Class AnalyticsAdminServiceGrpc.AnalyticsAdminServiceFutureStub (0.21.0)

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

Service Interface for the Analytics Admin API (GA4).

Inheritance

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

Inherited Members

io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)

io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.getCallOptions()

io.grpc.stub.AbstractStub.getChannel()

io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)

io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)

io.grpc.stub.AbstractStub.withCompression(java.lang.String)

io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)

io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)

io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)

io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)

io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)

io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)

io.grpc.stub.AbstractStub.withWaitForReady()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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 via this API) before MeasurementProtocolSecret resources may be created.

Parameter

Name	Description
`request`	`AcknowledgeUserDataCollectionRequest`

Returns

Type	Description
`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

Name	Description
`request`	`ApproveDisplayVideo360AdvertiserLinkProposalRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<ApproveDisplayVideo360AdvertiserLinkProposalResponse>`

archiveAudience(ArchiveAudienceRequest request)

public ListenableFuture<Empty> archiveAudience(ArchiveAudienceRequest request)

Archives an Audience on a property.

Parameter

Name	Description
`request`	`ArchiveAudienceRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<Empty>`

archiveCustomDimension(ArchiveCustomDimensionRequest request)

public ListenableFuture<Empty> archiveCustomDimension(ArchiveCustomDimensionRequest request)

Archives a CustomDimension on a property.

Parameter

Name	Description
`request`	`ArchiveCustomDimensionRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<Empty>`

archiveCustomMetric(ArchiveCustomMetricRequest request)

public ListenableFuture<Empty> archiveCustomMetric(ArchiveCustomMetricRequest request)

Archives a CustomMetric on a property.

Parameter

Name	Description
`request`	`ArchiveCustomMetricRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<Empty>`

auditUserLinks(AuditUserLinksRequest request)

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

Name	Description
`request`	`AuditUserLinksRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<AuditUserLinksResponse>`

batchCreateUserLinks(BatchCreateUserLinksRequest request)

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

Name	Description
`request`	`BatchCreateUserLinksRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<BatchCreateUserLinksResponse>`

batchDeleteUserLinks(BatchDeleteUserLinksRequest request)

public ListenableFuture<Empty> batchDeleteUserLinks(BatchDeleteUserLinksRequest request)

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

Parameter

Name	Description
`request`	`BatchDeleteUserLinksRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<Empty>`

batchGetUserLinks(BatchGetUserLinksRequest request)

public ListenableFuture<BatchGetUserLinksResponse> batchGetUserLinks(BatchGetUserLinksRequest request)

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

Parameter

Name	Description
`request`	`BatchGetUserLinksRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<BatchGetUserLinksResponse>`

batchUpdateUserLinks(BatchUpdateUserLinksRequest request)

public ListenableFuture<BatchUpdateUserLinksResponse> batchUpdateUserLinks(BatchUpdateUserLinksRequest request)

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

Parameter

Name	Description
`request`	`BatchUpdateUserLinksRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<BatchUpdateUserLinksResponse>`

build(Channel channel, CallOptions callOptions)

protected AnalyticsAdminServiceGrpc.AnalyticsAdminServiceFutureStub build(Channel channel, CallOptions callOptions)

Parameters

Name	Description
`channel`	`io.grpc.Channel`
`callOptions`	`io.grpc.CallOptions`

Returns

Type	Description
`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

Name	Description
`request`	`CancelDisplayVideo360AdvertiserLinkProposalRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<DisplayVideo360AdvertiserLinkProposal>`

createAudience(CreateAudienceRequest request)

public ListenableFuture<Audience> createAudience(CreateAudienceRequest request)

Creates an Audience.

Parameter

Name	Description
`request`	`CreateAudienceRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<Audience>`

createConversionEvent(CreateConversionEventRequest request)

public ListenableFuture<ConversionEvent> createConversionEvent(CreateConversionEventRequest request)

Creates a conversion event with the specified attributes.

Parameter

Name	Description
`request`	`CreateConversionEventRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<ConversionEvent>`

