Package google.analytics.admin.v1alpha

Index

AnalyticsAdminService

Service Interface for the Analytics Admin API (GA4).

AcknowledgeUserDataCollection

rpc AcknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest) returns (AcknowledgeUserDataCollectionResponse)

Acknowledges the terms of user data collection for the specified property.

This acknowledgement must be completed (either in the Google Analytics UI or via this API) before MeasurementProtocolSecret resources may be created.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/analytics.edit
ApproveDisplayVideo360AdvertiserLinkProposal

rpc ApproveDisplayVideo360AdvertiserLinkProposal(ApproveDisplayVideo360AdvertiserLinkProposalRequest) returns (ApproveDisplayVideo360AdvertiserLinkProposalResponse)

Approves a DisplayVideo360AdvertiserLinkProposal. The DisplayVideo360AdvertiserLinkProposal will be deleted and a new DisplayVideo360AdvertiserLink will be created.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/analytics.edit
ArchiveCustomDimension

rpc ArchiveCustomDimension(ArchiveCustomDimensionRequest) returns (Empty)

Archives a CustomDimension on a property.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/analytics.edit
ArchiveCustomMetric

rpc ArchiveCustomMetric(ArchiveCustomMetricRequest) returns (Empty)

Archives a CustomMetric on a property.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/analytics.edit
CancelDisplayVideo360AdvertiserLinkProposal

rpc CancelDisplayVideo360AdvertiserLinkProposal(CancelDisplayVideo360AdvertiserLinkProposalRequest) returns (DisplayVideo360AdvertiserLinkProposal)

Cancels a DisplayVideo360AdvertiserLinkProposal. Cancelling can mean either: - Declining a proposal initiated from Display & Video 360 - Withdrawing a proposal initiated from Google Analytics After being cancelled, a proposal will eventually be deleted automatically.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/analytics.edit
CreateConversionEvent

rpc CreateConversionEvent(CreateConversionEventRequest) returns (ConversionEvent)

Creates a conversion event with the specified attributes.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/analytics.edit
CreateCustomDimension

rpc CreateCustomDimension(CreateCustomDimensionRequest) returns (CustomDimension)

Creates a CustomDimension.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/analytics.edit
CreateCustomMetric

rpc CreateCustomMetric(CreateCustomMetricRequest) returns (CustomMetric)

Creates a CustomMetric.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/analytics.edit
CreateDisplayVideo360AdvertiserLinkProposal

rpc CreateDisplayVideo360AdvertiserLinkProposal(CreateDisplayVideo360AdvertiserLinkProposalRequest) returns (DisplayVideo360AdvertiserLinkProposal)

Creates a DisplayVideo360AdvertiserLinkProposal.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/analytics.edit
CreateMeasurementProtocolSecret

rpc CreateMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest) returns (MeasurementProtocolSecret)

Creates a measurement protocol secret.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/analytics.edit
CreateProperty

rpc CreateProperty(CreatePropertyRequest) returns (Property)

Creates an "GA4" property with the specified location and attributes.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/analytics.edit
CreateWebDataStream

rpc CreateWebDataStream(CreateWebDataStreamRequest) returns (WebDataStream)

Creates a web stream with the specified location and attributes.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/analytics.edit
DeleteAccount

rpc DeleteAccount(DeleteAccountRequest) returns (Empty)

Marks target Account as soft-deleted (ie: "trashed") and returns it.

This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI.

If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772

Returns an error if the target is not found.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/analytics.edit
DeleteAndroidAppDataStream

rpc DeleteAndroidAppDataStream(DeleteAndroidAppDataStreamRequest) returns (Empty)

Deletes an android app stream on a property.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/analytics.edit
DeleteConversionEvent

rpc DeleteConversionEvent(DeleteConversionEventRequest) returns (Empty)

Deletes a conversion event in a property.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/analytics.edit
DeleteDisplayVideo360AdvertiserLinkProposal

rpc DeleteDisplayVideo360AdvertiserLinkProposal(DeleteDisplayVideo360AdvertiserLinkProposalRequest) returns (Empty)

Deletes a DisplayVideo360AdvertiserLinkProposal on a property. This can only be used on cancelled proposals.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/analytics.edit
DeleteIosAppDataStream

rpc DeleteIosAppDataStream(DeleteIosAppDataStreamRequest) returns (Empty)

Deletes an iOS app stream on a property.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/analytics.edit
DeleteMeasurementProtocolSecret

rpc DeleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest) returns (Empty)

Deletes target MeasurementProtocolSecret.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/analytics.edit
DeleteProperty

rpc DeleteProperty(DeletePropertyRequest) returns (Property)

Marks target Property as soft-deleted (ie: "trashed") and returns it.

This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI.

If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772

Returns an error if the target is not found, or is not an GA4 Property.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/analytics.edit
DeleteWebDataStream

rpc DeleteWebDataStream(DeleteWebDataStreamRequest) returns (Empty)

Deletes a web stream on a property.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/analytics.edit
GetAccount

rpc GetAccount(GetAccountRequest) returns (Account)

Lookup for a single Account.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetAndroidAppDataStream

rpc GetAndroidAppDataStream(GetAndroidAppDataStreamRequest) returns (AndroidAppDataStream)

Lookup for a single AndroidAppDataStream

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetConversionEvent

rpc GetConversionEvent(GetConversionEventRequest) returns (ConversionEvent)

Retrieve a single conversion event.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetCustomDimension

rpc GetCustomDimension(GetCustomDimensionRequest) returns (CustomDimension)

