Class AnalyticsAdminServiceGrpc.AnalyticsAdminServiceFutureStub (0.73.0) 

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 Google Analytics Admin API.

Inheritance

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

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.

Parameter
Name Description
request AcknowledgeUserDataCollectionRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<AcknowledgeUserDataCollectionResponse>

approveDisplayVideo360AdvertiserLinkProposal(ApproveDisplayVideo360AdvertiserLinkProposalRequest request)

public ListenableFuture approveDisplayVideo360AdvertiserLinkProposal(ApproveDisplayVideo360AdvertiserLinkProposalRequest request)

Approves a DisplayVideo360AdvertiserLinkProposal. The DisplayVideo360AdvertiserLinkProposal will be deleted and a new DisplayVideo360AdvertiserLink will be created.

Parameter
Name Description
request ApproveDisplayVideo360AdvertiserLinkProposalRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ApproveDisplayVideo360AdvertiserLinkProposalResponse>

archiveAudience(ArchiveAudienceRequest request)

public ListenableFuture archiveAudience(ArchiveAudienceRequest request)

Archives an Audience on a property.

Parameter
Name Description
request ArchiveAudienceRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

archiveCustomDimension(ArchiveCustomDimensionRequest request)

public ListenableFuture archiveCustomDimension(ArchiveCustomDimensionRequest request)

Archives a CustomDimension on a property.

Parameter
Name Description
request ArchiveCustomDimensionRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

archiveCustomMetric(ArchiveCustomMetricRequest request)

public ListenableFuture archiveCustomMetric(ArchiveCustomMetricRequest request)

Archives a CustomMetric on a property.

Parameter
Name Description
request ArchiveCustomMetricRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

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.

Parameter
Name Description
request BatchCreateAccessBindingsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<BatchCreateAccessBindingsResponse>

batchDeleteAccessBindings(BatchDeleteAccessBindingsRequest request)

public ListenableFuture batchDeleteAccessBindings(BatchDeleteAccessBindingsRequest request)

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

Parameter
Name Description
request BatchDeleteAccessBindingsRequest
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.

Parameter
Name Description
request BatchGetAccessBindingsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<BatchGetAccessBindingsResponse>

batchUpdateAccessBindings(BatchUpdateAccessBindingsRequest request)

public ListenableFuture batchUpdateAccessBindings(BatchUpdateAccessBindingsRequest request)

Updates information about multiple access bindings to an account or property.

Parameter
Name Description
request BatchUpdateAccessBindingsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<BatchUpdateAccessBindingsResponse>

build(Channel channel, CallOptions callOptions)

protected AnalyticsAdminServiceGrpc.AnalyticsAdminServiceFutureStub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
AnalyticsAdminServiceGrpc.AnalyticsAdminServiceFutureStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

cancelDisplayVideo360AdvertiserLinkProposal(CancelDisplayVideo360AdvertiserLinkProposalRequest request)

public ListenableFuture cancelDisplayVideo360AdvertiserLinkProposal(CancelDisplayVideo360AdvertiserLinkProposalRequest request)

Cancels a DisplayVideo360AdvertiserLinkProposal. Cancelling can mean either:

  • Declining a proposal initiated from Display & Video 360
  • Withdrawing a proposal initiated from Google Analytics After being cancelled, a proposal will eventually be deleted automatically.
Parameter
Name Description
request CancelDisplayVideo360AdvertiserLinkProposalRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<DisplayVideo360AdvertiserLinkProposal>

createAccessBinding(CreateAccessBindingRequest request)

public ListenableFuture createAccessBinding(CreateAccessBindingRequest request)

Creates an access binding on an account or property.

Parameter
Name Description
request CreateAccessBindingRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<AccessBinding>

createAdSenseLink(CreateAdSenseLinkRequest request)

public ListenableFuture createAdSenseLink(CreateAdSenseLinkRequest request)

Creates an AdSenseLink.

Parameter
Name Description
request CreateAdSenseLinkRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<AdSenseLink>

createAudience(CreateAudienceRequest request)

public ListenableFuture createAudience(CreateAudienceRequest request)

Creates an Audience.

Parameter
Name Description
request CreateAudienceRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Audience>

createBigQueryLink(CreateBigQueryLinkRequest request)

public ListenableFuture createBigQueryLink(CreateBigQueryLinkRequest request)

Creates a BigQueryLink.

Parameter
Name Description
request CreateBigQueryLinkRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<BigQueryLink>

createCalculatedMetric(CreateCalculatedMetricRequest request)

public ListenableFuture createCalculatedMetric(CreateCalculatedMetricRequest request)

Creates a CalculatedMetric.

Parameter
Name Description
request CreateCalculatedMetricRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<CalculatedMetric>

createChannelGroup(CreateChannelGroupRequest request)

public ListenableFuture createChannelGroup(CreateChannelGroupRequest request)

Creates a ChannelGroup.

Parameter
Name Description
request CreateChannelGroupRequest
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.

Parameter
Name Description
request CreateConnectedSiteTagRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<CreateConnectedSiteTagResponse>

createConversionEvent(CreateConversionEventRequest request) (deprecated)

public ListenableFuture createConversionEvent(CreateConversionEventRequest request)

Deprecated: Use CreateKeyEvent instead. Creates a conversion event with the specified attributes.

Parameter
Name Description
request CreateConversionEventRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ConversionEvent>

createCustomDimension(CreateCustomDimensionRequest request)

public ListenableFuture createCustomDimension(CreateCustomDimensionRequest request)

Creates a CustomDimension.

Parameter
Name Description
request CreateCustomDimensionRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<CustomDimension>

createCustomMetric(CreateCustomMetricRequest request)

public ListenableFuture createCustomMetric(CreateCustomMetricRequest request)

Creates a CustomMetric.

Parameter
Name Description
request CreateCustomMetricRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<CustomMetric>

createDataStream(CreateDataStreamRequest request)

public ListenableFuture createDataStream(CreateDataStreamRequest request)

Creates a DataStream.

Parameter
Name Description
request CreateDataStreamRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<DataStream>

createDisplayVideo360AdvertiserLink(CreateDisplayVideo360AdvertiserLinkRequest request)

public ListenableFuture createDisplayVideo360AdvertiserLink(CreateDisplayVideo360AdvertiserLinkRequest request)

Creates a DisplayVideo360AdvertiserLink. This can only be utilized by users who have proper authorization both on the Google Analytics property and on the Display & Video 360 advertiser. Users who do not have access to the Display & Video 360 advertiser should instead seek to create a DisplayVideo360LinkProposal.

Parameter
Name Description
request CreateDisplayVideo360AdvertiserLinkRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<DisplayVideo360AdvertiserLink>

createDisplayVideo360AdvertiserLinkProposal(CreateDisplayVideo360AdvertiserLinkProposalRequest request)

public ListenableFuture createDisplayVideo360AdvertiserLinkProposal(CreateDisplayVideo360AdvertiserLinkProposalRequest request)

Creates a DisplayVideo360AdvertiserLinkProposal.

Parameter
Name Description
request CreateDisplayVideo360AdvertiserLinkProposalRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<DisplayVideo360AdvertiserLinkProposal>

createEventCreateRule(CreateEventCreateRuleRequest request)

public ListenableFuture createEventCreateRule(CreateEventCreateRuleRequest request)

Creates an EventCreateRule.

Parameter
Name Description
request CreateEventCreateRuleRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<EventCreateRule>

createEventEditRule(CreateEventEditRuleRequest request)

public ListenableFuture createEventEditRule(CreateEventEditRuleRequest request)

Creates an EventEditRule.

Parameter
Name Description
request CreateEventEditRuleRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<EventEditRule>

createExpandedDataSet(CreateExpandedDataSetRequest request)

public ListenableFuture createExpandedDataSet(CreateExpandedDataSetRequest request)

Creates a ExpandedDataSet.

Parameter
Name Description
request CreateExpandedDataSetRequest
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.

Parameter
Name Description
request CreateFirebaseLinkRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<FirebaseLink>

createGoogleAdsLink(CreateGoogleAdsLinkRequest request)

public ListenableFuture createGoogleAdsLink(CreateGoogleAdsLinkRequest request)

Creates a GoogleAdsLink.

Parameter
Name Description
request CreateGoogleAdsLinkRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<GoogleAdsLink>

createKeyEvent(CreateKeyEventRequest request)

public ListenableFuture createKeyEvent(CreateKeyEventRequest request)

Creates a Key Event.

Parameter
Name Description
request CreateKeyEventRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<KeyEvent>

createMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest request)

public ListenableFuture createMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest request)

Creates a measurement protocol secret.

Parameter
Name Description
request CreateMeasurementProtocolSecretRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<MeasurementProtocolSecret>

createProperty(CreatePropertyRequest request)

public ListenableFuture createProperty(CreatePropertyRequest request)

Creates a Google Analytics property with the specified location and attributes.

Parameter
Name Description
request CreatePropertyRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Property>

createReportingDataAnnotation(CreateReportingDataAnnotationRequest request)

public ListenableFuture createReportingDataAnnotation(CreateReportingDataAnnotationRequest request)

Creates a Reporting Data Annotation.

Parameter
Name Description
request CreateReportingDataAnnotationRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ReportingDataAnnotation>

createRollupProperty(CreateRollupPropertyRequest request)

public ListenableFuture createRollupProperty(CreateRollupPropertyRequest request)

Create a roll-up property and all roll-up property source links.

Parameter
Name Description
request CreateRollupPropertyRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<CreateRollupPropertyResponse>

createRollupPropertySourceLink(CreateRollupPropertySourceLinkRequest request)

public ListenableFuture 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.

Parameter
Name Description
request CreateRollupPropertySourceLinkRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<RollupPropertySourceLink>

createSKAdNetworkConversionValueSchema(CreateSKAdNetworkConversionValueSchemaRequest request)

public ListenableFuture createSKAdNetworkConversionValueSchema(CreateSKAdNetworkConversionValueSchemaRequest request)

Creates a SKAdNetworkConversionValueSchema.

Parameter
Name Description
request CreateSKAdNetworkConversionValueSchemaRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<SKAdNetworkConversionValueSchema>

createSearchAds360Link(CreateSearchAds360LinkRequest request)

public ListenableFuture createSearchAds360Link(CreateSearchAds360LinkRequest request)

Creates a SearchAds360Link.

Parameter
Name Description
request CreateSearchAds360LinkRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<SearchAds360Link>

createSubpropertyEventFilter(CreateSubpropertyEventFilterRequest request)

public ListenableFuture createSubpropertyEventFilter(CreateSubpropertyEventFilterRequest request)

Creates a subproperty Event Filter.

Parameter
Name Description
request CreateSubpropertyEventFilterRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<SubpropertyEventFilter>

deleteAccessBinding(DeleteAccessBindingRequest request)

public ListenableFuture deleteAccessBinding(DeleteAccessBindingRequest request)

Deletes an access binding on an account or property.

Parameter
Name Description
request DeleteAccessBindingRequest
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, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found.

Parameter
Name Description
request DeleteAccountRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteAdSenseLink(DeleteAdSenseLinkRequest request)

public ListenableFuture deleteAdSenseLink(DeleteAdSenseLinkRequest request)

Deletes an AdSenseLink.

Parameter
Name Description
request DeleteAdSenseLinkRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteBigQueryLink(DeleteBigQueryLinkRequest request)

public ListenableFuture deleteBigQueryLink(DeleteBigQueryLinkRequest request)

Deletes a BigQueryLink on a property.

Parameter
Name Description
request DeleteBigQueryLinkRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteCalculatedMetric(DeleteCalculatedMetricRequest request)

public ListenableFuture deleteCalculatedMetric(DeleteCalculatedMetricRequest request)

Deletes a CalculatedMetric on a property.

Parameter
Name Description
request DeleteCalculatedMetricRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteChannelGroup(DeleteChannelGroupRequest request)

public ListenableFuture deleteChannelGroup(DeleteChannelGroupRequest request)

Deletes a ChannelGroup on a property.

Parameter
Name Description
request DeleteChannelGroupRequest
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.

Parameter
Name Description
request DeleteConnectedSiteTagRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteConversionEvent(DeleteConversionEventRequest request) (deprecated)

public ListenableFuture deleteConversionEvent(DeleteConversionEventRequest request)

Deprecated: Use DeleteKeyEvent instead. Deletes a conversion event in a property.

Parameter
Name Description
request DeleteConversionEventRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteDataStream(DeleteDataStreamRequest request)

public ListenableFuture deleteDataStream(DeleteDataStreamRequest request)

Deletes a DataStream on a property.

Parameter
Name Description
request DeleteDataStreamRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteDisplayVideo360AdvertiserLink(DeleteDisplayVideo360AdvertiserLinkRequest request)

public ListenableFuture deleteDisplayVideo360AdvertiserLink(DeleteDisplayVideo360AdvertiserLinkRequest request)

Deletes a DisplayVideo360AdvertiserLink on a property.

Parameter
Name Description
request DeleteDisplayVideo360AdvertiserLinkRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteDisplayVideo360AdvertiserLinkProposal(DeleteDisplayVideo360AdvertiserLinkProposalRequest request)

public ListenableFuture deleteDisplayVideo360AdvertiserLinkProposal(DeleteDisplayVideo360AdvertiserLinkProposalRequest request)

Deletes a DisplayVideo360AdvertiserLinkProposal on a property. This can only be used on cancelled proposals.

Parameter
Name Description
request DeleteDisplayVideo360AdvertiserLinkProposalRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteEventCreateRule(DeleteEventCreateRuleRequest request)

public ListenableFuture deleteEventCreateRule(DeleteEventCreateRuleRequest request)

Deletes an EventCreateRule.

Parameter
Name Description
request DeleteEventCreateRuleRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteEventEditRule(DeleteEventEditRuleRequest request)

public ListenableFuture deleteEventEditRule(DeleteEventEditRuleRequest request)

Deletes an EventEditRule.

Parameter
Name Description
request DeleteEventEditRuleRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteExpandedDataSet(DeleteExpandedDataSetRequest request)

public ListenableFuture deleteExpandedDataSet(DeleteExpandedDataSetRequest request)

Deletes a ExpandedDataSet on a property.

Parameter
Name Description
request DeleteExpandedDataSetRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteFirebaseLink(DeleteFirebaseLinkRequest request)

public ListenableFuture deleteFirebaseLink(DeleteFirebaseLinkRequest request)

Deletes a FirebaseLink on a property

Parameter
Name Description
request DeleteFirebaseLinkRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteGoogleAdsLink(DeleteGoogleAdsLinkRequest request)

public ListenableFuture deleteGoogleAdsLink(DeleteGoogleAdsLinkRequest request)

Deletes a GoogleAdsLink on a property

Parameter
Name Description
request DeleteGoogleAdsLinkRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteKeyEvent(DeleteKeyEventRequest request)

public ListenableFuture deleteKeyEvent(DeleteKeyEventRequest request)

Deletes a Key Event.

Parameter
Name Description
request DeleteKeyEventRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest request)

public ListenableFuture deleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest request)

Deletes target MeasurementProtocolSecret.

Parameter
Name Description
request DeleteMeasurementProtocolSecretRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteProperty(DeletePropertyRequest request)

public ListenableFuture 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.

Parameter
Name Description
request DeletePropertyRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Property>

deleteReportingDataAnnotation(DeleteReportingDataAnnotationRequest request)

public ListenableFuture deleteReportingDataAnnotation(DeleteReportingDataAnnotationRequest request)

Deletes a Reporting Data Annotation.

Parameter
Name Description
request DeleteReportingDataAnnotationRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteRollupPropertySourceLink(DeleteRollupPropertySourceLinkRequest request)

public ListenableFuture 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.

Parameter
Name Description
request DeleteRollupPropertySourceLinkRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteSKAdNetworkConversionValueSchema(DeleteSKAdNetworkConversionValueSchemaRequest request)

public ListenableFuture deleteSKAdNetworkConversionValueSchema(DeleteSKAdNetworkConversionValueSchemaRequest request)

Deletes target SKAdNetworkConversionValueSchema.

Parameter
Name Description
request DeleteSKAdNetworkConversionValueSchemaRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteSearchAds360Link(DeleteSearchAds360LinkRequest request)

public ListenableFuture deleteSearchAds360Link(DeleteSearchAds360LinkRequest request)

Deletes a SearchAds360Link on a property.

Parameter
Name Description
request DeleteSearchAds360LinkRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteSubpropertyEventFilter(DeleteSubpropertyEventFilterRequest request)

public ListenableFuture deleteSubpropertyEventFilter(DeleteSubpropertyEventFilterRequest request)

Deletes a subproperty event filter.

Parameter
Name Description
request DeleteSubpropertyEventFilterRequest
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.

Parameter
Name Description
request FetchAutomatedGa4ConfigurationOptOutRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<FetchAutomatedGa4ConfigurationOptOutResponse>

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.

Parameter
Name Description
request FetchConnectedGa4PropertyRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<FetchConnectedGa4PropertyResponse>

getAccessBinding(GetAccessBindingRequest request)

public ListenableFuture getAccessBinding(GetAccessBindingRequest request)

Gets information about an access binding.

Parameter
Name Description
request GetAccessBindingRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<AccessBinding>

getAccount(GetAccountRequest request)

public ListenableFuture getAccount(GetAccountRequest request)

Lookup for a single Account.

Parameter
Name Description
request GetAccountRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Account>

getAdSenseLink(GetAdSenseLinkRequest request)

public ListenableFuture getAdSenseLink(GetAdSenseLinkRequest request)

Looks up a single AdSenseLink.

Parameter
Name Description
request GetAdSenseLinkRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<AdSenseLink>

getAttributionSettings(GetAttributionSettingsRequest request)

public ListenableFuture getAttributionSettings(GetAttributionSettingsRequest request)

Lookup for a AttributionSettings singleton.

Parameter
Name Description
request GetAttributionSettingsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<AttributionSettings>

getAudience(GetAudienceRequest request)

public ListenableFuture getAudience(GetAudienceRequest request)

Lookup for a single Audience. Audiences created before 2020 may not be supported. Default audiences will not show filter definitions.

Parameter
Name Description
request GetAudienceRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Audience>

getBigQueryLink(GetBigQueryLinkRequest request)

public ListenableFuture getBigQueryLink(GetBigQueryLinkRequest request)

Lookup for a single BigQuery Link.

Parameter
Name Description
request GetBigQueryLinkRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<BigQueryLink>

getCalculatedMetric(GetCalculatedMetricRequest request)

public ListenableFuture getCalculatedMetric(GetCalculatedMetricRequest request)

Lookup for a single CalculatedMetric.

Parameter
Name Description
request GetCalculatedMetricRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<CalculatedMetric>

getChannelGroup(GetChannelGroupRequest request)

public ListenableFuture getChannelGroup(GetChannelGroupRequest request)

Lookup for a single ChannelGroup.

Parameter
Name Description
request GetChannelGroupRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ChannelGroup>

getConversionEvent(GetConversionEventRequest request) (deprecated)

public ListenableFuture getConversionEvent(GetConversionEventRequest request)

Deprecated: Use GetKeyEvent instead. Retrieve a single conversion event.

Parameter
Name Description
request GetConversionEventRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ConversionEvent>

getCustomDimension(GetCustomDimensionRequest request)

public ListenableFuture getCustomDimension(GetCustomDimensionRequest request)

Lookup for a single CustomDimension.

Parameter
Name Description
request GetCustomDimensionRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<CustomDimension>

getCustomMetric(GetCustomMetricRequest request)

public ListenableFuture getCustomMetric(GetCustomMetricRequest request)

Lookup for a single CustomMetric.

Parameter
Name Description
request GetCustomMetricRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<CustomMetric>

getDataRedactionSettings(GetDataRedactionSettingsRequest request)

public ListenableFuture getDataRedactionSettings(GetDataRedactionSettingsRequest request)

Lookup for a single DataRedactionSettings.

Parameter
Name Description
request GetDataRedactionSettingsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<DataRedactionSettings>

getDataRetentionSettings(GetDataRetentionSettingsRequest request)

public ListenableFuture getDataRetentionSettings(GetDataRetentionSettingsRequest request)

Returns the singleton data retention settings for this property.

Parameter
Name Description
request GetDataRetentionSettingsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<DataRetentionSettings>

getDataSharingSettings(GetDataSharingSettingsRequest request)

public ListenableFuture getDataSharingSettings(GetDataSharingSettingsRequest request)

Get data sharing settings on an account. Data sharing settings are singletons.

Parameter
Name Description
request GetDataSharingSettingsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<DataSharingSettings>

getDataStream(GetDataStreamRequest request)

public ListenableFuture getDataStream(GetDataStreamRequest request)

Lookup for a single DataStream.

Parameter
Name Description
request GetDataStreamRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<DataStream>

getDisplayVideo360AdvertiserLink(GetDisplayVideo360AdvertiserLinkRequest request)

public ListenableFuture getDisplayVideo360AdvertiserLink(GetDisplayVideo360AdvertiserLinkRequest request)

Look up a single DisplayVideo360AdvertiserLink

Parameter
Name Description
request GetDisplayVideo360AdvertiserLinkRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<DisplayVideo360AdvertiserLink>

getDisplayVideo360AdvertiserLinkProposal(GetDisplayVideo360AdvertiserLinkProposalRequest request)

public ListenableFuture getDisplayVideo360AdvertiserLinkProposal(GetDisplayVideo360AdvertiserLinkProposalRequest request)

Lookup for a single DisplayVideo360AdvertiserLinkProposal.

Parameter
Name Description
request GetDisplayVideo360AdvertiserLinkProposalRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<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.

Parameter
Name Description
request GetEnhancedMeasurementSettingsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<EnhancedMeasurementSettings>

getEventCreateRule(GetEventCreateRuleRequest request)

public ListenableFuture getEventCreateRule(GetEventCreateRuleRequest request)

Lookup for a single EventCreateRule.

Parameter
Name Description
request GetEventCreateRuleRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<EventCreateRule>

getEventEditRule(GetEventEditRuleRequest request)

public ListenableFuture getEventEditRule(GetEventEditRuleRequest request)

Lookup for a single EventEditRule.

Parameter
Name Description
request GetEventEditRuleRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<EventEditRule>

getExpandedDataSet(GetExpandedDataSetRequest request)

public ListenableFuture getExpandedDataSet(GetExpandedDataSetRequest request)

Lookup for a single ExpandedDataSet.

Parameter
Name Description
request GetExpandedDataSetRequest
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.

Parameter
Name Description
request GetGlobalSiteTagRequest
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.

Parameter
Name Description
request GetGoogleSignalsSettingsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<GoogleSignalsSettings>

getKeyEvent(GetKeyEventRequest request)

public ListenableFuture getKeyEvent(GetKeyEventRequest request)

Retrieve a single Key Event.

Parameter
Name Description
request GetKeyEventRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<KeyEvent>

getMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest request)

public ListenableFuture getMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest request)

Lookup for a single MeasurementProtocolSecret.

Parameter
Name Description
request GetMeasurementProtocolSecretRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<MeasurementProtocolSecret>

getProperty(GetPropertyRequest request)

public ListenableFuture getProperty(GetPropertyRequest request)

Lookup for a single GA Property.

Parameter
Name Description
request GetPropertyRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Property>

getReportingDataAnnotation(GetReportingDataAnnotationRequest request)

public ListenableFuture getReportingDataAnnotation(GetReportingDataAnnotationRequest request)

Lookup a single Reporting Data Annotation.

Parameter
Name Description
request GetReportingDataAnnotationRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ReportingDataAnnotation>

getRollupPropertySourceLink(GetRollupPropertySourceLinkRequest request)

public ListenableFuture 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.

Parameter
Name Description
request GetRollupPropertySourceLinkRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<RollupPropertySourceLink>

getSKAdNetworkConversionValueSchema(GetSKAdNetworkConversionValueSchemaRequest request)

public ListenableFuture getSKAdNetworkConversionValueSchema(GetSKAdNetworkConversionValueSchemaRequest request)

Looks up a single SKAdNetworkConversionValueSchema.

Parameter
Name Description
request GetSKAdNetworkConversionValueSchemaRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<SKAdNetworkConversionValueSchema>

getSearchAds360Link(GetSearchAds360LinkRequest request)

public ListenableFuture getSearchAds360Link(GetSearchAds360LinkRequest request)

Look up a single SearchAds360Link

Parameter
Name Description
request GetSearchAds360LinkRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<SearchAds360Link>

getSubpropertyEventFilter(GetSubpropertyEventFilterRequest request)

public ListenableFuture getSubpropertyEventFilter(GetSubpropertyEventFilterRequest request)

Lookup for a single subproperty Event Filter.

Parameter
Name Description
request GetSubpropertyEventFilterRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<SubpropertyEventFilter>

listAccessBindings(ListAccessBindingsRequest request)

public ListenableFuture listAccessBindings(ListAccessBindingsRequest request)

Lists all access bindings on an account or property.

Parameter
Name Description
request ListAccessBindingsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListAccessBindingsResponse>

listAccountSummaries(ListAccountSummariesRequest request)

public ListenableFuture listAccountSummaries(ListAccountSummariesRequest request)

Returns summaries of all accounts accessible by the caller.

Parameter
Name Description
request ListAccountSummariesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListAccountSummariesResponse>

listAccounts(ListAccountsRequest request)

public ListenableFuture listAccounts(ListAccountsRequest request)

Returns all accounts accessible by the caller. Note that these accounts might not currently have GA properties. Soft-deleted (ie: "trashed") accounts are excluded by default. Returns an empty list if no relevant accounts are found.

Parameter
Name Description
request ListAccountsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListAccountsResponse>

listAdSenseLinks(ListAdSenseLinksRequest request)

public ListenableFuture listAdSenseLinks(ListAdSenseLinksRequest request)

Lists AdSenseLinks on a property.

Parameter
Name Description
request ListAdSenseLinksRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListAdSenseLinksResponse>

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.

Parameter
Name Description
request ListAudiencesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListAudiencesResponse>

listBigQueryLinks(ListBigQueryLinksRequest request)

public ListenableFuture listBigQueryLinks(ListBigQueryLinksRequest request)

Lists BigQuery Links on a property.

Parameter
Name Description
request ListBigQueryLinksRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListBigQueryLinksResponse>

listCalculatedMetrics(ListCalculatedMetricsRequest request)