createCustomDimension(CreateCustomDimensionRequest request)

public ListenableFuture<CustomDimension> createCustomDimension(CreateCustomDimensionRequest request)

Creates a CustomDimension.

Parameter

Name	Description
`request`	`CreateCustomDimensionRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<CustomDimension>`

createCustomMetric(CreateCustomMetricRequest request)

public ListenableFuture<CustomMetric> createCustomMetric(CreateCustomMetricRequest request)

Creates a CustomMetric.

Parameter

Name	Description
`request`	`CreateCustomMetricRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<CustomMetric>`

createDataStream(CreateDataStreamRequest request)

public ListenableFuture<DataStream> createDataStream(CreateDataStreamRequest request)

Creates a DataStream.

Parameter

Name	Description
`request`	`CreateDataStreamRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<DataStream>`

createDisplayVideo360AdvertiserLink(CreateDisplayVideo360AdvertiserLinkRequest request)

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

Name	Description
`request`	`CreateDisplayVideo360AdvertiserLinkRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<DisplayVideo360AdvertiserLink>`

createDisplayVideo360AdvertiserLinkProposal(CreateDisplayVideo360AdvertiserLinkProposalRequest request)

public ListenableFuture<DisplayVideo360AdvertiserLinkProposal> createDisplayVideo360AdvertiserLinkProposal(CreateDisplayVideo360AdvertiserLinkProposalRequest request)

Creates a DisplayVideo360AdvertiserLinkProposal.

Parameter

Name	Description
`request`	`CreateDisplayVideo360AdvertiserLinkProposalRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<DisplayVideo360AdvertiserLinkProposal>`

createFirebaseLink(CreateFirebaseLinkRequest request)

public ListenableFuture<FirebaseLink> createFirebaseLink(CreateFirebaseLinkRequest request)

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

Parameter

Name	Description
`request`	`CreateFirebaseLinkRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<FirebaseLink>`

createGoogleAdsLink(CreateGoogleAdsLinkRequest request)

public ListenableFuture<GoogleAdsLink> createGoogleAdsLink(CreateGoogleAdsLinkRequest request)

Creates a GoogleAdsLink.

Parameter

Name	Description
`request`	`CreateGoogleAdsLinkRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<GoogleAdsLink>`

createMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest request)

public ListenableFuture<MeasurementProtocolSecret> createMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest request)

Creates a measurement protocol secret.

Parameter

Name	Description
`request`	`CreateMeasurementProtocolSecretRequest`

Returns

Type	Description
`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

Name	Description
`request`	`CreatePropertyRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<Property>`

createSearchAds360Link(CreateSearchAds360LinkRequest request)

public ListenableFuture<SearchAds360Link> createSearchAds360Link(CreateSearchAds360LinkRequest request)

Creates a SearchAds360Link.

Parameter

Name	Description
`request`	`CreateSearchAds360LinkRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<SearchAds360Link>`

createUserLink(CreateUserLinkRequest request)

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

Name	Description
`request`	`CreateUserLinkRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<UserLink>`

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

Name	Description
`request`	`DeleteAccountRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<Empty>`

deleteConversionEvent(DeleteConversionEventRequest request)

public ListenableFuture<Empty> deleteConversionEvent(DeleteConversionEventRequest request)

Deletes a conversion event in a property.

Parameter

Name	Description
`request`	`DeleteConversionEventRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<Empty>`

deleteDataStream(DeleteDataStreamRequest request)

public ListenableFuture<Empty> deleteDataStream(DeleteDataStreamRequest request)

Deletes a DataStream on a property.

Parameter

Name	Description
`request`	`DeleteDataStreamRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<Empty>`

deleteDisplayVideo360AdvertiserLink(DeleteDisplayVideo360AdvertiserLinkRequest request)

public ListenableFuture<Empty> deleteDisplayVideo360AdvertiserLink(DeleteDisplayVideo360AdvertiserLinkRequest request)

Deletes a DisplayVideo360AdvertiserLink on a property.

Parameter

Name	Description
`request`	`DeleteDisplayVideo360AdvertiserLinkRequest`

Returns

Type	Description
`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

