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)

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)

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.AndroidAppDataStream(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A resource message representing a Google Analytics Android app stream.

name

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

Type

str

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

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

package_name

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

Type

str

display_name

Human-readable display name for the Data Stream. The max allowed display name length is 255 UTF-16 code units.

Type

str

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

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

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

Type

Sequence[str]

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

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)

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

property raw_page

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

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)

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)

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)

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)

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)

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)

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.CreateAndroidAppDataStreamRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for CreateAndroidAppDataStream RPC.

android_app_data_stream

Required. The android app stream to create.

Type

google.analytics.admin_v1alpha.types.AndroidAppDataStream

parent

Required. The parent resource where this android app data stream will be created. Format: properties/123

Type

str

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

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)

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.CreateIosAppDataStreamRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for CreateIosAppDataStream RPC.

ios_app_data_stream

Required. The iOS app data stream to create.

Type

google.analytics.admin_v1alpha.types.IosAppDataStream

parent

Required. The parent resource where this ios app data stream will be created. Format: properties/123

Type

str

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

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)

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.CreateWebDataStreamRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for CreateWebDataStream RPC.

web_data_stream

Required. The web stream to create.

Type

google.analytics.admin_v1alpha.types.WebDataStream

parent

Required. The parent resource where this web data stream will be created. Format: properties/123

Type

str

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

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.DeleteAccountRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for DeleteAccount RPC.

name

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

Type

str

class google.analytics.admin_v1alpha.types.DeleteAndroidAppDataStreamRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for DeleteAndroidAppDataStream RPC.

name

Required. The name of the android app data stream to delete. Format: properties/{property_id}/androidAppDataStreams/{stream_id} Example: “properties/123/androidAppDataStreams/456”.

Type

str

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

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)

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.DeleteIosAppDataStreamRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for DeleteIosAppDataStream RPC.

name

Required. The name of the iOS app data stream to delete. Format: properties/{property_id}/iosAppDataStreams/{stream_id} Example: “properties/123/iosAppDataStreams/456”.

Type

str

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

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)

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.DeleteWebDataStreamRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for DeleteWebDataStream RPC.

name

Required. The name of the web data stream to delete. Format: properties/{property_id}/webDataStreams/{stream_id} Example: “properties/123/webDataStreams/456”.

Type

str

class google.analytics.admin_v1alpha.types.EnhancedMeasurementSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Singleton resource under a WebDataStream, configuring measurement of additional site interactions and content.

name

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

Type

str

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

bool

page_views_enabled

Output only. If enabled, capture a page view event each time a page loads or the website changes the browser history state.

Type

bool

scrolls_enabled

If enabled, capture scroll events each time a visitor gets to the bottom of a page.

Type

bool

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

bool

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

bool

video_engagement_enabled

If enabled, capture video play, progress, and complete events as visitors view embedded videos on your site.

Type

bool

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

bool

page_loads_enabled

Output only. If enabled, capture a page view event each time a page loads.

Type

bool

page_changes_enabled

If enabled, capture a page view event each time the website changes the browser history state.

Type

bool

search_query_parameter

Required. URL query parameters to interpret as site search parameters. Max length is 1024 characters. Must not be empty.

Type

str

uri_query_parameter

Additional URL query parameters. Max length is 1024 characters.

Type

str

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

Bases: proto.message.Message

A link between an 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

maximum_user_access

Maximum user access to the GA4 property allowed to admins of the linked Firebase project.

Type

google.analytics.admin_v1alpha.types.MaximumUserAccess

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

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.GetAndroidAppDataStreamRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for GetAndroidAppDataStream RPC.

name

Required. The name of the android app data stream to lookup. Format: properties/{property_id}/androidAppDataStreams/{stream_id} Example: “properties/123/androidAppDataStreams/456”.

Type

str

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

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.GetEnhancedMeasurementSettingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for GetEnhancedMeasurementSettings RPC.

name

Required. The name of the settings to lookup. Format: properties/{property_id}/webDataStreams/{stream_id}/enhancedMeasurementSettings Example: “properties/1000/webDataStreams/2000/enhancedMeasurementSettings”.

Type

str

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

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}/webDataStreams/{stream_id}/globalSiteTag Example: “properties/123/webDataStreams/456/globalSiteTag”.

Type

str

class google.analytics.admin_v1alpha.types.GetIosAppDataStreamRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for GetIosAppDataStream RPC.

name

Required. The name of the iOS app data stream to lookup. Format: properties/{property_id}/iosAppDataStreams/{stream_id} Example: “properties/123/iosAppDataStreams/456”.

Type

str

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

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)

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.GetWebDataStreamRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for GetWebDataStream RPC.

name

Required. The name of the web data stream to lookup. Format: properties/{property_id}/webDataStreams/{stream_id} Example: “properties/123/webDataStreams/456”.