Lookup for a single CustomDimension.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetCustomMetric

rpc GetCustomMetric(GetCustomMetricRequest) returns (CustomMetric)

Lookup for a single CustomMetric.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetDataRetentionSettings

rpc GetDataRetentionSettings(GetDataRetentionSettingsRequest) returns (DataRetentionSettings)

Returns the singleton data retention settings for this property.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetDataSharingSettings

rpc GetDataSharingSettings(GetDataSharingSettingsRequest) returns (DataSharingSettings)

Get data sharing settings on an account. Data sharing settings are singletons.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetDisplayVideo360AdvertiserLinkProposal

rpc GetDisplayVideo360AdvertiserLinkProposal(GetDisplayVideo360AdvertiserLinkProposalRequest) returns (DisplayVideo360AdvertiserLinkProposal)

Lookup for a single DisplayVideo360AdvertiserLinkProposal.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetEnhancedMeasurementSettings

rpc GetEnhancedMeasurementSettings(GetEnhancedMeasurementSettingsRequest) returns (EnhancedMeasurementSettings)

Returns the singleton enhanced measurement settings for this web stream. Note that the stream must enable enhanced measurement for these settings to take effect.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetGlobalSiteTag

rpc GetGlobalSiteTag(GetGlobalSiteTagRequest) returns (GlobalSiteTag)

Returns the Site Tag for the specified web stream. Site Tags are immutable singletons.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetGoogleSignalsSettings

rpc GetGoogleSignalsSettings(GetGoogleSignalsSettingsRequest) returns (GoogleSignalsSettings)

Lookup for Google Signals settings for a property.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetIosAppDataStream

rpc GetIosAppDataStream(GetIosAppDataStreamRequest) returns (IosAppDataStream)

Lookup for a single IosAppDataStream

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetMeasurementProtocolSecret

rpc GetMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest) returns (MeasurementProtocolSecret)

Lookup for a single "GA4" MeasurementProtocolSecret.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetProperty

rpc GetProperty(GetPropertyRequest) returns (Property)

Lookup for a single "GA4" Property.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetWebDataStream

rpc GetWebDataStream(GetWebDataStreamRequest) returns (WebDataStream)

Lookup for a single WebDataStream

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListAccountSummaries

rpc ListAccountSummaries(ListAccountSummariesRequest) returns (ListAccountSummariesResponse)

Returns summaries of all accounts accessible by the caller.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListAccounts

rpc ListAccounts(ListAccountsRequest) returns (ListAccountsResponse)

Returns all accounts accessible by the caller.

Note that these accounts might not currently have GA4 properties. Soft-deleted (ie: "trashed") accounts are excluded by default. Returns an empty list if no relevant accounts are found.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListAndroidAppDataStreams

rpc ListAndroidAppDataStreams(ListAndroidAppDataStreamsRequest) returns (ListAndroidAppDataStreamsResponse)

Returns child android app streams under the specified parent property.

Android app streams will be excluded if the caller does not have access. Returns an empty list if no relevant android app streams are found.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListConversionEvents

rpc ListConversionEvents(ListConversionEventsRequest) returns (ListConversionEventsResponse)

Returns a list of conversion events in the specified parent property.

Returns an empty list if no conversion events are found.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListCustomDimensions

rpc ListCustomDimensions(ListCustomDimensionsRequest) returns (ListCustomDimensionsResponse)

Lists CustomDimensions on a property.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListCustomMetrics

rpc ListCustomMetrics(ListCustomMetricsRequest) returns (ListCustomMetricsResponse)

Lists CustomMetrics on a property.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListDisplayVideo360AdvertiserLinkProposals

rpc ListDisplayVideo360AdvertiserLinkProposals(ListDisplayVideo360AdvertiserLinkProposalsRequest) returns (ListDisplayVideo360AdvertiserLinkProposalsResponse)

Lists DisplayVideo360AdvertiserLinkProposals on a property.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListIosAppDataStreams

rpc ListIosAppDataStreams(ListIosAppDataStreamsRequest) returns (ListIosAppDataStreamsResponse)

Returns child iOS app data streams under the specified parent property.

iOS app data streams will be excluded if the caller does not have access. Returns an empty list if no relevant iOS app data streams are found.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListMeasurementProtocolSecrets

rpc ListMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest) returns (ListMeasurementProtocolSecretsResponse)

Returns child MeasurementProtocolSecrets under the specified parent Property.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListProperties

rpc ListProperties(ListPropertiesRequest) returns (ListPropertiesResponse)

Returns child Properties under the specified parent Account.

Only "GA4" properties will be returned. Properties will be excluded if the caller does not have access. Soft-deleted (ie: "trashed") properties are excluded by default. Returns an empty list if no relevant properties are found.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListWebDataStreams

rpc ListWebDataStreams(ListWebDataStreamsRequest) returns (ListWebDataStreamsResponse)

Returns child web data streams under the specified parent property.

Web data streams will be excluded if the caller does not have access. Returns an empty list if no relevant web data streams are found.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ProvisionAccountTicket

rpc ProvisionAccountTicket(ProvisionAccountTicketRequest) returns (ProvisionAccountTicketResponse)

Requests a ticket for creating an account.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/analytics.edit
SearchChangeHistoryEvents

rpc SearchChangeHistoryEvents(SearchChangeHistoryEventsRequest) returns (SearchChangeHistoryEventsResponse)

Searches through all changes to an account or its children given the specified set of filters.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/analytics.edit
UpdateAccount

rpc UpdateAccount(UpdateAccountRequest) returns (Account)

