Show / Hide Table of Contents

Namespace Google.Apis.GoogleAnalyticsAdmin.v1alpha

Classes

AccountsResource

The "accounts" collection of methods.

AccountsResource.DeleteRequest

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.

AccountsResource.GetDataSharingSettingsRequest

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

AccountsResource.GetRequest

Lookup for a single Account.

AccountsResource.ListRequest

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.

AccountsResource.PatchRequest

Updates an account.

AccountsResource.ProvisionAccountTicketRequest

Requests a ticket for creating an account.

AccountsResource.SearchChangeHistoryEventsRequest

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

AccountsResource.UserLinksResource

The "userLinks" collection of methods.

AccountsResource.UserLinksResource.AuditRequest

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.

AccountsResource.UserLinksResource.BatchCreateRequest

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.

AccountsResource.UserLinksResource.BatchDeleteRequest

Deletes information about multiple users' links to an account or property.

AccountsResource.UserLinksResource.BatchGetRequest

Gets information about multiple users' links to an account or property.

AccountsResource.UserLinksResource.BatchUpdateRequest

Updates information about multiple users' links to an account or property.

AccountsResource.UserLinksResource.CreateRequest

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.

AccountsResource.UserLinksResource.DeleteRequest

Deletes a user link on an account or property.

AccountsResource.UserLinksResource.GetRequest

Gets information about a user's link to an account or property.

AccountsResource.UserLinksResource.ListRequest

Lists all user links on an account or property.

AccountsResource.UserLinksResource.PatchRequest

Updates a user link on an account or property.

AccountSummariesResource

The "accountSummaries" collection of methods.

AccountSummariesResource.ListRequest

Returns summaries of all accounts accessible by the caller.

GoogleAnalyticsAdminBaseServiceRequest<TResponse>

A base abstract class for GoogleAnalyticsAdmin requests.

GoogleAnalyticsAdminService

The GoogleAnalyticsAdmin Service.

GoogleAnalyticsAdminService.Scope

Available OAuth 2.0 scopes for use with the Google Analytics Admin API.

GoogleAnalyticsAdminService.ScopeConstants

Available OAuth 2.0 scope constants for use with the Google Analytics Admin API.

PropertiesResource

The "properties" collection of methods.

PropertiesResource.AcknowledgeUserDataCollectionRequest

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.

PropertiesResource.AudiencesResource

The "audiences" collection of methods.

PropertiesResource.AudiencesResource.ArchiveRequest

Archives an Audience on a property.

PropertiesResource.AudiencesResource.CreateRequest

Creates an Audience.

PropertiesResource.AudiencesResource.GetRequest

Lookup for a single Audience. Audiences created before 2020 may not be supported.

PropertiesResource.AudiencesResource.ListRequest

Lists Audiences on a property. Audiences created before 2020 may not be supported.

PropertiesResource.AudiencesResource.PatchRequest

Updates an Audience on a property.

PropertiesResource.ConversionEventsResource

The "conversionEvents" collection of methods.

PropertiesResource.ConversionEventsResource.CreateRequest

Creates a conversion event with the specified attributes.

PropertiesResource.ConversionEventsResource.DeleteRequest

Deletes a conversion event in a property.

PropertiesResource.ConversionEventsResource.GetRequest

Retrieve a single conversion event.

PropertiesResource.ConversionEventsResource.ListRequest

Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.

PropertiesResource.CreateRequest

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

PropertiesResource.CustomDimensionsResource

The "customDimensions" collection of methods.

PropertiesResource.CustomDimensionsResource.ArchiveRequest

Archives a CustomDimension on a property.

PropertiesResource.CustomDimensionsResource.CreateRequest

Creates a CustomDimension.

PropertiesResource.CustomDimensionsResource.GetRequest

Lookup for a single CustomDimension.

PropertiesResource.CustomDimensionsResource.ListRequest

Lists CustomDimensions on a property.

PropertiesResource.CustomDimensionsResource.PatchRequest

Updates a CustomDimension on a property.

PropertiesResource.CustomMetricsResource

The "customMetrics" collection of methods.

PropertiesResource.CustomMetricsResource.ArchiveRequest

Archives a CustomMetric on a property.

PropertiesResource.CustomMetricsResource.CreateRequest

Creates a CustomMetric.

PropertiesResource.CustomMetricsResource.GetRequest

Lookup for a single CustomMetric.

PropertiesResource.CustomMetricsResource.ListRequest

Lists CustomMetrics on a property.

PropertiesResource.CustomMetricsResource.PatchRequest

Updates a CustomMetric on a property.

PropertiesResource.DataStreamsResource

The "dataStreams" collection of methods.

PropertiesResource.DataStreamsResource.CreateRequest

Creates a DataStream.

PropertiesResource.DataStreamsResource.DeleteRequest

Deletes a DataStream on a property.

PropertiesResource.DataStreamsResource.GetGlobalSiteTagRequest

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

PropertiesResource.DataStreamsResource.GetRequest

Lookup for a single DataStream.

PropertiesResource.DataStreamsResource.ListRequest

Lists DataStreams on a property.

PropertiesResource.DataStreamsResource.MeasurementProtocolSecretsResource

The "measurementProtocolSecrets" collection of methods.

PropertiesResource.DataStreamsResource.MeasurementProtocolSecretsResource.CreateRequest

Creates a measurement protocol secret.

PropertiesResource.DataStreamsResource.MeasurementProtocolSecretsResource.DeleteRequest

Deletes target MeasurementProtocolSecret.

PropertiesResource.DataStreamsResource.MeasurementProtocolSecretsResource.GetRequest

Lookup for a single "GA4" MeasurementProtocolSecret.

