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

Types for Google Analytics Admin v1alpha API¶

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

Bases: proto.message.Message

A resource message representing a Google Analytics account.

name¶

Output only. Resource name of this account. Format: accounts/{account} Example: “accounts/100”.

Type: str

create_time¶

Output only. Time when this account was originally created.

Type: google.protobuf.timestamp_pb2.Timestamp

update_time¶

Output only. Time when account payload fields were last updated.

Type: google.protobuf.timestamp_pb2.Timestamp

display_name¶

Required. Human-readable display name for this account.

Type: str

region_code¶

Country of business. Must be a Unicode CLDR region code.

Type: str

deleted¶

Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.

Type: bool

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

Bases: proto.message.Message

A 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: str

account¶

Resource name of account referred to by this account summary Format: accounts/{account_id} Example: “accounts/1000”.

Type: str

display_name¶

Display name for the account referred to in this account summary.

Type: str

property_summaries¶

List of summaries for child accounts of this account.

Type: Sequence[google.analytics.admin_v1alpha.types.PropertySummary]

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

Bases: proto.message.Message

Request message for AcknowledgeUserDataCollection RPC.

property¶

Required. The property for which to acknowledge user data collection.

Type: str

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

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

Bases: proto.message.Message

Response message for AcknowledgeUserDataCollection RPC.

class google.analytics.admin_v1alpha.types.ActionType(value)[source]¶

Bases: proto.enums.Enum

Types of actions that may change a resource.

ACTION_TYPE_UNSPECIFIED = 0¶

CREATED = 1¶

DELETED = 3¶

UPDATED = 2¶

class google.analytics.admin_v1alpha.types.ActorType(value)[source]¶

Bases: proto.enums.Enum

Different kinds of actors that can make changes to Google Analytics resources.

ACTOR_TYPE_UNSPECIFIED = 0¶

SUPPORT = 3¶

SYSTEM = 2¶

USER = 1¶

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

Bases: proto.message.Message

Request message for ApproveDisplayVideo360AdvertiserLinkProposal RPC.

name¶

Required. The name of the DisplayVideo360AdvertiserLinkProposal to approve. Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678

Type: str

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

Bases: proto.message.Message

Response message for ApproveDisplayVideo360AdvertiserLinkProposal RPC.

display_video_360_advertiser_link¶

The DisplayVideo360AdvertiserLink created as a result of approving the proposal.

Type: google.analytics.admin_v1alpha.types.DisplayVideo360AdvertiserLink

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

Bases: proto.message.Message

Request message for ArchiveCustomDimension RPC.

name¶

Required. The name of the CustomDimension to archive. Example format: properties/1234/customDimensions/5678

Type: str

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

Bases: proto.message.Message

Request message for ArchiveCustomMetric RPC.

name¶

Required. The name of the CustomMetric to archive. Example format: properties/1234/customMetrics/5678

Type: str

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

Bases: proto.message.Message

Read-only resource used to summarize a principal’s effective roles.

name¶

Example format: properties/1234/userLinks/5678

Type: str

email_address¶

Email address of the linked user

Type: str

direct_roles¶

Roles directly assigned to this user for this entity. Format: predefinedRoles/viewer

Excludes roles that are inherited from an account (if this is for a property), group, or organization admin role.

Type: Sequence[str]

effective_roles¶

Union of all permissions a user has at this account or property (includes direct permissions, group-inherited permissions, etc.). Format: predefinedRoles/viewer

Type: Sequence[str]

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

Bases: proto.message.Message

Request message for AuditUserLinks RPC.

parent¶

Required. Example format: accounts/1234

Type: str

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

page_token¶

A page token, received from a previous AuditUserLinks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to AuditUserLinks must match the call that provided the page token.

Type: str

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

Bases: proto.message.Message

Response message for AuditUserLinks RPC.

user_links¶

List of AuditUserLinks. These will be ordered stably, but in an arbitrary order.

Type: Sequence[google.analytics.admin_v1alpha.types.AuditUserLink]

next_page_token¶

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

Type: str

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

Bases: proto.message.Message

Request 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: str

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

requests¶

Required. The requests specifying the user links to create. A maximum of 1000 user links can be created in a batch.

Type: Sequence[google.analytics.admin_v1alpha.types.CreateUserLinkRequest]

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

Bases: proto.message.Message

Response message for BatchCreateUserLinks RPC.

user_links¶

The user links created.

Type: Sequence[google.analytics.admin_v1alpha.types.UserLink]

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

Bases: proto.message.Message

Request 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: str

requests¶

Required. The requests specifying the user links to update. A maximum of 1000 user links can be updated in a batch.

Type: Sequence[google.analytics.admin_v1alpha.types.DeleteUserLinkRequest]

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

Bases: proto.message.Message

Request 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: str

names¶

Required. The names of the user links to retrieve. A maximum of 1000 user links can be retrieved in a batch. Format: accounts/{accountId}/userLinks/{userLinkId}

Type: Sequence[str]

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

Bases: proto.message.Message

Response message for BatchGetUserLinks RPC.

user_links¶

The requested user links.

Type: Sequence[google.analytics.admin_v1alpha.types.UserLink]

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

Bases: proto.message.Message

Request 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: str

requests¶

Required. The requests specifying the user links to update. A maximum of 1000 user links can be updated in a batch.

Type: Sequence[google.analytics.admin_v1alpha.types.UpdateUserLinkRequest]

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

Bases: proto.message.Message

Response message for BatchUpdateUserLinks RPC.

user_links¶

The user links updated.

