As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Google Analytics Data v1beta API¶

class google.analytics.data_v1beta.types.AudienceDimension(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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

dimension_name¶

Optional. The API name of the dimension. See the API Dimensions for the list of dimension names.

Type: str

class google.analytics.data_v1beta.types.AudienceDimensionValue(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The value of a dimension.

value¶

Value as a string if the dimension type is a string.

This field is a member of oneof one_value.

Type: str

class google.analytics.data_v1beta.types.AudienceExport(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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.

name¶

Output only. Identifier. The audience export resource name assigned during creation. This resource name identifies this AudienceExport.

Format: properties/{property}/audienceExports/{audience_export}

Type: str

audience¶

Required. The audience resource name. This resource name identifies the audience being listed and is shared between the Analytics Data & Admin APIs.

Format: properties/{property}/audiences/{audience}

Type: str

audience_display_name¶

Output only. The descriptive display name for this audience. For example, “Purchasers”.

Type: str

dimensions¶

Required. The dimensions requested and displayed in the query response.

Type: MutableSequence[google.analytics.data_v1beta.types.AudienceDimension]

state¶

Output only. The current state for this AudienceExport.

This field is a member of oneof _state.

Type: google.analytics.data_v1beta.types.AudienceExport.State

begin_creating_time¶

Output only. The time when CreateAudienceExport was called and the AudienceExport began the CREATING state.

This field is a member of oneof _begin_creating_time.

Type: google.protobuf.timestamp_pb2.Timestamp

creation_quota_tokens_charged¶

Output only. The total quota tokens charged during creation of the AudienceExport. Because this token count is based on activity from the CREATING state, this tokens charged will be fixed once an AudienceExport enters the ACTIVE or FAILED states.

Type: int

row_count¶

Output only. The total number of rows in the AudienceExport result.

This field is a member of oneof _row_count.

Type: int

error_message¶

Output only. Error message is populated when an audience export fails during creation. A common reason for such a failure is quota exhaustion.

This field is a member of oneof _error_message.

Type: str

percentage_completed¶

Output only. The percentage completed for this audience export ranging between 0 to 100.

This field is a member of oneof _percentage_completed.

Type: float

class State(value)[source]¶

Bases: proto.enums.Enum

The AudienceExport currently exists in this state.

Values:

STATE_UNSPECIFIED (0):: Unspecified state will never be used.
CREATING (1):: The AudienceExport is currently creating and will be available in the future. Creating occurs immediately after the CreateAudienceExport call.
ACTIVE (2):: The AudienceExport is fully created and ready for querying. An AudienceExport is updated to active asynchronously from a request; this occurs some time (for example 15 minutes) after the initial create call.
FAILED (3):: The AudienceExport failed to be created. It is possible that re-requesting this audience export will succeed.

class google.analytics.data_v1beta.types.AudienceExportMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

This metadata is currently blank.

class google.analytics.data_v1beta.types.AudienceRow(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Dimension value attributes for the audience user row.

dimension_values¶

Each dimension value attribute for an audience user. One dimension value will be added for each dimension column requested.

Type: MutableSequence[google.analytics.data_v1beta.types.AudienceDimensionValue]

class google.analytics.data_v1beta.types.BatchRunPivotReportsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The batch request containing multiple pivot report requests.

property¶

A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see where to find your Property ID. This property must be specified for the batch. The property within RunPivotReportRequest may either be unspecified or consistent with this property.

Example: properties/1234

Type: str

requests¶

Individual requests. Each request has a separate pivot report response. Each batch request is allowed up to 5 requests.

Type: MutableSequence[google.analytics.data_v1beta.types.RunPivotReportRequest]

class google.analytics.data_v1beta.types.BatchRunPivotReportsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The batch response containing multiple pivot reports.

pivot_reports¶

Individual responses. Each response has a separate pivot report request.

Type: MutableSequence[google.analytics.data_v1beta.types.RunPivotReportResponse]

kind¶

Identifies what kind of resource this message is. This kind is always the fixed string “analyticsData#batchRunPivotReports”. Useful to distinguish between response types in JSON.

Type: str

class google.analytics.data_v1beta.types.BatchRunReportsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The batch request containing multiple report requests.

property¶

A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see where to find your Property ID. This property must be specified for the batch. The property within RunReportRequest may either be unspecified or consistent with this property.

Example: properties/1234

Type: str

requests¶

Individual requests. Each request has a separate report response. Each batch request is allowed up to 5 requests.

Type: MutableSequence[google.analytics.data_v1beta.types.RunReportRequest]

class google.analytics.data_v1beta.types.BatchRunReportsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The batch response containing multiple reports.

reports¶

Individual responses. Each response has a separate report request.

Type: MutableSequence[google.analytics.data_v1beta.types.RunReportResponse]

kind¶

Identifies what kind of resource this message is. This kind is always the fixed string “analyticsData#batchRunReports”. Useful to distinguish between response types in JSON.

Type: str

class google.analytics.data_v1beta.types.CheckCompatibilityRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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.

property¶

A Google Analytics GA4 property identifier whose events are tracked. To learn more, see where to find your Property ID. property should be the same value as in your runReport request.

Example: properties/1234

Type: str

dimensions¶

The dimensions in this report. dimensions should be the same value as in your runReport request.

Type: MutableSequence[google.analytics.data_v1beta.types.Dimension]

metrics¶

The metrics in this report. metrics should be the same value as in your runReport request.

Type: MutableSequence[google.analytics.data_v1beta.types.Metric]

dimension_filter¶

The filter clause of dimensions. dimensionFilter should be the same value as in your runReport request.

Type: google.analytics.data_v1beta.types.FilterExpression

metric_filter¶

The filter clause of metrics. metricFilter should be the same value as in your runReport request

Type: google.analytics.data_v1beta.types.FilterExpression

compatibility_filter¶

Filters the dimensions and metrics in the response to just this compatibility. Commonly used as ”compatibilityFilter”: “COMPATIBLE” to only return compatible dimensions & metrics.

Type: google.analytics.data_v1beta.types.Compatibility

class google.analytics.data_v1beta.types.CheckCompatibilityResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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

dimension_compatibilities¶

The compatibility of each dimension.

Type: MutableSequence[google.analytics.data_v1beta.types.DimensionCompatibility]

metric_compatibilities¶

The compatibility of each metric.

Type: MutableSequence[google.analytics.data_v1beta.types.MetricCompatibility]

class google.analytics.data_v1beta.types.Cohort(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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.

name¶

Assigns a name to this cohort. The dimension cohort is valued to this name in a report response. If set, cannot begin with cohort_ or RESERVED_. If not set, cohorts are named by their zero based index cohort_0, cohort_1, etc.

Type: str

dimension¶

Dimension used by the cohort. Required and only supports firstSessionDate.

Type: str

date_range¶

The cohort selects users whose first touch date is between start date and end date defined in the dateRange. This dateRange does not specify the full date range of event data that is present in a cohort report. In a cohort report, this dateRange is extended by the granularity and offset present in the cohortsRange; event data for the extended reporting date range is present in a cohort report.

In a cohort request, this dateRange is required and the dateRanges in the RunReportRequest or RunPivotReportRequest must be unspecified.

This dateRange should generally be aligned with the cohort’s granularity. If CohortsRange uses daily granularity, this dateRange can be a single day. If CohortsRange uses weekly granularity, this dateRange can be aligned to a week boundary, starting at Sunday and ending Saturday. If CohortsRange uses monthly granularity, this dateRange can be aligned to a month, starting at the first and ending on the last day of the month.

Type: google.analytics.data_v1beta.types.DateRange

class google.analytics.data_v1beta.types.CohortReportSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Optional settings of a cohort report.

accumulate¶

If true, accumulates the result from first touch day to the end day. Not supported in RunReportRequest.

Type: bool

class google.analytics.data_v1beta.types.CohortSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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.

cohorts¶

Defines the selection criteria to group users into cohorts. Most cohort reports define only a single cohort. If multiple cohorts are specified, each cohort can be recognized in the report by their name.

Type: MutableSequence[google.analytics.data_v1beta.types.Cohort]

cohorts_range¶

Cohort reports follow cohorts over an extended reporting date range. This range specifies an offset duration to follow the cohorts over.

Type: google.analytics.data_v1beta.types.CohortsRange

cohort_report_settings¶

Optional settings for a cohort report.

Type: google.analytics.data_v1beta.types.CohortReportSettings

class google.analytics.data_v1beta.types.CohortsRange(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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

granularity¶

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

Type: google.analytics.data_v1beta.types.CohortsRange.Granularity

start_offset¶

startOffset specifies the start date of the extended reporting date range for a cohort report. startOffset is commonly set to 0 so that reports contain data from the acquisition of the cohort forward.

If granularity is DAILY, the startDate of the extended reporting date range is startDate of the cohort plus startOffset days.

If granularity is WEEKLY, the startDate of the extended reporting date range is startDate of the cohort plus startOffset * 7 days.

If granularity is MONTHLY, the startDate of the extended reporting date range is startDate of the cohort plus startOffset * 30 days.

Type: int

end_offset¶

Required. endOffset specifies the end date of the extended reporting date range for a cohort report. endOffset can be any positive integer but is commonly set to 5 to 10 so that reports contain data on the cohort for the next several granularity time periods.

If granularity is DAILY, the endDate of the extended reporting date range is endDate of the cohort plus endOffset days.

If granularity is WEEKLY, the endDate of the extended reporting date range is endDate of the cohort plus endOffset * 7 days.

If granularity is MONTHLY, the endDate of the extended reporting date range is endDate of the cohort plus endOffset * 30 days.

Type: int

class Granularity(value)[source]¶

Bases: proto.enums.Enum

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

Values:

GRANULARITY_UNSPECIFIED (0):: Should never be specified.
DAILY (1):: Daily granularity. Commonly used if the cohort’s dateRange is a single day and the request contains cohortNthDay.
WEEKLY (2):: Weekly granularity. Commonly used if the cohort’s dateRange is a week in duration (starting on Sunday and ending on Saturday) and the request contains cohortNthWeek.
MONTHLY (3):: Monthly granularity. Commonly used if the cohort’s dateRange is a month in duration and the request contains cohortNthMonth.

class google.analytics.data_v1beta.types.Comparison(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Defines an individual comparison. Most requests will include multiple comparisons so that the report compares between the comparisons.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

name¶

Each comparison produces separate rows in the response. In the response, this comparison is identified by this name. If name is unspecified, we will use the saved comparisons display name.

This field is a member of oneof _name.

Type: str

dimension_filter¶

A basic comparison.

This field is a member of oneof one_comparison.

Type: google.analytics.data_v1beta.types.FilterExpression

comparison¶

A saved comparison identified by the comparison’s resource name. For example, ‘comparisons/1234’.

This field is a member of oneof one_comparison.

Type: str

class google.analytics.data_v1beta.types.ComparisonMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The metadata for a single comparison.

api_name¶

This comparison’s resource name. Useable in Comparison’s comparison field. For example, ‘comparisons/1234’.

Type: str

ui_name¶

This comparison’s name within the Google Analytics user interface.

Type: str

description¶

This comparison’s description.

Type: str

class google.analytics.data_v1beta.types.Compatibility(value)[source]¶

Bases: proto.enums.Enum

The compatibility types for a single dimension or metric.

Values:

COMPATIBILITY_UNSPECIFIED (0):: Unspecified compatibility.
COMPATIBLE (1):: The dimension or metric is compatible. This dimension or metric can be successfully added to a report.
INCOMPATIBLE (2):: The dimension or metric is incompatible. This dimension or metric cannot be successfully added to a report.

class google.analytics.data_v1beta.types.CreateAudienceExportRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A request to create a new audience export.

parent¶

Required. The parent resource where this audience export will be created. Format: properties/{property}

Type: str

audience_export¶

Required. The audience export to create.

Type: google.analytics.data_v1beta.types.AudienceExport

class google.analytics.data_v1beta.types.DateRange(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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

start_date¶

The inclusive start date for the query in the format YYYY-MM-DD. Cannot be after end_date. The format NdaysAgo, yesterday, or today is also accepted, and in that case, the date is inferred based on the property’s reporting time zone.

Type: str

end_date¶

The inclusive end date for the query in the format YYYY-MM-DD. Cannot be before start_date. The format NdaysAgo, yesterday, or today is also accepted, and in that case, the date is inferred based on the property’s reporting time zone.

Type: str

name¶

Assigns a name to this date range. The dimension dateRange is valued to this name in a report response. If set, cannot begin with date_range_ or RESERVED_. If not set, date ranges are named by their zero based index in the request: date_range_0, date_range_1, etc.

Type: str

class google.analytics.data_v1beta.types.Dimension(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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.

name¶

The name of the dimension. See the API Dimensions for the list of dimension names supported by core reporting methods such as runReport and batchRunReports. See Realtime Dimensions for the list of dimension names supported by the runRealtimeReport method. See Funnel Dimensions for the list of dimension names supported by the runFunnelReport method.

If dimensionExpression is specified, name can be any string that you would like within the allowed character set. For example if a dimensionExpression concatenates country and city, you could call that dimension countryAndCity. Dimension names that you choose must match the regular expression ^[a-zA-Z0-9_]$.

Dimensions are referenced by name in dimensionFilter, orderBys, dimensionExpression, and pivots.

Type: str

dimension_expression¶

One dimension can be the result of an expression of multiple dimensions. For example, dimension “country, city”: concatenate(country, “, “, city).

Type: google.analytics.data_v1beta.types.DimensionExpression

class google.analytics.data_v1beta.types.DimensionCompatibility(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The compatibility for a single dimension.

dimension_metadata¶

The dimension metadata contains the API name for this compatibility information. The dimension metadata also contains other helpful information like the UI name and description.

This field is a member of oneof _dimension_metadata.

Type: google.analytics.data_v1beta.types.DimensionMetadata

compatibility¶

The compatibility of this dimension. If the compatibility is COMPATIBLE, this dimension can be successfully added to the report.

This field is a member of oneof _compatibility.

Type: google.analytics.data_v1beta.types.Compatibility

class google.analytics.data_v1beta.types.DimensionExpression(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Used to express a dimension which is the result of a formula of multiple dimensions. Example usages:

lower_case(dimension)
concatenate(dimension1, symbol, dimension2).

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

lower_case¶

Used to convert a dimension value to lower case.

This field is a member of oneof one_expression.

Type: google.analytics.data_v1beta.types.DimensionExpression.CaseExpression

upper_case¶

Used to convert a dimension value to upper case.

This field is a member of oneof one_expression.

Type: google.analytics.data_v1beta.types.DimensionExpression.CaseExpression

concatenate¶

Used to combine dimension values to a single dimension. For example, dimension “country, city”: concatenate(country, “, “, city).

This field is a member of oneof one_expression.

Type: google.analytics.data_v1beta.types.DimensionExpression.ConcatenateExpression

class CaseExpression(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Used to convert a dimension value to a single case.

dimension_name¶

Name of a dimension. The name must refer back to a name in dimensions field of the request.

Type: str

class ConcatenateExpression(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Used to combine dimension values to a single dimension.

dimension_names¶

Names of dimensions. The names must refer back to names in the dimensions field of the request.

Type: MutableSequence[str]

delimiter¶

The delimiter placed between dimension names.

Delimiters are often single characters such as “|” or “,” but can be longer strings. If a dimension value contains the delimiter, both will be present in response with no distinction. For example if dimension 1 value = “US,FR”, dimension 2 value = “JP”, and delimiter = “,”, then the response will contain “US,FR,JP”.

Type: str

class google.analytics.data_v1beta.types.DimensionHeader(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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.

name¶

The dimension’s name.

Type: str

class google.analytics.data_v1beta.types.DimensionMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Explains a dimension.

api_name¶

This dimension’s name. Useable in Dimension’s name. For example, eventName.

Type: str

ui_name¶

This dimension’s name within the Google Analytics user interface. For example, Event name.

Type: str

description¶

Description of how this dimension is used and calculated.

Type: str

deprecated_api_names¶

Still usable but deprecated names for this dimension. If populated, this dimension is available by either apiName or one of deprecatedApiNames for a period of time. After the deprecation period, the dimension will be available only by apiName.

Type: MutableSequence[str]

custom_definition¶

True if the dimension is custom to this property. This includes user, event, & item scoped custom dimensions; to learn more about custom dimensions, see https://support.google.com/analytics/answer/14240153. This also include custom channel groups; to learn more about custom channel groups, see https://support.google.com/analytics/answer/13051316.

Type: bool

category¶

The display name of the category that this dimension belongs to. Similar dimensions and metrics are categorized together.

Type: str

class google.analytics.data_v1beta.types.DimensionValue(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The value of a dimension.

value¶

Value as a string if the dimension type is a string.

This field is a member of oneof one_value.

Type: str

class google.analytics.data_v1beta.types.Filter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

An expression to filter dimension or metric values.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

field_name¶

The dimension name or metric name.

In most methods, dimensions & metrics can be used for the first time in this field. However in a RunPivotReportRequest, this field must be additionally specified by name in the RunPivotReportRequest’s dimensions or metrics.

Type: str

string_filter¶

Strings related filter.

This field is a member of oneof one_filter.

Type: google.analytics.data_v1beta.types.Filter.StringFilter

in_list_filter¶

A filter for in list values.

This field is a member of oneof one_filter.

Type: google.analytics.data_v1beta.types.Filter.InListFilter

numeric_filter¶

A filter for numeric or date values.

This field is a member of oneof one_filter.

Type: google.analytics.data_v1beta.types.Filter.NumericFilter

between_filter¶

A filter for two values.

This field is a member of oneof one_filter.

Type: google.analytics.data_v1beta.types.Filter.BetweenFilter

class BetweenFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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

from_value¶

Begins with this number.

Type: google.analytics.data_v1beta.types.NumericValue

to_value¶

Ends with this number.

Type: google.analytics.data_v1beta.types.NumericValue

class InListFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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

values¶

The list of string values. Must be non-empty.

Type: MutableSequence[str]

case_sensitive¶

If true, the string value is case sensitive.

Type: bool

class NumericFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Filters for numeric or date values.

operation¶

The operation type for this filter.

Type: google.analytics.data_v1beta.types.Filter.NumericFilter.Operation

value¶

A numeric value or a date value.

Type: google.analytics.data_v1beta.types.NumericValue

class Operation(value)[source]¶

Bases: proto.enums.Enum

The operation applied to a numeric filter

Values:

OPERATION_UNSPECIFIED (0):: Unspecified.
EQUAL (1):: Equal
LESS_THAN (2):: Less than
LESS_THAN_OR_EQUAL (3):: Less than or equal
GREATER_THAN (4):: Greater than
GREATER_THAN_OR_EQUAL (5):: Greater than or equal

class StringFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The filter for string

match_type¶

The match type for this filter.

Type: google.analytics.data_v1beta.types.Filter.StringFilter.MatchType

value¶

The string value used for the matching.

Type: str

case_sensitive¶

If true, the string value is case sensitive.

Type: bool

class MatchType(value)[source]¶

Bases: proto.enums.Enum

The match type of a string filter

Values:

MATCH_TYPE_UNSPECIFIED (0):: Unspecified
EXACT (1):: Exact match of the string value.
BEGINS_WITH (2):: Begins with the string value.
ENDS_WITH (3):: Ends with the string value.
CONTAINS (4):: Contains the string value.
FULL_REGEXP (5):: Full match for the regular expression with the string value.
PARTIAL_REGEXP (6):: Partial match for the regular expression with the string value.

class google.analytics.data_v1beta.types.FilterExpression(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

and_group¶

The FilterExpressions in and_group have an AND relationship.

This field is a member of oneof expr.

Type: google.analytics.data_v1beta.types.FilterExpressionList

or_group¶

The FilterExpressions in or_group have an OR relationship.

This field is a member of oneof expr.

Type: google.analytics.data_v1beta.types.FilterExpressionList

not_expression¶

The FilterExpression is NOT of not_expression.

This field is a member of oneof expr.

Type: google.analytics.data_v1beta.types.FilterExpression

filter¶

A primitive filter. In the same FilterExpression, all of the filter’s field names need to be either all dimensions or all metrics.

This field is a member of oneof expr.

Type: google.analytics.data_v1beta.types.Filter

class google.analytics.data_v1beta.types.FilterExpressionList(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A list of filter expressions.

expressions¶

A list of filter expressions.

Type: MutableSequence[google.analytics.data_v1beta.types.FilterExpression]

class google.analytics.data_v1beta.types.GetAudienceExportRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A request to retrieve configuration metadata about a specific audience export.

name¶

Required. The audience export resource name. Format: properties/{property}/audienceExports/{audience_export}

Type: str

class google.analytics.data_v1beta.types.GetMetadataRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Request for a property’s dimension and metric metadata.

name¶

Required. The resource name of the metadata to retrieve. This name field is specified in the URL path and not URL parameters. Property is a numeric Google Analytics GA4 Property identifier. To learn more, see where to find your Property ID.

Example: properties/1234/metadata

Set the Property ID to 0 for dimensions and metrics common to all properties. In this special mode, this method will not return custom dimensions and metrics.

Type: str

class google.analytics.data_v1beta.types.ListAudienceExportsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A request to list all audience exports for a property.

parent¶

Required. All audience exports for this property will be listed in the response. Format: properties/{property}

Type: str

page_size¶

Optional. The maximum number of audience exports to return. The service may return fewer than this value. If unspecified, at most 200 audience exports will be returned. The maximum value is 1000 (higher values will be coerced to the maximum).

Type: int

page_token¶

Optional. A page token, received from a previous ListAudienceExports call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListAudienceExports must match the call that provided the page token.

Type: str

class google.analytics.data_v1beta.types.ListAudienceExportsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A list of all audience exports for a property.

audience_exports¶

Each audience export for a property.

Type: MutableSequence[google.analytics.data_v1beta.types.AudienceExport]

next_page_token¶

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

This field is a member of oneof _next_page_token.

Type: str

class google.analytics.data_v1beta.types.Metadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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

name¶

Resource name of this metadata.

Type: str

dimensions¶

The dimension descriptions.

Type: MutableSequence[google.analytics.data_v1beta.types.DimensionMetadata]

metrics¶

The metric descriptions.

Type: MutableSequence[google.analytics.data_v1beta.types.MetricMetadata]

comparisons¶

The comparison descriptions.

Type: MutableSequence[google.analytics.data_v1beta.types.ComparisonMetadata]

class google.analytics.data_v1beta.types.Metric(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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

name¶

The name of the metric. See the API Metrics for the list of metric names supported by core reporting methods such as runReport and batchRunReports. See Realtime Metrics for the list of metric names supported by the runRealtimeReport method. See Funnel Metrics for the list of metric names supported by the runFunnelReport method.

If expression is specified, name can be any string that you would like within the allowed character set. For example if expression is screenPageViews/sessions, you could call that metric’s name = viewsPerSession. Metric names that you choose must match the regular expression ^[a-zA-Z0-9_]$.

Metrics are referenced by name in metricFilter, orderBys, and metric expression.

Type: str

expression¶

A mathematical expression for derived metrics. For example, the metric Event count per user is eventCount/totalUsers.

Type: str

invisible¶

Indicates if a metric is invisible in the report response. If a metric is invisible, the metric will not produce a column in the response, but can be used in metricFilter, orderBys, or a metric expression.

Type: bool

class google.analytics.data_v1beta.types.MetricAggregation(value)[source]¶

Bases: proto.enums.Enum

Represents aggregation of metrics.

Values:

METRIC_AGGREGATION_UNSPECIFIED (0):: Unspecified operator.
TOTAL (1):: SUM operator.
MINIMUM (5):: Minimum operator.
MAXIMUM (6):: Maximum operator.
COUNT (4):: Count operator.

class google.analytics.data_v1beta.types.MetricCompatibility(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The compatibility for a single metric.

metric_metadata¶

The metric metadata contains the API name for this compatibility information. The metric metadata also contains other helpful information like the UI name and description.

This field is a member of oneof _metric_metadata.

Type: google.analytics.data_v1beta.types.MetricMetadata

compatibility¶

The compatibility of this metric. If the compatibility is COMPATIBLE, this metric can be successfully added to the report.

This field is a member of oneof _compatibility.

Type: google.analytics.data_v1beta.types.Compatibility

class google.analytics.data_v1beta.types.MetricHeader(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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.

name¶

The metric’s name.

Type: str

type_¶

The metric’s data type.

Type: google.analytics.data_v1beta.types.MetricType

class google.analytics.data_v1beta.types.MetricMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Explains a metric.

api_name¶

A metric name. Useable in Metric’s name. For example, eventCount.

Type: str

ui_name¶

This metric’s name within the Google Analytics user interface. For example, Event count.

Type: str

description¶

Description of how this metric is used and calculated.

Type: str

deprecated_api_names¶

Still usable but deprecated names for this metric. If populated, this metric is available by either apiName or one of deprecatedApiNames for a period of time. After the deprecation period, the metric will be available only by apiName.

Type: MutableSequence[str]

type_¶

The type of this metric.

Type: google.analytics.data_v1beta.types.MetricType

expression¶

The mathematical expression for this derived metric. Can be used in Metric’s expression field for equivalent reports. Most metrics are not expressions, and for non-expressions, this field is empty.

Type: str

custom_definition¶

True if the metric is a custom metric for this property.

Type: bool

blocked_reasons¶

If reasons are specified, your access is blocked to this metric for this property. API requests from you to this property for this metric will succeed; however, the report will contain only zeros for this metric. API requests with metric filters on blocked metrics will fail. If reasons are empty, you have access to this metric.

To learn more, see Access and data-restriction management.

Type: MutableSequence[google.analytics.data_v1beta.types.MetricMetadata.BlockedReason]

category¶

The display name of the category that this metrics belongs to. Similar dimensions and metrics are categorized together.

Type: str

class BlockedReason(value)[source]¶

Bases: proto.enums.Enum

Justifications for why this metric is blocked.

Values:

BLOCKED_REASON_UNSPECIFIED (0):: Will never be specified in API response.
NO_REVENUE_METRICS (1):: If present, your access is blocked to revenue related metrics for this property, and this metric is revenue related.
NO_COST_METRICS (2):: If present, your access is blocked to cost related metrics for this property, and this metric is cost related.

class google.analytics.data_v1beta.types.MetricType(value)[source]¶

Bases: proto.enums.Enum

A metric’s value type.

Values:

METRIC_TYPE_UNSPECIFIED (0):: Unspecified type.
TYPE_INTEGER (1):: Integer type.
TYPE_FLOAT (2):: Floating point type.
TYPE_SECONDS (4):: A duration of seconds; a special floating point type.
TYPE_MILLISECONDS (5):: A duration in milliseconds; a special floating point type.
TYPE_MINUTES (6):: A duration in minutes; a special floating point type.
TYPE_HOURS (7):: A duration in hours; a special floating point type.
TYPE_STANDARD (8):: A custom metric of standard type; a special floating point type.
TYPE_CURRENCY (9):: An amount of money; a special floating point type.
TYPE_FEET (10):: A length in feet; a special floating point type.
TYPE_MILES (11):: A length in miles; a special floating point type.
TYPE_METERS (12):: A length in meters; a special floating point type.
TYPE_KILOMETERS (13):: A length in kilometers; a special floating point type.

class google.analytics.data_v1beta.types.MetricValue(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The value of a metric.

value¶

Measurement value. See MetricHeader for type.

This field is a member of oneof one_value.

Type: str

class google.analytics.data_v1beta.types.MinuteRange(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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

start_minutes_ago¶

The inclusive start minute for the query as a number of minutes before now. For example, "startMinutesAgo": 29 specifies the report should include event data from 29 minutes ago and after. Cannot be after endMinutesAgo.

If unspecified, startMinutesAgo is defaulted to 29. Standard Analytics properties can request up to the last 30 minutes of event data (startMinutesAgo <= 29), and 360 Analytics properties can request up to the last 60 minutes of event data (startMinutesAgo <= 59).

This field is a member of oneof _start_minutes_ago.

Type: int

end_minutes_ago¶

The inclusive end minute for the query as a number of minutes before now. Cannot be before startMinutesAgo. For example, "endMinutesAgo": 15 specifies the report should include event data from prior to 15 minutes ago.

If unspecified, endMinutesAgo is defaulted to 0. Standard Analytics properties can request any minute in the last 30 minutes of event data (endMinutesAgo <= 29), and 360 Analytics properties can request any minute in the last 60 minutes of event data (endMinutesAgo <= 59).

This field is a member of oneof _end_minutes_ago.

Type: int

name¶

Assigns a name to this minute range. The dimension dateRange is valued to this name in a report response. If set, cannot begin with date_range_ or RESERVED_. If not set, minute ranges are named by their zero based index in the request: date_range_0, date_range_1, etc.

Type: str

class google.analytics.data_v1beta.types.NumericValue(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

To represent a number.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

int64_value¶

Integer value

This field is a member of oneof one_value.

Type: int

double_value¶

Double value

This field is a member of oneof one_value.

Type: float

class google.analytics.data_v1beta.types.OrderBy(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

metric¶

Sorts results by a metric’s values.

This field is a member of oneof one_order_by.

Type: google.analytics.data_v1beta.types.OrderBy.MetricOrderBy

dimension¶

Sorts results by a dimension’s values.

This field is a member of oneof one_order_by.

Type: google.analytics.data_v1beta.types.OrderBy.DimensionOrderBy

pivot¶

Sorts results by a metric’s values within a pivot column group.

This field is a member of oneof one_order_by.

Type: google.analytics.data_v1beta.types.OrderBy.PivotOrderBy

desc¶

If true, sorts by descending order.

Type: bool

class DimensionOrderBy(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Sorts by dimension values.

dimension_name¶

A dimension name in the request to order by.

Type: str

order_type¶

Controls the rule for dimension value ordering.

Type: google.analytics.data_v1beta.types.OrderBy.DimensionOrderBy.OrderType

class OrderType(value)[source]¶

Bases: proto.enums.Enum

Rule to order the string dimension values by.

Values:

ORDER_TYPE_UNSPECIFIED (0):: Unspecified.
ALPHANUMERIC (1):: Alphanumeric sort by Unicode code point. For example, “2” < “A” < “X” < “b” < “z”.
CASE_INSENSITIVE_ALPHANUMERIC (2):: Case insensitive alphanumeric sort by lower case Unicode code point. For example, “2” < “A” < “b” < “X” < “z”.
NUMERIC (3):: Dimension values are converted to numbers before sorting. For example in NUMERIC sort, “25” < “100”, and in ALPHANUMERIC sort, “100” < “25”. Non-numeric dimension values all have equal ordering value below all numeric values.

class MetricOrderBy(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Sorts by metric values.

metric_name¶

A metric name in the request to order by.

Type: str

class PivotOrderBy(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Sorts by a pivot column group.

metric_name¶

In the response to order by, order rows by this column. Must be a metric name from the request.

Type: str

pivot_selections¶

Used to select a dimension name and value pivot. If multiple pivot selections are given, the sort occurs on rows where all pivot selection dimension name and value pairs match the row’s dimension name and value pair.

Type: MutableSequence[google.analytics.data_v1beta.types.OrderBy.PivotOrderBy.PivotSelection]

class PivotSelection(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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

dimension_name¶

Must be a dimension name from the request.

Type: str

dimension_value¶

Order by only when the named dimension is this value.

Type: str

class google.analytics.data_v1beta.types.Pivot(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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

field_names¶

Dimension names for visible columns in the report response. Including “dateRange” produces a date range column; for each row in the response, dimension values in the date range column will indicate the corresponding date range from the request.

Type: MutableSequence[str]

order_bys¶

Specifies how dimensions are ordered in the pivot. In the first Pivot, the OrderBys determine Row and PivotDimensionHeader ordering; in subsequent Pivots, the OrderBys determine only PivotDimensionHeader ordering. Dimensions specified in these OrderBys must be a subset of Pivot.field_names.

Type: MutableSequence[google.analytics.data_v1beta.types.OrderBy]

offset¶

The row count of the start row. The first row is counted as row 0.

Type: int

limit¶

The number of unique combinations of dimension values to return in this pivot. The limit parameter is required. A limit of 10,000 is common for single pivot requests.

The product of the limit for each pivot in a RunPivotReportRequest must not exceed 250,000. For example, a two pivot request with limit: 1000 in each pivot will fail because the product is 1,000,000.

Type: int

metric_aggregations¶

Aggregate the metrics by dimensions in this pivot using the specified metric_aggregations.

Type: MutableSequence[google.analytics.data_v1beta.types.MetricAggregation]

class google.analytics.data_v1beta.types.PivotDimensionHeader(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Summarizes dimension values from a row for this pivot.

dimension_values¶

Values of multiple dimensions in a pivot.

Type: MutableSequence[google.analytics.data_v1beta.types.DimensionValue]

class google.analytics.data_v1beta.types.PivotHeader(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Dimensions’ values in a single pivot.

pivot_dimension_headers¶

The size is the same as the cardinality of the corresponding dimension combinations.

Type: MutableSequence[google.analytics.data_v1beta.types.PivotDimensionHeader]

row_count¶

The cardinality of the pivot. The total number of rows for this pivot’s fields regardless of how the parameters offset and limit are specified in the request.

Type: int

class google.analytics.data_v1beta.types.PropertyQuota(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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.

tokens_per_day¶

Standard Analytics Properties can use up to 200,000 tokens per day; Analytics 360 Properties can use 2,000,000 tokens per day. Most requests consume fewer than 10 tokens.

Type: google.analytics.data_v1beta.types.QuotaStatus

tokens_per_hour¶

Standard Analytics Properties can use up to 40,000 tokens per hour; Analytics 360 Properties can use 400,000 tokens per hour. An API request consumes a single number of tokens, and that number is deducted from all of the hourly, daily, and per project hourly quotas.

Type: google.analytics.data_v1beta.types.QuotaStatus

concurrent_requests¶

Standard Analytics Properties can send up to 10 concurrent requests; Analytics 360 Properties can use up to 50 concurrent requests.

Type: google.analytics.data_v1beta.types.QuotaStatus

server_errors_per_project_per_hour¶

Standard Analytics Properties and cloud project pairs can have up to 10 server errors per hour; Analytics 360 Properties and cloud project pairs can have up to 50 server errors per hour.

Type: google.analytics.data_v1beta.types.QuotaStatus

potentially_thresholded_requests_per_hour¶

Analytics Properties can send up to 120 requests with potentially thresholded dimensions per hour. In a batch request, each report request is individually counted for this quota if the request contains potentially thresholded dimensions.

Type: google.analytics.data_v1beta.types.QuotaStatus

tokens_per_project_per_hour¶

Analytics Properties can use up to 35% of their tokens per project per hour. This amounts to standard Analytics Properties can use up to 14,000 tokens per project per hour, and Analytics 360 Properties can use 140,000 tokens per project per hour. An API request consumes a single number of tokens, and that number is deducted from all of the hourly, daily, and per project hourly quotas.

Type: google.analytics.data_v1beta.types.QuotaStatus

class google.analytics.data_v1beta.types.QueryAudienceExportRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A request to list users in an audience export.

name¶

Required. The name of the audience export to retrieve users from. Format: properties/{property}/audienceExports/{audience_export}

Type: str

offset¶

Optional. The row count of the start row. The first row is counted as row 0.

When paging, the first request does not specify offset; or equivalently, sets offset to 0; the first request returns the first limit of rows. The second request sets offset to the limit of the first request; the second request returns the second limit of rows.

To learn more about this pagination parameter, see Pagination.

Type: int

limit¶

Optional. The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 250,000 rows per request, no matter how many you ask for. limit must be positive.

The API can also return fewer rows than the requested limit, if there aren’t as many dimension values as the limit.

To learn more about this pagination parameter, see Pagination.

Type: int

class google.analytics.data_v1beta.types.QueryAudienceExportResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A list of users in an audience export.

audience_export¶

Configuration data about AudienceExport being queried. Returned to help interpret the audience rows in this response. For example, the dimensions in this AudienceExport correspond to the columns in the AudienceRows.

This field is a member of oneof _audience_export.

Type: google.analytics.data_v1beta.types.AudienceExport

audience_rows¶

Rows for each user in an audience export. The number of rows in this response will be less than or equal to request’s page size.

Type: MutableSequence[google.analytics.data_v1beta.types.AudienceRow]

row_count¶

The total number of rows in the AudienceExport result. rowCount is independent of the number of rows returned in the response, the limit request parameter, and the offset request parameter. For example if a query returns 175 rows and includes limit of 50 in the API request, the response will contain rowCount of 175 but only 50 rows.

To learn more about this pagination parameter, see Pagination.

This field is a member of oneof _row_count.

Type: int

class google.analytics.data_v1beta.types.QuotaStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Current state for a particular quota group.

consumed¶

Quota consumed by this request.

This field is a member of oneof _consumed.

Type: int

remaining¶

Quota remaining after this request.

This field is a member of oneof _remaining.

Type: int

class google.analytics.data_v1beta.types.ResponseMetaData(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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

data_loss_from_other_row¶

If true, indicates some buckets of dimension combinations are rolled into “(other)” row. This can happen for high cardinality reports.

The metadata parameter dataLossFromOtherRow is populated based on the aggregated data table used in the report. The parameter will be accurately populated regardless of the filters and limits in the report.

For example, the (other) row could be dropped from the report because the request contains a filter on sessionSource = google. This parameter will still be populated if data loss from other row was present in the input aggregate data used to generate this report.

To learn more, see About the (other) row and data sampling.

Type: bool

schema_restriction_response¶

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

This field is a member of oneof _schema_restriction_response.

Type: google.analytics.data_v1beta.types.ResponseMetaData.SchemaRestrictionResponse

currency_code¶

The currency code used in this report. Intended to be used in formatting currency metrics like purchaseRevenue for visualization. If currency_code was specified in the request, this response parameter will echo the request parameter; otherwise, this response parameter is the property’s current currency_code.

Currency codes are string encodings of currency types from the ISO 4217 standard (https://en.wikipedia.org/wiki/ISO_4217); for example “USD”, “EUR”, “JPY”. To learn more, see https://support.google.com/analytics/answer/9796179.

This field is a member of oneof _currency_code.

Type: str

time_zone¶

The property’s current timezone. Intended to be used to interpret time-based dimensions like hour and minute. Formatted as strings from the IANA Time Zone database (https://www.iana.org/time-zones); for example “America/New_York” or “Asia/Tokyo”.

This field is a member of oneof _time_zone.

Type: str

empty_reason¶

If empty reason is specified, the report is empty for this reason.

This field is a member of oneof _empty_reason.

Type: str

subject_to_thresholding¶

If subjectToThresholding is true, this report is subject to thresholding and only returns data that meets the minimum aggregation thresholds. It is possible for a request to be subject to thresholding thresholding and no data is absent from the report, and this happens when all data is above the thresholds. To learn more, see Data thresholds.

This field is a member of oneof _subject_to_thresholding.

Type: bool

sampling_metadatas¶

If this report results is sampled, this describes the percentage of events used in this report. One samplingMetadatas is populated for each date range. Each samplingMetadatas corresponds to a date range in order that date ranges were specified in the request.

However if the results are not sampled, this field will not be defined.

Type: MutableSequence[google.analytics.data_v1beta.types.SamplingMetadata]

class SchemaRestrictionResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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

active_metric_restrictions¶

All restrictions actively enforced in creating the report. For example, purchaseRevenue always has the restriction type REVENUE_DATA. However, this active response restriction is only populated if the user’s custom role disallows access to REVENUE_DATA.

Type: MutableSequence[google.analytics.data_v1beta.types.ResponseMetaData.SchemaRestrictionResponse.ActiveMetricRestriction]

class ActiveMetricRestriction(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

A metric actively restricted in creating the report.

metric_name¶

The name of the restricted metric.

This field is a member of oneof _metric_name.

Type: str

restricted_metric_types¶

The reason for this metric’s restriction.

Type: MutableSequence[google.analytics.data_v1beta.types.RestrictedMetricType]

class google.analytics.data_v1beta.types.RestrictedMetricType(value)[source]¶

Bases: proto.enums.Enum

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

Values:

RESTRICTED_METRIC_TYPE_UNSPECIFIED (0):: Unspecified type.
COST_DATA (1):: Cost metrics such as adCost.
REVENUE_DATA (2):: Revenue metrics such as purchaseRevenue.

class google.analytics.data_v1beta.types.Row(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Report data for each row. For example if RunReportRequest contains:

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

"dimensionValues": [
  {
    "value": "in_app_purchase"
  },
  {
    "value": "JP"
  }
],
"metricValues": [
  {
    "value": "15"
  }
]

dimension_values¶

List of requested dimension values. In a PivotReport, dimension_values are only listed for dimensions included in a pivot.

Type: MutableSequence[google.analytics.data_v1beta.types.DimensionValue]

metric_values¶

List of requested visible metric values.

Type: MutableSequence[google.analytics.data_v1beta.types.MetricValue]

class google.analytics.data_v1beta.types.RunPivotReportRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request to generate a pivot report.

property¶

A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see where to find your Property ID. Within a batch request, this property should either be unspecified or consistent with the batch-level property.

Example: properties/1234

Type: str

dimensions¶

The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys.

Type: MutableSequence[google.analytics.data_v1beta.types.Dimension]

metrics¶

The metrics requested, at least one metric needs to be specified. All defined metrics must be used by one of the following: metric_expression, metric_filter, order_bys.

Type: MutableSequence[google.analytics.data_v1beta.types.Metric]

date_ranges¶

The date range to retrieve event data for the report. If multiple date ranges are specified, event data from each date range is used in the report. A special dimension with field name “dateRange” can be included in a Pivot’s field names; if included, the report compares between date ranges. In a cohort request, this dateRanges must be unspecified.

Type: MutableSequence[google.analytics.data_v1beta.types.DateRange]

pivots¶

Describes the visual format of the report’s dimensions in columns or rows. The union of the fieldNames (dimension names) in all pivots must be a subset of dimension names defined in Dimensions. No two pivots can share a dimension. A dimension is only visible if it appears in a pivot.

Type: MutableSequence[google.analytics.data_v1beta.types.Pivot]

dimension_filter¶

The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter.

Type: google.analytics.data_v1beta.types.FilterExpression

metric_filter¶

The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Metrics must be requested to be used in this filter. Dimensions cannot be used in this filter.

Type: google.analytics.data_v1beta.types.FilterExpression

currency_code¶

A currency code in ISO4217 format, such as “AED”, “USD”, “JPY”. If the field is empty, the report uses the property’s default currency.

Type: str

cohort_spec¶

Cohort group associated with this request. If there is a cohort group in the request the ‘cohort’ dimension must be present.

Type: google.analytics.data_v1beta.types.CohortSpec

keep_empty_rows¶

If false or unspecified, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter.

Regardless of this keep_empty_rows setting, only data recorded by the Google Analytics (GA4) property can be displayed in a report.

For example if a property never logs a purchase event, then a query for the eventName dimension and eventCount metric will not have a row eventName: “purchase” and eventCount: 0.

Type: bool

return_property_quota¶

Toggles whether to return the current state of this Analytics Property’s quota. Quota is returned in PropertyQuota.

Type: bool

comparisons¶

Optional. The configuration of comparisons requested and displayed. The request requires both a comparisons field and a comparisons dimension to receive a comparison column in the response.

Type: MutableSequence[google.analytics.data_v1beta.types.Comparison]

class google.analytics.data_v1beta.types.RunPivotReportResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The response pivot report table corresponding to a pivot request.

pivot_headers¶

Summarizes the columns and rows created by a pivot. Each pivot in the request produces one header in the response. If we have a request like this:

"pivots": [{
  "fieldNames": ["country",
    "city"]
},
{
  "fieldNames": "eventName"
}]

We will have the following pivotHeaders in the response:

"pivotHeaders" : [{
  "dimensionHeaders": [{
    "dimensionValues": [
       { "value": "United Kingdom" },
       { "value": "London" }
     ]
  },
  {
    "dimensionValues": [
    { "value": "Japan" },
    { "value": "Osaka" }
    ]
  }]
},
{
  "dimensionHeaders": [{
    "dimensionValues": [{ "value": "session_start" }]
  },
  {
    "dimensionValues": [{ "value": "scroll" }]
  }]
}]

Type: MutableSequence[google.analytics.data_v1beta.types.PivotHeader]

dimension_headers¶

Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows.

Type: MutableSequence[google.analytics.data_v1beta.types.DimensionHeader]

metric_headers¶

Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.

Type: MutableSequence[google.analytics.data_v1beta.types.MetricHeader]

rows¶

Rows of dimension value combinations and metric values in the report.

Type: MutableSequence[google.analytics.data_v1beta.types.Row]

aggregates¶

Aggregation of metric values. Can be totals, minimums, or maximums. The returned aggregations are controlled by the metric_aggregations in the pivot. The type of aggregation returned in each row is shown by the dimension_values which are set to “RESERVED_”.

Type: MutableSequence[google.analytics.data_v1beta.types.Row]

metadata¶

Metadata for the report.

Type: google.analytics.data_v1beta.types.ResponseMetaData

property_quota¶

This Analytics Property’s quota state including this request.

Type: google.analytics.data_v1beta.types.PropertyQuota

kind¶

Identifies what kind of resource this message is. This kind is always the fixed string “analyticsData#runPivotReport”. Useful to distinguish between response types in JSON.

Type: str

class google.analytics.data_v1beta.types.RunRealtimeReportRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request to generate a realtime report.

property¶

A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see where to find your Property ID.

Example: properties/1234

Type: str

dimensions¶

The dimensions requested and displayed.

Type: MutableSequence[google.analytics.data_v1beta.types.Dimension]

metrics¶

The metrics requested and displayed.

Type: MutableSequence[google.analytics.data_v1beta.types.Metric]

dimension_filter¶

The filter clause of dimensions. Metrics cannot be used in this filter.

Type: google.analytics.data_v1beta.types.FilterExpression

metric_filter¶

The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Dimensions cannot be used in this filter.

Type: google.analytics.data_v1beta.types.FilterExpression

limit¶

The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 250,000 rows per request, no matter how many you ask for. limit must be positive.

The API can also return fewer rows than the requested limit, if there aren’t as many dimension values as the limit. For instance, there are fewer than 300 possible values for the dimension country, so when reporting on only country, you can’t get more than 300 rows, even if you set limit to a higher value.

Type: int

metric_aggregations¶

Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to “RESERVED_(MetricAggregation)”.

Type: MutableSequence[google.analytics.data_v1beta.types.MetricAggregation]

order_bys¶

Specifies how rows are ordered in the response.

Type: MutableSequence[google.analytics.data_v1beta.types.OrderBy]

return_property_quota¶

Toggles whether to return the current state of this Analytics Property’s Realtime quota. Quota is returned in PropertyQuota.

Type: bool

minute_ranges¶

The minute ranges of event data to read. If unspecified, one minute range for the last 30 minutes will be used. If multiple minute ranges are requested, each response row will contain a zero based minute range index. If two minute ranges overlap, the event data for the overlapping minutes is included in the response rows for both minute ranges.

Type: MutableSequence[google.analytics.data_v1beta.types.MinuteRange]

class google.analytics.data_v1beta.types.RunRealtimeReportResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The response realtime report table corresponding to a request.

dimension_headers¶

Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows.

Type: MutableSequence[google.analytics.data_v1beta.types.DimensionHeader]

metric_headers¶

Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.

Type: MutableSequence[google.analytics.data_v1beta.types.MetricHeader]

rows¶

Rows of dimension value combinations and metric values in the report.

Type: MutableSequence[google.analytics.data_v1beta.types.Row]

totals¶

If requested, the totaled values of metrics.

Type: MutableSequence[google.analytics.data_v1beta.types.Row]

maximums¶

If requested, the maximum values of metrics.

Type: MutableSequence[google.analytics.data_v1beta.types.Row]

minimums¶

If requested, the minimum values of metrics.

Type: MutableSequence[google.analytics.data_v1beta.types.Row]

row_count¶

The total number of rows in the query result. rowCount is independent of the number of rows returned in the response and the limit request parameter. For example if a query returns 175 rows and includes limit of 50 in the API request, the response will contain rowCount of 175 but only 50 rows.

Type: int

property_quota¶

This Analytics Property’s Realtime quota state including this request.

Type: google.analytics.data_v1beta.types.PropertyQuota

kind¶

Identifies what kind of resource this message is. This kind is always the fixed string “analyticsData#runRealtimeReport”. Useful to distinguish between response types in JSON.

Type: str

class google.analytics.data_v1beta.types.RunReportRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The request to generate a report.

property¶

A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see where to find your Property ID. Within a batch request, this property should either be unspecified or consistent with the batch-level property.

Example: properties/1234

Type: str

dimensions¶

The dimensions requested and displayed.

Type: MutableSequence[google.analytics.data_v1beta.types.Dimension]

metrics¶

The metrics requested and displayed.

Type: MutableSequence[google.analytics.data_v1beta.types.Metric]

date_ranges¶

Date ranges of data to read. If multiple date ranges are requested, each response row will contain a zero based date range index. If two date ranges overlap, the event data for the overlapping days is included in the response rows for both date ranges. In a cohort request, this dateRanges must be unspecified.

Type: MutableSequence[google.analytics.data_v1beta.types.DateRange]

dimension_filter¶

Dimension filters let you ask for only specific dimension values in the report. To learn more, see Fundamentals of Dimension Filters for examples. Metrics cannot be used in this filter.

Type: google.analytics.data_v1beta.types.FilterExpression

metric_filter¶

The filter clause of metrics. Applied after aggregating the report’s rows, similar to SQL having-clause. Dimensions cannot be used in this filter.

Type: google.analytics.data_v1beta.types.FilterExpression

offset¶

The row count of the start row. The first row is counted as row 0.

When paging, the first request does not specify offset; or equivalently, sets offset to 0; the first request returns the first limit of rows. The second request sets offset to the limit of the first request; the second request returns the second limit of rows.

To learn more about this pagination parameter, see Pagination.

Type: int

limit¶

The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 250,000 rows per request, no matter how many you ask for. limit must be positive.

The API can also return fewer rows than the requested limit, if there aren’t as many dimension values as the limit. For instance, there are fewer than 300 possible values for the dimension country, so when reporting on only country, you can’t get more than 300 rows, even if you set limit to a higher value.

To learn more about this pagination parameter, see Pagination.

Type: int

metric_aggregations¶

Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to “RESERVED_(MetricAggregation)”.

Type: MutableSequence[google.analytics.data_v1beta.types.MetricAggregation]

order_bys¶

Specifies how rows are ordered in the response.

Type: MutableSequence[google.analytics.data_v1beta.types.OrderBy]

currency_code¶

A currency code in ISO4217 format, such as “AED”, “USD”, “JPY”. If the field is empty, the report uses the property’s default currency.

Type: str

cohort_spec¶

Cohort group associated with this request. If there is a cohort group in the request the ‘cohort’ dimension must be present.

Type: google.analytics.data_v1beta.types.CohortSpec

keep_empty_rows¶

If false or unspecified, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter.

Regardless of this keep_empty_rows setting, only data recorded by the Google Analytics (GA4) property can be displayed in a report.

For example if a property never logs a purchase event, then a query for the eventName dimension and eventCount metric will not have a row eventName: “purchase” and eventCount: 0.

Type: bool

return_property_quota¶

Toggles whether to return the current state of this Analytics Property’s quota. Quota is returned in PropertyQuota.

Type: bool

comparisons¶

Optional. The configuration of comparisons requested and displayed. The request only requires a comparisons field in order to receive a comparison column in the response.

Type: MutableSequence[google.analytics.data_v1beta.types.Comparison]

class google.analytics.data_v1beta.types.RunReportResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

The response report table corresponding to a request.

dimension_headers¶

Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows.

Type: MutableSequence[google.analytics.data_v1beta.types.DimensionHeader]

metric_headers¶

Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.

Type: MutableSequence[google.analytics.data_v1beta.types.MetricHeader]

rows¶

Rows of dimension value combinations and metric values in the report.

Type: MutableSequence[google.analytics.data_v1beta.types.Row]

totals¶

If requested, the totaled values of metrics.

Type: MutableSequence[google.analytics.data_v1beta.types.Row]

maximums¶

If requested, the maximum values of metrics.

Type: MutableSequence[google.analytics.data_v1beta.types.Row]

minimums¶

If requested, the minimum values of metrics.

Type: MutableSequence[google.analytics.data_v1beta.types.Row]

row_count¶

The total number of rows in the query result. rowCount is independent of the number of rows returned in the response, the limit request parameter, and the offset request parameter. For example if a query returns 175 rows and includes limit of 50 in the API request, the response will contain rowCount of 175 but only 50 rows.

To learn more about this pagination parameter, see Pagination.

Type: int

metadata¶

Metadata for the report.

Type: google.analytics.data_v1beta.types.ResponseMetaData

property_quota¶

This Analytics Property’s quota state including this request.

Type: google.analytics.data_v1beta.types.PropertyQuota

kind¶

Identifies what kind of resource this message is. This kind is always the fixed string “analyticsData#runReport”. Useful to distinguish between response types in JSON.

Type: str

class google.analytics.data_v1beta.types.SamplingMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

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.

samples_read_count¶

The total number of events read in this sampled report for a date range. This is the size of the subset this property’s data that was analyzed in this report.

Type: int

sampling_space_size¶

The total number of events present in this property’s data that could have been analyzed in this report for a date range. Sampling uncovers the meaningful information about the larger data set, and this is the size of the larger data set.

To calculate the percentage of available data that was used in this report, compute samplesReadCount/samplingSpaceSize.

Type: int

Types for Google Analytics Data v1beta API¶

google-analytics-data

Navigation

Related Topics