public ListenableFuture listCalculatedMetrics(ListCalculatedMetricsRequest request)

Lists CalculatedMetrics on a property.

Parameter
Name Description
request ListCalculatedMetricsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListCalculatedMetricsResponse>

listChannelGroups(ListChannelGroupsRequest request)

public ListenableFuture listChannelGroups(ListChannelGroupsRequest request)

Lists ChannelGroups on a property.

Parameter
Name Description
request ListChannelGroupsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListChannelGroupsResponse>

listConnectedSiteTags(ListConnectedSiteTagsRequest request)

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.

Parameter
Name Description
request ListConnectedSiteTagsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListConnectedSiteTagsResponse>

listConversionEvents(ListConversionEventsRequest request) (deprecated)

public ListenableFuture 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.

Parameter
Name Description
request ListConversionEventsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListConversionEventsResponse>

listCustomDimensions(ListCustomDimensionsRequest request)

public ListenableFuture listCustomDimensions(ListCustomDimensionsRequest request)

Lists CustomDimensions on a property.

Parameter
Name Description
request ListCustomDimensionsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListCustomDimensionsResponse>

listCustomMetrics(ListCustomMetricsRequest request)

public ListenableFuture listCustomMetrics(ListCustomMetricsRequest request)

Lists CustomMetrics on a property.

Parameter
Name Description
request ListCustomMetricsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListCustomMetricsResponse>

listDataStreams(ListDataStreamsRequest request)

public ListenableFuture listDataStreams(ListDataStreamsRequest request)

Lists DataStreams on a property.

Parameter
Name Description
request ListDataStreamsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListDataStreamsResponse>

listDisplayVideo360AdvertiserLinkProposals(ListDisplayVideo360AdvertiserLinkProposalsRequest request)

public ListenableFuture listDisplayVideo360AdvertiserLinkProposals(ListDisplayVideo360AdvertiserLinkProposalsRequest request)

Lists DisplayVideo360AdvertiserLinkProposals on a property.

Parameter
Name Description
request ListDisplayVideo360AdvertiserLinkProposalsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListDisplayVideo360AdvertiserLinkProposalsResponse>

listDisplayVideo360AdvertiserLinks(ListDisplayVideo360AdvertiserLinksRequest request)

public ListenableFuture listDisplayVideo360AdvertiserLinks(ListDisplayVideo360AdvertiserLinksRequest request)

Lists all DisplayVideo360AdvertiserLinks on a property.

Parameter
Name Description
request ListDisplayVideo360AdvertiserLinksRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListDisplayVideo360AdvertiserLinksResponse>

listEventCreateRules(ListEventCreateRulesRequest request)

public ListenableFuture listEventCreateRules(ListEventCreateRulesRequest request)

Lists EventCreateRules on a web data stream.

Parameter
Name Description
request ListEventCreateRulesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListEventCreateRulesResponse>

listEventEditRules(ListEventEditRulesRequest request)

public ListenableFuture listEventEditRules(ListEventEditRulesRequest request)

Lists EventEditRules on a web data stream.

Parameter
Name Description
request ListEventEditRulesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListEventEditRulesResponse>

listExpandedDataSets(ListExpandedDataSetsRequest request)

public ListenableFuture listExpandedDataSets(ListExpandedDataSetsRequest request)

Lists ExpandedDataSets on a property.

Parameter
Name Description
request ListExpandedDataSetsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListExpandedDataSetsResponse>

listFirebaseLinks(ListFirebaseLinksRequest request)

public ListenableFuture listFirebaseLinks(ListFirebaseLinksRequest request)

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

Parameter
Name Description
request ListFirebaseLinksRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListFirebaseLinksResponse>

listGoogleAdsLinks(ListGoogleAdsLinksRequest request)

public ListenableFuture listGoogleAdsLinks(ListGoogleAdsLinksRequest request)

Lists GoogleAdsLinks on a property.

Parameter
Name Description
request ListGoogleAdsLinksRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListGoogleAdsLinksResponse>

listKeyEvents(ListKeyEventsRequest request)

public ListenableFuture listKeyEvents(ListKeyEventsRequest request)

Returns a list of Key Events in the specified parent property. Returns an empty list if no Key Events are found.

Parameter
Name Description
request ListKeyEventsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListKeyEventsResponse>

listMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest request)

public ListenableFuture listMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest request)

Returns child MeasurementProtocolSecrets under the specified parent Property.

Parameter
Name Description
request ListMeasurementProtocolSecretsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListMeasurementProtocolSecretsResponse>

listProperties(ListPropertiesRequest request)

public ListenableFuture listProperties(ListPropertiesRequest request)

Returns child Properties under the specified parent Account. Properties will be excluded if the caller does not have access. Soft-deleted (ie: "trashed") properties are excluded by default. Returns an empty list if no relevant properties are found.

Parameter
Name Description
request ListPropertiesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListPropertiesResponse>

listReportingDataAnnotations(ListReportingDataAnnotationsRequest request)

public ListenableFuture listReportingDataAnnotations(ListReportingDataAnnotationsRequest request)

List all Reporting Data Annotations on a property.

Parameter
Name Description
request ListReportingDataAnnotationsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListReportingDataAnnotationsResponse>

listRollupPropertySourceLinks(ListRollupPropertySourceLinksRequest request)

public ListenableFuture 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.