Type: Sequence[google.analytics.admin_v1alpha.types.UserLink]

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

Bases: proto.message.Message

Request message for CancelDisplayVideo360AdvertiserLinkProposal RPC.

name¶

Required. The name of the DisplayVideo360AdvertiserLinkProposal to cancel. Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678

Type: str

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

Bases: proto.message.Message

A description of a change to a single Google Analytics resource.

resource¶

Resource name of the resource whose changes are described by this entry.

Type: str

action¶

The type of action that changed this resource.

Type: google.analytics.admin_v1alpha.types.ActionType

resource_before_change¶

Resource contents from before the change was made. If this resource was created in this change, this field will be missing.

Type: google.analytics.admin_v1alpha.types.ChangeHistoryChange.ChangeHistoryResource

resource_after_change¶

Resource contents from after the change was made. If this resource was deleted in this change, this field will be missing.

Type: google.analytics.admin_v1alpha.types.ChangeHistoryChange.ChangeHistoryResource

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

Bases: proto.message.Message

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

Type: google.analytics.admin_v1alpha.types.Account

property¶

A snapshot of a Property resource in change history.

This field is a member of oneof resource.

Type: google.analytics.admin_v1alpha.types.Property

firebase_link¶

A snapshot of a FirebaseLink resource in change history.

This field is a member of oneof resource.

Type: google.analytics.admin_v1alpha.types.FirebaseLink

google_ads_link¶

A snapshot of a GoogleAdsLink resource in change history.

This field is a member of oneof resource.

Type: google.analytics.admin_v1alpha.types.GoogleAdsLink

google_signals_settings¶

A snapshot of a GoogleSignalsSettings resource in change history.

This field is a member of oneof resource.

Type: google.analytics.admin_v1alpha.types.GoogleSignalsSettings

display_video_360_advertiser_link¶

A snapshot of a DisplayVideo360AdvertiserLink resource in change history.

This field is a member of oneof resource.

Type: google.analytics.admin_v1alpha.types.DisplayVideo360AdvertiserLink

display_video_360_advertiser_link_proposal¶

A snapshot of a DisplayVideo360AdvertiserLinkProposal resource in change history.

This field is a member of oneof resource.

Type: google.analytics.admin_v1alpha.types.DisplayVideo360AdvertiserLinkProposal

conversion_event¶

A snapshot of a ConversionEvent resource in change history.

This field is a member of oneof resource.

Type: google.analytics.admin_v1alpha.types.ConversionEvent

measurement_protocol_secret¶

A snapshot of a MeasurementProtocolSecret resource in change history.

This field is a member of oneof resource.

Type: google.analytics.admin_v1alpha.types.MeasurementProtocolSecret

custom_dimension¶

A snapshot of a CustomDimension resource in change history.

This field is a member of oneof resource.

Type: google.analytics.admin_v1alpha.types.CustomDimension

custom_metric¶

A snapshot of a CustomMetric resource in change history.

This field is a member of oneof resource.

Type: google.analytics.admin_v1alpha.types.CustomMetric

data_retention_settings¶

A snapshot of a data retention settings resource in change history.

This field is a member of oneof resource.

Type: google.analytics.admin_v1alpha.types.DataRetentionSettings

data_stream¶

A snapshot of a DataStream resource in change history.

This field is a member of oneof resource.

Type: google.analytics.admin_v1alpha.types.DataStream

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

Bases: proto.message.Message

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

id¶

ID of this change history event. This ID is unique across Google Analytics.

Type: str

change_time¶

Time when change was made.

Type: google.protobuf.timestamp_pb2.Timestamp

actor_type¶

The type of actor that made this change.

Type: google.analytics.admin_v1alpha.types.ActorType

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

changes_filtered¶

If true, then the list of changes returned was filtered, and does not represent all changes that occurred in this event.

Type: bool

changes¶

A list of changes made in this change history event that fit the filters specified in SearchChangeHistoryEventsRequest.

Type: Sequence[google.analytics.admin_v1alpha.types.ChangeHistoryChange]

class google.analytics.admin_v1alpha.types.ChangeHistoryResourceType(value)[source]¶

Bases: proto.enums.Enum

Types of resources whose changes may be returned from change history.

ACCOUNT = 1¶

CHANGE_HISTORY_RESOURCE_TYPE_UNSPECIFIED = 0¶

CONVERSION_EVENT = 9¶

CUSTOM_DIMENSION = 11¶

CUSTOM_METRIC = 12¶

DATA_RETENTION_SETTINGS = 13¶

DATA_STREAM = 18¶

DISPLAY_VIDEO_360_ADVERTISER_LINK = 14¶

DISPLAY_VIDEO_360_ADVERTISER_LINK_PROPOSAL = 15¶

FIREBASE_LINK = 6¶

GOOGLE_ADS_LINK = 7¶

GOOGLE_SIGNALS_SETTINGS = 8¶

MEASUREMENT_PROTOCOL_SECRET = 10¶

PROPERTY = 2¶

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

Bases: proto.message.Message

A conversion event in a Google Analytics property.

name¶

Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}

Type: str

event_name¶

Immutable. The event name for this conversion event. Examples: ‘click’, ‘purchase’

Type: str

create_time¶

Output only. Time when this conversion event was created in the property.

Type: google.protobuf.timestamp_pb2.Timestamp

deletable¶

Output only. If set, this event can currently be deleted via DeleteConversionEvent.

Type: bool

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

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

Bases: proto.message.Message

Request message for CreateConversionEvent RPC

conversion_event¶

Required. The conversion event to create.

Type: google.analytics.admin_v1alpha.types.ConversionEvent

