Class AnalyticsAdminServiceGrpc.AnalyticsAdminServiceFutureStub (0.27.0)

public static final class AnalyticsAdminServiceGrpc.AnalyticsAdminServiceFutureStub extends AbstractFutureStub<AnalyticsAdminServiceGrpc.AnalyticsAdminServiceFutureStub>

A stub to allow clients to do ListenableFuture-style rpc calls to service AnalyticsAdminService.

Service Interface for the Analytics Admin API (GA4).

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > AnalyticsAdminServiceGrpc.AnalyticsAdminServiceFutureStub

Methods

acknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest request)

public ListenableFuture<AcknowledgeUserDataCollectionResponse> acknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest request)

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.

Parameter
NameDescription
requestAcknowledgeUserDataCollectionRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<AcknowledgeUserDataCollectionResponse>

approveDisplayVideo360AdvertiserLinkProposal(ApproveDisplayVideo360AdvertiserLinkProposalRequest request)

public ListenableFuture<ApproveDisplayVideo360AdvertiserLinkProposalResponse> approveDisplayVideo360AdvertiserLinkProposal(ApproveDisplayVideo360AdvertiserLinkProposalRequest request)

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

Parameter
NameDescription
requestApproveDisplayVideo360AdvertiserLinkProposalRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ApproveDisplayVideo360AdvertiserLinkProposalResponse>

archiveAudience(ArchiveAudienceRequest request)

public ListenableFuture<Empty> archiveAudience(ArchiveAudienceRequest request)

Archives an Audience on a property.

Parameter
NameDescription
requestArchiveAudienceRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

archiveCustomDimension(ArchiveCustomDimensionRequest request)

public ListenableFuture<Empty> archiveCustomDimension(ArchiveCustomDimensionRequest request)

Archives a CustomDimension on a property.

Parameter
NameDescription
requestArchiveCustomDimensionRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

archiveCustomMetric(ArchiveCustomMetricRequest request)

public ListenableFuture<Empty> archiveCustomMetric(ArchiveCustomMetricRequest request)

Archives a CustomMetric on a property.

Parameter
NameDescription
requestArchiveCustomMetricRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>
public ListenableFuture<AuditUserLinksResponse> auditUserLinks(AuditUserLinksRequest request)

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.

Parameter
NameDescription
requestAuditUserLinksRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<AuditUserLinksResponse>

batchCreateAccessBindings(BatchCreateAccessBindingsRequest request)

public ListenableFuture<BatchCreateAccessBindingsResponse> batchCreateAccessBindings(BatchCreateAccessBindingsRequest request)

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.

Parameter
NameDescription
requestBatchCreateAccessBindingsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<BatchCreateAccessBindingsResponse>
public ListenableFuture<BatchCreateUserLinksResponse> batchCreateUserLinks(BatchCreateUserLinksRequest request)

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.

Parameter
NameDescription
requestBatchCreateUserLinksRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<BatchCreateUserLinksResponse>

batchDeleteAccessBindings(BatchDeleteAccessBindingsRequest request)

public ListenableFuture<Empty> batchDeleteAccessBindings(BatchDeleteAccessBindingsRequest request)

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

Parameter
NameDescription
requestBatchDeleteAccessBindingsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>
public ListenableFuture<Empty> batchDeleteUserLinks(BatchDeleteUserLinksRequest request)

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

Parameter
NameDescription
requestBatchDeleteUserLinksRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

batchGetAccessBindings(BatchGetAccessBindingsRequest request)

public ListenableFuture<BatchGetAccessBindingsResponse> batchGetAccessBindings(BatchGetAccessBindingsRequest request)

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

Parameter
NameDescription
requestBatchGetAccessBindingsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<BatchGetAccessBindingsResponse>
public ListenableFuture<BatchGetUserLinksResponse> batchGetUserLinks(BatchGetUserLinksRequest request)

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

Parameter
NameDescription
requestBatchGetUserLinksRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<BatchGetUserLinksResponse>

batchUpdateAccessBindings(BatchUpdateAccessBindingsRequest request)

public ListenableFuture<BatchUpdateAccessBindingsResponse> batchUpdateAccessBindings(BatchUpdateAccessBindingsRequest request)

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

