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>

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>

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)

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

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>

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

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>

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>

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>

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>

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

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>

updateAccount(UpdateAccountRequest request)

public ListenableFuture<Account> updateAccount(UpdateAccountRequest request)

Updates an account.

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

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<GoogleAdsLink> updateGoogleAdsLink(UpdateGoogleAdsLinkRequest request)

Updates a GoogleAdsLink on a property

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

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>