parent¶

Required. The resource name of the parent property where this conversion event will be created. Format: properties/123

Type: str

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

Bases: proto.message.Message

Request message for CreateCustomDimension RPC.

parent¶

Required. Example format: properties/1234

Type: str

custom_dimension¶

Required. The CustomDimension to create.

Type: google.analytics.admin_v1alpha.types.CustomDimension

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

Bases: proto.message.Message

Request message for CreateCustomMetric RPC.

parent¶

Required. Example format: properties/1234

Type: str

custom_metric¶

Required. The CustomMetric to create.

Type: google.analytics.admin_v1alpha.types.CustomMetric

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

Bases: proto.message.Message

Request message for CreateDataStream RPC.

parent¶

Required. Example format: properties/1234

Type: str

data_stream¶

Required. The DataStream to create.

Type: google.analytics.admin_v1alpha.types.DataStream

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

Bases: proto.message.Message

Request message for CreateDisplayVideo360AdvertiserLinkProposal RPC.

parent¶

Required. Example format: properties/1234

Type: str

display_video_360_advertiser_link_proposal¶

Required. The DisplayVideo360AdvertiserLinkProposal to create.

Type: google.analytics.admin_v1alpha.types.DisplayVideo360AdvertiserLinkProposal

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

Bases: proto.message.Message

Request message for CreateDisplayVideo360AdvertiserLink RPC.

parent¶

Required. Example format: properties/1234

Type: str

display_video_360_advertiser_link¶

Required. The DisplayVideo360AdvertiserLink to create.

Type: google.analytics.admin_v1alpha.types.DisplayVideo360AdvertiserLink

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

Bases: proto.message.Message

Request message for CreateFirebaseLink RPC

parent¶

Required. Format: properties/{property_id} Example: properties/1234

Type: str

firebase_link¶

Required. The Firebase link to create.

Type: google.analytics.admin_v1alpha.types.FirebaseLink

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

Bases: proto.message.Message

Request message for CreateGoogleAdsLink RPC

parent¶

Required. Example format: properties/1234

Type: str

google_ads_link¶

Required. The GoogleAdsLink to create.

Type: google.analytics.admin_v1alpha.types.GoogleAdsLink

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

Bases: proto.message.Message

Request message for CreateMeasurementProtocolSecret RPC

parent¶

Required. The parent resource where this secret will be created. Format: properties/{property}/dataStreams/{dataStream}

Type: str

measurement_protocol_secret¶

Required. The measurement protocol secret to create.

Type: google.analytics.admin_v1alpha.types.MeasurementProtocolSecret

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

Bases: proto.message.Message

Request message for CreateProperty RPC.

property¶

Required. The property to create. Note: the supplied property must specify its parent.

Type: google.analytics.admin_v1alpha.types.Property

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

Bases: proto.message.Message

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

parent¶

Required. Example format: accounts/1234

Type: str

notify_new_user¶

Optional. If set, then email the new user notifying them that they’ve been granted permissions to the resource.

Type: bool

user_link¶

Required. The user link to create.

Type: google.analytics.admin_v1alpha.types.UserLink

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

Bases: proto.message.Message

A definition for a CustomDimension.

name¶

Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}

Type: str

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.

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

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

description¶

Optional. Description for this custom dimension. Max length of 150 characters.

Type: str

scope¶

Required. Immutable. The scope of this dimension.

Type: google.analytics.admin_v1alpha.types.CustomDimension.DimensionScope

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

class DimensionScope(value)[source]¶

Bases: proto.enums.Enum

Valid values for the scope of this dimension.

DIMENSION_SCOPE_UNSPECIFIED = 0¶

EVENT = 1¶

USER = 2¶

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

Bases: proto.message.Message

A definition for a custom metric.

name¶

Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}

Type: str

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

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

description¶

Optional. Description for this custom dimension. Max length of 150 characters.

Type: str

measurement_unit¶

Required. The type for the custom metric’s value.

Type: google.analytics.admin_v1alpha.types.CustomMetric.MeasurementUnit

scope¶

Required. Immutable. The scope of this custom metric.

Type: google.analytics.admin_v1alpha.types.CustomMetric.MetricScope

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: Sequence[google.analytics.admin_v1alpha.types.CustomMetric.RestrictedMetricType]

class MeasurementUnit(value)[source]¶

Bases: proto.enums.Enum

Possible types of representing the custom metric’s value. Currency representation may change in the future, requiring a breaking API change.

CURRENCY = 2¶

FEET = 3¶

HOURS = 10¶

KILOMETERS = 5¶

MEASUREMENT_UNIT_UNSPECIFIED = 0¶

METERS = 4¶

MILES = 6¶

MILLISECONDS = 7¶

MINUTES = 9¶

SECONDS = 8¶

STANDARD = 1¶

class MetricScope(value)[source]¶

Bases: proto.enums.Enum

The scope of this metric.

EVENT = 1¶

METRIC_SCOPE_UNSPECIFIED = 0¶

class RestrictedMetricType(value)[source]¶

Bases: proto.enums.Enum

Labels that mark the data in this custom metric as data that should be restricted to specific users.

COST_DATA = 1¶

RESTRICTED_METRIC_TYPE_UNSPECIFIED = 0¶

REVENUE_DATA = 2¶

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

Bases: proto.message.Message

Settings values for data retention. This is a singleton resource.

name¶

Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings

Type: str

event_data_retention¶

The length of time that event-level data is retained.

Type: google.analytics.admin_v1alpha.types.DataRetentionSettings.RetentionDuration

