Interface AnalyticsAdminServiceGrpc.AsyncService (0.25.0)

public static interface AnalyticsAdminServiceGrpc.AsyncService

Service Interface for the Analytics Admin API (GA4).

Methods

acknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest request, StreamObserver<AcknowledgeUserDataCollectionResponse> responseObserver)

public default void acknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest request, StreamObserver<AcknowledgeUserDataCollectionResponse> responseObserver)

Acknowledges the terms of user data collection for the specified property. This acknowledgement must be completed (either in the Google Analytics UI or through this API) before MeasurementProtocolSecret resources may be created.

Parameters
NameDescription
requestAcknowledgeUserDataCollectionRequest
responseObserverio.grpc.stub.StreamObserver<AcknowledgeUserDataCollectionResponse>

approveDisplayVideo360AdvertiserLinkProposal(ApproveDisplayVideo360AdvertiserLinkProposalRequest request, StreamObserver<ApproveDisplayVideo360AdvertiserLinkProposalResponse> responseObserver)

public default void approveDisplayVideo360AdvertiserLinkProposal(ApproveDisplayVideo360AdvertiserLinkProposalRequest request, StreamObserver<ApproveDisplayVideo360AdvertiserLinkProposalResponse> responseObserver)

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

Parameters
NameDescription
requestApproveDisplayVideo360AdvertiserLinkProposalRequest
responseObserverio.grpc.stub.StreamObserver<ApproveDisplayVideo360AdvertiserLinkProposalResponse>

archiveAudience(ArchiveAudienceRequest request, StreamObserver<Empty> responseObserver)

public default void archiveAudience(ArchiveAudienceRequest request, StreamObserver<Empty> responseObserver)

Archives an Audience on a property.

Parameters
NameDescription
requestArchiveAudienceRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

archiveCustomDimension(ArchiveCustomDimensionRequest request, StreamObserver<Empty> responseObserver)

public default void archiveCustomDimension(ArchiveCustomDimensionRequest request, StreamObserver<Empty> responseObserver)

Archives a CustomDimension on a property.

Parameters
NameDescription
requestArchiveCustomDimensionRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

archiveCustomMetric(ArchiveCustomMetricRequest request, StreamObserver<Empty> responseObserver)

public default void archiveCustomMetric(ArchiveCustomMetricRequest request, StreamObserver<Empty> responseObserver)

Archives a CustomMetric on a property.

Parameters
NameDescription
requestArchiveCustomMetricRequest
responseObserverio.grpc.stub.StreamObserver<Empty>
public default void auditUserLinks(AuditUserLinksRequest request, StreamObserver<AuditUserLinksResponse> responseObserver)

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.

Parameters
NameDescription
requestAuditUserLinksRequest
responseObserverio.grpc.stub.StreamObserver<AuditUserLinksResponse>

batchCreateAccessBindings(BatchCreateAccessBindingsRequest request, StreamObserver<BatchCreateAccessBindingsResponse> responseObserver)

public default void batchCreateAccessBindings(BatchCreateAccessBindingsRequest request, StreamObserver<BatchCreateAccessBindingsResponse> responseObserver)

Creates information about multiple access bindings to an account or property. This method is transactional. If any AccessBinding cannot be created, none of the AccessBindings will be created.

Parameters
NameDescription
requestBatchCreateAccessBindingsRequest
responseObserverio.grpc.stub.StreamObserver<BatchCreateAccessBindingsResponse>
public default void batchCreateUserLinks(BatchCreateUserLinksRequest request, StreamObserver<BatchCreateUserLinksResponse> responseObserver)

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.

Parameters
NameDescription
requestBatchCreateUserLinksRequest
responseObserverio.grpc.stub.StreamObserver<BatchCreateUserLinksResponse>

batchDeleteAccessBindings(BatchDeleteAccessBindingsRequest request, StreamObserver<Empty> responseObserver)

public default void batchDeleteAccessBindings(BatchDeleteAccessBindingsRequest request, StreamObserver<Empty> responseObserver)

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

Parameters
NameDescription
requestBatchDeleteAccessBindingsRequest
responseObserverio.grpc.stub.StreamObserver<Empty>
public default void batchDeleteUserLinks(BatchDeleteUserLinksRequest request, StreamObserver<Empty> responseObserver)

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

Parameters
NameDescription
requestBatchDeleteUserLinksRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

batchGetAccessBindings(BatchGetAccessBindingsRequest request, StreamObserver<BatchGetAccessBindingsResponse> responseObserver)

public default void batchGetAccessBindings(BatchGetAccessBindingsRequest request, StreamObserver<BatchGetAccessBindingsResponse> responseObserver)

Gets information about multiple access bindings to an account or property.

Parameters
NameDescription
requestBatchGetAccessBindingsRequest
responseObserverio.grpc.stub.StreamObserver<BatchGetAccessBindingsResponse>
public default void batchGetUserLinks(BatchGetUserLinksRequest request, StreamObserver<BatchGetUserLinksResponse> responseObserver)

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

Parameters
NameDescription
requestBatchGetUserLinksRequest
responseObserverio.grpc.stub.StreamObserver<BatchGetUserLinksResponse>

batchUpdateAccessBindings(BatchUpdateAccessBindingsRequest request, StreamObserver<BatchUpdateAccessBindingsResponse> responseObserver)

public default void batchUpdateAccessBindings(BatchUpdateAccessBindingsRequest request, StreamObserver<BatchUpdateAccessBindingsResponse> responseObserver)