Parameter
NameDescription
requestBatchUpdateAccessBindingsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<BatchUpdateAccessBindingsResponse>
public ListenableFuture<BatchUpdateUserLinksResponse> batchUpdateUserLinks(BatchUpdateUserLinksRequest request)

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

Parameter
NameDescription
requestBatchUpdateUserLinksRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<BatchUpdateUserLinksResponse>

build(Channel channel, CallOptions callOptions)

protected AnalyticsAdminServiceGrpc.AnalyticsAdminServiceFutureStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
AnalyticsAdminServiceGrpc.AnalyticsAdminServiceFutureStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

cancelDisplayVideo360AdvertiserLinkProposal(CancelDisplayVideo360AdvertiserLinkProposalRequest request)

public ListenableFuture<DisplayVideo360AdvertiserLinkProposal> cancelDisplayVideo360AdvertiserLinkProposal(CancelDisplayVideo360AdvertiserLinkProposalRequest request)

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.
Parameter
NameDescription
requestCancelDisplayVideo360AdvertiserLinkProposalRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<DisplayVideo360AdvertiserLinkProposal>

createAccessBinding(CreateAccessBindingRequest request)

public ListenableFuture<AccessBinding> createAccessBinding(CreateAccessBindingRequest request)

Creates an access binding on an account or property.

Parameter
NameDescription
requestCreateAccessBindingRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<AccessBinding>

createAudience(CreateAudienceRequest request)

public ListenableFuture<Audience> createAudience(CreateAudienceRequest request)

Creates an Audience.

Parameter
NameDescription
requestCreateAudienceRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Audience>

createChannelGroup(CreateChannelGroupRequest request)

public ListenableFuture<ChannelGroup> createChannelGroup(CreateChannelGroupRequest request)

Creates a ChannelGroup.

Parameter
NameDescription
requestCreateChannelGroupRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ChannelGroup>

createConnectedSiteTag(CreateConnectedSiteTagRequest request)

public ListenableFuture<CreateConnectedSiteTagResponse> createConnectedSiteTag(CreateConnectedSiteTagRequest request)

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.

Parameter
NameDescription
requestCreateConnectedSiteTagRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<CreateConnectedSiteTagResponse>

createConversionEvent(CreateConversionEventRequest request)

public ListenableFuture<ConversionEvent> createConversionEvent(CreateConversionEventRequest request)

Creates a conversion event with the specified attributes.

Parameter
NameDescription
requestCreateConversionEventRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ConversionEvent>

createCustomDimension(CreateCustomDimensionRequest request)

public ListenableFuture<CustomDimension> createCustomDimension(CreateCustomDimensionRequest request)

Creates a CustomDimension.

Parameter
NameDescription
requestCreateCustomDimensionRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<CustomDimension>

createCustomMetric(CreateCustomMetricRequest request)

public ListenableFuture<CustomMetric> createCustomMetric(CreateCustomMetricRequest request)

Creates a CustomMetric.

Parameter
NameDescription
requestCreateCustomMetricRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<CustomMetric>

createDataStream(CreateDataStreamRequest request)

public ListenableFuture<DataStream> createDataStream(CreateDataStreamRequest request)

Creates a DataStream.

Parameter
NameDescription
requestCreateDataStreamRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<DataStream>
public ListenableFuture<DisplayVideo360AdvertiserLink> createDisplayVideo360AdvertiserLink(CreateDisplayVideo360AdvertiserLinkRequest request)

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.

Parameter
NameDescription
requestCreateDisplayVideo360AdvertiserLinkRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<DisplayVideo360AdvertiserLink>

createDisplayVideo360AdvertiserLinkProposal(CreateDisplayVideo360AdvertiserLinkProposalRequest request)

public ListenableFuture<DisplayVideo360AdvertiserLinkProposal> createDisplayVideo360AdvertiserLinkProposal(CreateDisplayVideo360AdvertiserLinkProposalRequest request)

Creates a DisplayVideo360AdvertiserLinkProposal.

Parameter
NameDescription
requestCreateDisplayVideo360AdvertiserLinkProposalRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<DisplayVideo360AdvertiserLinkProposal>

createExpandedDataSet(CreateExpandedDataSetRequest request)

public ListenableFuture<ExpandedDataSet> createExpandedDataSet(CreateExpandedDataSetRequest request)

Creates a ExpandedDataSet.

Parameter
NameDescription
requestCreateExpandedDataSetRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ExpandedDataSet>
public ListenableFuture<FirebaseLink> createFirebaseLink(CreateFirebaseLinkRequest request)

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

Parameter
NameDescription
requestCreateFirebaseLinkRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<FirebaseLink>
public ListenableFuture<GoogleAdsLink> createGoogleAdsLink(CreateGoogleAdsLinkRequest request)

Creates a GoogleAdsLink.

Parameter
NameDescription
requestCreateGoogleAdsLinkRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<GoogleAdsLink>

createMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest request)

public ListenableFuture<MeasurementProtocolSecret> createMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest request)

Creates a measurement protocol secret.

Parameter
NameDescription
requestCreateMeasurementProtocolSecretRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<MeasurementProtocolSecret>

createProperty(CreatePropertyRequest request)

public ListenableFuture<Property> createProperty(CreatePropertyRequest request)

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

Parameter
NameDescription
requestCreatePropertyRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Property>
public ListenableFuture<SearchAds360Link> createSearchAds360Link(CreateSearchAds360LinkRequest request)

Creates a SearchAds360Link.

Parameter
NameDescription
requestCreateSearchAds360LinkRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<SearchAds360Link>
public ListenableFuture<UserLink> createUserLink(CreateUserLinkRequest request)

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.

Parameter
NameDescription
requestCreateUserLinkRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<UserLink>

deleteAccessBinding(DeleteAccessBindingRequest request)

public ListenableFuture<Empty> deleteAccessBinding(DeleteAccessBindingRequest request)

Deletes an access binding on an account or property.

Parameter
NameDescription
requestDeleteAccessBindingRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteAccount(DeleteAccountRequest request)

public ListenableFuture<Empty> deleteAccount(DeleteAccountRequest request)

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.

Parameter
NameDescription
requestDeleteAccountRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteChannelGroup(DeleteChannelGroupRequest request)

public ListenableFuture<Empty> deleteChannelGroup(DeleteChannelGroupRequest request)

Deletes a ChannelGroup on a property.

Parameter
NameDescription
requestDeleteChannelGroupRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteConnectedSiteTag(DeleteConnectedSiteTagRequest request)

public ListenableFuture<Empty> deleteConnectedSiteTag(DeleteConnectedSiteTagRequest request)

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

Parameter
NameDescription
requestDeleteConnectedSiteTagRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteConversionEvent(DeleteConversionEventRequest request)

public ListenableFuture<Empty> deleteConversionEvent(DeleteConversionEventRequest request)

Deletes a conversion event in a property.

Parameter
NameDescription
requestDeleteConversionEventRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteDataStream(DeleteDataStreamRequest request)

public ListenableFuture<Empty> deleteDataStream(DeleteDataStreamRequest request)

Deletes a DataStream on a property.

Parameter
NameDescription
requestDeleteDataStreamRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>
public ListenableFuture<Empty> deleteDisplayVideo360AdvertiserLink(DeleteDisplayVideo360AdvertiserLinkRequest request)

Deletes a DisplayVideo360AdvertiserLink on a property.

Parameter
NameDescription
requestDeleteDisplayVideo360AdvertiserLinkRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteDisplayVideo360AdvertiserLinkProposal(DeleteDisplayVideo360AdvertiserLinkProposalRequest request)

public ListenableFuture<Empty> deleteDisplayVideo360AdvertiserLinkProposal(DeleteDisplayVideo360AdvertiserLinkProposalRequest request)

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

Parameter
NameDescription
requestDeleteDisplayVideo360AdvertiserLinkProposalRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteExpandedDataSet(DeleteExpandedDataSetRequest request)

public ListenableFuture<Empty> deleteExpandedDataSet(DeleteExpandedDataSetRequest request)

Deletes a ExpandedDataSet on a property.

Parameter
NameDescription
requestDeleteExpandedDataSetRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>
public ListenableFuture<Empty> deleteFirebaseLink(DeleteFirebaseLinkRequest request)