reset_user_data_on_new_activity¶

If true, reset the retention period for the user identifier with every event from that user.

Type: bool

class RetentionDuration(value)[source]¶

Bases: proto.enums.Enum

Valid values for the data retention duration.

FIFTY_MONTHS = 6¶

FOURTEEN_MONTHS = 3¶

RETENTION_DURATION_UNSPECIFIED = 0¶

THIRTY_EIGHT_MONTHS = 5¶

TWENTY_SIX_MONTHS = 4¶

TWO_MONTHS = 1¶

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

Bases: proto.message.Message

A 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: str

sharing_with_google_support_enabled¶

Allows Google support to access the data in order to help troubleshoot issues.

Type: bool

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

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

sharing_with_google_products_enabled¶

Allows Google to use the data to improve other Google products or services.

Type: bool

sharing_with_others_enabled¶

Allows Google to share the data anonymously in aggregate form with others.

Type: bool

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

Bases: proto.message.Message

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

Type: google.analytics.admin_v1alpha.types.DataStream.WebStreamData

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.

Type: google.analytics.admin_v1alpha.types.DataStream.AndroidAppStreamData

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.

Type: google.analytics.admin_v1alpha.types.DataStream.IosAppStreamData

name¶

Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: “properties/1000/dataStreams/2000”.

Type: str

type_¶

Required. Immutable. The type of this DataStream resource.

Type: google.analytics.admin_v1alpha.types.DataStream.DataStreamType

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

create_time¶

Output only. Time when this stream was originally created.

Type: google.protobuf.timestamp_pb2.Timestamp

update_time¶

Output only. Time when stream payload fields were last updated.

Type: google.protobuf.timestamp_pb2.Timestamp

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

Bases: proto.message.Message

Data 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: str

package_name¶

Immutable. The package name for the app being measured. Example: “com.example.myandroidapp”.

Type: str

class DataStreamType(value)[source]¶

Bases: proto.enums.Enum

The type of the data stream.

ANDROID_APP_DATA_STREAM = 2¶

DATA_STREAM_TYPE_UNSPECIFIED = 0¶

IOS_APP_DATA_STREAM = 3¶

WEB_DATA_STREAM = 1¶

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

Bases: proto.message.Message

Data 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: str

bundle_id¶

Required. Immutable. The Apple App Store Bundle ID for the app Example: “com.example.myiosapp”.

Type: str

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

Bases: proto.message.Message

Data specific to web streams.

measurement_id¶

Output only. Analytics “Measurement ID”, without the “G-” prefix. Example: “G-1A2BCD345E” would just be “1A2BCD345E”.

Type: str

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

default_uri¶

Immutable. Domain name of the web app being measured, or empty. Example: “http://www.google.com”, “https://www.google.com”.

Type: str

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

Bases: proto.message.Message

Request message for DeleteAccount RPC.

name¶

Required. The name of the Account to soft-delete. Format: accounts/{account} Example: “accounts/100”.

Type: str

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

Bases: proto.message.Message

Request message for DeleteConversionEvent RPC

name¶

Required. The resource name of the conversion event to delete. Format: properties/{property}/conversionEvents/{conversion_event} Example: “properties/123/conversionEvents/456”.

Type: str

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

Bases: proto.message.Message

Request message for DeleteDataStream RPC.

name¶

Required. The name of the DataStream to delete. Example format: properties/1234/dataStreams/5678

Type: str

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

Bases: proto.message.Message

Request message for DeleteDisplayVideo360AdvertiserLinkProposal RPC.

name¶

Required. The name of the DisplayVideo360AdvertiserLinkProposal to delete. Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678

Type: str

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

Bases: proto.message.Message

Request message for DeleteDisplayVideo360AdvertiserLink RPC.

name¶

Required. The name of the DisplayVideo360AdvertiserLink to delete. Example format: properties/1234/displayVideo360AdvertiserLinks/5678

Type: str

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

Bases: proto.message.Message

Request message for DeleteFirebaseLink RPC

name¶

Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: properties/1234/firebaseLinks/5678

Type: str

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

Bases: proto.message.Message

Request message for DeleteGoogleAdsLink RPC.

name¶

Required. Example format: properties/1234/googleAdsLinks/5678

Type: str

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

Bases: proto.message.Message

Request message for DeleteMeasurementProtocolSecret RPC

name¶

Required. The name of the MeasurementProtocolSecret to delete. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

Type: str

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

Bases: proto.message.Message

Request message for DeleteProperty RPC.

name¶

Required. The name of the Property to soft-delete. Format: properties/{property_id} Example: “properties/1000”.

Type: str

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

Bases: proto.message.Message

Request message for DeleteUserLink RPC.

name¶

Required. Example format: accounts/1234/userLinks/5678

Type: str

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

Bases: proto.message.Message

A 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: str

advertiser_id¶

Immutable. The Display & Video 360 Advertiser’s advertiser ID.

Type: str

advertiser_display_name¶

Output only. The display name of the Display & Video 360 Advertiser.

Type: str

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.

Type: google.protobuf.wrappers_pb2.BoolValue

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.

Type: google.protobuf.wrappers_pb2.BoolValue

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.

Type: google.protobuf.wrappers_pb2.BoolValue

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

Bases: proto.message.Message

A 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: str

advertiser_id¶

Immutable. The Display & Video 360 Advertiser’s advertiser ID.

Type: str

link_proposal_status_details¶

Output only. The status information for this link proposal.

Type: google.analytics.admin_v1alpha.types.LinkProposalStatusDetails

advertiser_display_name¶

