View Source API Reference google_api_analytics_data v0.14.0

Modules

API client metadata for GoogleApi.AnalyticsData.V1alpha.

API calls for all endpoints tagged Properties.

API calls for all endpoints tagged V1alpha.

Handle Tesla connections for GoogleApi.AnalyticsData.V1alpha.

The batch request containing multiple pivot report requests.

The batch response containing multiple pivot reports.

The batch request containing multiple report requests.

The batch response containing multiple reports.

To express that the result needs to be between two numbers (inclusive).

Used to convert a dimension value to a single case.

Defines a cohort selection criteria. A cohort is a group of users who share a common characteristic. For example, users with the same firstSessionDate belong to the same cohort.

Optional settings of a cohort report.

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 cohort object. Following that cohort for the next six weeks is specified in the cohortsRange object. For examples, see Cohort Report Examples. 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 cohortActiveUsers/cohortTotalUsers and will be separate rows in the report.

Configures the extended reporting date range for a cohort report. Specifies an offset duration to follow the cohorts over.

Used to combine dimension values to a single dimension.

A contiguous set of days: startDate, startDate + 1, ..., endDate. Requests are allowed up to 4 date ranges.

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 9 dimensions.

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).

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.

The unique identifier of the property whose events are tracked.

An expression to filter dimension or metric values.

To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics.

The result needs to be in a list of string values.

The dimensions and metrics currently accepted in reporting methods.

The quantitative measurements of a report. For example, the metric eventCount is the total number of events. Requests are allowed up to 10 metrics.

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.

Filters for numeric or date values.

Describes the visible dimension columns and rows in the report response.

Summarizes dimension values from a row for this pivot.

Dimensions' values in a single pivot.

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 ---------|----------|----------------|----------|----------------

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.

Current state for a particular quota group.

Response's metadata carrying additional information about the report content.

Report data for each row. For example if RunReportRequest contains: none "dimensions": [ { "name": "eventName" }, { "name": "countryId" } ], "metrics": [ { "name": "eventCount" } ] One row with 'in_app_purchase' as the eventName, 'JP' as the countryId, and 15 as the eventCount, would be: none "dimensionValues": [ { "value": "in_app_purchase" }, { "value": "JP" } ], "metricValues": [ { "value": "15" } ]

The request to generate a pivot report.

The response pivot report table corresponding to a pivot request.

The request to generate a realtime report.

The response realtime report table corresponding to a request.

The request to generate a report.

The response report table corresponding to a request.

API client metadata for GoogleApi.AnalyticsData.V1beta.

API calls for all endpoints tagged Properties.

Handle Tesla connections for GoogleApi.AnalyticsData.V1beta.

A metric actively restricted in creating the report.

An audience export is a list of users in an audience at the time of the list's creation. One audience may have multiple audience exports created for different days.

The batch request containing multiple pivot report requests.

The batch response containing multiple pivot reports.

The batch request containing multiple report requests.

The batch response containing multiple reports.

To express that the result needs to be between two numbers (inclusive).

Used to convert a dimension value to a single case.

The request for compatibility information for a report's dimensions and metrics. Check compatibility provides a preview of the compatibility of a report; fields shared with the runReport request should be the same values as in your runReport request.

The compatibility response with the compatibility of each dimension & metric.

Defines a cohort selection criteria. A cohort is a group of users who share a common characteristic. For example, users with the same firstSessionDate belong to the same cohort.

Optional settings of a cohort report.

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 cohort object. Following that cohort for the next six weeks is specified in the cohortsRange object. For examples, see Cohort Report Examples. 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 cohortActiveUsers/cohortTotalUsers and will be separate rows in the report.

Configures the extended reporting date range for a cohort report. Specifies an offset duration to follow the cohorts over.

Used to combine dimension values to a single dimension.

A contiguous set of days: startDate, startDate + 1, ..., endDate. Requests are allowed up to 4 date ranges.

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, the city could be "Paris" or "New York". Requests are allowed up to 9 dimensions.

The compatibility for a single dimension.

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).

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.

An expression to filter dimension or metric values.

To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics.

The result needs to be in a list of string values.

A list of all audience exports for a property.

The dimensions, metrics and comparisons currently accepted in reporting methods.

The quantitative measurements of a report. For example, the metric eventCount is the total number of events. Requests are allowed up to 10 metrics.

The compatibility for a single metric.

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.

A contiguous set of minutes: startMinutesAgo, startMinutesAgo + 1, ..., endMinutesAgo. Requests are allowed up to 2 minute ranges.

Filters for numeric or date values.

This resource represents a long-running operation that is the result of a network API call.

Order bys define how rows will be sorted in the response. For example, ordering rows by descending event count is one ordering, and ordering rows by the event name string is a different ordering.

Describes the visible dimension columns and rows in the report response.

Summarizes dimension values from a row for this pivot.

Dimensions' values in a single pivot.

Sorts by a pivot column group.

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 ---------|----------|----------------|----------|----------------

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.

A request to list users in an audience export.

Current state for a particular quota group.

Response's metadata carrying additional information about the report content.

Report data for each row. For example if RunReportRequest contains: none "dimensions": [ { "name": "eventName" }, { "name": "countryId" } ], "metrics": [ { "name": "eventCount" } ] One row with 'in_app_purchase' as the eventName, 'JP' as the countryId, and 15 as the eventCount, would be: none "dimensionValues": [ { "value": "in_app_purchase" }, { "value": "JP" } ], "metricValues": [ { "value": "15" } ]

The request to generate a pivot report.

The response pivot report table corresponding to a pivot request.

The request to generate a realtime report.

The response realtime report table corresponding to a request.

The request to generate a report.

The response report table corresponding to a request.

If this report results is sampled, this describes the percentage of events used in this report. Sampling is the practice of analyzing a subset of all data in order to uncover the meaningful information in the larger data set.

The schema restrictions actively enforced in creating this report. To learn more, see Access and data-restriction management.

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

An audience dimension is a user attribute. Specific user attributed are requested and then later returned in the QueryAudienceExportResponse.

Dimension value attributes for the audience user row.