public static final class AnalyticsAdminServiceGrpc.AnalyticsAdminServiceFutureStub extends AbstractFutureStub.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.newStub(io.grpc.stub.AbstractStub.StubFactory,io.grpc.Channel)
io.grpc.stub.AbstractFutureStub.newStub(io.grpc.stub.AbstractStub.StubFactory,io.grpc.Channel,io.grpc.CallOptions)
io.grpc.stub.AbstractStub.withOption(io.grpc.CallOptions.Key,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()
Methods
acknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest request)
public ListenableFuture 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.
approveDisplayVideo360AdvertiserLinkProposal(ApproveDisplayVideo360AdvertiserLinkProposalRequest request)
public ListenableFuture approveDisplayVideo360AdvertiserLinkProposal(ApproveDisplayVideo360AdvertiserLinkProposalRequest request)
Approves a DisplayVideo360AdvertiserLinkProposal.
The DisplayVideo360AdvertiserLinkProposal will be deleted and a new
DisplayVideo360AdvertiserLink will be created.
archiveAudience(ArchiveAudienceRequest request)
public ListenableFuture archiveAudience(ArchiveAudienceRequest request)
Archives an Audience on a property.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Empty> | |
archiveCustomDimension(ArchiveCustomDimensionRequest request)
public ListenableFuture archiveCustomDimension(ArchiveCustomDimensionRequest request)
Archives a CustomDimension on a property.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Empty> | |
archiveCustomMetric(ArchiveCustomMetricRequest request)
public ListenableFuture archiveCustomMetric(ArchiveCustomMetricRequest request)
Archives a CustomMetric on a property.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Empty> | |
auditUserLinks(AuditUserLinksRequest request)
public ListenableFuture 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.
batchCreateAccessBindings(BatchCreateAccessBindingsRequest request)
public ListenableFuture 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.
batchCreateUserLinks(BatchCreateUserLinksRequest request)
public ListenableFuture 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.
batchDeleteAccessBindings(BatchDeleteAccessBindingsRequest request)
public ListenableFuture batchDeleteAccessBindings(BatchDeleteAccessBindingsRequest request)
Deletes information about multiple users' links to an account or property.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Empty> | |
batchDeleteUserLinks(BatchDeleteUserLinksRequest request)
public ListenableFuture batchDeleteUserLinks(BatchDeleteUserLinksRequest request)
Deletes information about multiple users' links to an account or property.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Empty> | |
batchGetAccessBindings(BatchGetAccessBindingsRequest request)
public ListenableFuture batchGetAccessBindings(BatchGetAccessBindingsRequest request)
Gets information about multiple access bindings to an account or property.
batchGetUserLinks(BatchGetUserLinksRequest request)
public ListenableFuture batchGetUserLinks(BatchGetUserLinksRequest request)
Gets information about multiple users' links to an account or property.
batchUpdateAccessBindings(BatchUpdateAccessBindingsRequest request)
public ListenableFuture batchUpdateAccessBindings(BatchUpdateAccessBindingsRequest request)
Updates information about multiple access bindings to an account or
property.
batchUpdateUserLinks(BatchUpdateUserLinksRequest request)
public ListenableFuture batchUpdateUserLinks(BatchUpdateUserLinksRequest request)
Updates information about multiple users' links to an account or property.
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)
cancelDisplayVideo360AdvertiserLinkProposal(CancelDisplayVideo360AdvertiserLinkProposalRequest request)
public ListenableFuture 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.
createAccessBinding(CreateAccessBindingRequest request)
public ListenableFuture createAccessBinding(CreateAccessBindingRequest request)
Creates an access binding on an account or property.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<AccessBinding> | |
createAdSenseLink(CreateAdSenseLinkRequest request)
public ListenableFuture createAdSenseLink(CreateAdSenseLinkRequest request)
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<AdSenseLink> | |
createAudience(CreateAudienceRequest request)
public ListenableFuture createAudience(CreateAudienceRequest request)
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Audience> | |
createChannelGroup(CreateChannelGroupRequest request)
public ListenableFuture createChannelGroup(CreateChannelGroupRequest request)
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<ChannelGroup> | |
createConnectedSiteTag(CreateConnectedSiteTagRequest request)
public ListenableFuture 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.
createConversionEvent(CreateConversionEventRequest request)
public ListenableFuture createConversionEvent(CreateConversionEventRequest request)
Creates a conversion event with the specified attributes.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<ConversionEvent> | |
createCustomDimension(CreateCustomDimensionRequest request)
public ListenableFuture createCustomDimension(CreateCustomDimensionRequest request)
Creates a CustomDimension.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<CustomDimension> | |
createCustomMetric(CreateCustomMetricRequest request)
public ListenableFuture createCustomMetric(CreateCustomMetricRequest request)
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<CustomMetric> | |
createDataStream(CreateDataStreamRequest request)
public ListenableFuture createDataStream(CreateDataStreamRequest request)
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<DataStream> | |
createDisplayVideo360AdvertiserLink(CreateDisplayVideo360AdvertiserLinkRequest request)
public ListenableFuture 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.
createDisplayVideo360AdvertiserLinkProposal(CreateDisplayVideo360AdvertiserLinkProposalRequest request)
public ListenableFuture createDisplayVideo360AdvertiserLinkProposal(CreateDisplayVideo360AdvertiserLinkProposalRequest request)
Creates a DisplayVideo360AdvertiserLinkProposal.
createEventCreateRule(CreateEventCreateRuleRequest request)
public ListenableFuture createEventCreateRule(CreateEventCreateRuleRequest request)
Creates an EventCreateRule.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<EventCreateRule> | |
createExpandedDataSet(CreateExpandedDataSetRequest request)
public ListenableFuture createExpandedDataSet(CreateExpandedDataSetRequest request)
Creates a ExpandedDataSet.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<ExpandedDataSet> | |
createFirebaseLink(CreateFirebaseLinkRequest request)
public ListenableFuture 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 createGoogleAdsLink(CreateGoogleAdsLinkRequest request)
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<GoogleAdsLink> | |
createMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest request)
public ListenableFuture createMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest request)
Creates a measurement protocol secret.
createProperty(CreatePropertyRequest request)
public ListenableFuture createProperty(CreatePropertyRequest request)
Creates an "GA4" property with the specified location and attributes.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Property> | |
createSKAdNetworkConversionValueSchema(CreateSKAdNetworkConversionValueSchemaRequest request)
public ListenableFuture createSKAdNetworkConversionValueSchema(CreateSKAdNetworkConversionValueSchemaRequest request)
Creates a SKAdNetworkConversionValueSchema.
createSearchAds360Link(CreateSearchAds360LinkRequest request)
public ListenableFuture createSearchAds360Link(CreateSearchAds360LinkRequest request)
Creates a SearchAds360Link.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<SearchAds360Link> | |
createUserLink(CreateUserLinkRequest request)
public ListenableFuture 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.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<UserLink> | |
deleteAccessBinding(DeleteAccessBindingRequest request)
public ListenableFuture deleteAccessBinding(DeleteAccessBindingRequest request)
Deletes an access binding on an account or property.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Empty> | |
deleteAccount(DeleteAccountRequest request)
public ListenableFuture 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.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Empty> | |
deleteAdSenseLink(DeleteAdSenseLinkRequest request)
public ListenableFuture deleteAdSenseLink(DeleteAdSenseLinkRequest request)
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Empty> | |
deleteChannelGroup(DeleteChannelGroupRequest request)
public ListenableFuture deleteChannelGroup(DeleteChannelGroupRequest request)
Deletes a ChannelGroup on a property.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Empty> | |
deleteConnectedSiteTag(DeleteConnectedSiteTagRequest request)
public ListenableFuture deleteConnectedSiteTag(DeleteConnectedSiteTagRequest request)
Deletes a connected site tag for a Universal Analytics property.
Note: this has no effect on GA4 properties.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Empty> | |
deleteConversionEvent(DeleteConversionEventRequest request)
public ListenableFuture deleteConversionEvent(DeleteConversionEventRequest request)
Deletes a conversion event in a property.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Empty> | |
deleteDataStream(DeleteDataStreamRequest request)
public ListenableFuture deleteDataStream(DeleteDataStreamRequest request)
Deletes a DataStream on a property.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Empty> | |
deleteDisplayVideo360AdvertiserLink(DeleteDisplayVideo360AdvertiserLinkRequest request)
public ListenableFuture deleteDisplayVideo360AdvertiserLink(DeleteDisplayVideo360AdvertiserLinkRequest request)
Deletes a DisplayVideo360AdvertiserLink on a property.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Empty> | |
deleteDisplayVideo360AdvertiserLinkProposal(DeleteDisplayVideo360AdvertiserLinkProposalRequest request)
public ListenableFuture deleteDisplayVideo360AdvertiserLinkProposal(DeleteDisplayVideo360AdvertiserLinkProposalRequest request)
Deletes a DisplayVideo360AdvertiserLinkProposal on a property.
This can only be used on cancelled proposals.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Empty> | |
deleteEventCreateRule(DeleteEventCreateRuleRequest request)
public ListenableFuture deleteEventCreateRule(DeleteEventCreateRuleRequest request)
Deletes an EventCreateRule.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Empty> | |
deleteExpandedDataSet(DeleteExpandedDataSetRequest request)
public ListenableFuture deleteExpandedDataSet(DeleteExpandedDataSetRequest request)
Deletes a ExpandedDataSet on a property.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Empty> | |
deleteFirebaseLink(DeleteFirebaseLinkRequest request)
public ListenableFuture deleteFirebaseLink(DeleteFirebaseLinkRequest request)
Deletes a FirebaseLink on a property
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Empty> | |
deleteGoogleAdsLink(DeleteGoogleAdsLinkRequest request)
public ListenableFuture deleteGoogleAdsLink(DeleteGoogleAdsLinkRequest request)
Deletes a GoogleAdsLink on a property
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Empty> | |
deleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest request)
public ListenableFuture deleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest request)
Deletes target MeasurementProtocolSecret.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Empty> | |
deleteProperty(DeletePropertyRequest request)
public ListenableFuture 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.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Property> | |
deleteSKAdNetworkConversionValueSchema(DeleteSKAdNetworkConversionValueSchemaRequest request)
public ListenableFuture deleteSKAdNetworkConversionValueSchema(DeleteSKAdNetworkConversionValueSchemaRequest request)
Deletes target SKAdNetworkConversionValueSchema.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Empty> | |
deleteSearchAds360Link(DeleteSearchAds360LinkRequest request)
public ListenableFuture deleteSearchAds360Link(DeleteSearchAds360LinkRequest request)
Deletes a SearchAds360Link on a property.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Empty> | |
deleteUserLink(DeleteUserLinkRequest request)
public ListenableFuture deleteUserLink(DeleteUserLinkRequest request)
Deletes a user link on an account or property.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Empty> | |
fetchAutomatedGa4ConfigurationOptOut(FetchAutomatedGa4ConfigurationOptOutRequest request)
public ListenableFuture 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.
fetchConnectedGa4Property(FetchConnectedGa4PropertyRequest request)
public ListenableFuture fetchConnectedGa4Property(FetchConnectedGa4PropertyRequest request)
Given a specified UA property, looks up the GA4 property connected to it.
Note: this cannot be used with GA4 properties.
getAccessBinding(GetAccessBindingRequest request)
public ListenableFuture getAccessBinding(GetAccessBindingRequest request)
Gets information about an access binding.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<AccessBinding> | |
getAccount(GetAccountRequest request)
public ListenableFuture getAccount(GetAccountRequest request)
Lookup for a single Account.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Account> | |
getAdSenseLink(GetAdSenseLinkRequest request)
public ListenableFuture getAdSenseLink(GetAdSenseLinkRequest request)
Looks up a single AdSenseLink.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<AdSenseLink> | |
getAttributionSettings(GetAttributionSettingsRequest request)
public ListenableFuture getAttributionSettings(GetAttributionSettingsRequest request)
Lookup for a AttributionSettings singleton.
getAudience(GetAudienceRequest request)
public ListenableFuture getAudience(GetAudienceRequest request)
Lookup for a single Audience.
Audiences created before 2020 may not be supported.
Default audiences will not show filter definitions.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Audience> | |
getBigQueryLink(GetBigQueryLinkRequest request)
public ListenableFuture getBigQueryLink(GetBigQueryLinkRequest request)
Lookup for a single BigQuery Link.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<BigQueryLink> | |
getChannelGroup(GetChannelGroupRequest request)
public ListenableFuture getChannelGroup(GetChannelGroupRequest request)
Lookup for a single ChannelGroup.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<ChannelGroup> | |
getConversionEvent(GetConversionEventRequest request)
public ListenableFuture getConversionEvent(GetConversionEventRequest request)
Retrieve a single conversion event.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<ConversionEvent> | |
getCustomDimension(GetCustomDimensionRequest request)
public ListenableFuture getCustomDimension(GetCustomDimensionRequest request)
Lookup for a single CustomDimension.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<CustomDimension> | |
getCustomMetric(GetCustomMetricRequest request)
public ListenableFuture getCustomMetric(GetCustomMetricRequest request)
Lookup for a single CustomMetric.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<CustomMetric> | |
getDataRetentionSettings(GetDataRetentionSettingsRequest request)
public ListenableFuture getDataRetentionSettings(GetDataRetentionSettingsRequest request)
Returns the singleton data retention settings for this property.
getDataSharingSettings(GetDataSharingSettingsRequest request)
public ListenableFuture getDataSharingSettings(GetDataSharingSettingsRequest request)
Get data sharing settings on an account.
Data sharing settings are singletons.
getDataStream(GetDataStreamRequest request)
public ListenableFuture getDataStream(GetDataStreamRequest request)
Lookup for a single DataStream.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<DataStream> | |
getDisplayVideo360AdvertiserLink(GetDisplayVideo360AdvertiserLinkRequest request)
public ListenableFuture getDisplayVideo360AdvertiserLink(GetDisplayVideo360AdvertiserLinkRequest request)
Look up a single DisplayVideo360AdvertiserLink
getDisplayVideo360AdvertiserLinkProposal(GetDisplayVideo360AdvertiserLinkProposalRequest request)
public ListenableFuture getDisplayVideo360AdvertiserLinkProposal(GetDisplayVideo360AdvertiserLinkProposalRequest request)
Lookup for a single DisplayVideo360AdvertiserLinkProposal.
getEnhancedMeasurementSettings(GetEnhancedMeasurementSettingsRequest request)
public ListenableFuture 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.
getEventCreateRule(GetEventCreateRuleRequest request)
public ListenableFuture getEventCreateRule(GetEventCreateRuleRequest request)
Lookup for a single EventCreateRule.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<EventCreateRule> | |
getExpandedDataSet(GetExpandedDataSetRequest request)
public ListenableFuture getExpandedDataSet(GetExpandedDataSetRequest request)
Lookup for a single ExpandedDataSet.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<ExpandedDataSet> | |
getGlobalSiteTag(GetGlobalSiteTagRequest request)
public ListenableFuture getGlobalSiteTag(GetGlobalSiteTagRequest request)
Returns the Site Tag for the specified web stream.
Site Tags are immutable singletons.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<GlobalSiteTag> | |
getGoogleSignalsSettings(GetGoogleSignalsSettingsRequest request)
public ListenableFuture getGoogleSignalsSettings(GetGoogleSignalsSettingsRequest request)
Lookup for Google Signals settings for a property.
getMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest request)
public ListenableFuture getMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest request)
Lookup for a single "GA4" MeasurementProtocolSecret.
getProperty(GetPropertyRequest request)
public ListenableFuture getProperty(GetPropertyRequest request)
Lookup for a single "GA4" Property.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Property> | |
getSKAdNetworkConversionValueSchema(GetSKAdNetworkConversionValueSchemaRequest request)
public ListenableFuture getSKAdNetworkConversionValueSchema(GetSKAdNetworkConversionValueSchemaRequest request)
Looks up a single SKAdNetworkConversionValueSchema.
getSearchAds360Link(GetSearchAds360LinkRequest request)
public ListenableFuture getSearchAds360Link(GetSearchAds360LinkRequest request)
Look up a single SearchAds360Link
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<SearchAds360Link> | |
getUserLink(GetUserLinkRequest request)
public ListenableFuture getUserLink(GetUserLinkRequest request)
Gets information about a user's link to an account or property.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<UserLink> | |
listAccessBindings(ListAccessBindingsRequest request)
public ListenableFuture listAccessBindings(ListAccessBindingsRequest request)
Lists all access bindings on an account or property.
listAccountSummaries(ListAccountSummariesRequest request)
public ListenableFuture listAccountSummaries(ListAccountSummariesRequest request)
Returns summaries of all accounts accessible by the caller.
listAccounts(ListAccountsRequest request)
public ListenableFuture 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.
listAdSenseLinks(ListAdSenseLinksRequest request)
public ListenableFuture listAdSenseLinks(ListAdSenseLinksRequest request)
Lists AdSenseLinks on a property.
listAudiences(ListAudiencesRequest request)
public ListenableFuture listAudiences(ListAudiencesRequest request)
Lists Audiences on a property.
Audiences created before 2020 may not be supported.
Default audiences will not show filter definitions.
listBigQueryLinks(ListBigQueryLinksRequest request)
public ListenableFuture listBigQueryLinks(ListBigQueryLinksRequest request)
Lists BigQuery Links on a property.
listChannelGroups(ListChannelGroupsRequest request)
public ListenableFuture listChannelGroups(ListChannelGroupsRequest request)
Lists ChannelGroups on a property.
public ListenableFuture 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.
listConversionEvents(ListConversionEventsRequest request)
public ListenableFuture listConversionEvents(ListConversionEventsRequest request)
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 listCustomDimensions(ListCustomDimensionsRequest request)
Lists CustomDimensions on a property.
listCustomMetrics(ListCustomMetricsRequest request)
public ListenableFuture listCustomMetrics(ListCustomMetricsRequest request)
Lists CustomMetrics on a property.
listDataStreams(ListDataStreamsRequest request)
public ListenableFuture listDataStreams(ListDataStreamsRequest request)
Lists DataStreams on a property.
listDisplayVideo360AdvertiserLinkProposals(ListDisplayVideo360AdvertiserLinkProposalsRequest request)
public ListenableFuture listDisplayVideo360AdvertiserLinkProposals(ListDisplayVideo360AdvertiserLinkProposalsRequest request)
Lists DisplayVideo360AdvertiserLinkProposals on a property.
listDisplayVideo360AdvertiserLinks(ListDisplayVideo360AdvertiserLinksRequest request)
public ListenableFuture listDisplayVideo360AdvertiserLinks(ListDisplayVideo360AdvertiserLinksRequest request)
Lists all DisplayVideo360AdvertiserLinks on a property.
listEventCreateRules(ListEventCreateRulesRequest request)
public ListenableFuture listEventCreateRules(ListEventCreateRulesRequest request)
Lists EventCreateRules on a web data stream.
listExpandedDataSets(ListExpandedDataSetsRequest request)
public ListenableFuture listExpandedDataSets(ListExpandedDataSetsRequest request)
Lists ExpandedDataSets on a property.
listFirebaseLinks(ListFirebaseLinksRequest request)
public ListenableFuture listFirebaseLinks(ListFirebaseLinksRequest request)
Lists FirebaseLinks on a property.
Properties can have at most one FirebaseLink.
listGoogleAdsLinks(ListGoogleAdsLinksRequest request)
public ListenableFuture listGoogleAdsLinks(ListGoogleAdsLinksRequest request)
Lists GoogleAdsLinks on a property.
listMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest request)
public ListenableFuture listMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest request)
Returns child MeasurementProtocolSecrets under the specified parent
Property.
listProperties(ListPropertiesRequest request)
public ListenableFuture 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.
listSKAdNetworkConversionValueSchemas(ListSKAdNetworkConversionValueSchemasRequest request)
public ListenableFuture listSKAdNetworkConversionValueSchemas(ListSKAdNetworkConversionValueSchemasRequest request)
Lists SKAdNetworkConversionValueSchema on a stream.
Properties can have at most one SKAdNetworkConversionValueSchema.
listSearchAds360Links(ListSearchAds360LinksRequest request)
public ListenableFuture listSearchAds360Links(ListSearchAds360LinksRequest request)
Lists all SearchAds360Links on a property.
listUserLinks(ListUserLinksRequest request)
public ListenableFuture listUserLinks(ListUserLinksRequest request)
Lists all user links on an account or property.
provisionAccountTicket(ProvisionAccountTicketRequest request)
public ListenableFuture provisionAccountTicket(ProvisionAccountTicketRequest request)
Requests a ticket for creating an account.
runAccessReport(RunAccessReportRequest request)
public ListenableFuture 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.
searchChangeHistoryEvents(SearchChangeHistoryEventsRequest request)
public ListenableFuture searchChangeHistoryEvents(SearchChangeHistoryEventsRequest request)
Searches through all changes to an account or its children given the
specified set of filters.
setAutomatedGa4ConfigurationOptOut(SetAutomatedGa4ConfigurationOptOutRequest request)
public ListenableFuture 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.
updateAccessBinding(UpdateAccessBindingRequest request)
public ListenableFuture updateAccessBinding(UpdateAccessBindingRequest request)
Updates an access binding on an account or property.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<AccessBinding> | |
updateAccount(UpdateAccountRequest request)
public ListenableFuture updateAccount(UpdateAccountRequest request)
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Account> | |
updateAttributionSettings(UpdateAttributionSettingsRequest request)
public ListenableFuture updateAttributionSettings(UpdateAttributionSettingsRequest request)
Updates attribution settings on a property.
updateAudience(UpdateAudienceRequest request)
public ListenableFuture updateAudience(UpdateAudienceRequest request)
Updates an Audience on a property.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Audience> | |
updateChannelGroup(UpdateChannelGroupRequest request)
public ListenableFuture updateChannelGroup(UpdateChannelGroupRequest request)
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<ChannelGroup> | |
updateConversionEvent(UpdateConversionEventRequest request)
public ListenableFuture updateConversionEvent(UpdateConversionEventRequest request)
Updates a conversion event with the specified attributes.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<ConversionEvent> | |
updateCustomDimension(UpdateCustomDimensionRequest request)
public ListenableFuture updateCustomDimension(UpdateCustomDimensionRequest request)
Updates a CustomDimension on a property.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<CustomDimension> | |
updateCustomMetric(UpdateCustomMetricRequest request)
public ListenableFuture updateCustomMetric(UpdateCustomMetricRequest request)
Updates a CustomMetric on a property.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<CustomMetric> | |
updateDataRetentionSettings(UpdateDataRetentionSettingsRequest request)
public ListenableFuture updateDataRetentionSettings(UpdateDataRetentionSettingsRequest request)
Updates the singleton data retention settings for this property.
updateDataStream(UpdateDataStreamRequest request)
public ListenableFuture updateDataStream(UpdateDataStreamRequest request)
Updates a DataStream on a property.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<DataStream> | |
updateDisplayVideo360AdvertiserLink(UpdateDisplayVideo360AdvertiserLinkRequest request)
public ListenableFuture updateDisplayVideo360AdvertiserLink(UpdateDisplayVideo360AdvertiserLinkRequest request)
Updates a DisplayVideo360AdvertiserLink on a property.
updateEnhancedMeasurementSettings(UpdateEnhancedMeasurementSettingsRequest request)
public ListenableFuture 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.
updateEventCreateRule(UpdateEventCreateRuleRequest request)
public ListenableFuture updateEventCreateRule(UpdateEventCreateRuleRequest request)
Updates an EventCreateRule.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<EventCreateRule> | |
updateExpandedDataSet(UpdateExpandedDataSetRequest request)
public ListenableFuture updateExpandedDataSet(UpdateExpandedDataSetRequest request)
Updates a ExpandedDataSet on a property.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<ExpandedDataSet> | |
updateGoogleAdsLink(UpdateGoogleAdsLinkRequest request)
public ListenableFuture updateGoogleAdsLink(UpdateGoogleAdsLinkRequest request)
Updates a GoogleAdsLink on a property
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<GoogleAdsLink> | |
updateGoogleSignalsSettings(UpdateGoogleSignalsSettingsRequest request)
public ListenableFuture updateGoogleSignalsSettings(UpdateGoogleSignalsSettingsRequest request)
Updates Google Signals settings for a property.
updateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest request)
public ListenableFuture updateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest request)
Updates a measurement protocol secret.
updateProperty(UpdatePropertyRequest request)
public ListenableFuture updateProperty(UpdatePropertyRequest request)
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Property> | |
updateSKAdNetworkConversionValueSchema(UpdateSKAdNetworkConversionValueSchemaRequest request)
public ListenableFuture updateSKAdNetworkConversionValueSchema(UpdateSKAdNetworkConversionValueSchemaRequest request)
Updates a SKAdNetworkConversionValueSchema.
updateSearchAds360Link(UpdateSearchAds360LinkRequest request)
public ListenableFuture updateSearchAds360Link(UpdateSearchAds360LinkRequest request)
Updates a SearchAds360Link on a property.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<SearchAds360Link> | |
updateUserLink(UpdateUserLinkRequest request)
public ListenableFuture updateUserLink(UpdateUserLinkRequest request)
Updates a user link on an account or property.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<UserLink> | |
