Types for Google Analytics Admin v1alpha API¶
- class google.analytics.admin_v1alpha.types.AccessBetweenFilter(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.admin_v1alpha.types.AccessBinding(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA binding of a user to a set of roles.
- user¶
If set, the email address of the user to set roles for. Format: “someuser@gmail.com”.
This field is a member of oneof
access_target.- Type
- name¶
Output only. Resource name of this binding.
Format: accounts/{account}/accessBindings/{access_binding} or properties/{property}/accessBindings/{access_binding}
Example: “accounts/100/accessBindings/200”.
- Type
- roles¶
A list of roles for to grant to the parent resource. Valid values:
predefinedRoles/viewer predefinedRoles/analyst predefinedRoles/editor predefinedRoles/admin predefinedRoles/no-cost-data predefinedRoles/no-revenue-data
For users, if an empty list of roles is set, this AccessBinding will be deleted.
- Type
MutableSequence[str]
- class google.analytics.admin_v1alpha.types.AccessDateRange(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA contiguous range of days: startDate, startDate + 1, …, endDate.
- start_date¶
The inclusive start date for the query in the format
YYYY-MM-DD. Cannot be afterendDate. The formatNdaysAgo,yesterday, ortodayis also accepted, and in that case, the date is inferred based on the current time in the request’s time zone.- Type
- class google.analytics.admin_v1alpha.types.AccessDimension(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDimensions are attributes of your data. For example, the dimension
userEmailindicates the email of the user that accessed reporting data. Dimension values in report responses are strings.- dimension_name¶
The API name of the dimension. See Data Access Schema for the list of dimensions supported in this API.
Dimensions are referenced by name in
dimensionFilterandorderBys.- Type
- class google.analytics.admin_v1alpha.types.AccessDimensionHeader(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.admin_v1alpha.types.AccessDimensionValue(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe value of a dimension.
- class google.analytics.admin_v1alpha.types.AccessFilter(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.admin_v1alpha.types.AccessFilterExpression(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageExpresses dimension or metric filters. The fields in the same expression 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¶
Each of the FilterExpressions in the and_group has an AND relationship.
This field is a member of oneof
one_expression.
- or_group¶
Each of the FilterExpressions in the or_group has an OR relationship.
This field is a member of oneof
one_expression.
- not_expression¶
The FilterExpression is NOT of not_expression.
This field is a member of oneof
one_expression.
- class google.analytics.admin_v1alpha.types.AccessFilterExpressionList(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA list of filter expressions.
- expressions¶
A list of filter expressions.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.AccessFilterExpression]
- class google.analytics.admin_v1alpha.types.AccessInListFilter(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.admin_v1alpha.types.AccessMetric(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe quantitative measurements of a report. For example, the metric
accessCountis the total number of data access records.- metric_name¶
The API name of the metric. See Data Access Schema for the list of metrics supported in this API.
Metrics are referenced by name in
metricFilter&orderBys.- Type
- class google.analytics.admin_v1alpha.types.AccessMetricHeader(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.
- class google.analytics.admin_v1alpha.types.AccessMetricValue(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe value of a metric.
- class google.analytics.admin_v1alpha.types.AccessNumericFilter(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 Operation(value)[source]¶
Bases:
proto.enums.EnumThe 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 google.analytics.admin_v1alpha.types.AccessOrderBy(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageOrder bys define how rows will be sorted in the response. For example, ordering rows by descending access count is one ordering, and ordering rows by the country 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.
- desc¶
If true, sorts by descending order. If false or unspecified, sorts in ascending order.
- Type
- class DimensionOrderBy(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSorts by dimension values.
- order_type¶
Controls the rule for dimension value ordering.
- class OrderType(value)[source]¶
Bases:
proto.enums.EnumRule 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
ALPHANUMERICsort, “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.MessageSorts by metric values.
- class google.analytics.admin_v1alpha.types.AccessQuota(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¶
Properties can use 250,000 tokens per day. Most requests consume fewer than 10 tokens.
- tokens_per_hour¶
Properties can use 50,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.
- concurrent_requests¶
Properties can use up to 50 concurrent requests.
- server_errors_per_project_per_hour¶
Properties and cloud project pairs can have up to 50 server errors per hour.
- tokens_per_project_per_hour¶
Properties can use up to 25% of their tokens per project per hour. This amounts to Analytics 360 Properties can use 12,500 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.
- class google.analytics.admin_v1alpha.types.AccessQuotaStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCurrent state for a particular quota group.
- class google.analytics.admin_v1alpha.types.AccessRow(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAccess report data for each row.
- dimension_values¶
List of dimension values. These values are in the same order as specified in the request.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.AccessDimensionValue]
- metric_values¶
List of metric values. These values are in the same order as specified in the request.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.AccessMetricValue]
- class google.analytics.admin_v1alpha.types.AccessStringFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe filter for strings.
- match_type¶
The match type for this filter.
- class MatchType(value)[source]¶
Bases:
proto.enums.EnumThe 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.admin_v1alpha.types.Account(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA resource message representing a Google Analytics account.
- name¶
Output only. Resource name of this account. Format: accounts/{account} Example: “accounts/100”.
- Type
- create_time¶
Output only. Time when this account was originally created.
- update_time¶
Output only. Time when account payload fields were last updated.
- class google.analytics.admin_v1alpha.types.AccountSummary(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA virtual resource representing an overview of an account and all its child GA4 properties.
- name¶
Resource name for this account summary. Format: accountSummaries/{account_id} Example: “accountSummaries/1000”.
- Type
- account¶
Resource name of account referred to by this account summary Format: accounts/{account_id} Example: “accounts/1000”.
- Type
- property_summaries¶
List of summaries for child accounts of this account.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.PropertySummary]
- class google.analytics.admin_v1alpha.types.AcknowledgeUserDataCollectionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for AcknowledgeUserDataCollection RPC.
- acknowledgement¶
Required. An acknowledgement that the caller of this method understands the terms of user data collection.
This field must contain the exact value:
“I acknowledge that I have the necessary privacy disclosures and rights from my end users for the collection and processing of their data, including the association of such data with the visitation information Google Analytics collects from my site and/or app property.”.
- Type
- class google.analytics.admin_v1alpha.types.AcknowledgeUserDataCollectionResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for AcknowledgeUserDataCollection RPC.
- class google.analytics.admin_v1alpha.types.ActionType(value)[source]¶
Bases:
proto.enums.EnumTypes of actions that may change a resource.
- Values:
- ACTION_TYPE_UNSPECIFIED (0):
Action type unknown or not specified.
- CREATED (1):
Resource was created in this change.
- UPDATED (2):
Resource was updated in this change.
- DELETED (3):
Resource was deleted in this change.
- class google.analytics.admin_v1alpha.types.ActorType(value)[source]¶
Bases:
proto.enums.EnumDifferent kinds of actors that can make changes to Google Analytics resources.
- Values:
- ACTOR_TYPE_UNSPECIFIED (0):
Unknown or unspecified actor type.
- USER (1):
Changes made by the user specified in actor_email.
- SYSTEM (2):
Changes made by the Google Analytics system.
- SUPPORT (3):
Changes made by Google Analytics support team staff.
- class google.analytics.admin_v1alpha.types.AdSenseLink(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA link between a GA4 Property and an AdSense for Content ad client.
- name¶
Output only. The resource name for this AdSense Link resource. Format: properties/{propertyId}/adSenseLinks/{linkId} Example: properties/1234/adSenseLinks/6789
- Type
- class google.analytics.admin_v1alpha.types.ApproveDisplayVideo360AdvertiserLinkProposalRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ApproveDisplayVideo360AdvertiserLinkProposal RPC.
- class google.analytics.admin_v1alpha.types.ApproveDisplayVideo360AdvertiserLinkProposalResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ApproveDisplayVideo360AdvertiserLinkProposal RPC.
- display_video_360_advertiser_link¶
The DisplayVideo360AdvertiserLink created as a result of approving the proposal.
- class google.analytics.admin_v1alpha.types.ArchiveAudienceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ArchiveAudience RPC.
- class google.analytics.admin_v1alpha.types.ArchiveCustomDimensionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ArchiveCustomDimension RPC.
- class google.analytics.admin_v1alpha.types.ArchiveCustomMetricRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ArchiveCustomMetric RPC.
- class google.analytics.admin_v1alpha.types.AttributionSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe attribution settings used for a given property. This is a singleton resource.
- name¶
Output only. Resource name of this attribution settings resource. Format: properties/{property_id}/attributionSettings Example: “properties/1000/attributionSettings”.
- Type
- acquisition_conversion_event_lookback_window¶
Required. The lookback window configuration for acquisition conversion events. The default window size is 30 days.
- other_conversion_event_lookback_window¶
Required. The lookback window for all other, non-acquisition conversion events. The default window size is 90 days.
- reporting_attribution_model¶
Required. The reporting attribution model used to calculate conversion credit in this property’s reports.
Changing the attribution model will apply to both historical and future data. These changes will be reflected in reports with conversion and revenue data. User and session data will be unaffected.
- ads_web_conversion_data_export_scope¶
Required. The Conversion Export Scope for data exported to linked Ads Accounts.
- class AcquisitionConversionEventLookbackWindow(value)[source]¶
Bases:
proto.enums.EnumHow far back in time events should be considered for inclusion in a converting path which leads to the first install of an app or the first visit to a site.
- Values:
- ACQUISITION_CONVERSION_EVENT_LOOKBACK_WINDOW_UNSPECIFIED (0):
Lookback window size unspecified.
- ACQUISITION_CONVERSION_EVENT_LOOKBACK_WINDOW_7_DAYS (1):
7-day lookback window.
- ACQUISITION_CONVERSION_EVENT_LOOKBACK_WINDOW_30_DAYS (2):
30-day lookback window.
- class AdsWebConversionDataExportScope(value)[source]¶
Bases:
proto.enums.EnumThe Conversion Export Scope for data exported to linked Ads Accounts.
- Values:
- ADS_WEB_CONVERSION_DATA_EXPORT_SCOPE_UNSPECIFIED (0):
Default value. This value is unused.
- NOT_SELECTED_YET (1):
No data export scope selected yet. Export scope can never be changed back to this value.
- PAID_AND_ORGANIC_CHANNELS (2):
Paid and organic channels are eligible to receive conversion credit, but only credit assigned to Google Ads channels will appear in your Ads accounts. To learn more, see Paid and Organic channels.
- GOOGLE_PAID_CHANNELS (3):
Only Google Ads paid channels are eligible to receive conversion credit. To learn more, see Google Paid channels.
- class OtherConversionEventLookbackWindow(value)[source]¶
Bases:
proto.enums.EnumHow far back in time events should be considered for inclusion in a converting path for all conversions other than first app install/first site visit.
- Values:
- OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_UNSPECIFIED (0):
Lookback window size unspecified.
- OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_30_DAYS (1):
30-day lookback window.
- OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_60_DAYS (2):
60-day lookback window.
- OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_90_DAYS (3):
90-day lookback window.
- class ReportingAttributionModel(value)[source]¶
Bases:
proto.enums.EnumThe reporting attribution model used to calculate conversion credit in this property’s reports.
- Values:
- REPORTING_ATTRIBUTION_MODEL_UNSPECIFIED (0):
Reporting attribution model unspecified.
- PAID_AND_ORGANIC_CHANNELS_DATA_DRIVEN (1):
Data-driven attribution distributes credit for the conversion based on data for each conversion event. Each Data-driven model is specific to each advertiser and each conversion event. Previously CROSS_CHANNEL_DATA_DRIVEN
- PAID_AND_ORGANIC_CHANNELS_LAST_CLICK (2):
Ignores direct traffic and attributes 100% of the conversion value to the last channel that the customer clicked through (or engaged view through for YouTube) before converting. Previously CROSS_CHANNEL_LAST_CLICK
- PAID_AND_ORGANIC_CHANNELS_FIRST_CLICK (3):
Starting in June 2023, new properties can no longer use this model. See Analytics Help for more details. Starting in September 2023, we will sunset this model for all properties.
Gives all credit for the conversion to the first channel that a customer clicked (or engaged view through for YouTube) before converting. Previously CROSS_CHANNEL_FIRST_CLICK
- PAID_AND_ORGANIC_CHANNELS_LINEAR (4):
Starting in June 2023, new properties can no longer use this model. See Analytics Help for more details. Starting in September 2023, we will sunset this model for all properties.
Distributes the credit for the conversion equally across all the channels a customer clicked (or engaged view through for YouTube) before converting. Previously CROSS_CHANNEL_LINEAR
- PAID_AND_ORGANIC_CHANNELS_POSITION_BASED (5):
Starting in June 2023, new properties can no longer use this model. See Analytics Help for more details. Starting in September 2023, we will sunset this model for all properties.
Attributes 40% credit to the first and last interaction, and the remaining 20% credit is distributed evenly to the middle interactions. Previously CROSS_CHANNEL_POSITION_BASED
- PAID_AND_ORGANIC_CHANNELS_TIME_DECAY (6):
Starting in June 2023, new properties can no longer use this model. See Analytics Help for more details. Starting in September 2023, we will sunset this model for all properties.
Gives more credit to the touchpoints that happened closer in time to the conversion. Previously CROSS_CHANNEL_TIME_DECAY
- GOOGLE_PAID_CHANNELS_LAST_CLICK (7):
Attributes 100% of the conversion value to the last Google Paid channel that the customer clicked through before converting. Previously ADS_PREFERRED_LAST_CLICK
- class google.analytics.admin_v1alpha.types.Audience(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA resource message representing a GA4 Audience.
- name¶
Output only. The resource name for this Audience resource. Format: properties/{propertyId}/audiences/{audienceId}
- Type
- membership_duration_days¶
Required. Immutable. The duration a user should stay in an Audience. It cannot be set to more than 540 days.
- Type
- ads_personalization_enabled¶
Output only. It is automatically set by GA to false if this is an NPA Audience and is excluded from ads personalization.
- Type
- event_trigger¶
Optional. Specifies an event to log when a user joins the Audience. If not set, no event is logged when a user joins the Audience.
- exclusion_duration_mode¶
Immutable. Specifies how long an exclusion lasts for users that meet the exclusion filter. It is applied to all EXCLUDE filter clauses and is ignored when there is no EXCLUDE filter clause in the Audience.
- filter_clauses¶
Required. Immutable. Unordered list. Filter clauses that define the Audience. All clauses will be AND’ed together.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.AudienceFilterClause]
- class AudienceExclusionDurationMode(value)[source]¶
Bases:
proto.enums.EnumSpecifies how long an exclusion lasts for users that meet the exclusion filter.
- Values:
- AUDIENCE_EXCLUSION_DURATION_MODE_UNSPECIFIED (0):
Not specified.
- EXCLUDE_TEMPORARILY (1):
Exclude users from the Audience during periods when they meet the filter clause.
- EXCLUDE_PERMANENTLY (2):
Exclude users from the Audience if they’ve ever met the filter clause.
- class google.analytics.admin_v1alpha.types.AudienceDimensionOrMetricFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA specific filter for a single dimension or metric.
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.
- string_filter¶
A filter for a string-type dimension that matches a particular pattern.
This field is a member of oneof
one_filter.
- in_list_filter¶
A filter for a string dimension that matches a particular list of options.
This field is a member of oneof
one_filter.
- numeric_filter¶
A filter for numeric or date values on a dimension or metric.
This field is a member of oneof
one_filter.
- between_filter¶
A filter for numeric or date values between certain values on a dimension or metric.
This field is a member of oneof
one_filter.
- field_name¶
Required. Immutable. The dimension name or metric name to filter. If the field name refers to a custom dimension or metric, a scope prefix will be added to the front of the custom dimensions or metric name. For more on scope prefixes or custom dimensions/metrics, reference the [Google Analytics Data API documentation] (https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#custom_dimensions).
- Type
- at_any_point_in_time¶
Optional. Indicates whether this filter needs dynamic evaluation or not. If set to true, users join the Audience if they ever met the condition (static evaluation). If unset or set to false, user evaluation for an Audience is dynamic; users are added to an Audience when they meet the conditions and then removed when they no longer meet them.
This can only be set when Audience scope is ACROSS_ALL_SESSIONS.
- Type
- in_any_n_day_period¶
Optional. If set, specifies the time window for which to evaluate data in number of days. If not set, then audience data is evaluated against lifetime data (For example, infinite time window).
For example, if set to 1 day, only the current day’s data is evaluated. The reference point is the current day when at_any_point_in_time is unset or false.
It can only be set when Audience scope is ACROSS_ALL_SESSIONS and cannot be greater than 60 days.
- Type
- class BetweenFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA filter for numeric or date values between certain values on a dimension or metric.
- from_value¶
Required. Begins with this number, inclusive.
- to_value¶
Required. Ends with this number, inclusive.
- class InListFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA filter for a string dimension that matches a particular list of options.
- class NumericFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA filter for numeric or date values on a dimension or metric.
- operation¶
Required. The operation applied to a numeric filter.
- value¶
Required. The numeric or date value to match against.
- class Operation(value)[source]¶
Bases:
proto.enums.EnumThe operation applied to a numeric filter.
- Values:
- OPERATION_UNSPECIFIED (0):
Unspecified.
- EQUAL (1):
Equal.
- LESS_THAN (2):
Less than.
- GREATER_THAN (4):
Greater than.
- class 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 StringFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA filter for a string-type dimension that matches a particular pattern.
- match_type¶
Required. The match type for the string filter.
- case_sensitive¶
Optional. If true, the match is case-sensitive. If false, the match is case-insensitive.
- Type
- class MatchType(value)[source]¶
Bases:
proto.enums.EnumThe match type for the 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 regular expression matches with the string value.
- class google.analytics.admin_v1alpha.types.AudienceEventFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA filter that matches events of a single event name. If an event parameter is specified, only the subset of events that match both the single event name and the parameter filter expressions match this event filter.
- event_parameter_filter_expression¶
Optional. If specified, this filter matches events that match both the single event name and the parameter filter expressions. AudienceEventFilter inside the parameter filter expression cannot be set (For example, nested event filters are not supported). This should be a single and_group of dimension_or_metric_filter or not_expression; ANDs of ORs are not supported. Also, if it includes a filter for “eventCount”, only that one will be considered; all the other filters will be ignored.
- class google.analytics.admin_v1alpha.types.AudienceEventTrigger(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSpecifies an event to log when a user joins the Audience.
- log_condition¶
Required. When to log the event.
- class LogCondition(value)[source]¶
Bases:
proto.enums.EnumDetermines when to log the event.
- Values:
- LOG_CONDITION_UNSPECIFIED (0):
Log condition is not specified.
- AUDIENCE_JOINED (1):
The event should be logged only when a user is joined.
- AUDIENCE_MEMBERSHIP_RENEWED (2):
The event should be logged whenever the Audience condition is met, even if the user is already a member of the Audience.
- class google.analytics.admin_v1alpha.types.AudienceFilterClause(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA clause for defining either a simple or sequence filter. A filter can be inclusive (For example, users satisfying the filter clause are included in the Audience) or exclusive (For example, users satisfying the filter clause are excluded from the Audience).
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.
- simple_filter¶
A simple filter that a user must satisfy to be a member of the Audience.
This field is a member of oneof
filter.
- sequence_filter¶
Filters that must occur in a specific order for the user to be a member of the Audience.
This field is a member of oneof
filter.
- clause_type¶
Required. Specifies whether this is an include or exclude filter clause.
- class AudienceClauseType(value)[source]¶
Bases:
proto.enums.EnumSpecifies whether this is an include or exclude filter clause.
- Values:
- AUDIENCE_CLAUSE_TYPE_UNSPECIFIED (0):
Unspecified clause type.
- INCLUDE (1):
Users will be included in the Audience if the filter clause is met.
- EXCLUDE (2):
Users will be excluded from the Audience if the filter clause is met.
- class google.analytics.admin_v1alpha.types.AudienceFilterExpression(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA logical expression of Audience dimension, metric, or event 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¶
A list of expressions to be AND’ed together. It can only contain AudienceFilterExpressions with or_group. This must be set for the top level AudienceFilterExpression.
This field is a member of oneof
expr.
- or_group¶
A list of expressions to OR’ed together. It cannot contain AudienceFilterExpressions with and_group or or_group.
This field is a member of oneof
expr.
- not_expression¶
A filter expression to be NOT’ed (For example, inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression.
This field is a member of oneof
expr.
- dimension_or_metric_filter¶
A filter on a single dimension or metric. This cannot be set on the top level AudienceFilterExpression.
This field is a member of oneof
expr.
- class google.analytics.admin_v1alpha.types.AudienceFilterExpressionList(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA list of Audience filter expressions.
- filter_expressions¶
A list of Audience filter expressions.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.AudienceFilterExpression]
- class google.analytics.admin_v1alpha.types.AudienceFilterScope(value)[source]¶
Bases:
proto.enums.EnumSpecifies how to evaluate users for joining an Audience.
- Values:
- AUDIENCE_FILTER_SCOPE_UNSPECIFIED (0):
Scope is not specified.
- AUDIENCE_FILTER_SCOPE_WITHIN_SAME_EVENT (1):
User joins the Audience if the filter condition is met within one event.
- AUDIENCE_FILTER_SCOPE_WITHIN_SAME_SESSION (2):
User joins the Audience if the filter condition is met within one session.
- AUDIENCE_FILTER_SCOPE_ACROSS_ALL_SESSIONS (3):
User joins the Audience if the filter condition is met by any event across any session.
- class google.analytics.admin_v1alpha.types.AudienceSequenceFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDefines filters that must occur in a specific order for the user to be a member of the Audience.
- scope¶
Required. Immutable. Specifies the scope for this filter.
- sequence_maximum_duration¶
Optional. Defines the time period in which the whole sequence must occur.
- sequence_steps¶
Required. An ordered sequence of steps. A user must complete each step in order to join the sequence filter.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.AudienceSequenceFilter.AudienceSequenceStep]
- class AudienceSequenceStep(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.
- scope¶
Required. Immutable. Specifies the scope for this step.
- immediately_follows¶
Optional. If true, the event satisfying this step must be the very next event after the event satisfying the last step. If unset or false, this step indirectly follows the prior step; for example, there may be events between the prior step and this step. It is ignored for the first step.
- Type
- constraint_duration¶
Optional. When set, this step must be satisfied within the constraint_duration of the previous step (For example, t[i] - t[i-1] <= constraint_duration). If not set, there is no duration requirement (the duration is effectively unlimited). It is ignored for the first step.
- filter_expression¶
Required. Immutable. A logical expression of Audience dimension, metric, or event filters in each step.
- class google.analytics.admin_v1alpha.types.AudienceSimpleFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDefines a simple filter that a user must satisfy to be a member of the Audience.
- scope¶
Required. Immutable. Specifies the scope for this filter.
- filter_expression¶
Required. Immutable. A logical expression of Audience dimension, metric, or event filters.
- class google.analytics.admin_v1alpha.types.AuditUserLink(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRead-only resource used to summarize a principal’s effective roles.
- class google.analytics.admin_v1alpha.types.AuditUserLinksRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for AuditUserLinks RPC.
- page_size¶
The maximum number of user links to return. The service may return fewer than this value. If unspecified, at most 1000 user links will be returned. The maximum value is 5000; values above 5000 will be coerced to 5000.
- Type
- class google.analytics.admin_v1alpha.types.AuditUserLinksResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for AuditUserLinks RPC.
- user_links¶
List of AuditUserLinks. These will be ordered stably, but in an arbitrary order.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.AuditUserLink]
- class google.analytics.admin_v1alpha.types.BatchCreateAccessBindingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for BatchCreateAccessBindings RPC.
- parent¶
Required. The account or property that owns the access bindings. The parent field in the CreateAccessBindingRequest messages must either be empty or match this field. Formats:
accounts/{account}
properties/{property}
- Type
- requests¶
Required. The requests specifying the access bindings to create. A maximum of 1000 access bindings can be created in a batch.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.CreateAccessBindingRequest]
- class google.analytics.admin_v1alpha.types.BatchCreateAccessBindingsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for BatchCreateAccessBindings RPC.
- access_bindings¶
The access bindings created.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.AccessBinding]
- class google.analytics.admin_v1alpha.types.BatchCreateUserLinksRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for BatchCreateUserLinks RPC.
- parent¶
Required. The account or property that all user links in the request are for. This field is required. The parent field in the CreateUserLinkRequest messages must either be empty or match this field. Example format: accounts/1234
- Type
- notify_new_users¶
Optional. If set, then email the new users notifying them that they’ve been granted permissions to the resource. Regardless of whether this is set or not, notify_new_user field inside each individual request is ignored.
- Type
- requests¶
Required. The requests specifying the user links to create. A maximum of 1000 user links can be created in a batch.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.CreateUserLinkRequest]
- class google.analytics.admin_v1alpha.types.BatchCreateUserLinksResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for BatchCreateUserLinks RPC.
- user_links¶
The user links created.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.UserLink]
- class google.analytics.admin_v1alpha.types.BatchDeleteAccessBindingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for BatchDeleteAccessBindings RPC.
- parent¶
Required. The account or property that owns the access bindings. The parent of all provided values for the ‘names’ field in DeleteAccessBindingRequest messages must match this field. Formats:
accounts/{account}
properties/{property}
- Type
- requests¶
Required. The requests specifying the access bindings to delete. A maximum of 1000 access bindings can be deleted in a batch.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.DeleteAccessBindingRequest]
- class google.analytics.admin_v1alpha.types.BatchDeleteUserLinksRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for BatchDeleteUserLinks RPC.
- parent¶
Required. The account or property that all user links in the request are for. The parent of all values for user link names to delete must match this field. Example format: accounts/1234
- Type
- requests¶
Required. The requests specifying the user links to update. A maximum of 1000 user links can be updated in a batch.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.DeleteUserLinkRequest]
- class google.analytics.admin_v1alpha.types.BatchGetAccessBindingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for BatchGetAccessBindings RPC.
- parent¶
Required. The account or property that owns the access bindings. The parent of all provided values for the ‘names’ field must match this field. Formats:
accounts/{account}
properties/{property}
- Type
- class google.analytics.admin_v1alpha.types.BatchGetAccessBindingsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for BatchGetAccessBindings RPC.
- access_bindings¶
The requested access bindings.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.AccessBinding]
- class google.analytics.admin_v1alpha.types.BatchGetUserLinksRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for BatchGetUserLinks RPC.
- parent¶
Required. The account or property that all user links in the request are for. The parent of all provided values for the ‘names’ field must match this field. Example format: accounts/1234
- Type
- class google.analytics.admin_v1alpha.types.BatchGetUserLinksResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for BatchGetUserLinks RPC.
- user_links¶
The requested user links.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.UserLink]
- class google.analytics.admin_v1alpha.types.BatchUpdateAccessBindingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for BatchUpdateAccessBindings RPC.
- parent¶
Required. The account or property that owns the access bindings. The parent of all provided AccessBinding in UpdateAccessBindingRequest messages must match this field. Formats:
accounts/{account}
properties/{property}
- Type
- requests¶
Required. The requests specifying the access bindings to update. A maximum of 1000 access bindings can be updated in a batch.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.UpdateAccessBindingRequest]
- class google.analytics.admin_v1alpha.types.BatchUpdateAccessBindingsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for BatchUpdateAccessBindings RPC.
- access_bindings¶
The access bindings updated.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.AccessBinding]
- class google.analytics.admin_v1alpha.types.BatchUpdateUserLinksRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for BatchUpdateUserLinks RPC.
- parent¶
Required. The account or property that all user links in the request are for. The parent field in the UpdateUserLinkRequest messages must either be empty or match this field. Example format: accounts/1234
- Type
- requests¶
Required. The requests specifying the user links to update. A maximum of 1000 user links can be updated in a batch.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.UpdateUserLinkRequest]
- class google.analytics.admin_v1alpha.types.BatchUpdateUserLinksResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for BatchUpdateUserLinks RPC.
- user_links¶
The user links updated.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.UserLink]
- class google.analytics.admin_v1alpha.types.BigQueryLink(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA link between a GA4 Property and BigQuery project.
- name¶
Output only. Resource name of this BigQuery link. Format: ‘properties/{property_id}/bigQueryLinks/{bigquery_link_id}’ Format: ‘properties/1234/bigQueryLinks/abc567’
- Type
- project¶
Immutable. The linked Google Cloud project. When creating a BigQueryLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, the returned project will always have a project that contains a project number. Format: ‘projects/{project number}’ Example: ‘projects/1234’
- Type
- create_time¶
Output only. Time when the link was created.
- daily_export_enabled¶
If set true, enables daily data export to the linked Google Cloud project.
- Type
- streaming_export_enabled¶
If set true, enables streaming export to the linked Google Cloud project.
- Type
- fresh_daily_export_enabled¶
If set true, enables fresh daily export to the linked Google Cloud project.
- Type
- include_advertising_id¶
If set true, exported data will include advertising identifiers for mobile app streams.
- Type
- class google.analytics.admin_v1alpha.types.CancelDisplayVideo360AdvertiserLinkProposalRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for CancelDisplayVideo360AdvertiserLinkProposal RPC.
- class google.analytics.admin_v1alpha.types.ChangeHistoryChange(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA description of a change to a single Google Analytics resource.
- action¶
The type of action that changed this resource.
- resource_before_change¶
Resource contents from before the change was made. If this resource was created in this change, this field will be missing.
- resource_after_change¶
Resource contents from after the change was made. If this resource was deleted in this change, this field will be missing.
- class ChangeHistoryResource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA snapshot of a resource as before or after the result of a change in change history.
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.
- account¶
A snapshot of an Account resource in change history.
This field is a member of oneof
resource.
- property¶
A snapshot of a Property resource in change history.
This field is a member of oneof
resource.
- firebase_link¶
A snapshot of a FirebaseLink resource in change history.
This field is a member of oneof
resource.
- google_ads_link¶
A snapshot of a GoogleAdsLink resource in change history.
This field is a member of oneof
resource.
- google_signals_settings¶
A snapshot of a GoogleSignalsSettings resource in change history.
This field is a member of oneof
resource.
- display_video_360_advertiser_link¶
A snapshot of a DisplayVideo360AdvertiserLink resource in change history.
This field is a member of oneof
resource.
- display_video_360_advertiser_link_proposal¶
A snapshot of a DisplayVideo360AdvertiserLinkProposal resource in change history.
This field is a member of oneof
resource.
- conversion_event¶
A snapshot of a ConversionEvent resource in change history.
This field is a member of oneof
resource.
- measurement_protocol_secret¶
A snapshot of a MeasurementProtocolSecret resource in change history.
This field is a member of oneof
resource.
- custom_dimension¶
A snapshot of a CustomDimension resource in change history.
This field is a member of oneof
resource.
- custom_metric¶
A snapshot of a CustomMetric resource in change history.
This field is a member of oneof
resource.
- data_retention_settings¶
A snapshot of a data retention settings resource in change history.
This field is a member of oneof
resource.
- search_ads_360_link¶
A snapshot of a SearchAds360Link resource in change history.
This field is a member of oneof
resource.
- data_stream¶
A snapshot of a DataStream resource in change history.
This field is a member of oneof
resource.
- attribution_settings¶
A snapshot of AttributionSettings resource in change history.
This field is a member of oneof
resource.
- expanded_data_set¶
A snapshot of an ExpandedDataSet resource in change history.
This field is a member of oneof
resource.
- channel_group¶
A snapshot of a ChannelGroup resource in change history.
This field is a member of oneof
resource.
- bigquery_link¶
A snapshot of a BigQuery link resource in change history.
This field is a member of oneof
resource.
- enhanced_measurement_settings¶
A snapshot of EnhancedMeasurementSettings resource in change history.
This field is a member of oneof
resource.
- skadnetwork_conversion_value_schema¶
A snapshot of SKAdNetworkConversionValueSchema resource in change history.
This field is a member of oneof
resource.
- adsense_link¶
A snapshot of an AdSenseLink resource in change history.
This field is a member of oneof
resource.
- audience¶
A snapshot of an Audience resource in change history.
This field is a member of oneof
resource.
- class google.analytics.admin_v1alpha.types.ChangeHistoryEvent(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA set of changes within a Google Analytics account or its child properties that resulted from the same cause. Common causes would be updates made in the Google Analytics UI, changes from customer support, or automatic Google Analytics system changes.
- change_time¶
Time when change was made.
- actor_type¶
The type of actor that made this change.
- user_actor_email¶
Email address of the Google account that made the change. This will be a valid email address if the actor field is set to USER, and empty otherwise. Google accounts that have been deleted will cause an error.
- Type
- changes_filtered¶
If true, then the list of changes returned was filtered, and does not represent all changes that occurred in this event.
- Type
- changes¶
A list of changes made in this change history event that fit the filters specified in SearchChangeHistoryEventsRequest.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.ChangeHistoryChange]
- class google.analytics.admin_v1alpha.types.ChangeHistoryResourceType(value)[source]¶
Bases:
proto.enums.EnumTypes of resources whose changes may be returned from change history.
- Values:
- CHANGE_HISTORY_RESOURCE_TYPE_UNSPECIFIED (0):
Resource type unknown or not specified.
- ACCOUNT (1):
Account resource
- PROPERTY (2):
Property resource
- FIREBASE_LINK (6):
FirebaseLink resource
- GOOGLE_ADS_LINK (7):
GoogleAdsLink resource
- GOOGLE_SIGNALS_SETTINGS (8):
GoogleSignalsSettings resource
- CONVERSION_EVENT (9):
ConversionEvent resource
- MEASUREMENT_PROTOCOL_SECRET (10):
MeasurementProtocolSecret resource
- CUSTOM_DIMENSION (11):
CustomDimension resource
- CUSTOM_METRIC (12):
CustomMetric resource
- DATA_RETENTION_SETTINGS (13):
DataRetentionSettings resource
- DISPLAY_VIDEO_360_ADVERTISER_LINK (14):
DisplayVideo360AdvertiserLink resource
- DISPLAY_VIDEO_360_ADVERTISER_LINK_PROPOSAL (15):
DisplayVideo360AdvertiserLinkProposal resource
- SEARCH_ADS_360_LINK (16):
SearchAds360Link resource
- DATA_STREAM (18):
DataStream resource
- ATTRIBUTION_SETTINGS (20):
AttributionSettings resource
- EXPANDED_DATA_SET (21):
ExpandedDataSet resource
- CHANNEL_GROUP (22):
ChannelGroup resource
- ENHANCED_MEASUREMENT_SETTINGS (24):
EnhancedMeasurementSettings resource
- SKADNETWORK_CONVERSION_VALUE_SCHEMA (26):
SKAdNetworkConversionValueSchema resource
- ADSENSE_LINK (27):
AdSenseLink resource
- AUDIENCE (28):
Audience resource
- EVENT_CREATE_RULE (29):
EventCreateRule resource
- class google.analytics.admin_v1alpha.types.ChannelGroup(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA resource message representing a Channel Group.
- name¶
Output only. The resource name for this Channel Group resource. Format: properties/{property}/channelGroups/{channel_group}
- Type
- display_name¶
Required. The display name of the Channel Group. Max length of 80 characters.
- Type
- grouping_rule¶
Required. The grouping rules of channels. Maximum number of rules is 25.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.GroupingRule]
- class google.analytics.admin_v1alpha.types.ChannelGroupFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA specific filter for a single dimension.
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.
- string_filter¶
A filter for a string-type dimension that matches a particular pattern.
This field is a member of oneof
value_filter.
- in_list_filter¶
A filter for a string dimension that matches a particular list of options.
This field is a member of oneof
value_filter.
- class InListFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA filter for a string dimension that matches a particular list of options. The match is case insensitive.
- class StringFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageFilter where the field value is a String. The match is case insensitive.
- match_type¶
Required. The match type for the string filter.
- class MatchType(value)[source]¶
Bases:
proto.enums.EnumHow the filter will be used to determine a match.
- Values:
- MATCH_TYPE_UNSPECIFIED (0):
Default match type.
- 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 regular expression match with the string value.
- PARTIAL_REGEXP (6):
Partial regular expression match with the string value.
- class google.analytics.admin_v1alpha.types.ChannelGroupFilterExpression(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA logical expression of Channel Group dimension 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¶
A list of expressions to be AND’ed together. It can only contain ChannelGroupFilterExpressions with or_group. This must be set for the top level ChannelGroupFilterExpression.
This field is a member of oneof
expr.
- or_group¶
A list of expressions to OR’ed together. It cannot contain ChannelGroupFilterExpressions with and_group or or_group.
This field is a member of oneof
expr.
- not_expression¶
A filter expression to be NOT’ed (that is inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level ChannelGroupFilterExpression.
This field is a member of oneof
expr.
- class google.analytics.admin_v1alpha.types.ChannelGroupFilterExpressionList(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA list of Channel Group filter expressions.
- filter_expressions¶
A list of Channel Group filter expressions.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.ChannelGroupFilterExpression]
- class google.analytics.admin_v1alpha.types.CoarseValue(value)[source]¶
Bases:
proto.enums.EnumThe coarse conversion value set on the updatePostbackConversionValue SDK call when a ConversionValues.event_mappings conditions are satisfied. For more information, see SKAdNetwork.CoarseConversionValue.
- Values:
- COARSE_VALUE_UNSPECIFIED (0):
Coarse value not specified.
- COARSE_VALUE_LOW (1):
Coarse value of low.
- COARSE_VALUE_MEDIUM (2):
Coarse value of medium.
- COARSE_VALUE_HIGH (3):
Coarse value of high.
- class google.analytics.admin_v1alpha.types.ConnectedSiteTag(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration for a specific Connected Site Tag.
- display_name¶
Required. User-provided display name for the connected site tag. Must be less than 256 characters.
- Type
- class google.analytics.admin_v1alpha.types.ConversionEvent(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA conversion event in a Google Analytics property.
- name¶
Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}
- Type
- event_name¶
Immutable. The event name for this conversion event. Examples: ‘click’, ‘purchase’
- Type
- create_time¶
Output only. Time when this conversion event was created in the property.
- deletable¶
Output only. If set, this event can currently be deleted with DeleteConversionEvent.
- Type
- custom¶
Output only. If set to true, this conversion event refers to a custom event. If set to false, this conversion event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom conversion events that may be created per property.
- Type
- counting_method¶
Optional. The method by which conversions will be counted across multiple events within a session. If this value is not provided, it will be set to
ONCE_PER_EVENT.
- class ConversionCountingMethod(value)[source]¶
Bases:
proto.enums.EnumThe method by which conversions will be counted across multiple events within a session.
- Values:
- CONVERSION_COUNTING_METHOD_UNSPECIFIED (0):
Counting method not specified.
- ONCE_PER_EVENT (1):
Each Event instance is considered a Conversion.
- ONCE_PER_SESSION (2):
An Event instance is considered a Conversion at most once per session per user.
- class google.analytics.admin_v1alpha.types.ConversionValues(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConversion value settings for a postback window for SKAdNetwork conversion value schema.
- display_name¶
Display name of the SKAdNetwork conversion value. The max allowed display name length is 50 UTF-16 code units.
- Type
- fine_value¶
The fine-grained conversion value. This is applicable only to the first postback window. Its valid values are [0,63], both inclusive. It must be set for postback window 1, and must not be set for postback window 2 & 3. This value is not guaranteed to be unique.
If the configuration for the first postback window is re-used for second or third postback windows this field has no effect.
This field is a member of oneof
_fine_value.- Type
- coarse_value¶
Required. A coarse grained conversion value.
This value is not guaranteed to be unique.
- event_mappings¶
Event conditions that must be met for this Conversion Value to be achieved. The conditions in this list are ANDed together. It must have minimum of 1 entry and maximum of 3 entries, if the postback window is enabled.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.EventMapping]
- class google.analytics.admin_v1alpha.types.CreateAccessBindingRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for CreateAccessBinding RPC.
- access_binding¶
Required. The access binding to create.
- class google.analytics.admin_v1alpha.types.CreateAdSenseLinkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message to be passed to CreateAdSenseLink method.
- parent¶
Required. The property for which to create an AdSense Link. Format: properties/{propertyId} Example: properties/1234
- Type
- adsense_link¶
Required. The AdSense Link to create
- class google.analytics.admin_v1alpha.types.CreateAudienceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for CreateAudience RPC.
- audience¶
Required. The audience to create.
- class google.analytics.admin_v1alpha.types.CreateChannelGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for CreateChannelGroup RPC.
- parent¶
Required. The property for which to create a ChannelGroup. Example format: properties/1234
- Type
- channel_group¶
Required. The ChannelGroup to create.
- class google.analytics.admin_v1alpha.types.CreateConnectedSiteTagRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for CreateConnectedSiteTag RPC.
- property¶
The Universal Analytics property to create connected site tags for. This API does not support GA4 properties. Format: properties/{universalAnalyticsPropertyId} Example: properties/1234
- Type
- connected_site_tag¶
Required. The tag to add to the Universal Analytics property
- class google.analytics.admin_v1alpha.types.CreateConnectedSiteTagResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for CreateConnectedSiteTag RPC.
- class google.analytics.admin_v1alpha.types.CreateConversionEventRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for CreateConversionEvent RPC
- conversion_event¶
Required. The conversion event to create.
- class google.analytics.admin_v1alpha.types.CreateCustomDimensionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for CreateCustomDimension RPC.
- custom_dimension¶
Required. The CustomDimension to create.
- class google.analytics.admin_v1alpha.types.CreateCustomMetricRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for CreateCustomMetric RPC.
- custom_metric¶
Required. The CustomMetric to create.
- class google.analytics.admin_v1alpha.types.CreateDataStreamRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for CreateDataStream RPC.
- data_stream¶
Required. The DataStream to create.
- class google.analytics.admin_v1alpha.types.CreateDisplayVideo360AdvertiserLinkProposalRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for CreateDisplayVideo360AdvertiserLinkProposal RPC.
- display_video_360_advertiser_link_proposal¶
Required. The DisplayVideo360AdvertiserLinkProposal to create.
- class google.analytics.admin_v1alpha.types.CreateDisplayVideo360AdvertiserLinkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for CreateDisplayVideo360AdvertiserLink RPC.
- display_video_360_advertiser_link¶
Required. The DisplayVideo360AdvertiserLink to create.
- class google.analytics.admin_v1alpha.types.CreateEventCreateRuleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for CreateEventCreateRule RPC.
- event_create_rule¶
Required. The EventCreateRule to create.
- class google.analytics.admin_v1alpha.types.CreateExpandedDataSetRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for CreateExpandedDataSet RPC.
- expanded_data_set¶
Required. The ExpandedDataSet to create.
- class google.analytics.admin_v1alpha.types.CreateFirebaseLinkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for CreateFirebaseLink RPC
- firebase_link¶
Required. The Firebase link to create.
- class google.analytics.admin_v1alpha.types.CreateGoogleAdsLinkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for CreateGoogleAdsLink RPC
- google_ads_link¶
Required. The GoogleAdsLink to create.
- class google.analytics.admin_v1alpha.types.CreateMeasurementProtocolSecretRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for CreateMeasurementProtocolSecret RPC
- parent¶
Required. The parent resource where this secret will be created. Format: properties/{property}/dataStreams/{dataStream}
- Type
- measurement_protocol_secret¶
Required. The measurement protocol secret to create.
- class google.analytics.admin_v1alpha.types.CreatePropertyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for CreateProperty RPC.
- property¶
Required. The property to create. Note: the supplied property must specify its parent.
- class google.analytics.admin_v1alpha.types.CreateSKAdNetworkConversionValueSchemaRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for CreateSKAdNetworkConversionValueSchema RPC.
- parent¶
Required. The parent resource where this schema will be created. Format: properties/{property}/dataStreams/{dataStream}
- Type
- skadnetwork_conversion_value_schema¶
Required. SKAdNetwork conversion value schema to create.
- class google.analytics.admin_v1alpha.types.CreateSearchAds360LinkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for CreateSearchAds360Link RPC.
- search_ads_360_link¶
Required. The SearchAds360Link to create.
- class google.analytics.admin_v1alpha.types.CreateUserLinkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for CreateUserLink RPC.
Users can have multiple email addresses associated with their Google account, and one of these email addresses is the “primary” email address. Any of the email addresses associated with a Google account may be used for a new UserLink, but the returned UserLink will always contain the “primary” email address. As a result, the input and output email address for this request may differ.
- notify_new_user¶
Optional. If set, then email the new user notifying them that they’ve been granted permissions to the resource.
- Type
- user_link¶
Required. The user link to create.
- class google.analytics.admin_v1alpha.types.CustomDimension(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA definition for a CustomDimension.
- name¶
Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}
- Type
- parameter_name¶
Required. Immutable. Tagging parameter name for this custom dimension. If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name.
If this is an item-scoped dimension, then this is the parameter name found in the eCommerce items array.
May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions.
- Type
- display_name¶
Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.
- Type
- description¶
Optional. Description for this custom dimension. Max length of 150 characters.
- Type
- scope¶
Required. Immutable. The scope of this dimension.
- disallow_ads_personalization¶
Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization.
This is currently only supported by user-scoped custom dimensions.
- Type
- class DimensionScope(value)[source]¶
Bases:
proto.enums.EnumValid values for the scope of this dimension.
- Values:
- DIMENSION_SCOPE_UNSPECIFIED (0):
Scope unknown or not specified.
- EVENT (1):
Dimension scoped to an event.
- USER (2):
Dimension scoped to a user.
- ITEM (3):
Dimension scoped to eCommerce items
- class google.analytics.admin_v1alpha.types.CustomMetric(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA definition for a custom metric.
- name¶
Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}
- Type
- parameter_name¶
Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name.
May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics.
- Type
- display_name¶
Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.
- Type
- description¶
Optional. Description for this custom dimension. Max length of 150 characters.
- Type
- measurement_unit¶
Required. The type for the custom metric’s value.
- scope¶
Required. Immutable. The scope of this custom metric.
- restricted_metric_type¶
Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.CustomMetric.RestrictedMetricType]
- class MeasurementUnit(value)[source]¶
Bases:
proto.enums.EnumPossible types of representing the custom metric’s value.
Currency representation may change in the future, requiring a breaking API change.
- Values:
- MEASUREMENT_UNIT_UNSPECIFIED (0):
MeasurementUnit unspecified or missing.
- STANDARD (1):
This metric uses default units.
- CURRENCY (2):
This metric measures a currency.
- FEET (3):
This metric measures feet.
- METERS (4):
This metric measures meters.
- KILOMETERS (5):
This metric measures kilometers.
- MILES (6):
This metric measures miles.
- MILLISECONDS (7):
This metric measures milliseconds.
- SECONDS (8):
This metric measures seconds.
- MINUTES (9):
This metric measures minutes.
- HOURS (10):
This metric measures hours.
- class MetricScope(value)[source]¶
Bases:
proto.enums.EnumThe scope of this metric.
- Values:
- METRIC_SCOPE_UNSPECIFIED (0):
Scope unknown or not specified.
- EVENT (1):
Metric scoped to an event.
- class RestrictedMetricType(value)[source]¶
Bases:
proto.enums.EnumLabels that mark the data in this custom metric as data that should be restricted to specific users.
- Values:
- RESTRICTED_METRIC_TYPE_UNSPECIFIED (0):
Type unknown or unspecified.
- COST_DATA (1):
Metric reports cost data.
- REVENUE_DATA (2):
Metric reports revenue data.
- class google.analytics.admin_v1alpha.types.DataRetentionSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSettings values for data retention. This is a singleton resource.
- name¶
Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings
- Type
- event_data_retention¶
The length of time that event-level data is retained.
- reset_user_data_on_new_activity¶
If true, reset the retention period for the user identifier with every event from that user.
- Type
- class RetentionDuration(value)[source]¶
Bases:
proto.enums.EnumValid values for the data retention duration.
- Values:
- RETENTION_DURATION_UNSPECIFIED (0):
Data retention time duration is not specified.
- TWO_MONTHS (1):
The data retention time duration is 2 months.
- FOURTEEN_MONTHS (3):
The data retention time duration is 14 months.
- TWENTY_SIX_MONTHS (4):
The data retention time duration is 26 months. Available to 360 properties only.
- THIRTY_EIGHT_MONTHS (5):
The data retention time duration is 38 months. Available to 360 properties only.
- FIFTY_MONTHS (6):
The data retention time duration is 50 months. Available to 360 properties only.
- class google.analytics.admin_v1alpha.types.DataSharingSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA resource message representing data sharing settings of a Google Analytics account.
- name¶
Output only. Resource name. Format: accounts/{account}/dataSharingSettings Example: “accounts/1000/dataSharingSettings”.
- Type
- sharing_with_google_support_enabled¶
Allows Google support to access the data in order to help troubleshoot issues.
- Type
- sharing_with_google_assigned_sales_enabled¶
Allows Google sales teams that are assigned to the customer to access the data in order to suggest configuration changes to improve results. Sales team restrictions still apply when enabled.
- Type
- sharing_with_google_any_sales_enabled¶
Allows any of Google sales to access the data in order to suggest configuration changes to improve results.
- Type
- sharing_with_google_products_enabled¶
Allows Google to use the data to improve other Google products or services.
- Type
- class google.analytics.admin_v1alpha.types.DataStream(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA resource message representing a data stream.
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.
- web_stream_data¶
Data specific to web streams. Must be populated if type is WEB_DATA_STREAM.
This field is a member of oneof
stream_data.
- android_app_stream_data¶
Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM.
This field is a member of oneof
stream_data.
- ios_app_stream_data¶
Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM.
This field is a member of oneof
stream_data.
- name¶
Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: “properties/1000/dataStreams/2000”.
- Type
- type_¶
Required. Immutable. The type of this DataStream resource.
- display_name¶
Human-readable display name for the Data Stream. Required for web data streams.
The max allowed display name length is 255 UTF-16 code units.
- Type
- create_time¶
Output only. Time when this stream was originally created.
- update_time¶
Output only. Time when stream payload fields were last updated.
- class AndroidAppStreamData(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageData specific to Android app streams.
- firebase_app_id¶
Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated.
- Type
- class DataStreamType(value)[source]¶
Bases:
proto.enums.EnumThe type of the data stream.
- Values:
- DATA_STREAM_TYPE_UNSPECIFIED (0):
Type unknown or not specified.
- WEB_DATA_STREAM (1):
Web data stream.
- ANDROID_APP_DATA_STREAM (2):
Android app data stream.
- IOS_APP_DATA_STREAM (3):
iOS app data stream.
- class IosAppStreamData(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageData specific to iOS app streams.
- firebase_app_id¶
Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated.
- Type
- class WebStreamData(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageData specific to web streams.
- firebase_app_id¶
Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated.
- Type
- default_uri¶
Domain name of the web app being measured, or empty. Example: “http://www.google.com”, “https://www.google.com”.
- Type
- class google.analytics.admin_v1alpha.types.DeleteAccessBindingRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for DeleteAccessBinding RPC.
- class google.analytics.admin_v1alpha.types.DeleteAccountRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for DeleteAccount RPC.
- class google.analytics.admin_v1alpha.types.DeleteAdSenseLinkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message to be passed to DeleteAdSenseLink method.
- class google.analytics.admin_v1alpha.types.DeleteChannelGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for DeleteChannelGroup RPC.
- class google.analytics.admin_v1alpha.types.DeleteConnectedSiteTagRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for DeleteConnectedSiteTag RPC.
- property¶
The Universal Analytics property to delete connected site tags for. This API does not support GA4 properties. Format: properties/{universalAnalyticsPropertyId} Example: properties/1234
- Type
- class google.analytics.admin_v1alpha.types.DeleteConversionEventRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for DeleteConversionEvent RPC
- class google.analytics.admin_v1alpha.types.DeleteDataStreamRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for DeleteDataStream RPC.
- class google.analytics.admin_v1alpha.types.DeleteDisplayVideo360AdvertiserLinkProposalRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for DeleteDisplayVideo360AdvertiserLinkProposal RPC.
- class google.analytics.admin_v1alpha.types.DeleteDisplayVideo360AdvertiserLinkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for DeleteDisplayVideo360AdvertiserLink RPC.
- class google.analytics.admin_v1alpha.types.DeleteEventCreateRuleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for DeleteEventCreateRule RPC.
- class google.analytics.admin_v1alpha.types.DeleteExpandedDataSetRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for DeleteExpandedDataSet RPC.
- class google.analytics.admin_v1alpha.types.DeleteFirebaseLinkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for DeleteFirebaseLink RPC
- class google.analytics.admin_v1alpha.types.DeleteGoogleAdsLinkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for DeleteGoogleAdsLink RPC.
- class google.analytics.admin_v1alpha.types.DeleteMeasurementProtocolSecretRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for DeleteMeasurementProtocolSecret RPC
- class google.analytics.admin_v1alpha.types.DeletePropertyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for DeleteProperty RPC.
- class google.analytics.admin_v1alpha.types.DeleteSKAdNetworkConversionValueSchemaRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for DeleteSKAdNetworkConversionValueSchema RPC.
- class google.analytics.admin_v1alpha.types.DeleteSearchAds360LinkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for DeleteSearchAds360Link RPC.
- class google.analytics.admin_v1alpha.types.DeleteUserLinkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for DeleteUserLink RPC.
- class google.analytics.admin_v1alpha.types.DisplayVideo360AdvertiserLink(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA link between a GA4 property and a Display & Video 360 advertiser.
- name¶
Output only. The resource name for this DisplayVideo360AdvertiserLink resource. Format:
properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId}
Note: linkId is not the Display & Video 360 Advertiser ID
- Type
- advertiser_display_name¶
Output only. The display name of the Display & Video 360 Advertiser.
- Type
- ads_personalization_enabled¶
Enables personalized advertising features with this integration. If this field is not set on create/update, it will be defaulted to true.
- campaign_data_sharing_enabled¶
Immutable. Enables the import of campaign data from Display & Video 360 into the GA4 property. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true.
- cost_data_sharing_enabled¶
Immutable. Enables the import of cost data from Display & Video 360 into the GA4 property. This can only be enabled if campaign_data_sharing_enabled is enabled. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true.
- class google.analytics.admin_v1alpha.types.DisplayVideo360AdvertiserLinkProposal(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA proposal for a link between a GA4 property and a Display & Video 360 advertiser.
A proposal is converted to a DisplayVideo360AdvertiserLink once approved. Google Analytics admins approve inbound proposals while Display & Video 360 admins approve outbound proposals.
- name¶
Output only. The resource name for this DisplayVideo360AdvertiserLinkProposal resource. Format:
properties/{propertyId}/displayVideo360AdvertiserLinkProposals/{proposalId}
Note: proposalId is not the Display & Video 360 Advertiser ID
- Type
- link_proposal_status_details¶
Output only. The status information for this link proposal.
- advertiser_display_name¶
Output only. The display name of the Display & Video Advertiser. Only populated for proposals that originated from Display & Video 360.
- Type
- validation_email¶
Input only. On a proposal being sent to Display & Video 360, this field must be set to the email address of an admin on the target advertiser. This is used to verify that the Google Analytics admin is aware of at least one admin on the Display & Video 360 Advertiser. This does not restrict approval of the proposal to a single user. Any admin on the Display & Video 360 Advertiser may approve the proposal.
- Type
- ads_personalization_enabled¶
Immutable. Enables personalized advertising features with this integration. If this field is not set on create, it will be defaulted to true.
- campaign_data_sharing_enabled¶
Immutable. Enables the import of campaign data from Display & Video 360. If this field is not set on create, it will be defaulted to true.
- cost_data_sharing_enabled¶
Immutable. Enables the import of cost data from Display & Video 360. This can only be enabled if campaign_data_sharing_enabled is enabled. If this field is not set on create, it will be defaulted to true.
- class google.analytics.admin_v1alpha.types.EnhancedMeasurementSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSingleton resource under a web DataStream, configuring measurement of additional site interactions and content.
- name¶
Output only. Resource name of the Enhanced Measurement Settings. Format: properties/{property_id}/dataStreams/{data_stream}/enhancedMeasurementSettings Example: “properties/1000/dataStreams/2000/enhancedMeasurementSettings”.
- Type
- stream_enabled¶
Indicates whether Enhanced Measurement Settings will be used to automatically measure interactions and content on this web stream.
Changing this value does not affect the settings themselves, but determines whether they are respected.
- Type
- scrolls_enabled¶
If enabled, capture scroll events each time a visitor gets to the bottom of a page.
- Type
- outbound_clicks_enabled¶
If enabled, capture an outbound click event each time a visitor clicks a link that leads them away from your domain.
- Type
- site_search_enabled¶
If enabled, capture a view search results event each time a visitor performs a search on your site (based on a query parameter).
- Type
- video_engagement_enabled¶
If enabled, capture video play, progress, and complete events as visitors view embedded videos on your site.
- Type
- file_downloads_enabled¶
If enabled, capture a file download event each time a link is clicked with a common document, compressed file, application, video, or audio extension.
- Type
- page_changes_enabled¶
If enabled, capture a page view event each time the website changes the browser history state.
- Type
- form_interactions_enabled¶
If enabled, capture a form interaction event each time a visitor interacts with a form on your website. False by default.
- Type
- search_query_parameter¶
Required. URL query parameters to interpret as site search parameters. Max length is 1024 characters. Must not be empty.
- Type
- class google.analytics.admin_v1alpha.types.EventCreateRule(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAn Event Create Rule defines conditions that will trigger the creation of an entirely new event based upon matched criteria of a source event. Additional mutations of the parameters from the source event can be defined.
Unlike Event Edit rules, Event Creation Rules have no defined order. They will all be run independently.
Event Edit and Event Create rules can’t be used to modify an event created from an Event Create rule.
- name¶
Output only. Resource name for this EventCreateRule resource. Format: properties/{property}/dataStreams/{data_stream}/eventCreateRules/{event_create_rule}
- Type
- destination_event¶
Required. The name of the new event to be created.
This value must:
be less than 40 characters
consist only of letters, digits or _ (underscores)
start with a letter
- Type
- event_conditions¶
Required. Must have at least one condition, and can have up to 10 max. Conditions on the source event must match for this rule to be applied.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.MatchingCondition]
- source_copy_parameters¶
If true, the source parameters are copied to the new event. If false, or unset, all non-internal parameters are not copied from the source event. Parameter mutations are applied after the parameters have been copied.
- Type
- parameter_mutations¶
Parameter mutations define parameter behavior on the new event, and are applied in order. A maximum of 20 mutations can be applied.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.ParameterMutation]
- class google.analytics.admin_v1alpha.types.EventMapping(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageEvent setting conditions to match an event.
- event_name¶
Required. Name of the GA4 event. It must always be set. The max allowed display name length is 40 UTF-16 code units.
- Type
- min_event_count¶
At least one of the following four min/max values must be set. The values set will be ANDed together to qualify an event. The minimum number of times the event occurred. If not set, minimum event count won’t be checked.
This field is a member of oneof
_min_event_count.- Type
- max_event_count¶
The maximum number of times the event occurred. If not set, maximum event count won’t be checked.
This field is a member of oneof
_max_event_count.- Type
- class google.analytics.admin_v1alpha.types.ExpandedDataSet(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA resource message representing a GA4 ExpandedDataSet.
- name¶
Output only. The resource name for this ExpandedDataSet resource. Format: properties/{property_id}/expandedDataSets/{expanded_data_set}
- Type
- dimension_names¶
Immutable. The list of dimensions included in the ExpandedDataSet. See the API Dimensions for the list of dimension names.
- Type
MutableSequence[str]
- metric_names¶
Immutable. The list of metrics included in the ExpandedDataSet. See the API Metrics for the list of dimension names.
- Type
MutableSequence[str]
- dimension_filter_expression¶
Immutable. A logical expression of ExpandedDataSet filters applied to dimension included in the ExpandedDataSet. This filter is used to reduce the number of rows and thus the chance of encountering
otherrow.
- data_collection_start_time¶
Output only. Time when expanded data set began (or will begin) collecing data.
- class google.analytics.admin_v1alpha.types.ExpandedDataSetFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA specific filter for a single dimension
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.
- string_filter¶
A filter for a string-type dimension that matches a particular pattern.
This field is a member of oneof
one_filter.
- in_list_filter¶
A filter for a string dimension that matches a particular list of options.
This field is a member of oneof
one_filter.
- class InListFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA filter for a string dimension that matches a particular list of options.
- class StringFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA filter for a string-type dimension that matches a particular pattern.
- match_type¶
Required. The match type for the string filter.
- case_sensitive¶
Optional. If true, the match is case-sensitive. If false, the match is case-insensitive. Must be true when match_type is EXACT. Must be false when match_type is CONTAINS.
- Type
- class MatchType(value)[source]¶
Bases:
proto.enums.EnumThe match type for the string filter.
- Values:
- MATCH_TYPE_UNSPECIFIED (0):
Unspecified
- EXACT (1):
Exact match of the string value.
- CONTAINS (2):
Contains the string value.
- class google.analytics.admin_v1alpha.types.ExpandedDataSetFilterExpression(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA logical expression of EnhancedDataSet dimension 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¶
A list of expressions to be AND’ed together. It must contain a ExpandedDataSetFilterExpression with either not_expression or dimension_filter. This must be set for the top level ExpandedDataSetFilterExpression.
This field is a member of oneof
expr.
- not_expression¶
A filter expression to be NOT’ed (that is, inverted, complemented). It must include a dimension_filter. This cannot be set on the top level ExpandedDataSetFilterExpression.
This field is a member of oneof
expr.
- class google.analytics.admin_v1alpha.types.ExpandedDataSetFilterExpressionList(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA list of ExpandedDataSet filter expressions.
- filter_expressions¶
A list of ExpandedDataSet filter expressions.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.ExpandedDataSetFilterExpression]
- class google.analytics.admin_v1alpha.types.FetchAutomatedGa4ConfigurationOptOutRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest for fetching the opt out status for the automated GA4 setup process.
- class google.analytics.admin_v1alpha.types.FetchAutomatedGa4ConfigurationOptOutResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for fetching the opt out status for the automated GA4 setup process.
- class google.analytics.admin_v1alpha.types.FetchConnectedGa4PropertyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest for looking up GA4 property connected to a UA property.
- class google.analytics.admin_v1alpha.types.FetchConnectedGa4PropertyResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse for looking up GA4 property connected to a UA property.
- class google.analytics.admin_v1alpha.types.FirebaseLink(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA link between a GA4 property and a Firebase project.
- project¶
Immutable. Firebase project resource name. When creating a FirebaseLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, returned FirebaseLinks will always have a project_name that contains a project number.
Format: ‘projects/{project number}’ Example: ‘projects/1234’
- Type
- create_time¶
Output only. Time when this FirebaseLink was originally created.
- class google.analytics.admin_v1alpha.types.GetAccessBindingRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for GetAccessBinding RPC.
- class google.analytics.admin_v1alpha.types.GetAccountRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for GetAccount RPC.
- class google.analytics.admin_v1alpha.types.GetAdSenseLinkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message to be passed to GetAdSenseLink method.
- class google.analytics.admin_v1alpha.types.GetAttributionSettingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for GetAttributionSettings RPC.
- class google.analytics.admin_v1alpha.types.GetAudienceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for GetAudience RPC.
- class google.analytics.admin_v1alpha.types.GetBigQueryLinkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for GetBigQueryLink RPC.
- class google.analytics.admin_v1alpha.types.GetChannelGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for GetChannelGroup RPC.
- class google.analytics.admin_v1alpha.types.GetConversionEventRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for GetConversionEvent RPC
- class google.analytics.admin_v1alpha.types.GetCustomDimensionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for GetCustomDimension RPC.
- class google.analytics.admin_v1alpha.types.GetCustomMetricRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for GetCustomMetric RPC.
- class google.analytics.admin_v1alpha.types.GetDataRetentionSettingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for GetDataRetentionSettings RPC.
- class google.analytics.admin_v1alpha.types.GetDataSharingSettingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for GetDataSharingSettings RPC.
- class google.analytics.admin_v1alpha.types.GetDataStreamRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for GetDataStream RPC.
- class google.analytics.admin_v1alpha.types.GetDisplayVideo360AdvertiserLinkProposalRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for GetDisplayVideo360AdvertiserLinkProposal RPC.
- class google.analytics.admin_v1alpha.types.GetDisplayVideo360AdvertiserLinkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for GetDisplayVideo360AdvertiserLink RPC.
- class google.analytics.admin_v1alpha.types.GetEnhancedMeasurementSettingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for GetEnhancedMeasurementSettings RPC.
- class google.analytics.admin_v1alpha.types.GetEventCreateRuleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for GetEventCreateRule RPC.
- class google.analytics.admin_v1alpha.types.GetExpandedDataSetRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for GetExpandedDataSet RPC.
- class google.analytics.admin_v1alpha.types.GetGlobalSiteTagRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for GetGlobalSiteTag RPC.
- class google.analytics.admin_v1alpha.types.GetGoogleSignalsSettingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for GetGoogleSignalsSettings RPC
- class google.analytics.admin_v1alpha.types.GetMeasurementProtocolSecretRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for GetMeasurementProtocolSecret RPC.
- class google.analytics.admin_v1alpha.types.GetPropertyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for GetProperty RPC.
- class google.analytics.admin_v1alpha.types.GetSKAdNetworkConversionValueSchemaRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for GetSKAdNetworkConversionValueSchema RPC.
- class google.analytics.admin_v1alpha.types.GetSearchAds360LinkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for GetSearchAds360Link RPC.
- class google.analytics.admin_v1alpha.types.GetUserLinkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for GetUserLink RPC.
- class google.analytics.admin_v1alpha.types.GlobalSiteTag(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRead-only resource with the tag for sending data from a website to a DataStream. Only present for web DataStream resources.
- name¶
Output only. Resource name for this GlobalSiteTag resource. Format: properties/{property_id}/dataStreams/{stream_id}/globalSiteTag Example: “properties/123/dataStreams/456/globalSiteTag”.
- Type
- class google.analytics.admin_v1alpha.types.GoogleAdsLink(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA link between a GA4 property and a Google Ads account.
- name¶
Output only. Format:
properties/{propertyId}/googleAdsLinks/{googleAdsLinkId}
Note: googleAdsLinkId is not the Google Ads customer ID.
- Type
- ads_personalization_enabled¶
Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update, it will be defaulted to true.
- create_time¶
Output only. Time when this link was originally created.
- update_time¶
Output only. Time when this link was last updated.
- class google.analytics.admin_v1alpha.types.GoogleSignalsConsent(value)[source]¶
Bases:
proto.enums.EnumConsent field of the Google Signals settings.
- Values:
- GOOGLE_SIGNALS_CONSENT_UNSPECIFIED (0):
Google Signals consent value defaults to GOOGLE_SIGNALS_CONSENT_UNSPECIFIED. This will be treated as GOOGLE_SIGNALS_CONSENT_NOT_CONSENTED.
- GOOGLE_SIGNALS_CONSENT_CONSENTED (2):
Terms of service have been accepted
- GOOGLE_SIGNALS_CONSENT_NOT_CONSENTED (1):
Terms of service have not been accepted
- class google.analytics.admin_v1alpha.types.GoogleSignalsSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSettings values for Google Signals. This is a singleton resource.
- name¶
Output only. Resource name of this setting. Format: properties/{property_id}/googleSignalsSettings Example: “properties/1000/googleSignalsSettings”.
- Type
- state¶
Status of this setting.
- consent¶
Output only. Terms of Service acceptance.
- class google.analytics.admin_v1alpha.types.GoogleSignalsState(value)[source]¶
Bases:
proto.enums.EnumStatus of the Google Signals settings.
- Values:
- GOOGLE_SIGNALS_STATE_UNSPECIFIED (0):
Google Signals status defaults to GOOGLE_SIGNALS_STATE_UNSPECIFIED to represent that the user has not made an explicit choice.
- GOOGLE_SIGNALS_ENABLED (1):
Google Signals is enabled.
- GOOGLE_SIGNALS_DISABLED (2):
Google Signals is disabled.
- class google.analytics.admin_v1alpha.types.GroupingRule(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe rules that govern how traffic is grouped into one channel.
- expression¶
Required. The Filter Expression that defines the Grouping Rule.
- class google.analytics.admin_v1alpha.types.IndustryCategory(value)[source]¶
Bases:
proto.enums.EnumThe category selected for this property, used for industry benchmarking.
- Values:
- INDUSTRY_CATEGORY_UNSPECIFIED (0):
Industry category unspecified
- AUTOMOTIVE (1):
Automotive
- BUSINESS_AND_INDUSTRIAL_MARKETS (2):
Business and industrial markets
- FINANCE (3):
Finance
- HEALTHCARE (4):
Healthcare
- TECHNOLOGY (5):
Technology
- TRAVEL (6):
Travel
- OTHER (7):
Other
- ARTS_AND_ENTERTAINMENT (8):
Arts and entertainment
- BEAUTY_AND_FITNESS (9):
Beauty and fitness
- BOOKS_AND_LITERATURE (10):
Books and literature
- FOOD_AND_DRINK (11):
Food and drink
- GAMES (12):
Games
- HOBBIES_AND_LEISURE (13):
Hobbies and leisure
- HOME_AND_GARDEN (14):
Home and garden
- INTERNET_AND_TELECOM (15):
Internet and telecom
- LAW_AND_GOVERNMENT (16):
Law and government
- NEWS (17):
News
- ONLINE_COMMUNITIES (18):
Online communities
- PEOPLE_AND_SOCIETY (19):
People and society
- PETS_AND_ANIMALS (20):
Pets and animals
- REAL_ESTATE (21):
Real estate
- REFERENCE (22):
Reference
- SCIENCE (23):
Science
- SPORTS (24):
Sports
- JOBS_AND_EDUCATION (25):
Jobs and education
- SHOPPING (26):
Shopping
- class google.analytics.admin_v1alpha.types.LinkProposalInitiatingProduct(value)[source]¶
Bases:
proto.enums.EnumAn indication of which product the user initiated a link proposal from.
- Values:
- LINK_PROPOSAL_INITIATING_PRODUCT_UNSPECIFIED (0):
Unspecified product.
- GOOGLE_ANALYTICS (1):
This proposal was created by a user from Google Analytics.
- LINKED_PRODUCT (2):
This proposal was created by a user from a linked product (not Google Analytics).
- class google.analytics.admin_v1alpha.types.LinkProposalState(value)[source]¶
Bases:
proto.enums.EnumThe state of a link proposal resource.
- Values:
- LINK_PROPOSAL_STATE_UNSPECIFIED (0):
Unspecified state
- AWAITING_REVIEW_FROM_GOOGLE_ANALYTICS (1):
This proposal is awaiting review from a Google Analytics user. This proposal will automatically expire after some time.
- AWAITING_REVIEW_FROM_LINKED_PRODUCT (2):
This proposal is awaiting review from a user of a linked product. This proposal will automatically expire after some time.
- WITHDRAWN (3):
This proposal has been withdrawn by an admin on the initiating product. This proposal will be automatically deleted after some time.
- DECLINED (4):
This proposal has been declined by an admin on the receiving product. This proposal will be automatically deleted after some time.
- EXPIRED (5):
This proposal expired due to lack of response from an admin on the receiving product. This proposal will be automatically deleted after some time.
- OBSOLETE (6):
This proposal has become obsolete because a link was directly created to the same external product resource that this proposal specifies. This proposal will be automatically deleted after some time.
- class google.analytics.admin_v1alpha.types.LinkProposalStatusDetails(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageStatus information for a link proposal.
- link_proposal_initiating_product¶
Output only. The source of this proposal.
- link_proposal_state¶
Output only. The state of this proposal.
- class google.analytics.admin_v1alpha.types.ListAccessBindingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ListAccessBindings RPC.
- page_size¶
The maximum number of access bindings to return. The service may return fewer than this value. If unspecified, at most 200 access bindings will be returned. The maximum value is 500; values above 500 will be coerced to 500.
- Type
- class google.analytics.admin_v1alpha.types.ListAccessBindingsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ListAccessBindings RPC.
- access_bindings¶
List of AccessBindings. These will be ordered stably, but in an arbitrary order.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.AccessBinding]
- class google.analytics.admin_v1alpha.types.ListAccountSummariesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ListAccountSummaries RPC.
- page_size¶
The maximum number of AccountSummary resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
- Type
- class google.analytics.admin_v1alpha.types.ListAccountSummariesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ListAccountSummaries RPC.
- account_summaries¶
Account summaries of all accounts the caller has access to.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.AccountSummary]
- class google.analytics.admin_v1alpha.types.ListAccountsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ListAccounts RPC.
- page_size¶
The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
- Type
- page_token¶
A page token, received from a previous
ListAccountscall. Provide this to retrieve the subsequent page. When paginating, all other parameters provided toListAccountsmust match the call that provided the page token.- Type
- class google.analytics.admin_v1alpha.types.ListAccountsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ListAccounts RPC.
- accounts¶
Results that were accessible to the caller.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.Account]
- class google.analytics.admin_v1alpha.types.ListAdSenseLinksRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message to be passed to ListAdSenseLinks method.
- parent¶
Required. Resource name of the parent property. Format: properties/{propertyId} Example: properties/1234
- Type
- page_size¶
The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).
- Type
- class google.analytics.admin_v1alpha.types.ListAdSenseLinksResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ListAdSenseLinks method.
- adsense_links¶
List of AdSenseLinks.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.AdSenseLink]
- class google.analytics.admin_v1alpha.types.ListAudiencesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ListAudiences RPC.
- page_size¶
The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).
- Type
- class google.analytics.admin_v1alpha.types.ListAudiencesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ListAudiences RPC.
- audiences¶
List of Audiences.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.Audience]
- class google.analytics.admin_v1alpha.types.ListBigQueryLinksRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ListBigQueryLinks RPC.
- parent¶
Required. The name of the property to list BigQuery links under. Format: properties/{property_id} Example: properties/1234
- Type
- page_size¶
The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
- Type
- class google.analytics.admin_v1alpha.types.ListBigQueryLinksResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ListBigQueryLinks RPC
- bigquery_links¶
List of BigQueryLinks.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.BigQueryLink]
- class google.analytics.admin_v1alpha.types.ListChannelGroupsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ListChannelGroups RPC.
- parent¶
Required. The property for which to list ChannelGroups. Example format: properties/1234
- Type
- page_size¶
The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).
- Type
- class google.analytics.admin_v1alpha.types.ListChannelGroupsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ListChannelGroups RPC.
- channel_groups¶
List of ChannelGroup. These will be ordered stably, but in an arbitrary order.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.ChannelGroup]
- class google.analytics.admin_v1alpha.types.ListConnectedSiteTagsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ListConnectedSiteTags RPC.
- class google.analytics.admin_v1alpha.types.ListConnectedSiteTagsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ListConnectedSiteTags RPC.
- connected_site_tags¶
The site tags for the Universal Analytics property. A maximum of 20 connected site tags will be returned.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.ConnectedSiteTag]
- class google.analytics.admin_v1alpha.types.ListConversionEventsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ListConversionEvents RPC
- page_size¶
The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
- Type
- class google.analytics.admin_v1alpha.types.ListConversionEventsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ListConversionEvents RPC.
- conversion_events¶
The requested conversion events
- Type
MutableSequence[google.analytics.admin_v1alpha.types.ConversionEvent]
- class google.analytics.admin_v1alpha.types.ListCustomDimensionsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ListCustomDimensions RPC.
- page_size¶
The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).
- Type
- class google.analytics.admin_v1alpha.types.ListCustomDimensionsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ListCustomDimensions RPC.
- custom_dimensions¶
List of CustomDimensions.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.CustomDimension]
- class google.analytics.admin_v1alpha.types.ListCustomMetricsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ListCustomMetrics RPC.
- page_size¶
The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).
- Type
- class google.analytics.admin_v1alpha.types.ListCustomMetricsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ListCustomMetrics RPC.
- custom_metrics¶
List of CustomMetrics.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.CustomMetric]
- class google.analytics.admin_v1alpha.types.ListDataStreamsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ListDataStreams RPC.
- page_size¶
The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).
- Type
- class google.analytics.admin_v1alpha.types.ListDataStreamsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ListDataStreams RPC.
- data_streams¶
List of DataStreams.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.DataStream]
- class google.analytics.admin_v1alpha.types.ListDisplayVideo360AdvertiserLinkProposalsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ListDisplayVideo360AdvertiserLinkProposals RPC.
- page_size¶
The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).
- Type
- class google.analytics.admin_v1alpha.types.ListDisplayVideo360AdvertiserLinkProposalsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ListDisplayVideo360AdvertiserLinkProposals RPC.
- display_video_360_advertiser_link_proposals¶
List of DisplayVideo360AdvertiserLinkProposals.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.DisplayVideo360AdvertiserLinkProposal]
- class google.analytics.admin_v1alpha.types.ListDisplayVideo360AdvertiserLinksRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ListDisplayVideo360AdvertiserLinks RPC.
- page_size¶
The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).
- Type
- class google.analytics.admin_v1alpha.types.ListDisplayVideo360AdvertiserLinksResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ListDisplayVideo360AdvertiserLinks RPC.
- display_video_360_advertiser_links¶
List of DisplayVideo360AdvertiserLinks.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.DisplayVideo360AdvertiserLink]
- class google.analytics.admin_v1alpha.types.ListEventCreateRulesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ListEventCreateRules RPC.
- page_size¶
The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).
- Type
- class google.analytics.admin_v1alpha.types.ListEventCreateRulesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ListEventCreateRules RPC.
- event_create_rules¶
List of EventCreateRules. These will be ordered stably, but in an arbitrary order.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.EventCreateRule]
- class google.analytics.admin_v1alpha.types.ListExpandedDataSetsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ListExpandedDataSets RPC.
- page_size¶
The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).
- Type
- class google.analytics.admin_v1alpha.types.ListExpandedDataSetsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ListExpandedDataSets RPC.
- expanded_data_sets¶
List of ExpandedDataSet. These will be ordered stably, but in an arbitrary order.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.ExpandedDataSet]
- class google.analytics.admin_v1alpha.types.ListFirebaseLinksRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ListFirebaseLinks RPC
- page_size¶
The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
- Type
- class google.analytics.admin_v1alpha.types.ListFirebaseLinksResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ListFirebaseLinks RPC
- firebase_links¶
List of FirebaseLinks. This will have at most one value.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.FirebaseLink]
- class google.analytics.admin_v1alpha.types.ListGoogleAdsLinksRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ListGoogleAdsLinks RPC.
- page_size¶
The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).
- Type
- class google.analytics.admin_v1alpha.types.ListGoogleAdsLinksResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ListGoogleAdsLinks RPC.
- google_ads_links¶
List of GoogleAdsLinks.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.GoogleAdsLink]
- class google.analytics.admin_v1alpha.types.ListMeasurementProtocolSecretsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ListMeasurementProtocolSecret RPC
- parent¶
Required. The resource name of the parent stream. Format:
properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets
- Type
- page_size¶
The maximum number of resources to return. If unspecified, at most 10 resources will be returned. The maximum value is 10. Higher values will be coerced to the maximum.
- Type
- class google.analytics.admin_v1alpha.types.ListMeasurementProtocolSecretsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ListMeasurementProtocolSecret RPC
- measurement_protocol_secrets¶
A list of secrets for the parent stream specified in the request.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.MeasurementProtocolSecret]
- class google.analytics.admin_v1alpha.types.ListPropertiesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ListProperties RPC.
- filter¶
Required. An expression for filtering the results of the request. Fields eligible for filtering are:
parent:(The resource name of the parent account/property) orancestor:(The resource name of the parent account) orfirebase_project:(The id or number of the linked firebase project). Some examples of filters:| Filter | Description | |-----------------------------|-------------------------------------------| | parent:accounts/123 | The account with account id: 123. | | parent:properties/123 | The property with property id: 123. | | ancestor:accounts/123 | The account with account id: 123. | | firebase_project:project-id | The firebase project with id: project-id. | | firebase_project:123 | The firebase project with number: 123. |
- Type
- page_size¶
The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
- Type
- page_token¶
A page token, received from a previous
ListPropertiescall. Provide this to retrieve the subsequent page. When paginating, all other parameters provided toListPropertiesmust match the call that provided the page token.- Type
- class google.analytics.admin_v1alpha.types.ListPropertiesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ListProperties RPC.
- properties¶
Results that matched the filter criteria and were accessible to the caller.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.Property]
- class google.analytics.admin_v1alpha.types.ListSKAdNetworkConversionValueSchemasRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ListSKAdNetworkConversionValueSchemas RPC
- parent¶
Required. Format: properties/{property_id}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema Example: properties/1234/dataStreams/5678/sKAdNetworkConversionValueSchema
- Type
- page_size¶
The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
- Type
- class google.analytics.admin_v1alpha.types.ListSKAdNetworkConversionValueSchemasResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ListSKAdNetworkConversionValueSchemas RPC
- skadnetwork_conversion_value_schemas¶
List of SKAdNetworkConversionValueSchemas. This will have at most one value.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.SKAdNetworkConversionValueSchema]
- class google.analytics.admin_v1alpha.types.ListSearchAds360LinksRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ListSearchAds360Links RPC.
- page_size¶
The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).
- Type
- class google.analytics.admin_v1alpha.types.ListSearchAds360LinksResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ListSearchAds360Links RPC.
- search_ads_360_links¶
List of SearchAds360Links.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.SearchAds360Link]
- class google.analytics.admin_v1alpha.types.ListUserLinksRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ListUserLinks RPC.
- page_size¶
The maximum number of user links to return. The service may return fewer than this value. If unspecified, at most 200 user links will be returned. The maximum value is 500; values above 500 will be coerced to 500.
- Type
- class google.analytics.admin_v1alpha.types.ListUserLinksResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ListUserLinks RPC.
- user_links¶
List of UserLinks. These will be ordered stably, but in an arbitrary order.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.UserLink]
- class google.analytics.admin_v1alpha.types.MatchingCondition(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDefines a condition for when an Event Edit or Event Creation rule applies to an event.
- field¶
Required. The name of the field that is compared against for the condition. If ‘event_name’ is specified this condition will apply to the name of the event. Otherwise the condition will apply to a parameter with the specified name.
This value cannot contain spaces.
- Type
- comparison_type¶
Required. The type of comparison to be applied to the value.
- value¶
Required. The value being compared against for this condition. The runtime implementation may perform type coercion of this value to evaluate this condition based on the type of the parameter value.
- Type
- negated¶
Whether or not the result of the comparison should be negated. For example, if
negatedis true, then ‘equals’ comparisons would function as ‘not equals’.- Type
- class ComparisonType(value)[source]¶
Bases:
proto.enums.EnumComparison type for matching condition
- Values:
- COMPARISON_TYPE_UNSPECIFIED (0):
Unknown
- EQUALS (1):
Equals, case sensitive
- EQUALS_CASE_INSENSITIVE (2):
Equals, case insensitive
- CONTAINS (3):
Contains, case sensitive
- CONTAINS_CASE_INSENSITIVE (4):
Contains, case insensitive
- STARTS_WITH (5):
Starts with, case sensitive
- STARTS_WITH_CASE_INSENSITIVE (6):
Starts with, case insensitive
- ENDS_WITH (7):
Ends with, case sensitive
- ENDS_WITH_CASE_INSENSITIVE (8):
Ends with, case insensitive
- GREATER_THAN (9):
Greater than
- GREATER_THAN_OR_EQUAL (10):
Greater than or equal
- LESS_THAN (11):
Less than
- LESS_THAN_OR_EQUAL (12):
Less than or equal
- REGULAR_EXPRESSION (13):
regular expression. Only supported for web streams.
- REGULAR_EXPRESSION_CASE_INSENSITIVE (14):
regular expression, case insensitive. Only supported for web streams.
- class google.analytics.admin_v1alpha.types.MeasurementProtocolSecret(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA secret value used for sending hits to Measurement Protocol.
- name¶
Output only. Resource name of this secret. This secret may be a child of any type of stream. Format:
properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
- Type
- class google.analytics.admin_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.admin_v1alpha.types.ParameterMutation(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDefines an event parameter to mutate.
- parameter¶
Required. The name of the parameter to mutate. This value must:
be less than 40 characters.
be unique across across all mutations within the rule
consist only of letters, digits or _ (underscores) For event edit rules, the name may also be set to ‘event_name’ to modify the event_name in place.
- Type
- parameter_value¶
Required. The value mutation to perform.
Must be less than 100 characters.
To specify a constant value for the param, use the value’s string.
To copy value from another parameter, use syntax like “[[other_parameter]]” For more details, see this help center article.
- Type
- class google.analytics.admin_v1alpha.types.PostbackWindow(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSettings for a SKAdNetwork conversion postback window.
- conversion_values¶
Ordering of the repeated field will be used to prioritize the conversion value settings. Lower indexed entries are prioritized higher. The first conversion value setting that evaluates to true will be selected. It must have at least one entry if enable_postback_window_settings is set to true. It can have maximum of 128 entries.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.ConversionValues]
- postback_window_settings_enabled¶
If enable_postback_window_settings is true, conversion_values must be populated and will be used for determining when and how to set the Conversion Value on a client device and exporting schema to linked Ads accounts. If false, the settings are not used, but are retained in case they may be used in the future. This must always be true for postback_window_one.
- Type
- class google.analytics.admin_v1alpha.types.Property(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA resource message representing a Google Analytics GA4 property.
- name¶
Output only. Resource name of this property. Format: properties/{property_id} Example: “properties/1000”.
- Type
- property_type¶
Immutable. The property type for this Property resource. When creating a property, if the type is “PROPERTY_TYPE_UNSPECIFIED”, then “ORDINARY_PROPERTY” will be implied. “SUBPROPERTY” and “ROLLUP_PROPERTY” types cannot yet be created with the Google Analytics Admin API.
- create_time¶
Output only. Time when the entity was originally created.
- update_time¶
Output only. Time when entity payload fields were last updated.
- parent¶
Immutable. Resource name of this property’s logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: “accounts/100”, “properties/101”.
- Type
- display_name¶
Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units.
- Type
- industry_category¶
Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
- time_zone¶
Required. Reporting Time Zone, used as the day boundary for reports, regardless of where the data originates. If the time zone honors DST, Analytics will automatically adjust for the changes.
NOTE: Changing the time zone only affects data going forward, and is not applied retroactively.
Format: https://www.iana.org/time-zones Example: “America/Los_Angeles”.
- Type
- currency_code¶
The currency type used in reports involving monetary values.
Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: “USD”, “EUR”, “JPY”.
- Type
- service_level¶
Output only. The Google Analytics service level that applies to this property.
- delete_time¶
Output only. If set, the time at which this property was trashed. If not set, then this property is not currently in the trash can.
- expire_time¶
Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted.
- class google.analytics.admin_v1alpha.types.PropertySummary(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA virtual resource representing metadata for a GA4 property.
- property¶
Resource name of property referred to by this property summary Format: properties/{property_id} Example: “properties/1000”.
- Type
- property_type¶
The property’s property type.
- class google.analytics.admin_v1alpha.types.PropertyType(value)[source]¶
Bases:
proto.enums.EnumTypes of Property resources.
- Values:
- PROPERTY_TYPE_UNSPECIFIED (0):
Unknown or unspecified property type
- PROPERTY_TYPE_ORDINARY (1):
Ordinary GA4 property
- PROPERTY_TYPE_SUBPROPERTY (2):
GA4 subproperty
- PROPERTY_TYPE_ROLLUP (3):
GA4 rollup property
- class google.analytics.admin_v1alpha.types.ProvisionAccountTicketRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ProvisionAccountTicket RPC.
- account¶
The account to create.
- class google.analytics.admin_v1alpha.types.ProvisionAccountTicketResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for ProvisionAccountTicket RPC.
- class google.analytics.admin_v1alpha.types.RunAccessReportRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe request for a Data Access Record Report.
- entity¶
The Data Access Report supports requesting at the property level or account level. If requested at the account level, Data Access Reports include all access for all properties under that account.
To request at the property level, entity should be for example ‘properties/123’ if “123” is your GA4 property ID. To request at the account level, entity should be for example ‘accounts/1234’ if “1234” is your GA4 Account ID.
- Type
- dimensions¶
The dimensions requested and displayed in the response. Requests are allowed up to 9 dimensions.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.AccessDimension]
- metrics¶
The metrics requested and displayed in the response. Requests are allowed up to 10 metrics.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.AccessMetric]
- date_ranges¶
Date ranges of access records 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 access records for the overlapping days is included in the response rows for both date ranges. Requests are allowed up to 2 date ranges.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.AccessDateRange]
- dimension_filter¶
Dimension filters let you restrict report response to specific dimension values which match the filter. For example, filtering on access records of a single user. To learn more, see Fundamentals of Dimension Filters for examples. Metrics cannot be used in this filter.
- metric_filter¶
Metric filters allow you to restrict report response to specific metric values which match the filter. Metric filters are applied after aggregating the report’s rows, similar to SQL having-clause. Dimensions cannot be used in this filter.
- offset¶
The row count of the start row. The first row is counted as row 0. If offset is unspecified, it is treated as 0. If offset is zero, then this method will return the first page of results with
limitentries.To learn more about this pagination parameter, see Pagination.
- 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 may return fewer rows than the requested
limit, if there aren’t as many remaining rows as thelimit. For instance, there are fewer than 300 possible values for the dimensioncountry, so when reporting on onlycountry, you can’t get more than 300 rows, even if you setlimitto a higher value.To learn more about this pagination parameter, see Pagination.
- Type
- time_zone¶
This request’s time zone if specified. If unspecified, the property’s time zone is used. The request’s time zone is used to interpret the start & end dates of the report.
Formatted as strings from the IANA Time Zone database (https://www.iana.org/time-zones); for example “America/New_York” or “Asia/Tokyo”.
- Type
- order_bys¶
Specifies how rows are ordered in the response.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.AccessOrderBy]
- return_entity_quota¶
Toggles whether to return the current state of this Analytics Property’s quota. Quota is returned in AccessQuota. For account-level requests, this field must be false.
- Type
- class google.analytics.admin_v1alpha.types.RunAccessReportResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe customized Data Access Record Report response.
- dimension_headers¶
The header for a column in the report that corresponds to a specific dimension. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.AccessDimensionHeader]
- metric_headers¶
The header for a column in the report that corresponds to a specific metric. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.AccessMetricHeader]
- rows¶
Rows of dimension value combinations and metric values in the report.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.AccessRow]
- row_count¶
The total number of rows in the query result.
rowCountis independent of the number of rows returned in the response, thelimitrequest parameter, and theoffsetrequest parameter. For example if a query returns 175 rows and includeslimitof 50 in the API request, the response will containrowCountof 175 but only 50 rows.To learn more about this pagination parameter, see Pagination.
- Type
- quota¶
The quota state for this Analytics property including this request. This field doesn’t work with account-level requests.
- class google.analytics.admin_v1alpha.types.SKAdNetworkConversionValueSchema(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSKAdNetwork conversion value schema of an iOS stream.
- name¶
Output only. Resource name of the schema. This will be child of ONLY an iOS stream, and there can be at most one such child under an iOS stream. Format:
properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema
- Type
- postback_window_one¶
Required. The conversion value settings for the first postback window. These differ from values for postback window two and three in that they contain a “Fine” grained conversion value (a numeric value).
Conversion values for this postback window must be set. The other windows are optional and may inherit this window’s settings if unset or disabled.
- postback_window_two¶
The conversion value settings for the second postback window.
This field should only be configured if there is a need to define different conversion values for this postback window.
If enable_postback_window_settings is set to false for this postback window, the values from postback_window_one will be used.
- postback_window_three¶
The conversion value settings for the third postback window.
This field should only be set if the user chose to define different conversion values for this postback window. It is allowed to configure window 3 without setting window 2. In case window 1 & 2 settings are set and enable_postback_window_settings for this postback window is set to false, the schema will inherit settings from postback_window_two.
- apply_conversion_values¶
If enabled, the GA SDK will set conversion values using this schema definition, and schema will be exported to any Google Ads accounts linked to this property. If disabled, the GA SDK will not automatically set conversion values, and also the schema will not be exported to Ads.
- Type
- class google.analytics.admin_v1alpha.types.SearchAds360Link(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA link between a GA4 property and a Search Ads 360 entity.
- name¶
Output only. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId}
Note: linkId is not the Search Ads 360 advertiser ID
- Type
- advertiser_id¶
Immutable. This field represents the Advertiser ID of the Search Ads 360 Advertiser. that has been linked.
- Type
- campaign_data_sharing_enabled¶
Immutable. Enables the import of campaign data from Search Ads 360 into the GA4 property. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true.
- cost_data_sharing_enabled¶
Immutable. Enables the import of cost data from Search Ads 360 to the GA4 property. This can only be enabled if campaign_data_sharing_enabled is enabled. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true.
- advertiser_display_name¶
Output only. The display name of the Search Ads 360 Advertiser. Allows users to easily identify the linked resource.
- Type
- ads_personalization_enabled¶
Enables personalized advertising features with this integration. If this field is not set on create, it will be defaulted to true.
- site_stats_sharing_enabled¶
Enables export of site stats with this integration. If this field is not set on create, it will be defaulted to true.
- class google.analytics.admin_v1alpha.types.SearchChangeHistoryEventsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for SearchChangeHistoryEvents RPC.
- property¶
Optional. Resource name for a child property. If set, only return changes made to this property or its child resources.
- Type
- resource_type¶
Optional. If set, only return changes if they are for a resource that matches at least one of these types.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.ChangeHistoryResourceType]
- action¶
Optional. If set, only return changes that match one or more of these types of actions.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.ActionType]
- actor_email¶
Optional. If set, only return changes if they are made by a user in this list.
- Type
MutableSequence[str]
- earliest_change_time¶
Optional. If set, only return changes made after this time (inclusive).
- latest_change_time¶
Optional. If set, only return changes made before this time (inclusive).
- page_size¶
Optional. The maximum number of ChangeHistoryEvent items to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 items will be returned. The maximum value is 200 (higher values will be coerced to the maximum).
- Type
- class google.analytics.admin_v1alpha.types.SearchChangeHistoryEventsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for SearchAccounts RPC.
- change_history_events¶
Results that were accessible to the caller.
- Type
MutableSequence[google.analytics.admin_v1alpha.types.ChangeHistoryEvent]
- class google.analytics.admin_v1alpha.types.ServiceLevel(value)[source]¶
Bases:
proto.enums.EnumVarious levels of service for Google Analytics.
- Values:
- SERVICE_LEVEL_UNSPECIFIED (0):
Service level not specified or invalid.
- GOOGLE_ANALYTICS_STANDARD (1):
The standard version of Google Analytics.
- GOOGLE_ANALYTICS_360 (2):
The paid, premium version of Google Analytics.
- class google.analytics.admin_v1alpha.types.SetAutomatedGa4ConfigurationOptOutRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest for setting the opt out status for the automated GA4 setup process.
- property¶
Required. The UA property to set the opt out status. Note this request uses the internal property ID, not the tracking ID of the form UA-XXXXXX-YY. Format: properties/{internalWebPropertyId} Example: properties/1234
- Type
- class google.analytics.admin_v1alpha.types.SetAutomatedGa4ConfigurationOptOutResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for setting the opt out status for the automated GA4 setup process.
- class google.analytics.admin_v1alpha.types.UpdateAccessBindingRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for UpdateAccessBinding RPC.
- access_binding¶
Required. The access binding to update.
- class google.analytics.admin_v1alpha.types.UpdateAccountRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for UpdateAccount RPC.
- account¶
Required. The account to update. The account’s
namefield is used to identify the account.
- update_mask¶
Required. The list of fields to be updated. Field names must be in snake case (for example, “field_to_update”). Omitted fields will not be updated. To replace the entire entity, use one path with the string “*” to match all fields.
- class google.analytics.admin_v1alpha.types.UpdateAttributionSettingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for UpdateAttributionSettings RPC
- attribution_settings¶
Required. The attribution settings to update. The
namefield is used to identify the settings to be updated.
- update_mask¶
Required. The list of fields to be updated. Field names must be in snake case (e.g., “field_to_update”). Omitted fields will not be updated. To replace the entire entity, use one path with the string “*” to match all fields.
- class google.analytics.admin_v1alpha.types.UpdateAudienceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for UpdateAudience RPC.
- audience¶
Required. The audience to update. The audience’s
namefield is used to identify the audience to be updated.
- update_mask¶
Required. The list of fields to be updated. Field names must be in snake case (e.g., “field_to_update”). Omitted fields will not be updated. To replace the entire entity, use one path with the string “*” to match all fields.
- class google.analytics.admin_v1alpha.types.UpdateChannelGroupRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for UpdateChannelGroup RPC.
- channel_group¶
Required. The ChannelGroup to update. The resource’s
namefield is used to identify the ChannelGroup to be updated.
- update_mask¶
Required. The list of fields to be updated. Field names must be in snake case (e.g., “field_to_update”). Omitted fields will not be updated. To replace the entire entity, use one path with the string “*” to match all fields.
- class google.analytics.admin_v1alpha.types.UpdateConversionEventRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for UpdateConversionEvent RPC
- conversion_event¶
Required. The conversion event to update. The
namefield is used to identify the settings to be updated.
- update_mask¶
Required. The list of fields to be updated. Field names must be in snake case (e.g., “field_to_update”). Omitted fields will not be updated. To replace the entire entity, use one path with the string “*” to match all fields.
- class google.analytics.admin_v1alpha.types.UpdateCustomDimensionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for UpdateCustomDimension RPC.
- custom_dimension¶
The CustomDimension to update
- update_mask¶
Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string “*” to match all fields.
- class google.analytics.admin_v1alpha.types.UpdateCustomMetricRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for UpdateCustomMetric RPC.
- custom_metric¶
The CustomMetric to update
- update_mask¶
Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string “*” to match all fields.
- class google.analytics.admin_v1alpha.types.UpdateDataRetentionSettingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for UpdateDataRetentionSettings RPC.
- data_retention_settings¶
Required. The settings to update. The
namefield is used to identify the settings to be updated.
- update_mask¶
Required. The list of fields to be updated. Field names must be in snake case (e.g., “field_to_update”). Omitted fields will not be updated. To replace the entire entity, use one path with the string “*” to match all fields.
- class google.analytics.admin_v1alpha.types.UpdateDataStreamRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for UpdateDataStream RPC.
- data_stream¶
The DataStream to update
- update_mask¶
Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string “*” to match all fields.
- class google.analytics.admin_v1alpha.types.UpdateDisplayVideo360AdvertiserLinkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for UpdateDisplayVideo360AdvertiserLink RPC.
- display_video_360_advertiser_link¶
The DisplayVideo360AdvertiserLink to update
- update_mask¶
Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string “*” to match all fields.
- class google.analytics.admin_v1alpha.types.UpdateEnhancedMeasurementSettingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for UpdateEnhancedMeasurementSettings RPC.
- enhanced_measurement_settings¶
Required. The settings to update. The
namefield is used to identify the settings to be updated.
- update_mask¶
Required. The list of fields to be updated. Field names must be in snake case (e.g., “field_to_update”). Omitted fields will not be updated. To replace the entire entity, use one path with the string “*” to match all fields.
- class google.analytics.admin_v1alpha.types.UpdateEventCreateRuleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for UpdateEventCreateRule RPC.
- event_create_rule¶
Required. The EventCreateRule to update. The resource’s
namefield is used to identify the EventCreateRule to be updated.
- update_mask¶
Required. The list of fields to be updated. Field names must be in snake case (e.g., “field_to_update”). Omitted fields will not be updated. To replace the entire entity, use one path with the string “*” to match all fields.
- class google.analytics.admin_v1alpha.types.UpdateExpandedDataSetRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for UpdateExpandedDataSet RPC.
- expanded_data_set¶
Required. The ExpandedDataSet to update. The resource’s
namefield is used to identify the ExpandedDataSet to be updated.
- update_mask¶
Required. The list of fields to be updated. Field names must be in snake case (e.g., “field_to_update”). Omitted fields will not be updated. To replace the entire entity, use one path with the string “*” to match all fields.
- class google.analytics.admin_v1alpha.types.UpdateGoogleAdsLinkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for UpdateGoogleAdsLink RPC
- google_ads_link¶
The GoogleAdsLink to update
- update_mask¶
Required. The list of fields to be updated. Field names must be in snake case (e.g., “field_to_update”). Omitted fields will not be updated. To replace the entire entity, use one path with the string “*” to match all fields.
- class google.analytics.admin_v1alpha.types.UpdateGoogleSignalsSettingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for UpdateGoogleSignalsSettings RPC
- google_signals_settings¶
Required. The settings to update. The
namefield is used to identify the settings to be updated.
- update_mask¶
Required. The list of fields to be updated. Field names must be in snake case (e.g., “field_to_update”). Omitted fields will not be updated. To replace the entire entity, use one path with the string “*” to match all fields.
- class google.analytics.admin_v1alpha.types.UpdateMeasurementProtocolSecretRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for UpdateMeasurementProtocolSecret RPC
- measurement_protocol_secret¶
Required. The measurement protocol secret to update.
- update_mask¶
Required. The list of fields to be updated. Omitted fields will not be updated.
- class google.analytics.admin_v1alpha.types.UpdatePropertyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for UpdateProperty RPC.
- property¶
Required. The property to update. The property’s
namefield is used to identify the property to be updated.
- update_mask¶
Required. The list of fields to be updated. Field names must be in snake case (e.g., “field_to_update”). Omitted fields will not be updated. To replace the entire entity, use one path with the string “*” to match all fields.
- class google.analytics.admin_v1alpha.types.UpdateSKAdNetworkConversionValueSchemaRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for UpdateSKAdNetworkConversionValueSchema RPC.
- skadnetwork_conversion_value_schema¶
Required. SKAdNetwork conversion value schema to update.
- update_mask¶
Required. The list of fields to be updated. Omitted fields will not be updated.
- class google.analytics.admin_v1alpha.types.UpdateSearchAds360LinkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for UpdateSearchAds360Link RPC.
- search_ads_360_link¶
The SearchAds360Link to update
- update_mask¶
Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string “*” to match all fields.
- class google.analytics.admin_v1alpha.types.UpdateUserLinkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for UpdateUserLink RPC.
- user_link¶
Required. The user link to update.
- class google.analytics.admin_v1alpha.types.UserLink(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA resource message representing a user’s permissions on an Account or Property resource.
- direct_roles¶
Roles directly assigned to this user for this account or property.
Valid values: predefinedRoles/viewer predefinedRoles/analyst predefinedRoles/editor predefinedRoles/admin predefinedRoles/no-cost-data predefinedRoles/no-revenue-data
Excludes roles that are inherited from a higher-level entity, group, or organization admin role.
A UserLink that is updated to have an empty list of direct_roles will be deleted.
- Type
MutableSequence[str]