Name	Description
`request`	`DeleteDisplayVideo360AdvertiserLinkProposalRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<Empty>`

deleteFirebaseLink(DeleteFirebaseLinkRequest request)

public ListenableFuture<Empty> deleteFirebaseLink(DeleteFirebaseLinkRequest request)

Deletes a FirebaseLink on a property

Parameter

Name	Description
`request`	`DeleteFirebaseLinkRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<Empty>`

deleteGoogleAdsLink(DeleteGoogleAdsLinkRequest request)

public ListenableFuture<Empty> deleteGoogleAdsLink(DeleteGoogleAdsLinkRequest request)

Deletes a GoogleAdsLink on a property

Parameter

Name	Description
`request`	`DeleteGoogleAdsLinkRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<Empty>`

deleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest request)

public ListenableFuture<Empty> deleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest request)

Deletes target MeasurementProtocolSecret.

Parameter

Name	Description
`request`	`DeleteMeasurementProtocolSecretRequest`

Returns

Type	Description
`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

Name	Description
`request`	`DeletePropertyRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<Property>`

deleteSearchAds360Link(DeleteSearchAds360LinkRequest request)

public ListenableFuture<Empty> deleteSearchAds360Link(DeleteSearchAds360LinkRequest request)

Deletes a SearchAds360Link on a property.

Parameter

Name	Description
`request`	`DeleteSearchAds360LinkRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<Empty>`

deleteUserLink(DeleteUserLinkRequest request)

public ListenableFuture<Empty> deleteUserLink(DeleteUserLinkRequest request)

Deletes a user link on an account or property.

Parameter

Name	Description
`request`	`DeleteUserLinkRequest`

Returns

Type	Description
`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

Name	Description
`request`	`FetchAutomatedGa4ConfigurationOptOutRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<FetchAutomatedGa4ConfigurationOptOutResponse>`

getAccount(GetAccountRequest request)

public ListenableFuture<Account> getAccount(GetAccountRequest request)

Lookup for a single Account.

Parameter

Name	Description
`request`	`GetAccountRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<Account>`

getAttributionSettings(GetAttributionSettingsRequest request)

public ListenableFuture<AttributionSettings> getAttributionSettings(GetAttributionSettingsRequest request)

Lookup for a AttributionSettings singleton.

Parameter

Name	Description
`request`	`GetAttributionSettingsRequest`

Returns

Type	Description
`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

Name	Description
`request`	`GetAudienceRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<Audience>`

getBigQueryLink(GetBigQueryLinkRequest request)

public ListenableFuture<BigQueryLink> getBigQueryLink(GetBigQueryLinkRequest request)

Lookup for a single BigQuery Link.

Parameter

Name	Description
`request`	`GetBigQueryLinkRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<BigQueryLink>`

getConversionEvent(GetConversionEventRequest request)

public ListenableFuture<ConversionEvent> getConversionEvent(GetConversionEventRequest request)

Retrieve a single conversion event.

Parameter

Name	Description
`request`	`GetConversionEventRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<ConversionEvent>`

getCustomDimension(GetCustomDimensionRequest request)

public ListenableFuture<CustomDimension> getCustomDimension(GetCustomDimensionRequest request)

Lookup for a single CustomDimension.

Parameter

Name	Description
`request`	`GetCustomDimensionRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<CustomDimension>`

getCustomMetric(GetCustomMetricRequest request)

public ListenableFuture<CustomMetric> getCustomMetric(GetCustomMetricRequest request)

Lookup for a single CustomMetric.

Parameter

Name	Description
`request`	`GetCustomMetricRequest`

Returns

Type	Description
`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

Name	Description
`request`	`GetDataRetentionSettingsRequest`

Returns