Updates an account.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/analytics.edit
UpdateAndroidAppDataStream

rpc UpdateAndroidAppDataStream(UpdateAndroidAppDataStreamRequest) returns (AndroidAppDataStream)

Updates an android app stream on a property.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/analytics.edit
UpdateCustomDimension

rpc UpdateCustomDimension(UpdateCustomDimensionRequest) returns (CustomDimension)

Updates a CustomDimension on a property.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/analytics.edit
UpdateCustomMetric

rpc UpdateCustomMetric(UpdateCustomMetricRequest) returns (CustomMetric)

Updates a CustomMetric on a property.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/analytics.edit
UpdateDataRetentionSettings

rpc UpdateDataRetentionSettings(UpdateDataRetentionSettingsRequest) returns (DataRetentionSettings)

Updates the singleton data retention settings for this property.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/analytics.edit
UpdateEnhancedMeasurementSettings

rpc UpdateEnhancedMeasurementSettings(UpdateEnhancedMeasurementSettingsRequest) returns (EnhancedMeasurementSettings)

Updates the singleton enhanced measurement settings for this web stream. Note that the stream must enable enhanced measurement for these settings to take effect.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/analytics.edit
UpdateGoogleSignalsSettings

rpc UpdateGoogleSignalsSettings(UpdateGoogleSignalsSettingsRequest) returns (GoogleSignalsSettings)

Updates Google Signals settings for a property.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/analytics.edit
UpdateIosAppDataStream

rpc UpdateIosAppDataStream(UpdateIosAppDataStreamRequest) returns (IosAppDataStream)

Updates an iOS app stream on a property.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/analytics.edit
UpdateMeasurementProtocolSecret

rpc UpdateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest) returns (MeasurementProtocolSecret)

Updates a measurement protocol secret.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/analytics.edit
UpdateProperty

rpc UpdateProperty(UpdatePropertyRequest) returns (Property)

Updates a property.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/analytics.edit
UpdateWebDataStream

rpc UpdateWebDataStream(UpdateWebDataStreamRequest) returns (WebDataStream)

Updates a web stream on a property.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/analytics.edit

Account

A resource message representing a Google Analytics account.

Fields
name

string

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

create_time

Timestamp

Output only. Time when this account was originally created.

update_time

Timestamp

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

display_name

string

Required. Human-readable display name for this account.

region_code

string

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

deleted

bool

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

AccountSummary

A virtual resource representing an overview of an account and all its child GA4 properties.

Fields
name

string

Resource name for this account summary. Format: accountSummaries/{account_id} Example: "accountSummaries/1000"

account

string

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

display_name

string

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

property_summaries[]

PropertySummary

List of summaries for child accounts of this account.

AcknowledgeUserDataCollectionRequest

Request message for AcknowledgeUserDataCollection RPC.

Fields
property

string

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

acknowledgement

string

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

AcknowledgeUserDataCollectionResponse

Response message for AcknowledgeUserDataCollection RPC.

ActionType

Types of actions that may change a resource.

Enums
ACTION_TYPE_UNSPECIFIED Action type unknown or not specified.
CREATED Resource was created in this change.
UPDATED Resource was updated in this change.
DELETED Resource was deleted in this change.

ActorType

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

Enums
ACTOR_TYPE_UNSPECIFIED Unknown or unspecified actor type.
USER Changes made by the user specified in actor_email.
SYSTEM Changes made by the Google Analytics system.
SUPPORT Changes made by Google Analytics support team staff.

AndroidAppDataStream

A resource message representing a Google Analytics Android app stream.

Fields
name

string

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

firebase_app_id

string

Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated.

create_time

Timestamp

Output only. Time when this stream was originally created.

update_time

Timestamp

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

package_name

string

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

display_name

string

Human-readable display name for the Data Stream.

The max allowed display name length is 255 UTF-16 code units.

ApproveDisplayVideo360AdvertiserLinkProposalRequest

Request message for ApproveDisplayVideo360AdvertiserLinkProposal RPC.

Fields
name

string

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

ApproveDisplayVideo360AdvertiserLinkProposalResponse

Response message for ApproveDisplayVideo360AdvertiserLinkProposal RPC.

Fields

ArchiveCustomDimensionRequest

Request message for ArchiveCustomDimension RPC.

Fields
name

string

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

ArchiveCustomMetricRequest

Request message for ArchiveCustomMetric RPC.

Fields
name

string

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

AuditUserLinksRequest

Request message for AuditUserLinks RPC.

Fields
parent

string

Required. Example format: accounts/1234

page_size

int32

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.

page_token

string

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.

AuditUserLinksResponse

Response message for AuditUserLinks RPC.

Fields
next_page_token

string

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

BatchCreateUserLinksRequest

Request message for BatchCreateUserLinks RPC.

Fields
parent

string

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

notify_new_users

bool

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.

requests[]

CreateUserLinkRequest

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

BatchCreateUserLinksResponse

Response message for BatchCreateUserLinks RPC.

Fields

BatchDeleteUserLinksRequest

Request message for BatchDeleteUserLinks RPC.

Fields
parent

string

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

requests[]

DeleteUserLinkRequest

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

BatchGetUserLinksRequest

Request message for BatchGetUserLinks RPC.

Fields
parent

string

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

names[]

string

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}

BatchGetUserLinksResponse

Response message for BatchGetUserLinks RPC.

Fields

BatchUpdateUserLinksRequest

Request message for BatchUpdateUserLinks RPC.

Fields
parent

string

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

requests[]

