mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-28 04:41:02 +01:00
67 lines
21 KiB
HTML
67 lines
21 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `api` mod in crate `google_analyticsreporting4`."><meta name="keywords" content="rust, rustlang, rust-lang, api"><title>google_analyticsreporting4::api - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../google_analyticsreporting4/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Module api</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></div><p class="location"><a href="../index.html">google_analyticsreporting4</a></p><div id="sidebar-vars" data-name="api" data-ty="mod" data-relpath="../"></div><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Module <a href="../index.html">google_analyticsreporting4</a>::<wbr><a class="mod" href="">api</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../src/google_analyticsreporting4/api.rs.html#1-1878" title="goto source code">[src]</a></span></h1><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
|
||
<table><tr class="module-item"><td><a class="struct" href="struct.Activity.html" title="google_analyticsreporting4::api::Activity struct">Activity</a></td><td class="docblock-short"><p>An Activity represents data for an activity of a user. Note that an Activity is different from a hit. A hit might result in multiple Activity's. For example, if a hit includes a transaction and a goal completion, there will be two Activity protos for this hit, one for ECOMMERCE and one for GOAL. Conversely, multiple hits can also construct one Activity. In classic e-commerce, data for one transaction might be sent through multiple hits. These hits will be merged into one ECOMMERCE Activity.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AnalyticsReporting.html" title="google_analyticsreporting4::api::AnalyticsReporting struct">AnalyticsReporting</a></td><td class="docblock-short"><p>Central instance to access all AnalyticsReporting related resource activities</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Cohort.html" title="google_analyticsreporting4::api::Cohort struct">Cohort</a></td><td class="docblock-short"><p>Defines a cohort. A cohort is a group of users who share a common characteristic. For example, all users with the same acquisition date belong to the same cohort.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.CohortGroup.html" title="google_analyticsreporting4::api::CohortGroup struct">CohortGroup</a></td><td class="docblock-short"><p>Defines a cohort group. For example: "cohortGroup": { "cohorts": [{ "name": "cohort 1", "type": "FIRST_VISIT_DATE", "dateRange": { "startDate": "2015-08-01", "endDate": "2015-08-01" } },{ "name": "cohort 2" "type": "FIRST_VISIT_DATE" "dateRange": { "startDate": "2015-07-01", "endDate": "2015-07-01" } }] }</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ColumnHeader.html" title="google_analyticsreporting4::api::ColumnHeader struct">ColumnHeader</a></td><td class="docblock-short"><p>Column headers.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.CustomDimension.html" title="google_analyticsreporting4::api::CustomDimension struct">CustomDimension</a></td><td class="docblock-short"><p>Custom dimension.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DateRange.html" title="google_analyticsreporting4::api::DateRange struct">DateRange</a></td><td class="docblock-short"><p>A contiguous set of days: startDate, startDate + 1 day, ..., endDate. The start and end dates are specified in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601</a> date format <code>YYYY-MM-DD</code>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DateRangeValues.html" title="google_analyticsreporting4::api::DateRangeValues struct">DateRangeValues</a></td><td class="docblock-short"><p>Used to return a list of metrics for a single DateRange / dimension combination</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Dimension.html" title="google_analyticsreporting4::api::Dimension struct">Dimension</a></td><td class="docblock-short"><p><a href="https://support.google.com/analytics/answer/1033861">Dimensions</a> are attributes of your data. For example, the dimension <code>ga:city</code> indicates the city, for example, "Paris" or "New York", from which a session originates.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DimensionFilter.html" title="google_analyticsreporting4::api::DimensionFilter struct">DimensionFilter</a></td><td class="docblock-short"><p>Dimension filter specifies the filtering options on a dimension.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DimensionFilterClause.html" title="google_analyticsreporting4::api::DimensionFilterClause struct">DimensionFilterClause</a></td><td class="docblock-short"><p>A group of dimension filters. Set the operator value to specify how the filters are logically combined.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DynamicSegment.html" title="google_analyticsreporting4::api::DynamicSegment struct">DynamicSegment</a></td><td class="docblock-short"><p>Dynamic segment definition for defining the segment within the request. A segment can select users, sessions or both.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.EcommerceData.html" title="google_analyticsreporting4::api::EcommerceData struct">EcommerceData</a></td><td class="docblock-short"><p>E-commerce details associated with the user activity.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.EventData.html" title="google_analyticsreporting4::api::EventData struct">EventData</a></td><td class="docblock-short"><p>Represents all the details pertaining to an event.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GetReportsRequest.html" title="google_analyticsreporting4::api::GetReportsRequest struct">GetReportsRequest</a></td><td class="docblock-short"><p>The batch request containing multiple report request.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GetReportsResponse.html" title="google_analyticsreporting4::api::GetReportsResponse struct">GetReportsResponse</a></td><td class="docblock-short"><p>The main response class which holds the reports from the Reporting API <code>batchGet</code> call.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoalData.html" title="google_analyticsreporting4::api::GoalData struct">GoalData</a></td><td class="docblock-short"><p>Represents all the details pertaining to a goal.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoalSetData.html" title="google_analyticsreporting4::api::GoalSetData struct">GoalSetData</a></td><td class="docblock-short"><p>Represents a set of goals that were reached in an activity.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Metric.html" title="google_analyticsreporting4::api::Metric struct">Metric</a></td><td class="docblock-short"><p><a href="https://support.google.com/analytics/answer/1033861">Metrics</a> are the quantitative measurements. For example, the metric <code>ga:users</code> indicates the total number of users for the requested time period.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.MetricFilter.html" title="google_analyticsreporting4::api::MetricFilter struct">MetricFilter</a></td><td class="docblock-short"><p>MetricFilter specifies the filter on a metric.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.MetricFilterClause.html" title="google_analyticsreporting4::api::MetricFilterClause struct">MetricFilterClause</a></td><td class="docblock-short"><p>Represents a group of metric filters. Set the operator value to specify how the filters are logically combined.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.MetricHeader.html" title="google_analyticsreporting4::api::MetricHeader struct">MetricHeader</a></td><td class="docblock-short"><p>The headers for the metrics.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.MetricHeaderEntry.html" title="google_analyticsreporting4::api::MetricHeaderEntry struct">MetricHeaderEntry</a></td><td class="docblock-short"><p>Header for the metrics.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.OrFiltersForSegment.html" title="google_analyticsreporting4::api::OrFiltersForSegment struct">OrFiltersForSegment</a></td><td class="docblock-short"><p>A list of segment filters in the <code>OR</code> group are combined with the logical OR operator.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.OrderBy.html" title="google_analyticsreporting4::api::OrderBy struct">OrderBy</a></td><td class="docblock-short"><p>Specifies the sorting options.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PageviewData.html" title="google_analyticsreporting4::api::PageviewData struct">PageviewData</a></td><td class="docblock-short"><p>Represents details collected when the visitor views a page.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Pivot.html" title="google_analyticsreporting4::api::Pivot struct">Pivot</a></td><td class="docblock-short"><p>The Pivot describes the pivot section in the request. The Pivot helps rearrange the information in the table for certain reports by pivoting your data on a second dimension.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PivotHeader.html" title="google_analyticsreporting4::api::PivotHeader struct">PivotHeader</a></td><td class="docblock-short"><p>The headers for each of the pivot sections defined in the request.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PivotHeaderEntry.html" title="google_analyticsreporting4::api::PivotHeaderEntry struct">PivotHeaderEntry</a></td><td class="docblock-short"><p>The headers for the each of the metric column corresponding to the metrics requested in the pivots section of the response.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PivotValueRegion.html" title="google_analyticsreporting4::api::PivotValueRegion struct">PivotValueRegion</a></td><td class="docblock-short"><p>The metric values in the pivot region.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProductData.html" title="google_analyticsreporting4::api::ProductData struct">ProductData</a></td><td class="docblock-short"><p>Details of the products in an e-commerce transaction.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Report.html" title="google_analyticsreporting4::api::Report struct">Report</a></td><td class="docblock-short"><p>The data response corresponding to the request.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ReportBatchGetCall.html" title="google_analyticsreporting4::api::ReportBatchGetCall struct">ReportBatchGetCall</a></td><td class="docblock-short"><p>Returns the Analytics data.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ReportData.html" title="google_analyticsreporting4::api::ReportData struct">ReportData</a></td><td class="docblock-short"><p>The data part of the report.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ReportMethods.html" title="google_analyticsreporting4::api::ReportMethods struct">ReportMethods</a></td><td class="docblock-short"><p>A builder providing access to all methods supported on <em>report</em> resources.
|
||
It is not used directly, but through the <code>AnalyticsReporting</code> hub.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ReportRequest.html" title="google_analyticsreporting4::api::ReportRequest struct">ReportRequest</a></td><td class="docblock-short"><p>The main request class which specifies the Reporting API request.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ReportRow.html" title="google_analyticsreporting4::api::ReportRow struct">ReportRow</a></td><td class="docblock-short"><p>A row in the report.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ResourceQuotasRemaining.html" title="google_analyticsreporting4::api::ResourceQuotasRemaining struct">ResourceQuotasRemaining</a></td><td class="docblock-short"><p>The resource quota tokens remaining for the property after the request is completed.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ScreenviewData.html" title="google_analyticsreporting4::api::ScreenviewData struct">ScreenviewData</a></td><td class="docblock-short"><p>There is no detailed description.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SearchUserActivityRequest.html" title="google_analyticsreporting4::api::SearchUserActivityRequest struct">SearchUserActivityRequest</a></td><td class="docblock-short"><p>The request to fetch User Report from Reporting API <code>userActivity:get</code> call.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SearchUserActivityResponse.html" title="google_analyticsreporting4::api::SearchUserActivityResponse struct">SearchUserActivityResponse</a></td><td class="docblock-short"><p>The response from <code>userActivity:get</code> call.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Segment.html" title="google_analyticsreporting4::api::Segment struct">Segment</a></td><td class="docblock-short"><p>The segment definition, if the report needs to be segmented. A Segment is a subset of the Analytics data. For example, of the entire set of users, one Segment might be users from a particular country or city.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SegmentDefinition.html" title="google_analyticsreporting4::api::SegmentDefinition struct">SegmentDefinition</a></td><td class="docblock-short"><p>SegmentDefinition defines the segment to be a set of SegmentFilters which are combined together with a logical <code>AND</code> operation.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SegmentDimensionFilter.html" title="google_analyticsreporting4::api::SegmentDimensionFilter struct">SegmentDimensionFilter</a></td><td class="docblock-short"><p>Dimension filter specifies the filtering options on a dimension.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SegmentFilter.html" title="google_analyticsreporting4::api::SegmentFilter struct">SegmentFilter</a></td><td class="docblock-short"><p>SegmentFilter defines the segment to be either a simple or a sequence segment. A simple segment condition contains dimension and metric conditions to select the sessions or users. A sequence segment condition can be used to select users or sessions based on sequential conditions.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SegmentFilterClause.html" title="google_analyticsreporting4::api::SegmentFilterClause struct">SegmentFilterClause</a></td><td class="docblock-short"><p>Filter Clause to be used in a segment definition, can be wither a metric or a dimension filter.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SegmentMetricFilter.html" title="google_analyticsreporting4::api::SegmentMetricFilter struct">SegmentMetricFilter</a></td><td class="docblock-short"><p>Metric filter to be used in a segment filter clause.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SegmentSequenceStep.html" title="google_analyticsreporting4::api::SegmentSequenceStep struct">SegmentSequenceStep</a></td><td class="docblock-short"><p>A segment sequence definition.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SequenceSegment.html" title="google_analyticsreporting4::api::SequenceSegment struct">SequenceSegment</a></td><td class="docblock-short"><p>Sequence conditions consist of one or more steps, where each step is defined by one or more dimension/metric conditions. Multiple steps can be combined with special sequence operators.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SimpleSegment.html" title="google_analyticsreporting4::api::SimpleSegment struct">SimpleSegment</a></td><td class="docblock-short"><p>A Simple segment conditions consist of one or more dimension/metric conditions that can be combined.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TransactionData.html" title="google_analyticsreporting4::api::TransactionData struct">TransactionData</a></td><td class="docblock-short"><p>Represents details collected when the visitor performs a transaction on the page.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.User.html" title="google_analyticsreporting4::api::User struct">User</a></td><td class="docblock-short"><p>Contains information to identify a particular user uniquely.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.UserActivityMethods.html" title="google_analyticsreporting4::api::UserActivityMethods struct">UserActivityMethods</a></td><td class="docblock-short"><p>A builder providing access to all methods supported on <em>userActivity</em> resources.
|
||
It is not used directly, but through the <code>AnalyticsReporting</code> hub.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.UserActivitySearchCall.html" title="google_analyticsreporting4::api::UserActivitySearchCall struct">UserActivitySearchCall</a></td><td class="docblock-short"><p>Returns User Activity data.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.UserActivitySession.html" title="google_analyticsreporting4::api::UserActivitySession struct">UserActivitySession</a></td><td class="docblock-short"><p>This represents a user session performed on a specific device at a certain time over a period of time.</p>
|
||
</td></tr></table><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2>
|
||
<table><tr class="module-item"><td><a class="enum" href="enum.Scope.html" title="google_analyticsreporting4::api::Scope enum">Scope</a></td><td class="docblock-short"><p>Identifies the an OAuth2 authorization scope.
|
||
A scope is needed when requesting an
|
||
<a href="https://developers.google.com/youtube/v3/guides/authentication">authorization token</a>.</p>
|
||
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="google_analyticsreporting4"></div>
|
||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |