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
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.withOnReadyThreshold(int)
io.grpc.stub.AbstractStub.withWaitForReady()
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.
archiveCustomDimension(ArchiveCustomDimensionRequest request)
public ListenableFuture<Empty> archiveCustomDimension(ArchiveCustomDimensionRequest request)
Archives a CustomDimension on a property.
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.
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<Empty> |
|
build(Channel channel, CallOptions callOptions)
protected AnalyticsAdminServiceGrpc.AnalyticsAdminServiceFutureStub build(Channel channel, CallOptions callOptions)
Parameters |
Name |
Description |
channel |
io.grpc.Channel
|
callOptions |
io.grpc.CallOptions
|
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
createConversionEvent(CreateConversionEventRequest request) (deprecated)
public ListenableFuture<ConversionEvent> createConversionEvent(CreateConversionEventRequest request)
Deprecated: Use CreateKeyEvent
instead.
Creates a conversion event with the specified attributes.
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<ConversionEvent> |
|
createCustomDimension(CreateCustomDimensionRequest request)
public ListenableFuture<CustomDimension> createCustomDimension(CreateCustomDimensionRequest request)
Creates a CustomDimension.
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<CustomDimension> |
|
createCustomMetric(CreateCustomMetricRequest request)
public ListenableFuture<CustomMetric> createCustomMetric(CreateCustomMetricRequest request)
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<CustomMetric> |
|
createDataStream(CreateDataStreamRequest request)
public ListenableFuture<DataStream> createDataStream(CreateDataStreamRequest request)
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<DataStream> |
|
createFirebaseLink(CreateFirebaseLinkRequest request)
public ListenableFuture<FirebaseLink> createFirebaseLink(CreateFirebaseLinkRequest request)
Creates a FirebaseLink.
Properties can have at most one FirebaseLink.
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<FirebaseLink> |
|
createGoogleAdsLink(CreateGoogleAdsLinkRequest request)
public ListenableFuture<GoogleAdsLink> createGoogleAdsLink(CreateGoogleAdsLinkRequest request)
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<GoogleAdsLink> |
|
createKeyEvent(CreateKeyEventRequest request)
public ListenableFuture<KeyEvent> createKeyEvent(CreateKeyEventRequest request)
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<KeyEvent> |
|
createMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest request)
public ListenableFuture<MeasurementProtocolSecret> createMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest request)
Creates a measurement protocol secret.
createProperty(CreatePropertyRequest request)
public ListenableFuture<Property> createProperty(CreatePropertyRequest request)
Creates an "GA4" property with the specified location and attributes.
Returns |
Type |
Description |
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,
AccessBindings) will be permanently purged.
https://support.google.com/analytics/answer/6154772
Returns an error if the target is not found.
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<Empty> |
|
deleteConversionEvent(DeleteConversionEventRequest request) (deprecated)
public ListenableFuture<Empty> deleteConversionEvent(DeleteConversionEventRequest request)
Deprecated: Use DeleteKeyEvent
instead.
Deletes a conversion event in a property.
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.
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
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
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<Empty> |
|
deleteKeyEvent(DeleteKeyEventRequest request)
public ListenableFuture<Empty> deleteKeyEvent(DeleteKeyEventRequest request)
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<Empty> |
|
deleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest request)
public ListenableFuture<Empty> deleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest request)
Deletes target MeasurementProtocolSecret.
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, AccessBindings)
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.
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<Property> |
|
getAccount(GetAccountRequest request)
public ListenableFuture<Account> getAccount(GetAccountRequest request)
Lookup for a single Account.
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<Account> |
|
getConversionEvent(GetConversionEventRequest request) (deprecated)
public ListenableFuture<ConversionEvent> getConversionEvent(GetConversionEventRequest request)
Deprecated: Use GetKeyEvent
instead.
Retrieve a single conversion event.
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<ConversionEvent> |
|
getCustomDimension(GetCustomDimensionRequest request)
public ListenableFuture<CustomDimension> getCustomDimension(GetCustomDimensionRequest request)
Lookup for a single CustomDimension.
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<CustomDimension> |
|
getCustomMetric(GetCustomMetricRequest request)
public ListenableFuture<CustomMetric> getCustomMetric(GetCustomMetricRequest request)
Lookup for a single CustomMetric.
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.
getDataSharingSettings(GetDataSharingSettingsRequest request)
public ListenableFuture<DataSharingSettings> getDataSharingSettings(GetDataSharingSettingsRequest request)
Get data sharing settings on an account.
Data sharing settings are singletons.
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<DataSharingSettings> |
|
getDataStream(GetDataStreamRequest request)
public ListenableFuture<DataStream> getDataStream(GetDataStreamRequest request)
Lookup for a single DataStream.
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<DataStream> |
|
getKeyEvent(GetKeyEventRequest request)
public ListenableFuture<KeyEvent> getKeyEvent(GetKeyEventRequest request)
Retrieve a single Key Event.
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<KeyEvent> |
|
getMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest request)
public ListenableFuture<MeasurementProtocolSecret> getMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest request)
Lookup for a single "GA4" MeasurementProtocolSecret.
getProperty(GetPropertyRequest request)
public ListenableFuture<Property> getProperty(GetPropertyRequest request)
Lookup for a single "GA4" Property.
Returns |
Type |
Description |
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.
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.
listConversionEvents(ListConversionEventsRequest request) (deprecated)
public ListenableFuture<ListConversionEventsResponse> listConversionEvents(ListConversionEventsRequest request)
Deprecated: Use ListKeyEvents
instead.
Returns a list of conversion events in the specified parent property.
Returns an empty list if no conversion events are found.
listCustomDimensions(ListCustomDimensionsRequest request)
public ListenableFuture<ListCustomDimensionsResponse> listCustomDimensions(ListCustomDimensionsRequest request)
Lists CustomDimensions on a property.
listCustomMetrics(ListCustomMetricsRequest request)
public ListenableFuture<ListCustomMetricsResponse> listCustomMetrics(ListCustomMetricsRequest request)
Lists CustomMetrics on a property.
listDataStreams(ListDataStreamsRequest request)
public ListenableFuture<ListDataStreamsResponse> listDataStreams(ListDataStreamsRequest request)
Lists DataStreams on a property.
listFirebaseLinks(ListFirebaseLinksRequest request)
public ListenableFuture<ListFirebaseLinksResponse> listFirebaseLinks(ListFirebaseLinksRequest request)
Lists FirebaseLinks on a property.
Properties can have at most one FirebaseLink.
listGoogleAdsLinks(ListGoogleAdsLinksRequest request)
public ListenableFuture<ListGoogleAdsLinksResponse> listGoogleAdsLinks(ListGoogleAdsLinksRequest request)
Lists GoogleAdsLinks on a property.
listKeyEvents(ListKeyEventsRequest request)
public ListenableFuture<ListKeyEventsResponse> listKeyEvents(ListKeyEventsRequest request)
Returns a list of Key Events in the specified parent property.
Returns an empty list if no Key Events are found.
listMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest request)
public ListenableFuture<ListMeasurementProtocolSecretsResponse> listMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest request)
Returns child MeasurementProtocolSecrets under the specified parent
Property.
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.
provisionAccountTicket(ProvisionAccountTicketRequest request)
public ListenableFuture<ProvisionAccountTicketResponse> provisionAccountTicket(ProvisionAccountTicketRequest request)
Requests a ticket for creating an account.
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. Reports may be
requested for any property, but dimensions that aren't related to quota can
only be requested on Google Analytics 360 properties. 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.
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.
updateAccount(UpdateAccountRequest request)
public ListenableFuture<Account> updateAccount(UpdateAccountRequest request)
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<Account> |
|
updateConversionEvent(UpdateConversionEventRequest request) (deprecated)
public ListenableFuture<ConversionEvent> updateConversionEvent(UpdateConversionEventRequest request)
Deprecated: Use UpdateKeyEvent
instead.
Updates a conversion event with the specified attributes.
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<ConversionEvent> |
|
updateCustomDimension(UpdateCustomDimensionRequest request)
public ListenableFuture<CustomDimension> updateCustomDimension(UpdateCustomDimensionRequest request)
Updates a CustomDimension on a property.
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.
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.
updateDataStream(UpdateDataStreamRequest request)
public ListenableFuture<DataStream> updateDataStream(UpdateDataStreamRequest request)
Updates a DataStream on a property.
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<DataStream> |
|
updateGoogleAdsLink(UpdateGoogleAdsLinkRequest request)
public ListenableFuture<GoogleAdsLink> updateGoogleAdsLink(UpdateGoogleAdsLinkRequest request)
Updates a GoogleAdsLink on a property
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<GoogleAdsLink> |
|
updateKeyEvent(UpdateKeyEventRequest request)
public ListenableFuture<KeyEvent> updateKeyEvent(UpdateKeyEventRequest request)
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<KeyEvent> |
|
updateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest request)
public ListenableFuture<MeasurementProtocolSecret> updateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest request)
Updates a measurement protocol secret.
updateProperty(UpdatePropertyRequest request)
public ListenableFuture<Property> updateProperty(UpdatePropertyRequest request)
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<Property> |
|