Package com.google.analytics.data.v1beta (0.19.0)

A client to Google Analytics Data API

The interfaces provided are listed below, along with usage samples.

BetaAnalyticsDataClient

Service Description: Google Analytics reporting data service.

Sample for BetaAnalyticsDataClient:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BetaAnalyticsDataClient betaAnalyticsDataClient = BetaAnalyticsDataClient.create()) {
   RunReportRequest request =
       RunReportRequest.newBuilder()
           .setProperty("property-993141291")
           .addAllDimensions(new ArrayList<Dimension>())
           .addAllMetrics(new ArrayList<Metric>())
           .addAllDateRanges(new ArrayList<DateRange>())
           .setDimensionFilter(FilterExpression.newBuilder().build())
           .setMetricFilter(FilterExpression.newBuilder().build())
           .setOffset(-1019779949)
           .setLimit(102976443)
           .addAllMetricAggregations(new ArrayList<MetricAggregation>())
           .addAllOrderBys(new ArrayList<OrderBy>())
           .setCurrencyCode("currencyCode1004773790")
           .setCohortSpec(CohortSpec.newBuilder().build())
           .setKeepEmptyRows(true)
           .setReturnPropertyQuota(true)
           .build();
   RunReportResponse response = betaAnalyticsDataClient.runReport(request);
 }
 

Classes

AnalyticsDataApiProto

BatchRunPivotReportsRequest

The batch request containing multiple pivot report requests.

Protobuf type google.analytics.data.v1beta.BatchRunPivotReportsRequest

BatchRunPivotReportsRequest.Builder

The batch request containing multiple pivot report requests.

Protobuf type google.analytics.data.v1beta.BatchRunPivotReportsRequest

BatchRunPivotReportsResponse

The batch response containing multiple pivot reports.

Protobuf type google.analytics.data.v1beta.BatchRunPivotReportsResponse

BatchRunPivotReportsResponse.Builder

The batch response containing multiple pivot reports.

Protobuf type google.analytics.data.v1beta.BatchRunPivotReportsResponse

BatchRunReportsRequest

The batch request containing multiple report requests.

Protobuf type google.analytics.data.v1beta.BatchRunReportsRequest

BatchRunReportsRequest.Builder

The batch request containing multiple report requests.

Protobuf type google.analytics.data.v1beta.BatchRunReportsRequest

BatchRunReportsResponse

The batch response containing multiple reports.

Protobuf type google.analytics.data.v1beta.BatchRunReportsResponse

BatchRunReportsResponse.Builder

The batch response containing multiple reports.

Protobuf type google.analytics.data.v1beta.BatchRunReportsResponse

BetaAnalyticsDataClient

Service Description: Google Analytics reporting data service.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BetaAnalyticsDataClient betaAnalyticsDataClient = BetaAnalyticsDataClient.create()) {
   RunReportRequest request =
       RunReportRequest.newBuilder()
           .setProperty("property-993141291")
           .addAllDimensions(new ArrayList<Dimension>())
           .addAllMetrics(new ArrayList<Metric>())
           .addAllDateRanges(new ArrayList<DateRange>())
           .setDimensionFilter(FilterExpression.newBuilder().build())
           .setMetricFilter(FilterExpression.newBuilder().build())
           .setOffset(-1019779949)
           .setLimit(102976443)
           .addAllMetricAggregations(new ArrayList<MetricAggregation>())
           .addAllOrderBys(new ArrayList<OrderBy>())
           .setCurrencyCode("currencyCode1004773790")
           .setCohortSpec(CohortSpec.newBuilder().build())
           .setKeepEmptyRows(true)
           .setReturnPropertyQuota(true)
           .build();
   RunReportResponse response = betaAnalyticsDataClient.runReport(request);
 }
 