Parameter
Name Description
request ListRollupPropertySourceLinksRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListRollupPropertySourceLinksResponse>

listSKAdNetworkConversionValueSchemas(ListSKAdNetworkConversionValueSchemasRequest request)

public ListenableFuture listSKAdNetworkConversionValueSchemas(ListSKAdNetworkConversionValueSchemasRequest request)

Lists SKAdNetworkConversionValueSchema on a stream. Properties can have at most one SKAdNetworkConversionValueSchema.

Parameter
Name Description
request ListSKAdNetworkConversionValueSchemasRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListSKAdNetworkConversionValueSchemasResponse>

listSearchAds360Links(ListSearchAds360LinksRequest request)

public ListenableFuture listSearchAds360Links(ListSearchAds360LinksRequest request)

Lists all SearchAds360Links on a property.

Parameter
Name Description
request ListSearchAds360LinksRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListSearchAds360LinksResponse>

listSubpropertyEventFilters(ListSubpropertyEventFiltersRequest request)

public ListenableFuture listSubpropertyEventFilters(ListSubpropertyEventFiltersRequest request)

List all subproperty Event Filters on a property.

Parameter
Name Description
request ListSubpropertyEventFiltersRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListSubpropertyEventFiltersResponse>

provisionAccountTicket(ProvisionAccountTicketRequest request)

public ListenableFuture provisionAccountTicket(ProvisionAccountTicketRequest request)

Requests a ticket for creating an account.

Parameter
Name Description
request ProvisionAccountTicketRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ProvisionAccountTicketResponse>

provisionSubproperty(ProvisionSubpropertyRequest request)

public ListenableFuture provisionSubproperty(ProvisionSubpropertyRequest request)

Create a subproperty and a subproperty event filter that applies to the created subproperty.

Parameter
Name Description
request ProvisionSubpropertyRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ProvisionSubpropertyResponse>

reorderEventEditRules(ReorderEventEditRulesRequest request)

public ListenableFuture reorderEventEditRules(ReorderEventEditRulesRequest request)

Changes the processing order of event edit rules on the specified stream.

Parameter
Name Description
request ReorderEventEditRulesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

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. 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 GA UI Reporting, GA UI Explorations, GA 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. To give your feedback on this API, complete the Google Analytics Access Reports feedback form.

Parameter
Name Description
request RunAccessReportRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<RunAccessReportResponse>

searchChangeHistoryEvents(SearchChangeHistoryEventsRequest request)

public ListenableFuture searchChangeHistoryEvents(SearchChangeHistoryEventsRequest request)

Searches through all changes to an account or its children given the specified set of filters. Only returns the subset of changes supported by the API. The UI may return additional changes.

Parameter
Name Description
request SearchChangeHistoryEventsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<SearchChangeHistoryEventsResponse>

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.

Parameter
Name Description
request SetAutomatedGa4ConfigurationOptOutRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<SetAutomatedGa4ConfigurationOptOutResponse>

submitUserDeletion(SubmitUserDeletionRequest request)

public ListenableFuture submitUserDeletion(SubmitUserDeletionRequest request)

Submits a request for user deletion for a property.

Parameter
Name Description
request SubmitUserDeletionRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<SubmitUserDeletionResponse>

updateAccessBinding(UpdateAccessBindingRequest request)

public ListenableFuture updateAccessBinding(UpdateAccessBindingRequest request)

Updates an access binding on an account or property.

Parameter
Name Description
request UpdateAccessBindingRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<AccessBinding>

updateAccount(UpdateAccountRequest request)

public ListenableFuture updateAccount(UpdateAccountRequest request)

Updates an account.

Parameter
Name Description
request UpdateAccountRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Account>

updateAttributionSettings(UpdateAttributionSettingsRequest request)

public ListenableFuture updateAttributionSettings(UpdateAttributionSettingsRequest request)

Updates attribution settings on a property.

Parameter
Name Description
request UpdateAttributionSettingsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<AttributionSettings>

updateAudience(UpdateAudienceRequest request)

public ListenableFuture updateAudience(UpdateAudienceRequest request)

Updates an Audience on a property.

Parameter
Name Description
request UpdateAudienceRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Audience>

updateBigQueryLink(UpdateBigQueryLinkRequest request)

public ListenableFuture updateBigQueryLink(UpdateBigQueryLinkRequest request)

Updates a BigQueryLink.

Parameter
Name Description
request UpdateBigQueryLinkRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<BigQueryLink>

updateCalculatedMetric(UpdateCalculatedMetricRequest request)

public ListenableFuture updateCalculatedMetric(UpdateCalculatedMetricRequest request)

Updates a CalculatedMetric on a property.

Parameter
Name Description
request UpdateCalculatedMetricRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<CalculatedMetric>

updateChannelGroup(UpdateChannelGroupRequest request)

public ListenableFuture updateChannelGroup(UpdateChannelGroupRequest request)

Updates a ChannelGroup.

Parameter
Name Description
request UpdateChannelGroupRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ChannelGroup>

updateConversionEvent(UpdateConversionEventRequest request) (deprecated)

public ListenableFuture updateConversionEvent(UpdateConversionEventRequest request)

Deprecated: Use UpdateKeyEvent instead. Updates a conversion event with the specified attributes.

Parameter
Name Description
request UpdateConversionEventRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ConversionEvent>

updateCustomDimension(UpdateCustomDimensionRequest request)

public ListenableFuture updateCustomDimension(UpdateCustomDimensionRequest request)