Type	Description
`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

Name	Description
`request`	`GetDataSharingSettingsRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<DataSharingSettings>`

getDataStream(GetDataStreamRequest request)

public ListenableFuture<DataStream> getDataStream(GetDataStreamRequest request)

Lookup for a single DataStream.

Parameter

Name	Description
`request`	`GetDataStreamRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<DataStream>`

getDisplayVideo360AdvertiserLink(GetDisplayVideo360AdvertiserLinkRequest request)

public ListenableFuture<DisplayVideo360AdvertiserLink> getDisplayVideo360AdvertiserLink(GetDisplayVideo360AdvertiserLinkRequest request)

Look up a single DisplayVideo360AdvertiserLink

Parameter

Name	Description
`request`	`GetDisplayVideo360AdvertiserLinkRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<DisplayVideo360AdvertiserLink>`

getDisplayVideo360AdvertiserLinkProposal(GetDisplayVideo360AdvertiserLinkProposalRequest request)

public ListenableFuture<DisplayVideo360AdvertiserLinkProposal> getDisplayVideo360AdvertiserLinkProposal(GetDisplayVideo360AdvertiserLinkProposalRequest request)

Lookup for a single DisplayVideo360AdvertiserLinkProposal.

Parameter

Name	Description
`request`	`GetDisplayVideo360AdvertiserLinkProposalRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<DisplayVideo360AdvertiserLinkProposal>`

getGlobalSiteTag(GetGlobalSiteTagRequest request)

public ListenableFuture<GlobalSiteTag> getGlobalSiteTag(GetGlobalSiteTagRequest request)

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

Parameter

Name	Description
`request`	`GetGlobalSiteTagRequest`

Returns

Type	Description
`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

Name	Description
`request`	`GetGoogleSignalsSettingsRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<GoogleSignalsSettings>`

getMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest request)

public ListenableFuture<MeasurementProtocolSecret> getMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest request)

Lookup for a single "GA4" MeasurementProtocolSecret.

Parameter

Name	Description
`request`	`GetMeasurementProtocolSecretRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<MeasurementProtocolSecret>`

getProperty(GetPropertyRequest request)

public ListenableFuture<Property> getProperty(GetPropertyRequest request)

Lookup for a single "GA4" Property.

Parameter

Name	Description
`request`	`GetPropertyRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<Property>`

getSearchAds360Link(GetSearchAds360LinkRequest request)

public ListenableFuture<SearchAds360Link> getSearchAds360Link(GetSearchAds360LinkRequest request)

Look up a single SearchAds360Link

Parameter

Name	Description
`request`	`GetSearchAds360LinkRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<SearchAds360Link>`

getUserLink(GetUserLinkRequest request)

public ListenableFuture<UserLink> getUserLink(GetUserLinkRequest request)

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

Parameter

Name	Description
`request`	`GetUserLinkRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<UserLink>`

listAccountSummaries(ListAccountSummariesRequest request)

public ListenableFuture<ListAccountSummariesResponse> listAccountSummaries(ListAccountSummariesRequest request)

Returns summaries of all accounts accessible by the caller.

Parameter

Name	Description
`request`	`ListAccountSummariesRequest`

Returns

Type	Description
`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

Name	Description
`request`	`ListAccountsRequest`

Returns

Type	Description
`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

Name	Description
`request`	`ListAudiencesRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListAudiencesResponse>`

listBigQueryLinks(ListBigQueryLinksRequest request)

public ListenableFuture<ListBigQueryLinksResponse> listBigQueryLinks(ListBigQueryLinksRequest request)

Lists BigQuery Links on a property.

Parameter

Name	Description
`request`	`ListBigQueryLinksRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListBigQueryLinksResponse>`

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

Name	Description
`request`	`ListConversionEventsRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListConversionEventsResponse>`

listCustomDimensions(ListCustomDimensionsRequest request)

public ListenableFuture<ListCustomDimensionsResponse> listCustomDimensions(ListCustomDimensionsRequest request)

Lists CustomDimensions on a property.

Parameter

Name	Description
`request`	`ListCustomDimensionsRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListCustomDimensionsResponse>`

listCustomMetrics(ListCustomMetricsRequest request)