Updates information about multiple access bindings to an account or property.

Parameters
NameDescription
requestBatchUpdateAccessBindingsRequest
responseObserverio.grpc.stub.StreamObserver<BatchUpdateAccessBindingsResponse>
public default void batchUpdateUserLinks(BatchUpdateUserLinksRequest request, StreamObserver<BatchUpdateUserLinksResponse> responseObserver)

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

Parameters
NameDescription
requestBatchUpdateUserLinksRequest
responseObserverio.grpc.stub.StreamObserver<BatchUpdateUserLinksResponse>

cancelDisplayVideo360AdvertiserLinkProposal(CancelDisplayVideo360AdvertiserLinkProposalRequest request, StreamObserver<DisplayVideo360AdvertiserLinkProposal> responseObserver)

public default void cancelDisplayVideo360AdvertiserLinkProposal(CancelDisplayVideo360AdvertiserLinkProposalRequest request, StreamObserver<DisplayVideo360AdvertiserLinkProposal> responseObserver)

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.
Parameters
NameDescription
requestCancelDisplayVideo360AdvertiserLinkProposalRequest
responseObserverio.grpc.stub.StreamObserver<DisplayVideo360AdvertiserLinkProposal>

createAccessBinding(CreateAccessBindingRequest request, StreamObserver<AccessBinding> responseObserver)

public default void createAccessBinding(CreateAccessBindingRequest request, StreamObserver<AccessBinding> responseObserver)

Creates an access binding on an account or property.

Parameters
NameDescription
requestCreateAccessBindingRequest
responseObserverio.grpc.stub.StreamObserver<AccessBinding>

createAudience(CreateAudienceRequest request, StreamObserver<Audience> responseObserver)

public default void createAudience(CreateAudienceRequest request, StreamObserver<Audience> responseObserver)

Creates an Audience.

Parameters
NameDescription
requestCreateAudienceRequest
responseObserverio.grpc.stub.StreamObserver<Audience>

createConnectedSiteTag(CreateConnectedSiteTagRequest request, StreamObserver<CreateConnectedSiteTagResponse> responseObserver)

public default void createConnectedSiteTag(CreateConnectedSiteTagRequest request, StreamObserver<CreateConnectedSiteTagResponse> responseObserver)

Creates a connected site tag for a Universal Analytics property. You can create a maximum of 20 connected site tags per property. Note: This API cannot be used on GA4 properties.

Parameters
NameDescription
requestCreateConnectedSiteTagRequest
responseObserverio.grpc.stub.StreamObserver<CreateConnectedSiteTagResponse>

createConversionEvent(CreateConversionEventRequest request, StreamObserver<ConversionEvent> responseObserver)

public default void createConversionEvent(CreateConversionEventRequest request, StreamObserver<ConversionEvent> responseObserver)

Creates a conversion event with the specified attributes.

Parameters
NameDescription
requestCreateConversionEventRequest
responseObserverio.grpc.stub.StreamObserver<ConversionEvent>

createCustomDimension(CreateCustomDimensionRequest request, StreamObserver<CustomDimension> responseObserver)

public default void createCustomDimension(CreateCustomDimensionRequest request, StreamObserver<CustomDimension> responseObserver)

Creates a CustomDimension.

Parameters
NameDescription
requestCreateCustomDimensionRequest
responseObserverio.grpc.stub.StreamObserver<CustomDimension>

createCustomMetric(CreateCustomMetricRequest request, StreamObserver<CustomMetric> responseObserver)

public default void createCustomMetric(CreateCustomMetricRequest request, StreamObserver<CustomMetric> responseObserver)

Creates a CustomMetric.

Parameters
NameDescription
requestCreateCustomMetricRequest
responseObserverio.grpc.stub.StreamObserver<CustomMetric>

createDataStream(CreateDataStreamRequest request, StreamObserver<DataStream> responseObserver)

public default void createDataStream(CreateDataStreamRequest request, StreamObserver<DataStream> responseObserver)

Creates a DataStream.

Parameters
NameDescription
requestCreateDataStreamRequest
responseObserverio.grpc.stub.StreamObserver<DataStream>
public default void createDisplayVideo360AdvertiserLink(CreateDisplayVideo360AdvertiserLinkRequest request, StreamObserver<DisplayVideo360AdvertiserLink> responseObserver)

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.

Parameters
NameDescription
requestCreateDisplayVideo360AdvertiserLinkRequest
responseObserverio.grpc.stub.StreamObserver<DisplayVideo360AdvertiserLink>

createDisplayVideo360AdvertiserLinkProposal(CreateDisplayVideo360AdvertiserLinkProposalRequest request, StreamObserver<DisplayVideo360AdvertiserLinkProposal> responseObserver)

public default void createDisplayVideo360AdvertiserLinkProposal(CreateDisplayVideo360AdvertiserLinkProposalRequest request, StreamObserver<DisplayVideo360AdvertiserLinkProposal> responseObserver)

Creates a DisplayVideo360AdvertiserLinkProposal.

Parameters
NameDescription
requestCreateDisplayVideo360AdvertiserLinkProposalRequest
responseObserverio.grpc.stub.StreamObserver<DisplayVideo360AdvertiserLinkProposal>

createExpandedDataSet(CreateExpandedDataSetRequest request, StreamObserver<ExpandedDataSet> responseObserver)

public default void createExpandedDataSet(CreateExpandedDataSetRequest request, StreamObserver<ExpandedDataSet> responseObserver)

