Types for Google Analytics Data v1alpha API¶
- class google.analytics.data_v1alpha.types.BetweenFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageTo express that the result needs to be between two numbers (inclusive).
- from_value¶
Begins with this number.
- to_value¶
Ends with this number.
- class google.analytics.data_v1alpha.types.DateRange(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA 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 afterend_date. The formatNdaysAgo,yesterday, ortodayis also accepted, and in that case, the date is inferred based on the property’s reporting time zone.- Type
- end_date¶
The inclusive end date for the query in the format
YYYY-MM-DD. Cannot be beforestart_date. The formatNdaysAgo,yesterday, ortodayis also accepted, and in that case, the date is inferred based on the property’s reporting time zone.- Type
- class google.analytics.data_v1alpha.types.Dimension(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDimensions 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”.
- name¶
The name of the dimension. See the API Dimensions for the list of dimension names.
If
dimensionExpressionis specified,namecan be any string that you would like within the allowed character set. For example if adimensionExpressionconcatenatescountryandcity, you could call that dimensioncountryAndCity. Dimension names that you choose must match the regular expression^[a-zA-Z0-9_]$.Dimensions are referenced by
nameindimensionFilter,orderBys,dimensionExpression, andpivots.- Type
- dimension_expression¶
One dimension can be the result of an expression of multiple dimensions. For example, dimension “country, city”: concatenate(country, “, “, city).
- class google.analytics.data_v1alpha.types.DimensionExpression(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageUsed 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.
- upper_case¶
Used to convert a dimension value to upper case.
This field is a member of oneof
one_expression.
- 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.
- class CaseExpression(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageUsed to convert a dimension value to a single case.
- class ConcatenateExpression(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageUsed 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
Sequence[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
- class google.analytics.data_v1alpha.types.DimensionHeader(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDescribes 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.
- class google.analytics.data_v1alpha.types.DimensionValue(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe value of a dimension.
- class google.analytics.data_v1alpha.types.EventCriteriaScoping(value)[source]¶
Bases:
proto.enums.EnumScoping specifies which events are considered when evaluating if an event meets a criteria.
- EVENT_CRITERIA_SCOPING_UNSPECIFIED = 0¶
- EVENT_CRITERIA_WITHIN_SAME_EVENT = 1¶
- class google.analytics.data_v1alpha.types.EventExclusionDuration(value)[source]¶
Bases:
proto.enums.EnumEnumerates options for how long an exclusion will last if an event matches the
eventExclusionCriteria.- EVENT_EXCLUSION_DURATION_UNSPECIFIED = 0¶
- EVENT_EXCLUSION_PERMANENT = 1¶
- class google.analytics.data_v1alpha.types.EventSegment(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageEvent segments are subsets of events that were triggered on your site or app. for example, all purchase events made in a particular location; app_exception events that occurred on a specific operating system.
- event_inclusion_criteria¶
Defines which events are included in this segment. Optional.
- exclusion¶
Defines which events are excluded in this segment. Optional.
- class google.analytics.data_v1alpha.types.EventSegmentConditionGroup(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConditions tell Analytics what data to include in or exclude from the segment.
- condition_scoping¶
conditionScopingshould always beEVENT_CRITERIA_WITHIN_SAME_EVENT.Optional. If unspecified, a
conditionScopingofEVENT_CRITERIA_WITHIN_SAME_EVENTis used.
- segment_filter_expression¶
Data is included or excluded from the segment based on if it matches this expression. Expressions express criteria on dimension, metrics, and/or parameters.
- class google.analytics.data_v1alpha.types.EventSegmentCriteria(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAn event matches a criteria if the event meet the conditions in the criteria.
- and_condition_groups¶
An event matches this criteria if the event matches each of these
andConditionGroups.
- class google.analytics.data_v1alpha.types.EventSegmentExclusion(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSpecifies which events are excluded in this segment.
- event_exclusion_duration¶
eventExclusionDurationshould always bePERMANENTLY_EXCLUDE.Optional. If unspecified, an
eventExclusionDurationofEVENT_EXCLUSION_PERMANENTis used.
- event_exclusion_criteria¶
If an event meets this condition, the event is excluded from membership in the segment for the
eventExclusionDuration.
- class google.analytics.data_v1alpha.types.Filter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAn 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. Must be a name defined in dimensions or metrics.
- Type
- class google.analytics.data_v1alpha.types.FilterExpression(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageTo 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.
- or_group¶
The FilterExpressions in or_group have an OR relationship.
This field is a member of oneof
expr.
- not_expression¶
The FilterExpression is NOT of not_expression.
This field is a member of oneof
expr.
- class google.analytics.data_v1alpha.types.FilterExpressionList(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA list of filter expressions.
- expressions¶
A list of filter expressions.
- Type
Sequence[google.analytics.data_v1alpha.types.FilterExpression]
- class google.analytics.data_v1alpha.types.Funnel(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfigures the funnel in a funnel report request. A funnel reports on users as they pass through a sequence of steps. Funnel exploration lets you visualize the steps your users take to complete a task and quickly see how well they are succeeding or failing at each step. For example, how do prospects become shoppers and then become buyers? How do one time buyers become repeat buyers? With this information, you can improve inefficient or abandoned customer journeys.
- is_open_funnel¶
In an open funnel, users can enter the funnel in any step, and in a closed funnel, users must enter the funnel in the first step. Optional. If unspecified, a closed funnel is used.
- Type
- steps¶
The sequential steps of this funnel.
- Type
- class google.analytics.data_v1alpha.types.FunnelBreakdown(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageBreakdowns add a dimension to the funnel table sub report response.
- breakdown_dimension¶
The dimension column added to the funnel table sub report response. The breakdown dimension breaks down each funnel step. A valid
breakdownDimensionis required iffunnelBreakdownis specified.
- class google.analytics.data_v1alpha.types.FunnelEventFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCreates a filter that matches events of a single event name. If a parameter filter expression is specified, only the subset of events that match both the single event name and the parameter filter expressions match this event filter.
- event_name¶
This filter matches events of this single event name. Event name is required.
This field is a member of oneof
_event_name.- Type
- class google.analytics.data_v1alpha.types.FunnelFieldFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAn 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.
- class google.analytics.data_v1alpha.types.FunnelFilterExpression(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageExpresses combinations of funnel filters.
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 FunnelFilterExpression in
andGrouphave an AND relationship.This field is a member of oneof
expr.
- or_group¶
The FunnelFilterExpression in
orGrouphave an OR relationship.This field is a member of oneof
expr.
- not_expression¶
The FunnelFilterExpression is NOT of
notExpression.This field is a member of oneof
expr.
- funnel_field_filter¶
A funnel filter for a dimension or metric.
This field is a member of oneof
expr.
- class google.analytics.data_v1alpha.types.FunnelFilterExpressionList(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA list of funnel filter expressions.
- expressions¶
The list of funnel filter expressions.
- Type
Sequence[google.analytics.data_v1alpha.types.FunnelFilterExpression]
- class google.analytics.data_v1alpha.types.FunnelNextAction(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageNext actions state the value for a dimension after the user has achieved a step but before the same user has achieved the next step. For example if the
nextActionDimensioniseventName, thennextActionDimensionin theith funnel step row will return first event after the event that qualified the user into theith funnel step but before the user achieved thei+1th funnel step.- next_action_dimension¶
The dimension column added to the funnel visualization sub report response. The next action dimension returns the next dimension value of this dimension after the user has attained the
ith funnel step.nextActionDimensioncurrently only supportseventNameand most Page / Screen dimensions likepageTitleandpagePath.nextActionDimensioncannot be a dimension expression.
- class google.analytics.data_v1alpha.types.FunnelParameterFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAn expression to filter parameter values in a funnel.
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.
- event_parameter_name¶
This filter will be evaluated on the specified event parameter. Event parameters are logged as parameters of the event. Event parameters include fields like “firebase_screen” & “currency”.
Event parameters can only be used in segments & funnels and can only be used in a descendent filter from an EventFilter. In a descendent filter from an EventFilter either event or item parameters should be used.
This field is a member of oneof
one_parameter.- Type
- item_parameter_name¶
This filter will be evaluated on the specified item parameter. Item parameters are logged as parameters in the item array. Item parameters include fields like “item_name” & “item_category”.
Item parameters can only be used in segments & funnels and can only be used in a descendent filter from an EventFilter. In a descendent filter from an EventFilter either event or item parameters should be used.
Item parameters are only available in ecommerce events. To learn more about ecommerce events, see the [Measure ecommerce] (https://developers.google.com/analytics/devguides/collection/ga4/ecommerce) guide.
This field is a member of oneof
one_parameter.- Type
- class google.analytics.data_v1alpha.types.FunnelParameterFilterExpression(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageExpresses combinations of funnel filters on parameters.
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 FunnelParameterFilterExpression in
andGrouphave an AND relationship.This field is a member of oneof
expr.
- or_group¶
The FunnelParameterFilterExpression in
orGrouphave an OR relationship.This field is a member of oneof
expr.
- not_expression¶
The FunnelParameterFilterExpression is NOT of
notExpression.This field is a member of oneof
expr.
- class google.analytics.data_v1alpha.types.FunnelParameterFilterExpressionList(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA list of funnel parameter filter expressions.
- expressions¶
The list of funnel parameter filter expressions.
- class google.analytics.data_v1alpha.types.FunnelResponseMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe funnel report’s response metadata carries additional information about the funnel report.
- sampling_metadatas¶
If funnel report results are sampled, this describes what percentage of events were used in this funnel report. One
samplingMetadatasis populated for each date range. EachsamplingMetadatascorresponds 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
Sequence[google.analytics.data_v1alpha.types.SamplingMetadata]
- class google.analytics.data_v1alpha.types.FunnelStep(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSteps define the user journey you want to measure. Steps contain one or more conditions that your users must meet to be included in that step of the funnel journey.
- name¶
The distinctive name for this step. If unspecified, steps will be named by a 1 based indexed name (i.e. “0. “, “1. “, etc.). This name defines string value returned by the
funnelStepNamedimension. For example, specifyingname = Purchasein the request’s third funnel step will produce3. Purchasein the funnel report response.- Type
- is_directly_followed_by¶
If true, this step must directly follow the previous step. If false, there can be events between the previous step and this step. If unspecified,
isDirectlyFollowedByis treated as false.- Type
- within_duration_from_prior_step¶
If specified, this step must complete within this duration of the completion of the prior step.
withinDurationFromPriorStepis inclusive of the endpoint at the microsecond granularity. For example a duration of 5 seconds can be completed at 4.9 or 5.0 seconds, but not 5 seconds and 1 microsecond.withinDurationFromPriorStepis optional, and if unspecified, steps may be separated by any time duration.This field is a member of oneof
_within_duration_from_prior_step.
- filter_expression¶
The condition that your users must meet to be included in this step of the funnel journey.
- class google.analytics.data_v1alpha.types.FunnelSubReport(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageFunnel sub reports contain the dimension and metric data values. For example, 12 users reached the second step of the funnel.
- dimension_headers¶
Describes dimension columns. Funnel reports always include the funnel step dimension in sub report responses. Additional dimensions like breakdowns, dates, and next actions may be present in the response if requested.
- Type
Sequence[google.analytics.data_v1alpha.types.DimensionHeader]
- metric_headers¶
Describes metric columns. Funnel reports always include active users in sub report responses. The funnel table includes additional metrics like completion rate, abandonments, and abandonments rate.
- Type
- rows¶
Rows of dimension value combinations and metric values in the report.
- Type
Sequence[google.analytics.data_v1alpha.types.Row]
- metadata¶
Metadata for the funnel report.
- class google.analytics.data_v1alpha.types.InListFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe result needs to be in a list of string values.
- class google.analytics.data_v1alpha.types.MetricHeader(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDescribes 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.
- type_¶
The metric’s data type.
- class google.analytics.data_v1alpha.types.MetricType(value)[source]¶
Bases:
proto.enums.EnumA metric’s value type.
- METRIC_TYPE_UNSPECIFIED = 0¶
- TYPE_CURRENCY = 9¶
- TYPE_FEET = 10¶
- TYPE_FLOAT = 2¶
- TYPE_HOURS = 7¶
- TYPE_INTEGER = 1¶
- TYPE_KILOMETERS = 13¶
- TYPE_METERS = 12¶
- TYPE_MILES = 11¶
- TYPE_MILLISECONDS = 5¶
- TYPE_MINUTES = 6¶
- TYPE_SECONDS = 4¶
- TYPE_STANDARD = 8¶
- class google.analytics.data_v1alpha.types.MetricValue(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe value of a metric.
- class google.analytics.data_v1alpha.types.NumericFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageFilters for numeric or date values.
- operation¶
The operation type for this filter.
- value¶
A numeric value or a date value.
- class google.analytics.data_v1alpha.types.NumericValue(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageTo 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.
- class google.analytics.data_v1alpha.types.PropertyQuota(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCurrent 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 25,000 tokens per day; Analytics 360 Properties can use 250,000 tokens per day. Most requests consume fewer than 10 tokens.
- tokens_per_hour¶
Standard Analytics Properties can use up to 5,000 tokens per hour; Analytics 360 Properties can use 50,000 tokens per hour. An API request consumes a single number of tokens, and that number is deducted from both the hourly and daily quotas.
- concurrent_requests¶
Standard Analytics Properties can send up to 10 concurrent requests; Analytics 360 Properties can use up to 50 concurrent requests.
- 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.
- 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.
- class google.analytics.data_v1alpha.types.QuotaStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCurrent state for a particular quota group.
- class google.analytics.data_v1alpha.types.Row(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageReport 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
Sequence[google.analytics.data_v1alpha.types.DimensionValue]
- metric_values¶
List of requested visible metric values.
- Type
- class google.analytics.data_v1alpha.types.RunFunnelReportRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe request for a funnel 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
- 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.
- Type
- funnel¶
The configuration of this request’s funnel. This funnel configuration is required.
- funnel_breakdown¶
If specified, this breakdown adds a dimension to the funnel table sub report response. This breakdown dimension expands each funnel step to the unique values of the breakdown dimension. For example, a breakdown by the
deviceCategorydimension will create rows formobile,tablet,desktop, and the total.
- funnel_next_action¶
If specified, next action adds a dimension to the funnel visualization sub report response. This next action dimension expands each funnel step to the unique values of the next action. For example a next action of the
eventNamedimension will create rows for several events (i.e.session_start&click) and the total.Next action only supports
eventNameand most Page / Screen dimensions likepageTitleandpagePath.
- funnel_visualization_type¶
The funnel visualization type controls the dimensions present in the funnel visualization sub report response. If not specified,
STANDARD_FUNNELis used.
- segments¶
The configurations of segments. Segments are subsets of a property’s data. In a funnel report with segments, the funnel is evaluated in each segment. Each segment specified in this request produces a separate row in the response; in the response, each segment identified by its name.
The segments parameter is optional. Requests are limited to 4 segments.
- Type
- limit¶
The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 100,000 rows per request, no matter how many you ask for.
limitmust be positive.The API can also return fewer rows than the requested
limit, if there aren’t as many dimension values as thelimit.- Type
- dimension_filter¶
Dimension filters allow you to ask for only specific dimension values in the report. To learn more, see Creating a Report: Dimension Filters for examples. Metrics cannot be used in this filter.
- return_property_quota¶
Toggles whether to return the current state of this Analytics Property’s quota. Quota is returned in PropertyQuota.
- Type
- class google.analytics.data_v1alpha.types.RunFunnelReportResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe funnel report response contains two sub reports. The two sub reports are different combinations of dimensions and metrics.
- funnel_table¶
The funnel table is a report with the funnel step, segment, breakdown dimension, active users, completion rate, abandonments, and abandonments rate.
The segment dimension is only present in this response if a segment was requested. The breakdown dimension is only present in this response if it was requested.
- funnel_visualization¶
The funnel visualization is a report with the funnel step, segment, date, next action dimension, and active users.
The segment dimension is only present in this response if a segment was requested. The date dimension is only present in this response if it was requested via the
TRENDED_FUNNELfunnel type. The next action dimension is only present in the response if it was requested.
- property_quota¶
This Analytics Property’s quota state including this request.
- class google.analytics.data_v1alpha.types.SamplingMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageIf funnel report results are sampled, this metadata describes what percentage of events were used in this funnel report for a date range. 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 funnel report.
- Type
- sampling_space_size¶
The total number of events present in this property’s data that could have been analyzed in this funnel 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 funnel report, compute
samplesReadCount/samplingSpaceSize.- Type
- class google.analytics.data_v1alpha.types.Segment(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA segment is a subset of your Analytics data. For example, of your entire set of users, one segment might be users from a particular country or city. Another segment might be users who purchase a particular line of products or who visit a specific part of your site or trigger certain events in your app.
To learn more, see GA4 Segment Builder.
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¶
The name for this segment. If unspecified, segments are named “Segment”. This name defines string value returned by the
segmentdimension. Thesegmentdimension prefixes segment names by the 1-based index number of the segment in the request (i.e. “1. Segment”, “2. Segment”, etc.).- Type
- user_segment¶
User segments are subsets of users who engaged with your site or app.
This field is a member of oneof
one_segment_scope.
- session_segment¶
Session segments are subsets of the sessions that occurred on your site or app.
This field is a member of oneof
one_segment_scope.
- class google.analytics.data_v1alpha.types.SegmentEventFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCreates a filter that matches events of a single event name. If a parameter filter expression is specified, only the subset of events that match both the single event name and the parameter filter expressions match this event filter.
- event_name¶
This filter matches events of this single event name. Event name is required.
This field is a member of oneof
_event_name.- Type
- segment_parameter_filter_expression¶
If specified, this filter matches events that match both the single event name and the parameter filter expressions. Inside the parameter filter expression, only parameter filters are available.
This field is a member of oneof
_segment_parameter_filter_expression.
- class google.analytics.data_v1alpha.types.SegmentFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAn 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.
- filter_scoping¶
Specifies the scope for the filter.
- class google.analytics.data_v1alpha.types.SegmentFilterExpression(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageExpresses combinations of segment filters.
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 SegmentFilterExpression in
andGrouphave an AND relationship.This field is a member of oneof
expr.
- or_group¶
The SegmentFilterExpression in
orGrouphave an OR relationship.This field is a member of oneof
expr.
- not_expression¶
The SegmentFilterExpression is NOT of
notExpression.This field is a member of oneof
expr.
- class google.analytics.data_v1alpha.types.SegmentFilterExpressionList(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA list of segment filter expressions.
- expressions¶
The list of segment filter expressions
- Type
Sequence[google.analytics.data_v1alpha.types.SegmentFilterExpression]
- class google.analytics.data_v1alpha.types.SegmentFilterScoping(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageScopings specify how the dimensions & metrics of multiple events should be considered when evaluating a segment filter.
- at_any_point_in_time¶
If
atAnyPointInTimeis true, this filter evaluates to true for all events if it evaluates to true for any event in the date range of the request.This
atAnyPointInTimeparameter does not extend the date range of events in the report. IfatAnyPointInTimeis true, only events within the report’s date range are considered when evaluating this filter.This
atAnyPointInTimeis only able to be specified if the criteria scoping isACROSS_ALL_SESSIONSand is not able to be specified in sequences.If the criteria scoping is
ACROSS_ALL_SESSIONS,atAnyPointInTime= false is used if unspecified.This field is a member of oneof
_at_any_point_in_time.- Type
- class google.analytics.data_v1alpha.types.SegmentParameterFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAn expression to filter parameter values in a segment.
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.
- event_parameter_name¶
This filter will be evaluated on the specified event parameter. Event parameters are logged as parameters of the event. Event parameters include fields like “firebase_screen” & “currency”.
Event parameters can only be used in segments & funnels and can only be used in a descendent filter from an EventFilter. In a descendent filter from an EventFilter either event or item parameters should be used.
This field is a member of oneof
one_parameter.- Type
- item_parameter_name¶
This filter will be evaluated on the specified item parameter. Item parameters are logged as parameters in the item array. Item parameters include fields like “item_name” & “item_category”.
Item parameters can only be used in segments & funnels and can only be used in a descendent filter from an EventFilter. In a descendent filter from an EventFilter either event or item parameters should be used.
Item parameters are only available in ecommerce events. To learn more about ecommerce events, see the [Measure ecommerce] (https://developers.google.com/analytics/devguides/collection/ga4/ecommerce) guide.
This field is a member of oneof
one_parameter.- Type
- filter_scoping¶
Specifies the scope for the filter.
- class google.analytics.data_v1alpha.types.SegmentParameterFilterExpression(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageExpresses combinations of segment filter on parameters.
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 SegmentParameterFilterExpression in
andGrouphave an AND relationship.This field is a member of oneof
expr.
- or_group¶
The SegmentParameterFilterExpression in
orGrouphave an OR relationship.This field is a member of oneof
expr.
- not_expression¶
The SegmentParameterFilterExpression is NOT of
notExpression.This field is a member of oneof
expr.
- class google.analytics.data_v1alpha.types.SegmentParameterFilterExpressionList(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA list of segment parameter filter expressions.
- expressions¶
The list of segment parameter filter expressions.
- class google.analytics.data_v1alpha.types.SegmentParameterFilterScoping(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageScopings specify how multiple events should be considered when evaluating a segment parameter filter.
- in_any_n_day_period¶
Accumulates the parameter over the specified period of days before applying the filter. Only supported if criteria scoping is
ACROSS_ALL_SESSIONSorWITHIN_SAME_SESSION. Only supported if the parameter isevent_count.For example if
inAnyNDayPeriodis 3, the event_name is “purchase”, the event parameter is “event_count”, and the Filter’s criteria is greater than 5, this filter will accumulate the event count of purchase events over every 3 consecutive day period in the report’s date range; a user will pass this Filter’s criteria to be included in this segment if their count of purchase events exceeds 5 in any 3 consecutive day period. For example, the periods 2021-11-01 to 2021-11-03, 2021-11-02 to 2021-11-04, 2021-11-03 to 2021-11-05, and etc. will be considered.The date range is not extended for the purpose of having a full N day window near the start of the date range. For example if a report is for 2021-11-01 to 2021-11-10 and
inAnyNDayPeriod= 3, the first two day period will be effectively shortened because no event data outside the report’s date range will be read. For example, the first four periods will effectively be: 2021-11-01 to 2021-11-01, 2021-11-01 to 2021-11-02, 2021-11-01 to 2021-11-03, and 2021-11-02 to 2021-11-04.inAnyNDayPeriodis optional. If not specified, thesegmentParameterFilteris applied to each event individually.This field is a member of oneof
_in_any_n_day_period.- Type
- class google.analytics.data_v1alpha.types.SessionCriteriaScoping(value)[source]¶
Bases:
proto.enums.EnumScoping specifies which events are considered when evaluating if a session meets a criteria.
- SESSION_CRITERIA_SCOPING_UNSPECIFIED = 0¶
- SESSION_CRITERIA_WITHIN_SAME_EVENT = 1¶
- SESSION_CRITERIA_WITHIN_SAME_SESSION = 2¶
- class google.analytics.data_v1alpha.types.SessionExclusionDuration(value)[source]¶
Bases:
proto.enums.EnumEnumerates options for how long an exclusion will last if a session matches the
sessionExclusionCriteria.- SESSION_EXCLUSION_DURATION_UNSPECIFIED = 0¶
- SESSION_EXCLUSION_PERMANENT = 2¶
- SESSION_EXCLUSION_TEMPORARY = 1¶
- class google.analytics.data_v1alpha.types.SessionSegment(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSession segments are subsets of the sessions that occurred on your site or app: for example, all the sessions that originated from a particular advertising campaign.
- session_inclusion_criteria¶
Defines which sessions are included in this segment. Optional.
- exclusion¶
Defines which sessions are excluded in this segment. Optional.
- class google.analytics.data_v1alpha.types.SessionSegmentConditionGroup(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConditions tell Analytics what data to include in or exclude from the segment.
- condition_scoping¶
Data is included or excluded from the segment based on if it matches the condition group. This scoping defines how many events the
segmentFilterExpressionis evaluated on before the condition group is determined to be matched or not. For example ifconditionScoping = SESSION_CRITERIA_WITHIN_SAME_SESSION, the expression is evaluated on all events in a session, and then, the condition group is determined to be matched or not for this session. For example ifconditionScoping = SESSION_CRITERIA_WITHIN_SAME_EVENT, the expression is evaluated on a single event, and then, the condition group is determined to be matched or not for this session.Optional. If unspecified, a
conditionScopingofWITHIN_SAME_SESSIONis used.
- segment_filter_expression¶
Data is included or excluded from the segment based on if it matches this expression. Expressions express criteria on dimension, metrics, and/or parameters.
- class google.analytics.data_v1alpha.types.SessionSegmentCriteria(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA session matches a criteria if the session’s events meet the conditions in the criteria.
- and_condition_groups¶
A session matches this criteria if the session matches each of these
andConditionGroups.
- class google.analytics.data_v1alpha.types.SessionSegmentExclusion(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSpecifies which sessions are excluded in this segment.
- session_exclusion_duration¶
Specifies how long an exclusion will last if a session matches the
sessionExclusionCriteria.Optional. If unspecified, a
sessionExclusionDurationofSESSION_EXCLUSION_TEMPORARYis used.
- session_exclusion_criteria¶
If a session meets this condition, the session is excluded from membership in the segment for the
sessionExclusionDuration.
- class google.analytics.data_v1alpha.types.StringFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe filter for string
- match_type¶
The match type for this filter.
- class google.analytics.data_v1alpha.types.UserCriteriaScoping(value)[source]¶
Bases:
proto.enums.EnumScoping specifies which events are considered when evaluating if a user meets a criteria.
- USER_CRITERIA_ACROSS_ALL_SESSIONS = 3¶
- USER_CRITERIA_SCOPING_UNSPECIFIED = 0¶
- USER_CRITERIA_WITHIN_SAME_EVENT = 1¶
- USER_CRITERIA_WITHIN_SAME_SESSION = 2¶
- class google.analytics.data_v1alpha.types.UserExclusionDuration(value)[source]¶
Bases:
proto.enums.EnumEnumerates options for how long an exclusion will last if a user matches the
userExclusionCriteria.- USER_EXCLUSION_DURATION_UNSPECIFIED = 0¶
- USER_EXCLUSION_PERMANENT = 2¶
- USER_EXCLUSION_TEMPORARY = 1¶
- class google.analytics.data_v1alpha.types.UserSegment(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageUser segments are subsets of users who engaged with your site or app. For example, users who have previously purchased; users who added items to their shopping carts, but didn’t complete a purchase.
- user_inclusion_criteria¶
Defines which users are included in this segment. Optional.
- exclusion¶
Defines which users are excluded in this segment. Optional.
- class google.analytics.data_v1alpha.types.UserSegmentConditionGroup(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConditions tell Analytics what data to include in or exclude from the segment.
- condition_scoping¶
Data is included or excluded from the segment based on if it matches the condition group. This scoping defines how many events the
segmentFilterExpressionis evaluated on before the condition group is determined to be matched or not. For example ifconditionScoping = USER_CRITERIA_WITHIN_SAME_SESSION, the expression is evaluated on all events in a session, and then, the condition group is determined to be matched or not for this user. For example ifconditionScoping = USER_CRITERIA_WITHIN_SAME_EVENT, the expression is evaluated on a single event, and then, the condition group is determined to be matched or not for this user.Optional. If unspecified,
conditionScoping = ACROSS_ALL_SESSIONSis used.
- segment_filter_expression¶
Data is included or excluded from the segment based on if it matches this expression. Expressions express criteria on dimension, metrics, and/or parameters.
- class google.analytics.data_v1alpha.types.UserSegmentCriteria(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA user matches a criteria if the user’s events meet the conditions in the criteria.
- and_condition_groups¶
A user matches this criteria if the user matches each of these
andConditionGroupsand each of theandSequenceGroups.andConditionGroupsmay be empty ifandSequenceGroupsare specified.
- and_sequence_groups¶
A user matches this criteria if the user matches each of these
andSequenceGroupsand each of theandConditionGroups.andSequenceGroupsmay be empty ifandConditionGroupsare specified.- Type
Sequence[google.analytics.data_v1alpha.types.UserSegmentSequenceGroup]
- class google.analytics.data_v1alpha.types.UserSegmentExclusion(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSpecifies which users are excluded in this segment.
- user_exclusion_duration¶
Specifies how long an exclusion will last if a user matches the
userExclusionCriteria.Optional. If unspecified,
userExclusionDurationofUSER_EXCLUSION_TEMPORARYis used.
- user_exclusion_criteria¶
If a user meets this condition, the user is excluded from membership in the segment for the
userExclusionDuration.
- class google.analytics.data_v1alpha.types.UserSegmentSequenceGroup(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDefine conditions that must occur in a specific order for the user to be a member of the segment.
- sequence_scoping¶
All sequence steps must be satisfied in the scoping for the user to match the sequence. For example if
sequenceScoping = USER_CRITERIA_WITHIN_SAME_SESSION, all sequence steps must complete within one session for the user to match the sequence.sequenceScoping = USER_CRITERIA_WITHIN_SAME_EVENTis not supported.Optional. If unspecified,
conditionScoping = ACROSS_ALL_SESSIONSis used.
- sequence_maximum_duration¶
Defines the time period in which the whole sequence must occur; for example, 30 Minutes.
sequenceMaximumDurationis inclusive of the endpoint at the microsecond granularity. For example a sequence with a maximum duration of 5 seconds can be completed at 4.9 or 5.0 seconds, but not 5 seconds and 1 microsecond.sequenceMaximumDurationis optional, and if unspecified, sequences can be completed in any time duration.
- user_sequence_steps¶
An ordered sequence of condition steps. A user’s events must complete each step in order for the user to match the
UserSegmentSequenceGroup.- Type
Sequence[google.analytics.data_v1alpha.types.UserSequenceStep]
- class google.analytics.data_v1alpha.types.UserSequenceStep(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA condition that must occur in the specified step order for this user to match the sequence.
- is_directly_followed_by¶
If true, the event satisfying this step must be the very next event after the event satifying the last step. If false, this step indirectly follows the prior step; for example, there may be events between the prior step and this step.
isDirectlyFollowedBymust be false for the first step.- Type
- step_scoping¶
This sequence step must be satisfied in the scoping for the user to match the sequence. For example if
sequenceScoping = WITHIN_SAME_SESSION, this sequence steps must complete within one session for the user to match the sequence.stepScoping = ACROSS_ALL_SESSIONSis only allowed if thesequenceScoping = ACROSS_ALL_SESSIONS.Optional. If unspecified,
stepScopinguses the sameUserCriteriaScopingas thesequenceScoping.
- segment_filter_expression¶
A user matches this sequence step if their events match this expression. Expressions express criteria on dimension, metrics, and/or parameters.