UpdateUserLinkRequest

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

BatchUpdateUserLinksResponse

Response message for BatchUpdateUserLinks RPC.

Fields

CancelDisplayVideo360AdvertiserLinkProposalRequest

Request message for CancelDisplayVideo360AdvertiserLinkProposal RPC.

Fields
name

string

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

ChangeHistoryChange

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

Fields
resource

string

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

action

ActionType

The type of action that changed this resource.

resource_before_change

ChangeHistoryResource

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

resource_after_change

ChangeHistoryResource

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

ChangeHistoryResource

A snapshot of a resource as before or after the result of a change in change history.

Fields

Union field resource.

resource can be only one of the following:

account

Account

A snapshot of an Account resource in change history.

property

Property

A snapshot of a Property resource in change history.

web_data_stream

WebDataStream

A snapshot of a WebDataStream resource in change history.

android_app_data_stream

AndroidAppDataStream

A snapshot of an AndroidAppDataStream resource in change history.

ios_app_data_stream

IosAppDataStream

A snapshot of an IosAppDataStream resource in change history.

google_signals_settings

GoogleSignalsSettings

A snapshot of a GoogleSignalsSettings resource in change history.

conversion_event

ConversionEvent

A snapshot of a ConversionEvent resource in change history.

measurement_protocol_secret

MeasurementProtocolSecret

A snapshot of a MeasurementProtocolSecret resource in change history.

custom_dimension

CustomDimension

A snapshot of a CustomDimension resource in change history.

custom_metric

CustomMetric

A snapshot of a CustomMetric resource in change history.

data_retention_settings

DataRetentionSettings

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

ChangeHistoryEvent

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.

Fields
id

string

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

change_time

Timestamp

Time when change was made.

actor_type

ActorType

The type of actor that made this change.

user_actor_email

string

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.

changes_filtered

bool

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

changes[]

ChangeHistoryChange

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

ChangeHistoryResourceType

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

Enums
CHANGE_HISTORY_RESOURCE_TYPE_UNSPECIFIED Resource type unknown or not specified.
ACCOUNT Account resource
PROPERTY Property resource
WEB_DATA_STREAM WebDataStream resource
ANDROID_APP_DATA_STREAM AndroidAppDataStream resource
IOS_APP_DATA_STREAM IosAppDataStream resource
GOOGLE_SIGNALS_SETTINGS GoogleSignalsSettings resource
CONVERSION_EVENT ConversionEvent resource
MEASUREMENT_PROTOCOL_SECRET MeasurementProtocolSecret resource
CUSTOM_DIMENSION CustomDimension resource
CUSTOM_METRIC CustomMetric resource
DATA_RETENTION_SETTINGS DataRetentionSettings resource

ConversionEvent

A conversion event in a Google Analytics property.

Fields
name

string

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

event_name

string

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

create_time

Timestamp

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

deletable

bool

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

custom

bool

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.

CreateConversionEventRequest

Request message for CreateConversionEvent RPC

Fields
conversion_event

ConversionEvent

Required. The conversion event to create.

parent

string

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

CreateCustomDimensionRequest

Request message for CreateCustomDimension RPC.

Fields
parent

string

Required. Example format: properties/1234

custom_dimension

CustomDimension

Required. The CustomDimension to create.

CreateCustomMetricRequest

Request message for CreateCustomMetric RPC.

Fields
parent

string

Required. Example format: properties/1234

custom_metric

CustomMetric

Required. The CustomMetric to create.

CreateDisplayVideo360AdvertiserLinkProposalRequest

Request message for CreateDisplayVideo360AdvertiserLinkProposal RPC.

Fields
parent

string

Required. Example format: properties/1234

CreateDisplayVideo360AdvertiserLinkRequest

Request message for CreateDisplayVideo360AdvertiserLink RPC.

Fields
parent

string

Required. Example format: properties/1234

CreateFirebaseLinkRequest

Request message for CreateFirebaseLink RPC

Fields
parent

string

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

CreateGoogleAdsLinkRequest

Request message for CreateGoogleAdsLink RPC

Fields
parent

string

Required. Example format: properties/1234

CreateMeasurementProtocolSecretRequest

Request message for CreateMeasurementProtocolSecret RPC

Fields
parent

string

Required. The parent resource where this secret will be created. Any type of stream (WebDataStream, IosAppDataStream, AndroidAppDataStream) may be a parent. Format: properties/{property}/webDataStreams/{webDataStream}

measurement_protocol_secret

MeasurementProtocolSecret

Required. The measurement protocol secret to create.

CreatePropertyRequest

Request message for CreateProperty RPC.

Fields
property

Property

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

CreateUserLinkRequest

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.

Fields
parent

string

Required. Example format: accounts/1234

notify_new_user

bool

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

CreateWebDataStreamRequest

Request message for CreateWebDataStream RPC.

Fields
web_data_stream

WebDataStream

Required. The web stream to create.

parent

string

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

CustomDimension

A definition for a CustomDimension.

Fields
name

string

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

parameter_name

string

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.

display_name

string

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.

description

string

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

scope

DimensionScope

Required. Immutable. The scope of this dimension.

disallow_ads_personalization

bool

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.

DimensionScope

Valid values for the scope of this dimension.

Enums
DIMENSION_SCOPE_UNSPECIFIED Scope unknown or not specified.
EVENT Dimension scoped to an event.
USER Dimension scoped to a user.

CustomMetric

A definition for a custom metric.

Fields
name

string

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

parameter_name

string

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.

display_name

string

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.

description

string

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

measurement_unit