Creates a ExpandedDataSet.

Parameters
NameDescription
requestCreateExpandedDataSetRequest
responseObserverio.grpc.stub.StreamObserver<ExpandedDataSet>
public default void createFirebaseLink(CreateFirebaseLinkRequest request, StreamObserver<FirebaseLink> responseObserver)

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

Parameters
NameDescription
requestCreateFirebaseLinkRequest
responseObserverio.grpc.stub.StreamObserver<FirebaseLink>
public default void createGoogleAdsLink(CreateGoogleAdsLinkRequest request, StreamObserver<GoogleAdsLink> responseObserver)

Creates a GoogleAdsLink.

Parameters
NameDescription
requestCreateGoogleAdsLinkRequest
responseObserverio.grpc.stub.StreamObserver<GoogleAdsLink>

createMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest request, StreamObserver<MeasurementProtocolSecret> responseObserver)

public default void createMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest request, StreamObserver<MeasurementProtocolSecret> responseObserver)

Creates a measurement protocol secret.

Parameters
NameDescription
requestCreateMeasurementProtocolSecretRequest
responseObserverio.grpc.stub.StreamObserver<MeasurementProtocolSecret>

createProperty(CreatePropertyRequest request, StreamObserver<Property> responseObserver)

public default void createProperty(CreatePropertyRequest request, StreamObserver<Property> responseObserver)

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

Parameters
NameDescription
requestCreatePropertyRequest
responseObserverio.grpc.stub.StreamObserver<Property>
public default void createSearchAds360Link(CreateSearchAds360LinkRequest request, StreamObserver<SearchAds360Link> responseObserver)

Creates a SearchAds360Link.

Parameters
NameDescription
requestCreateSearchAds360LinkRequest
responseObserverio.grpc.stub.StreamObserver<SearchAds360Link>
public default void createUserLink(CreateUserLinkRequest request, StreamObserver<UserLink> responseObserver)

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.

Parameters
NameDescription
requestCreateUserLinkRequest
responseObserverio.grpc.stub.StreamObserver<UserLink>

deleteAccessBinding(DeleteAccessBindingRequest request, StreamObserver<Empty> responseObserver)

public default void deleteAccessBinding(DeleteAccessBindingRequest request, StreamObserver<Empty> responseObserver)

Deletes an access binding on an account or property.

Parameters
NameDescription
requestDeleteAccessBindingRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

deleteAccount(DeleteAccountRequest request, StreamObserver<Empty> responseObserver)

public default void deleteAccount(DeleteAccountRequest request, StreamObserver<Empty> responseObserver)

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.

Parameters
NameDescription
requestDeleteAccountRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

deleteConnectedSiteTag(DeleteConnectedSiteTagRequest request, StreamObserver<Empty> responseObserver)

public default void deleteConnectedSiteTag(DeleteConnectedSiteTagRequest request, StreamObserver<Empty> responseObserver)

Deletes a connected site tag for a Universal Analytics property. Note: this has no effect on GA4 properties.

Parameters
NameDescription
requestDeleteConnectedSiteTagRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

deleteConversionEvent(DeleteConversionEventRequest request, StreamObserver<Empty> responseObserver)

public default void deleteConversionEvent(DeleteConversionEventRequest request, StreamObserver<Empty> responseObserver)

Deletes a conversion event in a property.

Parameters
NameDescription
requestDeleteConversionEventRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

deleteDataStream(DeleteDataStreamRequest request, StreamObserver<Empty> responseObserver)

public default void deleteDataStream(DeleteDataStreamRequest request, StreamObserver<Empty> responseObserver)

Deletes a DataStream on a property.

Parameters
NameDescription
requestDeleteDataStreamRequest
responseObserverio.grpc.stub.StreamObserver<Empty>
public default void deleteDisplayVideo360AdvertiserLink(DeleteDisplayVideo360AdvertiserLinkRequest request, StreamObserver<Empty> responseObserver)

Deletes a DisplayVideo360AdvertiserLink on a property.

Parameters
NameDescription
requestDeleteDisplayVideo360AdvertiserLinkRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

deleteDisplayVideo360AdvertiserLinkProposal(DeleteDisplayVideo360AdvertiserLinkProposalRequest request, StreamObserver<Empty> responseObserver)

public default void deleteDisplayVideo360AdvertiserLinkProposal(DeleteDisplayVideo360AdvertiserLinkProposalRequest request, StreamObserver<Empty> responseObserver)

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

Parameters
NameDescription
requestDeleteDisplayVideo360AdvertiserLinkProposalRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

deleteExpandedDataSet(DeleteExpandedDataSetRequest request, StreamObserver<Empty> responseObserver)

public default void deleteExpandedDataSet(DeleteExpandedDataSetRequest request, StreamObserver<Empty> responseObserver)

Deletes a ExpandedDataSet on a property.

Parameters
NameDescription
requestDeleteExpandedDataSetRequest
responseObserverio.grpc.stub.StreamObserver<Empty>
public default void deleteFirebaseLink(DeleteFirebaseLinkRequest request, StreamObserver<Empty> responseObserver)

Deletes a FirebaseLink on a property

Parameters
NameDescription
requestDeleteFirebaseLinkRequest
responseObserverio.grpc.stub.StreamObserver<Empty>
public default void deleteGoogleAdsLink(DeleteGoogleAdsLinkRequest request, StreamObserver<Empty> responseObserver)

Deletes a GoogleAdsLink on a property

Parameters
NameDescription
requestDeleteGoogleAdsLinkRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

deleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest request, StreamObserver<Empty> responseObserver)

public default void deleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest request, StreamObserver<Empty> responseObserver)

Deletes target MeasurementProtocolSecret.

Parameters
NameDescription
requestDeleteMeasurementProtocolSecretRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

deleteProperty(DeletePropertyRequest request, StreamObserver<Property> responseObserver)

public default void deleteProperty(DeletePropertyRequest request, StreamObserver<Property> responseObserver)

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 a GA4 Property.

Parameters
NameDescription
requestDeletePropertyRequest
responseObserverio.grpc.stub.StreamObserver<Property>
public default void deleteSearchAds360Link(DeleteSearchAds360LinkRequest request, StreamObserver<Empty> responseObserver)

Deletes a SearchAds360Link on a property.

Parameters
NameDescription
requestDeleteSearchAds360LinkRequest
responseObserverio.grpc.stub.StreamObserver<Empty>
public default void deleteUserLink(DeleteUserLinkRequest request, StreamObserver<Empty> responseObserver)

Deletes a user link on an account or property.

Parameters
NameDescription
requestDeleteUserLinkRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

fetchAutomatedGa4ConfigurationOptOut(FetchAutomatedGa4ConfigurationOptOutRequest request, StreamObserver<FetchAutomatedGa4ConfigurationOptOutResponse> responseObserver)

public default void fetchAutomatedGa4ConfigurationOptOut(FetchAutomatedGa4ConfigurationOptOutRequest request, StreamObserver<FetchAutomatedGa4ConfigurationOptOutResponse> responseObserver)

Fetches the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property.

Parameters
NameDescription
requestFetchAutomatedGa4ConfigurationOptOutRequest
responseObserverio.grpc.stub.StreamObserver<FetchAutomatedGa4ConfigurationOptOutResponse>

getAccessBinding(GetAccessBindingRequest request, StreamObserver<AccessBinding> responseObserver)

public default void getAccessBinding(GetAccessBindingRequest request, StreamObserver<AccessBinding> responseObserver)

Gets information about an access binding.

Parameters
NameDescription
requestGetAccessBindingRequest
responseObserverio.grpc.stub.StreamObserver<AccessBinding>

getAccount(GetAccountRequest request, StreamObserver<Account> responseObserver)

public default void getAccount(GetAccountRequest request, StreamObserver<Account> responseObserver)

Lookup for a single Account.

Parameters
NameDescription
requestGetAccountRequest
responseObserverio.grpc.stub.StreamObserver<Account>

getAttributionSettings(GetAttributionSettingsRequest request, StreamObserver<AttributionSettings> responseObserver)

public default void getAttributionSettings(GetAttributionSettingsRequest request, StreamObserver<AttributionSettings> responseObserver)

Lookup for a AttributionSettings singleton.

Parameters
NameDescription
requestGetAttributionSettingsRequest
responseObserverio.grpc.stub.StreamObserver<AttributionSettings>

getAudience(GetAudienceRequest request, StreamObserver<Audience> responseObserver)

public default void getAudience(GetAudienceRequest request, StreamObserver<Audience> responseObserver)

Lookup for a single Audience. Audiences created before 2020 may not be supported. Default audiences will not show filter definitions.

Parameters
NameDescription
requestGetAudienceRequest
responseObserverio.grpc.stub.StreamObserver<Audience>
public default void getBigQueryLink(GetBigQueryLinkRequest request, StreamObserver<BigQueryLink> responseObserver)

Lookup for a single BigQuery Link.

Parameters
NameDescription
requestGetBigQueryLinkRequest
responseObserverio.grpc.stub.StreamObserver<BigQueryLink>

getConversionEvent(GetConversionEventRequest request, StreamObserver<ConversionEvent> responseObserver)

public default void getConversionEvent(GetConversionEventRequest request, StreamObserver<ConversionEvent> responseObserver)

Retrieve a single conversion event.

Parameters
NameDescription
requestGetConversionEventRequest
responseObserverio.grpc.stub.StreamObserver<ConversionEvent>

getCustomDimension(GetCustomDimensionRequest request, StreamObserver<CustomDimension> responseObserver)

public default void getCustomDimension(GetCustomDimensionRequest request, StreamObserver<CustomDimension> responseObserver)

Lookup for a single CustomDimension.

Parameters
NameDescription
requestGetCustomDimensionRequest
responseObserverio.grpc.stub.StreamObserver<CustomDimension>

getCustomMetric(GetCustomMetricRequest request, StreamObserver<CustomMetric> responseObserver)

public default void getCustomMetric(GetCustomMetricRequest request, StreamObserver<CustomMetric> responseObserver)

Lookup for a single CustomMetric.

Parameters
NameDescription
requestGetCustomMetricRequest
responseObserverio.grpc.stub.StreamObserver<CustomMetric>

getDataRetentionSettings(GetDataRetentionSettingsRequest request, StreamObserver<DataRetentionSettings> responseObserver)

public default void getDataRetentionSettings(GetDataRetentionSettingsRequest request, StreamObserver<DataRetentionSettings> responseObserver)

Returns the singleton data retention settings for this property.

Parameters
NameDescription
requestGetDataRetentionSettingsRequest
responseObserverio.grpc.stub.StreamObserver<DataRetentionSettings>

getDataSharingSettings(GetDataSharingSettingsRequest request, StreamObserver<DataSharingSettings> responseObserver)

public default void getDataSharingSettings(GetDataSharingSettingsRequest request, StreamObserver<DataSharingSettings> responseObserver)

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