Output only. The display name of the Display & Video Advertiser. Only populated for proposals that originated from Display & Video 360.

Type: str

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

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.

Type: google.protobuf.wrappers_pb2.BoolValue

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.

Type: google.protobuf.wrappers_pb2.BoolValue

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.

Type: google.protobuf.wrappers_pb2.BoolValue

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

Bases: proto.message.Message

A link between a GA4 property and a Firebase project.

name¶

Output only. Example format: properties/1234/firebaseLinks/5678

Type: str

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

create_time¶

Output only. Time when this FirebaseLink was originally created.

Type: google.protobuf.timestamp_pb2.Timestamp

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

Bases: proto.message.Message

Request message for GetAccount RPC.

name¶

Required. The name of the account to lookup. Format: accounts/{account} Example: “accounts/100”.

Type: str

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

Bases: proto.message.Message

Request message for GetConversionEvent RPC

name¶

Required. The resource name of the conversion event to retrieve. Format: properties/{property}/conversionEvents/{conversion_event} Example: “properties/123/conversionEvents/456”.

Type: str

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

Bases: proto.message.Message

Request message for GetCustomDimension RPC.

name¶

Required. The name of the CustomDimension to get. Example format: properties/1234/customDimensions/5678

Type: str

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

Bases: proto.message.Message

Request message for GetCustomMetric RPC.

name¶

Required. The name of the CustomMetric to get. Example format: properties/1234/customMetrics/5678

Type: str

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

Bases: proto.message.Message

Request message for GetDataRetentionSettings RPC.

name¶

Required. The name of the settings to lookup. Format: properties/{property}/dataRetentionSettings Example: “properties/1000/dataRetentionSettings”.

Type: str

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

Bases: proto.message.Message

Request message for GetDataSharingSettings RPC.

name¶

Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: “accounts/1000/dataSharingSettings”.

Type: str

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

Bases: proto.message.Message

Request message for GetDataStream RPC.

name¶

Required. The name of the DataStream to get. Example format: properties/1234/dataStreams/5678

Type: str

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

Bases: proto.message.Message

Request message for GetDisplayVideo360AdvertiserLinkProposal RPC.

name¶

Required. The name of the DisplayVideo360AdvertiserLinkProposal to get. Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678

Type: str

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

Bases: proto.message.Message

Request message for GetDisplayVideo360AdvertiserLink RPC.

name¶

Required. The name of the DisplayVideo360AdvertiserLink to get. Example format: properties/1234/displayVideo360AdvertiserLink/5678

Type: str

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

Bases: proto.message.Message

Request message for GetGlobalSiteTag RPC.

name¶

Required. The name of the site tag to lookup. Note that site tags are singletons and do not have unique IDs. Format: properties/{property_id}/dataStreams/{stream_id}/globalSiteTag Example: “properties/123/dataStreams/456/globalSiteTag”.

Type: str

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

Bases: proto.message.Message

Request message for GetGoogleSignalsSettings RPC

name¶

Required. The name of the google signals settings to retrieve. Format: properties/{property}/googleSignalsSettings

Type: str

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

Bases: proto.message.Message

Request message for GetMeasurementProtocolSecret RPC.

name¶

Required. The name of the measurement protocol secret to lookup. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

Type: str

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

Bases: proto.message.Message

Request message for GetProperty RPC.

name¶

Required. The name of the property to lookup. Format: properties/{property_id} Example: “properties/1000”.

Type: str

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

Bases: proto.message.Message

Request message for GetUserLink RPC.

name¶

Required. Example format: accounts/1234/userLinks/5678

Type: str

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

Bases: proto.message.Message

Read-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: str

snippet¶

Immutable. JavaScript code snippet to be pasted as the first item into the head tag of every webpage to measure.

Type: str

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

Bases: proto.message.Message

A 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: str

customer_id¶

Immutable. Google Ads customer ID.

Type: str

can_manage_clients¶

Output only. If true, this link is for a Google Ads manager account.

Type: bool

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.

Type: google.protobuf.wrappers_pb2.BoolValue

create_time¶

Output only. Time when this link was originally created.

Type: google.protobuf.timestamp_pb2.Timestamp

update_time¶

Output only. Time when this link was last updated.

Type: google.protobuf.timestamp_pb2.Timestamp

creator_email_address¶

Output only. Email address of the user that created the link. An empty string will be returned if the email address can’t be retrieved.

Type: str

class google.analytics.admin_v1alpha.types.GoogleSignalsConsent(value)[source]¶

Bases: proto.enums.Enum

Consent field of the Google Signals settings (i.e., whether the user has consented to the Google Signals terms of service.)

GOOGLE_SIGNALS_CONSENT_CONSENTED = 2¶

GOOGLE_SIGNALS_CONSENT_NOT_CONSENTED = 1¶

GOOGLE_SIGNALS_CONSENT_UNSPECIFIED = 0¶

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

Bases: proto.message.Message

Settings 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: str

state¶

Status of this setting.

Type: google.analytics.admin_v1alpha.types.GoogleSignalsState

consent¶

Output only. Terms of Service acceptance.

Type: google.analytics.admin_v1alpha.types.GoogleSignalsConsent

class google.analytics.admin_v1alpha.types.GoogleSignalsState(value)[source]¶

Bases: proto.enums.Enum

Status of the Google Signals settings (i.e., whether this feature has been enabled for the property).

GOOGLE_SIGNALS_DISABLED = 2¶

GOOGLE_SIGNALS_ENABLED = 1¶

GOOGLE_SIGNALS_STATE_UNSPECIFIED = 0¶