Deletes a FirebaseLink on a property

Parameter
NameDescription
requestDeleteFirebaseLinkRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>
public ListenableFuture<Empty> deleteGoogleAdsLink(DeleteGoogleAdsLinkRequest request)

Deletes a GoogleAdsLink on a property

Parameter
NameDescription
requestDeleteGoogleAdsLinkRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest request)

public ListenableFuture<Empty> deleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest request)

Deletes target MeasurementProtocolSecret.

Parameter
NameDescription
requestDeleteMeasurementProtocolSecretRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteProperty(DeletePropertyRequest request)

public ListenableFuture<Property> deleteProperty(DeletePropertyRequest request)

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.

Parameter
NameDescription
requestDeletePropertyRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Property>
public ListenableFuture<Empty> deleteSearchAds360Link(DeleteSearchAds360LinkRequest request)

Deletes a SearchAds360Link on a property.

Parameter
NameDescription
requestDeleteSearchAds360LinkRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>
public ListenableFuture<Empty> deleteUserLink(DeleteUserLinkRequest request)

Deletes a user link on an account or property.

Parameter
NameDescription
requestDeleteUserLinkRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

fetchAutomatedGa4ConfigurationOptOut(FetchAutomatedGa4ConfigurationOptOutRequest request)

public ListenableFuture<FetchAutomatedGa4ConfigurationOptOutResponse> fetchAutomatedGa4ConfigurationOptOut(FetchAutomatedGa4ConfigurationOptOutRequest request)

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

Parameter
NameDescription
requestFetchAutomatedGa4ConfigurationOptOutRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<FetchAutomatedGa4ConfigurationOptOutResponse>

fetchConnectedGa4Property(FetchConnectedGa4PropertyRequest request)

public ListenableFuture<FetchConnectedGa4PropertyResponse> fetchConnectedGa4Property(FetchConnectedGa4PropertyRequest request)

Given a specified UA property, looks up the GA4 property connected to it. Note: this cannot be used with GA4 properties.

Parameter
NameDescription
requestFetchConnectedGa4PropertyRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<FetchConnectedGa4PropertyResponse>

getAccessBinding(GetAccessBindingRequest request)

public ListenableFuture<AccessBinding> getAccessBinding(GetAccessBindingRequest request)

Gets information about an access binding.

Parameter
NameDescription
requestGetAccessBindingRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<AccessBinding>

getAccount(GetAccountRequest request)

public ListenableFuture<Account> getAccount(GetAccountRequest request)

Lookup for a single Account.

Parameter
NameDescription
requestGetAccountRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Account>

getAttributionSettings(GetAttributionSettingsRequest request)

public ListenableFuture<AttributionSettings> getAttributionSettings(GetAttributionSettingsRequest request)

Lookup for a AttributionSettings singleton.

Parameter
NameDescription
requestGetAttributionSettingsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<AttributionSettings>

getAudience(GetAudienceRequest request)

public ListenableFuture<Audience> getAudience(GetAudienceRequest request)

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

Parameter
NameDescription
requestGetAudienceRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Audience>
public ListenableFuture<BigQueryLink> getBigQueryLink(GetBigQueryLinkRequest request)

Lookup for a single BigQuery Link.

Parameter
NameDescription
requestGetBigQueryLinkRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<BigQueryLink>

getChannelGroup(GetChannelGroupRequest request)

public ListenableFuture<ChannelGroup> getChannelGroup(GetChannelGroupRequest request)

Lookup for a single ChannelGroup.

Parameter
NameDescription
requestGetChannelGroupRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ChannelGroup>

getConversionEvent(GetConversionEventRequest request)

public ListenableFuture<ConversionEvent> getConversionEvent(GetConversionEventRequest request)

Retrieve a single conversion event.

Parameter
NameDescription
requestGetConversionEventRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ConversionEvent>

getCustomDimension(GetCustomDimensionRequest request)

public ListenableFuture<CustomDimension> getCustomDimension(GetCustomDimensionRequest request)

Lookup for a single CustomDimension.

Parameter
NameDescription
requestGetCustomDimensionRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<CustomDimension>

getCustomMetric(GetCustomMetricRequest request)

public ListenableFuture<CustomMetric> getCustomMetric(GetCustomMetricRequest request)

Lookup for a single CustomMetric.

Parameter
NameDescription
requestGetCustomMetricRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<CustomMetric>

getDataRetentionSettings(GetDataRetentionSettingsRequest request)

public ListenableFuture<DataRetentionSettings> getDataRetentionSettings(GetDataRetentionSettingsRequest request)

Returns the singleton data retention settings for this property.

Parameter
NameDescription
requestGetDataRetentionSettingsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<DataRetentionSettings>

getDataSharingSettings(GetDataSharingSettingsRequest request)

public ListenableFuture<DataSharingSettings> getDataSharingSettings(GetDataSharingSettingsRequest request)

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

Parameter
NameDescription
requestGetDataSharingSettingsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<DataSharingSettings>

getDataStream(GetDataStreamRequest request)

public ListenableFuture<DataStream> getDataStream(GetDataStreamRequest request)

Lookup for a single DataStream.

Parameter
NameDescription
requestGetDataStreamRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<DataStream>
public ListenableFuture<DisplayVideo360AdvertiserLink> getDisplayVideo360AdvertiserLink(GetDisplayVideo360AdvertiserLinkRequest request)

Look up a single DisplayVideo360AdvertiserLink

Parameter
NameDescription
requestGetDisplayVideo360AdvertiserLinkRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<DisplayVideo360AdvertiserLink>

getDisplayVideo360AdvertiserLinkProposal(GetDisplayVideo360AdvertiserLinkProposalRequest request)

public ListenableFuture<DisplayVideo360AdvertiserLinkProposal> getDisplayVideo360AdvertiserLinkProposal(GetDisplayVideo360AdvertiserLinkProposalRequest request)

Lookup for a single DisplayVideo360AdvertiserLinkProposal.

Parameter
NameDescription
requestGetDisplayVideo360AdvertiserLinkProposalRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<DisplayVideo360AdvertiserLinkProposal>

getEnhancedMeasurementSettings(GetEnhancedMeasurementSettingsRequest request)

public ListenableFuture<EnhancedMeasurementSettings> getEnhancedMeasurementSettings(GetEnhancedMeasurementSettingsRequest request)

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

Parameter
NameDescription
requestGetEnhancedMeasurementSettingsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<EnhancedMeasurementSettings>

getExpandedDataSet(GetExpandedDataSetRequest request)

public ListenableFuture<ExpandedDataSet> getExpandedDataSet(GetExpandedDataSetRequest request)

Lookup for a single ExpandedDataSet.

Parameter
NameDescription
requestGetExpandedDataSetRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ExpandedDataSet>

getGlobalSiteTag(GetGlobalSiteTagRequest request)

public ListenableFuture<GlobalSiteTag> getGlobalSiteTag(GetGlobalSiteTagRequest request)

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

Parameter
NameDescription
requestGetGlobalSiteTagRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<GlobalSiteTag>

getGoogleSignalsSettings(GetGoogleSignalsSettingsRequest request)

public ListenableFuture<GoogleSignalsSettings> getGoogleSignalsSettings(GetGoogleSignalsSettingsRequest request)

Lookup for Google Signals settings for a property.

Parameter
NameDescription
requestGetGoogleSignalsSettingsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<GoogleSignalsSettings>

getMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest request)

public ListenableFuture<MeasurementProtocolSecret> getMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest request)

Lookup for a single "GA4" MeasurementProtocolSecret.

Parameter
NameDescription
requestGetMeasurementProtocolSecretRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<MeasurementProtocolSecret>

getProperty(GetPropertyRequest request)

public ListenableFuture<Property> getProperty(GetPropertyRequest request)

Lookup for a single "GA4" Property.

Parameter
NameDescription
requestGetPropertyRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Property>
public ListenableFuture<SearchAds360Link> getSearchAds360Link(GetSearchAds360LinkRequest request)

Look up a single SearchAds360Link

Parameter
NameDescription
requestGetSearchAds360LinkRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<SearchAds360Link>
public ListenableFuture<UserLink> getUserLink(GetUserLinkRequest request)

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

Parameter
NameDescription
requestGetUserLinkRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<UserLink>