public ListenableFuture<ListCustomMetricsResponse> listCustomMetrics(ListCustomMetricsRequest request)

Lists CustomMetrics on a property.

Parameter

Name	Description
`request`	`ListCustomMetricsRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListCustomMetricsResponse>`

listDataStreams(ListDataStreamsRequest request)

public ListenableFuture<ListDataStreamsResponse> listDataStreams(ListDataStreamsRequest request)

Lists DataStreams on a property.

Parameter

Name	Description
`request`	`ListDataStreamsRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListDataStreamsResponse>`

listDisplayVideo360AdvertiserLinkProposals(ListDisplayVideo360AdvertiserLinkProposalsRequest request)

public ListenableFuture<ListDisplayVideo360AdvertiserLinkProposalsResponse> listDisplayVideo360AdvertiserLinkProposals(ListDisplayVideo360AdvertiserLinkProposalsRequest request)

Lists DisplayVideo360AdvertiserLinkProposals on a property.

Parameter

Name	Description
`request`	`ListDisplayVideo360AdvertiserLinkProposalsRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListDisplayVideo360AdvertiserLinkProposalsResponse>`

listDisplayVideo360AdvertiserLinks(ListDisplayVideo360AdvertiserLinksRequest request)

public ListenableFuture<ListDisplayVideo360AdvertiserLinksResponse> listDisplayVideo360AdvertiserLinks(ListDisplayVideo360AdvertiserLinksRequest request)

Lists all DisplayVideo360AdvertiserLinks on a property.

Parameter

Name	Description
`request`	`ListDisplayVideo360AdvertiserLinksRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListDisplayVideo360AdvertiserLinksResponse>`

listFirebaseLinks(ListFirebaseLinksRequest request)

public ListenableFuture<ListFirebaseLinksResponse> listFirebaseLinks(ListFirebaseLinksRequest request)

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

Parameter

Name	Description
`request`	`ListFirebaseLinksRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListFirebaseLinksResponse>`

listGoogleAdsLinks(ListGoogleAdsLinksRequest request)

public ListenableFuture<ListGoogleAdsLinksResponse> listGoogleAdsLinks(ListGoogleAdsLinksRequest request)

Lists GoogleAdsLinks on a property.

Parameter

Name	Description
`request`	`ListGoogleAdsLinksRequest`

Returns

Type	Description
`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

Name	Description
`request`	`ListMeasurementProtocolSecretsRequest`

Returns

Type	Description
`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

Name	Description
`request`	`ListPropertiesRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListPropertiesResponse>`

listSearchAds360Links(ListSearchAds360LinksRequest request)

public ListenableFuture<ListSearchAds360LinksResponse> listSearchAds360Links(ListSearchAds360LinksRequest request)

Lists all SearchAds360Links on a property.

Parameter

Name	Description
`request`	`ListSearchAds360LinksRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListSearchAds360LinksResponse>`

listUserLinks(ListUserLinksRequest request)

public ListenableFuture<ListUserLinksResponse> listUserLinks(ListUserLinksRequest request)

Lists all user links on an account or property.

Parameter

Name	Description
`request`	`ListUserLinksRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListUserLinksResponse>`

provisionAccountTicket(ProvisionAccountTicketRequest request)

public ListenableFuture<ProvisionAccountTicketResponse> provisionAccountTicket(ProvisionAccountTicketRequest request)

Requests a ticket for creating an account.

Parameter

Name	Description
`request`	`ProvisionAccountTicketRequest`

Returns

Type	Description
`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

Name	Description
`request`	`RunAccessReportRequest`

Returns

Type	Description
`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

Name	Description
`request`	`SearchChangeHistoryEventsRequest`

Returns