class google.analytics.admin_v1alpha.types.IndustryCategory(value)[source]¶

Bases: proto.enums.Enum

The category selected for this property, used for industry benchmarking.

ARTS_AND_ENTERTAINMENT = 8¶

AUTOMOTIVE = 1¶

BEAUTY_AND_FITNESS = 9¶

BOOKS_AND_LITERATURE = 10¶

BUSINESS_AND_INDUSTRIAL_MARKETS = 2¶

FINANCE = 3¶

FOOD_AND_DRINK = 11¶

GAMES = 12¶

HEALTHCARE = 4¶

HOBBIES_AND_LEISURE = 13¶

HOME_AND_GARDEN = 14¶

INDUSTRY_CATEGORY_UNSPECIFIED = 0¶

INTERNET_AND_TELECOM = 15¶

JOBS_AND_EDUCATION = 25¶

LAW_AND_GOVERNMENT = 16¶

NEWS = 17¶

ONLINE_COMMUNITIES = 18¶

OTHER = 7¶

PEOPLE_AND_SOCIETY = 19¶

PETS_AND_ANIMALS = 20¶

REAL_ESTATE = 21¶

REFERENCE = 22¶

SCIENCE = 23¶

SHOPPING = 26¶

SPORTS = 24¶

TECHNOLOGY = 5¶

TRAVEL = 6¶

class google.analytics.admin_v1alpha.types.LinkProposalInitiatingProduct(value)[source]¶

Bases: proto.enums.Enum

An indication of which product the user initiated a link proposal from.

GOOGLE_ANALYTICS = 1¶

LINKED_PRODUCT = 2¶

LINK_PROPOSAL_INITIATING_PRODUCT_UNSPECIFIED = 0¶

class google.analytics.admin_v1alpha.types.LinkProposalState(value)[source]¶

Bases: proto.enums.Enum

The state of a link proposal resource.

AWAITING_REVIEW_FROM_GOOGLE_ANALYTICS = 1¶

AWAITING_REVIEW_FROM_LINKED_PRODUCT = 2¶

DECLINED = 4¶

EXPIRED = 5¶

LINK_PROPOSAL_STATE_UNSPECIFIED = 0¶

OBSOLETE = 6¶

WITHDRAWN = 3¶

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

Bases: proto.message.Message

Status information for a link proposal.

link_proposal_initiating_product¶

Output only. The source of this proposal.

Type: google.analytics.admin_v1alpha.types.LinkProposalInitiatingProduct

requestor_email¶

Output only. The email address of the user that proposed this linkage.

Type: str

link_proposal_state¶

Output only. The state of this proposal.

Type: google.analytics.admin_v1alpha.types.LinkProposalState

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

Bases: proto.message.Message

Request 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: int

page_token¶

A page token, received from a previous ListAccountSummaries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAccountSummaries must match the call that provided the page token.

Type: str

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

Bases: proto.message.Message

Response message for ListAccountSummaries RPC.

account_summaries¶

Account summaries of all accounts the caller has access to.

Type: Sequence[google.analytics.admin_v1alpha.types.AccountSummary]

next_page_token¶

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

Type: str

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

Bases: proto.message.Message

Request 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: int

page_token¶

A page token, received from a previous ListAccounts call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAccounts must match the call that provided the page token.

Type: str

show_deleted¶

Whether to include soft-deleted (ie: “trashed”) Accounts in the results. Accounts can be inspected to determine whether they are deleted or not.

Type: bool

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

Bases: proto.message.Message

Request message for ListAccounts RPC.

accounts¶

Results that were accessible to the caller.

Type: Sequence[google.analytics.admin_v1alpha.types.Account]

next_page_token¶

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

Type: str

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

Bases: proto.message.Message

Request message for ListConversionEvents RPC

parent¶

Required. The resource name of the parent property. Example: ‘properties/123’

Type: str

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

page_token¶

A page token, received from a previous ListConversionEvents call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListConversionEvents must match the call that provided the page token.

Type: str

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

Bases: proto.message.Message

Response message for ListConversionEvents RPC.

conversion_events¶

The requested conversion events

Type: Sequence[google.analytics.admin_v1alpha.types.ConversionEvent]

next_page_token¶

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

Type: str

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

Bases: proto.message.Message

Request message for ListCustomDimensions RPC.

parent¶

Required. Example format: properties/1234

Type: str

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

page_token¶

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

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

Type: str

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

Bases: proto.message.Message

Response message for ListCustomDimensions RPC.

custom_dimensions¶

List of CustomDimensions.

Type: Sequence[google.analytics.admin_v1alpha.types.CustomDimension]

next_page_token¶

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

Type: str

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

Bases: proto.message.Message

Request message for ListCustomMetrics RPC.

parent¶

Required. Example format: properties/1234

Type: str

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

page_token¶

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

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

Type: str

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

Bases: proto.message.Message

Response message for ListCustomMetrics RPC.

custom_metrics¶

List of CustomMetrics.

Type: Sequence[google.analytics.admin_v1alpha.types.CustomMetric]

next_page_token¶

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

Type: str

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

Bases: proto.message.Message

Request message for ListDataStreams RPC.

parent¶

Required. Example format: properties/1234

Type: str

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

page_token¶

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

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

Type: str

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

Bases: proto.message.Message

Response message for ListDataStreams RPC.

data_streams¶

List of DataStreams.

Type: Sequence[google.analytics.admin_v1alpha.types.DataStream]

next_page_token¶

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

Type: str

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

Bases: proto.message.Message