Parameters
NameDescription
requestGetDataSharingSettingsRequest
responseObserverio.grpc.stub.StreamObserver<DataSharingSettings>

getDataStream(GetDataStreamRequest request, StreamObserver<DataStream> responseObserver)

public default void getDataStream(GetDataStreamRequest request, StreamObserver<DataStream> responseObserver)

Lookup for a single DataStream.

Parameters
NameDescription
requestGetDataStreamRequest
responseObserverio.grpc.stub.StreamObserver<DataStream>
public default void getDisplayVideo360AdvertiserLink(GetDisplayVideo360AdvertiserLinkRequest request, StreamObserver<DisplayVideo360AdvertiserLink> responseObserver)

Look up a single DisplayVideo360AdvertiserLink

Parameters
NameDescription
requestGetDisplayVideo360AdvertiserLinkRequest
responseObserverio.grpc.stub.StreamObserver<DisplayVideo360AdvertiserLink>

getDisplayVideo360AdvertiserLinkProposal(GetDisplayVideo360AdvertiserLinkProposalRequest request, StreamObserver<DisplayVideo360AdvertiserLinkProposal> responseObserver)

public default void getDisplayVideo360AdvertiserLinkProposal(GetDisplayVideo360AdvertiserLinkProposalRequest request, StreamObserver<DisplayVideo360AdvertiserLinkProposal> responseObserver)

Lookup for a single DisplayVideo360AdvertiserLinkProposal.

Parameters
NameDescription
requestGetDisplayVideo360AdvertiserLinkProposalRequest
responseObserverio.grpc.stub.StreamObserver<DisplayVideo360AdvertiserLinkProposal>

getEnhancedMeasurementSettings(GetEnhancedMeasurementSettingsRequest request, StreamObserver<EnhancedMeasurementSettings> responseObserver)

public default void getEnhancedMeasurementSettings(GetEnhancedMeasurementSettingsRequest request, StreamObserver<EnhancedMeasurementSettings> responseObserver)

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

Parameters
NameDescription
requestGetEnhancedMeasurementSettingsRequest
responseObserverio.grpc.stub.StreamObserver<EnhancedMeasurementSettings>

getExpandedDataSet(GetExpandedDataSetRequest request, StreamObserver<ExpandedDataSet> responseObserver)

public default void getExpandedDataSet(GetExpandedDataSetRequest request, StreamObserver<ExpandedDataSet> responseObserver)

Lookup for a single ExpandedDataSet.

Parameters
NameDescription
requestGetExpandedDataSetRequest
responseObserverio.grpc.stub.StreamObserver<ExpandedDataSet>

getGlobalSiteTag(GetGlobalSiteTagRequest request, StreamObserver<GlobalSiteTag> responseObserver)

public default void getGlobalSiteTag(GetGlobalSiteTagRequest request, StreamObserver<GlobalSiteTag> responseObserver)

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

Parameters
NameDescription
requestGetGlobalSiteTagRequest
responseObserverio.grpc.stub.StreamObserver<GlobalSiteTag>

getGoogleSignalsSettings(GetGoogleSignalsSettingsRequest request, StreamObserver<GoogleSignalsSettings> responseObserver)

public default void getGoogleSignalsSettings(GetGoogleSignalsSettingsRequest request, StreamObserver<GoogleSignalsSettings> responseObserver)

Lookup for Google Signals settings for a property.

Parameters
NameDescription
requestGetGoogleSignalsSettingsRequest
responseObserverio.grpc.stub.StreamObserver<GoogleSignalsSettings>

getMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest request, StreamObserver<MeasurementProtocolSecret> responseObserver)

public default void getMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest request, StreamObserver<MeasurementProtocolSecret> responseObserver)

Lookup for a single "GA4" MeasurementProtocolSecret.

Parameters
NameDescription
requestGetMeasurementProtocolSecretRequest
responseObserverio.grpc.stub.StreamObserver<MeasurementProtocolSecret>

getProperty(GetPropertyRequest request, StreamObserver<Property> responseObserver)

public default void getProperty(GetPropertyRequest request, StreamObserver<Property> responseObserver)

Lookup for a single "GA4" Property.

Parameters
NameDescription
requestGetPropertyRequest
responseObserverio.grpc.stub.StreamObserver<Property>
public default void getSearchAds360Link(GetSearchAds360LinkRequest request, StreamObserver<SearchAds360Link> responseObserver)

Look up a single SearchAds360Link

Parameters
NameDescription
requestGetSearchAds360LinkRequest
responseObserverio.grpc.stub.StreamObserver<SearchAds360Link>
public default void getUserLink(GetUserLinkRequest request, StreamObserver<UserLink> responseObserver)

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

Parameters
NameDescription
requestGetUserLinkRequest
responseObserverio.grpc.stub.StreamObserver<UserLink>

listAccessBindings(ListAccessBindingsRequest request, StreamObserver<ListAccessBindingsResponse> responseObserver)

public default void listAccessBindings(ListAccessBindingsRequest request, StreamObserver<ListAccessBindingsResponse> responseObserver)

Lists all access bindings on an account or property.

Parameters
NameDescription
requestListAccessBindingsRequest
responseObserverio.grpc.stub.StreamObserver<ListAccessBindingsResponse>

listAccountSummaries(ListAccountSummariesRequest request, StreamObserver<ListAccountSummariesResponse> responseObserver)