Note: close() needs to be called on the BetaAnalyticsDataClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

  1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
  2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
  3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of BetaAnalyticsDataSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 BetaAnalyticsDataSettings betaAnalyticsDataSettings =
     BetaAnalyticsDataSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 BetaAnalyticsDataClient betaAnalyticsDataClient =
     BetaAnalyticsDataClient.create(betaAnalyticsDataSettings);
 

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 BetaAnalyticsDataSettings betaAnalyticsDataSettings =
     BetaAnalyticsDataSettings.newBuilder().setEndpoint(myEndpoint).build();
 BetaAnalyticsDataClient betaAnalyticsDataClient =
     BetaAnalyticsDataClient.create(betaAnalyticsDataSettings);
 

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 BetaAnalyticsDataSettings betaAnalyticsDataSettings =
     BetaAnalyticsDataSettings.newHttpJsonBuilder().build();
 BetaAnalyticsDataClient betaAnalyticsDataClient =
     BetaAnalyticsDataClient.create(betaAnalyticsDataSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

BetaAnalyticsDataGrpc

Google Analytics reporting data service.

BetaAnalyticsDataGrpc.BetaAnalyticsDataBlockingStub

Google Analytics reporting data service.

BetaAnalyticsDataGrpc.BetaAnalyticsDataFutureStub

Google Analytics reporting data service.

BetaAnalyticsDataGrpc.BetaAnalyticsDataImplBase

Google Analytics reporting data service.

BetaAnalyticsDataGrpc.BetaAnalyticsDataStub

Google Analytics reporting data service.

BetaAnalyticsDataSettings

Settings class to configure an instance of BetaAnalyticsDataClient.

The default instance has everything set to sensible defaults:

  • The default service address (analyticsdata.googleapis.com) and default port (443) are used.
  • Credentials are acquired automatically through Application Default Credentials.
  • Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of runReport to 30 seconds:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 BetaAnalyticsDataSettings.Builder betaAnalyticsDataSettingsBuilder =
     BetaAnalyticsDataSettings.newBuilder();
 betaAnalyticsDataSettingsBuilder
     .runReportSettings()
     .setRetrySettings(
         betaAnalyticsDataSettingsBuilder
             .runReportSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 BetaAnalyticsDataSettings betaAnalyticsDataSettings = betaAnalyticsDataSettingsBuilder.build();
 

BetaAnalyticsDataSettings.Builder

Builder for BetaAnalyticsDataSettings.

CheckCompatibilityRequest

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.

Protobuf type google.analytics.data.v1beta.CheckCompatibilityRequest

CheckCompatibilityRequest.Builder

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.

Protobuf type google.analytics.data.v1beta.CheckCompatibilityRequest

CheckCompatibilityResponse

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

Protobuf type google.analytics.data.v1beta.CheckCompatibilityResponse

CheckCompatibilityResponse.Builder

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

Protobuf type google.analytics.data.v1beta.CheckCompatibilityResponse

Cohort

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.

Protobuf type google.analytics.data.v1beta.Cohort

Cohort.Builder

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.

Protobuf type google.analytics.data.v1beta.Cohort

CohortReportSettings

Optional settings of a cohort report.

Protobuf type google.analytics.data.v1beta.CohortReportSettings

CohortReportSettings.Builder

Optional settings of a cohort report.

Protobuf type google.analytics.data.v1beta.CohortReportSettings

CohortSpec

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.

Protobuf type google.analytics.data.v1beta.CohortSpec

CohortSpec.Builder

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.

Protobuf type google.analytics.data.v1beta.CohortSpec

CohortsRange

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

Protobuf type google.analytics.data.v1beta.CohortsRange

CohortsRange.Builder

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

Protobuf type google.analytics.data.v1beta.CohortsRange

DateRange

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

Protobuf type google.analytics.data.v1beta.DateRange

DateRange.Builder

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

Protobuf type google.analytics.data.v1beta.DateRange

Dimension

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.

Protobuf type google.analytics.data.v1beta.Dimension

Dimension.Builder

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.

Protobuf type google.analytics.data.v1beta.Dimension

DimensionCompatibility

The compatibility for a single dimension.

Protobuf type google.analytics.data.v1beta.DimensionCompatibility

DimensionCompatibility.Builder

The compatibility for a single dimension.

Protobuf type google.analytics.data.v1beta.DimensionCompatibility

DimensionExpression

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

Protobuf type google.analytics.data.v1beta.DimensionExpression

DimensionExpression.Builder

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

Protobuf type google.analytics.data.v1beta.DimensionExpression

DimensionExpression.CaseExpression

Used to convert a dimension value to a single case.

Protobuf type google.analytics.data.v1beta.DimensionExpression.CaseExpression

DimensionExpression.CaseExpression.Builder

Used to convert a dimension value to a single case.

Protobuf type google.analytics.data.v1beta.DimensionExpression.CaseExpression

DimensionExpression.ConcatenateExpression

Used to combine dimension values to a single dimension.

Protobuf type google.analytics.data.v1beta.DimensionExpression.ConcatenateExpression

DimensionExpression.ConcatenateExpression.Builder

Used to combine dimension values to a single dimension.

Protobuf type google.analytics.data.v1beta.DimensionExpression.ConcatenateExpression

DimensionHeader

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.

Protobuf type google.analytics.data.v1beta.DimensionHeader

DimensionHeader.Builder

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.

Protobuf type google.analytics.data.v1beta.DimensionHeader

DimensionMetadata

Explains a dimension.

Protobuf type google.analytics.data.v1beta.DimensionMetadata

DimensionMetadata.Builder

Explains a dimension.

Protobuf type google.analytics.data.v1beta.DimensionMetadata

DimensionValue

The value of a dimension.

Protobuf type google.analytics.data.v1beta.DimensionValue

DimensionValue.Builder

The value of a dimension.

Protobuf type google.analytics.data.v1beta.DimensionValue

Filter

An expression to filter dimension or metric values.

Protobuf type google.analytics.data.v1beta.Filter

Filter.BetweenFilter

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

Protobuf type google.analytics.data.v1beta.Filter.BetweenFilter

Filter.BetweenFilter.Builder

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

Protobuf type google.analytics.data.v1beta.Filter.BetweenFilter

Filter.Builder

An expression to filter dimension or metric values.

Protobuf type google.analytics.data.v1beta.Filter

Filter.InListFilter

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

Protobuf type google.analytics.data.v1beta.Filter.InListFilter

Filter.InListFilter.Builder

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

Protobuf type google.analytics.data.v1beta.Filter.InListFilter

Filter.NumericFilter

Filters for numeric or date values.

Protobuf type google.analytics.data.v1beta.Filter.NumericFilter

Filter.NumericFilter.Builder

Filters for numeric or date values.

Protobuf type google.analytics.data.v1beta.Filter.NumericFilter

Filter.StringFilter

The filter for string

Protobuf type google.analytics.data.v1beta.Filter.StringFilter

Filter.StringFilter.Builder

The filter for string

Protobuf type google.analytics.data.v1beta.Filter.StringFilter

FilterExpression

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

Protobuf type google.analytics.data.v1beta.FilterExpression

FilterExpression.Builder

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

Protobuf type google.analytics.data.v1beta.FilterExpression

FilterExpressionList

A list of filter expressions.

Protobuf type google.analytics.data.v1beta.FilterExpressionList

FilterExpressionList.Builder

A list of filter expressions.

Protobuf type google.analytics.data.v1beta.FilterExpressionList

GetMetadataRequest

Request for a property's dimension and metric metadata.

Protobuf type google.analytics.data.v1beta.GetMetadataRequest

GetMetadataRequest.Builder

Request for a property's dimension and metric metadata.

Protobuf type google.analytics.data.v1beta.GetMetadataRequest

Metadata

The dimensions and metrics currently accepted in reporting methods.

Protobuf type google.analytics.data.v1beta.Metadata

Metadata.Builder

The dimensions and metrics currently accepted in reporting methods.

Protobuf type google.analytics.data.v1beta.Metadata

MetadataName

MetadataName.Builder

Builder for properties/{property}/metadata.

Metric

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

Protobuf type google.analytics.data.v1beta.Metric

Metric.Builder

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

Protobuf type google.analytics.data.v1beta.Metric

MetricCompatibility

The compatibility for a single metric.

Protobuf type google.analytics.data.v1beta.MetricCompatibility

MetricCompatibility.Builder

The compatibility for a single metric.

Protobuf type google.analytics.data.v1beta.MetricCompatibility

MetricHeader

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.

Protobuf type google.analytics.data.v1beta.MetricHeader

MetricHeader.Builder

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.

Protobuf type google.analytics.data.v1beta.MetricHeader

MetricMetadata

Explains a metric.

Protobuf type google.analytics.data.v1beta.MetricMetadata

MetricMetadata.Builder

Explains a metric.

Protobuf type google.analytics.data.v1beta.MetricMetadata

MetricValue

The value of a metric.

Protobuf type google.analytics.data.v1beta.MetricValue

MetricValue.Builder

The value of a metric.

Protobuf type google.analytics.data.v1beta.MetricValue

MinuteRange

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

Protobuf type google.analytics.data.v1beta.MinuteRange

MinuteRange.Builder

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

Protobuf type google.analytics.data.v1beta.MinuteRange

NumericValue

To represent a number.

Protobuf type google.analytics.data.v1beta.NumericValue

NumericValue.Builder

To represent a number.

Protobuf type google.analytics.data.v1beta.NumericValue

OrderBy

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.

Protobuf type google.analytics.data.v1beta.OrderBy

OrderBy.Builder

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.

Protobuf type google.analytics.data.v1beta.OrderBy

OrderBy.DimensionOrderBy

Sorts by dimension values.

Protobuf type google.analytics.data.v1beta.OrderBy.DimensionOrderBy

OrderBy.DimensionOrderBy.Builder

Sorts by dimension values.

Protobuf type google.analytics.data.v1beta.OrderBy.DimensionOrderBy

OrderBy.MetricOrderBy

Sorts by metric values.

Protobuf type google.analytics.data.v1beta.OrderBy.MetricOrderBy

OrderBy.MetricOrderBy.Builder

Sorts by metric values.

Protobuf type google.analytics.data.v1beta.OrderBy.MetricOrderBy

OrderBy.PivotOrderBy

Sorts by a pivot column group.

Protobuf type google.analytics.data.v1beta.OrderBy.PivotOrderBy

OrderBy.PivotOrderBy.Builder

Sorts by a pivot column group.

Protobuf type google.analytics.data.v1beta.OrderBy.PivotOrderBy

OrderBy.PivotOrderBy.PivotSelection

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
---------
Country
---------
US
---------
Canada
---------

Protobuf type google.analytics.data.v1beta.OrderBy.PivotOrderBy.PivotSelection

OrderBy.PivotOrderBy.PivotSelection.Builder

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
---------
Country
---------
US
---------
Canada
---------

Protobuf type google.analytics.data.v1beta.OrderBy.PivotOrderBy.PivotSelection

Pivot

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

Protobuf type google.analytics.data.v1beta.Pivot

Pivot.Builder

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

Protobuf type google.analytics.data.v1beta.Pivot

PivotDimensionHeader

Summarizes dimension values from a row for this pivot.

Protobuf type google.analytics.data.v1beta.PivotDimensionHeader

PivotDimensionHeader.Builder

Summarizes dimension values from a row for this pivot.

Protobuf type google.analytics.data.v1beta.PivotDimensionHeader

PivotHeader

Dimensions' values in a single pivot.

Protobuf type google.analytics.data.v1beta.PivotHeader

PivotHeader.Builder

Dimensions' values in a single pivot.

Protobuf type google.analytics.data.v1beta.PivotHeader

PropertyQuota

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.

Protobuf type google.analytics.data.v1beta.PropertyQuota

PropertyQuota.Builder

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.

Protobuf type google.analytics.data.v1beta.PropertyQuota

QuotaStatus

Current state for a particular quota group.

Protobuf type google.analytics.data.v1beta.QuotaStatus

QuotaStatus.Builder

Current state for a particular quota group.

Protobuf type google.analytics.data.v1beta.QuotaStatus

ReportingApiProto

ResponseMetaData

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

Protobuf type google.analytics.data.v1beta.ResponseMetaData

ResponseMetaData.Builder

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

Protobuf type google.analytics.data.v1beta.ResponseMetaData

ResponseMetaData.SchemaRestrictionResponse

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

Protobuf type google.analytics.data.v1beta.ResponseMetaData.SchemaRestrictionResponse

ResponseMetaData.SchemaRestrictionResponse.ActiveMetricRestriction

A metric actively restricted in creating the report.

Protobuf type google.analytics.data.v1beta.ResponseMetaData.SchemaRestrictionResponse.ActiveMetricRestriction

ResponseMetaData.SchemaRestrictionResponse.ActiveMetricRestriction.Builder

A metric actively restricted in creating the report.

Protobuf type google.analytics.data.v1beta.ResponseMetaData.SchemaRestrictionResponse.ActiveMetricRestriction

ResponseMetaData.SchemaRestrictionResponse.Builder

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

Protobuf type google.analytics.data.v1beta.ResponseMetaData.SchemaRestrictionResponse

Row

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

Protobuf type google.analytics.data.v1beta.Row

Row.Builder

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

Protobuf type google.analytics.data.v1beta.Row

RunPivotReportRequest

The request to generate a pivot report.

Protobuf type google.analytics.data.v1beta.RunPivotReportRequest

RunPivotReportRequest.Builder

The request to generate a pivot report.

Protobuf type google.analytics.data.v1beta.RunPivotReportRequest

RunPivotReportResponse

The response pivot report table corresponding to a pivot request.

Protobuf type google.analytics.data.v1beta.RunPivotReportResponse

RunPivotReportResponse.Builder

The response pivot report table corresponding to a pivot request.

Protobuf type google.analytics.data.v1beta.RunPivotReportResponse

RunRealtimeReportRequest

The request to generate a realtime report.

Protobuf type google.analytics.data.v1beta.RunRealtimeReportRequest

RunRealtimeReportRequest.Builder

The request to generate a realtime report.

Protobuf type google.analytics.data.v1beta.RunRealtimeReportRequest

RunRealtimeReportResponse

The response realtime report table corresponding to a request.

Protobuf type google.analytics.data.v1beta.RunRealtimeReportResponse

RunRealtimeReportResponse.Builder

The response realtime report table corresponding to a request.

Protobuf type google.analytics.data.v1beta.RunRealtimeReportResponse

RunReportRequest

The request to generate a report.

Protobuf type google.analytics.data.v1beta.RunReportRequest

RunReportRequest.Builder

The request to generate a report.

Protobuf type google.analytics.data.v1beta.RunReportRequest

RunReportResponse

The response report table corresponding to a request.

Protobuf type google.analytics.data.v1beta.RunReportResponse

RunReportResponse.Builder

The response report table corresponding to a request.

Protobuf type google.analytics.data.v1beta.RunReportResponse

Interfaces

BatchRunPivotReportsRequestOrBuilder

BatchRunPivotReportsResponseOrBuilder

BatchRunReportsRequestOrBuilder

BatchRunReportsResponseOrBuilder

CheckCompatibilityRequestOrBuilder

CheckCompatibilityResponseOrBuilder

CohortOrBuilder

CohortReportSettingsOrBuilder

CohortSpecOrBuilder

CohortsRangeOrBuilder

DateRangeOrBuilder

DimensionCompatibilityOrBuilder

DimensionExpression.CaseExpressionOrBuilder

DimensionExpression.ConcatenateExpressionOrBuilder

DimensionExpressionOrBuilder

DimensionHeaderOrBuilder

DimensionMetadataOrBuilder

DimensionOrBuilder

DimensionValueOrBuilder

Filter.BetweenFilterOrBuilder

Filter.InListFilterOrBuilder

Filter.NumericFilterOrBuilder

Filter.StringFilterOrBuilder

FilterExpressionListOrBuilder

FilterExpressionOrBuilder

FilterOrBuilder

GetMetadataRequestOrBuilder

MetadataOrBuilder

MetricCompatibilityOrBuilder

MetricHeaderOrBuilder

MetricMetadataOrBuilder

MetricOrBuilder

MetricValueOrBuilder

MinuteRangeOrBuilder

NumericValueOrBuilder

OrderBy.DimensionOrderByOrBuilder

OrderBy.MetricOrderByOrBuilder

OrderBy.PivotOrderBy.PivotSelectionOrBuilder

OrderBy.PivotOrderByOrBuilder

OrderByOrBuilder

PivotDimensionHeaderOrBuilder

PivotHeaderOrBuilder

PivotOrBuilder

PropertyQuotaOrBuilder

QuotaStatusOrBuilder

ResponseMetaData.SchemaRestrictionResponse.ActiveMetricRestrictionOrBuilder

ResponseMetaData.SchemaRestrictionResponseOrBuilder

ResponseMetaDataOrBuilder

RowOrBuilder

RunPivotReportRequestOrBuilder

RunPivotReportResponseOrBuilder

RunRealtimeReportRequestOrBuilder

RunRealtimeReportResponseOrBuilder

RunReportRequestOrBuilder

RunReportResponseOrBuilder

Enums

CohortsRange.Granularity

The granularity used to interpret the startOffset and endOffset for the extended reporting date range for a cohort report.

Protobuf enum google.analytics.data.v1beta.CohortsRange.Granularity

Compatibility

The compatibility types for a single dimension or metric.

Protobuf enum google.analytics.data.v1beta.Compatibility

DimensionExpression.OneExpressionCase

DimensionValue.OneValueCase

Filter.NumericFilter.Operation

The operation applied to a numeric filter

Protobuf enum google.analytics.data.v1beta.Filter.NumericFilter.Operation

Filter.OneFilterCase

Filter.StringFilter.MatchType

The match type of a string filter

Protobuf enum google.analytics.data.v1beta.Filter.StringFilter.MatchType

FilterExpression.ExprCase

MetricAggregation

Represents aggregation of metrics.

Protobuf enum google.analytics.data.v1beta.MetricAggregation

MetricMetadata.BlockedReason

Justifications for why this metric is blocked.

Protobuf enum google.analytics.data.v1beta.MetricMetadata.BlockedReason

MetricType

A metric's value type.

Protobuf enum google.analytics.data.v1beta.MetricType

MetricValue.OneValueCase

NumericValue.OneValueCase

OrderBy.DimensionOrderBy.OrderType

Rule to order the string dimension values by.

Protobuf enum google.analytics.data.v1beta.OrderBy.DimensionOrderBy.OrderType

OrderBy.OneOrderByCase

RestrictedMetricType

Categories of data that you may be restricted from viewing on certain GA4 properties.

Protobuf enum google.analytics.data.v1beta.RestrictedMetricType