Request message for ListDisplayVideo360AdvertiserLinkProposals RPC.

parent¶

Required. Example format: properties/1234

Type: str

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

page_token¶

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

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

Type: str

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

Bases: proto.message.Message

Response message for ListDisplayVideo360AdvertiserLinkProposals RPC.

display_video_360_advertiser_link_proposals¶

List of DisplayVideo360AdvertiserLinkProposals.

Type: Sequence[google.analytics.admin_v1alpha.types.DisplayVideo360AdvertiserLinkProposal]

next_page_token¶

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

Type: str

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

Bases: proto.message.Message

Request message for ListDisplayVideo360AdvertiserLinks RPC.

parent¶

Required. Example format: properties/1234

Type: str

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

page_token¶

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

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

Type: str

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

Bases: proto.message.Message

Response message for ListDisplayVideo360AdvertiserLinks RPC.

display_video_360_advertiser_links¶

List of DisplayVideo360AdvertiserLinks.

Type: Sequence[google.analytics.admin_v1alpha.types.DisplayVideo360AdvertiserLink]

next_page_token¶

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

Type: str

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

Bases: proto.message.Message

Request message for ListFirebaseLinks RPC

parent¶

Required. Format: properties/{property_id} Example: properties/1234

Type: str

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

page_token¶

A page token, received from a previous ListFirebaseLinks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListProperties must match the call that provided the page token.

Type: str

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

Bases: proto.message.Message

Response message for ListFirebaseLinks RPC

firebase_links¶

List of FirebaseLinks. This will have at most one value.

Type: Sequence[google.analytics.admin_v1alpha.types.FirebaseLink]

next_page_token¶

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. Currently, Google Analytics supports only one FirebaseLink per property, so this will never be populated.

Type: str

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

Bases: proto.message.Message

Request message for ListGoogleAdsLinks RPC.

parent¶

Required. Example format: properties/1234

Type: str

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

page_token¶

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

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

Type: str

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

Bases: proto.message.Message

Response message for ListGoogleAdsLinks RPC.

google_ads_links¶

List of GoogleAdsLinks.

Type: Sequence[google.analytics.admin_v1alpha.types.GoogleAdsLink]

next_page_token¶

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

Type: str

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

Bases: proto.message.Message

Request message for ListMeasurementProtocolSecret RPC

parent¶

Required. The resource name of the parent stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets

Type: str

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

page_token¶

A page token, received from a previous ListMeasurementProtocolSecrets call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListMeasurementProtocolSecrets must match the call that provided the page token.

Type: str

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

Bases: proto.message.Message

Response message for ListMeasurementProtocolSecret RPC

measurement_protocol_secrets¶

A list of secrets for the parent stream specified in the request.

Type: Sequence[google.analytics.admin_v1alpha.types.MeasurementProtocolSecret]

next_page_token¶

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

Type: str

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

Bases: proto.message.Message

Request 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) or ancestor:(The resource name of the parent account) or firebase_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: str

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

page_token¶

A page token, received from a previous ListProperties call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListProperties must match the call that provided the page token.

Type: str

show_deleted¶

Whether to include soft-deleted (ie: “trashed”) Properties in the results. Properties can be inspected to determine whether they are deleted or not.

Type: bool

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

Bases: proto.message.Message

Response message for ListProperties RPC.

properties¶

Results that matched the filter criteria and were accessible to the caller.

Type: Sequence[google.analytics.admin_v1alpha.types.Property]

next_page_token¶

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

Type: str

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

Bases: proto.message.Message

Request message for ListUserLinks RPC.

parent¶

Required. Example format: accounts/1234

Type: str

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

page_token¶

A page token, received from a previous ListUserLinks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListUserLinks must match the call that provided the page token.

Type: str

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

Bases: proto.message.Message

Response message for ListUserLinks RPC.

user_links¶

List of UserLinks. These will be ordered stably, but in an arbitrary order.

Type: Sequence[google.analytics.admin_v1alpha.types.UserLink]

next_page_token¶

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

Type: str

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

Bases: proto.message.Message

A 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}/webDataStreams/{webDataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

Type: str

display_name¶

Required. Human-readable display name for this secret.

Type: str

secret_value¶

Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret’s parent property.

Type: str

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

Bases: proto.message.Message

A resource message representing a Google Analytics GA4 property.

name¶

Output only. Resource name of this property. Format: properties/{property_id} Example: “properties/1000”.

Type: str

create_time¶

Output only. Time when the entity was originally created.

Type: google.protobuf.timestamp_pb2.Timestamp

update_time¶

Output only. Time when entity payload fields were last updated.

Type: google.protobuf.timestamp_pb2.Timestamp

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} Example: “accounts/100”.

Type: str

display_name¶

Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units.

Type: str

industry_category¶

Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK

Type: google.analytics.admin_v1alpha.types.IndustryCategory

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

currency_code¶

The currency type used in reports involving monetary values.

Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: “USD”, “EUR”, “JPY”.

Type: str

service_level¶

Output only. The Google Analytics service level that applies to this property.

Type: google.analytics.admin_v1alpha.types.ServiceLevel

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.

Type: google.protobuf.timestamp_pb2.Timestamp

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.

Type: google.protobuf.timestamp_pb2.Timestamp

account¶

Immutable. The resource name of the parent account Format: accounts/{account_id} Example: “accounts/123”.

Type: str

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

Bases: proto.message.Message

A 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: str

display_name¶

Display name for the property referred to in this property summary.

Type: str

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

Bases: proto.message.Message

Request message for ProvisionAccountTicket RPC.

account¶