MeasurementUnit

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

scope

MetricScope

Required. Immutable. The scope of this custom metric.

MeasurementUnit

Possible types of representing the custom metric's value.

Currency representation may change in the future, requiring a breaking API change.

Enums
MEASUREMENT_UNIT_UNSPECIFIED MeasurementUnit unspecified or missing.
STANDARD This metric uses default units.
CURRENCY This metric measures a currency.
FEET This metric measures feet.
METERS This metric measures meters.
KILOMETERS This metric measures kilometers.
MILES This metric measures miles.
MILLISECONDS This metric measures milliseconds.
SECONDS This metric measures seconds.
MINUTES This metric measures minutes.
HOURS This metric measures hours.

MetricScope

The scope of this metric.

Enums
METRIC_SCOPE_UNSPECIFIED Scope unknown or not specified.
EVENT Metric scoped to an event.

DataRetentionSettings

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

Fields
name

string

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

event_data_retention

RetentionDuration

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

reset_user_data_on_new_activity

bool

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

RetentionDuration

Valid values for the data retention duration.

Enums
RETENTION_DURATION_UNSPECIFIED Data retention time duration is not specified.
TWO_MONTHS The data retention time duration is 2 months.
FOURTEEN_MONTHS The data retention time duration is 14 months.
TWENTY_SIX_MONTHS The data retention time duration is 26 months. Available to 360 properties only.
THIRTY_EIGHT_MONTHS The data retention time duration is 38 months. Available to 360 properties only.
FIFTY_MONTHS The data retention time duration is 50 months. Available to 360 properties only.

DataSharingSettings

A resource message representing data sharing settings of a Google Analytics account.

Fields
name

string

Output only. Resource name. Format: accounts/{account}/dataSharingSettings Example: "accounts/1000/dataSharingSettings"

sharing_with_google_support_enabled

bool

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

sharing_with_google_assigned_sales_enabled

bool

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.

sharing_with_google_any_sales_enabled

bool

Allows any of Google sales to access the data in order to suggest configuration changes to improve results.

sharing_with_google_products_enabled

bool

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

sharing_with_others_enabled

bool

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

DeleteAccountRequest

Request message for DeleteAccount RPC.

Fields
name

string

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

DeleteAndroidAppDataStreamRequest

Request message for DeleteAndroidAppDataStream RPC.

Fields
name

string

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

DeleteConversionEventRequest

Request message for DeleteConversionEvent RPC

Fields
name

string

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

DeleteDisplayVideo360AdvertiserLinkProposalRequest

Request message for DeleteDisplayVideo360AdvertiserLinkProposal RPC.

Fields
name

string

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

DeleteDisplayVideo360AdvertiserLinkRequest

Request message for DeleteDisplayVideo360AdvertiserLink RPC.

Fields
name

string

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

DeleteFirebaseLinkRequest

Request message for DeleteFirebaseLink RPC

Fields
name

string

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

DeleteGoogleAdsLinkRequest

Request message for DeleteGoogleAdsLink RPC.

Fields
name

string

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

DeleteIosAppDataStreamRequest

Request message for DeleteIosAppDataStream RPC.

Fields
name

string

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

DeleteMeasurementProtocolSecretRequest

Request message for DeleteMeasurementProtocolSecret RPC

Fields
name

string

Required. The name of the MeasurementProtocolSecret to delete. Format: properties/{property}/webDataStreams/{webDataStream}/measurementProtocolSecrets/{measurementProtocolSecret} Note: Any type of stream (WebDataStream, IosAppDataStream, AndroidAppDataStream) may be a parent.

DeletePropertyRequest

Request message for DeleteProperty RPC.

Fields
name

string

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

DeleteUserLinkRequest

Request message for DeleteUserLink RPC.

Fields
name

string

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

DeleteWebDataStreamRequest

Request message for DeleteWebDataStream RPC.

Fields
name

string

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

DisplayVideo360AdvertiserLinkProposal

A proposal for a link between an 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.

Fields
name

string

Output only. The resource name for this DisplayVideo360AdvertiserLinkProposal resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinkProposals/{proposalId}

Note: proposalId is not the Display & Video 360 Advertiser ID

advertiser_id

string

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

advertiser_display_name

string

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

validation_email

string

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.

ads_personalization_enabled

BoolValue

Immutable. Enables personalized advertising features with this integration. If this field is not set on create, it will be defaulted to true.

campaign_data_sharing_enabled

BoolValue

Immutable. Enables the import of campaign data from Display & Video 360. If this field is not set on create, it will be defaulted to true.

cost_data_sharing_enabled

BoolValue

Immutable. Enables the import of cost data from Display & Video 360. This can only be enabled if campaign_data_import_enabled is enabled. If this field is not set on create, it will be defaulted to true.

EnhancedMeasurementSettings

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

Fields
name

string

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

stream_enabled

bool

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.

page_views_enabled

bool

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

scrolls_enabled

bool

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

outbound_clicks_enabled

bool

If enabled, capture an outbound click event each time a visitor clicks a link that leads them away from your domain.

site_search_enabled

bool

If enabled, capture a view search results event each time a visitor performs a search on your site (based on a query parameter).

video_engagement_enabled

bool

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

file_downloads_enabled

bool

If enabled, capture a file download event each time a link is clicked with a common document, compressed file, application, video, or audio extension.

page_loads_enabled

bool

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

page_changes_enabled

bool

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

search_query_parameter

string

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

uri_query_parameter

string

Additional URL query parameters. Max length is 1024 characters.

GetAccountRequest

