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.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.
approveDisplayVideo360AdvertiserLinkProposal(ApproveDisplayVideo360AdvertiserLinkProposalRequest request)
public ListenableFuture<ApproveDisplayVideo360AdvertiserLinkProposalResponse> approveDisplayVideo360AdvertiserLinkProposal(ApproveDisplayVideo360AdvertiserLinkProposalRequest request)
Approves a DisplayVideo360AdvertiserLinkProposal.
The DisplayVideo360AdvertiserLinkProposal will be deleted and a new
DisplayVideo360AdvertiserLink will be created.
archiveAudience(ArchiveAudienceRequest request)
public ListenableFuture<Empty> archiveAudience(ArchiveAudienceRequest request)
Archives an Audience on a property.
| 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.
| 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> | |
batchCreateAccessBindings(BatchCreateAccessBindingsRequest request)
public ListenableFuture<BatchCreateAccessBindingsResponse> batchCreateAccessBindings(BatchCreateAccessBindingsRequest request)
Creates information about multiple access bindings to an account or
property.
This method is transactional. If any AccessBinding cannot be created, none
of the AccessBindings will be created.
batchDeleteAccessBindings(BatchDeleteAccessBindingsRequest request)
public ListenableFuture<Empty> batchDeleteAccessBindings(BatchDeleteAccessBindingsRequest 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<BatchGetAccessBindingsResponse> batchGetAccessBindings(BatchGetAccessBindingsRequest request)
Gets information about multiple access bindings to an account or property.
batchUpdateAccessBindings(BatchUpdateAccessBindingsRequest request)
public ListenableFuture<BatchUpdateAccessBindingsResponse> batchUpdateAccessBindings(BatchUpdateAccessBindingsRequest request)
Updates information about multiple access bindings 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<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.
createAccessBinding(CreateAccessBindingRequest request)
public ListenableFuture<AccessBinding> 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<AdSenseLink> createAdSenseLink(CreateAdSenseLinkRequest request)
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<AdSenseLink> | |
createAudience(CreateAudienceRequest request)
public ListenableFuture<Audience> createAudience(CreateAudienceRequest request)
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Audience> | |
createChannelGroup(CreateChannelGroupRequest request)
public ListenableFuture<ChannelGroup> createChannelGroup(CreateChannelGroupRequest request)
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<ChannelGroup> | |
createConnectedSiteTag(CreateConnectedSiteTagRequest request)
public ListenableFuture<CreateConnectedSiteTagResponse> createConnectedSiteTag(CreateConnectedSiteTagRequest request)
Creates a connected site tag for a Universal Analytics property. You can
create a maximum of 20 connected site tags per property.
Note: This API cannot be used on GA4 properties.
createConversionEvent(CreateConversionEventRequest request)
public ListenableFuture<ConversionEvent> 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<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> | |
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.
createDisplayVideo360AdvertiserLinkProposal(CreateDisplayVideo360AdvertiserLinkProposalRequest request)
public ListenableFuture<DisplayVideo360AdvertiserLinkProposal> createDisplayVideo360AdvertiserLinkProposal(CreateDisplayVideo360AdvertiserLinkProposalRequest request)
Creates a DisplayVideo360AdvertiserLinkProposal.
createEventCreateRule(CreateEventCreateRuleRequest request)
public ListenableFuture<EventCreateRule> createEventCreateRule(CreateEventCreateRuleRequest request)
Creates an EventCreateRule.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<EventCreateRule> | |
createExpandedDataSet(CreateExpandedDataSetRequest request)
public ListenableFuture<ExpandedDataSet> createExpandedDataSet(CreateExpandedDataSetRequest request)
Creates a ExpandedDataSet.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<ExpandedDataSet> | |
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> | |
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> | |
createRollupProperty(CreateRollupPropertyRequest request)
public ListenableFuture<CreateRollupPropertyResponse> createRollupProperty(CreateRollupPropertyRequest request)
Create a roll-up property and all roll-up property source links.
createRollupPropertySourceLink(CreateRollupPropertySourceLinkRequest request)
public ListenableFuture<RollupPropertySourceLink> createRollupPropertySourceLink(CreateRollupPropertySourceLinkRequest request)
Creates a roll-up property source link.
Only roll-up properties can have source links, so this method will throw an
error if used on other types of properties.
createSKAdNetworkConversionValueSchema(CreateSKAdNetworkConversionValueSchemaRequest request)
public ListenableFuture<SKAdNetworkConversionValueSchema> createSKAdNetworkConversionValueSchema(CreateSKAdNetworkConversionValueSchemaRequest request)
Creates a SKAdNetworkConversionValueSchema.
createSearchAds360Link(CreateSearchAds360LinkRequest request)
public ListenableFuture<SearchAds360Link> createSearchAds360Link(CreateSearchAds360LinkRequest request)
Creates a SearchAds360Link.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<SearchAds360Link> | |
createSubproperty(CreateSubpropertyRequest request)
public ListenableFuture<CreateSubpropertyResponse> createSubproperty(CreateSubpropertyRequest request)
Create a subproperty and a subproperty event filter that applies to the
created subproperty.
createSubpropertyEventFilter(CreateSubpropertyEventFilterRequest request)
public ListenableFuture<SubpropertyEventFilter> createSubpropertyEventFilter(CreateSubpropertyEventFilterRequest request)
Creates a subproperty Event Filter.
deleteAccessBinding(DeleteAccessBindingRequest request)
public ListenableFuture<Empty> 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<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> | |
deleteAdSenseLink(DeleteAdSenseLinkRequest request)
public ListenableFuture<Empty> deleteAdSenseLink(DeleteAdSenseLinkRequest request)
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Empty> | |
deleteChannelGroup(DeleteChannelGroupRequest request)
public ListenableFuture<Empty> deleteChannelGroup(DeleteChannelGroupRequest request)
Deletes a ChannelGroup on a property.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Empty> | |
deleteConnectedSiteTag(DeleteConnectedSiteTagRequest request)
public ListenableFuture<Empty> deleteConnectedSiteTag(DeleteConnectedSiteTagRequest request)
Deletes a connected site tag for a Universal Analytics property.
Note: this has no effect on GA4 properties.
| 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.
| 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> | |
deleteDisplayVideo360AdvertiserLink(DeleteDisplayVideo360AdvertiserLinkRequest request)
public ListenableFuture<Empty> deleteDisplayVideo360AdvertiserLink(DeleteDisplayVideo360AdvertiserLinkRequest request)
Deletes a DisplayVideo360AdvertiserLink on a property.
| 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.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Empty> | |
deleteEventCreateRule(DeleteEventCreateRuleRequest request)
public ListenableFuture<Empty> deleteEventCreateRule(DeleteEventCreateRuleRequest request)
Deletes an EventCreateRule.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Empty> | |
deleteExpandedDataSet(DeleteExpandedDataSetRequest request)
public ListenableFuture<Empty> deleteExpandedDataSet(DeleteExpandedDataSetRequest request)
Deletes a ExpandedDataSet 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> | |
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> | |
deleteRollupPropertySourceLink(DeleteRollupPropertySourceLinkRequest request)
public ListenableFuture<Empty> deleteRollupPropertySourceLink(DeleteRollupPropertySourceLinkRequest request)
Deletes a roll-up property source link.
Only roll-up properties can have source links, so this method will throw an
error if used on other types of properties.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Empty> | |
deleteSKAdNetworkConversionValueSchema(DeleteSKAdNetworkConversionValueSchemaRequest request)
public ListenableFuture<Empty> deleteSKAdNetworkConversionValueSchema(DeleteSKAdNetworkConversionValueSchemaRequest request)
Deletes target SKAdNetworkConversionValueSchema.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Empty> | |
deleteSearchAds360Link(DeleteSearchAds360LinkRequest request)
public ListenableFuture<Empty> deleteSearchAds360Link(DeleteSearchAds360LinkRequest request)
Deletes a SearchAds360Link on a property.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Empty> | |
deleteSubpropertyEventFilter(DeleteSubpropertyEventFilterRequest request)
public ListenableFuture<Empty> deleteSubpropertyEventFilter(DeleteSubpropertyEventFilterRequest request)
Deletes a subproperty event filter.
| 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.
fetchConnectedGa4Property(FetchConnectedGa4PropertyRequest request)
public ListenableFuture<FetchConnectedGa4PropertyResponse> fetchConnectedGa4Property(FetchConnectedGa4PropertyRequest request)
Given a specified UA property, looks up the GA4 property connected to it.
Note: this cannot be used with GA4 properties.
getAccessBinding(GetAccessBindingRequest request)
public ListenableFuture<AccessBinding> getAccessBinding(GetAccessBindingRequest request)
Gets information about an access binding.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<AccessBinding> | |
getAccount(GetAccountRequest request)
public ListenableFuture<Account> getAccount(GetAccountRequest request)
Lookup for a single Account.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Account> | |
getAdSenseLink(GetAdSenseLinkRequest request)
public ListenableFuture<AdSenseLink> getAdSenseLink(GetAdSenseLinkRequest request)
Looks up a single AdSenseLink.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<AdSenseLink> | |
getAttributionSettings(GetAttributionSettingsRequest request)
public ListenableFuture<AttributionSettings> getAttributionSettings(GetAttributionSettingsRequest request)
Lookup for a AttributionSettings singleton.
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.
| 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.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<BigQueryLink> | |
getChannelGroup(GetChannelGroupRequest request)
public ListenableFuture<ChannelGroup> getChannelGroup(GetChannelGroupRequest request)
Lookup for a single ChannelGroup.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<ChannelGroup> | |
getConversionEvent(GetConversionEventRequest request)
public ListenableFuture<ConversionEvent> getConversionEvent(GetConversionEventRequest request)
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> | |
getDataRedactionSettings(GetDataRedactionSettingsRequest request)
public ListenableFuture<DataRedactionSettings> getDataRedactionSettings(GetDataRedactionSettingsRequest request)
Lookup for a single DataRedactionSettings.
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.
getDataStream(GetDataStreamRequest request)
public ListenableFuture<DataStream> getDataStream(GetDataStreamRequest request)
Lookup for a single DataStream.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<DataStream> | |
getDisplayVideo360AdvertiserLink(GetDisplayVideo360AdvertiserLinkRequest request)
public ListenableFuture<DisplayVideo360AdvertiserLink> getDisplayVideo360AdvertiserLink(GetDisplayVideo360AdvertiserLinkRequest request)
Look up a single DisplayVideo360AdvertiserLink
getDisplayVideo360AdvertiserLinkProposal(GetDisplayVideo360AdvertiserLinkProposalRequest request)
public ListenableFuture<DisplayVideo360AdvertiserLinkProposal> getDisplayVideo360AdvertiserLinkProposal(GetDisplayVideo360AdvertiserLinkProposalRequest request)
Lookup for a single DisplayVideo360AdvertiserLinkProposal.
getEnhancedMeasurementSettings(GetEnhancedMeasurementSettingsRequest request)
public ListenableFuture<EnhancedMeasurementSettings> getEnhancedMeasurementSettings(GetEnhancedMeasurementSettingsRequest request)
Returns the enhanced measurement settings for this data stream.
Note that the stream must enable enhanced measurement for these settings to
take effect.
getEventCreateRule(GetEventCreateRuleRequest request)
public ListenableFuture<EventCreateRule> getEventCreateRule(GetEventCreateRuleRequest request)
Lookup for a single EventCreateRule.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<EventCreateRule> | |
getExpandedDataSet(GetExpandedDataSetRequest request)
public ListenableFuture<ExpandedDataSet> getExpandedDataSet(GetExpandedDataSetRequest request)
Lookup for a single ExpandedDataSet.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<ExpandedDataSet> | |
getGlobalSiteTag(GetGlobalSiteTagRequest request)
public ListenableFuture<GlobalSiteTag> getGlobalSiteTag(GetGlobalSiteTagRequest request)
Returns the Site Tag for the specified web stream.
Site Tags are immutable singletons.
| 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.
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> | |
getRollupPropertySourceLink(GetRollupPropertySourceLinkRequest request)
public ListenableFuture<RollupPropertySourceLink> getRollupPropertySourceLink(GetRollupPropertySourceLinkRequest request)
Lookup for a single roll-up property source Link.
Only roll-up properties can have source links, so this method will throw an
error if used on other types of properties.
getSKAdNetworkConversionValueSchema(GetSKAdNetworkConversionValueSchemaRequest request)
public ListenableFuture<SKAdNetworkConversionValueSchema> getSKAdNetworkConversionValueSchema(GetSKAdNetworkConversionValueSchemaRequest request)
Looks up a single SKAdNetworkConversionValueSchema.
getSearchAds360Link(GetSearchAds360LinkRequest request)
public ListenableFuture<SearchAds360Link> getSearchAds360Link(GetSearchAds360LinkRequest request)
Look up a single SearchAds360Link
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<SearchAds360Link> | |
listAccessBindings(ListAccessBindingsRequest request)
public ListenableFuture<ListAccessBindingsResponse> listAccessBindings(ListAccessBindingsRequest request)
Lists all access bindings on an account or 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.
listAdSenseLinks(ListAdSenseLinksRequest request)
public ListenableFuture<ListAdSenseLinksResponse> listAdSenseLinks(ListAdSenseLinksRequest request)
Lists AdSenseLinks on a property.
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.
listBigQueryLinks(ListBigQueryLinksRequest request)
public ListenableFuture<ListBigQueryLinksResponse> listBigQueryLinks(ListBigQueryLinksRequest request)
Lists BigQuery Links on a property.
listChannelGroups(ListChannelGroupsRequest request)
public ListenableFuture<ListChannelGroupsResponse> listChannelGroups(ListChannelGroupsRequest request)
Lists ChannelGroups on a property.
public ListenableFuture<ListConnectedSiteTagsResponse> listConnectedSiteTags(ListConnectedSiteTagsRequest request)
Lists the connected site tags for a Universal Analytics property. A maximum
of 20 connected site tags will be returned. Note: this has no effect on GA4
property.
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.
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.
listDisplayVideo360AdvertiserLinkProposals(ListDisplayVideo360AdvertiserLinkProposalsRequest request)
public ListenableFuture<ListDisplayVideo360AdvertiserLinkProposalsResponse> listDisplayVideo360AdvertiserLinkProposals(ListDisplayVideo360AdvertiserLinkProposalsRequest request)
Lists DisplayVideo360AdvertiserLinkProposals on a property.
listDisplayVideo360AdvertiserLinks(ListDisplayVideo360AdvertiserLinksRequest request)
public ListenableFuture<ListDisplayVideo360AdvertiserLinksResponse> listDisplayVideo360AdvertiserLinks(ListDisplayVideo360AdvertiserLinksRequest request)
Lists all DisplayVideo360AdvertiserLinks on a property.
listEventCreateRules(ListEventCreateRulesRequest request)
public ListenableFuture<ListEventCreateRulesResponse> listEventCreateRules(ListEventCreateRulesRequest request)
Lists EventCreateRules on a web data stream.
listExpandedDataSets(ListExpandedDataSetsRequest request)
public ListenableFuture<ListExpandedDataSetsResponse> listExpandedDataSets(ListExpandedDataSetsRequest request)
Lists ExpandedDataSets 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.
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.
listRollupPropertySourceLinks(ListRollupPropertySourceLinksRequest request)
public ListenableFuture<ListRollupPropertySourceLinksResponse> listRollupPropertySourceLinks(ListRollupPropertySourceLinksRequest request)
Lists roll-up property source Links on a property.
Only roll-up properties can have source links, so this method will throw an
error if used on other types of properties.
listSKAdNetworkConversionValueSchemas(ListSKAdNetworkConversionValueSchemasRequest request)
public ListenableFuture<ListSKAdNetworkConversionValueSchemasResponse> listSKAdNetworkConversionValueSchemas(ListSKAdNetworkConversionValueSchemasRequest request)
Lists SKAdNetworkConversionValueSchema on a stream.
Properties can have at most one SKAdNetworkConversionValueSchema.
listSearchAds360Links(ListSearchAds360LinksRequest request)
public ListenableFuture<ListSearchAds360LinksResponse> listSearchAds360Links(ListSearchAds360LinksRequest request)
Lists all SearchAds360Links on a property.
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. 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<SearchChangeHistoryEventsResponse> searchChangeHistoryEvents(SearchChangeHistoryEventsRequest request)
Searches through all changes to an account or its children given the
specified set of filters.
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.
updateAccessBinding(UpdateAccessBindingRequest request)
public ListenableFuture<AccessBinding> 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<Account> updateAccount(UpdateAccountRequest request)
| 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.
updateAudience(UpdateAudienceRequest request)
public ListenableFuture<Audience> updateAudience(UpdateAudienceRequest request)
Updates an Audience on a property.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<Audience> | |
updateChannelGroup(UpdateChannelGroupRequest request)
public ListenableFuture<ChannelGroup> updateChannelGroup(UpdateChannelGroupRequest request)
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<ChannelGroup> | |
updateConversionEvent(UpdateConversionEventRequest request)
public ListenableFuture<ConversionEvent> 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<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> | |
updateDataRedactionSettings(UpdateDataRedactionSettingsRequest request)
public ListenableFuture<DataRedactionSettings> updateDataRedactionSettings(UpdateDataRedactionSettingsRequest request)
Updates a DataRedactionSettings on a property.
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> | |
updateDisplayVideo360AdvertiserLink(UpdateDisplayVideo360AdvertiserLinkRequest request)
public ListenableFuture<DisplayVideo360AdvertiserLink> updateDisplayVideo360AdvertiserLink(UpdateDisplayVideo360AdvertiserLinkRequest request)
Updates a DisplayVideo360AdvertiserLink on a property.
updateEnhancedMeasurementSettings(UpdateEnhancedMeasurementSettingsRequest request)
public ListenableFuture<EnhancedMeasurementSettings> updateEnhancedMeasurementSettings(UpdateEnhancedMeasurementSettingsRequest request)
Updates the enhanced measurement settings for this data stream.
Note that the stream must enable enhanced measurement for these settings to
take effect.
updateEventCreateRule(UpdateEventCreateRuleRequest request)
public ListenableFuture<EventCreateRule> updateEventCreateRule(UpdateEventCreateRuleRequest request)
Updates an EventCreateRule.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<EventCreateRule> | |
updateExpandedDataSet(UpdateExpandedDataSetRequest request)
public ListenableFuture<ExpandedDataSet> updateExpandedDataSet(UpdateExpandedDataSetRequest request)
Updates a ExpandedDataSet on a property.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<ExpandedDataSet> | |
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> | |
updateGoogleSignalsSettings(UpdateGoogleSignalsSettingsRequest request)
public ListenableFuture<GoogleSignalsSettings> updateGoogleSignalsSettings(UpdateGoogleSignalsSettingsRequest request)
Updates Google Signals settings for a property.
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> | |
updateSKAdNetworkConversionValueSchema(UpdateSKAdNetworkConversionValueSchemaRequest request)
public ListenableFuture<SKAdNetworkConversionValueSchema> updateSKAdNetworkConversionValueSchema(UpdateSKAdNetworkConversionValueSchemaRequest request)
Updates a SKAdNetworkConversionValueSchema.
updateSearchAds360Link(UpdateSearchAds360LinkRequest request)
public ListenableFuture<SearchAds360Link> updateSearchAds360Link(UpdateSearchAds360LinkRequest request)
Updates a SearchAds360Link on a property.
| Returns |
|---|
| Type | Description |
com.google.common.util.concurrent.ListenableFuture<SearchAds360Link> | |
