mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-28 04:41:02 +01:00
66 lines
23 KiB
HTML
66 lines
23 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_analyticsdata1_beta`."><meta name="keywords" content="rust, rustlang, rust-lang, api"><title>google_analyticsdata1_beta::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_analyticsdata1_beta/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_analyticsdata1_beta</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_analyticsdata1_beta</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_analyticsdata1_beta/api.rs.html#1-3067" 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.AnalyticsData.html" title="google_analyticsdata1_beta::api::AnalyticsData struct">AnalyticsData</a></td><td class="docblock-short"><p>Central instance to access all AnalyticsData related resource activities</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BatchRunPivotReportsRequest.html" title="google_analyticsdata1_beta::api::BatchRunPivotReportsRequest struct">BatchRunPivotReportsRequest</a></td><td class="docblock-short"><p>The batch request containing multiple pivot report requests.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BatchRunPivotReportsResponse.html" title="google_analyticsdata1_beta::api::BatchRunPivotReportsResponse struct">BatchRunPivotReportsResponse</a></td><td class="docblock-short"><p>The batch response containing multiple pivot reports.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BatchRunReportsRequest.html" title="google_analyticsdata1_beta::api::BatchRunReportsRequest struct">BatchRunReportsRequest</a></td><td class="docblock-short"><p>The batch request containing multiple report requests.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BatchRunReportsResponse.html" title="google_analyticsdata1_beta::api::BatchRunReportsResponse struct">BatchRunReportsResponse</a></td><td class="docblock-short"><p>The batch response containing multiple reports.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BetweenFilter.html" title="google_analyticsdata1_beta::api::BetweenFilter struct">BetweenFilter</a></td><td class="docblock-short"><p>To express that the result needs to be between two numbers (inclusive).</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.CaseExpression.html" title="google_analyticsdata1_beta::api::CaseExpression struct">CaseExpression</a></td><td class="docblock-short"><p>Used to convert a dimension value to a single case.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Cohort.html" title="google_analyticsdata1_beta::api::Cohort struct">Cohort</a></td><td class="docblock-short"><p>Defines a cohort selection criteria. A cohort is a group of users who share a common characteristic. For example, users with the same <code>firstSessionDate</code> belong to the same cohort.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.CohortReportSettings.html" title="google_analyticsdata1_beta::api::CohortReportSettings struct">CohortReportSettings</a></td><td class="docblock-short"><p>Optional settings of a cohort report.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.CohortSpec.html" title="google_analyticsdata1_beta::api::CohortSpec struct">CohortSpec</a></td><td class="docblock-short"><p>The specification of cohorts for a cohort report. Cohort reports create a time series of user retention for the cohort. For example, you could select the cohort of users that were acquired in the first week of September and follow that cohort for the next six weeks. Selecting the users acquired in the first week of September cohort is specified in the <code>cohort</code> object. Following that cohort for the next six weeks is specified in the <code>cohortsRange</code> object. For examples, see <a href="https://developers.google.com/analytics/devguides/reporting/data/v1/advanced#cohort_report_examples">Cohort Report Examples</a>. The report response could show a weekly time series where say your app has retained 60% of this cohort after three weeks and 25% of this cohort after six weeks. These two percentages can be calculated by the metric <code>cohortActiveUsers/cohortTotalUsers</code> and will be separate rows in the report.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.CohortsRange.html" title="google_analyticsdata1_beta::api::CohortsRange struct">CohortsRange</a></td><td class="docblock-short"><p>Configures the extended reporting date range for a cohort report. Specifies an offset duration to follow the cohorts over.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ConcatenateExpression.html" title="google_analyticsdata1_beta::api::ConcatenateExpression struct">ConcatenateExpression</a></td><td class="docblock-short"><p>Used to combine dimension values to a single dimension.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DateRange.html" title="google_analyticsdata1_beta::api::DateRange struct">DateRange</a></td><td class="docblock-short"><p>A contiguous set of days: startDate, startDate + 1, ..., endDate. Requests are allowed up to 4 date ranges.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Dimension.html" title="google_analyticsdata1_beta::api::Dimension struct">Dimension</a></td><td class="docblock-short"><p>Dimensions are attributes of your data. For example, the dimension city indicates the city from which an event originates. Dimension values in report responses are strings; for example, city could be "Paris" or "New York". Requests are allowed up to 8 dimensions.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DimensionExpression.html" title="google_analyticsdata1_beta::api::DimensionExpression struct">DimensionExpression</a></td><td class="docblock-short"><p>Used to express a dimension which is the result of a formula of multiple dimensions. Example usages: 1) lower_case(dimension) 2) concatenate(dimension1, symbol, dimension2).</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DimensionHeader.html" title="google_analyticsdata1_beta::api::DimensionHeader struct">DimensionHeader</a></td><td class="docblock-short"><p>Describes a dimension column in the report. Dimensions requested in a report produce column entries within rows and DimensionHeaders. However, dimensions used exclusively within filters or expressions do not produce columns in a report; correspondingly, those dimensions do not produce headers.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DimensionMetadata.html" title="google_analyticsdata1_beta::api::DimensionMetadata struct">DimensionMetadata</a></td><td class="docblock-short"><p>Explains a dimension.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DimensionOrderBy.html" title="google_analyticsdata1_beta::api::DimensionOrderBy struct">DimensionOrderBy</a></td><td class="docblock-short"><p>Sorts by dimension values.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DimensionValue.html" title="google_analyticsdata1_beta::api::DimensionValue struct">DimensionValue</a></td><td class="docblock-short"><p>The value of a dimension.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Filter.html" title="google_analyticsdata1_beta::api::Filter struct">Filter</a></td><td class="docblock-short"><p>An expression to filter dimension or metric values.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.FilterExpression.html" title="google_analyticsdata1_beta::api::FilterExpression struct">FilterExpression</a></td><td class="docblock-short"><p>To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.FilterExpressionList.html" title="google_analyticsdata1_beta::api::FilterExpressionList struct">FilterExpressionList</a></td><td class="docblock-short"><p>A list of filter expressions.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.InListFilter.html" title="google_analyticsdata1_beta::api::InListFilter struct">InListFilter</a></td><td class="docblock-short"><p>The result needs to be in a list of string values.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Metadata.html" title="google_analyticsdata1_beta::api::Metadata struct">Metadata</a></td><td class="docblock-short"><p>The dimensions and metrics currently accepted in reporting methods.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Metric.html" title="google_analyticsdata1_beta::api::Metric struct">Metric</a></td><td class="docblock-short"><p>The quantitative measurements of a report. For example, the metric <code>eventCount</code> is the total number of events. Requests are allowed up to 10 metrics.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.MetricHeader.html" title="google_analyticsdata1_beta::api::MetricHeader struct">MetricHeader</a></td><td class="docblock-short"><p>Describes a metric column in the report. Visible metrics requested in a report produce column entries within rows and MetricHeaders. However, metrics used exclusively within filters or expressions do not produce columns in a report; correspondingly, those metrics do not produce headers.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.MetricMetadata.html" title="google_analyticsdata1_beta::api::MetricMetadata struct">MetricMetadata</a></td><td class="docblock-short"><p>Explains a metric.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.MetricOrderBy.html" title="google_analyticsdata1_beta::api::MetricOrderBy struct">MetricOrderBy</a></td><td class="docblock-short"><p>Sorts by metric values.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.MetricValue.html" title="google_analyticsdata1_beta::api::MetricValue struct">MetricValue</a></td><td class="docblock-short"><p>The value of a metric.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.NumericFilter.html" title="google_analyticsdata1_beta::api::NumericFilter struct">NumericFilter</a></td><td class="docblock-short"><p>Filters for numeric or date values.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.NumericValue.html" title="google_analyticsdata1_beta::api::NumericValue struct">NumericValue</a></td><td class="docblock-short"><p>To represent a number.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.OrderBy.html" title="google_analyticsdata1_beta::api::OrderBy struct">OrderBy</a></td><td class="docblock-short"><p>The sort options.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Pivot.html" title="google_analyticsdata1_beta::api::Pivot struct">Pivot</a></td><td class="docblock-short"><p>Describes the visible dimension columns and rows in the report response.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PivotDimensionHeader.html" title="google_analyticsdata1_beta::api::PivotDimensionHeader struct">PivotDimensionHeader</a></td><td class="docblock-short"><p>Summarizes dimension values from a row for this pivot.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PivotHeader.html" title="google_analyticsdata1_beta::api::PivotHeader struct">PivotHeader</a></td><td class="docblock-short"><p>Dimensions' values in a single pivot.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PivotOrderBy.html" title="google_analyticsdata1_beta::api::PivotOrderBy struct">PivotOrderBy</a></td><td class="docblock-short"><p>Sorts by a pivot column group.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PivotSelection.html" title="google_analyticsdata1_beta::api::PivotSelection struct">PivotSelection</a></td><td class="docblock-short"><p>A pair of dimension names and values. Rows with this dimension pivot pair are ordered by the metric's value. For example if pivots = {{"browser", "Chrome"}} and metric_name = "Sessions", then the rows will be sorted based on Sessions in Chrome. ---------|----------|----------------|----------|---------------- | Chrome | Chrome | Safari | Safari ---------|----------|----------------|----------|---------------- Country | Sessions | Pages/Sessions | Sessions | Pages/Sessions ---------|----------|----------------|----------|---------------- US | 2 | 2 | 3 | 1 ---------|----------|----------------|----------|---------------- Canada | 3 | 1 | 4 | 1 ---------|----------|----------------|----------|----------------</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PropertyBatchRunPivotReportCall.html" title="google_analyticsdata1_beta::api::PropertyBatchRunPivotReportCall struct">PropertyBatchRunPivotReportCall</a></td><td class="docblock-short"><p>Returns multiple pivot reports in a batch. All reports must be for the same GA4 Property.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PropertyBatchRunReportCall.html" title="google_analyticsdata1_beta::api::PropertyBatchRunReportCall struct">PropertyBatchRunReportCall</a></td><td class="docblock-short"><p>Returns multiple reports in a batch. All reports must be for the same GA4 Property.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PropertyGetMetadataCall.html" title="google_analyticsdata1_beta::api::PropertyGetMetadataCall struct">PropertyGetMetadataCall</a></td><td class="docblock-short"><p>Returns metadata for dimensions and metrics available in reporting methods. Used to explore the dimensions and metrics. In this method, a Google Analytics GA4 Property Identifier is specified in the request, and the metadata response includes Custom dimensions and metrics as well as Universal metadata. For example if a custom metric with parameter name <code>levels_unlocked</code> is registered to a property, the Metadata response will contain <code>customEvent:levels_unlocked</code>. Universal metadata are dimensions and metrics applicable to any property such as <code>country</code> and <code>totalUsers</code>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PropertyMethods.html" title="google_analyticsdata1_beta::api::PropertyMethods struct">PropertyMethods</a></td><td class="docblock-short"><p>A builder providing access to all methods supported on <em>property</em> resources.
|
||
It is not used directly, but through the <code>AnalyticsData</code> hub.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PropertyQuota.html" title="google_analyticsdata1_beta::api::PropertyQuota struct">PropertyQuota</a></td><td class="docblock-short"><p>Current state of all quotas for this Analytics Property. If any quota for a property is exhausted, all requests to that property will return Resource Exhausted errors.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PropertyRunPivotReportCall.html" title="google_analyticsdata1_beta::api::PropertyRunPivotReportCall struct">PropertyRunPivotReportCall</a></td><td class="docblock-short"><p>Returns a customized pivot report of your Google Analytics event data. Pivot reports are more advanced and expressive formats than regular reports. In a pivot report, dimensions are only visible if they are included in a pivot. Multiple pivots can be specified to further dissect your data.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PropertyRunRealtimeReportCall.html" title="google_analyticsdata1_beta::api::PropertyRunRealtimeReportCall struct">PropertyRunRealtimeReportCall</a></td><td class="docblock-short"><p>The Google Analytics Realtime API returns a customized report of realtime event data for your property. These reports show events and usage from the last 30 minutes.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PropertyRunReportCall.html" title="google_analyticsdata1_beta::api::PropertyRunReportCall struct">PropertyRunReportCall</a></td><td class="docblock-short"><p>Returns a customized report of your Google Analytics event data. Reports contain statistics derived from data collected by the Google Analytics tracking code. The data returned from the API is as a table with columns for the requested dimensions and metrics. Metrics are individual measurements of user activity on your property, such as active users or event count. Dimensions break down metrics across some common criteria, such as country or event name.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.QuotaStatus.html" title="google_analyticsdata1_beta::api::QuotaStatus struct">QuotaStatus</a></td><td class="docblock-short"><p>Current state for a particular quota group.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ResponseMetaData.html" title="google_analyticsdata1_beta::api::ResponseMetaData struct">ResponseMetaData</a></td><td class="docblock-short"><p>Response's metadata carrying additional information about the report content.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Row.html" title="google_analyticsdata1_beta::api::Row struct">Row</a></td><td class="docblock-short"><p>Report data for each row. For example if RunReportRequest contains: <code>none "dimensions": [ { "name": "eventName" }, { "name": "countryId" } ], "metrics": [ { "name": "eventCount" } ] </code> One row with 'in_app_purchase' as the eventName, 'JP' as the countryId, and 15 as the eventCount, would be: <code>none "dimensionValues": [ { "value": "in_app_purchase" }, { "value": "JP" } ], "metricValues": [ { "value": "15" } ] </code></p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.RunPivotReportRequest.html" title="google_analyticsdata1_beta::api::RunPivotReportRequest struct">RunPivotReportRequest</a></td><td class="docblock-short"><p>The request to generate a pivot report.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.RunPivotReportResponse.html" title="google_analyticsdata1_beta::api::RunPivotReportResponse struct">RunPivotReportResponse</a></td><td class="docblock-short"><p>The response pivot report table corresponding to a pivot request.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.RunRealtimeReportRequest.html" title="google_analyticsdata1_beta::api::RunRealtimeReportRequest struct">RunRealtimeReportRequest</a></td><td class="docblock-short"><p>The request to generate a realtime report.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.RunRealtimeReportResponse.html" title="google_analyticsdata1_beta::api::RunRealtimeReportResponse struct">RunRealtimeReportResponse</a></td><td class="docblock-short"><p>The response realtime report table corresponding to a request.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.RunReportRequest.html" title="google_analyticsdata1_beta::api::RunReportRequest struct">RunReportRequest</a></td><td class="docblock-short"><p>The request to generate a report.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.RunReportResponse.html" title="google_analyticsdata1_beta::api::RunReportResponse struct">RunReportResponse</a></td><td class="docblock-short"><p>The response report table corresponding to a request.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.StringFilter.html" title="google_analyticsdata1_beta::api::StringFilter struct">StringFilter</a></td><td class="docblock-short"><p>The filter for string</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_analyticsdata1_beta::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_analyticsdata1_beta"></div>
|
||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |