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

GitHub Repository

This package is not the latest GA version!

For this library, we recommend using the package associated with API version v1beta for new applications.

Prerelease Implications

This package is a prerelease version! Use with caution. Prerelease versions are considered unstable as they may be shut down. You can read more about Cloud API versioning strategy here. Each Cloud Java client library may contain multiple packages. Each package containing a version number in its name corresponds to a published version of the service. We recommend using the latest stable version for new production applications, which can be identified by the largest numeric version that does not contain a suffix. For example, if a client library has two packages: v1 and v2alpha, then the latest stable version is v1. If you use an unstable release, breaking changes may be introduced when upgrading.

Client Classes

Client classes are the main entry point to using a package. They contain several variations of Java methods for each of the API's methods.

Client Description
com.google.analytics.data.v1beta.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:

Settings Classes

Settings classes can be used to configure credentials, endpoints, and retry settings for a Client.

Settings Description
com.google.analytics.data.v1beta.BetaAnalyticsDataSettings Settings class to configure an instance of BetaAnalyticsDataClient.

The default instance has everything set to sensible defaults:

com.google.analytics.data.v1beta.CohortReportSettings

Optional settings of a cohort report.

Classes

Class Description
com.google.analytics.data.v1beta.AnalyticsDataApiProto
com.google.analytics.data.v1beta.BatchRunPivotReportsRequest The batch request containing multiple pivot report requests.
com.google.analytics.data.v1beta.BatchRunPivotReportsRequest.Builder The batch request containing multiple pivot report requests.
com.google.analytics.data.v1beta.BatchRunPivotReportsResponse The batch response containing multiple pivot reports.
com.google.analytics.data.v1beta.BatchRunPivotReportsResponse.Builder The batch response containing multiple pivot reports.
com.google.analytics.data.v1beta.BatchRunReportsRequest The batch request containing multiple report requests.
com.google.analytics.data.v1beta.BatchRunReportsRequest.Builder The batch request containing multiple report requests.
com.google.analytics.data.v1beta.BatchRunReportsResponse The batch response containing multiple reports.
com.google.analytics.data.v1beta.BatchRunReportsResponse.Builder The batch response containing multiple reports.
com.google.analytics.data.v1beta.BetaAnalyticsDataGrpc Google Analytics reporting data service.
com.google.analytics.data.v1beta.BetaAnalyticsDataGrpc.BetaAnalyticsDataImplBase Base class for the server implementation of the service BetaAnalyticsData. Google Analytics reporting data service.
com.google.analytics.data.v1beta.BetaAnalyticsDataSettings.Builder Builder for BetaAnalyticsDataSettings.
com.google.analytics.data.v1beta.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
com.google.analytics.data.v1beta.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
com.google.analytics.data.v1beta.CheckCompatibilityResponse The compatibility response with the compatibility of each dimension & metric.
com.google.analytics.data.v1beta.CheckCompatibilityResponse.Builder The compatibility response with the compatibility of each dimension & metric.
com.google.analytics.data.v1beta.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.
com.google.analytics.data.v1beta.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.
com.google.analytics.data.v1beta.CohortReportSettings.Builder Optional settings of a cohort report.
com.google.analytics.data.v1beta.CohortSpec The specification of cohorts for a cohort report. Cohort reports create a time series of user retention for the cohort. For
com.google.analytics.data.v1beta.CohortSpec.Builder The specification of cohorts for a cohort report. Cohort reports create a time series of user retention for the cohort. For
com.google.analytics.data.v1beta.CohortsRange Configures the extended reporting date range for a cohort report. Specifies an offset duration to follow the cohorts over.
com.google.analytics.data.v1beta.CohortsRange.Builder Configures the extended reporting date range for a cohort report. Specifies an offset duration to follow the cohorts over.
com.google.analytics.data.v1beta.DateRange A contiguous set of days: startDate, startDate + 1, ..., endDate. Requests are allowed up to 4 date ranges.
com.google.analytics.data.v1beta.DateRange.Builder A contiguous set of days: startDate, startDate + 1, ..., endDate. Requests are allowed up to 4 date ranges.
com.google.analytics.data.v1beta.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".
com.google.analytics.data.v1beta.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".
com.google.analytics.data.v1beta.DimensionCompatibility The compatibility for a single dimension.
com.google.analytics.data.v1beta.DimensionCompatibility.Builder The compatibility for a single dimension.
com.google.analytics.data.v1beta.DimensionExpression Used to express a dimension which is the result of a formula of multiple dimensions. Example usages: 1) lower_case(dimension)
com.google.analytics.data.v1beta.DimensionExpression.Builder Used to express a dimension which is the result of a formula of multiple dimensions. Example usages: 1) lower_case(dimension)
com.google.analytics.data.v1beta.DimensionExpression.CaseExpression Used to convert a dimension value to a single case.
com.google.analytics.data.v1beta.DimensionExpression.CaseExpression.Builder Used to convert a dimension value to a single case.
com.google.analytics.data.v1beta.DimensionExpression.ConcatenateExpression Used to combine dimension values to a single dimension.
com.google.analytics.data.v1beta.DimensionExpression.ConcatenateExpression.Builder Used to combine dimension values to a single dimension.
com.google.analytics.data.v1beta.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
com.google.analytics.data.v1beta.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
com.google.analytics.data.v1beta.DimensionMetadata Explains a dimension.
com.google.analytics.data.v1beta.DimensionMetadata.Builder Explains a dimension.
com.google.analytics.data.v1beta.DimensionValue The value of a dimension.
com.google.analytics.data.v1beta.DimensionValue.Builder The value of a dimension.
com.google.analytics.data.v1beta.Filter An expression to filter dimension or metric values.
com.google.analytics.data.v1beta.Filter.BetweenFilter To express that the result needs to be between two numbers (inclusive).
com.google.analytics.data.v1beta.Filter.BetweenFilter.Builder To express that the result needs to be between two numbers (inclusive).
com.google.analytics.data.v1beta.Filter.Builder An expression to filter dimension or metric values.
com.google.analytics.data.v1beta.Filter.InListFilter The result needs to be in a list of string values.
com.google.analytics.data.v1beta.Filter.InListFilter.Builder The result needs to be in a list of string values.
com.google.analytics.data.v1beta.Filter.NumericFilter Filters for numeric or date values.
com.google.analytics.data.v1beta.Filter.NumericFilter.Builder Filters for numeric or date values.
com.google.analytics.data.v1beta.Filter.StringFilter The filter for string
com.google.analytics.data.v1beta.Filter.StringFilter.Builder The filter for string
com.google.analytics.data.v1beta.FilterExpression To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics.
com.google.analytics.data.v1beta.FilterExpression.Builder To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics.
com.google.analytics.data.v1beta.FilterExpressionList A list of filter expressions.
com.google.analytics.data.v1beta.FilterExpressionList.Builder A list of filter expressions.
com.google.analytics.data.v1beta.GetMetadataRequest Request for a property's dimension and metric metadata.
com.google.analytics.data.v1beta.GetMetadataRequest.Builder Request for a property's dimension and metric metadata.
com.google.analytics.data.v1beta.Metadata The dimensions and metrics currently accepted in reporting methods.
com.google.analytics.data.v1beta.Metadata.Builder The dimensions and metrics currently accepted in reporting methods.
com.google.analytics.data.v1beta.MetadataName
com.google.analytics.data.v1beta.MetadataName.Builder Builder for properties/{property}/metadata.
com.google.analytics.data.v1beta.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.
com.google.analytics.data.v1beta.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.
com.google.analytics.data.v1beta.MetricCompatibility The compatibility for a single metric.
com.google.analytics.data.v1beta.MetricCompatibility.Builder The compatibility for a single metric.
com.google.analytics.data.v1beta.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
com.google.analytics.data.v1beta.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
com.google.analytics.data.v1beta.MetricMetadata Explains a metric.
com.google.analytics.data.v1beta.MetricMetadata.Builder Explains a metric.
com.google.analytics.data.v1beta.MetricValue The value of a metric.
com.google.analytics.data.v1beta.MetricValue.Builder The value of a metric.
com.google.analytics.data.v1beta.MinuteRange A contiguous set of minutes: startMinutesAgo, startMinutesAgo + 1, ..., endMinutesAgo. Requests are allowed up to 2 minute ranges.
com.google.analytics.data.v1beta.MinuteRange.Builder A contiguous set of minutes: startMinutesAgo, startMinutesAgo + 1, ..., endMinutesAgo. Requests are allowed up to 2 minute ranges.
com.google.analytics.data.v1beta.NumericValue To represent a number.
com.google.analytics.data.v1beta.NumericValue.Builder To represent a number.
com.google.analytics.data.v1beta.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.
com.google.analytics.data.v1beta.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.
com.google.analytics.data.v1beta.OrderBy.DimensionOrderBy Sorts by dimension values.
com.google.analytics.data.v1beta.OrderBy.DimensionOrderBy.Builder Sorts by dimension values.
com.google.analytics.data.v1beta.OrderBy.MetricOrderBy Sorts by metric values.
com.google.analytics.data.v1beta.OrderBy.MetricOrderBy.Builder Sorts by metric values.
com.google.analytics.data.v1beta.OrderBy.PivotOrderBy Sorts by a pivot column group.
com.google.analytics.data.v1beta.OrderBy.PivotOrderBy.Builder Sorts by a pivot column group.
com.google.analytics.data.v1beta.OrderBy.PivotOrderBy.PivotSelection A pair of dimension names and values. Rows with this dimension pivot pair are ordered by the metric's value.
com.google.analytics.data.v1beta.OrderBy.PivotOrderBy.PivotSelection.Builder A pair of dimension names and values. Rows with this dimension pivot pair are ordered by the metric's value.
com.google.analytics.data.v1beta.Pivot Describes the visible dimension columns and rows in the report response.
com.google.analytics.data.v1beta.Pivot.Builder Describes the visible dimension columns and rows in the report response.
com.google.analytics.data.v1beta.PivotDimensionHeader Summarizes dimension values from a row for this pivot.
com.google.analytics.data.v1beta.PivotDimensionHeader.Builder Summarizes dimension values from a row for this pivot.
com.google.analytics.data.v1beta.PivotHeader Dimensions' values in a single pivot.
com.google.analytics.data.v1beta.PivotHeader.Builder Dimensions' values in a single pivot.
com.google.analytics.data.v1beta.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.
com.google.analytics.data.v1beta.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.
com.google.analytics.data.v1beta.QuotaStatus Current state for a particular quota group.
com.google.analytics.data.v1beta.QuotaStatus.Builder Current state for a particular quota group.
com.google.analytics.data.v1beta.ReportingApiProto
com.google.analytics.data.v1beta.ResponseMetaData Response's metadata carrying additional information about the report content.
com.google.analytics.data.v1beta.ResponseMetaData.Builder Response's metadata carrying additional information about the report content.
com.google.analytics.data.v1beta.ResponseMetaData.SchemaRestrictionResponse The schema restrictions actively enforced in creating this report. To learn more, see Access and data-restriction management.
com.google.analytics.data.v1beta.ResponseMetaData.SchemaRestrictionResponse.ActiveMetricRestriction A metric actively restricted in creating the report.
com.google.analytics.data.v1beta.ResponseMetaData.SchemaRestrictionResponse.ActiveMetricRestriction.Builder A metric actively restricted in creating the report.
com.google.analytics.data.v1beta.ResponseMetaData.SchemaRestrictionResponse.Builder The schema restrictions actively enforced in creating this report. To learn more, see Access and data-restriction management.
com.google.analytics.data.v1beta.Row Report data for each row. For example if RunReportRequest contains:
com.google.analytics.data.v1beta.Row.Builder Report data for each row. For example if RunReportRequest contains:
com.google.analytics.data.v1beta.RunPivotReportRequest The request to generate a pivot report.
com.google.analytics.data.v1beta.RunPivotReportRequest.Builder The request to generate a pivot report.
com.google.analytics.data.v1beta.RunPivotReportResponse The response pivot report table corresponding to a pivot request.
com.google.analytics.data.v1beta.RunPivotReportResponse.Builder The response pivot report table corresponding to a pivot request.
com.google.analytics.data.v1beta.RunRealtimeReportRequest The request to generate a realtime report.
com.google.analytics.data.v1beta.RunRealtimeReportRequest.Builder The request to generate a realtime report.
com.google.analytics.data.v1beta.RunRealtimeReportResponse The response realtime report table corresponding to a request.
com.google.analytics.data.v1beta.RunRealtimeReportResponse.Builder The response realtime report table corresponding to a request.
com.google.analytics.data.v1beta.RunReportRequest The request to generate a report.
com.google.analytics.data.v1beta.RunReportRequest.Builder The request to generate a report.
com.google.analytics.data.v1beta.RunReportResponse The response report table corresponding to a request.
com.google.analytics.data.v1beta.RunReportResponse.Builder The response report table corresponding to a request.

Interfaces

Interface Description
com.google.analytics.data.v1beta.BatchRunPivotReportsRequestOrBuilder
com.google.analytics.data.v1beta.BatchRunPivotReportsResponseOrBuilder
com.google.analytics.data.v1beta.BatchRunReportsRequestOrBuilder
com.google.analytics.data.v1beta.BatchRunReportsResponseOrBuilder
com.google.analytics.data.v1beta.BetaAnalyticsDataGrpc.AsyncService Google Analytics reporting data service.
com.google.analytics.data.v1beta.CheckCompatibilityRequestOrBuilder
com.google.analytics.data.v1beta.CheckCompatibilityResponseOrBuilder
com.google.analytics.data.v1beta.CohortOrBuilder
com.google.analytics.data.v1beta.CohortReportSettingsOrBuilder
com.google.analytics.data.v1beta.CohortSpecOrBuilder
com.google.analytics.data.v1beta.CohortsRangeOrBuilder
com.google.analytics.data.v1beta.DateRangeOrBuilder
com.google.analytics.data.v1beta.DimensionCompatibilityOrBuilder
com.google.analytics.data.v1beta.DimensionExpression.CaseExpressionOrBuilder
com.google.analytics.data.v1beta.DimensionExpression.ConcatenateExpressionOrBuilder
com.google.analytics.data.v1beta.DimensionExpressionOrBuilder
com.google.analytics.data.v1beta.DimensionHeaderOrBuilder
com.google.analytics.data.v1beta.DimensionMetadataOrBuilder
com.google.analytics.data.v1beta.DimensionOrBuilder
com.google.analytics.data.v1beta.DimensionValueOrBuilder
com.google.analytics.data.v1beta.Filter.BetweenFilterOrBuilder
com.google.analytics.data.v1beta.Filter.InListFilterOrBuilder
com.google.analytics.data.v1beta.Filter.NumericFilterOrBuilder
com.google.analytics.data.v1beta.Filter.StringFilterOrBuilder
com.google.analytics.data.v1beta.FilterExpressionListOrBuilder
com.google.analytics.data.v1beta.FilterExpressionOrBuilder
com.google.analytics.data.v1beta.FilterOrBuilder
com.google.analytics.data.v1beta.GetMetadataRequestOrBuilder
com.google.analytics.data.v1beta.MetadataOrBuilder
com.google.analytics.data.v1beta.MetricCompatibilityOrBuilder
com.google.analytics.data.v1beta.MetricHeaderOrBuilder
com.google.analytics.data.v1beta.MetricMetadataOrBuilder
com.google.analytics.data.v1beta.MetricOrBuilder
com.google.analytics.data.v1beta.MetricValueOrBuilder
com.google.analytics.data.v1beta.MinuteRangeOrBuilder
com.google.analytics.data.v1beta.NumericValueOrBuilder
com.google.analytics.data.v1beta.OrderBy.DimensionOrderByOrBuilder
com.google.analytics.data.v1beta.OrderBy.MetricOrderByOrBuilder
com.google.analytics.data.v1beta.OrderBy.PivotOrderBy.PivotSelectionOrBuilder
com.google.analytics.data.v1beta.OrderBy.PivotOrderByOrBuilder
com.google.analytics.data.v1beta.OrderByOrBuilder
com.google.analytics.data.v1beta.PivotDimensionHeaderOrBuilder
com.google.analytics.data.v1beta.PivotHeaderOrBuilder
com.google.analytics.data.v1beta.PivotOrBuilder
com.google.analytics.data.v1beta.PropertyQuotaOrBuilder
com.google.analytics.data.v1beta.QuotaStatusOrBuilder
com.google.analytics.data.v1beta.ResponseMetaData.SchemaRestrictionResponse.ActiveMetricRestrictionOrBuilder
com.google.analytics.data.v1beta.ResponseMetaData.SchemaRestrictionResponseOrBuilder
com.google.analytics.data.v1beta.ResponseMetaDataOrBuilder
com.google.analytics.data.v1beta.RowOrBuilder
com.google.analytics.data.v1beta.RunPivotReportRequestOrBuilder
com.google.analytics.data.v1beta.RunPivotReportResponseOrBuilder
com.google.analytics.data.v1beta.RunRealtimeReportRequestOrBuilder
com.google.analytics.data.v1beta.RunRealtimeReportResponseOrBuilder
com.google.analytics.data.v1beta.RunReportRequestOrBuilder
com.google.analytics.data.v1beta.RunReportResponseOrBuilder

Enums

Enum Description
com.google.analytics.data.v1beta.CohortsRange.Granularity The granularity used to interpret the startOffset and endOffset for the extended reporting date range for a cohort report.
com.google.analytics.data.v1beta.Compatibility The compatibility types for a single dimension or metric.
com.google.analytics.data.v1beta.DimensionExpression.OneExpressionCase
com.google.analytics.data.v1beta.DimensionValue.OneValueCase
com.google.analytics.data.v1beta.Filter.NumericFilter.Operation The operation applied to a numeric filter
com.google.analytics.data.v1beta.Filter.OneFilterCase
com.google.analytics.data.v1beta.Filter.StringFilter.MatchType The match type of a string filter
com.google.analytics.data.v1beta.FilterExpression.ExprCase
com.google.analytics.data.v1beta.MetricAggregation Represents aggregation of metrics.
com.google.analytics.data.v1beta.MetricMetadata.BlockedReason Justifications for why this metric is blocked.
com.google.analytics.data.v1beta.MetricType A metric's value type.
com.google.analytics.data.v1beta.MetricValue.OneValueCase
com.google.analytics.data.v1beta.NumericValue.OneValueCase
com.google.analytics.data.v1beta.OrderBy.DimensionOrderBy.OrderType Rule to order the string dimension values by.
com.google.analytics.data.v1beta.OrderBy.OneOrderByCase
com.google.analytics.data.v1beta.RestrictedMetricType Categories of data that you may be restricted from viewing on certain GA4 properties.