listAccessBindings(ListAccessBindingsRequest request)

public ListenableFuture<ListAccessBindingsResponse> listAccessBindings(ListAccessBindingsRequest request)

Lists all access bindings on an account or property.

Parameter
NameDescription
requestListAccessBindingsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListAccessBindingsResponse>

listAccountSummaries(ListAccountSummariesRequest request)

public ListenableFuture<ListAccountSummariesResponse> listAccountSummaries(ListAccountSummariesRequest request)

Returns summaries of all accounts accessible by the caller.

Parameter
NameDescription
requestListAccountSummariesRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListAccountSummariesResponse>

listAccounts(ListAccountsRequest request)

public ListenableFuture<ListAccountsResponse> listAccounts(ListAccountsRequest request)

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.

Parameter
NameDescription
requestListAccountsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListAccountsResponse>

listAudiences(ListAudiencesRequest request)

public ListenableFuture<ListAudiencesResponse> listAudiences(ListAudiencesRequest request)

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

Parameter
NameDescription
requestListAudiencesRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListAudiencesResponse>
public ListenableFuture<ListBigQueryLinksResponse> listBigQueryLinks(ListBigQueryLinksRequest request)

Lists BigQuery Links on a property.

Parameter
NameDescription
requestListBigQueryLinksRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListBigQueryLinksResponse>

listChannelGroups(ListChannelGroupsRequest request)

public ListenableFuture<ListChannelGroupsResponse> listChannelGroups(ListChannelGroupsRequest request)

Lists ChannelGroups on a property.

Parameter
NameDescription
requestListChannelGroupsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListChannelGroupsResponse>

listConnectedSiteTags(ListConnectedSiteTagsRequest request)

public ListenableFuture<ListConnectedSiteTagsResponse> listConnectedSiteTags(ListConnectedSiteTagsRequest request)

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.

Parameter
NameDescription
requestListConnectedSiteTagsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListConnectedSiteTagsResponse>

listConversionEvents(ListConversionEventsRequest request)

public ListenableFuture<ListConversionEventsResponse> listConversionEvents(ListConversionEventsRequest request)

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

Parameter
NameDescription
requestListConversionEventsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListConversionEventsResponse>

listCustomDimensions(ListCustomDimensionsRequest request)

public ListenableFuture<ListCustomDimensionsResponse> listCustomDimensions(ListCustomDimensionsRequest request)

Lists CustomDimensions on a property.

Parameter
NameDescription
requestListCustomDimensionsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListCustomDimensionsResponse>

listCustomMetrics(ListCustomMetricsRequest request)

public ListenableFuture<ListCustomMetricsResponse> listCustomMetrics(ListCustomMetricsRequest request)

Lists CustomMetrics on a property.

Parameter
NameDescription
requestListCustomMetricsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListCustomMetricsResponse>

listDataStreams(ListDataStreamsRequest request)

public ListenableFuture<ListDataStreamsResponse> listDataStreams(ListDataStreamsRequest request)

Lists DataStreams on a property.

Parameter
NameDescription
requestListDataStreamsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListDataStreamsResponse>

listDisplayVideo360AdvertiserLinkProposals(ListDisplayVideo360AdvertiserLinkProposalsRequest request)

public ListenableFuture<ListDisplayVideo360AdvertiserLinkProposalsResponse> listDisplayVideo360AdvertiserLinkProposals(ListDisplayVideo360AdvertiserLinkProposalsRequest request)

Lists DisplayVideo360AdvertiserLinkProposals on a property.

Parameter
NameDescription
requestListDisplayVideo360AdvertiserLinkProposalsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListDisplayVideo360AdvertiserLinkProposalsResponse>
public ListenableFuture<ListDisplayVideo360AdvertiserLinksResponse> listDisplayVideo360AdvertiserLinks(ListDisplayVideo360AdvertiserLinksRequest request)

Lists all DisplayVideo360AdvertiserLinks on a property.

Parameter
NameDescription
requestListDisplayVideo360AdvertiserLinksRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListDisplayVideo360AdvertiserLinksResponse>

listExpandedDataSets(ListExpandedDataSetsRequest request)