Request message for GetAccount RPC.

Fields
name

string

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

GetAndroidAppDataStreamRequest

Request message for GetAndroidAppDataStream RPC.

Fields
name

string

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

GetConversionEventRequest

Request message for GetConversionEvent RPC

Fields
name

string

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

GetCustomDimensionRequest

Request message for GetCustomDimension RPC.

Fields
name

string

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

GetCustomMetricRequest

Request message for GetCustomMetric RPC.

Fields
name

string

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

GetDataRetentionSettingsRequest

Request message for GetDataRetentionSettings RPC.

Fields
name

string

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

GetDataSharingSettingsRequest

Request message for GetDataSharingSettings RPC.

Fields
name

string

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

GetDisplayVideo360AdvertiserLinkProposalRequest

Request message for GetDisplayVideo360AdvertiserLinkProposal RPC.

Fields
name

string

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

GetDisplayVideo360AdvertiserLinkRequest

Request message for GetDisplayVideo360AdvertiserLink RPC.

Fields
name

string

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

GetEnhancedMeasurementSettingsRequest

Request message for GetEnhancedMeasurementSettings RPC.

Fields
name

string

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

GetGlobalSiteTagRequest

Request message for GetGlobalSiteTag RPC.

Fields
name

string

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"

GetGoogleSignalsSettingsRequest

Request message for GetGoogleSignalsSettings RPC

Fields
name

string

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

GetIosAppDataStreamRequest

Request message for GetIosAppDataStream RPC.

Fields
name

string

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

GetMeasurementProtocolSecretRequest

Request message for GetMeasurementProtocolSecret RPC.

Fields
name

string

Required. The name of the measurement protocol secret to lookup. Format: properties/{property}/webDataStreams/{webDataStream}/measurementProtocolSecrets/{measurementProtocolSecret} Note: Any type of stream (WebDataStream, IosAppDataStream, AndroidAppDataStream) may be a parent.

GetPropertyRequest

Request message for GetProperty RPC.

Fields
name

string

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

GetUserLinkRequest

Request message for GetUserLink RPC.

Fields
name

string

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

GetWebDataStreamRequest

Request message for GetWebDataStream RPC.

Fields
name

string

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

GlobalSiteTag

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

Fields
name

string

Output only. Resource name for this GlobalSiteTag resource. Format: properties/{propertyId}/globalSiteTag

snippet

string

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

GoogleSignalsConsent

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

Enums

GoogleSignalsSettings

Settings values for Google Signals. This is a singleton resource.

Fields
name

string

Output only. Resource name of this setting. Format: properties/{property_id}/googleSignalsSettings Example: "properties/1000/googleSignalsSettings"

state

GoogleSignalsState

Status of this setting.

consent

GoogleSignalsConsent

Output only. Terms of Service acceptance.

GoogleSignalsState

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

Enums
GOOGLE_SIGNALS_STATE_UNSPECIFIED Google Signals status defaults to GOOGLE_SIGNALS_STATE_UNSPECIFIED to represent that the user has not made an explicit choice.
GOOGLE_SIGNALS_ENABLED Google Signals is enabled.
GOOGLE_SIGNALS_DISABLED Google Signals is disabled.

IndustryCategory

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

Enums
INDUSTRY_CATEGORY_UNSPECIFIED Industry category unspecified
AUTOMOTIVE Automotive
BUSINESS_AND_INDUSTRIAL_MARKETS Business and industrial markets
FINANCE Finance
HEALTHCARE Healthcare
TECHNOLOGY Technology
TRAVEL Travel
OTHER Other
ARTS_AND_ENTERTAINMENT Arts and entertainment
BEAUTY_AND_FITNESS Beauty and fitness
BOOKS_AND_LITERATURE Books and literature
FOOD_AND_DRINK Food and drink
GAMES Games
HOBBIES_AND_LEISURE Hobbies and leisure
HOME_AND_GARDEN Home and garden
INTERNET_AND_TELECOM Internet and telecom
LAW_AND_GOVERNMENT Law and government
NEWS News
ONLINE_COMMUNITIES Online communities
PEOPLE_AND_SOCIETY People and society
PETS_AND_ANIMALS Pets and animals
REAL_ESTATE Real estate
REFERENCE Reference
SCIENCE Science
SPORTS Sports
JOBS_AND_EDUCATION Jobs and education
SHOPPING Shopping

IosAppDataStream

A resource message representing a Google Analytics IOS app stream.

Fields
name

string

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

firebase_app_id

string

Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated.

create_time

Timestamp

Output only. Time when this stream was originally created.

update_time

Timestamp

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

bundle_id

string

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

display_name

string

Human-readable display name for the Data Stream.

The max allowed display name length is 255 UTF-16 code units.

LinkProposalInitiatingProduct

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

Enums
GOOGLE_ANALYTICS This proposal was created by a user from Google Analytics.
LINKED_PRODUCT This proposal was created by a user from a linked product (not Google Analytics).

LinkProposalState

The state of a link proposal resource.

Enums
AWAITING_REVIEW_FROM_GOOGLE_ANALYTICS This proposal is awaiting review from a Google Analytics user. This proposal will automatically expire after some time.
AWAITING_REVIEW_FROM_LINKED_PRODUCT This proposal is awaiting review from a user of a linked product. This proposal will automatically expire after some time.
WITHDRAWN This proposal has been withdrawn by an admin on the initiating product. This proposal will be automatically deleted after some time.
DECLINED This proposal has been declined by an admin on the receiving product. This proposal will be automatically deleted after some time.
EXPIRED This proposal expired due to lack of response from an admin on the receiving product. This proposal will be automatically deleted after some time.
OBSOLETE This proposal has become obsolete because a link was directly created to the same external product resource that this proposal specifies. This proposal will be automatically deleted after some time.