Updates a CustomDimension on a property.

Parameter
Name Description
request UpdateCustomDimensionRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<CustomDimension>

updateCustomMetric(UpdateCustomMetricRequest request)

public ListenableFuture updateCustomMetric(UpdateCustomMetricRequest request)

Updates a CustomMetric on a property.

Parameter
Name Description
request UpdateCustomMetricRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<CustomMetric>

updateDataRedactionSettings(UpdateDataRedactionSettingsRequest request)

public ListenableFuture updateDataRedactionSettings(UpdateDataRedactionSettingsRequest request)

Updates a DataRedactionSettings on a property.

Parameter
Name Description
request UpdateDataRedactionSettingsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<DataRedactionSettings>

updateDataRetentionSettings(UpdateDataRetentionSettingsRequest request)

public ListenableFuture updateDataRetentionSettings(UpdateDataRetentionSettingsRequest request)

Updates the singleton data retention settings for this property.

Parameter
Name Description
request UpdateDataRetentionSettingsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<DataRetentionSettings>

updateDataStream(UpdateDataStreamRequest request)

public ListenableFuture updateDataStream(UpdateDataStreamRequest request)

Updates a DataStream on a property.

Parameter
Name Description
request UpdateDataStreamRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<DataStream>

updateDisplayVideo360AdvertiserLink(UpdateDisplayVideo360AdvertiserLinkRequest request)

public ListenableFuture updateDisplayVideo360AdvertiserLink(UpdateDisplayVideo360AdvertiserLinkRequest request)

Updates a DisplayVideo360AdvertiserLink on a property.

Parameter
Name Description
request UpdateDisplayVideo360AdvertiserLinkRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<DisplayVideo360AdvertiserLink>

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.

Parameter
Name Description
request UpdateEnhancedMeasurementSettingsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<EnhancedMeasurementSettings>

updateEventCreateRule(UpdateEventCreateRuleRequest request)

public ListenableFuture updateEventCreateRule(UpdateEventCreateRuleRequest request)

Updates an EventCreateRule.

Parameter
Name Description
request UpdateEventCreateRuleRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<EventCreateRule>

updateEventEditRule(UpdateEventEditRuleRequest request)

public ListenableFuture updateEventEditRule(UpdateEventEditRuleRequest request)

Updates an EventEditRule.

Parameter
Name Description
request UpdateEventEditRuleRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<EventEditRule>

updateExpandedDataSet(UpdateExpandedDataSetRequest request)

public ListenableFuture updateExpandedDataSet(UpdateExpandedDataSetRequest request)

Updates a ExpandedDataSet on a property.

Parameter
Name Description
request UpdateExpandedDataSetRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ExpandedDataSet>

updateGoogleAdsLink(UpdateGoogleAdsLinkRequest request)

public ListenableFuture updateGoogleAdsLink(UpdateGoogleAdsLinkRequest request)

Updates a GoogleAdsLink on a property

Parameter
Name Description
request UpdateGoogleAdsLinkRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<GoogleAdsLink>

updateGoogleSignalsSettings(UpdateGoogleSignalsSettingsRequest request)

public ListenableFuture updateGoogleSignalsSettings(UpdateGoogleSignalsSettingsRequest request)

Updates Google Signals settings for a property.

Parameter
Name Description
request UpdateGoogleSignalsSettingsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<GoogleSignalsSettings>

updateKeyEvent(UpdateKeyEventRequest request)

public ListenableFuture updateKeyEvent(UpdateKeyEventRequest request)

Updates a Key Event.

Parameter
Name Description
request UpdateKeyEventRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<KeyEvent>

updateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest request)

public ListenableFuture updateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest request)

Updates a measurement protocol secret.

Parameter
Name Description
request UpdateMeasurementProtocolSecretRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<MeasurementProtocolSecret>

updateProperty(UpdatePropertyRequest request)

public ListenableFuture updateProperty(UpdatePropertyRequest request)

Updates a property.

Parameter
Name Description
request UpdatePropertyRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Property>

updateReportingDataAnnotation(UpdateReportingDataAnnotationRequest request)

public ListenableFuture updateReportingDataAnnotation(UpdateReportingDataAnnotationRequest request)

Updates a Reporting Data Annotation.

Parameter
Name Description
request UpdateReportingDataAnnotationRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ReportingDataAnnotation>

updateSKAdNetworkConversionValueSchema(UpdateSKAdNetworkConversionValueSchemaRequest request)

public ListenableFuture updateSKAdNetworkConversionValueSchema(UpdateSKAdNetworkConversionValueSchemaRequest request)

Updates a SKAdNetworkConversionValueSchema.

Parameter
Name Description
request UpdateSKAdNetworkConversionValueSchemaRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<SKAdNetworkConversionValueSchema>

updateSearchAds360Link(UpdateSearchAds360LinkRequest request)

public ListenableFuture updateSearchAds360Link(UpdateSearchAds360LinkRequest request)

Updates a SearchAds360Link on a property.

Parameter
Name Description
request UpdateSearchAds360LinkRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<SearchAds360Link>

updateSubpropertyEventFilter(UpdateSubpropertyEventFilterRequest request)

public ListenableFuture updateSubpropertyEventFilter(UpdateSubpropertyEventFilterRequest request)

Updates a subproperty Event Filter.

Parameter
Name Description
request UpdateSubpropertyEventFilterRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<SubpropertyEventFilter>