public ListenableFuture<ListExpandedDataSetsResponse> listExpandedDataSets(ListExpandedDataSetsRequest request)

Lists ExpandedDataSets on a property.

Parameter
NameDescription
requestListExpandedDataSetsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListExpandedDataSetsResponse>
public ListenableFuture<ListFirebaseLinksResponse> listFirebaseLinks(ListFirebaseLinksRequest request)

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

Parameter
NameDescription
requestListFirebaseLinksRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListFirebaseLinksResponse>
public ListenableFuture<ListGoogleAdsLinksResponse> listGoogleAdsLinks(ListGoogleAdsLinksRequest request)

Lists GoogleAdsLinks on a property.

Parameter
NameDescription
requestListGoogleAdsLinksRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListGoogleAdsLinksResponse>

listMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest request)

public ListenableFuture<ListMeasurementProtocolSecretsResponse> listMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest request)

Returns child MeasurementProtocolSecrets under the specified parent Property.

Parameter
NameDescription
requestListMeasurementProtocolSecretsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListMeasurementProtocolSecretsResponse>

listProperties(ListPropertiesRequest request)

public ListenableFuture<ListPropertiesResponse> listProperties(ListPropertiesRequest request)

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.

Parameter
NameDescription
requestListPropertiesRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListPropertiesResponse>
public ListenableFuture<ListSearchAds360LinksResponse> listSearchAds360Links(ListSearchAds360LinksRequest request)

Lists all SearchAds360Links on a property.

Parameter
NameDescription
requestListSearchAds360LinksRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListSearchAds360LinksResponse>
public ListenableFuture<ListUserLinksResponse> listUserLinks(ListUserLinksRequest request)

Lists all user links on an account or property.

Parameter
NameDescription
requestListUserLinksRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListUserLinksResponse>

provisionAccountTicket(ProvisionAccountTicketRequest request)

public ListenableFuture<ProvisionAccountTicketResponse> provisionAccountTicket(ProvisionAccountTicketRequest request)

Requests a ticket for creating an account.

Parameter
NameDescription
requestProvisionAccountTicketRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ProvisionAccountTicketResponse>

runAccessReport(RunAccessReportRequest request)

public ListenableFuture<RunAccessReportResponse> runAccessReport(RunAccessReportRequest request)

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.

Parameter
NameDescription
requestRunAccessReportRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<RunAccessReportResponse>

searchChangeHistoryEvents(SearchChangeHistoryEventsRequest request)

public ListenableFuture<SearchChangeHistoryEventsResponse> searchChangeHistoryEvents(SearchChangeHistoryEventsRequest request)

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

Parameter
NameDescription
requestSearchChangeHistoryEventsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<SearchChangeHistoryEventsResponse>

setAutomatedGa4ConfigurationOptOut(SetAutomatedGa4ConfigurationOptOutRequest request)

public ListenableFuture<SetAutomatedGa4ConfigurationOptOutResponse> setAutomatedGa4ConfigurationOptOut(SetAutomatedGa4ConfigurationOptOutRequest request)

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

Parameter
NameDescription
requestSetAutomatedGa4ConfigurationOptOutRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<SetAutomatedGa4ConfigurationOptOutResponse>

updateAccessBinding(UpdateAccessBindingRequest request)

public ListenableFuture<AccessBinding> updateAccessBinding(UpdateAccessBindingRequest request)

Updates an access binding on an account or property.

Parameter
NameDescription
requestUpdateAccessBindingRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<AccessBinding>

updateAccount(UpdateAccountRequest request)

public ListenableFuture<Account> updateAccount(UpdateAccountRequest request)

Updates an account.

Parameter
NameDescription
requestUpdateAccountRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Account>

updateAttributionSettings(UpdateAttributionSettingsRequest request)

public ListenableFuture<AttributionSettings> updateAttributionSettings(UpdateAttributionSettingsRequest request)

Updates attribution settings on a property.

Parameter
NameDescription
requestUpdateAttributionSettingsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<AttributionSettings>

updateAudience(UpdateAudienceRequest request)

public ListenableFuture<Audience> updateAudience(UpdateAudienceRequest request)

Updates an Audience on a property.

Parameter
NameDescription
requestUpdateAudienceRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Audience>