PropertiesResource.DataStreamsResource.MeasurementProtocolSecretsResource.ListRequest

Returns child MeasurementProtocolSecrets under the specified parent Property.

PropertiesResource.DataStreamsResource.MeasurementProtocolSecretsResource.PatchRequest

Updates a measurement protocol secret.

PropertiesResource.DataStreamsResource.PatchRequest

Updates a DataStream on a property.

PropertiesResource.DeleteRequest

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.

PropertiesResource.DisplayVideo360AdvertiserLinkProposalsResource

The "displayVideo360AdvertiserLinkProposals" collection of methods.

PropertiesResource.DisplayVideo360AdvertiserLinkProposalsResource.ApproveRequest

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

PropertiesResource.DisplayVideo360AdvertiserLinkProposalsResource.CancelRequest

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

PropertiesResource.DisplayVideo360AdvertiserLinkProposalsResource.CreateRequest

Creates a DisplayVideo360AdvertiserLinkProposal.

PropertiesResource.DisplayVideo360AdvertiserLinkProposalsResource.DeleteRequest

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

PropertiesResource.DisplayVideo360AdvertiserLinkProposalsResource.GetRequest

Lookup for a single DisplayVideo360AdvertiserLinkProposal.

PropertiesResource.DisplayVideo360AdvertiserLinkProposalsResource.ListRequest

Lists DisplayVideo360AdvertiserLinkProposals on a property.

PropertiesResource.DisplayVideo360AdvertiserLinksResource

The "displayVideo360AdvertiserLinks" collection of methods.

PropertiesResource.DisplayVideo360AdvertiserLinksResource.CreateRequest

Creates a DisplayVideo360AdvertiserLink. This can only be utilized by users who have proper authorization both on the Google Analytics property and on the Display &amp; Video 360 advertiser. Users who do not have access to the Display &amp; Video 360 advertiser should instead seek to create a DisplayVideo360LinkProposal.

PropertiesResource.DisplayVideo360AdvertiserLinksResource.DeleteRequest

Deletes a DisplayVideo360AdvertiserLink on a property.

PropertiesResource.DisplayVideo360AdvertiserLinksResource.GetRequest

Look up a single DisplayVideo360AdvertiserLink

PropertiesResource.DisplayVideo360AdvertiserLinksResource.ListRequest

Lists all DisplayVideo360AdvertiserLinks on a property.

PropertiesResource.DisplayVideo360AdvertiserLinksResource.PatchRequest

Updates a DisplayVideo360AdvertiserLink on a property.

PropertiesResource.FirebaseLinksResource

The "firebaseLinks" collection of methods.

PropertiesResource.FirebaseLinksResource.CreateRequest

Creates a FirebaseLink. Properties can have at most one FirebaseLink.

PropertiesResource.FirebaseLinksResource.DeleteRequest

Deletes a FirebaseLink on a property

PropertiesResource.FirebaseLinksResource.ListRequest

Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink.

PropertiesResource.GetAttributionSettingsRequest

Lookup for a AttributionSettings singleton.

PropertiesResource.GetDataRetentionSettingsRequest

Returns the singleton data retention settings for this property.

PropertiesResource.GetGoogleSignalsSettingsRequest

Lookup for Google Signals settings for a property.

PropertiesResource.GetRequest

Lookup for a single "GA4" Property.

PropertiesResource.GoogleAdsLinksResource

The "googleAdsLinks" collection of methods.

PropertiesResource.GoogleAdsLinksResource.CreateRequest

Creates a GoogleAdsLink.

PropertiesResource.GoogleAdsLinksResource.DeleteRequest

Deletes a GoogleAdsLink on a property

PropertiesResource.GoogleAdsLinksResource.ListRequest

Lists GoogleAdsLinks on a property.

PropertiesResource.GoogleAdsLinksResource.PatchRequest

Updates a GoogleAdsLink on a property

PropertiesResource.ListRequest

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.

PropertiesResource.PatchRequest

Updates a property.

PropertiesResource.RunAccessReportRequest

Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. The property must be in Google Analytics 360. This method is only available to Administrators. These data access records include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase &amp; Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see searchChangeHistoryEvents.

PropertiesResource.UpdateAttributionSettingsRequest

Updates attribution settings on a property.

PropertiesResource.UpdateDataRetentionSettingsRequest

Updates the singleton data retention settings for this property.

PropertiesResource.UpdateGoogleSignalsSettingsRequest

Updates Google Signals settings for a property.

PropertiesResource.UserLinksResource

The "userLinks" collection of methods.

PropertiesResource.UserLinksResource.AuditRequest

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.

PropertiesResource.UserLinksResource.BatchCreateRequest

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.

PropertiesResource.UserLinksResource.BatchDeleteRequest

Deletes information about multiple users' links to an account or property.

PropertiesResource.UserLinksResource.BatchGetRequest

Gets information about multiple users' links to an account or property.

PropertiesResource.UserLinksResource.BatchUpdateRequest

Updates information about multiple users' links to an account or property.

PropertiesResource.UserLinksResource.CreateRequest

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.

PropertiesResource.UserLinksResource.DeleteRequest

Deletes a user link on an account or property.

PropertiesResource.UserLinksResource.GetRequest

Gets information about a user's link to an account or property.

PropertiesResource.UserLinksResource.ListRequest

Lists all user links on an account or property.

PropertiesResource.UserLinksResource.PatchRequest

Updates a user link on an account or property.

Enums

GoogleAnalyticsAdminBaseServiceRequest<TResponse>.AltEnum

Data format for response.

GoogleAnalyticsAdminBaseServiceRequest<TResponse>.XgafvEnum

V1 error format.

In This Article
Back to top