The account to create.

Type: google.analytics.admin_v1alpha.types.Account

redirect_uri¶

Redirect URI where the user will be sent after accepting Terms of Service. Must be configured in Developers Console as a Redirect URI

Type: str

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

Bases: proto.message.Message

Response message for ProvisionAccountTicket RPC.

account_ticket_id¶

The param to be passed in the ToS link.

Type: str

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

Bases: proto.message.Message

Request message for SearchChangeHistoryEvents RPC.

account¶

Required. The account resource for which to return change history resources.

Type: str

property¶

Optional. Resource name for a child property. If set, only return changes made to this property or its child resources.

Type: str

resource_type¶

Optional. If set, only return changes if they are for a resource that matches at least one of these types.

Type: Sequence[google.analytics.admin_v1alpha.types.ChangeHistoryResourceType]

action¶

Optional. If set, only return changes that match one or more of these types of actions.

Type: Sequence[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: Sequence[str]

earliest_change_time¶

Optional. If set, only return changes made after this time (inclusive).

Type: google.protobuf.timestamp_pb2.Timestamp

latest_change_time¶

Optional. If set, only return changes made before this time (inclusive).

Type: google.protobuf.timestamp_pb2.Timestamp

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

page_token¶

Optional. A page token, received from a previous SearchChangeHistoryEvents call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchChangeHistoryEvents must match the call that provided the page token.

Type: str

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

Bases: proto.message.Message

Response message for SearchAccounts RPC.

change_history_events¶

Results that were accessible to the caller.

Type: Sequence[google.analytics.admin_v1alpha.types.ChangeHistoryEvent]

next_page_token¶

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

Type: str

class google.analytics.admin_v1alpha.types.ServiceLevel(value)[source]¶

Bases: proto.enums.Enum

Various levels of service for Google Analytics.

GOOGLE_ANALYTICS_360 = 2¶

GOOGLE_ANALYTICS_STANDARD = 1¶

SERVICE_LEVEL_UNSPECIFIED = 0¶

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

Bases: proto.message.Message

Request message for UpdateAccount RPC.

account¶

Required. The account to update. The account’s name field is used to identify the account.

Type: google.analytics.admin_v1alpha.types.Account

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.

Type: google.protobuf.field_mask_pb2.FieldMask

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

Bases: proto.message.Message

Request message for UpdateCustomDimension RPC.

custom_dimension¶

The CustomDimension to update

Type: google.analytics.admin_v1alpha.types.CustomDimension

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.

Type: google.protobuf.field_mask_pb2.FieldMask

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

Bases: proto.message.Message

Request message for UpdateCustomMetric RPC.

custom_metric¶

The CustomMetric to update

Type: google.analytics.admin_v1alpha.types.CustomMetric

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.

Type: google.protobuf.field_mask_pb2.FieldMask

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

Bases: proto.message.Message

Request message for UpdateDataRetentionSettings RPC.

data_retention_settings¶

Required. The settings to update. The name field is used to identify the settings to be updated.

Type: google.analytics.admin_v1alpha.types.DataRetentionSettings

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.

Type: google.protobuf.field_mask_pb2.FieldMask

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

Bases: proto.message.Message

Request message for UpdateDataStream RPC.

data_stream¶

The DataStream to update

Type: google.analytics.admin_v1alpha.types.DataStream

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.

Type: google.protobuf.field_mask_pb2.FieldMask

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

Bases: proto.message.Message

Request message for UpdateDisplayVideo360AdvertiserLink RPC.

display_video_360_advertiser_link¶

The DisplayVideo360AdvertiserLink to update

Type: google.analytics.admin_v1alpha.types.DisplayVideo360AdvertiserLink

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.

Type: google.protobuf.field_mask_pb2.FieldMask

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

Bases: proto.message.Message

Request message for UpdateGoogleAdsLink RPC

google_ads_link¶

The GoogleAdsLink to update

Type: google.analytics.admin_v1alpha.types.GoogleAdsLink

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.

Type: google.protobuf.field_mask_pb2.FieldMask

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

Bases: proto.message.Message

Request message for UpdateGoogleSignalsSettings RPC

google_signals_settings¶

Required. The settings to update. The name field is used to identify the settings to be updated.

Type: google.analytics.admin_v1alpha.types.GoogleSignalsSettings

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.

Type: google.protobuf.field_mask_pb2.FieldMask

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

Bases: proto.message.Message

Request message for UpdateMeasurementProtocolSecret RPC

measurement_protocol_secret¶

Required. The measurement protocol secret to update.

Type: google.analytics.admin_v1alpha.types.MeasurementProtocolSecret

update_mask¶

The list of fields to be updated. Omitted fields will not be updated.

Type: google.protobuf.field_mask_pb2.FieldMask

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

Bases: proto.message.Message

Request message for UpdateProperty RPC.

property¶

Required. The property to update. The property’s name field is used to identify the property to be updated.

Type: google.analytics.admin_v1alpha.types.Property

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.

Type: google.protobuf.field_mask_pb2.FieldMask

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

Bases: proto.message.Message

Request message for UpdateUserLink RPC.

user_link¶

Required. The user link to update.

Type: google.analytics.admin_v1alpha.types.UserLink

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

Bases: proto.message.Message

A resource message representing a user’s permissions on an Account or Property resource.

name¶

Output only. Example format: properties/1234/userLinks/5678

Type: str

email_address¶

Immutable. Email address of the user to link

Type: str

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: Sequence[str]

Types for Google Analytics Admin v1alpha API¶

google-analytics-admin

Navigation

Related Topics