Type

str

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

Bases: proto.message.Message

Read-only resource with the tag for sending data from a website to a WebDataStream.

name

Output only. Resource name for this GlobalSiteTag resource. Format: properties/{propertyId}/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)

Bases: proto.message.Message

A link between an 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

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

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

class google.analytics.admin_v1alpha.types.IndustryCategory(value)

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.IosAppDataStream(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A resource message representing a Google Analytics IOS app stream.

name

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

Type

str

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

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

bundle_id

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

Type

str

display_name

Human-readable display name for the Data Stream. The max allowed display name length is 255 UTF-16 code units.

Type

str

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

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)

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

property raw_page

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

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)

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

property raw_page

class google.analytics.admin_v1alpha.types.ListAndroidAppDataStreamsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for ListAndroidAppDataStreams RPC.

parent

Required. The name of the parent property. For example, to limit results to app streams under the property with Id 123: “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 call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAndroidAppDataStreams must match the call that provided the page token.

Type

str

class google.analytics.admin_v1alpha.types.ListAndroidAppDataStreamsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for ListAndroidDataStreams RPC.

android_app_data_streams

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

Type

Sequence[google.analytics.admin_v1alpha.types.AndroidAppDataStream]

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

property raw_page

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

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)

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

property raw_page

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

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)

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

property raw_page

class google.analytics.admin_v1alpha.types.ListIosAppDataStreamsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for ListIosAppDataStreams RPC.

parent

Required. The name of the parent property. For example, to list results of app streams under the property with Id 123: “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 ListIosAppDataStreams call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListIosAppDataStreams must match the call that provided the page token.

Type

str

class google.analytics.admin_v1alpha.types.ListIosAppDataStreamsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for ListIosAppDataStreams RPC.

ios_app_data_streams

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

Type

Sequence[google.analytics.admin_v1alpha.types.IosAppDataStream]

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

property raw_page

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

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

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

property raw_page

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

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)

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

property raw_page

class google.analytics.admin_v1alpha.types.ListWebDataStreamsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for ListWebDataStreams RPC.

parent

Required. The name of the parent property. For example, to list results of web streams under the property with Id 123: “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 ListWebDataStreams call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListWebDataStreams must match the call that provided the page token.

Type

str

class google.analytics.admin_v1alpha.types.ListWebDataStreamsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for ListWebDataStreams RPC.

web_data_streams

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

Type

Sequence[google.analytics.admin_v1alpha.types.WebDataStream]

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

property raw_page

class google.analytics.admin_v1alpha.types.MaximumUserAccess(value)

Bases: proto.enums.Enum

Maximum access settings that Firebase user receive on the linked Analytics property.

EDITOR_INCLUDING_LINK_MANAGEMENT = 4

EDITOR_WITHOUT_LINK_MANAGEMENT = 3

MAXIMUM_USER_ACCESS_UNSPECIFIED = 0

NO_ACCESS = 1

READ_AND_ANALYZE = 2

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

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

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

deleted

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

Type

bool

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

Bases: proto.message.Message

A virtual resource representing metadata for an 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 account summary.

Type

str

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

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)

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.UpdateAccountRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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. 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.UpdateAndroidAppDataStreamRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for UpdateAndroidAppDataStream RPC.

android_app_data_stream

Required. The android app stream to update. The name field is used to identify the android app stream to be updated.

Type

google.analytics.admin_v1alpha.types.AndroidAppDataStream

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.UpdateEnhancedMeasurementSettingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for UpdateEnhancedMeasurementSettings RPC.

enhanced_measurement_settings

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

Type

google.analytics.admin_v1alpha.types.EnhancedMeasurementSettings

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.UpdateFirebaseLinkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for UpdateFirebaseLink RPC

firebase_link

Required. The Firebase link to update.

Type

google.analytics.admin_v1alpha.types.FirebaseLink

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)

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. 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.UpdateIosAppDataStreamRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for UpdateIosAppDataStream RPC.

ios_app_data_stream

Required. The iOS app stream to update. The name field is used to identify the iOS app stream to be updated.

Type

google.analytics.admin_v1alpha.types.IosAppDataStream

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.UpdatePropertyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

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.UpdateWebDataStreamRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for UpdateWebDataStream RPC.

web_data_stream

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

Type

google.analytics.admin_v1alpha.types.WebDataStream

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.UserLink(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

name

Example format: properties/1234/userLinks/5678

Type

str

email_address

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/read predefinedRoles/collaborate predefinedRoles/edit predefinedRoles/manage-users

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]

class google.analytics.admin_v1alpha.types.WebDataStream(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A resource message representing a Google Analytics web stream.

name

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

Type

str

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

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

default_uri

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

Type

str

display_name

Required. Human-readable display name for the Data Stream. The max allowed display name length is 100 UTF-16 code units.

Type

str