LinkProposalStatusDetails

Status information for a link proposal.

Fields
requestor_email

string

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

ListAccountSummariesRequest

Request message for ListAccountSummaries RPC.

Fields
page_size

int32

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)

page_token

string

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.

ListAccountSummariesResponse

Response message for ListAccountSummaries RPC.

Fields
account_summaries[]

AccountSummary

Account summaries of all accounts the caller has access to.

next_page_token

string

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

ListAccountsRequest

Request message for ListAccounts RPC.

Fields
page_size

int32

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)

page_token

string

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.

show_deleted

bool

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

ListAccountsResponse

Request message for ListAccounts RPC.

Fields
accounts[]

Account

Results that were accessible to the caller.

next_page_token

string

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

ListAndroidAppDataStreamsRequest

Request message for ListAndroidAppDataStreams RPC.

Fields
parent

string

Required. The name of the parent property. For example, to limit results to app streams under the property with Id 123: "properties/123"

page_size

int32

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)

page_token

string

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.

ListAndroidAppDataStreamsResponse

Request message for ListAndroidDataStreams RPC.

Fields
android_app_data_streams[]

AndroidAppDataStream

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

next_page_token

string

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

ListConversionEventsRequest

Request message for ListConversionEvents RPC

Fields
parent

string

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

page_size

int32

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)

page_token

string

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.

ListConversionEventsResponse

Response message for ListConversionEvents RPC.

Fields
conversion_events[]

ConversionEvent

The requested conversion events

next_page_token

string

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

ListCustomDimensionsRequest

Request message for ListCustomDimensions RPC.

Fields
parent

string

Required. Example format: properties/1234

page_size

int32

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

page_token

string

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.

ListCustomDimensionsResponse

Response message for ListCustomDimensions RPC.

Fields
custom_dimensions[]

CustomDimension

List of CustomDimensions.

next_page_token

string

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

ListCustomMetricsRequest

Request message for ListCustomMetrics RPC.

Fields
parent

string

Required. Example format: properties/1234

page_size

int32

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

page_token

string

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.

ListCustomMetricsResponse

Response message for ListCustomMetrics RPC.

Fields
custom_metrics[]

CustomMetric

List of CustomMetrics.

next_page_token

string

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

ListDisplayVideo360AdvertiserLinkProposalsRequest

Request message for ListDisplayVideo360AdvertiserLinkProposals RPC.

Fields
parent

string

Required. Example format: properties/1234

page_size

int32

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

page_token

string

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.

ListDisplayVideo360AdvertiserLinkProposalsResponse

Response message for ListDisplayVideo360AdvertiserLinkProposals RPC.

Fields
next_page_token

string

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

ListDisplayVideo360AdvertiserLinksRequest

Request message for ListDisplayVideo360AdvertiserLinks RPC.

Fields
parent

string

Required. Example format: properties/1234

page_size

int32

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

page_token

string

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.

ListDisplayVideo360AdvertiserLinksResponse

Response message for ListDisplayVideo360AdvertiserLinks RPC.

Fields
next_page_token

string

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

ListFirebaseLinksRequest

Request message for ListFirebaseLinks RPC

Fields
parent

string

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

page_size

int32

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)

page_token

string

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.

ListFirebaseLinksResponse

Response message for ListFirebaseLinks RPC

Fields
next_page_token

string

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.

ListGoogleAdsLinksRequest

Request message for ListGoogleAdsLinks RPC.

Fields
parent

string

Required. Example format: properties/1234

page_size

int32

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

page_token

string

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.

ListGoogleAdsLinksResponse

Response message for ListGoogleAdsLinks RPC.

Fields
next_page_token

string

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

ListIosAppDataStreamsRequest

Request message for ListIosAppDataStreams RPC.

Fields
parent

string

Required. The name of the parent property. For example, to list results of app streams under the property with Id 123: "properties/123"

page_size

int32

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)

page_token

string

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.

ListIosAppDataStreamsResponse

Request message for ListIosAppDataStreams RPC.

Fields
ios_app_data_streams[]

IosAppDataStream

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

next_page_token

string

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

ListMeasurementProtocolSecretsRequest

Request message for ListMeasurementProtocolSecret RPC

Fields
parent

string

Required. The resource name of the parent stream. Any type of stream (WebDataStream, IosAppDataStream, AndroidAppDataStream) may be a parent. Format: properties/{property}/webDataStreams/{webDataStream}/measurementProtocolSecrets

page_size

int32

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.

page_token

string

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.

ListMeasurementProtocolSecretsResponse

Response message for ListMeasurementProtocolSecret RPC

Fields
measurement_protocol_secrets[]

MeasurementProtocolSecret

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

next_page_token

string

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

ListPropertiesRequest

Request message for ListProperties RPC.

Fields
filter

string

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

int32

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)

page_token

string

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.

show_deleted

bool

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

ListPropertiesResponse

Response message for ListProperties RPC.

Fields
properties[]

Property

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

next_page_token

string

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

ListUserLinksRequest

Request message for ListUserLinks RPC.

Fields
parent

string

Required. Example format: accounts/1234

page_size

int32

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.

page_token

string

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.

ListUserLinksResponse

Response message for ListUserLinks RPC.

Fields
next_page_token

string

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

ListWebDataStreamsRequest