public default void listAccountSummaries(ListAccountSummariesRequest request, StreamObserver<ListAccountSummariesResponse> responseObserver)

Returns summaries of all accounts accessible by the caller.

Parameters
NameDescription
requestListAccountSummariesRequest
responseObserverio.grpc.stub.StreamObserver<ListAccountSummariesResponse>

listAccounts(ListAccountsRequest request, StreamObserver<ListAccountsResponse> responseObserver)

public default void listAccounts(ListAccountsRequest request, StreamObserver<ListAccountsResponse> responseObserver)

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.

Parameters
NameDescription
requestListAccountsRequest
responseObserverio.grpc.stub.StreamObserver<ListAccountsResponse>

listAudiences(ListAudiencesRequest request, StreamObserver<ListAudiencesResponse> responseObserver)

public default void listAudiences(ListAudiencesRequest request, StreamObserver<ListAudiencesResponse> responseObserver)

Lists Audiences on a property. Audiences created before 2020 may not be supported. Default audiences will not show filter definitions.

Parameters
NameDescription
requestListAudiencesRequest
responseObserverio.grpc.stub.StreamObserver<ListAudiencesResponse>
public default void listBigQueryLinks(ListBigQueryLinksRequest request, StreamObserver<ListBigQueryLinksResponse> responseObserver)

Lists BigQuery Links on a property.

Parameters
NameDescription
requestListBigQueryLinksRequest
responseObserverio.grpc.stub.StreamObserver<ListBigQueryLinksResponse>

listConnectedSiteTags(ListConnectedSiteTagsRequest request, StreamObserver<ListConnectedSiteTagsResponse> responseObserver)

public default void listConnectedSiteTags(ListConnectedSiteTagsRequest request, StreamObserver<ListConnectedSiteTagsResponse> responseObserver)

Lists the connected site tags for a Universal Analytics property. A maximum of 20 connected site tags will be returned. Note: this has no effect on GA4 property.

Parameters
NameDescription
requestListConnectedSiteTagsRequest
responseObserverio.grpc.stub.StreamObserver<ListConnectedSiteTagsResponse>

listConversionEvents(ListConversionEventsRequest request, StreamObserver<ListConversionEventsResponse> responseObserver)

public default void listConversionEvents(ListConversionEventsRequest request, StreamObserver<ListConversionEventsResponse> responseObserver)

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

Parameters
NameDescription
requestListConversionEventsRequest
responseObserverio.grpc.stub.StreamObserver<ListConversionEventsResponse>

listCustomDimensions(ListCustomDimensionsRequest request, StreamObserver<ListCustomDimensionsResponse> responseObserver)

public default void listCustomDimensions(ListCustomDimensionsRequest request, StreamObserver<ListCustomDimensionsResponse> responseObserver)

Lists CustomDimensions on a property.

Parameters
NameDescription
requestListCustomDimensionsRequest
responseObserverio.grpc.stub.StreamObserver<ListCustomDimensionsResponse>

listCustomMetrics(ListCustomMetricsRequest request, StreamObserver<ListCustomMetricsResponse> responseObserver)

public default void listCustomMetrics(ListCustomMetricsRequest request, StreamObserver<ListCustomMetricsResponse> responseObserver)

Lists CustomMetrics on a property.

Parameters
NameDescription
requestListCustomMetricsRequest
responseObserverio.grpc.stub.StreamObserver<ListCustomMetricsResponse>

listDataStreams(ListDataStreamsRequest request, StreamObserver<ListDataStreamsResponse> responseObserver)

public default void listDataStreams(ListDataStreamsRequest request, StreamObserver<ListDataStreamsResponse> responseObserver)

Lists DataStreams on a property.

Parameters
NameDescription
requestListDataStreamsRequest
responseObserverio.grpc.stub.StreamObserver<ListDataStreamsResponse>

listDisplayVideo360AdvertiserLinkProposals(ListDisplayVideo360AdvertiserLinkProposalsRequest request, StreamObserver<ListDisplayVideo360AdvertiserLinkProposalsResponse> responseObserver)

public default void listDisplayVideo360AdvertiserLinkProposals(ListDisplayVideo360AdvertiserLinkProposalsRequest request, StreamObserver<ListDisplayVideo360AdvertiserLinkProposalsResponse> responseObserver)

Lists DisplayVideo360AdvertiserLinkProposals on a property.

Parameters
NameDescription
requestListDisplayVideo360AdvertiserLinkProposalsRequest
responseObserverio.grpc.stub.StreamObserver<ListDisplayVideo360AdvertiserLinkProposalsResponse>
public default void listDisplayVideo360AdvertiserLinks(ListDisplayVideo360AdvertiserLinksRequest request, StreamObserver<ListDisplayVideo360AdvertiserLinksResponse> responseObserver)

Lists all DisplayVideo360AdvertiserLinks on a property.

Parameters
NameDescription
requestListDisplayVideo360AdvertiserLinksRequest
responseObserverio.grpc.stub.StreamObserver<ListDisplayVideo360AdvertiserLinksResponse>

listExpandedDataSets(ListExpandedDataSetsRequest request, StreamObserver<ListExpandedDataSetsResponse> responseObserver)

public default void listExpandedDataSets(ListExpandedDataSetsRequest request, StreamObserver<ListExpandedDataSetsResponse> responseObserver)

Lists ExpandedDataSets on a property.

Parameters
NameDescription
requestListExpandedDataSetsRequest
responseObserverio.grpc.stub.StreamObserver<ListExpandedDataSetsResponse>
public default void listFirebaseLinks(ListFirebaseLinksRequest request, StreamObserver<ListFirebaseLinksResponse> responseObserver)

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