updateChannelGroup(UpdateChannelGroupRequest request)

public ListenableFuture<ChannelGroup> updateChannelGroup(UpdateChannelGroupRequest request)

Updates a ChannelGroup.

Parameter
NameDescription
requestUpdateChannelGroupRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ChannelGroup>

updateCustomDimension(UpdateCustomDimensionRequest request)

public ListenableFuture<CustomDimension> updateCustomDimension(UpdateCustomDimensionRequest request)

Updates a CustomDimension on a property.

Parameter
NameDescription
requestUpdateCustomDimensionRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<CustomDimension>

updateCustomMetric(UpdateCustomMetricRequest request)

public ListenableFuture<CustomMetric> updateCustomMetric(UpdateCustomMetricRequest request)

Updates a CustomMetric on a property.

Parameter
NameDescription
requestUpdateCustomMetricRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<CustomMetric>

updateDataRetentionSettings(UpdateDataRetentionSettingsRequest request)

public ListenableFuture<DataRetentionSettings> updateDataRetentionSettings(UpdateDataRetentionSettingsRequest request)

Updates the singleton data retention settings for this property.

Parameter
NameDescription
requestUpdateDataRetentionSettingsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<DataRetentionSettings>

updateDataStream(UpdateDataStreamRequest request)

public ListenableFuture<DataStream> updateDataStream(UpdateDataStreamRequest request)

Updates a DataStream on a property.

Parameter
NameDescription
requestUpdateDataStreamRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<DataStream>
public ListenableFuture<DisplayVideo360AdvertiserLink> updateDisplayVideo360AdvertiserLink(UpdateDisplayVideo360AdvertiserLinkRequest request)

Updates a DisplayVideo360AdvertiserLink on a property.

Parameter
NameDescription
requestUpdateDisplayVideo360AdvertiserLinkRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<DisplayVideo360AdvertiserLink>

updateEnhancedMeasurementSettings(UpdateEnhancedMeasurementSettingsRequest request)

public ListenableFuture<EnhancedMeasurementSettings> updateEnhancedMeasurementSettings(UpdateEnhancedMeasurementSettingsRequest request)

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

Parameter
NameDescription
requestUpdateEnhancedMeasurementSettingsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<EnhancedMeasurementSettings>

updateExpandedDataSet(UpdateExpandedDataSetRequest request)

public ListenableFuture<ExpandedDataSet> updateExpandedDataSet(UpdateExpandedDataSetRequest request)

Updates a ExpandedDataSet on a property.

Parameter
NameDescription
requestUpdateExpandedDataSetRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ExpandedDataSet>
public ListenableFuture<GoogleAdsLink> updateGoogleAdsLink(UpdateGoogleAdsLinkRequest request)

Updates a GoogleAdsLink on a property

Parameter
NameDescription
requestUpdateGoogleAdsLinkRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<GoogleAdsLink>

updateGoogleSignalsSettings(UpdateGoogleSignalsSettingsRequest request)

public ListenableFuture<GoogleSignalsSettings> updateGoogleSignalsSettings(UpdateGoogleSignalsSettingsRequest request)

Updates Google Signals settings for a property.

Parameter
NameDescription
requestUpdateGoogleSignalsSettingsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<GoogleSignalsSettings>

updateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest request)

public ListenableFuture<MeasurementProtocolSecret> updateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest request)

Updates a measurement protocol secret.

Parameter
NameDescription
requestUpdateMeasurementProtocolSecretRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<MeasurementProtocolSecret>

updateProperty(UpdatePropertyRequest request)

public ListenableFuture<Property> updateProperty(UpdatePropertyRequest request)

Updates a property.

Parameter
NameDescription
requestUpdatePropertyRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Property>
public ListenableFuture<SearchAds360Link> updateSearchAds360Link(UpdateSearchAds360LinkRequest request)

Updates a SearchAds360Link on a property.

Parameter
NameDescription
requestUpdateSearchAds360LinkRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<SearchAds360Link>
public ListenableFuture<UserLink> updateUserLink(UpdateUserLinkRequest request)

Updates a user link on an account or property.

Parameter
NameDescription
requestUpdateUserLinkRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<UserLink>