Request message for ListWebDataStreams RPC.

Fields
parent

string

Required. The name of the parent property. For example, to list results of web streams under the property with Id 123: "properties/123"

page_size

int32

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)

page_token

string

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.

ListWebDataStreamsResponse

Request message for ListWebDataStreams RPC.

Fields
web_data_streams[]

WebDataStream

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

next_page_token

string

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

MeasurementProtocolSecret

A secret value used for sending hits to Measurement Protocol.

Fields
name

string

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}

display_name

string

Required. Human-readable display name for this secret.

secret_value

string

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.

Property

A resource message representing a Google Analytics GA4 property.

Fields
name

string

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

create_time

Timestamp

Output only. Time when the entity was originally created.

update_time

Timestamp

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

parent

string

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"

display_name

string

Required. Human-readable display name for this property.

The max allowed display name length is 100 UTF-16 code units.

industry_category

IndustryCategory

Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK

time_zone

string

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"

currency_code

string

The currency type used in reports involving monetary values.

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

service_level

ServiceLevel

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

delete_time

Timestamp

Output only. If set, the time at which this property was trashed. If not set, then this property is not currently in the trash can.

expire_time

Timestamp

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.

account

string

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

PropertySummary

A virtual resource representing metadata for an GA4 property.

Fields
property

string

Resource name of property referred to by this property summary Format: properties/{property_id} Example: "properties/1000"

display_name

string

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

ProvisionAccountTicketRequest

Request message for ProvisionAccountTicket RPC.

Fields
account

Account

The account to create.

redirect_uri

string

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

ProvisionAccountTicketResponse

Response message for ProvisionAccountTicket RPC.

Fields
account_ticket_id

string

The param to be passed in the ToS link.

SearchChangeHistoryEventsRequest

Request message for SearchChangeHistoryEvents RPC.

Fields
account

string

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

property

string

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

resource_type[]

ChangeHistoryResourceType

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

action[]

ActionType

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

actor_email[]

string

Optional. If set, only return changes if they are made by a user in this list.

earliest_change_time

Timestamp

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

latest_change_time

Timestamp

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

page_size

int32

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

page_token

string

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.

SearchChangeHistoryEventsResponse

Response message for SearchAccounts RPC.

Fields
change_history_events[]

ChangeHistoryEvent

Results that were accessible to the caller.

next_page_token

string

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

ServiceLevel

Various levels of service for Google Analytics.

Enums
SERVICE_LEVEL_UNSPECIFIED Service level not specified or invalid.
GOOGLE_ANALYTICS_STANDARD The standard version of Google Analytics.
GOOGLE_ANALYTICS_360 The paid, premium version of Google Analytics.

UpdateAccountRequest

Request message for UpdateAccount RPC.

Fields
account

Account

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

update_mask

FieldMask

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.

UpdateAndroidAppDataStreamRequest

Request message for UpdateAndroidAppDataStream RPC.

Fields
android_app_data_stream

AndroidAppDataStream

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

update_mask

FieldMask

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.

UpdateCustomDimensionRequest

Request message for UpdateCustomDimension RPC.

Fields
custom_dimension

CustomDimension

The CustomDimension to update

update_mask

FieldMask

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.

UpdateCustomMetricRequest

Request message for UpdateCustomMetric RPC.

Fields
custom_metric

CustomMetric

The CustomMetric to update

update_mask

FieldMask

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.

UpdateDataRetentionSettingsRequest

Request message for UpdateDataRetentionSettings RPC.

Fields
data_retention_settings

DataRetentionSettings

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

update_mask

FieldMask

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.

UpdateDisplayVideo360AdvertiserLinkRequest

Request message for UpdateDisplayVideo360AdvertiserLink RPC.

Fields
update_mask

FieldMask

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.

UpdateEnhancedMeasurementSettingsRequest

Request message for UpdateEnhancedMeasurementSettings RPC.

Fields
enhanced_measurement_settings

EnhancedMeasurementSettings

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

update_mask

FieldMask

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.

UpdateGoogleAdsLinkRequest

Request message for UpdateGoogleAdsLink RPC

Fields
update_mask

FieldMask

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.

UpdateGoogleSignalsSettingsRequest

Request message for UpdateGoogleSignalsSettings RPC

Fields
google_signals_settings

GoogleSignalsSettings

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

update_mask

FieldMask

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.

UpdateIosAppDataStreamRequest

Request message for UpdateIosAppDataStream RPC.

Fields
ios_app_data_stream

IosAppDataStream

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

update_mask

FieldMask

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.

UpdateMeasurementProtocolSecretRequest

Request message for UpdateMeasurementProtocolSecret RPC

Fields
measurement_protocol_secret

MeasurementProtocolSecret

Required. The measurement protocol secret to update.

update_mask

FieldMask

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

UpdatePropertyRequest

Request message for UpdateProperty RPC.

Fields
property

Property

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

update_mask

FieldMask

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.

UpdateUserLinkRequest

Request message for UpdateUserLink RPC.

Fields

UpdateWebDataStreamRequest

Request message for UpdateWebDataStream RPC.

Fields
web_data_stream

WebDataStream

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

update_mask

FieldMask

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.

WebDataStream

A resource message representing a Google Analytics web stream.

Fields
name

string

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

measurement_id

string

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

firebase_app_id

string

Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated.

create_time

Timestamp

Output only. Time when this stream was originally created.

update_time

Timestamp

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

default_uri

string

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

display_name

string

Required. Human-readable display name for the Data Stream.

The max allowed display name length is 100 UTF-16 code units.