Parameters
NameDescription
requestListFirebaseLinksRequest
responseObserverio.grpc.stub.StreamObserver<ListFirebaseLinksResponse>
public default void listGoogleAdsLinks(ListGoogleAdsLinksRequest request, StreamObserver<ListGoogleAdsLinksResponse> responseObserver)

Lists GoogleAdsLinks on a property.

Parameters
NameDescription
requestListGoogleAdsLinksRequest
responseObserverio.grpc.stub.StreamObserver<ListGoogleAdsLinksResponse>

listMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest request, StreamObserver<ListMeasurementProtocolSecretsResponse> responseObserver)

public default void listMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest request, StreamObserver<ListMeasurementProtocolSecretsResponse> responseObserver)

Returns child MeasurementProtocolSecrets under the specified parent Property.

Parameters
NameDescription
requestListMeasurementProtocolSecretsRequest
responseObserverio.grpc.stub.StreamObserver<ListMeasurementProtocolSecretsResponse>

listProperties(ListPropertiesRequest request, StreamObserver<ListPropertiesResponse> responseObserver)

public default void listProperties(ListPropertiesRequest request, StreamObserver<ListPropertiesResponse> responseObserver)

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.

Parameters
NameDescription
requestListPropertiesRequest
responseObserverio.grpc.stub.StreamObserver<ListPropertiesResponse>
public default void listSearchAds360Links(ListSearchAds360LinksRequest request, StreamObserver<ListSearchAds360LinksResponse> responseObserver)

Lists all SearchAds360Links on a property.

Parameters
NameDescription
requestListSearchAds360LinksRequest
responseObserverio.grpc.stub.StreamObserver<ListSearchAds360LinksResponse>
public default void listUserLinks(ListUserLinksRequest request, StreamObserver<ListUserLinksResponse> responseObserver)

Lists all user links on an account or property.

Parameters
NameDescription
requestListUserLinksRequest
responseObserverio.grpc.stub.StreamObserver<ListUserLinksResponse>

provisionAccountTicket(ProvisionAccountTicketRequest request, StreamObserver<ProvisionAccountTicketResponse> responseObserver)

public default void provisionAccountTicket(ProvisionAccountTicketRequest request, StreamObserver<ProvisionAccountTicketResponse> responseObserver)

Requests a ticket for creating an account.

Parameters
NameDescription
requestProvisionAccountTicketRequest
responseObserverio.grpc.stub.StreamObserver<ProvisionAccountTicketResponse>

runAccessReport(RunAccessReportRequest request, StreamObserver<RunAccessReportResponse> responseObserver)

public default void runAccessReport(RunAccessReportRequest request, StreamObserver<RunAccessReportResponse> responseObserver)

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

Parameters
NameDescription
requestRunAccessReportRequest
responseObserverio.grpc.stub.StreamObserver<RunAccessReportResponse>

searchChangeHistoryEvents(SearchChangeHistoryEventsRequest request, StreamObserver<SearchChangeHistoryEventsResponse> responseObserver)

public default void searchChangeHistoryEvents(SearchChangeHistoryEventsRequest request, StreamObserver<SearchChangeHistoryEventsResponse> responseObserver)

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

Parameters
NameDescription
requestSearchChangeHistoryEventsRequest
responseObserverio.grpc.stub.StreamObserver<SearchChangeHistoryEventsResponse>

setAutomatedGa4ConfigurationOptOut(SetAutomatedGa4ConfigurationOptOutRequest request, StreamObserver<SetAutomatedGa4ConfigurationOptOutResponse> responseObserver)

public default void setAutomatedGa4ConfigurationOptOut(SetAutomatedGa4ConfigurationOptOutRequest request, StreamObserver<SetAutomatedGa4ConfigurationOptOutResponse> responseObserver)

Sets the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property.

Parameters
NameDescription
requestSetAutomatedGa4ConfigurationOptOutRequest
responseObserverio.grpc.stub.StreamObserver<SetAutomatedGa4ConfigurationOptOutResponse>

updateAccessBinding(UpdateAccessBindingRequest request, StreamObserver<AccessBinding> responseObserver)

public default void updateAccessBinding(UpdateAccessBindingRequest request, StreamObserver<AccessBinding> responseObserver)

Updates an access binding on an account or property.

Parameters
NameDescription
requestUpdateAccessBindingRequest
responseObserverio.grpc.stub.StreamObserver<AccessBinding>

updateAccount(UpdateAccountRequest request, StreamObserver<Account> responseObserver)

public default void updateAccount(UpdateAccountRequest request, StreamObserver<Account> responseObserver)

Updates an account.

Parameters
NameDescription
requestUpdateAccountRequest
responseObserverio.grpc.stub.StreamObserver<Account>

updateAttributionSettings(UpdateAttributionSettingsRequest request, StreamObserver<AttributionSettings> responseObserver)

public default void updateAttributionSettings(UpdateAttributionSettingsRequest request, StreamObserver<AttributionSettings> responseObserver)

Updates attribution settings on a property.

Parameters
NameDescription
requestUpdateAttributionSettingsRequest
responseObserverio.grpc.stub.StreamObserver<AttributionSettings>

updateAudience(UpdateAudienceRequest request, StreamObserver<Audience> responseObserver)

public default void updateAudience(UpdateAudienceRequest request, StreamObserver<Audience> responseObserver)