Type	Description
`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

Name	Description
`request`	`SetAutomatedGa4ConfigurationOptOutRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<SetAutomatedGa4ConfigurationOptOutResponse>`

updateAccount(UpdateAccountRequest request)

public ListenableFuture<Account> updateAccount(UpdateAccountRequest request)

Updates an account.

Parameter

Name	Description
`request`	`UpdateAccountRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<Account>`

updateAttributionSettings(UpdateAttributionSettingsRequest request)

public ListenableFuture<AttributionSettings> updateAttributionSettings(UpdateAttributionSettingsRequest request)

Updates attribution settings on a property.

Parameter

Name	Description
`request`	`UpdateAttributionSettingsRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<AttributionSettings>`

updateAudience(UpdateAudienceRequest request)

public ListenableFuture<Audience> updateAudience(UpdateAudienceRequest request)

Updates an Audience on a property.

Parameter

Name	Description
`request`	`UpdateAudienceRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<Audience>`

updateCustomDimension(UpdateCustomDimensionRequest request)

public ListenableFuture<CustomDimension> updateCustomDimension(UpdateCustomDimensionRequest request)

Updates a CustomDimension on a property.

Parameter

Name	Description
`request`	`UpdateCustomDimensionRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<CustomDimension>`

updateCustomMetric(UpdateCustomMetricRequest request)

public ListenableFuture<CustomMetric> updateCustomMetric(UpdateCustomMetricRequest request)

Updates a CustomMetric on a property.

Parameter

Name	Description
`request`	`UpdateCustomMetricRequest`

Returns

Type	Description
`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

Name	Description
`request`	`UpdateDataRetentionSettingsRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<DataRetentionSettings>`

updateDataStream(UpdateDataStreamRequest request)

public ListenableFuture<DataStream> updateDataStream(UpdateDataStreamRequest request)

Updates a DataStream on a property.

Parameter

Name	Description
`request`	`UpdateDataStreamRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<DataStream>`

updateDisplayVideo360AdvertiserLink(UpdateDisplayVideo360AdvertiserLinkRequest request)

public ListenableFuture<DisplayVideo360AdvertiserLink> updateDisplayVideo360AdvertiserLink(UpdateDisplayVideo360AdvertiserLinkRequest request)

Updates a DisplayVideo360AdvertiserLink on a property.

Parameter

Name	Description
`request`	`UpdateDisplayVideo360AdvertiserLinkRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<DisplayVideo360AdvertiserLink>`

updateGoogleAdsLink(UpdateGoogleAdsLinkRequest request)

public ListenableFuture<GoogleAdsLink> updateGoogleAdsLink(UpdateGoogleAdsLinkRequest request)

Updates a GoogleAdsLink on a property

Parameter

Name	Description
`request`	`UpdateGoogleAdsLinkRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<GoogleAdsLink>`

updateGoogleSignalsSettings(UpdateGoogleSignalsSettingsRequest request)

public ListenableFuture<GoogleSignalsSettings> updateGoogleSignalsSettings(UpdateGoogleSignalsSettingsRequest request)

Updates Google Signals settings for a property.

Parameter

Name	Description
`request`	`UpdateGoogleSignalsSettingsRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<GoogleSignalsSettings>`

updateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest request)

public ListenableFuture<MeasurementProtocolSecret> updateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest request)

Updates a measurement protocol secret.

Parameter

Name	Description
`request`	`UpdateMeasurementProtocolSecretRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<MeasurementProtocolSecret>`

updateProperty(UpdatePropertyRequest request)

public ListenableFuture<Property> updateProperty(UpdatePropertyRequest request)

Updates a property.

Parameter

Name	Description
`request`	`UpdatePropertyRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<Property>`

updateSearchAds360Link(UpdateSearchAds360LinkRequest request)

public ListenableFuture<SearchAds360Link> updateSearchAds360Link(UpdateSearchAds360LinkRequest request)

Updates a SearchAds360Link on a property.

Parameter

Name	Description
`request`	`UpdateSearchAds360LinkRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<SearchAds360Link>`

updateUserLink(UpdateUserLinkRequest request)

public ListenableFuture<UserLink> updateUserLink(UpdateUserLinkRequest request)

Updates a user link on an account or property.

Parameter

Name	Description
`request`	`UpdateUserLinkRequest`

Returns

Type	Description
`com.google.common.util.concurrent.ListenableFuture<UserLink>`