Module api

Module api 

Source

Structs§

AccountDeleteCall
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.
AccountGetCall
Lookup for a single Account.
AccountGetDataSharingSettingCall
Get data sharing settings on an account. Data sharing settings are singletons.
AccountListCall
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.
AccountMethods
A builder providing access to all methods supported on account resources. It is not used directly, but through the GoogleAnalyticsAdmin hub.
AccountPatchCall
Updates an account.
AccountProvisionAccountTicketCall
Requests a ticket for creating an account.
AccountSearchChangeHistoryEventCall
Searches through all changes to an account or its children given the specified set of filters.
AccountSummaryListCall
Returns summaries of all accounts accessible by the caller.
AccountSummaryMethods
A builder providing access to all methods supported on accountSummary resources. It is not used directly, but through the GoogleAnalyticsAdmin hub.
AccountUserLinkAuditCall
Lists all user links on an account or property, including implicit ones that come from effective permissions granted by groups or organization admin roles. If a returned user link does not have direct permissions, they cannot be removed from the account or property directly with the DeleteUserLink command. They have to be removed from the group/etc that gives them permissions, which is currently only usable/discoverable in the GA or GMP UIs.
AccountUserLinkBatchCreateCall
Creates information about multiple users’ links to an account or property. This method is transactional. If any UserLink cannot be created, none of the UserLinks will be created.
AccountUserLinkBatchDeleteCall
Deletes information about multiple users’ links to an account or property.
AccountUserLinkBatchGetCall
Gets information about multiple users’ links to an account or property.
AccountUserLinkBatchUpdateCall
Updates information about multiple users’ links to an account or property.
AccountUserLinkCreateCall
Creates a user link on an account or property. If the user with the specified email already has permissions on the account or property, then the user’s existing permissions will be unioned with the permissions specified in the new UserLink.
AccountUserLinkDeleteCall
Deletes a user link on an account or property.
AccountUserLinkGetCall
Gets information about a user’s link to an account or property.
AccountUserLinkListCall
Lists all user links on an account or property.
AccountUserLinkPatchCall
Updates a user link on an account or property.
GoogleAnalyticsAdmin
Central instance to access all GoogleAnalyticsAdmin related resource activities
GoogleAnalyticsAdminV1alphaAccount
A resource message representing a Google Analytics account.
GoogleAnalyticsAdminV1alphaAccountSummary
A virtual resource representing an overview of an account and all its child GA4 properties.
GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionRequest
Request message for AcknowledgeUserDataCollection RPC.
GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionResponse
Response message for AcknowledgeUserDataCollection RPC.
GoogleAnalyticsAdminV1alphaApproveDisplayVideo360AdvertiserLinkProposalRequest
Request message for ApproveDisplayVideo360AdvertiserLinkProposal RPC.
GoogleAnalyticsAdminV1alphaApproveDisplayVideo360AdvertiserLinkProposalResponse
Response message for ApproveDisplayVideo360AdvertiserLinkProposal RPC.
GoogleAnalyticsAdminV1alphaArchiveCustomDimensionRequest
Request message for ArchiveCustomDimension RPC.
GoogleAnalyticsAdminV1alphaArchiveCustomMetricRequest
Request message for ArchiveCustomMetric RPC.
GoogleAnalyticsAdminV1alphaAuditUserLink
Read-only resource used to summarize a principal’s effective roles.
GoogleAnalyticsAdminV1alphaAuditUserLinksRequest
Request message for AuditUserLinks RPC.
GoogleAnalyticsAdminV1alphaAuditUserLinksResponse
Response message for AuditUserLinks RPC.
GoogleAnalyticsAdminV1alphaBatchCreateUserLinksRequest
Request message for BatchCreateUserLinks RPC.
GoogleAnalyticsAdminV1alphaBatchCreateUserLinksResponse
Response message for BatchCreateUserLinks RPC.
GoogleAnalyticsAdminV1alphaBatchDeleteUserLinksRequest
Request message for BatchDeleteUserLinks RPC.
GoogleAnalyticsAdminV1alphaBatchGetUserLinksResponse
Response message for BatchGetUserLinks RPC.
GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksRequest
Request message for BatchUpdateUserLinks RPC.
GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksResponse
Response message for BatchUpdateUserLinks RPC.
GoogleAnalyticsAdminV1alphaCancelDisplayVideo360AdvertiserLinkProposalRequest
Request message for CancelDisplayVideo360AdvertiserLinkProposal RPC.
GoogleAnalyticsAdminV1alphaChangeHistoryChange
A description of a change to a single Google Analytics resource.
GoogleAnalyticsAdminV1alphaChangeHistoryChangeChangeHistoryResource
A snapshot of a resource as before or after the result of a change in change history.
GoogleAnalyticsAdminV1alphaChangeHistoryEvent
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.
GoogleAnalyticsAdminV1alphaConversionEvent
A conversion event in a Google Analytics property.
GoogleAnalyticsAdminV1alphaCreateUserLinkRequest
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.
GoogleAnalyticsAdminV1alphaCustomDimension
A definition for a CustomDimension.
GoogleAnalyticsAdminV1alphaCustomMetric
A definition for a custom metric.
GoogleAnalyticsAdminV1alphaDataRetentionSettings
Settings values for data retention. This is a singleton resource.
GoogleAnalyticsAdminV1alphaDataSharingSettings
A resource message representing data sharing settings of a Google Analytics account.
GoogleAnalyticsAdminV1alphaDataStream
A resource message representing a data stream.
GoogleAnalyticsAdminV1alphaDataStreamAndroidAppStreamData
Data specific to Android app streams.
GoogleAnalyticsAdminV1alphaDataStreamIosAppStreamData
Data specific to iOS app streams.
GoogleAnalyticsAdminV1alphaDataStreamWebStreamData
Data specific to web streams.
GoogleAnalyticsAdminV1alphaDeleteUserLinkRequest
Request message for DeleteUserLink RPC.
GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLink
A link between a GA4 property and a Display & Video 360 advertiser.
GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLinkProposal
A proposal for a link between a GA4 property and a Display & Video 360 advertiser. A proposal is converted to a DisplayVideo360AdvertiserLink once approved. Google Analytics admins approve inbound proposals while Display & Video 360 admins approve outbound proposals.
GoogleAnalyticsAdminV1alphaFirebaseLink
A link between a GA4 property and a Firebase project.
GoogleAnalyticsAdminV1alphaGlobalSiteTag
Read-only resource with the tag for sending data from a website to a DataStream. Only present for web DataStream resources.
GoogleAnalyticsAdminV1alphaGoogleAdsLink
A link between a GA4 property and a Google Ads account.
GoogleAnalyticsAdminV1alphaGoogleSignalsSettings
Settings values for Google Signals. This is a singleton resource.
GoogleAnalyticsAdminV1alphaLinkProposalStatusDetails
Status information for a link proposal.
GoogleAnalyticsAdminV1alphaListAccountSummariesResponse
Response message for ListAccountSummaries RPC.
GoogleAnalyticsAdminV1alphaListAccountsResponse
Request message for ListAccounts RPC.
GoogleAnalyticsAdminV1alphaListConversionEventsResponse
Response message for ListConversionEvents RPC.
GoogleAnalyticsAdminV1alphaListCustomDimensionsResponse
Response message for ListCustomDimensions RPC.
GoogleAnalyticsAdminV1alphaListCustomMetricsResponse
Response message for ListCustomMetrics RPC.
GoogleAnalyticsAdminV1alphaListDataStreamsResponse
Response message for ListDataStreams RPC.
GoogleAnalyticsAdminV1alphaListDisplayVideo360AdvertiserLinkProposalsResponse
Response message for ListDisplayVideo360AdvertiserLinkProposals RPC.
GoogleAnalyticsAdminV1alphaListDisplayVideo360AdvertiserLinksResponse
Response message for ListDisplayVideo360AdvertiserLinks RPC.
GoogleAnalyticsAdminV1alphaListFirebaseLinksResponse
Response message for ListFirebaseLinks RPC
GoogleAnalyticsAdminV1alphaListGoogleAdsLinksResponse
Response message for ListGoogleAdsLinks RPC.
GoogleAnalyticsAdminV1alphaListMeasurementProtocolSecretsResponse
Response message for ListMeasurementProtocolSecret RPC
GoogleAnalyticsAdminV1alphaListPropertiesResponse
Response message for ListProperties RPC.
GoogleAnalyticsAdminV1alphaListUserLinksResponse
Response message for ListUserLinks RPC.
GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret
A secret value used for sending hits to Measurement Protocol.
GoogleAnalyticsAdminV1alphaProperty
A resource message representing a Google Analytics GA4 property.
GoogleAnalyticsAdminV1alphaPropertySummary
A virtual resource representing metadata for a GA4 property.
GoogleAnalyticsAdminV1alphaProvisionAccountTicketRequest
Request message for ProvisionAccountTicket RPC.
GoogleAnalyticsAdminV1alphaProvisionAccountTicketResponse
Response message for ProvisionAccountTicket RPC.
GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsRequest
Request message for SearchChangeHistoryEvents RPC.
GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsResponse
Response message for SearchAccounts RPC.
GoogleAnalyticsAdminV1alphaUpdateUserLinkRequest
Request message for UpdateUserLink RPC.
GoogleAnalyticsAdminV1alphaUserLink
A resource message representing a user’s permissions on an Account or Property resource.
GoogleProtobufEmpty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.
PropertyAcknowledgeUserDataCollectionCall
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.
PropertyConversionEventCreateCall
Creates a conversion event with the specified attributes.
PropertyConversionEventDeleteCall
Deletes a conversion event in a property.
PropertyConversionEventGetCall
Retrieve a single conversion event.
PropertyConversionEventListCall
Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.
PropertyCreateCall
Creates an “GA4” property with the specified location and attributes.
PropertyCustomDimensionArchiveCall
Archives a CustomDimension on a property.
PropertyCustomDimensionCreateCall
Creates a CustomDimension.
PropertyCustomDimensionGetCall
Lookup for a single CustomDimension.
PropertyCustomDimensionListCall
Lists CustomDimensions on a property.
PropertyCustomDimensionPatchCall
Updates a CustomDimension on a property.
PropertyCustomMetricArchiveCall
Archives a CustomMetric on a property.
PropertyCustomMetricCreateCall
Creates a CustomMetric.
PropertyCustomMetricGetCall
Lookup for a single CustomMetric.
PropertyCustomMetricListCall
Lists CustomMetrics on a property.
PropertyCustomMetricPatchCall
Updates a CustomMetric on a property.
PropertyDataStreamCreateCall
Creates a DataStream.
PropertyDataStreamDeleteCall
Deletes a DataStream on a property.
PropertyDataStreamGetCall
Lookup for a single DataStream.
PropertyDataStreamGetGlobalSiteTagCall
Returns the Site Tag for the specified web stream. Site Tags are immutable singletons.
PropertyDataStreamListCall
Lists DataStreams on a property.
PropertyDataStreamMeasurementProtocolSecretCreateCall
Creates a measurement protocol secret.
PropertyDataStreamMeasurementProtocolSecretDeleteCall
Deletes target MeasurementProtocolSecret.
PropertyDataStreamMeasurementProtocolSecretGetCall
Lookup for a single “GA4” MeasurementProtocolSecret.
PropertyDataStreamMeasurementProtocolSecretListCall
Returns child MeasurementProtocolSecrets under the specified parent Property.
PropertyDataStreamMeasurementProtocolSecretPatchCall
Updates a measurement protocol secret.
PropertyDataStreamPatchCall
Updates a DataStream on a property.
PropertyDeleteCall
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.
PropertyDisplayVideo360AdvertiserLinkCreateCall
Creates a DisplayVideo360AdvertiserLink. This can only be utilized by users who have proper authorization both on the Google Analytics property and on the Display & Video 360 advertiser. Users who do not have access to the Display & Video 360 advertiser should instead seek to create a DisplayVideo360LinkProposal.
PropertyDisplayVideo360AdvertiserLinkDeleteCall
Deletes a DisplayVideo360AdvertiserLink on a property.
PropertyDisplayVideo360AdvertiserLinkGetCall
Look up a single DisplayVideo360AdvertiserLink
PropertyDisplayVideo360AdvertiserLinkListCall
Lists all DisplayVideo360AdvertiserLinks on a property.
PropertyDisplayVideo360AdvertiserLinkPatchCall
Updates a DisplayVideo360AdvertiserLink on a property.
PropertyDisplayVideo360AdvertiserLinkProposalApproveCall
Approves a DisplayVideo360AdvertiserLinkProposal. The DisplayVideo360AdvertiserLinkProposal will be deleted and a new DisplayVideo360AdvertiserLink will be created.
PropertyDisplayVideo360AdvertiserLinkProposalCancelCall
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.
PropertyDisplayVideo360AdvertiserLinkProposalCreateCall
Creates a DisplayVideo360AdvertiserLinkProposal.
PropertyDisplayVideo360AdvertiserLinkProposalDeleteCall
Deletes a DisplayVideo360AdvertiserLinkProposal on a property. This can only be used on cancelled proposals.
PropertyDisplayVideo360AdvertiserLinkProposalGetCall
Lookup for a single DisplayVideo360AdvertiserLinkProposal.
PropertyDisplayVideo360AdvertiserLinkProposalListCall
Lists DisplayVideo360AdvertiserLinkProposals on a property.
PropertyFirebaseLinkCreateCall
Creates a FirebaseLink. Properties can have at most one FirebaseLink.
PropertyFirebaseLinkDeleteCall
Deletes a FirebaseLink on a property
PropertyFirebaseLinkListCall
Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink.
PropertyGetCall
Lookup for a single “GA4” Property.
PropertyGetDataRetentionSettingCall
Returns the singleton data retention settings for this property.
PropertyGetGoogleSignalsSettingCall
Lookup for Google Signals settings for a property.
PropertyGoogleAdsLinkCreateCall
Creates a GoogleAdsLink.
PropertyGoogleAdsLinkDeleteCall
Deletes a GoogleAdsLink on a property
PropertyGoogleAdsLinkListCall
Lists GoogleAdsLinks on a property.
PropertyGoogleAdsLinkPatchCall
Updates a GoogleAdsLink on a property
PropertyListCall
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.
PropertyMethods
A builder providing access to all methods supported on property resources. It is not used directly, but through the GoogleAnalyticsAdmin hub.
PropertyPatchCall
Updates a property.
PropertyUpdateDataRetentionSettingCall
Updates the singleton data retention settings for this property.
PropertyUpdateGoogleSignalsSettingCall
Updates Google Signals settings for a property.
PropertyUserLinkAuditCall
Lists all user links on an account or property, including implicit ones that come from effective permissions granted by groups or organization admin roles. If a returned user link does not have direct permissions, they cannot be removed from the account or property directly with the DeleteUserLink command. They have to be removed from the group/etc that gives them permissions, which is currently only usable/discoverable in the GA or GMP UIs.
PropertyUserLinkBatchCreateCall
Creates information about multiple users’ links to an account or property. This method is transactional. If any UserLink cannot be created, none of the UserLinks will be created.
PropertyUserLinkBatchDeleteCall
Deletes information about multiple users’ links to an account or property.
PropertyUserLinkBatchGetCall
Gets information about multiple users’ links to an account or property.
PropertyUserLinkBatchUpdateCall
Updates information about multiple users’ links to an account or property.
PropertyUserLinkCreateCall
Creates a user link on an account or property. If the user with the specified email already has permissions on the account or property, then the user’s existing permissions will be unioned with the permissions specified in the new UserLink.
PropertyUserLinkDeleteCall
Deletes a user link on an account or property.
PropertyUserLinkGetCall
Gets information about a user’s link to an account or property.
PropertyUserLinkListCall
Lists all user links on an account or property.
PropertyUserLinkPatchCall
Updates a user link on an account or property.

Enums§

Scope
Identifies the an OAuth2 authorization scope. A scope is needed when requesting an authorization token.