Updates an Audience on a property.

Parameters
NameDescription
requestUpdateAudienceRequest
responseObserverio.grpc.stub.StreamObserver<Audience>

updateCustomDimension(UpdateCustomDimensionRequest request, StreamObserver<CustomDimension> responseObserver)

public default void updateCustomDimension(UpdateCustomDimensionRequest request, StreamObserver<CustomDimension> responseObserver)

Updates a CustomDimension on a property.

Parameters
NameDescription
requestUpdateCustomDimensionRequest
responseObserverio.grpc.stub.StreamObserver<CustomDimension>

updateCustomMetric(UpdateCustomMetricRequest request, StreamObserver<CustomMetric> responseObserver)

public default void updateCustomMetric(UpdateCustomMetricRequest request, StreamObserver<CustomMetric> responseObserver)

Updates a CustomMetric on a property.

Parameters
NameDescription
requestUpdateCustomMetricRequest
responseObserverio.grpc.stub.StreamObserver<CustomMetric>

updateDataRetentionSettings(UpdateDataRetentionSettingsRequest request, StreamObserver<DataRetentionSettings> responseObserver)

public default void updateDataRetentionSettings(UpdateDataRetentionSettingsRequest request, StreamObserver<DataRetentionSettings> responseObserver)

Updates the singleton data retention settings for this property.

Parameters
NameDescription
requestUpdateDataRetentionSettingsRequest
responseObserverio.grpc.stub.StreamObserver<DataRetentionSettings>

updateDataStream(UpdateDataStreamRequest request, StreamObserver<DataStream> responseObserver)

public default void updateDataStream(UpdateDataStreamRequest request, StreamObserver<DataStream> responseObserver)

Updates a DataStream on a property.

Parameters
NameDescription
requestUpdateDataStreamRequest
responseObserverio.grpc.stub.StreamObserver<DataStream>
public default void updateDisplayVideo360AdvertiserLink(UpdateDisplayVideo360AdvertiserLinkRequest request, StreamObserver<DisplayVideo360AdvertiserLink> responseObserver)

Updates a DisplayVideo360AdvertiserLink on a property.

Parameters
NameDescription
requestUpdateDisplayVideo360AdvertiserLinkRequest
responseObserverio.grpc.stub.StreamObserver<DisplayVideo360AdvertiserLink>

updateEnhancedMeasurementSettings(UpdateEnhancedMeasurementSettingsRequest request, StreamObserver<EnhancedMeasurementSettings> responseObserver)

public default void updateEnhancedMeasurementSettings(UpdateEnhancedMeasurementSettingsRequest request, StreamObserver<EnhancedMeasurementSettings> responseObserver)

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

Parameters
NameDescription
requestUpdateEnhancedMeasurementSettingsRequest
responseObserverio.grpc.stub.StreamObserver<EnhancedMeasurementSettings>

updateExpandedDataSet(UpdateExpandedDataSetRequest request, StreamObserver<ExpandedDataSet> responseObserver)

public default void updateExpandedDataSet(UpdateExpandedDataSetRequest request, StreamObserver<ExpandedDataSet> responseObserver)

Updates a ExpandedDataSet on a property.

Parameters
NameDescription
requestUpdateExpandedDataSetRequest
responseObserverio.grpc.stub.StreamObserver<ExpandedDataSet>
public default void updateGoogleAdsLink(UpdateGoogleAdsLinkRequest request, StreamObserver<GoogleAdsLink> responseObserver)

Updates a GoogleAdsLink on a property

Parameters
NameDescription
requestUpdateGoogleAdsLinkRequest
responseObserverio.grpc.stub.StreamObserver<GoogleAdsLink>

updateGoogleSignalsSettings(UpdateGoogleSignalsSettingsRequest request, StreamObserver<GoogleSignalsSettings> responseObserver)

public default void updateGoogleSignalsSettings(UpdateGoogleSignalsSettingsRequest request, StreamObserver<GoogleSignalsSettings> responseObserver)

Updates Google Signals settings for a property.

Parameters
NameDescription
requestUpdateGoogleSignalsSettingsRequest
responseObserverio.grpc.stub.StreamObserver<GoogleSignalsSettings>

updateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest request, StreamObserver<MeasurementProtocolSecret> responseObserver)

public default void updateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest request, StreamObserver<MeasurementProtocolSecret> responseObserver)

Updates a measurement protocol secret.

Parameters
NameDescription
requestUpdateMeasurementProtocolSecretRequest
responseObserverio.grpc.stub.StreamObserver<MeasurementProtocolSecret>

updateProperty(UpdatePropertyRequest request, StreamObserver<Property> responseObserver)

public default void updateProperty(UpdatePropertyRequest request, StreamObserver<Property> responseObserver)

Updates a property.

Parameters
NameDescription
requestUpdatePropertyRequest
responseObserverio.grpc.stub.StreamObserver<Property>
public default void updateSearchAds360Link(UpdateSearchAds360LinkRequest request, StreamObserver<SearchAds360Link> responseObserver)

Updates a SearchAds360Link on a property.

Parameters
NameDescription
requestUpdateSearchAds360LinkRequest
responseObserverio.grpc.stub.StreamObserver<SearchAds360Link>
public default void updateUserLink(UpdateUserLinkRequest request, StreamObserver<UserLink> responseObserver)

Updates a user link on an account or property.

Parameters
NameDescription
requestUpdateUserLinkRequest
responseObserverio.grpc.stub.StreamObserver<UserLink>