Class AnalyticsAdminServiceClient (0.62.0)

GitHub RepositoryProduct Reference

Service Description: Service Interface for the Analytics Admin API (GA4).

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   AccountName name = AccountName.of("[ACCOUNT]");
   Account response = analyticsAdminServiceClient.getAccount(name);
 }
 

Note: close() needs to be called on the AnalyticsAdminServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
Method Description Method Variants

GetAccount

Lookup for a single Account.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getAccount(GetAccountRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getAccount(AccountName name)

  • getAccount(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getAccountCallable()

ListAccounts

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listAccounts(ListAccountsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listAccountsPagedCallable()

  • listAccountsCallable()

DeleteAccount

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteAccount(DeleteAccountRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteAccount(AccountName name)

  • deleteAccount(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteAccountCallable()

UpdateAccount

Updates an account.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateAccount(UpdateAccountRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateAccount(Account account, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateAccountCallable()

ProvisionAccountTicket

Requests a ticket for creating an account.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • provisionAccountTicket(ProvisionAccountTicketRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • provisionAccountTicketCallable()

ListAccountSummaries

Returns summaries of all accounts accessible by the caller.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listAccountSummaries(ListAccountSummariesRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listAccountSummariesPagedCallable()

  • listAccountSummariesCallable()

GetProperty

Lookup for a single "GA4" Property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getProperty(GetPropertyRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getProperty(PropertyName name)

  • getProperty(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getPropertyCallable()

ListProperties

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listProperties(ListPropertiesRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listPropertiesPagedCallable()

  • listPropertiesCallable()

CreateProperty

Creates an "GA4" property with the specified location and attributes.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createProperty(CreatePropertyRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createProperty(Property property)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createPropertyCallable()

DeleteProperty

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteProperty(DeletePropertyRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteProperty(PropertyName name)

  • deleteProperty(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deletePropertyCallable()

UpdateProperty

Updates a property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateProperty(UpdatePropertyRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateProperty(Property property, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updatePropertyCallable()

CreateFirebaseLink

Creates a FirebaseLink.

Properties can have at most one FirebaseLink.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createFirebaseLink(CreateFirebaseLinkRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createFirebaseLink(PropertyName parent, FirebaseLink firebaseLink)

  • createFirebaseLink(String parent, FirebaseLink firebaseLink)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createFirebaseLinkCallable()

DeleteFirebaseLink

Deletes a FirebaseLink on a property

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteFirebaseLink(DeleteFirebaseLinkRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteFirebaseLink(FirebaseLinkName name)

  • deleteFirebaseLink(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteFirebaseLinkCallable()

ListFirebaseLinks

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listFirebaseLinks(ListFirebaseLinksRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listFirebaseLinks(PropertyName parent)

  • listFirebaseLinks(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listFirebaseLinksPagedCallable()

  • listFirebaseLinksCallable()

GetGlobalSiteTag

Returns the Site Tag for the specified web stream. Site Tags are immutable singletons.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getGlobalSiteTag(GetGlobalSiteTagRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getGlobalSiteTag(GlobalSiteTagName name)

  • getGlobalSiteTag(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getGlobalSiteTagCallable()

CreateGoogleAdsLink

Creates a GoogleAdsLink.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createGoogleAdsLink(CreateGoogleAdsLinkRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createGoogleAdsLink(PropertyName parent, GoogleAdsLink googleAdsLink)

  • createGoogleAdsLink(String parent, GoogleAdsLink googleAdsLink)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createGoogleAdsLinkCallable()

UpdateGoogleAdsLink

Updates a GoogleAdsLink on a property

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateGoogleAdsLink(UpdateGoogleAdsLinkRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateGoogleAdsLink(GoogleAdsLink googleAdsLink, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateGoogleAdsLinkCallable()

DeleteGoogleAdsLink

Deletes a GoogleAdsLink on a property

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteGoogleAdsLink(DeleteGoogleAdsLinkRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteGoogleAdsLink(GoogleAdsLinkName name)

  • deleteGoogleAdsLink(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteGoogleAdsLinkCallable()

ListGoogleAdsLinks

Lists GoogleAdsLinks on a property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listGoogleAdsLinks(ListGoogleAdsLinksRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listGoogleAdsLinks(PropertyName parent)

  • listGoogleAdsLinks(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listGoogleAdsLinksPagedCallable()

  • listGoogleAdsLinksCallable()

GetDataSharingSettings

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getDataSharingSettings(GetDataSharingSettingsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getDataSharingSettings(DataSharingSettingsName name)

  • getDataSharingSettings(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getDataSharingSettingsCallable()

GetMeasurementProtocolSecret

Lookup for a single "GA4" MeasurementProtocolSecret.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getMeasurementProtocolSecret(MeasurementProtocolSecretName name)

  • getMeasurementProtocolSecret(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getMeasurementProtocolSecretCallable()

ListMeasurementProtocolSecrets

Returns child MeasurementProtocolSecrets under the specified parent Property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listMeasurementProtocolSecrets(DataStreamName parent)

  • listMeasurementProtocolSecrets(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listMeasurementProtocolSecretsPagedCallable()

  • listMeasurementProtocolSecretsCallable()

CreateMeasurementProtocolSecret

Creates a measurement protocol secret.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createMeasurementProtocolSecret(DataStreamName parent, MeasurementProtocolSecret measurementProtocolSecret)

  • createMeasurementProtocolSecret(String parent, MeasurementProtocolSecret measurementProtocolSecret)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createMeasurementProtocolSecretCallable()

DeleteMeasurementProtocolSecret

Deletes target MeasurementProtocolSecret.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteMeasurementProtocolSecret(MeasurementProtocolSecretName name)

  • deleteMeasurementProtocolSecret(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteMeasurementProtocolSecretCallable()

UpdateMeasurementProtocolSecret

Updates a measurement protocol secret.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateMeasurementProtocolSecret(MeasurementProtocolSecret measurementProtocolSecret, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateMeasurementProtocolSecretCallable()

AcknowledgeUserDataCollection

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • acknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • acknowledgeUserDataCollectionCallable()

GetSKAdNetworkConversionValueSchema

Looks up a single SKAdNetworkConversionValueSchema.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getSKAdNetworkConversionValueSchema(GetSKAdNetworkConversionValueSchemaRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getSKAdNetworkConversionValueSchema(SKAdNetworkConversionValueSchemaName name)

  • getSKAdNetworkConversionValueSchema(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getSKAdNetworkConversionValueSchemaCallable()

CreateSKAdNetworkConversionValueSchema

Creates a SKAdNetworkConversionValueSchema.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createSKAdNetworkConversionValueSchema(CreateSKAdNetworkConversionValueSchemaRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createSKAdNetworkConversionValueSchema(DataStreamName parent, SKAdNetworkConversionValueSchema skadnetworkConversionValueSchema)

  • createSKAdNetworkConversionValueSchema(String parent, SKAdNetworkConversionValueSchema skadnetworkConversionValueSchema)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createSKAdNetworkConversionValueSchemaCallable()

DeleteSKAdNetworkConversionValueSchema

Deletes target SKAdNetworkConversionValueSchema.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteSKAdNetworkConversionValueSchema(DeleteSKAdNetworkConversionValueSchemaRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteSKAdNetworkConversionValueSchema(SKAdNetworkConversionValueSchemaName name)

  • deleteSKAdNetworkConversionValueSchema(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteSKAdNetworkConversionValueSchemaCallable()

UpdateSKAdNetworkConversionValueSchema

Updates a SKAdNetworkConversionValueSchema.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateSKAdNetworkConversionValueSchema(UpdateSKAdNetworkConversionValueSchemaRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateSKAdNetworkConversionValueSchema(SKAdNetworkConversionValueSchema skadnetworkConversionValueSchema, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateSKAdNetworkConversionValueSchemaCallable()

ListSKAdNetworkConversionValueSchemas

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listSKAdNetworkConversionValueSchemas(ListSKAdNetworkConversionValueSchemasRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listSKAdNetworkConversionValueSchemas(DataStreamName parent)

  • listSKAdNetworkConversionValueSchemas(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listSKAdNetworkConversionValueSchemasPagedCallable()

  • listSKAdNetworkConversionValueSchemasCallable()

SearchChangeHistoryEvents

Searches through all changes to an account or its children given the specified set of filters.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • searchChangeHistoryEvents(SearchChangeHistoryEventsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • searchChangeHistoryEventsPagedCallable()

  • searchChangeHistoryEventsCallable()

GetGoogleSignalsSettings

Lookup for Google Signals settings for a property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getGoogleSignalsSettings(GetGoogleSignalsSettingsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getGoogleSignalsSettings(GoogleSignalsSettingsName name)

  • getGoogleSignalsSettings(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getGoogleSignalsSettingsCallable()

UpdateGoogleSignalsSettings

Updates Google Signals settings for a property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateGoogleSignalsSettings(UpdateGoogleSignalsSettingsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateGoogleSignalsSettings(GoogleSignalsSettings googleSignalsSettings, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateGoogleSignalsSettingsCallable()

CreateConversionEvent

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createConversionEvent(CreateConversionEventRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createConversionEvent(PropertyName parent, ConversionEvent conversionEvent)

  • createConversionEvent(String parent, ConversionEvent conversionEvent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createConversionEventCallable()

UpdateConversionEvent

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateConversionEvent(UpdateConversionEventRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateConversionEvent(ConversionEvent conversionEvent, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateConversionEventCallable()

GetConversionEvent

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getConversionEvent(GetConversionEventRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getConversionEvent(ConversionEventName name)

  • getConversionEvent(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getConversionEventCallable()

DeleteConversionEvent

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteConversionEvent(DeleteConversionEventRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteConversionEvent(ConversionEventName name)

  • deleteConversionEvent(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteConversionEventCallable()

ListConversionEvents

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listConversionEvents(ListConversionEventsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listConversionEvents(PropertyName parent)

  • listConversionEvents(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listConversionEventsPagedCallable()

  • listConversionEventsCallable()

CreateKeyEvent

Creates a Key Event.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createKeyEvent(CreateKeyEventRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createKeyEvent(PropertyName parent, KeyEvent keyEvent)

  • createKeyEvent(String parent, KeyEvent keyEvent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createKeyEventCallable()

UpdateKeyEvent

Updates a Key Event.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateKeyEvent(UpdateKeyEventRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateKeyEvent(KeyEvent keyEvent, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateKeyEventCallable()

GetKeyEvent

Retrieve a single Key Event.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getKeyEvent(GetKeyEventRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getKeyEvent(KeyEventName name)

  • getKeyEvent(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getKeyEventCallable()

DeleteKeyEvent

Deletes a Key Event.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteKeyEvent(DeleteKeyEventRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteKeyEvent(KeyEventName name)

  • deleteKeyEvent(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteKeyEventCallable()

ListKeyEvents

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listKeyEvents(ListKeyEventsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listKeyEvents(PropertyName parent)

  • listKeyEvents(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listKeyEventsPagedCallable()

  • listKeyEventsCallable()

GetDisplayVideo360AdvertiserLink

Look up a single DisplayVideo360AdvertiserLink

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getDisplayVideo360AdvertiserLink(GetDisplayVideo360AdvertiserLinkRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getDisplayVideo360AdvertiserLink(DisplayVideo360AdvertiserLinkName name)

  • getDisplayVideo360AdvertiserLink(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getDisplayVideo360AdvertiserLinkCallable()

ListDisplayVideo360AdvertiserLinks

Lists all DisplayVideo360AdvertiserLinks on a property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listDisplayVideo360AdvertiserLinks(ListDisplayVideo360AdvertiserLinksRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listDisplayVideo360AdvertiserLinks(PropertyName parent)

  • listDisplayVideo360AdvertiserLinks(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listDisplayVideo360AdvertiserLinksPagedCallable()

  • listDisplayVideo360AdvertiserLinksCallable()

CreateDisplayVideo360AdvertiserLink

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createDisplayVideo360AdvertiserLink(CreateDisplayVideo360AdvertiserLinkRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createDisplayVideo360AdvertiserLink(PropertyName parent, DisplayVideo360AdvertiserLink displayVideo360AdvertiserLink)

  • createDisplayVideo360AdvertiserLink(String parent, DisplayVideo360AdvertiserLink displayVideo360AdvertiserLink)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createDisplayVideo360AdvertiserLinkCallable()

DeleteDisplayVideo360AdvertiserLink

Deletes a DisplayVideo360AdvertiserLink on a property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteDisplayVideo360AdvertiserLink(DeleteDisplayVideo360AdvertiserLinkRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteDisplayVideo360AdvertiserLink(DisplayVideo360AdvertiserLinkName name)

  • deleteDisplayVideo360AdvertiserLink(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteDisplayVideo360AdvertiserLinkCallable()

UpdateDisplayVideo360AdvertiserLink

Updates a DisplayVideo360AdvertiserLink on a property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateDisplayVideo360AdvertiserLink(UpdateDisplayVideo360AdvertiserLinkRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateDisplayVideo360AdvertiserLink(DisplayVideo360AdvertiserLink displayVideo360AdvertiserLink, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateDisplayVideo360AdvertiserLinkCallable()

GetDisplayVideo360AdvertiserLinkProposal

Lookup for a single DisplayVideo360AdvertiserLinkProposal.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getDisplayVideo360AdvertiserLinkProposal(GetDisplayVideo360AdvertiserLinkProposalRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getDisplayVideo360AdvertiserLinkProposal(DisplayVideo360AdvertiserLinkProposalName name)

  • getDisplayVideo360AdvertiserLinkProposal(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getDisplayVideo360AdvertiserLinkProposalCallable()

ListDisplayVideo360AdvertiserLinkProposals

Lists DisplayVideo360AdvertiserLinkProposals on a property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listDisplayVideo360AdvertiserLinkProposals(ListDisplayVideo360AdvertiserLinkProposalsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listDisplayVideo360AdvertiserLinkProposals(PropertyName parent)

  • listDisplayVideo360AdvertiserLinkProposals(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listDisplayVideo360AdvertiserLinkProposalsPagedCallable()

  • listDisplayVideo360AdvertiserLinkProposalsCallable()

CreateDisplayVideo360AdvertiserLinkProposal

Creates a DisplayVideo360AdvertiserLinkProposal.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createDisplayVideo360AdvertiserLinkProposal(CreateDisplayVideo360AdvertiserLinkProposalRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createDisplayVideo360AdvertiserLinkProposal(PropertyName parent, DisplayVideo360AdvertiserLinkProposal displayVideo360AdvertiserLinkProposal)

  • createDisplayVideo360AdvertiserLinkProposal(String parent, DisplayVideo360AdvertiserLinkProposal displayVideo360AdvertiserLinkProposal)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createDisplayVideo360AdvertiserLinkProposalCallable()

DeleteDisplayVideo360AdvertiserLinkProposal

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteDisplayVideo360AdvertiserLinkProposal(DeleteDisplayVideo360AdvertiserLinkProposalRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteDisplayVideo360AdvertiserLinkProposal(DisplayVideo360AdvertiserLinkProposalName name)

  • deleteDisplayVideo360AdvertiserLinkProposal(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteDisplayVideo360AdvertiserLinkProposalCallable()

ApproveDisplayVideo360AdvertiserLinkProposal

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • approveDisplayVideo360AdvertiserLinkProposal(ApproveDisplayVideo360AdvertiserLinkProposalRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • approveDisplayVideo360AdvertiserLinkProposalCallable()

CancelDisplayVideo360AdvertiserLinkProposal

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • cancelDisplayVideo360AdvertiserLinkProposal(CancelDisplayVideo360AdvertiserLinkProposalRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • cancelDisplayVideo360AdvertiserLinkProposalCallable()

CreateCustomDimension

Creates a CustomDimension.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createCustomDimension(CreateCustomDimensionRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createCustomDimension(PropertyName parent, CustomDimension customDimension)

  • createCustomDimension(String parent, CustomDimension customDimension)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createCustomDimensionCallable()

UpdateCustomDimension

Updates a CustomDimension on a property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateCustomDimension(UpdateCustomDimensionRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateCustomDimension(CustomDimension customDimension, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateCustomDimensionCallable()

ListCustomDimensions

Lists CustomDimensions on a property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listCustomDimensions(ListCustomDimensionsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listCustomDimensions(PropertyName parent)

  • listCustomDimensions(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listCustomDimensionsPagedCallable()

  • listCustomDimensionsCallable()

ArchiveCustomDimension

Archives a CustomDimension on a property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • archiveCustomDimension(ArchiveCustomDimensionRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • archiveCustomDimension(CustomDimensionName name)

  • archiveCustomDimension(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • archiveCustomDimensionCallable()

GetCustomDimension

Lookup for a single CustomDimension.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getCustomDimension(GetCustomDimensionRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getCustomDimension(CustomDimensionName name)

  • getCustomDimension(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getCustomDimensionCallable()

CreateCustomMetric

Creates a CustomMetric.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createCustomMetric(CreateCustomMetricRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createCustomMetric(PropertyName parent, CustomMetric customMetric)

  • createCustomMetric(String parent, CustomMetric customMetric)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createCustomMetricCallable()

UpdateCustomMetric

Updates a CustomMetric on a property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateCustomMetric(UpdateCustomMetricRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateCustomMetric(CustomMetric customMetric, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateCustomMetricCallable()

ListCustomMetrics

Lists CustomMetrics on a property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listCustomMetrics(ListCustomMetricsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listCustomMetrics(PropertyName parent)

  • listCustomMetrics(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listCustomMetricsPagedCallable()

  • listCustomMetricsCallable()

ArchiveCustomMetric

Archives a CustomMetric on a property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • archiveCustomMetric(ArchiveCustomMetricRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • archiveCustomMetric(CustomMetricName name)

  • archiveCustomMetric(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • archiveCustomMetricCallable()

GetCustomMetric

Lookup for a single CustomMetric.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getCustomMetric(GetCustomMetricRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getCustomMetric(CustomMetricName name)

  • getCustomMetric(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getCustomMetricCallable()

GetDataRetentionSettings

Returns the singleton data retention settings for this property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getDataRetentionSettings(GetDataRetentionSettingsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getDataRetentionSettings(DataRetentionSettingsName name)

  • getDataRetentionSettings(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getDataRetentionSettingsCallable()

UpdateDataRetentionSettings

Updates the singleton data retention settings for this property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateDataRetentionSettings(UpdateDataRetentionSettingsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateDataRetentionSettings(DataRetentionSettings dataRetentionSettings, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateDataRetentionSettingsCallable()

CreateDataStream

Creates a DataStream.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createDataStream(CreateDataStreamRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createDataStream(PropertyName parent, DataStream dataStream)

  • createDataStream(String parent, DataStream dataStream)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createDataStreamCallable()

DeleteDataStream

Deletes a DataStream on a property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteDataStream(DeleteDataStreamRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteDataStream(DataStreamName name)

  • deleteDataStream(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteDataStreamCallable()

UpdateDataStream

Updates a DataStream on a property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateDataStream(UpdateDataStreamRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateDataStream(DataStream dataStream, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateDataStreamCallable()

ListDataStreams

Lists DataStreams on a property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listDataStreams(ListDataStreamsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listDataStreams(PropertyName parent)

  • listDataStreams(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listDataStreamsPagedCallable()

  • listDataStreamsCallable()

GetDataStream

Lookup for a single DataStream.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getDataStream(GetDataStreamRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getDataStream(DataStreamName name)

  • getDataStream(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getDataStreamCallable()

GetAudience

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getAudience(GetAudienceRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getAudience(AudienceName name)

  • getAudience(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getAudienceCallable()

ListAudiences

Lists Audiences on a property. Audiences created before 2020 may not be supported. Default audiences will not show filter definitions.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listAudiences(ListAudiencesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listAudiences(PropertyName parent)

  • listAudiences(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listAudiencesPagedCallable()

  • listAudiencesCallable()

CreateAudience

Creates an Audience.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createAudience(CreateAudienceRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createAudience(PropertyName parent, Audience audience)

  • createAudience(String parent, Audience audience)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createAudienceCallable()

UpdateAudience

Updates an Audience on a property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateAudience(UpdateAudienceRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateAudience(Audience audience, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateAudienceCallable()

ArchiveAudience

Archives an Audience on a property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • archiveAudience(ArchiveAudienceRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • archiveAudienceCallable()

GetSearchAds360Link

Look up a single SearchAds360Link

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getSearchAds360Link(GetSearchAds360LinkRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getSearchAds360Link(SearchAds360LinkName name)

  • getSearchAds360Link(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getSearchAds360LinkCallable()

ListSearchAds360Links

Lists all SearchAds360Links on a property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listSearchAds360Links(ListSearchAds360LinksRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listSearchAds360Links(PropertyName parent)

  • listSearchAds360Links(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listSearchAds360LinksPagedCallable()

  • listSearchAds360LinksCallable()

CreateSearchAds360Link

Creates a SearchAds360Link.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createSearchAds360Link(CreateSearchAds360LinkRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createSearchAds360Link(PropertyName parent, SearchAds360Link searchAds360Link)

  • createSearchAds360Link(String parent, SearchAds360Link searchAds360Link)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createSearchAds360LinkCallable()

DeleteSearchAds360Link

Deletes a SearchAds360Link on a property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteSearchAds360Link(DeleteSearchAds360LinkRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteSearchAds360Link(SearchAds360LinkName name)

  • deleteSearchAds360Link(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteSearchAds360LinkCallable()

UpdateSearchAds360Link

Updates a SearchAds360Link on a property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateSearchAds360Link(UpdateSearchAds360LinkRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateSearchAds360Link(SearchAds360Link searchAds360Link, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateSearchAds360LinkCallable()

GetAttributionSettings

Lookup for a AttributionSettings singleton.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getAttributionSettings(GetAttributionSettingsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getAttributionSettings(AttributionSettingsName name)

  • getAttributionSettings(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getAttributionSettingsCallable()

UpdateAttributionSettings

Updates attribution settings on a property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateAttributionSettings(UpdateAttributionSettingsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateAttributionSettings(AttributionSettings attributionSettings, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateAttributionSettingsCallable()

RunAccessReport

Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years.

Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators.

These data access records include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see searchChangeHistoryEvents.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • runAccessReport(RunAccessReportRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • runAccessReportCallable()

CreateAccessBinding

Creates an access binding on an account or property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createAccessBinding(CreateAccessBindingRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createAccessBinding(AccountName parent, AccessBinding accessBinding)

  • createAccessBinding(PropertyName parent, AccessBinding accessBinding)

  • createAccessBinding(String parent, AccessBinding accessBinding)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createAccessBindingCallable()

GetAccessBinding

Gets information about an access binding.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getAccessBinding(GetAccessBindingRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getAccessBinding(AccessBindingName name)

  • getAccessBinding(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getAccessBindingCallable()

UpdateAccessBinding

Updates an access binding on an account or property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateAccessBinding(UpdateAccessBindingRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateAccessBinding(AccessBinding accessBinding)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateAccessBindingCallable()

DeleteAccessBinding

Deletes an access binding on an account or property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteAccessBinding(DeleteAccessBindingRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteAccessBinding(AccessBindingName name)

  • deleteAccessBinding(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteAccessBindingCallable()

ListAccessBindings

Lists all access bindings on an account or property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listAccessBindings(ListAccessBindingsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listAccessBindings(AccountName parent)

  • listAccessBindings(PropertyName parent)

  • listAccessBindings(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listAccessBindingsPagedCallable()

  • listAccessBindingsCallable()

BatchCreateAccessBindings

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • batchCreateAccessBindings(BatchCreateAccessBindingsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • batchCreateAccessBindingsCallable()

BatchGetAccessBindings

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • batchGetAccessBindings(BatchGetAccessBindingsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • batchGetAccessBindingsCallable()

BatchUpdateAccessBindings

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • batchUpdateAccessBindings(BatchUpdateAccessBindingsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • batchUpdateAccessBindingsCallable()

BatchDeleteAccessBindings

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • batchDeleteAccessBindings(BatchDeleteAccessBindingsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • batchDeleteAccessBindingsCallable()

GetExpandedDataSet

Lookup for a single ExpandedDataSet.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getExpandedDataSet(GetExpandedDataSetRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getExpandedDataSet(ExpandedDataSetName name)

  • getExpandedDataSet(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getExpandedDataSetCallable()

ListExpandedDataSets

Lists ExpandedDataSets on a property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listExpandedDataSets(ListExpandedDataSetsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listExpandedDataSets(PropertyName parent)

  • listExpandedDataSets(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listExpandedDataSetsPagedCallable()

  • listExpandedDataSetsCallable()

CreateExpandedDataSet

Creates a ExpandedDataSet.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createExpandedDataSet(CreateExpandedDataSetRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createExpandedDataSet(PropertyName parent, ExpandedDataSet expandedDataSet)

  • createExpandedDataSet(String parent, ExpandedDataSet expandedDataSet)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createExpandedDataSetCallable()

UpdateExpandedDataSet

Updates a ExpandedDataSet on a property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateExpandedDataSet(UpdateExpandedDataSetRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateExpandedDataSet(ExpandedDataSet expandedDataSet, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateExpandedDataSetCallable()

DeleteExpandedDataSet

Deletes a ExpandedDataSet on a property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteExpandedDataSet(DeleteExpandedDataSetRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteExpandedDataSet(ExpandedDataSetName name)

  • deleteExpandedDataSet(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteExpandedDataSetCallable()

GetChannelGroup

Lookup for a single ChannelGroup.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getChannelGroup(GetChannelGroupRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getChannelGroup(ChannelGroupName name)

  • getChannelGroup(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getChannelGroupCallable()

ListChannelGroups

Lists ChannelGroups on a property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listChannelGroups(ListChannelGroupsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listChannelGroups(PropertyName parent)

  • listChannelGroups(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listChannelGroupsPagedCallable()

  • listChannelGroupsCallable()

CreateChannelGroup

Creates a ChannelGroup.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createChannelGroup(CreateChannelGroupRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createChannelGroup(PropertyName parent, ChannelGroup channelGroup)

  • createChannelGroup(String parent, ChannelGroup channelGroup)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createChannelGroupCallable()

UpdateChannelGroup

Updates a ChannelGroup.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateChannelGroup(UpdateChannelGroupRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateChannelGroup(ChannelGroup channelGroup, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateChannelGroupCallable()

DeleteChannelGroup

Deletes a ChannelGroup on a property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteChannelGroup(DeleteChannelGroupRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteChannelGroup(ChannelGroupName name)

  • deleteChannelGroup(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteChannelGroupCallable()

SetAutomatedGa4ConfigurationOptOut

Sets the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • setAutomatedGa4ConfigurationOptOut(SetAutomatedGa4ConfigurationOptOutRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • setAutomatedGa4ConfigurationOptOutCallable()

FetchAutomatedGa4ConfigurationOptOut

Fetches the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • fetchAutomatedGa4ConfigurationOptOut(FetchAutomatedGa4ConfigurationOptOutRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • fetchAutomatedGa4ConfigurationOptOutCallable()

CreateBigQueryLink

Creates a BigQueryLink.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createBigQueryLink(CreateBigQueryLinkRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createBigQueryLink(PropertyName parent, BigQueryLink bigqueryLink)

  • createBigQueryLink(String parent, BigQueryLink bigqueryLink)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createBigQueryLinkCallable()

GetBigQueryLink

Lookup for a single BigQuery Link.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getBigQueryLink(GetBigQueryLinkRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getBigQueryLink(BigQueryLinkName name)

  • getBigQueryLink(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getBigQueryLinkCallable()

ListBigQueryLinks

Lists BigQuery Links on a property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listBigQueryLinks(ListBigQueryLinksRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listBigQueryLinks(PropertyName parent)

  • listBigQueryLinks(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listBigQueryLinksPagedCallable()

  • listBigQueryLinksCallable()

DeleteBigQueryLink

Deletes a BigQueryLink on a property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteBigQueryLink(DeleteBigQueryLinkRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteBigQueryLink(BigQueryLinkName name)

  • deleteBigQueryLink(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteBigQueryLinkCallable()

UpdateBigQueryLink

Updates a BigQueryLink.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateBigQueryLink(UpdateBigQueryLinkRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateBigQueryLink(BigQueryLink bigqueryLink, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateBigQueryLinkCallable()

GetEnhancedMeasurementSettings

Returns the enhanced measurement settings for this data stream. Note that the stream must enable enhanced measurement for these settings to take effect.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getEnhancedMeasurementSettings(GetEnhancedMeasurementSettingsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getEnhancedMeasurementSettings(EnhancedMeasurementSettingsName name)

  • getEnhancedMeasurementSettings(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getEnhancedMeasurementSettingsCallable()

UpdateEnhancedMeasurementSettings

Updates the enhanced measurement settings for this data stream. Note that the stream must enable enhanced measurement for these settings to take effect.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateEnhancedMeasurementSettings(UpdateEnhancedMeasurementSettingsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateEnhancedMeasurementSettings(EnhancedMeasurementSettings enhancedMeasurementSettings, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateEnhancedMeasurementSettingsCallable()

CreateConnectedSiteTag

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createConnectedSiteTag(CreateConnectedSiteTagRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createConnectedSiteTagCallable()

DeleteConnectedSiteTag

Deletes a connected site tag for a Universal Analytics property. Note: this has no effect on GA4 properties.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteConnectedSiteTag(DeleteConnectedSiteTagRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteConnectedSiteTagCallable()

ListConnectedSiteTags

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listConnectedSiteTags(ListConnectedSiteTagsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listConnectedSiteTagsCallable()

FetchConnectedGa4Property

Given a specified UA property, looks up the GA4 property connected to it. Note: this cannot be used with GA4 properties.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • fetchConnectedGa4Property(FetchConnectedGa4PropertyRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • fetchConnectedGa4PropertyCallable()

GetAdSenseLink

Looks up a single AdSenseLink.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getAdSenseLink(GetAdSenseLinkRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getAdSenseLink(AdSenseLinkName name)

  • getAdSenseLink(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getAdSenseLinkCallable()

CreateAdSenseLink

Creates an AdSenseLink.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createAdSenseLink(CreateAdSenseLinkRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createAdSenseLink(PropertyName parent, AdSenseLink adsenseLink)

  • createAdSenseLink(String parent, AdSenseLink adsenseLink)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createAdSenseLinkCallable()

DeleteAdSenseLink

Deletes an AdSenseLink.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteAdSenseLink(DeleteAdSenseLinkRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteAdSenseLink(AdSenseLinkName name)

  • deleteAdSenseLink(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteAdSenseLinkCallable()

ListAdSenseLinks

Lists AdSenseLinks on a property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listAdSenseLinks(ListAdSenseLinksRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listAdSenseLinks(PropertyName parent)

  • listAdSenseLinks(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listAdSenseLinksPagedCallable()

  • listAdSenseLinksCallable()

GetEventCreateRule

Lookup for a single EventCreateRule.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getEventCreateRule(GetEventCreateRuleRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getEventCreateRule(EventCreateRuleName name)

  • getEventCreateRule(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getEventCreateRuleCallable()

ListEventCreateRules

Lists EventCreateRules on a web data stream.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listEventCreateRules(ListEventCreateRulesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listEventCreateRules(DataStreamName parent)

  • listEventCreateRules(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listEventCreateRulesPagedCallable()

  • listEventCreateRulesCallable()

CreateEventCreateRule

Creates an EventCreateRule.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createEventCreateRule(CreateEventCreateRuleRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createEventCreateRule(DataStreamName parent, EventCreateRule eventCreateRule)

  • createEventCreateRule(String parent, EventCreateRule eventCreateRule)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createEventCreateRuleCallable()

UpdateEventCreateRule

Updates an EventCreateRule.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateEventCreateRule(UpdateEventCreateRuleRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateEventCreateRule(EventCreateRule eventCreateRule, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateEventCreateRuleCallable()

DeleteEventCreateRule

Deletes an EventCreateRule.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteEventCreateRule(DeleteEventCreateRuleRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteEventCreateRule(EventCreateRuleName name)

  • deleteEventCreateRule(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteEventCreateRuleCallable()

GetEventEditRule

Lookup for a single EventEditRule.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getEventEditRule(GetEventEditRuleRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getEventEditRule(EventEditRuleName name)

  • getEventEditRule(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getEventEditRuleCallable()

ListEventEditRules

Lists EventEditRules on a web data stream.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listEventEditRules(ListEventEditRulesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listEventEditRules(DataStreamName parent)

  • listEventEditRules(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listEventEditRulesPagedCallable()

  • listEventEditRulesCallable()

CreateEventEditRule

Creates an EventEditRule.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createEventEditRule(CreateEventEditRuleRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createEventEditRule(DataStreamName parent, EventEditRule eventEditRule)

  • createEventEditRule(String parent, EventEditRule eventEditRule)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createEventEditRuleCallable()

UpdateEventEditRule

Updates an EventEditRule.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateEventEditRule(UpdateEventEditRuleRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateEventEditRule(EventEditRule eventEditRule, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateEventEditRuleCallable()

DeleteEventEditRule

Deletes an EventEditRule.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteEventEditRule(DeleteEventEditRuleRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteEventEditRule(EventEditRuleName name)

  • deleteEventEditRule(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteEventEditRuleCallable()

ReorderEventEditRules

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • reorderEventEditRules(ReorderEventEditRulesRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • reorderEventEditRulesCallable()

UpdateDataRedactionSettings

Updates a DataRedactionSettings on a property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateDataRedactionSettings(UpdateDataRedactionSettingsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateDataRedactionSettings(DataRedactionSettings dataRedactionSettings, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateDataRedactionSettingsCallable()

GetDataRedactionSettings

Lookup for a single DataRedactionSettings.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getDataRedactionSettings(GetDataRedactionSettingsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getDataRedactionSettings(DataRedactionSettingsName name)

  • getDataRedactionSettings(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getDataRedactionSettingsCallable()

GetCalculatedMetric

Lookup for a single CalculatedMetric.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getCalculatedMetric(GetCalculatedMetricRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getCalculatedMetric(CalculatedMetricName name)

  • getCalculatedMetric(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getCalculatedMetricCallable()

CreateCalculatedMetric

Creates a CalculatedMetric.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createCalculatedMetric(CreateCalculatedMetricRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createCalculatedMetric(PropertyName parent, CalculatedMetric calculatedMetric, String calculatedMetricId)

  • createCalculatedMetric(String parent, CalculatedMetric calculatedMetric, String calculatedMetricId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createCalculatedMetricCallable()

ListCalculatedMetrics

Lists CalculatedMetrics on a property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listCalculatedMetrics(ListCalculatedMetricsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listCalculatedMetrics(PropertyName parent)

  • listCalculatedMetrics(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listCalculatedMetricsPagedCallable()

  • listCalculatedMetricsCallable()

UpdateCalculatedMetric

Updates a CalculatedMetric on a property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateCalculatedMetric(UpdateCalculatedMetricRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateCalculatedMetric(CalculatedMetric calculatedMetric, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateCalculatedMetricCallable()

DeleteCalculatedMetric

Deletes a CalculatedMetric on a property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteCalculatedMetric(DeleteCalculatedMetricRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteCalculatedMetric(CalculatedMetricName name)

  • deleteCalculatedMetric(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteCalculatedMetricCallable()

CreateRollupProperty

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createRollupProperty(CreateRollupPropertyRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createRollupPropertyCallable()

GetRollupPropertySourceLink

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getRollupPropertySourceLink(GetRollupPropertySourceLinkRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getRollupPropertySourceLink(RollupPropertySourceLinkName name)

  • getRollupPropertySourceLink(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getRollupPropertySourceLinkCallable()

ListRollupPropertySourceLinks

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listRollupPropertySourceLinks(ListRollupPropertySourceLinksRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listRollupPropertySourceLinks(PropertyName parent)

  • listRollupPropertySourceLinks(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listRollupPropertySourceLinksPagedCallable()

  • listRollupPropertySourceLinksCallable()

CreateRollupPropertySourceLink

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createRollupPropertySourceLink(CreateRollupPropertySourceLinkRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createRollupPropertySourceLink(PropertyName parent, RollupPropertySourceLink rollupPropertySourceLink)

  • createRollupPropertySourceLink(String parent, RollupPropertySourceLink rollupPropertySourceLink)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createRollupPropertySourceLinkCallable()

DeleteRollupPropertySourceLink

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteRollupPropertySourceLink(DeleteRollupPropertySourceLinkRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteRollupPropertySourceLink(RollupPropertySourceLinkName name)

  • deleteRollupPropertySourceLink(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteRollupPropertySourceLinkCallable()

ProvisionSubproperty

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • provisionSubproperty(ProvisionSubpropertyRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • provisionSubpropertyCallable()

CreateSubpropertyEventFilter

Creates a subproperty Event Filter.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createSubpropertyEventFilter(CreateSubpropertyEventFilterRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createSubpropertyEventFilter(PropertyName parent, SubpropertyEventFilter subpropertyEventFilter)

  • createSubpropertyEventFilter(String parent, SubpropertyEventFilter subpropertyEventFilter)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createSubpropertyEventFilterCallable()

GetSubpropertyEventFilter

Lookup for a single subproperty Event Filter.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getSubpropertyEventFilter(GetSubpropertyEventFilterRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getSubpropertyEventFilter(SubpropertyEventFilterName name)

  • getSubpropertyEventFilter(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getSubpropertyEventFilterCallable()

ListSubpropertyEventFilters

List all subproperty Event Filters on a property.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listSubpropertyEventFilters(ListSubpropertyEventFiltersRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listSubpropertyEventFilters(PropertyName parent)

  • listSubpropertyEventFilters(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listSubpropertyEventFiltersPagedCallable()

  • listSubpropertyEventFiltersCallable()

UpdateSubpropertyEventFilter

Updates a subproperty Event Filter.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateSubpropertyEventFilter(UpdateSubpropertyEventFilterRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateSubpropertyEventFilter(SubpropertyEventFilter subpropertyEventFilter, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateSubpropertyEventFilterCallable()

DeleteSubpropertyEventFilter

Deletes a subproperty event filter.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteSubpropertyEventFilter(DeleteSubpropertyEventFilterRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteSubpropertyEventFilter(SubpropertyEventFilterName name)

  • deleteSubpropertyEventFilter(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteSubpropertyEventFilterCallable()

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of AnalyticsAdminServiceSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 AnalyticsAdminServiceSettings analyticsAdminServiceSettings =
     AnalyticsAdminServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create(analyticsAdminServiceSettings);
 

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 AnalyticsAdminServiceSettings analyticsAdminServiceSettings =
     AnalyticsAdminServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create(analyticsAdminServiceSettings);
 

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 AnalyticsAdminServiceSettings analyticsAdminServiceSettings =
     AnalyticsAdminServiceSettings.newHttpJsonBuilder().build();
 AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create(analyticsAdminServiceSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > AnalyticsAdminServiceClient

Static Methods

create()

public static final AnalyticsAdminServiceClient create()

Constructs an instance of AnalyticsAdminServiceClient with default settings.

Returns
Type Description
AnalyticsAdminServiceClient
Exceptions
Type Description
IOException

create(AnalyticsAdminServiceSettings settings)

public static final AnalyticsAdminServiceClient create(AnalyticsAdminServiceSettings settings)

Constructs an instance of AnalyticsAdminServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name Description
settings AnalyticsAdminServiceSettings
Returns
Type Description
AnalyticsAdminServiceClient
Exceptions
Type Description
IOException

create(AnalyticsAdminServiceStub stub)

public static final AnalyticsAdminServiceClient create(AnalyticsAdminServiceStub stub)

Constructs an instance of AnalyticsAdminServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(AnalyticsAdminServiceSettings).

Parameter
Name Description
stub AnalyticsAdminServiceStub
Returns
Type Description
AnalyticsAdminServiceClient

Constructors

AnalyticsAdminServiceClient(AnalyticsAdminServiceSettings settings)

protected AnalyticsAdminServiceClient(AnalyticsAdminServiceSettings settings)

Constructs an instance of AnalyticsAdminServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
Name Description
settings AnalyticsAdminServiceSettings

AnalyticsAdminServiceClient(AnalyticsAdminServiceStub stub)

protected AnalyticsAdminServiceClient(AnalyticsAdminServiceStub stub)
Parameter
Name Description
stub AnalyticsAdminServiceStub

Methods

acknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   AcknowledgeUserDataCollectionRequest request =
       AcknowledgeUserDataCollectionRequest.newBuilder()
           .setProperty(PropertyName.of("[PROPERTY]").toString())
           .setAcknowledgement("acknowledgement1769490938")
           .build();
   AcknowledgeUserDataCollectionResponse response =
       analyticsAdminServiceClient.acknowledgeUserDataCollection(request);
 }
 
Parameter
Name Description
request AcknowledgeUserDataCollectionRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
AcknowledgeUserDataCollectionResponse

acknowledgeUserDataCollectionCallable()

public final UnaryCallable<AcknowledgeUserDataCollectionRequest,AcknowledgeUserDataCollectionResponse> acknowledgeUserDataCollectionCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   AcknowledgeUserDataCollectionRequest request =
       AcknowledgeUserDataCollectionRequest.newBuilder()
           .setProperty(PropertyName.of("[PROPERTY]").toString())
           .setAcknowledgement("acknowledgement1769490938")
           .build();
   ApiFuture<AcknowledgeUserDataCollectionResponse> future =
       analyticsAdminServiceClient.acknowledgeUserDataCollectionCallable().futureCall(request);
   // Do something.
   AcknowledgeUserDataCollectionResponse response = future.get();
 }
 
Returns
Type Description
UnaryCallable<AcknowledgeUserDataCollectionRequest,AcknowledgeUserDataCollectionResponse>

approveDisplayVideo360AdvertiserLinkProposal(ApproveDisplayVideo360AdvertiserLinkProposalRequest request)

public final ApproveDisplayVideo360AdvertiserLinkProposalResponse approveDisplayVideo360AdvertiserLinkProposal(ApproveDisplayVideo360AdvertiserLinkProposalRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ApproveDisplayVideo360AdvertiserLinkProposalRequest request =
       ApproveDisplayVideo360AdvertiserLinkProposalRequest.newBuilder()
           .setName(
               DisplayVideo360AdvertiserLinkProposalName.of(
                       "[PROPERTY]", "[DISPLAY_VIDEO_360_ADVERTISER_LINK_PROPOSAL]")
                   .toString())
           .build();
   ApproveDisplayVideo360AdvertiserLinkProposalResponse response =
       analyticsAdminServiceClient.approveDisplayVideo360AdvertiserLinkProposal(request);
 }
 
Parameter
Name Description
request ApproveDisplayVideo360AdvertiserLinkProposalRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
ApproveDisplayVideo360AdvertiserLinkProposalResponse

approveDisplayVideo360AdvertiserLinkProposalCallable()

public final UnaryCallable<ApproveDisplayVideo360AdvertiserLinkProposalRequest,ApproveDisplayVideo360AdvertiserLinkProposalResponse> approveDisplayVideo360AdvertiserLinkProposalCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ApproveDisplayVideo360AdvertiserLinkProposalRequest request =
       ApproveDisplayVideo360AdvertiserLinkProposalRequest.newBuilder()
           .setName(
               DisplayVideo360AdvertiserLinkProposalName.of(
                       "[PROPERTY]", "[DISPLAY_VIDEO_360_ADVERTISER_LINK_PROPOSAL]")
                   .toString())
           .build();
   ApiFuture<ApproveDisplayVideo360AdvertiserLinkProposalResponse> future =
       analyticsAdminServiceClient
           .approveDisplayVideo360AdvertiserLinkProposalCallable()
           .futureCall(request);
   // Do something.
   ApproveDisplayVideo360AdvertiserLinkProposalResponse response = future.get();
 }
 
Returns
Type Description
UnaryCallable<ApproveDisplayVideo360AdvertiserLinkProposalRequest,ApproveDisplayVideo360AdvertiserLinkProposalResponse>

archiveAudience(ArchiveAudienceRequest request)

public final void archiveAudience(ArchiveAudienceRequest request)

Archives an Audience on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ArchiveAudienceRequest request =
       ArchiveAudienceRequest.newBuilder()
           .setName(PropertyName.of("[PROPERTY]").toString())
           .build();
   analyticsAdminServiceClient.archiveAudience(request);
 }
 
Parameter
Name Description
request ArchiveAudienceRequest

The request object containing all of the parameters for the API call.

archiveAudienceCallable()

public final UnaryCallable<ArchiveAudienceRequest,Empty> archiveAudienceCallable()

Archives an Audience on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ArchiveAudienceRequest request =
       ArchiveAudienceRequest.newBuilder()
           .setName(PropertyName.of("[PROPERTY]").toString())
           .build();
   ApiFuture<Empty> future =
       analyticsAdminServiceClient.archiveAudienceCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<ArchiveAudienceRequest,Empty>

archiveCustomDimension(ArchiveCustomDimensionRequest request)

public final void archiveCustomDimension(ArchiveCustomDimensionRequest request)

Archives a CustomDimension on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ArchiveCustomDimensionRequest request =
       ArchiveCustomDimensionRequest.newBuilder()
           .setName(CustomDimensionName.of("[PROPERTY]", "[CUSTOM_DIMENSION]").toString())
           .build();
   analyticsAdminServiceClient.archiveCustomDimension(request);
 }
 
Parameter
Name Description
request ArchiveCustomDimensionRequest

The request object containing all of the parameters for the API call.

archiveCustomDimension(CustomDimensionName name)

public final void archiveCustomDimension(CustomDimensionName name)

Archives a CustomDimension on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CustomDimensionName name = CustomDimensionName.of("[PROPERTY]", "[CUSTOM_DIMENSION]");
   analyticsAdminServiceClient.archiveCustomDimension(name);
 }
 
Parameter
Name Description
name CustomDimensionName

Required. The name of the CustomDimension to archive. Example format: properties/1234/customDimensions/5678

archiveCustomDimension(String name)

public final void archiveCustomDimension(String name)

Archives a CustomDimension on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name = CustomDimensionName.of("[PROPERTY]", "[CUSTOM_DIMENSION]").toString();
   analyticsAdminServiceClient.archiveCustomDimension(name);
 }
 
Parameter
Name Description
name String

Required. The name of the CustomDimension to archive. Example format: properties/1234/customDimensions/5678

archiveCustomDimensionCallable()

public final UnaryCallable<ArchiveCustomDimensionRequest,Empty> archiveCustomDimensionCallable()

Archives a CustomDimension on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ArchiveCustomDimensionRequest request =
       ArchiveCustomDimensionRequest.newBuilder()
           .setName(CustomDimensionName.of("[PROPERTY]", "[CUSTOM_DIMENSION]").toString())
           .build();
   ApiFuture<Empty> future =
       analyticsAdminServiceClient.archiveCustomDimensionCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<ArchiveCustomDimensionRequest,Empty>

archiveCustomMetric(ArchiveCustomMetricRequest request)

public final void archiveCustomMetric(ArchiveCustomMetricRequest request)

Archives a CustomMetric on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ArchiveCustomMetricRequest request =
       ArchiveCustomMetricRequest.newBuilder()
           .setName(CustomMetricName.of("[PROPERTY]", "[CUSTOM_METRIC]").toString())
           .build();
   analyticsAdminServiceClient.archiveCustomMetric(request);
 }
 
Parameter
Name Description
request ArchiveCustomMetricRequest

The request object containing all of the parameters for the API call.

archiveCustomMetric(CustomMetricName name)

public final void archiveCustomMetric(CustomMetricName name)

Archives a CustomMetric on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CustomMetricName name = CustomMetricName.of("[PROPERTY]", "[CUSTOM_METRIC]");
   analyticsAdminServiceClient.archiveCustomMetric(name);
 }
 
Parameter
Name Description
name CustomMetricName

Required. The name of the CustomMetric to archive. Example format: properties/1234/customMetrics/5678

archiveCustomMetric(String name)

public final void archiveCustomMetric(String name)

Archives a CustomMetric on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name = CustomMetricName.of("[PROPERTY]", "[CUSTOM_METRIC]").toString();
   analyticsAdminServiceClient.archiveCustomMetric(name);
 }
 
Parameter
Name Description
name String

Required. The name of the CustomMetric to archive. Example format: properties/1234/customMetrics/5678

archiveCustomMetricCallable()

public final UnaryCallable<ArchiveCustomMetricRequest,Empty> archiveCustomMetricCallable()

Archives a CustomMetric on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ArchiveCustomMetricRequest request =
       ArchiveCustomMetricRequest.newBuilder()
           .setName(CustomMetricName.of("[PROPERTY]", "[CUSTOM_METRIC]").toString())
           .build();
   ApiFuture<Empty> future =
       analyticsAdminServiceClient.archiveCustomMetricCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<ArchiveCustomMetricRequest,Empty>

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

batchCreateAccessBindings(BatchCreateAccessBindingsRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   BatchCreateAccessBindingsRequest request =
       BatchCreateAccessBindingsRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .addAllRequests(new ArrayList<CreateAccessBindingRequest>())
           .build();
   BatchCreateAccessBindingsResponse response =
       analyticsAdminServiceClient.batchCreateAccessBindings(request);
 }
 
Parameter
Name Description
request BatchCreateAccessBindingsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
BatchCreateAccessBindingsResponse

batchCreateAccessBindingsCallable()

public final UnaryCallable<BatchCreateAccessBindingsRequest,BatchCreateAccessBindingsResponse> batchCreateAccessBindingsCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   BatchCreateAccessBindingsRequest request =
       BatchCreateAccessBindingsRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .addAllRequests(new ArrayList<CreateAccessBindingRequest>())
           .build();
   ApiFuture<BatchCreateAccessBindingsResponse> future =
       analyticsAdminServiceClient.batchCreateAccessBindingsCallable().futureCall(request);
   // Do something.
   BatchCreateAccessBindingsResponse response = future.get();
 }
 
Returns
Type Description
UnaryCallable<BatchCreateAccessBindingsRequest,BatchCreateAccessBindingsResponse>

batchDeleteAccessBindings(BatchDeleteAccessBindingsRequest request)

public final void batchDeleteAccessBindings(BatchDeleteAccessBindingsRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   BatchDeleteAccessBindingsRequest request =
       BatchDeleteAccessBindingsRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .addAllRequests(new ArrayList<DeleteAccessBindingRequest>())
           .build();
   analyticsAdminServiceClient.batchDeleteAccessBindings(request);
 }
 
Parameter
Name Description
request BatchDeleteAccessBindingsRequest

The request object containing all of the parameters for the API call.

batchDeleteAccessBindingsCallable()

public final UnaryCallable<BatchDeleteAccessBindingsRequest,Empty> batchDeleteAccessBindingsCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   BatchDeleteAccessBindingsRequest request =
       BatchDeleteAccessBindingsRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .addAllRequests(new ArrayList<DeleteAccessBindingRequest>())
           .build();
   ApiFuture<Empty> future =
       analyticsAdminServiceClient.batchDeleteAccessBindingsCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<BatchDeleteAccessBindingsRequest,Empty>

batchGetAccessBindings(BatchGetAccessBindingsRequest request)

public final BatchGetAccessBindingsResponse batchGetAccessBindings(BatchGetAccessBindingsRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   BatchGetAccessBindingsRequest request =
       BatchGetAccessBindingsRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .addAllNames(new ArrayList<String>())
           .build();
   BatchGetAccessBindingsResponse response =
       analyticsAdminServiceClient.batchGetAccessBindings(request);
 }
 
Parameter
Name Description
request BatchGetAccessBindingsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
BatchGetAccessBindingsResponse

batchGetAccessBindingsCallable()

public final UnaryCallable<BatchGetAccessBindingsRequest,BatchGetAccessBindingsResponse> batchGetAccessBindingsCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   BatchGetAccessBindingsRequest request =
       BatchGetAccessBindingsRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .addAllNames(new ArrayList<String>())
           .build();
   ApiFuture<BatchGetAccessBindingsResponse> future =
       analyticsAdminServiceClient.batchGetAccessBindingsCallable().futureCall(request);
   // Do something.
   BatchGetAccessBindingsResponse response = future.get();
 }
 
Returns
Type Description
UnaryCallable<BatchGetAccessBindingsRequest,BatchGetAccessBindingsResponse>

batchUpdateAccessBindings(BatchUpdateAccessBindingsRequest request)

public final BatchUpdateAccessBindingsResponse batchUpdateAccessBindings(BatchUpdateAccessBindingsRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   BatchUpdateAccessBindingsRequest request =
       BatchUpdateAccessBindingsRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .addAllRequests(new ArrayList<UpdateAccessBindingRequest>())
           .build();
   BatchUpdateAccessBindingsResponse response =
       analyticsAdminServiceClient.batchUpdateAccessBindings(request);
 }
 
Parameter
Name Description
request BatchUpdateAccessBindingsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
BatchUpdateAccessBindingsResponse

batchUpdateAccessBindingsCallable()

public final UnaryCallable<BatchUpdateAccessBindingsRequest,BatchUpdateAccessBindingsResponse> batchUpdateAccessBindingsCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   BatchUpdateAccessBindingsRequest request =
       BatchUpdateAccessBindingsRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .addAllRequests(new ArrayList<UpdateAccessBindingRequest>())
           .build();
   ApiFuture<BatchUpdateAccessBindingsResponse> future =
       analyticsAdminServiceClient.batchUpdateAccessBindingsCallable().futureCall(request);
   // Do something.
   BatchUpdateAccessBindingsResponse response = future.get();
 }
 
Returns
Type Description
UnaryCallable<BatchUpdateAccessBindingsRequest,BatchUpdateAccessBindingsResponse>

cancelDisplayVideo360AdvertiserLinkProposal(CancelDisplayVideo360AdvertiserLinkProposalRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CancelDisplayVideo360AdvertiserLinkProposalRequest request =
       CancelDisplayVideo360AdvertiserLinkProposalRequest.newBuilder()
           .setName(
               DisplayVideo360AdvertiserLinkProposalName.of(
                       "[PROPERTY]", "[DISPLAY_VIDEO_360_ADVERTISER_LINK_PROPOSAL]")
                   .toString())
           .build();
   DisplayVideo360AdvertiserLinkProposal response =
       analyticsAdminServiceClient.cancelDisplayVideo360AdvertiserLinkProposal(request);
 }
 
Parameter
Name Description
request CancelDisplayVideo360AdvertiserLinkProposalRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
DisplayVideo360AdvertiserLinkProposal

cancelDisplayVideo360AdvertiserLinkProposalCallable()

public final UnaryCallable<CancelDisplayVideo360AdvertiserLinkProposalRequest,DisplayVideo360AdvertiserLinkProposal> cancelDisplayVideo360AdvertiserLinkProposalCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CancelDisplayVideo360AdvertiserLinkProposalRequest request =
       CancelDisplayVideo360AdvertiserLinkProposalRequest.newBuilder()
           .setName(
               DisplayVideo360AdvertiserLinkProposalName.of(
                       "[PROPERTY]", "[DISPLAY_VIDEO_360_ADVERTISER_LINK_PROPOSAL]")
                   .toString())
           .build();
   ApiFuture<DisplayVideo360AdvertiserLinkProposal> future =
       analyticsAdminServiceClient
           .cancelDisplayVideo360AdvertiserLinkProposalCallable()
           .futureCall(request);
   // Do something.
   DisplayVideo360AdvertiserLinkProposal response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CancelDisplayVideo360AdvertiserLinkProposalRequest,DisplayVideo360AdvertiserLinkProposal>

close()

public final void close()

createAccessBinding(AccountName parent, AccessBinding accessBinding)

public final AccessBinding createAccessBinding(AccountName parent, AccessBinding accessBinding)

Creates an access binding on an account or property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   AccountName parent = AccountName.of("[ACCOUNT]");
   AccessBinding accessBinding = AccessBinding.newBuilder().build();
   AccessBinding response =
       analyticsAdminServiceClient.createAccessBinding(parent, accessBinding);
 }
 
Parameters
Name Description
parent AccountName

Required. Formats: - accounts/{account} - properties/{property}

accessBinding AccessBinding

Required. The access binding to create.

Returns
Type Description
AccessBinding

createAccessBinding(CreateAccessBindingRequest request)

public final AccessBinding createAccessBinding(CreateAccessBindingRequest request)

Creates an access binding on an account or property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateAccessBindingRequest request =
       CreateAccessBindingRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setAccessBinding(AccessBinding.newBuilder().build())
           .build();
   AccessBinding response = analyticsAdminServiceClient.createAccessBinding(request);
 }
 
Parameter
Name Description
request CreateAccessBindingRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
AccessBinding

createAccessBinding(PropertyName parent, AccessBinding accessBinding)

public final AccessBinding createAccessBinding(PropertyName parent, AccessBinding accessBinding)

Creates an access binding on an account or property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   PropertyName parent = PropertyName.of("[PROPERTY]");
   AccessBinding accessBinding = AccessBinding.newBuilder().build();
   AccessBinding response =
       analyticsAdminServiceClient.createAccessBinding(parent, accessBinding);
 }
 
Parameters
Name Description
parent PropertyName

Required. Formats: - accounts/{account} - properties/{property}

accessBinding AccessBinding

Required. The access binding to create.

Returns
Type Description
AccessBinding

createAccessBinding(String parent, AccessBinding accessBinding)

public final AccessBinding createAccessBinding(String parent, AccessBinding accessBinding)

Creates an access binding on an account or property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String parent = AccountName.of("[ACCOUNT]").toString();
   AccessBinding accessBinding = AccessBinding.newBuilder().build();
   AccessBinding response =
       analyticsAdminServiceClient.createAccessBinding(parent, accessBinding);
 }
 
Parameters
Name Description
parent String

Required. Formats: - accounts/{account} - properties/{property}

accessBinding AccessBinding

Required. The access binding to create.

Returns
Type Description
AccessBinding

createAccessBindingCallable()

public final UnaryCallable<CreateAccessBindingRequest,AccessBinding> createAccessBindingCallable()

Creates an access binding on an account or property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateAccessBindingRequest request =
       CreateAccessBindingRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setAccessBinding(AccessBinding.newBuilder().build())
           .build();
   ApiFuture<AccessBinding> future =
       analyticsAdminServiceClient.createAccessBindingCallable().futureCall(request);
   // Do something.
   AccessBinding response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateAccessBindingRequest,AccessBinding>
public final AdSenseLink createAdSenseLink(CreateAdSenseLinkRequest request)

Creates an AdSenseLink.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateAdSenseLinkRequest request =
       CreateAdSenseLinkRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setAdsenseLink(AdSenseLink.newBuilder().build())
           .build();
   AdSenseLink response = analyticsAdminServiceClient.createAdSenseLink(request);
 }
 
Parameter
Name Description
request CreateAdSenseLinkRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
AdSenseLink
public final AdSenseLink createAdSenseLink(PropertyName parent, AdSenseLink adsenseLink)

Creates an AdSenseLink.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   PropertyName parent = PropertyName.of("[PROPERTY]");
   AdSenseLink adsenseLink = AdSenseLink.newBuilder().build();
   AdSenseLink response = analyticsAdminServiceClient.createAdSenseLink(parent, adsenseLink);
 }
 
Parameters
Name Description
parent PropertyName

Required. The property for which to create an AdSense Link. Format: properties/{propertyId} Example: properties/1234

adsenseLink AdSenseLink

Required. The AdSense Link to create

Returns
Type Description
AdSenseLink
public final AdSenseLink createAdSenseLink(String parent, AdSenseLink adsenseLink)

Creates an AdSenseLink.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String parent = PropertyName.of("[PROPERTY]").toString();
   AdSenseLink adsenseLink = AdSenseLink.newBuilder().build();
   AdSenseLink response = analyticsAdminServiceClient.createAdSenseLink(parent, adsenseLink);
 }
 
Parameters
Name Description
parent String

Required. The property for which to create an AdSense Link. Format: properties/{propertyId} Example: properties/1234

adsenseLink AdSenseLink

Required. The AdSense Link to create

Returns
Type Description
AdSenseLink

createAdSenseLinkCallable()

public final UnaryCallable<CreateAdSenseLinkRequest,AdSenseLink> createAdSenseLinkCallable()

Creates an AdSenseLink.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateAdSenseLinkRequest request =
       CreateAdSenseLinkRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setAdsenseLink(AdSenseLink.newBuilder().build())
           .build();
   ApiFuture<AdSenseLink> future =
       analyticsAdminServiceClient.createAdSenseLinkCallable().futureCall(request);
   // Do something.
   AdSenseLink response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateAdSenseLinkRequest,AdSenseLink>

createAudience(CreateAudienceRequest request)

public final Audience createAudience(CreateAudienceRequest request)

Creates an Audience.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateAudienceRequest request =
       CreateAudienceRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setAudience(Audience.newBuilder().build())
           .build();
   Audience response = analyticsAdminServiceClient.createAudience(request);
 }
 
Parameter
Name Description
request CreateAudienceRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
Audience

createAudience(PropertyName parent, Audience audience)

public final Audience createAudience(PropertyName parent, Audience audience)

Creates an Audience.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   PropertyName parent = PropertyName.of("[PROPERTY]");
   Audience audience = Audience.newBuilder().build();
   Audience response = analyticsAdminServiceClient.createAudience(parent, audience);
 }
 
Parameters
Name Description
parent PropertyName

Required. Example format: properties/1234

audience Audience

Required. The audience to create.

Returns
Type Description
Audience

createAudience(String parent, Audience audience)

public final Audience createAudience(String parent, Audience audience)

Creates an Audience.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String parent = PropertyName.of("[PROPERTY]").toString();
   Audience audience = Audience.newBuilder().build();
   Audience response = analyticsAdminServiceClient.createAudience(parent, audience);
 }
 
Parameters
Name Description
parent String

Required. Example format: properties/1234

audience Audience

Required. The audience to create.

Returns
Type Description
Audience

createAudienceCallable()

public final UnaryCallable<CreateAudienceRequest,Audience> createAudienceCallable()

Creates an Audience.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateAudienceRequest request =
       CreateAudienceRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setAudience(Audience.newBuilder().build())
           .build();
   ApiFuture<Audience> future =
       analyticsAdminServiceClient.createAudienceCallable().futureCall(request);
   // Do something.
   Audience response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateAudienceRequest,Audience>
public final BigQueryLink createBigQueryLink(CreateBigQueryLinkRequest request)

Creates a BigQueryLink.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateBigQueryLinkRequest request =
       CreateBigQueryLinkRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setBigqueryLink(BigQueryLink.newBuilder().build())
           .build();
   BigQueryLink response = analyticsAdminServiceClient.createBigQueryLink(request);
 }
 
Parameter
Name Description
request CreateBigQueryLinkRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
BigQueryLink
public final BigQueryLink createBigQueryLink(PropertyName parent, BigQueryLink bigqueryLink)

Creates a BigQueryLink.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   PropertyName parent = PropertyName.of("[PROPERTY]");
   BigQueryLink bigqueryLink = BigQueryLink.newBuilder().build();
   BigQueryLink response = analyticsAdminServiceClient.createBigQueryLink(parent, bigqueryLink);
 }
 
Parameters
Name Description
parent PropertyName

Required. Example format: properties/1234

bigqueryLink BigQueryLink

Required. The BigQueryLink to create.

Returns
Type Description
BigQueryLink
public final BigQueryLink createBigQueryLink(String parent, BigQueryLink bigqueryLink)

Creates a BigQueryLink.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String parent = PropertyName.of("[PROPERTY]").toString();
   BigQueryLink bigqueryLink = BigQueryLink.newBuilder().build();
   BigQueryLink response = analyticsAdminServiceClient.createBigQueryLink(parent, bigqueryLink);
 }
 
Parameters
Name Description
parent String

Required. Example format: properties/1234

bigqueryLink BigQueryLink

Required. The BigQueryLink to create.

Returns
Type Description
BigQueryLink

createBigQueryLinkCallable()

public final UnaryCallable<CreateBigQueryLinkRequest,BigQueryLink> createBigQueryLinkCallable()

Creates a BigQueryLink.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateBigQueryLinkRequest request =
       CreateBigQueryLinkRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setBigqueryLink(BigQueryLink.newBuilder().build())
           .build();
   ApiFuture<BigQueryLink> future =
       analyticsAdminServiceClient.createBigQueryLinkCallable().futureCall(request);
   // Do something.
   BigQueryLink response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateBigQueryLinkRequest,BigQueryLink>

createCalculatedMetric(CreateCalculatedMetricRequest request)

public final CalculatedMetric createCalculatedMetric(CreateCalculatedMetricRequest request)

Creates a CalculatedMetric.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateCalculatedMetricRequest request =
       CreateCalculatedMetricRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setCalculatedMetricId("calculatedMetricId-277970231")
           .setCalculatedMetric(CalculatedMetric.newBuilder().build())
           .build();
   CalculatedMetric response = analyticsAdminServiceClient.createCalculatedMetric(request);
 }
 
Parameter
Name Description
request CreateCalculatedMetricRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
CalculatedMetric

createCalculatedMetric(PropertyName parent, CalculatedMetric calculatedMetric, String calculatedMetricId)

public final CalculatedMetric createCalculatedMetric(PropertyName parent, CalculatedMetric calculatedMetric, String calculatedMetricId)

Creates a CalculatedMetric.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   PropertyName parent = PropertyName.of("[PROPERTY]");
   CalculatedMetric calculatedMetric = CalculatedMetric.newBuilder().build();
   String calculatedMetricId = "calculatedMetricId-277970231";
   CalculatedMetric response =
       analyticsAdminServiceClient.createCalculatedMetric(
           parent, calculatedMetric, calculatedMetricId);
 }
 
Parameters
Name Description
parent PropertyName

Required. Format: properties/{property_id} Example: properties/1234

calculatedMetric CalculatedMetric

Required. The CalculatedMetric to create.

calculatedMetricId String

Required. The ID to use for the calculated metric which will become the final component of the calculated metric's resource name.

This value should be 1-80 characters and valid characters are /[a-zA-Z0-9_]/, no spaces allowed. calculated_metric_id must be unique between all calculated metrics under a property. The calculated_metric_id is used when referencing this calculated metric from external APIs, for example, "calcMetric:{calculated_metric_id}".

Returns
Type Description
CalculatedMetric

createCalculatedMetric(String parent, CalculatedMetric calculatedMetric, String calculatedMetricId)

public final CalculatedMetric createCalculatedMetric(String parent, CalculatedMetric calculatedMetric, String calculatedMetricId)

Creates a CalculatedMetric.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String parent = PropertyName.of("[PROPERTY]").toString();
   CalculatedMetric calculatedMetric = CalculatedMetric.newBuilder().build();
   String calculatedMetricId = "calculatedMetricId-277970231";
   CalculatedMetric response =
       analyticsAdminServiceClient.createCalculatedMetric(
           parent, calculatedMetric, calculatedMetricId);
 }
 
Parameters
Name Description
parent String

Required. Format: properties/{property_id} Example: properties/1234

calculatedMetric CalculatedMetric

Required. The CalculatedMetric to create.

calculatedMetricId String

Required. The ID to use for the calculated metric which will become the final component of the calculated metric's resource name.

This value should be 1-80 characters and valid characters are /[a-zA-Z0-9_]/, no spaces allowed. calculated_metric_id must be unique between all calculated metrics under a property. The calculated_metric_id is used when referencing this calculated metric from external APIs, for example, "calcMetric:{calculated_metric_id}".

Returns
Type Description
CalculatedMetric

createCalculatedMetricCallable()

public final UnaryCallable<CreateCalculatedMetricRequest,CalculatedMetric> createCalculatedMetricCallable()

Creates a CalculatedMetric.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateCalculatedMetricRequest request =
       CreateCalculatedMetricRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setCalculatedMetricId("calculatedMetricId-277970231")
           .setCalculatedMetric(CalculatedMetric.newBuilder().build())
           .build();
   ApiFuture<CalculatedMetric> future =
       analyticsAdminServiceClient.createCalculatedMetricCallable().futureCall(request);
   // Do something.
   CalculatedMetric response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateCalculatedMetricRequest,CalculatedMetric>

createChannelGroup(CreateChannelGroupRequest request)

public final ChannelGroup createChannelGroup(CreateChannelGroupRequest request)

Creates a ChannelGroup.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateChannelGroupRequest request =
       CreateChannelGroupRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setChannelGroup(ChannelGroup.newBuilder().build())
           .build();
   ChannelGroup response = analyticsAdminServiceClient.createChannelGroup(request);
 }
 
Parameter
Name Description
request CreateChannelGroupRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
ChannelGroup

createChannelGroup(PropertyName parent, ChannelGroup channelGroup)

public final ChannelGroup createChannelGroup(PropertyName parent, ChannelGroup channelGroup)

Creates a ChannelGroup.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   PropertyName parent = PropertyName.of("[PROPERTY]");
   ChannelGroup channelGroup = ChannelGroup.newBuilder().build();
   ChannelGroup response = analyticsAdminServiceClient.createChannelGroup(parent, channelGroup);
 }
 
Parameters
Name Description
parent PropertyName

Required. The property for which to create a ChannelGroup. Example format: properties/1234

channelGroup ChannelGroup

Required. The ChannelGroup to create.

Returns
Type Description
ChannelGroup

createChannelGroup(String parent, ChannelGroup channelGroup)

public final ChannelGroup createChannelGroup(String parent, ChannelGroup channelGroup)

Creates a ChannelGroup.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String parent = PropertyName.of("[PROPERTY]").toString();
   ChannelGroup channelGroup = ChannelGroup.newBuilder().build();
   ChannelGroup response = analyticsAdminServiceClient.createChannelGroup(parent, channelGroup);
 }
 
Parameters
Name Description
parent String

Required. The property for which to create a ChannelGroup. Example format: properties/1234

channelGroup ChannelGroup

Required. The ChannelGroup to create.

Returns
Type Description
ChannelGroup

createChannelGroupCallable()

public final UnaryCallable<CreateChannelGroupRequest,ChannelGroup> createChannelGroupCallable()

Creates a ChannelGroup.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateChannelGroupRequest request =
       CreateChannelGroupRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setChannelGroup(ChannelGroup.newBuilder().build())
           .build();
   ApiFuture<ChannelGroup> future =
       analyticsAdminServiceClient.createChannelGroupCallable().futureCall(request);
   // Do something.
   ChannelGroup response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateChannelGroupRequest,ChannelGroup>

createConnectedSiteTag(CreateConnectedSiteTagRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateConnectedSiteTagRequest request =
       CreateConnectedSiteTagRequest.newBuilder()
           .setProperty("property-993141291")
           .setConnectedSiteTag(ConnectedSiteTag.newBuilder().build())
           .build();
   CreateConnectedSiteTagResponse response =
       analyticsAdminServiceClient.createConnectedSiteTag(request);
 }
 
Parameter
Name Description
request CreateConnectedSiteTagRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
CreateConnectedSiteTagResponse

createConnectedSiteTagCallable()

public final UnaryCallable<CreateConnectedSiteTagRequest,CreateConnectedSiteTagResponse> createConnectedSiteTagCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateConnectedSiteTagRequest request =
       CreateConnectedSiteTagRequest.newBuilder()
           .setProperty("property-993141291")
           .setConnectedSiteTag(ConnectedSiteTag.newBuilder().build())
           .build();
   ApiFuture<CreateConnectedSiteTagResponse> future =
       analyticsAdminServiceClient.createConnectedSiteTagCallable().futureCall(request);
   // Do something.
   CreateConnectedSiteTagResponse response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateConnectedSiteTagRequest,CreateConnectedSiteTagResponse>

createConversionEvent(CreateConversionEventRequest request) (deprecated)

public final ConversionEvent createConversionEvent(CreateConversionEventRequest request)

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateConversionEventRequest request =
       CreateConversionEventRequest.newBuilder()
           .setConversionEvent(ConversionEvent.newBuilder().build())
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .build();
   ConversionEvent response = analyticsAdminServiceClient.createConversionEvent(request);
 }
 
Parameter
Name Description
request CreateConversionEventRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
ConversionEvent

createConversionEvent(PropertyName parent, ConversionEvent conversionEvent) (deprecated)

public final ConversionEvent createConversionEvent(PropertyName parent, ConversionEvent conversionEvent)

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   PropertyName parent = PropertyName.of("[PROPERTY]");
   ConversionEvent conversionEvent = ConversionEvent.newBuilder().build();
   ConversionEvent response =
       analyticsAdminServiceClient.createConversionEvent(parent, conversionEvent);
 }
 
Parameters
Name Description
parent PropertyName

Required. The resource name of the parent property where this conversion event will be created. Format: properties/123

conversionEvent ConversionEvent

Required. The conversion event to create.

Returns
Type Description
ConversionEvent

createConversionEvent(String parent, ConversionEvent conversionEvent) (deprecated)

public final ConversionEvent createConversionEvent(String parent, ConversionEvent conversionEvent)

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String parent = PropertyName.of("[PROPERTY]").toString();
   ConversionEvent conversionEvent = ConversionEvent.newBuilder().build();
   ConversionEvent response =
       analyticsAdminServiceClient.createConversionEvent(parent, conversionEvent);
 }
 
Parameters
Name Description
parent String

Required. The resource name of the parent property where this conversion event will be created. Format: properties/123

conversionEvent ConversionEvent

Required. The conversion event to create.

Returns
Type Description
ConversionEvent

createConversionEventCallable() (deprecated)

public final UnaryCallable<CreateConversionEventRequest,ConversionEvent> createConversionEventCallable()

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateConversionEventRequest request =
       CreateConversionEventRequest.newBuilder()
           .setConversionEvent(ConversionEvent.newBuilder().build())
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .build();
   ApiFuture<ConversionEvent> future =
       analyticsAdminServiceClient.createConversionEventCallable().futureCall(request);
   // Do something.
   ConversionEvent response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateConversionEventRequest,ConversionEvent>

createCustomDimension(CreateCustomDimensionRequest request)

public final CustomDimension createCustomDimension(CreateCustomDimensionRequest request)

Creates a CustomDimension.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateCustomDimensionRequest request =
       CreateCustomDimensionRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setCustomDimension(CustomDimension.newBuilder().build())
           .build();
   CustomDimension response = analyticsAdminServiceClient.createCustomDimension(request);
 }
 
Parameter
Name Description
request CreateCustomDimensionRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
CustomDimension

createCustomDimension(PropertyName parent, CustomDimension customDimension)

public final CustomDimension createCustomDimension(PropertyName parent, CustomDimension customDimension)

Creates a CustomDimension.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   PropertyName parent = PropertyName.of("[PROPERTY]");
   CustomDimension customDimension = CustomDimension.newBuilder().build();
   CustomDimension response =
       analyticsAdminServiceClient.createCustomDimension(parent, customDimension);
 }
 
Parameters
Name Description
parent PropertyName

Required. Example format: properties/1234

customDimension CustomDimension

Required. The CustomDimension to create.

Returns
Type Description
CustomDimension

createCustomDimension(String parent, CustomDimension customDimension)

public final CustomDimension createCustomDimension(String parent, CustomDimension customDimension)

Creates a CustomDimension.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String parent = PropertyName.of("[PROPERTY]").toString();
   CustomDimension customDimension = CustomDimension.newBuilder().build();
   CustomDimension response =
       analyticsAdminServiceClient.createCustomDimension(parent, customDimension);
 }
 
Parameters
Name Description
parent String

Required. Example format: properties/1234

customDimension CustomDimension

Required. The CustomDimension to create.

Returns
Type Description
CustomDimension

createCustomDimensionCallable()

public final UnaryCallable<CreateCustomDimensionRequest,CustomDimension> createCustomDimensionCallable()

Creates a CustomDimension.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateCustomDimensionRequest request =
       CreateCustomDimensionRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setCustomDimension(CustomDimension.newBuilder().build())
           .build();
   ApiFuture<CustomDimension> future =
       analyticsAdminServiceClient.createCustomDimensionCallable().futureCall(request);
   // Do something.
   CustomDimension response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateCustomDimensionRequest,CustomDimension>

createCustomMetric(CreateCustomMetricRequest request)

public final CustomMetric createCustomMetric(CreateCustomMetricRequest request)

Creates a CustomMetric.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateCustomMetricRequest request =
       CreateCustomMetricRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setCustomMetric(CustomMetric.newBuilder().build())
           .build();
   CustomMetric response = analyticsAdminServiceClient.createCustomMetric(request);
 }
 
Parameter
Name Description
request CreateCustomMetricRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
CustomMetric

createCustomMetric(PropertyName parent, CustomMetric customMetric)

public final CustomMetric createCustomMetric(PropertyName parent, CustomMetric customMetric)

Creates a CustomMetric.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   PropertyName parent = PropertyName.of("[PROPERTY]");
   CustomMetric customMetric = CustomMetric.newBuilder().build();
   CustomMetric response = analyticsAdminServiceClient.createCustomMetric(parent, customMetric);
 }
 
Parameters
Name Description
parent PropertyName

Required. Example format: properties/1234

customMetric CustomMetric

Required. The CustomMetric to create.

Returns
Type Description
CustomMetric

createCustomMetric(String parent, CustomMetric customMetric)

public final CustomMetric createCustomMetric(String parent, CustomMetric customMetric)

Creates a CustomMetric.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String parent = PropertyName.of("[PROPERTY]").toString();
   CustomMetric customMetric = CustomMetric.newBuilder().build();
   CustomMetric response = analyticsAdminServiceClient.createCustomMetric(parent, customMetric);
 }
 
Parameters
Name Description
parent String

Required. Example format: properties/1234

customMetric CustomMetric

Required. The CustomMetric to create.

Returns
Type Description
CustomMetric

createCustomMetricCallable()

public final UnaryCallable<CreateCustomMetricRequest,CustomMetric> createCustomMetricCallable()

Creates a CustomMetric.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateCustomMetricRequest request =
       CreateCustomMetricRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setCustomMetric(CustomMetric.newBuilder().build())
           .build();
   ApiFuture<CustomMetric> future =
       analyticsAdminServiceClient.createCustomMetricCallable().futureCall(request);
   // Do something.
   CustomMetric response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateCustomMetricRequest,CustomMetric>

createDataStream(CreateDataStreamRequest request)

public final DataStream createDataStream(CreateDataStreamRequest request)

Creates a DataStream.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateDataStreamRequest request =
       CreateDataStreamRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setDataStream(DataStream.newBuilder().build())
           .build();
   DataStream response = analyticsAdminServiceClient.createDataStream(request);
 }
 
Parameter
Name Description
request CreateDataStreamRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
DataStream

createDataStream(PropertyName parent, DataStream dataStream)

public final DataStream createDataStream(PropertyName parent, DataStream dataStream)

Creates a DataStream.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   PropertyName parent = PropertyName.of("[PROPERTY]");
   DataStream dataStream = DataStream.newBuilder().build();
   DataStream response = analyticsAdminServiceClient.createDataStream(parent, dataStream);
 }
 
Parameters
Name Description
parent PropertyName

Required. Example format: properties/1234

dataStream DataStream

Required. The DataStream to create.

Returns
Type Description
DataStream

createDataStream(String parent, DataStream dataStream)

public final DataStream createDataStream(String parent, DataStream dataStream)

Creates a DataStream.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String parent = PropertyName.of("[PROPERTY]").toString();
   DataStream dataStream = DataStream.newBuilder().build();
   DataStream response = analyticsAdminServiceClient.createDataStream(parent, dataStream);
 }
 
Parameters
Name Description
parent String

Required. Example format: properties/1234

dataStream DataStream

Required. The DataStream to create.

Returns
Type Description
DataStream

createDataStreamCallable()

public final UnaryCallable<CreateDataStreamRequest,DataStream> createDataStreamCallable()

Creates a DataStream.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateDataStreamRequest request =
       CreateDataStreamRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setDataStream(DataStream.newBuilder().build())
           .build();
   ApiFuture<DataStream> future =
       analyticsAdminServiceClient.createDataStreamCallable().futureCall(request);
   // Do something.
   DataStream response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateDataStreamRequest,DataStream>
public final 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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateDisplayVideo360AdvertiserLinkRequest request =
       CreateDisplayVideo360AdvertiserLinkRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setDisplayVideo360AdvertiserLink(DisplayVideo360AdvertiserLink.newBuilder().build())
           .build();
   DisplayVideo360AdvertiserLink response =
       analyticsAdminServiceClient.createDisplayVideo360AdvertiserLink(request);
 }
 
Parameter
Name Description
request CreateDisplayVideo360AdvertiserLinkRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
DisplayVideo360AdvertiserLink
public final DisplayVideo360AdvertiserLink createDisplayVideo360AdvertiserLink(PropertyName parent, DisplayVideo360AdvertiserLink displayVideo360AdvertiserLink)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   PropertyName parent = PropertyName.of("[PROPERTY]");
   DisplayVideo360AdvertiserLink displayVideo360AdvertiserLink =
       DisplayVideo360AdvertiserLink.newBuilder().build();
   DisplayVideo360AdvertiserLink response =
       analyticsAdminServiceClient.createDisplayVideo360AdvertiserLink(
           parent, displayVideo360AdvertiserLink);
 }
 
Parameters
Name Description
parent PropertyName

Required. Example format: properties/1234

displayVideo360AdvertiserLink DisplayVideo360AdvertiserLink

Required. The DisplayVideo360AdvertiserLink to create.

Returns
Type Description
DisplayVideo360AdvertiserLink
public final DisplayVideo360AdvertiserLink createDisplayVideo360AdvertiserLink(String parent, DisplayVideo360AdvertiserLink displayVideo360AdvertiserLink)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String parent = PropertyName.of("[PROPERTY]").toString();
   DisplayVideo360AdvertiserLink displayVideo360AdvertiserLink =
       DisplayVideo360AdvertiserLink.newBuilder().build();
   DisplayVideo360AdvertiserLink response =
       analyticsAdminServiceClient.createDisplayVideo360AdvertiserLink(
           parent, displayVideo360AdvertiserLink);
 }
 
Parameters
Name Description
parent String

Required. Example format: properties/1234

displayVideo360AdvertiserLink DisplayVideo360AdvertiserLink

Required. The DisplayVideo360AdvertiserLink to create.

Returns
Type Description
DisplayVideo360AdvertiserLink

createDisplayVideo360AdvertiserLinkCallable()

public final UnaryCallable<CreateDisplayVideo360AdvertiserLinkRequest,DisplayVideo360AdvertiserLink> createDisplayVideo360AdvertiserLinkCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateDisplayVideo360AdvertiserLinkRequest request =
       CreateDisplayVideo360AdvertiserLinkRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setDisplayVideo360AdvertiserLink(DisplayVideo360AdvertiserLink.newBuilder().build())
           .build();
   ApiFuture<DisplayVideo360AdvertiserLink> future =
       analyticsAdminServiceClient
           .createDisplayVideo360AdvertiserLinkCallable()
           .futureCall(request);
   // Do something.
   DisplayVideo360AdvertiserLink response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateDisplayVideo360AdvertiserLinkRequest,DisplayVideo360AdvertiserLink>

createDisplayVideo360AdvertiserLinkProposal(CreateDisplayVideo360AdvertiserLinkProposalRequest request)

public final DisplayVideo360AdvertiserLinkProposal createDisplayVideo360AdvertiserLinkProposal(CreateDisplayVideo360AdvertiserLinkProposalRequest request)

Creates a DisplayVideo360AdvertiserLinkProposal.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateDisplayVideo360AdvertiserLinkProposalRequest request =
       CreateDisplayVideo360AdvertiserLinkProposalRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setDisplayVideo360AdvertiserLinkProposal(
               DisplayVideo360AdvertiserLinkProposal.newBuilder().build())
           .build();
   DisplayVideo360AdvertiserLinkProposal response =
       analyticsAdminServiceClient.createDisplayVideo360AdvertiserLinkProposal(request);
 }
 
Parameter
Name Description
request CreateDisplayVideo360AdvertiserLinkProposalRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
DisplayVideo360AdvertiserLinkProposal

createDisplayVideo360AdvertiserLinkProposal(PropertyName parent, DisplayVideo360AdvertiserLinkProposal displayVideo360AdvertiserLinkProposal)

public final DisplayVideo360AdvertiserLinkProposal createDisplayVideo360AdvertiserLinkProposal(PropertyName parent, DisplayVideo360AdvertiserLinkProposal displayVideo360AdvertiserLinkProposal)

Creates a DisplayVideo360AdvertiserLinkProposal.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   PropertyName parent = PropertyName.of("[PROPERTY]");
   DisplayVideo360AdvertiserLinkProposal displayVideo360AdvertiserLinkProposal =
       DisplayVideo360AdvertiserLinkProposal.newBuilder().build();
   DisplayVideo360AdvertiserLinkProposal response =
       analyticsAdminServiceClient.createDisplayVideo360AdvertiserLinkProposal(
           parent, displayVideo360AdvertiserLinkProposal);
 }
 
Parameters
Name Description
parent PropertyName

Required. Example format: properties/1234

displayVideo360AdvertiserLinkProposal DisplayVideo360AdvertiserLinkProposal

Required. The DisplayVideo360AdvertiserLinkProposal to create.

Returns
Type Description
DisplayVideo360AdvertiserLinkProposal

createDisplayVideo360AdvertiserLinkProposal(String parent, DisplayVideo360AdvertiserLinkProposal displayVideo360AdvertiserLinkProposal)

public final DisplayVideo360AdvertiserLinkProposal createDisplayVideo360AdvertiserLinkProposal(String parent, DisplayVideo360AdvertiserLinkProposal displayVideo360AdvertiserLinkProposal)

Creates a DisplayVideo360AdvertiserLinkProposal.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String parent = PropertyName.of("[PROPERTY]").toString();
   DisplayVideo360AdvertiserLinkProposal displayVideo360AdvertiserLinkProposal =
       DisplayVideo360AdvertiserLinkProposal.newBuilder().build();
   DisplayVideo360AdvertiserLinkProposal response =
       analyticsAdminServiceClient.createDisplayVideo360AdvertiserLinkProposal(
           parent, displayVideo360AdvertiserLinkProposal);
 }
 
Parameters
Name Description
parent String

Required. Example format: properties/1234

displayVideo360AdvertiserLinkProposal DisplayVideo360AdvertiserLinkProposal

Required. The DisplayVideo360AdvertiserLinkProposal to create.

Returns
Type Description
DisplayVideo360AdvertiserLinkProposal

createDisplayVideo360AdvertiserLinkProposalCallable()

public final UnaryCallable<CreateDisplayVideo360AdvertiserLinkProposalRequest,DisplayVideo360AdvertiserLinkProposal> createDisplayVideo360AdvertiserLinkProposalCallable()

Creates a DisplayVideo360AdvertiserLinkProposal.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateDisplayVideo360AdvertiserLinkProposalRequest request =
       CreateDisplayVideo360AdvertiserLinkProposalRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setDisplayVideo360AdvertiserLinkProposal(
               DisplayVideo360AdvertiserLinkProposal.newBuilder().build())
           .build();
   ApiFuture<DisplayVideo360AdvertiserLinkProposal> future =
       analyticsAdminServiceClient
           .createDisplayVideo360AdvertiserLinkProposalCallable()
           .futureCall(request);
   // Do something.
   DisplayVideo360AdvertiserLinkProposal response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateDisplayVideo360AdvertiserLinkProposalRequest,DisplayVideo360AdvertiserLinkProposal>

createEventCreateRule(CreateEventCreateRuleRequest request)

public final EventCreateRule createEventCreateRule(CreateEventCreateRuleRequest request)

Creates an EventCreateRule.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateEventCreateRuleRequest request =
       CreateEventCreateRuleRequest.newBuilder()
           .setParent(DataStreamName.of("[PROPERTY]", "[DATA_STREAM]").toString())
           .setEventCreateRule(EventCreateRule.newBuilder().build())
           .build();
   EventCreateRule response = analyticsAdminServiceClient.createEventCreateRule(request);
 }
 
Parameter
Name Description
request CreateEventCreateRuleRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
EventCreateRule

createEventCreateRule(DataStreamName parent, EventCreateRule eventCreateRule)

public final EventCreateRule createEventCreateRule(DataStreamName parent, EventCreateRule eventCreateRule)

Creates an EventCreateRule.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DataStreamName parent = DataStreamName.of("[PROPERTY]", "[DATA_STREAM]");
   EventCreateRule eventCreateRule = EventCreateRule.newBuilder().build();
   EventCreateRule response =
       analyticsAdminServiceClient.createEventCreateRule(parent, eventCreateRule);
 }
 
Parameters
Name Description
parent DataStreamName

Required. Example format: properties/123/dataStreams/456

eventCreateRule EventCreateRule

Required. The EventCreateRule to create.

Returns
Type Description
EventCreateRule

createEventCreateRule(String parent, EventCreateRule eventCreateRule)

public final EventCreateRule createEventCreateRule(String parent, EventCreateRule eventCreateRule)

Creates an EventCreateRule.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String parent = DataStreamName.of("[PROPERTY]", "[DATA_STREAM]").toString();
   EventCreateRule eventCreateRule = EventCreateRule.newBuilder().build();
   EventCreateRule response =
       analyticsAdminServiceClient.createEventCreateRule(parent, eventCreateRule);
 }
 
Parameters
Name Description
parent String

Required. Example format: properties/123/dataStreams/456

eventCreateRule EventCreateRule

Required. The EventCreateRule to create.

Returns
Type Description
EventCreateRule

createEventCreateRuleCallable()

public final UnaryCallable<CreateEventCreateRuleRequest,EventCreateRule> createEventCreateRuleCallable()

Creates an EventCreateRule.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateEventCreateRuleRequest request =
       CreateEventCreateRuleRequest.newBuilder()
           .setParent(DataStreamName.of("[PROPERTY]", "[DATA_STREAM]").toString())
           .setEventCreateRule(EventCreateRule.newBuilder().build())
           .build();
   ApiFuture<EventCreateRule> future =
       analyticsAdminServiceClient.createEventCreateRuleCallable().futureCall(request);
   // Do something.
   EventCreateRule response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateEventCreateRuleRequest,EventCreateRule>

createEventEditRule(CreateEventEditRuleRequest request)

public final EventEditRule createEventEditRule(CreateEventEditRuleRequest request)

Creates an EventEditRule.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateEventEditRuleRequest request =
       CreateEventEditRuleRequest.newBuilder()
           .setParent(DataStreamName.of("[PROPERTY]", "[DATA_STREAM]").toString())
           .setEventEditRule(EventEditRule.newBuilder().build())
           .build();
   EventEditRule response = analyticsAdminServiceClient.createEventEditRule(request);
 }
 
Parameter
Name Description
request CreateEventEditRuleRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
EventEditRule

createEventEditRule(DataStreamName parent, EventEditRule eventEditRule)

public final EventEditRule createEventEditRule(DataStreamName parent, EventEditRule eventEditRule)

Creates an EventEditRule.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DataStreamName parent = DataStreamName.of("[PROPERTY]", "[DATA_STREAM]");
   EventEditRule eventEditRule = EventEditRule.newBuilder().build();
   EventEditRule response =
       analyticsAdminServiceClient.createEventEditRule(parent, eventEditRule);
 }
 
Parameters
Name Description
parent DataStreamName

Required. Example format: properties/123/dataStreams/456

eventEditRule EventEditRule

Required. The EventEditRule to create.

Returns
Type Description
EventEditRule

createEventEditRule(String parent, EventEditRule eventEditRule)

public final EventEditRule createEventEditRule(String parent, EventEditRule eventEditRule)

Creates an EventEditRule.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String parent = DataStreamName.of("[PROPERTY]", "[DATA_STREAM]").toString();
   EventEditRule eventEditRule = EventEditRule.newBuilder().build();
   EventEditRule response =
       analyticsAdminServiceClient.createEventEditRule(parent, eventEditRule);
 }
 
Parameters
Name Description
parent String

Required. Example format: properties/123/dataStreams/456

eventEditRule EventEditRule

Required. The EventEditRule to create.

Returns
Type Description
EventEditRule

createEventEditRuleCallable()

public final UnaryCallable<CreateEventEditRuleRequest,EventEditRule> createEventEditRuleCallable()

Creates an EventEditRule.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateEventEditRuleRequest request =
       CreateEventEditRuleRequest.newBuilder()
           .setParent(DataStreamName.of("[PROPERTY]", "[DATA_STREAM]").toString())
           .setEventEditRule(EventEditRule.newBuilder().build())
           .build();
   ApiFuture<EventEditRule> future =
       analyticsAdminServiceClient.createEventEditRuleCallable().futureCall(request);
   // Do something.
   EventEditRule response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateEventEditRuleRequest,EventEditRule>

createExpandedDataSet(CreateExpandedDataSetRequest request)

public final ExpandedDataSet createExpandedDataSet(CreateExpandedDataSetRequest request)

Creates a ExpandedDataSet.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateExpandedDataSetRequest request =
       CreateExpandedDataSetRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setExpandedDataSet(ExpandedDataSet.newBuilder().build())
           .build();
   ExpandedDataSet response = analyticsAdminServiceClient.createExpandedDataSet(request);
 }
 
Parameter
Name Description
request CreateExpandedDataSetRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
ExpandedDataSet

createExpandedDataSet(PropertyName parent, ExpandedDataSet expandedDataSet)

public final ExpandedDataSet createExpandedDataSet(PropertyName parent, ExpandedDataSet expandedDataSet)

Creates a ExpandedDataSet.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   PropertyName parent = PropertyName.of("[PROPERTY]");
   ExpandedDataSet expandedDataSet = ExpandedDataSet.newBuilder().build();
   ExpandedDataSet response =
       analyticsAdminServiceClient.createExpandedDataSet(parent, expandedDataSet);
 }
 
Parameters
Name Description
parent PropertyName

Required. Example format: properties/1234

expandedDataSet ExpandedDataSet

Required. The ExpandedDataSet to create.

Returns
Type Description
ExpandedDataSet

createExpandedDataSet(String parent, ExpandedDataSet expandedDataSet)

public final ExpandedDataSet createExpandedDataSet(String parent, ExpandedDataSet expandedDataSet)

Creates a ExpandedDataSet.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String parent = PropertyName.of("[PROPERTY]").toString();
   ExpandedDataSet expandedDataSet = ExpandedDataSet.newBuilder().build();
   ExpandedDataSet response =
       analyticsAdminServiceClient.createExpandedDataSet(parent, expandedDataSet);
 }
 
Parameters
Name Description
parent String

Required. Example format: properties/1234

expandedDataSet ExpandedDataSet

Required. The ExpandedDataSet to create.

Returns
Type Description
ExpandedDataSet

createExpandedDataSetCallable()

public final UnaryCallable<CreateExpandedDataSetRequest,ExpandedDataSet> createExpandedDataSetCallable()

Creates a ExpandedDataSet.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateExpandedDataSetRequest request =
       CreateExpandedDataSetRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setExpandedDataSet(ExpandedDataSet.newBuilder().build())
           .build();
   ApiFuture<ExpandedDataSet> future =
       analyticsAdminServiceClient.createExpandedDataSetCallable().futureCall(request);
   // Do something.
   ExpandedDataSet response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateExpandedDataSetRequest,ExpandedDataSet>
public final FirebaseLink createFirebaseLink(CreateFirebaseLinkRequest request)

Creates a FirebaseLink.

Properties can have at most one FirebaseLink.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateFirebaseLinkRequest request =
       CreateFirebaseLinkRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setFirebaseLink(FirebaseLink.newBuilder().build())
           .build();
   FirebaseLink response = analyticsAdminServiceClient.createFirebaseLink(request);
 }
 
Parameter
Name Description
request CreateFirebaseLinkRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
FirebaseLink
public final FirebaseLink createFirebaseLink(PropertyName parent, FirebaseLink firebaseLink)

Creates a FirebaseLink.

Properties can have at most one FirebaseLink.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   PropertyName parent = PropertyName.of("[PROPERTY]");
   FirebaseLink firebaseLink = FirebaseLink.newBuilder().build();
   FirebaseLink response = analyticsAdminServiceClient.createFirebaseLink(parent, firebaseLink);
 }
 
Parameters
Name Description
parent PropertyName

Required. Format: properties/{property_id}

Example: properties/1234

firebaseLink FirebaseLink

Required. The Firebase link to create.

Returns
Type Description
FirebaseLink
public final FirebaseLink createFirebaseLink(String parent, FirebaseLink firebaseLink)

Creates a FirebaseLink.

Properties can have at most one FirebaseLink.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String parent = PropertyName.of("[PROPERTY]").toString();
   FirebaseLink firebaseLink = FirebaseLink.newBuilder().build();
   FirebaseLink response = analyticsAdminServiceClient.createFirebaseLink(parent, firebaseLink);
 }
 
Parameters
Name Description
parent String

Required. Format: properties/{property_id}

Example: properties/1234

firebaseLink FirebaseLink

Required. The Firebase link to create.

Returns
Type Description
FirebaseLink

createFirebaseLinkCallable()

public final UnaryCallable<CreateFirebaseLinkRequest,FirebaseLink> createFirebaseLinkCallable()

Creates a FirebaseLink.

Properties can have at most one FirebaseLink.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateFirebaseLinkRequest request =
       CreateFirebaseLinkRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setFirebaseLink(FirebaseLink.newBuilder().build())
           .build();
   ApiFuture<FirebaseLink> future =
       analyticsAdminServiceClient.createFirebaseLinkCallable().futureCall(request);
   // Do something.
   FirebaseLink response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateFirebaseLinkRequest,FirebaseLink>
public final GoogleAdsLink createGoogleAdsLink(CreateGoogleAdsLinkRequest request)

Creates a GoogleAdsLink.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateGoogleAdsLinkRequest request =
       CreateGoogleAdsLinkRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setGoogleAdsLink(GoogleAdsLink.newBuilder().build())
           .build();
   GoogleAdsLink response = analyticsAdminServiceClient.createGoogleAdsLink(request);
 }
 
Parameter
Name Description
request CreateGoogleAdsLinkRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
GoogleAdsLink
public final GoogleAdsLink createGoogleAdsLink(PropertyName parent, GoogleAdsLink googleAdsLink)

Creates a GoogleAdsLink.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   PropertyName parent = PropertyName.of("[PROPERTY]");
   GoogleAdsLink googleAdsLink = GoogleAdsLink.newBuilder().build();
   GoogleAdsLink response =
       analyticsAdminServiceClient.createGoogleAdsLink(parent, googleAdsLink);
 }
 
Parameters
Name Description
parent PropertyName

Required. Example format: properties/1234

googleAdsLink GoogleAdsLink

Required. The GoogleAdsLink to create.

Returns
Type Description
GoogleAdsLink
public final GoogleAdsLink createGoogleAdsLink(String parent, GoogleAdsLink googleAdsLink)

Creates a GoogleAdsLink.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String parent = PropertyName.of("[PROPERTY]").toString();
   GoogleAdsLink googleAdsLink = GoogleAdsLink.newBuilder().build();
   GoogleAdsLink response =
       analyticsAdminServiceClient.createGoogleAdsLink(parent, googleAdsLink);
 }
 
Parameters
Name Description
parent String

Required. Example format: properties/1234

googleAdsLink GoogleAdsLink

Required. The GoogleAdsLink to create.

Returns
Type Description
GoogleAdsLink

createGoogleAdsLinkCallable()

public final UnaryCallable<CreateGoogleAdsLinkRequest,GoogleAdsLink> createGoogleAdsLinkCallable()

Creates a GoogleAdsLink.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateGoogleAdsLinkRequest request =
       CreateGoogleAdsLinkRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setGoogleAdsLink(GoogleAdsLink.newBuilder().build())
           .build();
   ApiFuture<GoogleAdsLink> future =
       analyticsAdminServiceClient.createGoogleAdsLinkCallable().futureCall(request);
   // Do something.
   GoogleAdsLink response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateGoogleAdsLinkRequest,GoogleAdsLink>

createKeyEvent(CreateKeyEventRequest request)

public final KeyEvent createKeyEvent(CreateKeyEventRequest request)

Creates a Key Event.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateKeyEventRequest request =
       CreateKeyEventRequest.newBuilder()
           .setKeyEvent(KeyEvent.newBuilder().build())
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .build();
   KeyEvent response = analyticsAdminServiceClient.createKeyEvent(request);
 }
 
Parameter
Name Description
request CreateKeyEventRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
KeyEvent

createKeyEvent(PropertyName parent, KeyEvent keyEvent)

public final KeyEvent createKeyEvent(PropertyName parent, KeyEvent keyEvent)

Creates a Key Event.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   PropertyName parent = PropertyName.of("[PROPERTY]");
   KeyEvent keyEvent = KeyEvent.newBuilder().build();
   KeyEvent response = analyticsAdminServiceClient.createKeyEvent(parent, keyEvent);
 }
 
Parameters
Name Description
parent PropertyName

Required. The resource name of the parent property where this Key Event will be created. Format: properties/123

keyEvent KeyEvent

Required. The Key Event to create.

Returns
Type Description
KeyEvent

createKeyEvent(String parent, KeyEvent keyEvent)

public final KeyEvent createKeyEvent(String parent, KeyEvent keyEvent)

Creates a Key Event.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String parent = PropertyName.of("[PROPERTY]").toString();
   KeyEvent keyEvent = KeyEvent.newBuilder().build();
   KeyEvent response = analyticsAdminServiceClient.createKeyEvent(parent, keyEvent);
 }
 
Parameters
Name Description
parent String

Required. The resource name of the parent property where this Key Event will be created. Format: properties/123

keyEvent KeyEvent

Required. The Key Event to create.

Returns
Type Description
KeyEvent

createKeyEventCallable()

public final UnaryCallable<CreateKeyEventRequest,KeyEvent> createKeyEventCallable()

Creates a Key Event.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateKeyEventRequest request =
       CreateKeyEventRequest.newBuilder()
           .setKeyEvent(KeyEvent.newBuilder().build())
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .build();
   ApiFuture<KeyEvent> future =
       analyticsAdminServiceClient.createKeyEventCallable().futureCall(request);
   // Do something.
   KeyEvent response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateKeyEventRequest,KeyEvent>

createMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest request)

public final MeasurementProtocolSecret createMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest request)

Creates a measurement protocol secret.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateMeasurementProtocolSecretRequest request =
       CreateMeasurementProtocolSecretRequest.newBuilder()
           .setParent(DataStreamName.of("[PROPERTY]", "[DATA_STREAM]").toString())
           .setMeasurementProtocolSecret(MeasurementProtocolSecret.newBuilder().build())
           .build();
   MeasurementProtocolSecret response =
       analyticsAdminServiceClient.createMeasurementProtocolSecret(request);
 }
 
Parameter
Name Description
request CreateMeasurementProtocolSecretRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
MeasurementProtocolSecret

createMeasurementProtocolSecret(DataStreamName parent, MeasurementProtocolSecret measurementProtocolSecret)

public final MeasurementProtocolSecret createMeasurementProtocolSecret(DataStreamName parent, MeasurementProtocolSecret measurementProtocolSecret)

Creates a measurement protocol secret.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DataStreamName parent = DataStreamName.of("[PROPERTY]", "[DATA_STREAM]");
   MeasurementProtocolSecret measurementProtocolSecret =
       MeasurementProtocolSecret.newBuilder().build();
   MeasurementProtocolSecret response =
       analyticsAdminServiceClient.createMeasurementProtocolSecret(
           parent, measurementProtocolSecret);
 }
 
Parameters
Name Description
parent DataStreamName

Required. The parent resource where this secret will be created. Format: properties/{property}/dataStreams/{dataStream}

measurementProtocolSecret MeasurementProtocolSecret

Required. The measurement protocol secret to create.

Returns
Type Description
MeasurementProtocolSecret

createMeasurementProtocolSecret(String parent, MeasurementProtocolSecret measurementProtocolSecret)

public final MeasurementProtocolSecret createMeasurementProtocolSecret(String parent, MeasurementProtocolSecret measurementProtocolSecret)

Creates a measurement protocol secret.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String parent = DataStreamName.of("[PROPERTY]", "[DATA_STREAM]").toString();
   MeasurementProtocolSecret measurementProtocolSecret =
       MeasurementProtocolSecret.newBuilder().build();
   MeasurementProtocolSecret response =
       analyticsAdminServiceClient.createMeasurementProtocolSecret(
           parent, measurementProtocolSecret);
 }
 
Parameters
Name Description
parent String

Required. The parent resource where this secret will be created. Format: properties/{property}/dataStreams/{dataStream}

measurementProtocolSecret MeasurementProtocolSecret

Required. The measurement protocol secret to create.

Returns
Type Description
MeasurementProtocolSecret

createMeasurementProtocolSecretCallable()

public final UnaryCallable<CreateMeasurementProtocolSecretRequest,MeasurementProtocolSecret> createMeasurementProtocolSecretCallable()

Creates a measurement protocol secret.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateMeasurementProtocolSecretRequest request =
       CreateMeasurementProtocolSecretRequest.newBuilder()
           .setParent(DataStreamName.of("[PROPERTY]", "[DATA_STREAM]").toString())
           .setMeasurementProtocolSecret(MeasurementProtocolSecret.newBuilder().build())
           .build();
   ApiFuture<MeasurementProtocolSecret> future =
       analyticsAdminServiceClient.createMeasurementProtocolSecretCallable().futureCall(request);
   // Do something.
   MeasurementProtocolSecret response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateMeasurementProtocolSecretRequest,MeasurementProtocolSecret>

createProperty(CreatePropertyRequest request)

public final Property createProperty(CreatePropertyRequest request)

Creates an "GA4" property with the specified location and attributes.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreatePropertyRequest request =
       CreatePropertyRequest.newBuilder().setProperty(Property.newBuilder().build()).build();
   Property response = analyticsAdminServiceClient.createProperty(request);
 }
 
Parameter
Name Description
request CreatePropertyRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
Property

createProperty(Property property)

public final Property createProperty(Property property)

Creates an "GA4" property with the specified location and attributes.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   Property property = Property.newBuilder().build();
   Property response = analyticsAdminServiceClient.createProperty(property);
 }
 
Parameter
Name Description
property Property

Required. The property to create. Note: the supplied property must specify its parent.

Returns
Type Description
Property

createPropertyCallable()

public final UnaryCallable<CreatePropertyRequest,Property> createPropertyCallable()

Creates an "GA4" property with the specified location and attributes.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreatePropertyRequest request =
       CreatePropertyRequest.newBuilder().setProperty(Property.newBuilder().build()).build();
   ApiFuture<Property> future =
       analyticsAdminServiceClient.createPropertyCallable().futureCall(request);
   // Do something.
   Property response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreatePropertyRequest,Property>

createRollupProperty(CreateRollupPropertyRequest request)

public final CreateRollupPropertyResponse createRollupProperty(CreateRollupPropertyRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateRollupPropertyRequest request =
       CreateRollupPropertyRequest.newBuilder()
           .setRollupProperty(Property.newBuilder().build())
           .addAllSourceProperties(new ArrayList<String>())
           .build();
   CreateRollupPropertyResponse response =
       analyticsAdminServiceClient.createRollupProperty(request);
 }
 
Parameter
Name Description
request CreateRollupPropertyRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
CreateRollupPropertyResponse

createRollupPropertyCallable()

public final UnaryCallable<CreateRollupPropertyRequest,CreateRollupPropertyResponse> createRollupPropertyCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateRollupPropertyRequest request =
       CreateRollupPropertyRequest.newBuilder()
           .setRollupProperty(Property.newBuilder().build())
           .addAllSourceProperties(new ArrayList<String>())
           .build();
   ApiFuture<CreateRollupPropertyResponse> future =
       analyticsAdminServiceClient.createRollupPropertyCallable().futureCall(request);
   // Do something.
   CreateRollupPropertyResponse response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateRollupPropertyRequest,CreateRollupPropertyResponse>
public final 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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateRollupPropertySourceLinkRequest request =
       CreateRollupPropertySourceLinkRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setRollupPropertySourceLink(RollupPropertySourceLink.newBuilder().build())
           .build();
   RollupPropertySourceLink response =
       analyticsAdminServiceClient.createRollupPropertySourceLink(request);
 }
 
Parameter
Name Description
request CreateRollupPropertySourceLinkRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
RollupPropertySourceLink
public final RollupPropertySourceLink createRollupPropertySourceLink(PropertyName parent, RollupPropertySourceLink rollupPropertySourceLink)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   PropertyName parent = PropertyName.of("[PROPERTY]");
   RollupPropertySourceLink rollupPropertySourceLink =
       RollupPropertySourceLink.newBuilder().build();
   RollupPropertySourceLink response =
       analyticsAdminServiceClient.createRollupPropertySourceLink(
           parent, rollupPropertySourceLink);
 }
 
Parameters
Name Description
parent PropertyName

Required. Format: properties/{property_id} Example: properties/1234

rollupPropertySourceLink RollupPropertySourceLink

Required. The roll-up property source link to create.

Returns
Type Description
RollupPropertySourceLink
public final RollupPropertySourceLink createRollupPropertySourceLink(String parent, RollupPropertySourceLink rollupPropertySourceLink)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String parent = PropertyName.of("[PROPERTY]").toString();
   RollupPropertySourceLink rollupPropertySourceLink =
       RollupPropertySourceLink.newBuilder().build();
   RollupPropertySourceLink response =
       analyticsAdminServiceClient.createRollupPropertySourceLink(
           parent, rollupPropertySourceLink);
 }
 
Parameters
Name Description
parent String

Required. Format: properties/{property_id} Example: properties/1234

rollupPropertySourceLink RollupPropertySourceLink

Required. The roll-up property source link to create.

Returns
Type Description
RollupPropertySourceLink

createRollupPropertySourceLinkCallable()

public final UnaryCallable<CreateRollupPropertySourceLinkRequest,RollupPropertySourceLink> createRollupPropertySourceLinkCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateRollupPropertySourceLinkRequest request =
       CreateRollupPropertySourceLinkRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setRollupPropertySourceLink(RollupPropertySourceLink.newBuilder().build())
           .build();
   ApiFuture<RollupPropertySourceLink> future =
       analyticsAdminServiceClient.createRollupPropertySourceLinkCallable().futureCall(request);
   // Do something.
   RollupPropertySourceLink response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateRollupPropertySourceLinkRequest,RollupPropertySourceLink>

createSKAdNetworkConversionValueSchema(CreateSKAdNetworkConversionValueSchemaRequest request)

public final SKAdNetworkConversionValueSchema createSKAdNetworkConversionValueSchema(CreateSKAdNetworkConversionValueSchemaRequest request)

Creates a SKAdNetworkConversionValueSchema.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateSKAdNetworkConversionValueSchemaRequest request =
       CreateSKAdNetworkConversionValueSchemaRequest.newBuilder()
           .setParent(DataStreamName.of("[PROPERTY]", "[DATA_STREAM]").toString())
           .setSkadnetworkConversionValueSchema(
               SKAdNetworkConversionValueSchema.newBuilder().build())
           .build();
   SKAdNetworkConversionValueSchema response =
       analyticsAdminServiceClient.createSKAdNetworkConversionValueSchema(request);
 }
 
Parameter
Name Description
request CreateSKAdNetworkConversionValueSchemaRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
SKAdNetworkConversionValueSchema

createSKAdNetworkConversionValueSchema(DataStreamName parent, SKAdNetworkConversionValueSchema skadnetworkConversionValueSchema)

public final SKAdNetworkConversionValueSchema createSKAdNetworkConversionValueSchema(DataStreamName parent, SKAdNetworkConversionValueSchema skadnetworkConversionValueSchema)

Creates a SKAdNetworkConversionValueSchema.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DataStreamName parent = DataStreamName.of("[PROPERTY]", "[DATA_STREAM]");
   SKAdNetworkConversionValueSchema skadnetworkConversionValueSchema =
       SKAdNetworkConversionValueSchema.newBuilder().build();
   SKAdNetworkConversionValueSchema response =
       analyticsAdminServiceClient.createSKAdNetworkConversionValueSchema(
           parent, skadnetworkConversionValueSchema);
 }
 
Parameters
Name Description
parent DataStreamName

Required. The parent resource where this schema will be created. Format: properties/{property}/dataStreams/{dataStream}

skadnetworkConversionValueSchema SKAdNetworkConversionValueSchema

Required. SKAdNetwork conversion value schema to create.

Returns
Type Description
SKAdNetworkConversionValueSchema

createSKAdNetworkConversionValueSchema(String parent, SKAdNetworkConversionValueSchema skadnetworkConversionValueSchema)

public final SKAdNetworkConversionValueSchema createSKAdNetworkConversionValueSchema(String parent, SKAdNetworkConversionValueSchema skadnetworkConversionValueSchema)

Creates a SKAdNetworkConversionValueSchema.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String parent = DataStreamName.of("[PROPERTY]", "[DATA_STREAM]").toString();
   SKAdNetworkConversionValueSchema skadnetworkConversionValueSchema =
       SKAdNetworkConversionValueSchema.newBuilder().build();
   SKAdNetworkConversionValueSchema response =
       analyticsAdminServiceClient.createSKAdNetworkConversionValueSchema(
           parent, skadnetworkConversionValueSchema);
 }
 
Parameters
Name Description
parent String

Required. The parent resource where this schema will be created. Format: properties/{property}/dataStreams/{dataStream}

skadnetworkConversionValueSchema SKAdNetworkConversionValueSchema

Required. SKAdNetwork conversion value schema to create.

Returns
Type Description
SKAdNetworkConversionValueSchema

createSKAdNetworkConversionValueSchemaCallable()

public final UnaryCallable<CreateSKAdNetworkConversionValueSchemaRequest,SKAdNetworkConversionValueSchema> createSKAdNetworkConversionValueSchemaCallable()

Creates a SKAdNetworkConversionValueSchema.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateSKAdNetworkConversionValueSchemaRequest request =
       CreateSKAdNetworkConversionValueSchemaRequest.newBuilder()
           .setParent(DataStreamName.of("[PROPERTY]", "[DATA_STREAM]").toString())
           .setSkadnetworkConversionValueSchema(
               SKAdNetworkConversionValueSchema.newBuilder().build())
           .build();
   ApiFuture<SKAdNetworkConversionValueSchema> future =
       analyticsAdminServiceClient
           .createSKAdNetworkConversionValueSchemaCallable()
           .futureCall(request);
   // Do something.
   SKAdNetworkConversionValueSchema response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateSKAdNetworkConversionValueSchemaRequest,SKAdNetworkConversionValueSchema>
public final SearchAds360Link createSearchAds360Link(CreateSearchAds360LinkRequest request)

Creates a SearchAds360Link.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateSearchAds360LinkRequest request =
       CreateSearchAds360LinkRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setSearchAds360Link(SearchAds360Link.newBuilder().build())
           .build();
   SearchAds360Link response = analyticsAdminServiceClient.createSearchAds360Link(request);
 }
 
Parameter
Name Description
request CreateSearchAds360LinkRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
SearchAds360Link
public final SearchAds360Link createSearchAds360Link(PropertyName parent, SearchAds360Link searchAds360Link)

Creates a SearchAds360Link.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   PropertyName parent = PropertyName.of("[PROPERTY]");
   SearchAds360Link searchAds360Link = SearchAds360Link.newBuilder().build();
   SearchAds360Link response =
       analyticsAdminServiceClient.createSearchAds360Link(parent, searchAds360Link);
 }
 
Parameters
Name Description
parent PropertyName

Required. Example format: properties/1234

searchAds360Link SearchAds360Link

Required. The SearchAds360Link to create.

Returns
Type Description
SearchAds360Link
public final SearchAds360Link createSearchAds360Link(String parent, SearchAds360Link searchAds360Link)

Creates a SearchAds360Link.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String parent = PropertyName.of("[PROPERTY]").toString();
   SearchAds360Link searchAds360Link = SearchAds360Link.newBuilder().build();
   SearchAds360Link response =
       analyticsAdminServiceClient.createSearchAds360Link(parent, searchAds360Link);
 }
 
Parameters
Name Description
parent String

Required. Example format: properties/1234

searchAds360Link SearchAds360Link

Required. The SearchAds360Link to create.

Returns
Type Description
SearchAds360Link

createSearchAds360LinkCallable()

public final UnaryCallable<CreateSearchAds360LinkRequest,SearchAds360Link> createSearchAds360LinkCallable()

Creates a SearchAds360Link.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateSearchAds360LinkRequest request =
       CreateSearchAds360LinkRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setSearchAds360Link(SearchAds360Link.newBuilder().build())
           .build();
   ApiFuture<SearchAds360Link> future =
       analyticsAdminServiceClient.createSearchAds360LinkCallable().futureCall(request);
   // Do something.
   SearchAds360Link response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateSearchAds360LinkRequest,SearchAds360Link>

createSubpropertyEventFilter(CreateSubpropertyEventFilterRequest request)

public final SubpropertyEventFilter createSubpropertyEventFilter(CreateSubpropertyEventFilterRequest request)

Creates a subproperty Event Filter.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateSubpropertyEventFilterRequest request =
       CreateSubpropertyEventFilterRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setSubpropertyEventFilter(SubpropertyEventFilter.newBuilder().build())
           .build();
   SubpropertyEventFilter response =
       analyticsAdminServiceClient.createSubpropertyEventFilter(request);
 }
 
Parameter
Name Description
request CreateSubpropertyEventFilterRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
SubpropertyEventFilter

createSubpropertyEventFilter(PropertyName parent, SubpropertyEventFilter subpropertyEventFilter)

public final SubpropertyEventFilter createSubpropertyEventFilter(PropertyName parent, SubpropertyEventFilter subpropertyEventFilter)

Creates a subproperty Event Filter.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   PropertyName parent = PropertyName.of("[PROPERTY]");
   SubpropertyEventFilter subpropertyEventFilter = SubpropertyEventFilter.newBuilder().build();
   SubpropertyEventFilter response =
       analyticsAdminServiceClient.createSubpropertyEventFilter(parent, subpropertyEventFilter);
 }
 
Parameters
Name Description
parent PropertyName

Required. The ordinary property for which to create a subproperty event filter. Format: properties/property_id Example: properties/123

subpropertyEventFilter SubpropertyEventFilter

Required. The subproperty event filter to create.

Returns
Type Description
SubpropertyEventFilter

createSubpropertyEventFilter(String parent, SubpropertyEventFilter subpropertyEventFilter)

public final SubpropertyEventFilter createSubpropertyEventFilter(String parent, SubpropertyEventFilter subpropertyEventFilter)

Creates a subproperty Event Filter.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String parent = PropertyName.of("[PROPERTY]").toString();
   SubpropertyEventFilter subpropertyEventFilter = SubpropertyEventFilter.newBuilder().build();
   SubpropertyEventFilter response =
       analyticsAdminServiceClient.createSubpropertyEventFilter(parent, subpropertyEventFilter);
 }
 
Parameters
Name Description
parent String

Required. The ordinary property for which to create a subproperty event filter. Format: properties/property_id Example: properties/123

subpropertyEventFilter SubpropertyEventFilter

Required. The subproperty event filter to create.

Returns
Type Description
SubpropertyEventFilter

createSubpropertyEventFilterCallable()

public final UnaryCallable<CreateSubpropertyEventFilterRequest,SubpropertyEventFilter> createSubpropertyEventFilterCallable()

Creates a subproperty Event Filter.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CreateSubpropertyEventFilterRequest request =
       CreateSubpropertyEventFilterRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setSubpropertyEventFilter(SubpropertyEventFilter.newBuilder().build())
           .build();
   ApiFuture<SubpropertyEventFilter> future =
       analyticsAdminServiceClient.createSubpropertyEventFilterCallable().futureCall(request);
   // Do something.
   SubpropertyEventFilter response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateSubpropertyEventFilterRequest,SubpropertyEventFilter>

deleteAccessBinding(AccessBindingName name)

public final void deleteAccessBinding(AccessBindingName name)

Deletes an access binding on an account or property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   AccessBindingName name =
       AccessBindingName.ofAccountAccessBindingName("[ACCOUNT]", "[ACCESS_BINDING]");
   analyticsAdminServiceClient.deleteAccessBinding(name);
 }
 
Parameter
Name Description
name AccessBindingName

Required. Formats: - accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding}

deleteAccessBinding(DeleteAccessBindingRequest request)

public final void deleteAccessBinding(DeleteAccessBindingRequest request)

Deletes an access binding on an account or property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DeleteAccessBindingRequest request =
       DeleteAccessBindingRequest.newBuilder()
           .setName(
               AccessBindingName.ofAccountAccessBindingName("[ACCOUNT]", "[ACCESS_BINDING]")
                   .toString())
           .build();
   analyticsAdminServiceClient.deleteAccessBinding(request);
 }
 
Parameter
Name Description
request DeleteAccessBindingRequest

The request object containing all of the parameters for the API call.

deleteAccessBinding(String name)

public final void deleteAccessBinding(String name)

Deletes an access binding on an account or property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name =
       AccessBindingName.ofAccountAccessBindingName("[ACCOUNT]", "[ACCESS_BINDING]").toString();
   analyticsAdminServiceClient.deleteAccessBinding(name);
 }
 
Parameter
Name Description
name String

Required. Formats: - accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding}

deleteAccessBindingCallable()

public final UnaryCallable<DeleteAccessBindingRequest,Empty> deleteAccessBindingCallable()

Deletes an access binding on an account or property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DeleteAccessBindingRequest request =
       DeleteAccessBindingRequest.newBuilder()
           .setName(
               AccessBindingName.ofAccountAccessBindingName("[ACCOUNT]", "[ACCESS_BINDING]")
                   .toString())
           .build();
   ApiFuture<Empty> future =
       analyticsAdminServiceClient.deleteAccessBindingCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteAccessBindingRequest,Empty>

deleteAccount(AccountName name)

public final void deleteAccount(AccountName name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   AccountName name = AccountName.of("[ACCOUNT]");
   analyticsAdminServiceClient.deleteAccount(name);
 }
 
Parameter
Name Description
name AccountName

Required. The name of the Account to soft-delete. Format: accounts/{account} Example: "accounts/100"

deleteAccount(DeleteAccountRequest request)

public final void 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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DeleteAccountRequest request =
       DeleteAccountRequest.newBuilder().setName(AccountName.of("[ACCOUNT]").toString()).build();
   analyticsAdminServiceClient.deleteAccount(request);
 }
 
Parameter
Name Description
request DeleteAccountRequest

The request object containing all of the parameters for the API call.

deleteAccount(String name)

public final void deleteAccount(String name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name = AccountName.of("[ACCOUNT]").toString();
   analyticsAdminServiceClient.deleteAccount(name);
 }
 
Parameter
Name Description
name String

Required. The name of the Account to soft-delete. Format: accounts/{account} Example: "accounts/100"

deleteAccountCallable()

public final UnaryCallable<DeleteAccountRequest,Empty> deleteAccountCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DeleteAccountRequest request =
       DeleteAccountRequest.newBuilder().setName(AccountName.of("[ACCOUNT]").toString()).build();
   ApiFuture<Empty> future =
       analyticsAdminServiceClient.deleteAccountCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteAccountRequest,Empty>
public final void deleteAdSenseLink(AdSenseLinkName name)

Deletes an AdSenseLink.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   AdSenseLinkName name = AdSenseLinkName.of("[PROPERTY]", "[ADSENSE_LINK]");
   analyticsAdminServiceClient.deleteAdSenseLink(name);
 }
 
Parameter
Name Description
name AdSenseLinkName

Required. Unique identifier for the AdSense Link to be deleted. Format: properties/{propertyId}/adSenseLinks/{linkId} Example: properties/1234/adSenseLinks/5678

public final void deleteAdSenseLink(DeleteAdSenseLinkRequest request)

Deletes an AdSenseLink.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DeleteAdSenseLinkRequest request =
       DeleteAdSenseLinkRequest.newBuilder()
           .setName(AdSenseLinkName.of("[PROPERTY]", "[ADSENSE_LINK]").toString())
           .build();
   analyticsAdminServiceClient.deleteAdSenseLink(request);
 }
 
Parameter
Name Description
request DeleteAdSenseLinkRequest

The request object containing all of the parameters for the API call.

public final void deleteAdSenseLink(String name)

Deletes an AdSenseLink.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name = AdSenseLinkName.of("[PROPERTY]", "[ADSENSE_LINK]").toString();
   analyticsAdminServiceClient.deleteAdSenseLink(name);
 }
 
Parameter
Name Description
name String

Required. Unique identifier for the AdSense Link to be deleted. Format: properties/{propertyId}/adSenseLinks/{linkId} Example: properties/1234/adSenseLinks/5678

deleteAdSenseLinkCallable()

public final UnaryCallable<DeleteAdSenseLinkRequest,Empty> deleteAdSenseLinkCallable()

Deletes an AdSenseLink.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DeleteAdSenseLinkRequest request =
       DeleteAdSenseLinkRequest.newBuilder()
           .setName(AdSenseLinkName.of("[PROPERTY]", "[ADSENSE_LINK]").toString())
           .build();
   ApiFuture<Empty> future =
       analyticsAdminServiceClient.deleteAdSenseLinkCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteAdSenseLinkRequest,Empty>
public final void deleteBigQueryLink(BigQueryLinkName name)

Deletes a BigQueryLink on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   BigQueryLinkName name = BigQueryLinkName.of("[PROPERTY]", "[BIGQUERY_LINK]");
   analyticsAdminServiceClient.deleteBigQueryLink(name);
 }
 
Parameter
Name Description
name BigQueryLinkName

Required. The BigQueryLink to delete. Example format: properties/1234/bigQueryLinks/5678

public final void deleteBigQueryLink(DeleteBigQueryLinkRequest request)

Deletes a BigQueryLink on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DeleteBigQueryLinkRequest request =
       DeleteBigQueryLinkRequest.newBuilder()
           .setName(BigQueryLinkName.of("[PROPERTY]", "[BIGQUERY_LINK]").toString())
           .build();
   analyticsAdminServiceClient.deleteBigQueryLink(request);
 }
 
Parameter
Name Description
request DeleteBigQueryLinkRequest

The request object containing all of the parameters for the API call.

public final void deleteBigQueryLink(String name)

Deletes a BigQueryLink on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name = BigQueryLinkName.of("[PROPERTY]", "[BIGQUERY_LINK]").toString();
   analyticsAdminServiceClient.deleteBigQueryLink(name);
 }
 
Parameter
Name Description
name String

Required. The BigQueryLink to delete. Example format: properties/1234/bigQueryLinks/5678

deleteBigQueryLinkCallable()

public final UnaryCallable<DeleteBigQueryLinkRequest,Empty> deleteBigQueryLinkCallable()

Deletes a BigQueryLink on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DeleteBigQueryLinkRequest request =
       DeleteBigQueryLinkRequest.newBuilder()
           .setName(BigQueryLinkName.of("[PROPERTY]", "[BIGQUERY_LINK]").toString())
           .build();
   ApiFuture<Empty> future =
       analyticsAdminServiceClient.deleteBigQueryLinkCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteBigQueryLinkRequest,Empty>

deleteCalculatedMetric(CalculatedMetricName name)

public final void deleteCalculatedMetric(CalculatedMetricName name)

Deletes a CalculatedMetric on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CalculatedMetricName name = CalculatedMetricName.of("[PROPERTY]", "[CALCULATED_METRIC]");
   analyticsAdminServiceClient.deleteCalculatedMetric(name);
 }
 
Parameter
Name Description
name CalculatedMetricName

Required. The name of the CalculatedMetric to delete. Format: properties/{property_id}/calculatedMetrics/{calculated_metric_id} Example: properties/1234/calculatedMetrics/Metric01

deleteCalculatedMetric(DeleteCalculatedMetricRequest request)

public final void deleteCalculatedMetric(DeleteCalculatedMetricRequest request)

Deletes a CalculatedMetric on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DeleteCalculatedMetricRequest request =
       DeleteCalculatedMetricRequest.newBuilder()
           .setName(CalculatedMetricName.of("[PROPERTY]", "[CALCULATED_METRIC]").toString())
           .build();
   analyticsAdminServiceClient.deleteCalculatedMetric(request);
 }
 
Parameter
Name Description
request DeleteCalculatedMetricRequest

The request object containing all of the parameters for the API call.

deleteCalculatedMetric(String name)

public final void deleteCalculatedMetric(String name)

Deletes a CalculatedMetric on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name = CalculatedMetricName.of("[PROPERTY]", "[CALCULATED_METRIC]").toString();
   analyticsAdminServiceClient.deleteCalculatedMetric(name);
 }
 
Parameter
Name Description
name String

Required. The name of the CalculatedMetric to delete. Format: properties/{property_id}/calculatedMetrics/{calculated_metric_id} Example: properties/1234/calculatedMetrics/Metric01

deleteCalculatedMetricCallable()

public final UnaryCallable<DeleteCalculatedMetricRequest,Empty> deleteCalculatedMetricCallable()

Deletes a CalculatedMetric on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DeleteCalculatedMetricRequest request =
       DeleteCalculatedMetricRequest.newBuilder()
           .setName(CalculatedMetricName.of("[PROPERTY]", "[CALCULATED_METRIC]").toString())
           .build();
   ApiFuture<Empty> future =
       analyticsAdminServiceClient.deleteCalculatedMetricCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteCalculatedMetricRequest,Empty>

deleteChannelGroup(ChannelGroupName name)

public final void deleteChannelGroup(ChannelGroupName name)

Deletes a ChannelGroup on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ChannelGroupName name = ChannelGroupName.of("[PROPERTY]", "[CHANNEL_GROUP]");
   analyticsAdminServiceClient.deleteChannelGroup(name);
 }
 
Parameter
Name Description
name ChannelGroupName

Required. The ChannelGroup to delete. Example format: properties/1234/channelGroups/5678

deleteChannelGroup(DeleteChannelGroupRequest request)

public final void deleteChannelGroup(DeleteChannelGroupRequest request)

Deletes a ChannelGroup on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DeleteChannelGroupRequest request =
       DeleteChannelGroupRequest.newBuilder()
           .setName(ChannelGroupName.of("[PROPERTY]", "[CHANNEL_GROUP]").toString())
           .build();
   analyticsAdminServiceClient.deleteChannelGroup(request);
 }
 
Parameter
Name Description
request DeleteChannelGroupRequest

The request object containing all of the parameters for the API call.

deleteChannelGroup(String name)

public final void deleteChannelGroup(String name)

Deletes a ChannelGroup on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name = ChannelGroupName.of("[PROPERTY]", "[CHANNEL_GROUP]").toString();
   analyticsAdminServiceClient.deleteChannelGroup(name);
 }
 
Parameter
Name Description
name String

Required. The ChannelGroup to delete. Example format: properties/1234/channelGroups/5678

deleteChannelGroupCallable()

public final UnaryCallable<DeleteChannelGroupRequest,Empty> deleteChannelGroupCallable()

Deletes a ChannelGroup on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DeleteChannelGroupRequest request =
       DeleteChannelGroupRequest.newBuilder()
           .setName(ChannelGroupName.of("[PROPERTY]", "[CHANNEL_GROUP]").toString())
           .build();
   ApiFuture<Empty> future =
       analyticsAdminServiceClient.deleteChannelGroupCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteChannelGroupRequest,Empty>

deleteConnectedSiteTag(DeleteConnectedSiteTagRequest request)

public final void deleteConnectedSiteTag(DeleteConnectedSiteTagRequest request)

Deletes a connected site tag for a Universal Analytics property. Note: this has no effect on GA4 properties.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DeleteConnectedSiteTagRequest request =
       DeleteConnectedSiteTagRequest.newBuilder()
           .setProperty("property-993141291")
           .setTagId("tagId110119509")
           .build();
   analyticsAdminServiceClient.deleteConnectedSiteTag(request);
 }
 
Parameter
Name Description
request DeleteConnectedSiteTagRequest

The request object containing all of the parameters for the API call.

deleteConnectedSiteTagCallable()

public final UnaryCallable<DeleteConnectedSiteTagRequest,Empty> deleteConnectedSiteTagCallable()

Deletes a connected site tag for a Universal Analytics property. Note: this has no effect on GA4 properties.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DeleteConnectedSiteTagRequest request =
       DeleteConnectedSiteTagRequest.newBuilder()
           .setProperty("property-993141291")
           .setTagId("tagId110119509")
           .build();
   ApiFuture<Empty> future =
       analyticsAdminServiceClient.deleteConnectedSiteTagCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteConnectedSiteTagRequest,Empty>

deleteConversionEvent(ConversionEventName name) (deprecated)

public final void deleteConversionEvent(ConversionEventName name)

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ConversionEventName name = ConversionEventName.of("[PROPERTY]", "[CONVERSION_EVENT]");
   analyticsAdminServiceClient.deleteConversionEvent(name);
 }
 
Parameter
Name Description
name ConversionEventName

Required. The resource name of the conversion event to delete. Format: properties/{property}/conversionEvents/{conversion_event} Example: "properties/123/conversionEvents/456"

deleteConversionEvent(DeleteConversionEventRequest request) (deprecated)

public final void deleteConversionEvent(DeleteConversionEventRequest request)

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DeleteConversionEventRequest request =
       DeleteConversionEventRequest.newBuilder()
           .setName(ConversionEventName.of("[PROPERTY]", "[CONVERSION_EVENT]").toString())
           .build();
   analyticsAdminServiceClient.deleteConversionEvent(request);
 }
 
Parameter
Name Description
request DeleteConversionEventRequest

The request object containing all of the parameters for the API call.

deleteConversionEvent(String name) (deprecated)

public final void deleteConversionEvent(String name)

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name = ConversionEventName.of("[PROPERTY]", "[CONVERSION_EVENT]").toString();
   analyticsAdminServiceClient.deleteConversionEvent(name);
 }
 
Parameter
Name Description
name String

Required. The resource name of the conversion event to delete. Format: properties/{property}/conversionEvents/{conversion_event} Example: "properties/123/conversionEvents/456"

deleteConversionEventCallable() (deprecated)

public final UnaryCallable<DeleteConversionEventRequest,Empty> deleteConversionEventCallable()

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DeleteConversionEventRequest request =
       DeleteConversionEventRequest.newBuilder()
           .setName(ConversionEventName.of("[PROPERTY]", "[CONVERSION_EVENT]").toString())
           .build();
   ApiFuture<Empty> future =
       analyticsAdminServiceClient.deleteConversionEventCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteConversionEventRequest,Empty>

deleteDataStream(DataStreamName name)

public final void deleteDataStream(DataStreamName name)

Deletes a DataStream on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DataStreamName name = DataStreamName.of("[PROPERTY]", "[DATA_STREAM]");
   analyticsAdminServiceClient.deleteDataStream(name);
 }
 
Parameter
Name Description
name DataStreamName

Required. The name of the DataStream to delete. Example format: properties/1234/dataStreams/5678

deleteDataStream(DeleteDataStreamRequest request)

public final void deleteDataStream(DeleteDataStreamRequest request)

Deletes a DataStream on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DeleteDataStreamRequest request =
       DeleteDataStreamRequest.newBuilder()
           .setName(DataStreamName.of("[PROPERTY]", "[DATA_STREAM]").toString())
           .build();
   analyticsAdminServiceClient.deleteDataStream(request);
 }
 
Parameter
Name Description
request DeleteDataStreamRequest

The request object containing all of the parameters for the API call.

deleteDataStream(String name)

public final void deleteDataStream(String name)

Deletes a DataStream on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name = DataStreamName.of("[PROPERTY]", "[DATA_STREAM]").toString();
   analyticsAdminServiceClient.deleteDataStream(name);
 }
 
Parameter
Name Description
name String

Required. The name of the DataStream to delete. Example format: properties/1234/dataStreams/5678

deleteDataStreamCallable()

public final UnaryCallable<DeleteDataStreamRequest,Empty> deleteDataStreamCallable()

Deletes a DataStream on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DeleteDataStreamRequest request =
       DeleteDataStreamRequest.newBuilder()
           .setName(DataStreamName.of("[PROPERTY]", "[DATA_STREAM]").toString())
           .build();
   ApiFuture<Empty> future =
       analyticsAdminServiceClient.deleteDataStreamCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteDataStreamRequest,Empty>
public final void deleteDisplayVideo360AdvertiserLink(DeleteDisplayVideo360AdvertiserLinkRequest request)

Deletes a DisplayVideo360AdvertiserLink on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DeleteDisplayVideo360AdvertiserLinkRequest request =
       DeleteDisplayVideo360AdvertiserLinkRequest.newBuilder()
           .setName(
               DisplayVideo360AdvertiserLinkName.of(
                       "[PROPERTY]", "[DISPLAY_VIDEO_360_ADVERTISER_LINK]")
                   .toString())
           .build();
   analyticsAdminServiceClient.deleteDisplayVideo360AdvertiserLink(request);
 }
 
Parameter
Name Description
request DeleteDisplayVideo360AdvertiserLinkRequest

The request object containing all of the parameters for the API call.

public final void deleteDisplayVideo360AdvertiserLink(DisplayVideo360AdvertiserLinkName name)

Deletes a DisplayVideo360AdvertiserLink on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DisplayVideo360AdvertiserLinkName name =
       DisplayVideo360AdvertiserLinkName.of("[PROPERTY]", "[DISPLAY_VIDEO_360_ADVERTISER_LINK]");
   analyticsAdminServiceClient.deleteDisplayVideo360AdvertiserLink(name);
 }
 
Parameter
Name Description
name DisplayVideo360AdvertiserLinkName

Required. The name of the DisplayVideo360AdvertiserLink to delete. Example format: properties/1234/displayVideo360AdvertiserLinks/5678

public final void deleteDisplayVideo360AdvertiserLink(String name)

Deletes a DisplayVideo360AdvertiserLink on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name =
       DisplayVideo360AdvertiserLinkName.of("[PROPERTY]", "[DISPLAY_VIDEO_360_ADVERTISER_LINK]")
           .toString();
   analyticsAdminServiceClient.deleteDisplayVideo360AdvertiserLink(name);
 }
 
Parameter
Name Description
name String

Required. The name of the DisplayVideo360AdvertiserLink to delete. Example format: properties/1234/displayVideo360AdvertiserLinks/5678

deleteDisplayVideo360AdvertiserLinkCallable()

public final UnaryCallable<DeleteDisplayVideo360AdvertiserLinkRequest,Empty> deleteDisplayVideo360AdvertiserLinkCallable()

Deletes a DisplayVideo360AdvertiserLink on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DeleteDisplayVideo360AdvertiserLinkRequest request =
       DeleteDisplayVideo360AdvertiserLinkRequest.newBuilder()
           .setName(
               DisplayVideo360AdvertiserLinkName.of(
                       "[PROPERTY]", "[DISPLAY_VIDEO_360_ADVERTISER_LINK]")
                   .toString())
           .build();
   ApiFuture<Empty> future =
       analyticsAdminServiceClient
           .deleteDisplayVideo360AdvertiserLinkCallable()
           .futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteDisplayVideo360AdvertiserLinkRequest,Empty>

deleteDisplayVideo360AdvertiserLinkProposal(DeleteDisplayVideo360AdvertiserLinkProposalRequest request)

public final void deleteDisplayVideo360AdvertiserLinkProposal(DeleteDisplayVideo360AdvertiserLinkProposalRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DeleteDisplayVideo360AdvertiserLinkProposalRequest request =
       DeleteDisplayVideo360AdvertiserLinkProposalRequest.newBuilder()
           .setName(
               DisplayVideo360AdvertiserLinkProposalName.of(
                       "[PROPERTY]", "[DISPLAY_VIDEO_360_ADVERTISER_LINK_PROPOSAL]")
                   .toString())
           .build();
   analyticsAdminServiceClient.deleteDisplayVideo360AdvertiserLinkProposal(request);
 }
 
Parameter
Name Description
request DeleteDisplayVideo360AdvertiserLinkProposalRequest

The request object containing all of the parameters for the API call.

deleteDisplayVideo360AdvertiserLinkProposal(DisplayVideo360AdvertiserLinkProposalName name)

public final void deleteDisplayVideo360AdvertiserLinkProposal(DisplayVideo360AdvertiserLinkProposalName name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DisplayVideo360AdvertiserLinkProposalName name =
       DisplayVideo360AdvertiserLinkProposalName.of(
           "[PROPERTY]", "[DISPLAY_VIDEO_360_ADVERTISER_LINK_PROPOSAL]");
   analyticsAdminServiceClient.deleteDisplayVideo360AdvertiserLinkProposal(name);
 }
 
Parameter
Name Description
name DisplayVideo360AdvertiserLinkProposalName

Required. The name of the DisplayVideo360AdvertiserLinkProposal to delete. Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678

deleteDisplayVideo360AdvertiserLinkProposal(String name)

public final void deleteDisplayVideo360AdvertiserLinkProposal(String name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name =
       DisplayVideo360AdvertiserLinkProposalName.of(
               "[PROPERTY]", "[DISPLAY_VIDEO_360_ADVERTISER_LINK_PROPOSAL]")
           .toString();
   analyticsAdminServiceClient.deleteDisplayVideo360AdvertiserLinkProposal(name);
 }
 
Parameter
Name Description
name String

Required. The name of the DisplayVideo360AdvertiserLinkProposal to delete. Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678

deleteDisplayVideo360AdvertiserLinkProposalCallable()

public final UnaryCallable<DeleteDisplayVideo360AdvertiserLinkProposalRequest,Empty> deleteDisplayVideo360AdvertiserLinkProposalCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DeleteDisplayVideo360AdvertiserLinkProposalRequest request =
       DeleteDisplayVideo360AdvertiserLinkProposalRequest.newBuilder()
           .setName(
               DisplayVideo360AdvertiserLinkProposalName.of(
                       "[PROPERTY]", "[DISPLAY_VIDEO_360_ADVERTISER_LINK_PROPOSAL]")
                   .toString())
           .build();
   ApiFuture<Empty> future =
       analyticsAdminServiceClient
           .deleteDisplayVideo360AdvertiserLinkProposalCallable()
           .futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteDisplayVideo360AdvertiserLinkProposalRequest,Empty>

deleteEventCreateRule(DeleteEventCreateRuleRequest request)

public final void deleteEventCreateRule(DeleteEventCreateRuleRequest request)

Deletes an EventCreateRule.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DeleteEventCreateRuleRequest request =
       DeleteEventCreateRuleRequest.newBuilder()
           .setName(
               EventCreateRuleName.of("[PROPERTY]", "[DATA_STREAM]", "[EVENT_CREATE_RULE]")
                   .toString())
           .build();
   analyticsAdminServiceClient.deleteEventCreateRule(request);
 }
 
Parameter
Name Description
request DeleteEventCreateRuleRequest

The request object containing all of the parameters for the API call.

deleteEventCreateRule(EventCreateRuleName name)

public final void deleteEventCreateRule(EventCreateRuleName name)

Deletes an EventCreateRule.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   EventCreateRuleName name =
       EventCreateRuleName.of("[PROPERTY]", "[DATA_STREAM]", "[EVENT_CREATE_RULE]");
   analyticsAdminServiceClient.deleteEventCreateRule(name);
 }
 
Parameter
Name Description
name EventCreateRuleName

Required. Example format: properties/123/dataStreams/456/eventCreateRules/789

deleteEventCreateRule(String name)

public final void deleteEventCreateRule(String name)

Deletes an EventCreateRule.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name =
       EventCreateRuleName.of("[PROPERTY]", "[DATA_STREAM]", "[EVENT_CREATE_RULE]").toString();
   analyticsAdminServiceClient.deleteEventCreateRule(name);
 }
 
Parameter
Name Description
name String

Required. Example format: properties/123/dataStreams/456/eventCreateRules/789

deleteEventCreateRuleCallable()

public final UnaryCallable<DeleteEventCreateRuleRequest,Empty> deleteEventCreateRuleCallable()

Deletes an EventCreateRule.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DeleteEventCreateRuleRequest request =
       DeleteEventCreateRuleRequest.newBuilder()
           .setName(
               EventCreateRuleName.of("[PROPERTY]", "[DATA_STREAM]", "[EVENT_CREATE_RULE]")
                   .toString())
           .build();
   ApiFuture<Empty> future =
       analyticsAdminServiceClient.deleteEventCreateRuleCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteEventCreateRuleRequest,Empty>

deleteEventEditRule(DeleteEventEditRuleRequest request)

public final void deleteEventEditRule(DeleteEventEditRuleRequest request)

Deletes an EventEditRule.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DeleteEventEditRuleRequest request =
       DeleteEventEditRuleRequest.newBuilder()
           .setName(
               EventEditRuleName.of("[PROPERTY]", "[DATA_STREAM]", "[EVENT_EDIT_RULE]")
                   .toString())
           .build();
   analyticsAdminServiceClient.deleteEventEditRule(request);
 }
 
Parameter
Name Description
request DeleteEventEditRuleRequest

The request object containing all of the parameters for the API call.

deleteEventEditRule(EventEditRuleName name)

public final void deleteEventEditRule(EventEditRuleName name)

Deletes an EventEditRule.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   EventEditRuleName name =
       EventEditRuleName.of("[PROPERTY]", "[DATA_STREAM]", "[EVENT_EDIT_RULE]");
   analyticsAdminServiceClient.deleteEventEditRule(name);
 }
 
Parameter
Name Description
name EventEditRuleName

Required. Example format: properties/123/dataStreams/456/eventEditRules/789

deleteEventEditRule(String name)

public final void deleteEventEditRule(String name)

Deletes an EventEditRule.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name =
       EventEditRuleName.of("[PROPERTY]", "[DATA_STREAM]", "[EVENT_EDIT_RULE]").toString();
   analyticsAdminServiceClient.deleteEventEditRule(name);
 }
 
Parameter
Name Description
name String

Required. Example format: properties/123/dataStreams/456/eventEditRules/789

deleteEventEditRuleCallable()

public final UnaryCallable<DeleteEventEditRuleRequest,Empty> deleteEventEditRuleCallable()

Deletes an EventEditRule.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DeleteEventEditRuleRequest request =
       DeleteEventEditRuleRequest.newBuilder()
           .setName(
               EventEditRuleName.of("[PROPERTY]", "[DATA_STREAM]", "[EVENT_EDIT_RULE]")
                   .toString())
           .build();
   ApiFuture<Empty> future =
       analyticsAdminServiceClient.deleteEventEditRuleCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteEventEditRuleRequest,Empty>

deleteExpandedDataSet(DeleteExpandedDataSetRequest request)

public final void deleteExpandedDataSet(DeleteExpandedDataSetRequest request)

Deletes a ExpandedDataSet on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DeleteExpandedDataSetRequest request =
       DeleteExpandedDataSetRequest.newBuilder()
           .setName(ExpandedDataSetName.of("[PROPERTY]", "[EXPANDED_DATA_SET]").toString())
           .build();
   analyticsAdminServiceClient.deleteExpandedDataSet(request);
 }
 
Parameter
Name Description
request DeleteExpandedDataSetRequest

The request object containing all of the parameters for the API call.

deleteExpandedDataSet(ExpandedDataSetName name)

public final void deleteExpandedDataSet(ExpandedDataSetName name)

Deletes a ExpandedDataSet on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ExpandedDataSetName name = ExpandedDataSetName.of("[PROPERTY]", "[EXPANDED_DATA_SET]");
   analyticsAdminServiceClient.deleteExpandedDataSet(name);
 }
 
Parameter
Name Description
name ExpandedDataSetName

Required. Example format: properties/1234/expandedDataSets/5678

deleteExpandedDataSet(String name)

public final void deleteExpandedDataSet(String name)

Deletes a ExpandedDataSet on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name = ExpandedDataSetName.of("[PROPERTY]", "[EXPANDED_DATA_SET]").toString();
   analyticsAdminServiceClient.deleteExpandedDataSet(name);
 }
 
Parameter
Name Description
name String

Required. Example format: properties/1234/expandedDataSets/5678

deleteExpandedDataSetCallable()

public final UnaryCallable<DeleteExpandedDataSetRequest,Empty> deleteExpandedDataSetCallable()

Deletes a ExpandedDataSet on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DeleteExpandedDataSetRequest request =
       DeleteExpandedDataSetRequest.newBuilder()
           .setName(ExpandedDataSetName.of("[PROPERTY]", "[EXPANDED_DATA_SET]").toString())
           .build();
   ApiFuture<Empty> future =
       analyticsAdminServiceClient.deleteExpandedDataSetCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteExpandedDataSetRequest,Empty>
public final void deleteFirebaseLink(DeleteFirebaseLinkRequest request)

Deletes a FirebaseLink on a property

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DeleteFirebaseLinkRequest request =
       DeleteFirebaseLinkRequest.newBuilder()
           .setName(FirebaseLinkName.of("[PROPERTY]", "[FIREBASE_LINK]").toString())
           .build();
   analyticsAdminServiceClient.deleteFirebaseLink(request);
 }
 
Parameter
Name Description
request DeleteFirebaseLinkRequest

The request object containing all of the parameters for the API call.

public final void deleteFirebaseLink(FirebaseLinkName name)

Deletes a FirebaseLink on a property

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   FirebaseLinkName name = FirebaseLinkName.of("[PROPERTY]", "[FIREBASE_LINK]");
   analyticsAdminServiceClient.deleteFirebaseLink(name);
 }
 
Parameter
Name Description
name FirebaseLinkName

Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id}

Example: properties/1234/firebaseLinks/5678

public final void deleteFirebaseLink(String name)

Deletes a FirebaseLink on a property

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name = FirebaseLinkName.of("[PROPERTY]", "[FIREBASE_LINK]").toString();
   analyticsAdminServiceClient.deleteFirebaseLink(name);
 }
 
Parameter
Name Description
name String

Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id}

Example: properties/1234/firebaseLinks/5678

deleteFirebaseLinkCallable()

public final UnaryCallable<DeleteFirebaseLinkRequest,Empty> deleteFirebaseLinkCallable()

Deletes a FirebaseLink on a property

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DeleteFirebaseLinkRequest request =
       DeleteFirebaseLinkRequest.newBuilder()
           .setName(FirebaseLinkName.of("[PROPERTY]", "[FIREBASE_LINK]").toString())
           .build();
   ApiFuture<Empty> future =
       analyticsAdminServiceClient.deleteFirebaseLinkCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteFirebaseLinkRequest,Empty>
public final void deleteGoogleAdsLink(DeleteGoogleAdsLinkRequest request)

Deletes a GoogleAdsLink on a property

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DeleteGoogleAdsLinkRequest request =
       DeleteGoogleAdsLinkRequest.newBuilder()
           .setName(GoogleAdsLinkName.of("[PROPERTY]", "[GOOGLE_ADS_LINK]").toString())
           .build();
   analyticsAdminServiceClient.deleteGoogleAdsLink(request);
 }
 
Parameter
Name Description
request DeleteGoogleAdsLinkRequest

The request object containing all of the parameters for the API call.

public final void deleteGoogleAdsLink(GoogleAdsLinkName name)

Deletes a GoogleAdsLink on a property

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GoogleAdsLinkName name = GoogleAdsLinkName.of("[PROPERTY]", "[GOOGLE_ADS_LINK]");
   analyticsAdminServiceClient.deleteGoogleAdsLink(name);
 }
 
Parameter
Name Description
name GoogleAdsLinkName

Required. Example format: properties/1234/googleAdsLinks/5678

public final void deleteGoogleAdsLink(String name)

Deletes a GoogleAdsLink on a property

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name = GoogleAdsLinkName.of("[PROPERTY]", "[GOOGLE_ADS_LINK]").toString();
   analyticsAdminServiceClient.deleteGoogleAdsLink(name);
 }
 
Parameter
Name Description
name String

Required. Example format: properties/1234/googleAdsLinks/5678

deleteGoogleAdsLinkCallable()

public final UnaryCallable<DeleteGoogleAdsLinkRequest,Empty> deleteGoogleAdsLinkCallable()

Deletes a GoogleAdsLink on a property

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DeleteGoogleAdsLinkRequest request =
       DeleteGoogleAdsLinkRequest.newBuilder()
           .setName(GoogleAdsLinkName.of("[PROPERTY]", "[GOOGLE_ADS_LINK]").toString())
           .build();
   ApiFuture<Empty> future =
       analyticsAdminServiceClient.deleteGoogleAdsLinkCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteGoogleAdsLinkRequest,Empty>

deleteKeyEvent(DeleteKeyEventRequest request)

public final void deleteKeyEvent(DeleteKeyEventRequest request)

Deletes a Key Event.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DeleteKeyEventRequest request =
       DeleteKeyEventRequest.newBuilder()
           .setName(KeyEventName.of("[PROPERTY]", "[KEY_EVENT]").toString())
           .build();
   analyticsAdminServiceClient.deleteKeyEvent(request);
 }
 
Parameter
Name Description
request DeleteKeyEventRequest

The request object containing all of the parameters for the API call.

deleteKeyEvent(KeyEventName name)

public final void deleteKeyEvent(KeyEventName name)

Deletes a Key Event.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   KeyEventName name = KeyEventName.of("[PROPERTY]", "[KEY_EVENT]");
   analyticsAdminServiceClient.deleteKeyEvent(name);
 }
 
Parameter
Name Description
name KeyEventName

Required. The resource name of the Key Event to delete. Format: properties/{property}/keyEvents/{key_event} Example: "properties/123/keyEvents/456"

deleteKeyEvent(String name)

public final void deleteKeyEvent(String name)

Deletes a Key Event.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name = KeyEventName.of("[PROPERTY]", "[KEY_EVENT]").toString();
   analyticsAdminServiceClient.deleteKeyEvent(name);
 }
 
Parameter
Name Description
name String

Required. The resource name of the Key Event to delete. Format: properties/{property}/keyEvents/{key_event} Example: "properties/123/keyEvents/456"

deleteKeyEventCallable()

public final UnaryCallable<DeleteKeyEventRequest,Empty> deleteKeyEventCallable()

Deletes a Key Event.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DeleteKeyEventRequest request =
       DeleteKeyEventRequest.newBuilder()
           .setName(KeyEventName.of("[PROPERTY]", "[KEY_EVENT]").toString())
           .build();
   ApiFuture<Empty> future =
       analyticsAdminServiceClient.deleteKeyEventCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteKeyEventRequest,Empty>

deleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest request)

public final void deleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest request)

Deletes target MeasurementProtocolSecret.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DeleteMeasurementProtocolSecretRequest request =
       DeleteMeasurementProtocolSecretRequest.newBuilder()
           .setName(
               MeasurementProtocolSecretName.of(
                       "[PROPERTY]", "[DATA_STREAM]", "[MEASUREMENT_PROTOCOL_SECRET]")
                   .toString())
           .build();
   analyticsAdminServiceClient.deleteMeasurementProtocolSecret(request);
 }
 
Parameter
Name Description
request DeleteMeasurementProtocolSecretRequest

The request object containing all of the parameters for the API call.

deleteMeasurementProtocolSecret(MeasurementProtocolSecretName name)

public final void deleteMeasurementProtocolSecret(MeasurementProtocolSecretName name)

Deletes target MeasurementProtocolSecret.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   MeasurementProtocolSecretName name =
       MeasurementProtocolSecretName.of(
           "[PROPERTY]", "[DATA_STREAM]", "[MEASUREMENT_PROTOCOL_SECRET]");
   analyticsAdminServiceClient.deleteMeasurementProtocolSecret(name);
 }
 
Parameter
Name Description
name MeasurementProtocolSecretName

Required. The name of the MeasurementProtocolSecret to delete. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

deleteMeasurementProtocolSecret(String name)

public final void deleteMeasurementProtocolSecret(String name)

Deletes target MeasurementProtocolSecret.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name =
       MeasurementProtocolSecretName.of(
               "[PROPERTY]", "[DATA_STREAM]", "[MEASUREMENT_PROTOCOL_SECRET]")
           .toString();
   analyticsAdminServiceClient.deleteMeasurementProtocolSecret(name);
 }
 
Parameter
Name Description
name String

Required. The name of the MeasurementProtocolSecret to delete. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

deleteMeasurementProtocolSecretCallable()

public final UnaryCallable<DeleteMeasurementProtocolSecretRequest,Empty> deleteMeasurementProtocolSecretCallable()

Deletes target MeasurementProtocolSecret.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DeleteMeasurementProtocolSecretRequest request =
       DeleteMeasurementProtocolSecretRequest.newBuilder()
           .setName(
               MeasurementProtocolSecretName.of(
                       "[PROPERTY]", "[DATA_STREAM]", "[MEASUREMENT_PROTOCOL_SECRET]")
                   .toString())
           .build();
   ApiFuture<Empty> future =
       analyticsAdminServiceClient.deleteMeasurementProtocolSecretCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteMeasurementProtocolSecretRequest,Empty>

deleteProperty(DeletePropertyRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DeletePropertyRequest request =
       DeletePropertyRequest.newBuilder()
           .setName(PropertyName.of("[PROPERTY]").toString())
           .build();
   Property response = analyticsAdminServiceClient.deleteProperty(request);
 }
 
Parameter
Name Description
request DeletePropertyRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
Property

deleteProperty(PropertyName name)

public final Property deleteProperty(PropertyName name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   PropertyName name = PropertyName.of("[PROPERTY]");
   Property response = analyticsAdminServiceClient.deleteProperty(name);
 }
 
Parameter
Name Description
name PropertyName

Required. The name of the Property to soft-delete. Format: properties/{property_id} Example: "properties/1000"

Returns
Type Description
Property

deleteProperty(String name)

public final Property deleteProperty(String name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name = PropertyName.of("[PROPERTY]").toString();
   Property response = analyticsAdminServiceClient.deleteProperty(name);
 }
 
Parameter
Name Description
name String

Required. The name of the Property to soft-delete. Format: properties/{property_id} Example: "properties/1000"

Returns
Type Description
Property

deletePropertyCallable()

public final UnaryCallable<DeletePropertyRequest,Property> deletePropertyCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DeletePropertyRequest request =
       DeletePropertyRequest.newBuilder()
           .setName(PropertyName.of("[PROPERTY]").toString())
           .build();
   ApiFuture<Property> future =
       analyticsAdminServiceClient.deletePropertyCallable().futureCall(request);
   // Do something.
   Property response = future.get();
 }
 
Returns
Type Description
UnaryCallable<DeletePropertyRequest,Property>
public final void 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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DeleteRollupPropertySourceLinkRequest request =
       DeleteRollupPropertySourceLinkRequest.newBuilder()
           .setName(
               RollupPropertySourceLinkName.of("[PROPERTY]", "[ROLLUP_PROPERTY_SOURCE_LINK]")
                   .toString())
           .build();
   analyticsAdminServiceClient.deleteRollupPropertySourceLink(request);
 }
 
Parameter
Name Description
request DeleteRollupPropertySourceLinkRequest

The request object containing all of the parameters for the API call.

public final void deleteRollupPropertySourceLink(RollupPropertySourceLinkName name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   RollupPropertySourceLinkName name =
       RollupPropertySourceLinkName.of("[PROPERTY]", "[ROLLUP_PROPERTY_SOURCE_LINK]");
   analyticsAdminServiceClient.deleteRollupPropertySourceLink(name);
 }
 
Parameter
Name Description
name RollupPropertySourceLinkName

Required. Format: properties/{property_id}/rollupPropertySourceLinks/{rollup_property_source_link_id} Example: properties/1234/rollupPropertySourceLinks/5678

public final void deleteRollupPropertySourceLink(String name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name =
       RollupPropertySourceLinkName.of("[PROPERTY]", "[ROLLUP_PROPERTY_SOURCE_LINK]").toString();
   analyticsAdminServiceClient.deleteRollupPropertySourceLink(name);
 }
 
Parameter
Name Description
name String

Required. Format: properties/{property_id}/rollupPropertySourceLinks/{rollup_property_source_link_id} Example: properties/1234/rollupPropertySourceLinks/5678

deleteRollupPropertySourceLinkCallable()

public final UnaryCallable<DeleteRollupPropertySourceLinkRequest,Empty> deleteRollupPropertySourceLinkCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DeleteRollupPropertySourceLinkRequest request =
       DeleteRollupPropertySourceLinkRequest.newBuilder()
           .setName(
               RollupPropertySourceLinkName.of("[PROPERTY]", "[ROLLUP_PROPERTY_SOURCE_LINK]")
                   .toString())
           .build();
   ApiFuture<Empty> future =
       analyticsAdminServiceClient.deleteRollupPropertySourceLinkCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteRollupPropertySourceLinkRequest,Empty>

deleteSKAdNetworkConversionValueSchema(DeleteSKAdNetworkConversionValueSchemaRequest request)

public final void deleteSKAdNetworkConversionValueSchema(DeleteSKAdNetworkConversionValueSchemaRequest request)

Deletes target SKAdNetworkConversionValueSchema.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DeleteSKAdNetworkConversionValueSchemaRequest request =
       DeleteSKAdNetworkConversionValueSchemaRequest.newBuilder()
           .setName(
               SKAdNetworkConversionValueSchemaName.of(
                       "[PROPERTY]", "[DATA_STREAM]", "[SKADNETWORK_CONVERSION_VALUE_SCHEMA]")
                   .toString())
           .build();
   analyticsAdminServiceClient.deleteSKAdNetworkConversionValueSchema(request);
 }
 
Parameter
Name Description
request DeleteSKAdNetworkConversionValueSchemaRequest

The request object containing all of the parameters for the API call.

deleteSKAdNetworkConversionValueSchema(SKAdNetworkConversionValueSchemaName name)

public final void deleteSKAdNetworkConversionValueSchema(SKAdNetworkConversionValueSchemaName name)

Deletes target SKAdNetworkConversionValueSchema.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   SKAdNetworkConversionValueSchemaName name =
       SKAdNetworkConversionValueSchemaName.of(
           "[PROPERTY]", "[DATA_STREAM]", "[SKADNETWORK_CONVERSION_VALUE_SCHEMA]");
   analyticsAdminServiceClient.deleteSKAdNetworkConversionValueSchema(name);
 }
 
Parameter
Name Description
name SKAdNetworkConversionValueSchemaName

Required. The name of the SKAdNetworkConversionValueSchema to delete. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema/{skadnetwork_conversion_value_schema}

deleteSKAdNetworkConversionValueSchema(String name)

public final void deleteSKAdNetworkConversionValueSchema(String name)

Deletes target SKAdNetworkConversionValueSchema.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name =
       SKAdNetworkConversionValueSchemaName.of(
               "[PROPERTY]", "[DATA_STREAM]", "[SKADNETWORK_CONVERSION_VALUE_SCHEMA]")
           .toString();
   analyticsAdminServiceClient.deleteSKAdNetworkConversionValueSchema(name);
 }
 
Parameter
Name Description
name String

Required. The name of the SKAdNetworkConversionValueSchema to delete. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema/{skadnetwork_conversion_value_schema}

deleteSKAdNetworkConversionValueSchemaCallable()

public final UnaryCallable<DeleteSKAdNetworkConversionValueSchemaRequest,Empty> deleteSKAdNetworkConversionValueSchemaCallable()

Deletes target SKAdNetworkConversionValueSchema.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DeleteSKAdNetworkConversionValueSchemaRequest request =
       DeleteSKAdNetworkConversionValueSchemaRequest.newBuilder()
           .setName(
               SKAdNetworkConversionValueSchemaName.of(
                       "[PROPERTY]", "[DATA_STREAM]", "[SKADNETWORK_CONVERSION_VALUE_SCHEMA]")
                   .toString())
           .build();
   ApiFuture<Empty> future =
       analyticsAdminServiceClient
           .deleteSKAdNetworkConversionValueSchemaCallable()
           .futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteSKAdNetworkConversionValueSchemaRequest,Empty>
public final void deleteSearchAds360Link(DeleteSearchAds360LinkRequest request)

Deletes a SearchAds360Link on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DeleteSearchAds360LinkRequest request =
       DeleteSearchAds360LinkRequest.newBuilder()
           .setName(SearchAds360LinkName.of("[PROPERTY]", "[SEARCH_ADS_360_LINK]").toString())
           .build();
   analyticsAdminServiceClient.deleteSearchAds360Link(request);
 }
 
Parameter
Name Description
request DeleteSearchAds360LinkRequest

The request object containing all of the parameters for the API call.

public final void deleteSearchAds360Link(SearchAds360LinkName name)

Deletes a SearchAds360Link on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   SearchAds360LinkName name = SearchAds360LinkName.of("[PROPERTY]", "[SEARCH_ADS_360_LINK]");
   analyticsAdminServiceClient.deleteSearchAds360Link(name);
 }
 
Parameter
Name Description
name SearchAds360LinkName

Required. The name of the SearchAds360Link to delete. Example format: properties/1234/SearchAds360Links/5678

public final void deleteSearchAds360Link(String name)

Deletes a SearchAds360Link on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name = SearchAds360LinkName.of("[PROPERTY]", "[SEARCH_ADS_360_LINK]").toString();
   analyticsAdminServiceClient.deleteSearchAds360Link(name);
 }
 
Parameter
Name Description
name String

Required. The name of the SearchAds360Link to delete. Example format: properties/1234/SearchAds360Links/5678

deleteSearchAds360LinkCallable()

public final UnaryCallable<DeleteSearchAds360LinkRequest,Empty> deleteSearchAds360LinkCallable()

Deletes a SearchAds360Link on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DeleteSearchAds360LinkRequest request =
       DeleteSearchAds360LinkRequest.newBuilder()
           .setName(SearchAds360LinkName.of("[PROPERTY]", "[SEARCH_ADS_360_LINK]").toString())
           .build();
   ApiFuture<Empty> future =
       analyticsAdminServiceClient.deleteSearchAds360LinkCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteSearchAds360LinkRequest,Empty>

deleteSubpropertyEventFilter(DeleteSubpropertyEventFilterRequest request)

public final void deleteSubpropertyEventFilter(DeleteSubpropertyEventFilterRequest request)

Deletes a subproperty event filter.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DeleteSubpropertyEventFilterRequest request =
       DeleteSubpropertyEventFilterRequest.newBuilder()
           .setName(
               SubpropertyEventFilterName.of("[PROPERTY]", "[SUB_PROPERTY_EVENT_FILTER]")
                   .toString())
           .build();
   analyticsAdminServiceClient.deleteSubpropertyEventFilter(request);
 }
 
Parameter
Name Description
request DeleteSubpropertyEventFilterRequest

The request object containing all of the parameters for the API call.

deleteSubpropertyEventFilter(SubpropertyEventFilterName name)

public final void deleteSubpropertyEventFilter(SubpropertyEventFilterName name)

Deletes a subproperty event filter.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   SubpropertyEventFilterName name =
       SubpropertyEventFilterName.of("[PROPERTY]", "[SUB_PROPERTY_EVENT_FILTER]");
   analyticsAdminServiceClient.deleteSubpropertyEventFilter(name);
 }
 
Parameter
Name Description
name SubpropertyEventFilterName

Required. Resource name of the subproperty event filter to delete. Format: properties/property_id/subpropertyEventFilters/subproperty_event_filter Example: properties/123/subpropertyEventFilters/456

deleteSubpropertyEventFilter(String name)

public final void deleteSubpropertyEventFilter(String name)

Deletes a subproperty event filter.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name =
       SubpropertyEventFilterName.of("[PROPERTY]", "[SUB_PROPERTY_EVENT_FILTER]").toString();
   analyticsAdminServiceClient.deleteSubpropertyEventFilter(name);
 }
 
Parameter
Name Description
name String

Required. Resource name of the subproperty event filter to delete. Format: properties/property_id/subpropertyEventFilters/subproperty_event_filter Example: properties/123/subpropertyEventFilters/456

deleteSubpropertyEventFilterCallable()

public final UnaryCallable<DeleteSubpropertyEventFilterRequest,Empty> deleteSubpropertyEventFilterCallable()

Deletes a subproperty event filter.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DeleteSubpropertyEventFilterRequest request =
       DeleteSubpropertyEventFilterRequest.newBuilder()
           .setName(
               SubpropertyEventFilterName.of("[PROPERTY]", "[SUB_PROPERTY_EVENT_FILTER]")
                   .toString())
           .build();
   ApiFuture<Empty> future =
       analyticsAdminServiceClient.deleteSubpropertyEventFilterCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteSubpropertyEventFilterRequest,Empty>

fetchAutomatedGa4ConfigurationOptOut(FetchAutomatedGa4ConfigurationOptOutRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   FetchAutomatedGa4ConfigurationOptOutRequest request =
       FetchAutomatedGa4ConfigurationOptOutRequest.newBuilder()
           .setProperty("property-993141291")
           .build();
   FetchAutomatedGa4ConfigurationOptOutResponse response =
       analyticsAdminServiceClient.fetchAutomatedGa4ConfigurationOptOut(request);
 }
 
Parameter
Name Description
request FetchAutomatedGa4ConfigurationOptOutRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
FetchAutomatedGa4ConfigurationOptOutResponse

fetchAutomatedGa4ConfigurationOptOutCallable()

public final UnaryCallable<FetchAutomatedGa4ConfigurationOptOutRequest,FetchAutomatedGa4ConfigurationOptOutResponse> fetchAutomatedGa4ConfigurationOptOutCallable()

Fetches the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   FetchAutomatedGa4ConfigurationOptOutRequest request =
       FetchAutomatedGa4ConfigurationOptOutRequest.newBuilder()
           .setProperty("property-993141291")
           .build();
   ApiFuture<FetchAutomatedGa4ConfigurationOptOutResponse> future =
       analyticsAdminServiceClient
           .fetchAutomatedGa4ConfigurationOptOutCallable()
           .futureCall(request);
   // Do something.
   FetchAutomatedGa4ConfigurationOptOutResponse response = future.get();
 }
 
Returns
Type Description
UnaryCallable<FetchAutomatedGa4ConfigurationOptOutRequest,FetchAutomatedGa4ConfigurationOptOutResponse>

fetchConnectedGa4Property(FetchConnectedGa4PropertyRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   FetchConnectedGa4PropertyRequest request =
       FetchConnectedGa4PropertyRequest.newBuilder()
           .setProperty(PropertyName.of("[PROPERTY]").toString())
           .build();
   FetchConnectedGa4PropertyResponse response =
       analyticsAdminServiceClient.fetchConnectedGa4Property(request);
 }
 
Parameter
Name Description
request FetchConnectedGa4PropertyRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
FetchConnectedGa4PropertyResponse

fetchConnectedGa4PropertyCallable()

public final UnaryCallable<FetchConnectedGa4PropertyRequest,FetchConnectedGa4PropertyResponse> fetchConnectedGa4PropertyCallable()

Given a specified UA property, looks up the GA4 property connected to it. Note: this cannot be used with GA4 properties.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   FetchConnectedGa4PropertyRequest request =
       FetchConnectedGa4PropertyRequest.newBuilder()
           .setProperty(PropertyName.of("[PROPERTY]").toString())
           .build();
   ApiFuture<FetchConnectedGa4PropertyResponse> future =
       analyticsAdminServiceClient.fetchConnectedGa4PropertyCallable().futureCall(request);
   // Do something.
   FetchConnectedGa4PropertyResponse response = future.get();
 }
 
Returns
Type Description
UnaryCallable<FetchConnectedGa4PropertyRequest,FetchConnectedGa4PropertyResponse>

getAccessBinding(AccessBindingName name)

public final AccessBinding getAccessBinding(AccessBindingName name)

Gets information about an access binding.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   AccessBindingName name =
       AccessBindingName.ofAccountAccessBindingName("[ACCOUNT]", "[ACCESS_BINDING]");
   AccessBinding response = analyticsAdminServiceClient.getAccessBinding(name);
 }
 
Parameter
Name Description
name AccessBindingName

Required. The name of the access binding to retrieve. Formats: - accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding}

Returns
Type Description
AccessBinding

getAccessBinding(GetAccessBindingRequest request)

public final AccessBinding getAccessBinding(GetAccessBindingRequest request)

Gets information about an access binding.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetAccessBindingRequest request =
       GetAccessBindingRequest.newBuilder()
           .setName(
               AccessBindingName.ofAccountAccessBindingName("[ACCOUNT]", "[ACCESS_BINDING]")
                   .toString())
           .build();
   AccessBinding response = analyticsAdminServiceClient.getAccessBinding(request);
 }
 
Parameter
Name Description
request GetAccessBindingRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
AccessBinding

getAccessBinding(String name)

public final AccessBinding getAccessBinding(String name)

Gets information about an access binding.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name =
       AccessBindingName.ofAccountAccessBindingName("[ACCOUNT]", "[ACCESS_BINDING]").toString();
   AccessBinding response = analyticsAdminServiceClient.getAccessBinding(name);
 }
 
Parameter
Name Description
name String

Required. The name of the access binding to retrieve. Formats: - accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding}

Returns
Type Description
AccessBinding

getAccessBindingCallable()

public final UnaryCallable<GetAccessBindingRequest,AccessBinding> getAccessBindingCallable()

Gets information about an access binding.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetAccessBindingRequest request =
       GetAccessBindingRequest.newBuilder()
           .setName(
               AccessBindingName.ofAccountAccessBindingName("[ACCOUNT]", "[ACCESS_BINDING]")
                   .toString())
           .build();
   ApiFuture<AccessBinding> future =
       analyticsAdminServiceClient.getAccessBindingCallable().futureCall(request);
   // Do something.
   AccessBinding response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetAccessBindingRequest,AccessBinding>

getAccount(AccountName name)

public final Account getAccount(AccountName name)

Lookup for a single Account.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   AccountName name = AccountName.of("[ACCOUNT]");
   Account response = analyticsAdminServiceClient.getAccount(name);
 }
 
Parameter
Name Description
name AccountName

Required. The name of the account to lookup. Format: accounts/{account} Example: "accounts/100"

Returns
Type Description
Account

getAccount(GetAccountRequest request)

public final Account getAccount(GetAccountRequest request)

Lookup for a single Account.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetAccountRequest request =
       GetAccountRequest.newBuilder().setName(AccountName.of("[ACCOUNT]").toString()).build();
   Account response = analyticsAdminServiceClient.getAccount(request);
 }
 
Parameter
Name Description
request GetAccountRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
Account

getAccount(String name)

public final Account getAccount(String name)

Lookup for a single Account.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name = AccountName.of("[ACCOUNT]").toString();
   Account response = analyticsAdminServiceClient.getAccount(name);
 }
 
Parameter
Name Description
name String

Required. The name of the account to lookup. Format: accounts/{account} Example: "accounts/100"

Returns
Type Description
Account

getAccountCallable()

public final UnaryCallable<GetAccountRequest,Account> getAccountCallable()

Lookup for a single Account.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetAccountRequest request =
       GetAccountRequest.newBuilder().setName(AccountName.of("[ACCOUNT]").toString()).build();
   ApiFuture<Account> future =
       analyticsAdminServiceClient.getAccountCallable().futureCall(request);
   // Do something.
   Account response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetAccountRequest,Account>
public final AdSenseLink getAdSenseLink(AdSenseLinkName name)

Looks up a single AdSenseLink.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   AdSenseLinkName name = AdSenseLinkName.of("[PROPERTY]", "[ADSENSE_LINK]");
   AdSenseLink response = analyticsAdminServiceClient.getAdSenseLink(name);
 }
 
Parameter
Name Description
name AdSenseLinkName

Required. Unique identifier for the AdSense Link requested. Format: properties/{propertyId}/adSenseLinks/{linkId} Example: properties/1234/adSenseLinks/5678

Returns
Type Description
AdSenseLink
public final AdSenseLink getAdSenseLink(GetAdSenseLinkRequest request)

Looks up a single AdSenseLink.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetAdSenseLinkRequest request =
       GetAdSenseLinkRequest.newBuilder()
           .setName(AdSenseLinkName.of("[PROPERTY]", "[ADSENSE_LINK]").toString())
           .build();
   AdSenseLink response = analyticsAdminServiceClient.getAdSenseLink(request);
 }
 
Parameter
Name Description
request GetAdSenseLinkRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
AdSenseLink
public final AdSenseLink getAdSenseLink(String name)

Looks up a single AdSenseLink.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name = AdSenseLinkName.of("[PROPERTY]", "[ADSENSE_LINK]").toString();
   AdSenseLink response = analyticsAdminServiceClient.getAdSenseLink(name);
 }
 
Parameter
Name Description
name String

Required. Unique identifier for the AdSense Link requested. Format: properties/{propertyId}/adSenseLinks/{linkId} Example: properties/1234/adSenseLinks/5678

Returns
Type Description
AdSenseLink

getAdSenseLinkCallable()

public final UnaryCallable<GetAdSenseLinkRequest,AdSenseLink> getAdSenseLinkCallable()

Looks up a single AdSenseLink.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetAdSenseLinkRequest request =
       GetAdSenseLinkRequest.newBuilder()
           .setName(AdSenseLinkName.of("[PROPERTY]", "[ADSENSE_LINK]").toString())
           .build();
   ApiFuture<AdSenseLink> future =
       analyticsAdminServiceClient.getAdSenseLinkCallable().futureCall(request);
   // Do something.
   AdSenseLink response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetAdSenseLinkRequest,AdSenseLink>

getAttributionSettings(AttributionSettingsName name)

public final AttributionSettings getAttributionSettings(AttributionSettingsName name)

Lookup for a AttributionSettings singleton.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   AttributionSettingsName name = AttributionSettingsName.of("[PROPERTY]");
   AttributionSettings response = analyticsAdminServiceClient.getAttributionSettings(name);
 }
 
Parameter
Name Description
name AttributionSettingsName

Required. The name of the attribution settings to retrieve. Format: properties/{property}/attributionSettings

Returns
Type Description
AttributionSettings

getAttributionSettings(GetAttributionSettingsRequest request)

public final AttributionSettings getAttributionSettings(GetAttributionSettingsRequest request)

Lookup for a AttributionSettings singleton.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetAttributionSettingsRequest request =
       GetAttributionSettingsRequest.newBuilder()
           .setName(AttributionSettingsName.of("[PROPERTY]").toString())
           .build();
   AttributionSettings response = analyticsAdminServiceClient.getAttributionSettings(request);
 }
 
Parameter
Name Description
request GetAttributionSettingsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
AttributionSettings

getAttributionSettings(String name)

public final AttributionSettings getAttributionSettings(String name)

Lookup for a AttributionSettings singleton.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name = AttributionSettingsName.of("[PROPERTY]").toString();
   AttributionSettings response = analyticsAdminServiceClient.getAttributionSettings(name);
 }
 
Parameter
Name Description
name String

Required. The name of the attribution settings to retrieve. Format: properties/{property}/attributionSettings

Returns
Type Description
AttributionSettings

getAttributionSettingsCallable()

public final UnaryCallable<GetAttributionSettingsRequest,AttributionSettings> getAttributionSettingsCallable()

Lookup for a AttributionSettings singleton.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetAttributionSettingsRequest request =
       GetAttributionSettingsRequest.newBuilder()
           .setName(AttributionSettingsName.of("[PROPERTY]").toString())
           .build();
   ApiFuture<AttributionSettings> future =
       analyticsAdminServiceClient.getAttributionSettingsCallable().futureCall(request);
   // Do something.
   AttributionSettings response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetAttributionSettingsRequest,AttributionSettings>

getAudience(AudienceName name)

public final Audience getAudience(AudienceName name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   AudienceName name = AudienceName.of("[PROPERTY]", "[AUDIENCE]");
   Audience response = analyticsAdminServiceClient.getAudience(name);
 }
 
Parameter
Name Description
name AudienceName

Required. The name of the Audience to get. Example format: properties/1234/audiences/5678

Returns
Type Description
Audience

getAudience(GetAudienceRequest request)

public final Audience getAudience(GetAudienceRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetAudienceRequest request =
       GetAudienceRequest.newBuilder()
           .setName(AudienceName.of("[PROPERTY]", "[AUDIENCE]").toString())
           .build();
   Audience response = analyticsAdminServiceClient.getAudience(request);
 }
 
Parameter
Name Description
request GetAudienceRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
Audience

getAudience(String name)

public final Audience getAudience(String name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name = AudienceName.of("[PROPERTY]", "[AUDIENCE]").toString();
   Audience response = analyticsAdminServiceClient.getAudience(name);
 }
 
Parameter
Name Description
name String

Required. The name of the Audience to get. Example format: properties/1234/audiences/5678

Returns
Type Description
Audience

getAudienceCallable()

public final UnaryCallable<GetAudienceRequest,Audience> getAudienceCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetAudienceRequest request =
       GetAudienceRequest.newBuilder()
           .setName(AudienceName.of("[PROPERTY]", "[AUDIENCE]").toString())
           .build();
   ApiFuture<Audience> future =
       analyticsAdminServiceClient.getAudienceCallable().futureCall(request);
   // Do something.
   Audience response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetAudienceRequest,Audience>
public final BigQueryLink getBigQueryLink(BigQueryLinkName name)

Lookup for a single BigQuery Link.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   BigQueryLinkName name = BigQueryLinkName.of("[PROPERTY]", "[BIGQUERY_LINK]");
   BigQueryLink response = analyticsAdminServiceClient.getBigQueryLink(name);
 }
 
Parameter
Name Description
name BigQueryLinkName

Required. The name of the BigQuery link to lookup. Format: properties/{property_id}/bigQueryLinks/{bigquery_link_id} Example: properties/123/bigQueryLinks/456

Returns
Type Description
BigQueryLink
public final BigQueryLink getBigQueryLink(GetBigQueryLinkRequest request)

Lookup for a single BigQuery Link.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetBigQueryLinkRequest request =
       GetBigQueryLinkRequest.newBuilder()
           .setName(BigQueryLinkName.of("[PROPERTY]", "[BIGQUERY_LINK]").toString())
           .build();
   BigQueryLink response = analyticsAdminServiceClient.getBigQueryLink(request);
 }
 
Parameter
Name Description
request GetBigQueryLinkRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
BigQueryLink
public final BigQueryLink getBigQueryLink(String name)

Lookup for a single BigQuery Link.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name = BigQueryLinkName.of("[PROPERTY]", "[BIGQUERY_LINK]").toString();
   BigQueryLink response = analyticsAdminServiceClient.getBigQueryLink(name);
 }
 
Parameter
Name Description
name String

Required. The name of the BigQuery link to lookup. Format: properties/{property_id}/bigQueryLinks/{bigquery_link_id} Example: properties/123/bigQueryLinks/456

Returns
Type Description
BigQueryLink

getBigQueryLinkCallable()

public final UnaryCallable<GetBigQueryLinkRequest,BigQueryLink> getBigQueryLinkCallable()

Lookup for a single BigQuery Link.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetBigQueryLinkRequest request =
       GetBigQueryLinkRequest.newBuilder()
           .setName(BigQueryLinkName.of("[PROPERTY]", "[BIGQUERY_LINK]").toString())
           .build();
   ApiFuture<BigQueryLink> future =
       analyticsAdminServiceClient.getBigQueryLinkCallable().futureCall(request);
   // Do something.
   BigQueryLink response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetBigQueryLinkRequest,BigQueryLink>

getCalculatedMetric(CalculatedMetricName name)

public final CalculatedMetric getCalculatedMetric(CalculatedMetricName name)

Lookup for a single CalculatedMetric.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CalculatedMetricName name = CalculatedMetricName.of("[PROPERTY]", "[CALCULATED_METRIC]");
   CalculatedMetric response = analyticsAdminServiceClient.getCalculatedMetric(name);
 }
 
Parameter
Name Description
name CalculatedMetricName

Required. The name of the CalculatedMetric to get. Format: properties/{property_id}/calculatedMetrics/{calculated_metric_id} Example: properties/1234/calculatedMetrics/Metric01

Returns
Type Description
CalculatedMetric

getCalculatedMetric(GetCalculatedMetricRequest request)

public final CalculatedMetric getCalculatedMetric(GetCalculatedMetricRequest request)

Lookup for a single CalculatedMetric.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetCalculatedMetricRequest request =
       GetCalculatedMetricRequest.newBuilder()
           .setName(CalculatedMetricName.of("[PROPERTY]", "[CALCULATED_METRIC]").toString())
           .build();
   CalculatedMetric response = analyticsAdminServiceClient.getCalculatedMetric(request);
 }
 
Parameter
Name Description
request GetCalculatedMetricRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
CalculatedMetric

getCalculatedMetric(String name)

public final CalculatedMetric getCalculatedMetric(String name)

Lookup for a single CalculatedMetric.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name = CalculatedMetricName.of("[PROPERTY]", "[CALCULATED_METRIC]").toString();
   CalculatedMetric response = analyticsAdminServiceClient.getCalculatedMetric(name);
 }
 
Parameter
Name Description
name String

Required. The name of the CalculatedMetric to get. Format: properties/{property_id}/calculatedMetrics/{calculated_metric_id} Example: properties/1234/calculatedMetrics/Metric01

Returns
Type Description
CalculatedMetric

getCalculatedMetricCallable()

public final UnaryCallable<GetCalculatedMetricRequest,CalculatedMetric> getCalculatedMetricCallable()

Lookup for a single CalculatedMetric.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetCalculatedMetricRequest request =
       GetCalculatedMetricRequest.newBuilder()
           .setName(CalculatedMetricName.of("[PROPERTY]", "[CALCULATED_METRIC]").toString())
           .build();
   ApiFuture<CalculatedMetric> future =
       analyticsAdminServiceClient.getCalculatedMetricCallable().futureCall(request);
   // Do something.
   CalculatedMetric response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetCalculatedMetricRequest,CalculatedMetric>

getChannelGroup(ChannelGroupName name)

public final ChannelGroup getChannelGroup(ChannelGroupName name)

Lookup for a single ChannelGroup.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ChannelGroupName name = ChannelGroupName.of("[PROPERTY]", "[CHANNEL_GROUP]");
   ChannelGroup response = analyticsAdminServiceClient.getChannelGroup(name);
 }
 
Parameter
Name Description
name ChannelGroupName

Required. The ChannelGroup to get. Example format: properties/1234/channelGroups/5678

Returns
Type Description
ChannelGroup

getChannelGroup(GetChannelGroupRequest request)

public final ChannelGroup getChannelGroup(GetChannelGroupRequest request)

Lookup for a single ChannelGroup.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetChannelGroupRequest request =
       GetChannelGroupRequest.newBuilder()
           .setName(ChannelGroupName.of("[PROPERTY]", "[CHANNEL_GROUP]").toString())
           .build();
   ChannelGroup response = analyticsAdminServiceClient.getChannelGroup(request);
 }
 
Parameter
Name Description
request GetChannelGroupRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
ChannelGroup

getChannelGroup(String name)

public final ChannelGroup getChannelGroup(String name)

Lookup for a single ChannelGroup.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name = ChannelGroupName.of("[PROPERTY]", "[CHANNEL_GROUP]").toString();
   ChannelGroup response = analyticsAdminServiceClient.getChannelGroup(name);
 }
 
Parameter
Name Description
name String

Required. The ChannelGroup to get. Example format: properties/1234/channelGroups/5678

Returns
Type Description
ChannelGroup

getChannelGroupCallable()

public final UnaryCallable<GetChannelGroupRequest,ChannelGroup> getChannelGroupCallable()

Lookup for a single ChannelGroup.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetChannelGroupRequest request =
       GetChannelGroupRequest.newBuilder()
           .setName(ChannelGroupName.of("[PROPERTY]", "[CHANNEL_GROUP]").toString())
           .build();
   ApiFuture<ChannelGroup> future =
       analyticsAdminServiceClient.getChannelGroupCallable().futureCall(request);
   // Do something.
   ChannelGroup response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetChannelGroupRequest,ChannelGroup>

getConversionEvent(ConversionEventName name) (deprecated)

public final ConversionEvent getConversionEvent(ConversionEventName name)

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ConversionEventName name = ConversionEventName.of("[PROPERTY]", "[CONVERSION_EVENT]");
   ConversionEvent response = analyticsAdminServiceClient.getConversionEvent(name);
 }
 
Parameter
Name Description
name ConversionEventName

Required. The resource name of the conversion event to retrieve. Format: properties/{property}/conversionEvents/{conversion_event} Example: "properties/123/conversionEvents/456"

Returns
Type Description
ConversionEvent

getConversionEvent(GetConversionEventRequest request) (deprecated)

public final ConversionEvent getConversionEvent(GetConversionEventRequest request)

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetConversionEventRequest request =
       GetConversionEventRequest.newBuilder()
           .setName(ConversionEventName.of("[PROPERTY]", "[CONVERSION_EVENT]").toString())
           .build();
   ConversionEvent response = analyticsAdminServiceClient.getConversionEvent(request);
 }
 
Parameter
Name Description
request GetConversionEventRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
ConversionEvent

getConversionEvent(String name) (deprecated)

public final ConversionEvent getConversionEvent(String name)

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name = ConversionEventName.of("[PROPERTY]", "[CONVERSION_EVENT]").toString();
   ConversionEvent response = analyticsAdminServiceClient.getConversionEvent(name);
 }
 
Parameter
Name Description
name String

Required. The resource name of the conversion event to retrieve. Format: properties/{property}/conversionEvents/{conversion_event} Example: "properties/123/conversionEvents/456"

Returns
Type Description
ConversionEvent

getConversionEventCallable() (deprecated)

public final UnaryCallable<GetConversionEventRequest,ConversionEvent> getConversionEventCallable()

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetConversionEventRequest request =
       GetConversionEventRequest.newBuilder()
           .setName(ConversionEventName.of("[PROPERTY]", "[CONVERSION_EVENT]").toString())
           .build();
   ApiFuture<ConversionEvent> future =
       analyticsAdminServiceClient.getConversionEventCallable().futureCall(request);
   // Do something.
   ConversionEvent response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetConversionEventRequest,ConversionEvent>

getCustomDimension(CustomDimensionName name)

public final CustomDimension getCustomDimension(CustomDimensionName name)

Lookup for a single CustomDimension.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CustomDimensionName name = CustomDimensionName.of("[PROPERTY]", "[CUSTOM_DIMENSION]");
   CustomDimension response = analyticsAdminServiceClient.getCustomDimension(name);
 }
 
Parameter
Name Description
name CustomDimensionName

Required. The name of the CustomDimension to get. Example format: properties/1234/customDimensions/5678

Returns
Type Description
CustomDimension

getCustomDimension(GetCustomDimensionRequest request)

public final CustomDimension getCustomDimension(GetCustomDimensionRequest request)

Lookup for a single CustomDimension.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetCustomDimensionRequest request =
       GetCustomDimensionRequest.newBuilder()
           .setName(CustomDimensionName.of("[PROPERTY]", "[CUSTOM_DIMENSION]").toString())
           .build();
   CustomDimension response = analyticsAdminServiceClient.getCustomDimension(request);
 }
 
Parameter
Name Description
request GetCustomDimensionRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
CustomDimension

getCustomDimension(String name)

public final CustomDimension getCustomDimension(String name)

Lookup for a single CustomDimension.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name = CustomDimensionName.of("[PROPERTY]", "[CUSTOM_DIMENSION]").toString();
   CustomDimension response = analyticsAdminServiceClient.getCustomDimension(name);
 }
 
Parameter
Name Description
name String

Required. The name of the CustomDimension to get. Example format: properties/1234/customDimensions/5678

Returns
Type Description
CustomDimension

getCustomDimensionCallable()

public final UnaryCallable<GetCustomDimensionRequest,CustomDimension> getCustomDimensionCallable()

Lookup for a single CustomDimension.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetCustomDimensionRequest request =
       GetCustomDimensionRequest.newBuilder()
           .setName(CustomDimensionName.of("[PROPERTY]", "[CUSTOM_DIMENSION]").toString())
           .build();
   ApiFuture<CustomDimension> future =
       analyticsAdminServiceClient.getCustomDimensionCallable().futureCall(request);
   // Do something.
   CustomDimension response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetCustomDimensionRequest,CustomDimension>

getCustomMetric(CustomMetricName name)

public final CustomMetric getCustomMetric(CustomMetricName name)

Lookup for a single CustomMetric.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CustomMetricName name = CustomMetricName.of("[PROPERTY]", "[CUSTOM_METRIC]");
   CustomMetric response = analyticsAdminServiceClient.getCustomMetric(name);
 }
 
Parameter
Name Description
name CustomMetricName

Required. The name of the CustomMetric to get. Example format: properties/1234/customMetrics/5678

Returns
Type Description
CustomMetric

getCustomMetric(GetCustomMetricRequest request)

public final CustomMetric getCustomMetric(GetCustomMetricRequest request)

Lookup for a single CustomMetric.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetCustomMetricRequest request =
       GetCustomMetricRequest.newBuilder()
           .setName(CustomMetricName.of("[PROPERTY]", "[CUSTOM_METRIC]").toString())
           .build();
   CustomMetric response = analyticsAdminServiceClient.getCustomMetric(request);
 }
 
Parameter
Name Description
request GetCustomMetricRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
CustomMetric

getCustomMetric(String name)

public final CustomMetric getCustomMetric(String name)

Lookup for a single CustomMetric.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name = CustomMetricName.of("[PROPERTY]", "[CUSTOM_METRIC]").toString();
   CustomMetric response = analyticsAdminServiceClient.getCustomMetric(name);
 }
 
Parameter
Name Description
name String

Required. The name of the CustomMetric to get. Example format: properties/1234/customMetrics/5678

Returns
Type Description
CustomMetric

getCustomMetricCallable()

public final UnaryCallable<GetCustomMetricRequest,CustomMetric> getCustomMetricCallable()

Lookup for a single CustomMetric.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetCustomMetricRequest request =
       GetCustomMetricRequest.newBuilder()
           .setName(CustomMetricName.of("[PROPERTY]", "[CUSTOM_METRIC]").toString())
           .build();
   ApiFuture<CustomMetric> future =
       analyticsAdminServiceClient.getCustomMetricCallable().futureCall(request);
   // Do something.
   CustomMetric response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetCustomMetricRequest,CustomMetric>

getDataRedactionSettings(DataRedactionSettingsName name)

public final DataRedactionSettings getDataRedactionSettings(DataRedactionSettingsName name)

Lookup for a single DataRedactionSettings.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DataRedactionSettingsName name = DataRedactionSettingsName.of("[PROPERTY]", "[DATA_STREAM]");
   DataRedactionSettings response = analyticsAdminServiceClient.getDataRedactionSettings(name);
 }
 
Parameter
Name Description
name DataRedactionSettingsName

Required. The name of the settings to lookup. Format: properties/{property}/dataStreams/{data_stream}/dataRedactionSettings Example: "properties/1000/dataStreams/2000/dataRedactionSettings"

Returns
Type Description
DataRedactionSettings

getDataRedactionSettings(GetDataRedactionSettingsRequest request)

public final DataRedactionSettings getDataRedactionSettings(GetDataRedactionSettingsRequest request)

Lookup for a single DataRedactionSettings.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetDataRedactionSettingsRequest request =
       GetDataRedactionSettingsRequest.newBuilder()
           .setName(DataRedactionSettingsName.of("[PROPERTY]", "[DATA_STREAM]").toString())
           .build();
   DataRedactionSettings response =
       analyticsAdminServiceClient.getDataRedactionSettings(request);
 }
 
Parameter
Name Description
request GetDataRedactionSettingsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
DataRedactionSettings

getDataRedactionSettings(String name)

public final DataRedactionSettings getDataRedactionSettings(String name)

Lookup for a single DataRedactionSettings.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name = DataRedactionSettingsName.of("[PROPERTY]", "[DATA_STREAM]").toString();
   DataRedactionSettings response = analyticsAdminServiceClient.getDataRedactionSettings(name);
 }
 
Parameter
Name Description
name String

Required. The name of the settings to lookup. Format: properties/{property}/dataStreams/{data_stream}/dataRedactionSettings Example: "properties/1000/dataStreams/2000/dataRedactionSettings"

Returns
Type Description
DataRedactionSettings

getDataRedactionSettingsCallable()

public final UnaryCallable<GetDataRedactionSettingsRequest,DataRedactionSettings> getDataRedactionSettingsCallable()

Lookup for a single DataRedactionSettings.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetDataRedactionSettingsRequest request =
       GetDataRedactionSettingsRequest.newBuilder()
           .setName(DataRedactionSettingsName.of("[PROPERTY]", "[DATA_STREAM]").toString())
           .build();
   ApiFuture<DataRedactionSettings> future =
       analyticsAdminServiceClient.getDataRedactionSettingsCallable().futureCall(request);
   // Do something.
   DataRedactionSettings response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetDataRedactionSettingsRequest,DataRedactionSettings>

getDataRetentionSettings(DataRetentionSettingsName name)

public final DataRetentionSettings getDataRetentionSettings(DataRetentionSettingsName name)

Returns the singleton data retention settings for this property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DataRetentionSettingsName name = DataRetentionSettingsName.of("[PROPERTY]");
   DataRetentionSettings response = analyticsAdminServiceClient.getDataRetentionSettings(name);
 }
 
Parameter
Name Description
name DataRetentionSettingsName

Required. The name of the settings to lookup. Format: properties/{property}/dataRetentionSettings Example: "properties/1000/dataRetentionSettings"

Returns
Type Description
DataRetentionSettings

getDataRetentionSettings(GetDataRetentionSettingsRequest request)

public final DataRetentionSettings getDataRetentionSettings(GetDataRetentionSettingsRequest request)

Returns the singleton data retention settings for this property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetDataRetentionSettingsRequest request =
       GetDataRetentionSettingsRequest.newBuilder()
           .setName(DataRetentionSettingsName.of("[PROPERTY]").toString())
           .build();
   DataRetentionSettings response =
       analyticsAdminServiceClient.getDataRetentionSettings(request);
 }
 
Parameter
Name Description
request GetDataRetentionSettingsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
DataRetentionSettings

getDataRetentionSettings(String name)

public final DataRetentionSettings getDataRetentionSettings(String name)

Returns the singleton data retention settings for this property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name = DataRetentionSettingsName.of("[PROPERTY]").toString();
   DataRetentionSettings response = analyticsAdminServiceClient.getDataRetentionSettings(name);
 }
 
Parameter
Name Description
name String

Required. The name of the settings to lookup. Format: properties/{property}/dataRetentionSettings Example: "properties/1000/dataRetentionSettings"

Returns
Type Description
DataRetentionSettings

getDataRetentionSettingsCallable()

public final UnaryCallable<GetDataRetentionSettingsRequest,DataRetentionSettings> getDataRetentionSettingsCallable()

Returns the singleton data retention settings for this property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetDataRetentionSettingsRequest request =
       GetDataRetentionSettingsRequest.newBuilder()
           .setName(DataRetentionSettingsName.of("[PROPERTY]").toString())
           .build();
   ApiFuture<DataRetentionSettings> future =
       analyticsAdminServiceClient.getDataRetentionSettingsCallable().futureCall(request);
   // Do something.
   DataRetentionSettings response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetDataRetentionSettingsRequest,DataRetentionSettings>

getDataSharingSettings(DataSharingSettingsName name)

public final DataSharingSettings getDataSharingSettings(DataSharingSettingsName name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DataSharingSettingsName name = DataSharingSettingsName.of("[ACCOUNT]");
   DataSharingSettings response = analyticsAdminServiceClient.getDataSharingSettings(name);
 }
 
Parameter
Name Description
name DataSharingSettingsName

Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings

Example: accounts/1000/dataSharingSettings

Returns
Type Description
DataSharingSettings

getDataSharingSettings(GetDataSharingSettingsRequest request)

public final DataSharingSettings getDataSharingSettings(GetDataSharingSettingsRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetDataSharingSettingsRequest request =
       GetDataSharingSettingsRequest.newBuilder()
           .setName(DataSharingSettingsName.of("[ACCOUNT]").toString())
           .build();
   DataSharingSettings response = analyticsAdminServiceClient.getDataSharingSettings(request);
 }
 
Parameter
Name Description
request GetDataSharingSettingsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
DataSharingSettings

getDataSharingSettings(String name)

public final DataSharingSettings getDataSharingSettings(String name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name = DataSharingSettingsName.of("[ACCOUNT]").toString();
   DataSharingSettings response = analyticsAdminServiceClient.getDataSharingSettings(name);
 }
 
Parameter
Name Description
name String

Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings

Example: accounts/1000/dataSharingSettings

Returns
Type Description
DataSharingSettings

getDataSharingSettingsCallable()

public final UnaryCallable<GetDataSharingSettingsRequest,DataSharingSettings> getDataSharingSettingsCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetDataSharingSettingsRequest request =
       GetDataSharingSettingsRequest.newBuilder()
           .setName(DataSharingSettingsName.of("[ACCOUNT]").toString())
           .build();
   ApiFuture<DataSharingSettings> future =
       analyticsAdminServiceClient.getDataSharingSettingsCallable().futureCall(request);
   // Do something.
   DataSharingSettings response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetDataSharingSettingsRequest,DataSharingSettings>

getDataStream(DataStreamName name)

public final DataStream getDataStream(DataStreamName name)

Lookup for a single DataStream.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DataStreamName name = DataStreamName.of("[PROPERTY]", "[DATA_STREAM]");
   DataStream response = analyticsAdminServiceClient.getDataStream(name);
 }
 
Parameter
Name Description
name DataStreamName

Required. The name of the DataStream to get. Example format: properties/1234/dataStreams/5678

Returns
Type Description
DataStream

getDataStream(GetDataStreamRequest request)

public final DataStream getDataStream(GetDataStreamRequest request)

Lookup for a single DataStream.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetDataStreamRequest request =
       GetDataStreamRequest.newBuilder()
           .setName(DataStreamName.of("[PROPERTY]", "[DATA_STREAM]").toString())
           .build();
   DataStream response = analyticsAdminServiceClient.getDataStream(request);
 }
 
Parameter
Name Description
request GetDataStreamRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
DataStream

getDataStream(String name)

public final DataStream getDataStream(String name)

Lookup for a single DataStream.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name = DataStreamName.of("[PROPERTY]", "[DATA_STREAM]").toString();
   DataStream response = analyticsAdminServiceClient.getDataStream(name);
 }
 
Parameter
Name Description
name String

Required. The name of the DataStream to get. Example format: properties/1234/dataStreams/5678

Returns
Type Description
DataStream

getDataStreamCallable()

public final UnaryCallable<GetDataStreamRequest,DataStream> getDataStreamCallable()

Lookup for a single DataStream.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetDataStreamRequest request =
       GetDataStreamRequest.newBuilder()
           .setName(DataStreamName.of("[PROPERTY]", "[DATA_STREAM]").toString())
           .build();
   ApiFuture<DataStream> future =
       analyticsAdminServiceClient.getDataStreamCallable().futureCall(request);
   // Do something.
   DataStream response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetDataStreamRequest,DataStream>
public final DisplayVideo360AdvertiserLink getDisplayVideo360AdvertiserLink(DisplayVideo360AdvertiserLinkName name)

Look up a single DisplayVideo360AdvertiserLink

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DisplayVideo360AdvertiserLinkName name =
       DisplayVideo360AdvertiserLinkName.of("[PROPERTY]", "[DISPLAY_VIDEO_360_ADVERTISER_LINK]");
   DisplayVideo360AdvertiserLink response =
       analyticsAdminServiceClient.getDisplayVideo360AdvertiserLink(name);
 }
 
Parameter
Name Description
name DisplayVideo360AdvertiserLinkName

Required. The name of the DisplayVideo360AdvertiserLink to get. Example format: properties/1234/displayVideo360AdvertiserLink/5678

Returns
Type Description
DisplayVideo360AdvertiserLink
public final DisplayVideo360AdvertiserLink getDisplayVideo360AdvertiserLink(GetDisplayVideo360AdvertiserLinkRequest request)

Look up a single DisplayVideo360AdvertiserLink

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetDisplayVideo360AdvertiserLinkRequest request =
       GetDisplayVideo360AdvertiserLinkRequest.newBuilder()
           .setName(
               DisplayVideo360AdvertiserLinkName.of(
                       "[PROPERTY]", "[DISPLAY_VIDEO_360_ADVERTISER_LINK]")
                   .toString())
           .build();
   DisplayVideo360AdvertiserLink response =
       analyticsAdminServiceClient.getDisplayVideo360AdvertiserLink(request);
 }
 
Parameter
Name Description
request GetDisplayVideo360AdvertiserLinkRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
DisplayVideo360AdvertiserLink
public final DisplayVideo360AdvertiserLink getDisplayVideo360AdvertiserLink(String name)

Look up a single DisplayVideo360AdvertiserLink

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name =
       DisplayVideo360AdvertiserLinkName.of("[PROPERTY]", "[DISPLAY_VIDEO_360_ADVERTISER_LINK]")
           .toString();
   DisplayVideo360AdvertiserLink response =
       analyticsAdminServiceClient.getDisplayVideo360AdvertiserLink(name);
 }
 
Parameter
Name Description
name String

Required. The name of the DisplayVideo360AdvertiserLink to get. Example format: properties/1234/displayVideo360AdvertiserLink/5678

Returns
Type Description
DisplayVideo360AdvertiserLink

getDisplayVideo360AdvertiserLinkCallable()

public final UnaryCallable<GetDisplayVideo360AdvertiserLinkRequest,DisplayVideo360AdvertiserLink> getDisplayVideo360AdvertiserLinkCallable()

Look up a single DisplayVideo360AdvertiserLink

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetDisplayVideo360AdvertiserLinkRequest request =
       GetDisplayVideo360AdvertiserLinkRequest.newBuilder()
           .setName(
               DisplayVideo360AdvertiserLinkName.of(
                       "[PROPERTY]", "[DISPLAY_VIDEO_360_ADVERTISER_LINK]")
                   .toString())
           .build();
   ApiFuture<DisplayVideo360AdvertiserLink> future =
       analyticsAdminServiceClient
           .getDisplayVideo360AdvertiserLinkCallable()
           .futureCall(request);
   // Do something.
   DisplayVideo360AdvertiserLink response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetDisplayVideo360AdvertiserLinkRequest,DisplayVideo360AdvertiserLink>

getDisplayVideo360AdvertiserLinkProposal(DisplayVideo360AdvertiserLinkProposalName name)

public final DisplayVideo360AdvertiserLinkProposal getDisplayVideo360AdvertiserLinkProposal(DisplayVideo360AdvertiserLinkProposalName name)

Lookup for a single DisplayVideo360AdvertiserLinkProposal.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DisplayVideo360AdvertiserLinkProposalName name =
       DisplayVideo360AdvertiserLinkProposalName.of(
           "[PROPERTY]", "[DISPLAY_VIDEO_360_ADVERTISER_LINK_PROPOSAL]");
   DisplayVideo360AdvertiserLinkProposal response =
       analyticsAdminServiceClient.getDisplayVideo360AdvertiserLinkProposal(name);
 }
 
Parameter
Name Description
name DisplayVideo360AdvertiserLinkProposalName

Required. The name of the DisplayVideo360AdvertiserLinkProposal to get. Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678

Returns
Type Description
DisplayVideo360AdvertiserLinkProposal

getDisplayVideo360AdvertiserLinkProposal(GetDisplayVideo360AdvertiserLinkProposalRequest request)

public final DisplayVideo360AdvertiserLinkProposal getDisplayVideo360AdvertiserLinkProposal(GetDisplayVideo360AdvertiserLinkProposalRequest request)

Lookup for a single DisplayVideo360AdvertiserLinkProposal.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetDisplayVideo360AdvertiserLinkProposalRequest request =
       GetDisplayVideo360AdvertiserLinkProposalRequest.newBuilder()
           .setName(
               DisplayVideo360AdvertiserLinkProposalName.of(
                       "[PROPERTY]", "[DISPLAY_VIDEO_360_ADVERTISER_LINK_PROPOSAL]")
                   .toString())
           .build();
   DisplayVideo360AdvertiserLinkProposal response =
       analyticsAdminServiceClient.getDisplayVideo360AdvertiserLinkProposal(request);
 }
 
Parameter
Name Description
request GetDisplayVideo360AdvertiserLinkProposalRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
DisplayVideo360AdvertiserLinkProposal

getDisplayVideo360AdvertiserLinkProposal(String name)

public final DisplayVideo360AdvertiserLinkProposal getDisplayVideo360AdvertiserLinkProposal(String name)

Lookup for a single DisplayVideo360AdvertiserLinkProposal.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name =
       DisplayVideo360AdvertiserLinkProposalName.of(
               "[PROPERTY]", "[DISPLAY_VIDEO_360_ADVERTISER_LINK_PROPOSAL]")
           .toString();
   DisplayVideo360AdvertiserLinkProposal response =
       analyticsAdminServiceClient.getDisplayVideo360AdvertiserLinkProposal(name);
 }
 
Parameter
Name Description
name String

Required. The name of the DisplayVideo360AdvertiserLinkProposal to get. Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678

Returns
Type Description
DisplayVideo360AdvertiserLinkProposal

getDisplayVideo360AdvertiserLinkProposalCallable()

public final UnaryCallable<GetDisplayVideo360AdvertiserLinkProposalRequest,DisplayVideo360AdvertiserLinkProposal> getDisplayVideo360AdvertiserLinkProposalCallable()

Lookup for a single DisplayVideo360AdvertiserLinkProposal.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetDisplayVideo360AdvertiserLinkProposalRequest request =
       GetDisplayVideo360AdvertiserLinkProposalRequest.newBuilder()
           .setName(
               DisplayVideo360AdvertiserLinkProposalName.of(
                       "[PROPERTY]", "[DISPLAY_VIDEO_360_ADVERTISER_LINK_PROPOSAL]")
                   .toString())
           .build();
   ApiFuture<DisplayVideo360AdvertiserLinkProposal> future =
       analyticsAdminServiceClient
           .getDisplayVideo360AdvertiserLinkProposalCallable()
           .futureCall(request);
   // Do something.
   DisplayVideo360AdvertiserLinkProposal response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetDisplayVideo360AdvertiserLinkProposalRequest,DisplayVideo360AdvertiserLinkProposal>

getEnhancedMeasurementSettings(EnhancedMeasurementSettingsName name)

public final EnhancedMeasurementSettings getEnhancedMeasurementSettings(EnhancedMeasurementSettingsName name)

Returns the enhanced measurement settings for this data stream. Note that the stream must enable enhanced measurement for these settings to take effect.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   EnhancedMeasurementSettingsName name =
       EnhancedMeasurementSettingsName.of("[PROPERTY]", "[DATA_STREAM]");
   EnhancedMeasurementSettings response =
       analyticsAdminServiceClient.getEnhancedMeasurementSettings(name);
 }
 
Parameter
Name Description
name EnhancedMeasurementSettingsName

Required. The name of the settings to lookup. Format: properties/{property}/dataStreams/{data_stream}/enhancedMeasurementSettings Example: "properties/1000/dataStreams/2000/enhancedMeasurementSettings"

Returns
Type Description
EnhancedMeasurementSettings

getEnhancedMeasurementSettings(GetEnhancedMeasurementSettingsRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetEnhancedMeasurementSettingsRequest request =
       GetEnhancedMeasurementSettingsRequest.newBuilder()
           .setName(EnhancedMeasurementSettingsName.of("[PROPERTY]", "[DATA_STREAM]").toString())
           .build();
   EnhancedMeasurementSettings response =
       analyticsAdminServiceClient.getEnhancedMeasurementSettings(request);
 }
 
Parameter
Name Description
request GetEnhancedMeasurementSettingsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
EnhancedMeasurementSettings

getEnhancedMeasurementSettings(String name)

public final EnhancedMeasurementSettings getEnhancedMeasurementSettings(String name)

Returns the enhanced measurement settings for this data stream. Note that the stream must enable enhanced measurement for these settings to take effect.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name = EnhancedMeasurementSettingsName.of("[PROPERTY]", "[DATA_STREAM]").toString();
   EnhancedMeasurementSettings response =
       analyticsAdminServiceClient.getEnhancedMeasurementSettings(name);
 }
 
Parameter
Name Description
name String

Required. The name of the settings to lookup. Format: properties/{property}/dataStreams/{data_stream}/enhancedMeasurementSettings Example: "properties/1000/dataStreams/2000/enhancedMeasurementSettings"

Returns
Type Description
EnhancedMeasurementSettings

getEnhancedMeasurementSettingsCallable()

public final UnaryCallable<GetEnhancedMeasurementSettingsRequest,EnhancedMeasurementSettings> getEnhancedMeasurementSettingsCallable()

Returns the enhanced measurement settings for this data stream. Note that the stream must enable enhanced measurement for these settings to take effect.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetEnhancedMeasurementSettingsRequest request =
       GetEnhancedMeasurementSettingsRequest.newBuilder()
           .setName(EnhancedMeasurementSettingsName.of("[PROPERTY]", "[DATA_STREAM]").toString())
           .build();
   ApiFuture<EnhancedMeasurementSettings> future =
       analyticsAdminServiceClient.getEnhancedMeasurementSettingsCallable().futureCall(request);
   // Do something.
   EnhancedMeasurementSettings response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetEnhancedMeasurementSettingsRequest,EnhancedMeasurementSettings>

getEventCreateRule(EventCreateRuleName name)

public final EventCreateRule getEventCreateRule(EventCreateRuleName name)

Lookup for a single EventCreateRule.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   EventCreateRuleName name =
       EventCreateRuleName.of("[PROPERTY]", "[DATA_STREAM]", "[EVENT_CREATE_RULE]");
   EventCreateRule response = analyticsAdminServiceClient.getEventCreateRule(name);
 }
 
Parameter
Name Description
name EventCreateRuleName

Required. The name of the EventCreateRule to get. Example format: properties/123/dataStreams/456/eventCreateRules/789

Returns
Type Description
EventCreateRule

getEventCreateRule(GetEventCreateRuleRequest request)

public final EventCreateRule getEventCreateRule(GetEventCreateRuleRequest request)

Lookup for a single EventCreateRule.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetEventCreateRuleRequest request =
       GetEventCreateRuleRequest.newBuilder()
           .setName(
               EventCreateRuleName.of("[PROPERTY]", "[DATA_STREAM]", "[EVENT_CREATE_RULE]")
                   .toString())
           .build();
   EventCreateRule response = analyticsAdminServiceClient.getEventCreateRule(request);
 }
 
Parameter
Name Description
request GetEventCreateRuleRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
EventCreateRule

getEventCreateRule(String name)

public final EventCreateRule getEventCreateRule(String name)

Lookup for a single EventCreateRule.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name =
       EventCreateRuleName.of("[PROPERTY]", "[DATA_STREAM]", "[EVENT_CREATE_RULE]").toString();
   EventCreateRule response = analyticsAdminServiceClient.getEventCreateRule(name);
 }
 
Parameter
Name Description
name String

Required. The name of the EventCreateRule to get. Example format: properties/123/dataStreams/456/eventCreateRules/789

Returns
Type Description
EventCreateRule

getEventCreateRuleCallable()

public final UnaryCallable<GetEventCreateRuleRequest,EventCreateRule> getEventCreateRuleCallable()

Lookup for a single EventCreateRule.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetEventCreateRuleRequest request =
       GetEventCreateRuleRequest.newBuilder()
           .setName(
               EventCreateRuleName.of("[PROPERTY]", "[DATA_STREAM]", "[EVENT_CREATE_RULE]")
                   .toString())
           .build();
   ApiFuture<EventCreateRule> future =
       analyticsAdminServiceClient.getEventCreateRuleCallable().futureCall(request);
   // Do something.
   EventCreateRule response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetEventCreateRuleRequest,EventCreateRule>

getEventEditRule(EventEditRuleName name)

public final EventEditRule getEventEditRule(EventEditRuleName name)

Lookup for a single EventEditRule.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   EventEditRuleName name =
       EventEditRuleName.of("[PROPERTY]", "[DATA_STREAM]", "[EVENT_EDIT_RULE]");
   EventEditRule response = analyticsAdminServiceClient.getEventEditRule(name);
 }
 
Parameter
Name Description
name EventEditRuleName

Required. The name of the EventEditRule to get. Example format: properties/123/dataStreams/456/eventEditRules/789

Returns
Type Description
EventEditRule

getEventEditRule(GetEventEditRuleRequest request)

public final EventEditRule getEventEditRule(GetEventEditRuleRequest request)

Lookup for a single EventEditRule.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetEventEditRuleRequest request =
       GetEventEditRuleRequest.newBuilder()
           .setName(
               EventEditRuleName.of("[PROPERTY]", "[DATA_STREAM]", "[EVENT_EDIT_RULE]")
                   .toString())
           .build();
   EventEditRule response = analyticsAdminServiceClient.getEventEditRule(request);
 }
 
Parameter
Name Description
request GetEventEditRuleRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
EventEditRule

getEventEditRule(String name)

public final EventEditRule getEventEditRule(String name)

Lookup for a single EventEditRule.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name =
       EventEditRuleName.of("[PROPERTY]", "[DATA_STREAM]", "[EVENT_EDIT_RULE]").toString();
   EventEditRule response = analyticsAdminServiceClient.getEventEditRule(name);
 }
 
Parameter
Name Description
name String

Required. The name of the EventEditRule to get. Example format: properties/123/dataStreams/456/eventEditRules/789

Returns
Type Description
EventEditRule

getEventEditRuleCallable()

public final UnaryCallable<GetEventEditRuleRequest,EventEditRule> getEventEditRuleCallable()

Lookup for a single EventEditRule.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetEventEditRuleRequest request =
       GetEventEditRuleRequest.newBuilder()
           .setName(
               EventEditRuleName.of("[PROPERTY]", "[DATA_STREAM]", "[EVENT_EDIT_RULE]")
                   .toString())
           .build();
   ApiFuture<EventEditRule> future =
       analyticsAdminServiceClient.getEventEditRuleCallable().futureCall(request);
   // Do something.
   EventEditRule response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetEventEditRuleRequest,EventEditRule>

getExpandedDataSet(ExpandedDataSetName name)

public final ExpandedDataSet getExpandedDataSet(ExpandedDataSetName name)

Lookup for a single ExpandedDataSet.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ExpandedDataSetName name = ExpandedDataSetName.of("[PROPERTY]", "[EXPANDED_DATA_SET]");
   ExpandedDataSet response = analyticsAdminServiceClient.getExpandedDataSet(name);
 }
 
Parameter
Name Description
name ExpandedDataSetName

Required. The name of the ExpandedDataSet to get. Example format: properties/1234/expandedDataSets/5678

Returns
Type Description
ExpandedDataSet

getExpandedDataSet(GetExpandedDataSetRequest request)

public final ExpandedDataSet getExpandedDataSet(GetExpandedDataSetRequest request)

Lookup for a single ExpandedDataSet.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetExpandedDataSetRequest request =
       GetExpandedDataSetRequest.newBuilder()
           .setName(ExpandedDataSetName.of("[PROPERTY]", "[EXPANDED_DATA_SET]").toString())
           .build();
   ExpandedDataSet response = analyticsAdminServiceClient.getExpandedDataSet(request);
 }
 
Parameter
Name Description
request GetExpandedDataSetRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
ExpandedDataSet

getExpandedDataSet(String name)

public final ExpandedDataSet getExpandedDataSet(String name)

Lookup for a single ExpandedDataSet.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name = ExpandedDataSetName.of("[PROPERTY]", "[EXPANDED_DATA_SET]").toString();
   ExpandedDataSet response = analyticsAdminServiceClient.getExpandedDataSet(name);
 }
 
Parameter
Name Description
name String

Required. The name of the ExpandedDataSet to get. Example format: properties/1234/expandedDataSets/5678

Returns
Type Description
ExpandedDataSet

getExpandedDataSetCallable()

public final UnaryCallable<GetExpandedDataSetRequest,ExpandedDataSet> getExpandedDataSetCallable()

Lookup for a single ExpandedDataSet.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetExpandedDataSetRequest request =
       GetExpandedDataSetRequest.newBuilder()
           .setName(ExpandedDataSetName.of("[PROPERTY]", "[EXPANDED_DATA_SET]").toString())
           .build();
   ApiFuture<ExpandedDataSet> future =
       analyticsAdminServiceClient.getExpandedDataSetCallable().futureCall(request);
   // Do something.
   ExpandedDataSet response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetExpandedDataSetRequest,ExpandedDataSet>

getGlobalSiteTag(GetGlobalSiteTagRequest request)

public final GlobalSiteTag getGlobalSiteTag(GetGlobalSiteTagRequest request)

Returns the Site Tag for the specified web stream. Site Tags are immutable singletons.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetGlobalSiteTagRequest request =
       GetGlobalSiteTagRequest.newBuilder()
           .setName(GlobalSiteTagName.of("[PROPERTY]", "[DATA_STREAM]").toString())
           .build();
   GlobalSiteTag response = analyticsAdminServiceClient.getGlobalSiteTag(request);
 }
 
Parameter
Name Description
request GetGlobalSiteTagRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
GlobalSiteTag

getGlobalSiteTag(GlobalSiteTagName name)

public final GlobalSiteTag getGlobalSiteTag(GlobalSiteTagName name)

Returns the Site Tag for the specified web stream. Site Tags are immutable singletons.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GlobalSiteTagName name = GlobalSiteTagName.of("[PROPERTY]", "[DATA_STREAM]");
   GlobalSiteTag response = analyticsAdminServiceClient.getGlobalSiteTag(name);
 }
 
Parameter
Name Description
name GlobalSiteTagName

Required. The name of the site tag to lookup. Note that site tags are singletons and do not have unique IDs. Format: properties/{property_id}/dataStreams/{stream_id}/globalSiteTag

Example: properties/123/dataStreams/456/globalSiteTag

Returns
Type Description
GlobalSiteTag

getGlobalSiteTag(String name)

public final GlobalSiteTag getGlobalSiteTag(String name)

Returns the Site Tag for the specified web stream. Site Tags are immutable singletons.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name = GlobalSiteTagName.of("[PROPERTY]", "[DATA_STREAM]").toString();
   GlobalSiteTag response = analyticsAdminServiceClient.getGlobalSiteTag(name);
 }
 
Parameter
Name Description
name String

Required. The name of the site tag to lookup. Note that site tags are singletons and do not have unique IDs. Format: properties/{property_id}/dataStreams/{stream_id}/globalSiteTag

Example: properties/123/dataStreams/456/globalSiteTag

Returns
Type Description
GlobalSiteTag

getGlobalSiteTagCallable()

public final UnaryCallable<GetGlobalSiteTagRequest,GlobalSiteTag> getGlobalSiteTagCallable()

Returns the Site Tag for the specified web stream. Site Tags are immutable singletons.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetGlobalSiteTagRequest request =
       GetGlobalSiteTagRequest.newBuilder()
           .setName(GlobalSiteTagName.of("[PROPERTY]", "[DATA_STREAM]").toString())
           .build();
   ApiFuture<GlobalSiteTag> future =
       analyticsAdminServiceClient.getGlobalSiteTagCallable().futureCall(request);
   // Do something.
   GlobalSiteTag response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetGlobalSiteTagRequest,GlobalSiteTag>

getGoogleSignalsSettings(GetGoogleSignalsSettingsRequest request)

public final GoogleSignalsSettings getGoogleSignalsSettings(GetGoogleSignalsSettingsRequest request)

Lookup for Google Signals settings for a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetGoogleSignalsSettingsRequest request =
       GetGoogleSignalsSettingsRequest.newBuilder()
           .setName(GoogleSignalsSettingsName.of("[PROPERTY]").toString())
           .build();
   GoogleSignalsSettings response =
       analyticsAdminServiceClient.getGoogleSignalsSettings(request);
 }
 
Parameter
Name Description
request GetGoogleSignalsSettingsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
GoogleSignalsSettings

getGoogleSignalsSettings(GoogleSignalsSettingsName name)

public final GoogleSignalsSettings getGoogleSignalsSettings(GoogleSignalsSettingsName name)

Lookup for Google Signals settings for a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GoogleSignalsSettingsName name = GoogleSignalsSettingsName.of("[PROPERTY]");
   GoogleSignalsSettings response = analyticsAdminServiceClient.getGoogleSignalsSettings(name);
 }
 
Parameter
Name Description
name GoogleSignalsSettingsName

Required. The name of the google signals settings to retrieve. Format: properties/{property}/googleSignalsSettings

Returns
Type Description
GoogleSignalsSettings

getGoogleSignalsSettings(String name)

public final GoogleSignalsSettings getGoogleSignalsSettings(String name)

Lookup for Google Signals settings for a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name = GoogleSignalsSettingsName.of("[PROPERTY]").toString();
   GoogleSignalsSettings response = analyticsAdminServiceClient.getGoogleSignalsSettings(name);
 }
 
Parameter
Name Description
name String

Required. The name of the google signals settings to retrieve. Format: properties/{property}/googleSignalsSettings

Returns
Type Description
GoogleSignalsSettings

getGoogleSignalsSettingsCallable()

public final UnaryCallable<GetGoogleSignalsSettingsRequest,GoogleSignalsSettings> getGoogleSignalsSettingsCallable()

Lookup for Google Signals settings for a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetGoogleSignalsSettingsRequest request =
       GetGoogleSignalsSettingsRequest.newBuilder()
           .setName(GoogleSignalsSettingsName.of("[PROPERTY]").toString())
           .build();
   ApiFuture<GoogleSignalsSettings> future =
       analyticsAdminServiceClient.getGoogleSignalsSettingsCallable().futureCall(request);
   // Do something.
   GoogleSignalsSettings response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetGoogleSignalsSettingsRequest,GoogleSignalsSettings>

getKeyEvent(GetKeyEventRequest request)

public final KeyEvent getKeyEvent(GetKeyEventRequest request)

Retrieve a single Key Event.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetKeyEventRequest request =
       GetKeyEventRequest.newBuilder()
           .setName(KeyEventName.of("[PROPERTY]", "[KEY_EVENT]").toString())
           .build();
   KeyEvent response = analyticsAdminServiceClient.getKeyEvent(request);
 }
 
Parameter
Name Description
request GetKeyEventRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
KeyEvent

getKeyEvent(KeyEventName name)

public final KeyEvent getKeyEvent(KeyEventName name)

Retrieve a single Key Event.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   KeyEventName name = KeyEventName.of("[PROPERTY]", "[KEY_EVENT]");
   KeyEvent response = analyticsAdminServiceClient.getKeyEvent(name);
 }
 
Parameter
Name Description
name KeyEventName

Required. The resource name of the Key Event to retrieve. Format: properties/{property}/keyEvents/{key_event} Example: "properties/123/keyEvents/456"

Returns
Type Description
KeyEvent

getKeyEvent(String name)

public final KeyEvent getKeyEvent(String name)

Retrieve a single Key Event.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name = KeyEventName.of("[PROPERTY]", "[KEY_EVENT]").toString();
   KeyEvent response = analyticsAdminServiceClient.getKeyEvent(name);
 }
 
Parameter
Name Description
name String

Required. The resource name of the Key Event to retrieve. Format: properties/{property}/keyEvents/{key_event} Example: "properties/123/keyEvents/456"

Returns
Type Description
KeyEvent

getKeyEventCallable()

public final UnaryCallable<GetKeyEventRequest,KeyEvent> getKeyEventCallable()

Retrieve a single Key Event.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetKeyEventRequest request =
       GetKeyEventRequest.newBuilder()
           .setName(KeyEventName.of("[PROPERTY]", "[KEY_EVENT]").toString())
           .build();
   ApiFuture<KeyEvent> future =
       analyticsAdminServiceClient.getKeyEventCallable().futureCall(request);
   // Do something.
   KeyEvent response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetKeyEventRequest,KeyEvent>

getMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest request)

public final MeasurementProtocolSecret getMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest request)

Lookup for a single "GA4" MeasurementProtocolSecret.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetMeasurementProtocolSecretRequest request =
       GetMeasurementProtocolSecretRequest.newBuilder()
           .setName(
               MeasurementProtocolSecretName.of(
                       "[PROPERTY]", "[DATA_STREAM]", "[MEASUREMENT_PROTOCOL_SECRET]")
                   .toString())
           .build();
   MeasurementProtocolSecret response =
       analyticsAdminServiceClient.getMeasurementProtocolSecret(request);
 }
 
Parameter
Name Description
request GetMeasurementProtocolSecretRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
MeasurementProtocolSecret

getMeasurementProtocolSecret(MeasurementProtocolSecretName name)

public final MeasurementProtocolSecret getMeasurementProtocolSecret(MeasurementProtocolSecretName name)

Lookup for a single "GA4" MeasurementProtocolSecret.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   MeasurementProtocolSecretName name =
       MeasurementProtocolSecretName.of(
           "[PROPERTY]", "[DATA_STREAM]", "[MEASUREMENT_PROTOCOL_SECRET]");
   MeasurementProtocolSecret response =
       analyticsAdminServiceClient.getMeasurementProtocolSecret(name);
 }
 
Parameter
Name Description
name MeasurementProtocolSecretName

Required. The name of the measurement protocol secret to lookup. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

Returns
Type Description
MeasurementProtocolSecret

getMeasurementProtocolSecret(String name)

public final MeasurementProtocolSecret getMeasurementProtocolSecret(String name)

Lookup for a single "GA4" MeasurementProtocolSecret.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name =
       MeasurementProtocolSecretName.of(
               "[PROPERTY]", "[DATA_STREAM]", "[MEASUREMENT_PROTOCOL_SECRET]")
           .toString();
   MeasurementProtocolSecret response =
       analyticsAdminServiceClient.getMeasurementProtocolSecret(name);
 }
 
Parameter
Name Description
name String

Required. The name of the measurement protocol secret to lookup. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

Returns
Type Description
MeasurementProtocolSecret

getMeasurementProtocolSecretCallable()

public final UnaryCallable<GetMeasurementProtocolSecretRequest,MeasurementProtocolSecret> getMeasurementProtocolSecretCallable()

Lookup for a single "GA4" MeasurementProtocolSecret.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetMeasurementProtocolSecretRequest request =
       GetMeasurementProtocolSecretRequest.newBuilder()
           .setName(
               MeasurementProtocolSecretName.of(
                       "[PROPERTY]", "[DATA_STREAM]", "[MEASUREMENT_PROTOCOL_SECRET]")
                   .toString())
           .build();
   ApiFuture<MeasurementProtocolSecret> future =
       analyticsAdminServiceClient.getMeasurementProtocolSecretCallable().futureCall(request);
   // Do something.
   MeasurementProtocolSecret response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetMeasurementProtocolSecretRequest,MeasurementProtocolSecret>

getProperty(GetPropertyRequest request)

public final Property getProperty(GetPropertyRequest request)

Lookup for a single "GA4" Property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetPropertyRequest request =
       GetPropertyRequest.newBuilder().setName(PropertyName.of("[PROPERTY]").toString()).build();
   Property response = analyticsAdminServiceClient.getProperty(request);
 }
 
Parameter
Name Description
request GetPropertyRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
Property

getProperty(PropertyName name)

public final Property getProperty(PropertyName name)

Lookup for a single "GA4" Property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   PropertyName name = PropertyName.of("[PROPERTY]");
   Property response = analyticsAdminServiceClient.getProperty(name);
 }
 
Parameter
Name Description
name PropertyName

Required. The name of the property to lookup. Format: properties/{property_id} Example: "properties/1000"

Returns
Type Description
Property

getProperty(String name)

public final Property getProperty(String name)

Lookup for a single "GA4" Property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name = PropertyName.of("[PROPERTY]").toString();
   Property response = analyticsAdminServiceClient.getProperty(name);
 }
 
Parameter
Name Description
name String

Required. The name of the property to lookup. Format: properties/{property_id} Example: "properties/1000"

Returns
Type Description
Property

getPropertyCallable()

public final UnaryCallable<GetPropertyRequest,Property> getPropertyCallable()

Lookup for a single "GA4" Property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetPropertyRequest request =
       GetPropertyRequest.newBuilder().setName(PropertyName.of("[PROPERTY]").toString()).build();
   ApiFuture<Property> future =
       analyticsAdminServiceClient.getPropertyCallable().futureCall(request);
   // Do something.
   Property response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetPropertyRequest,Property>
public final 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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetRollupPropertySourceLinkRequest request =
       GetRollupPropertySourceLinkRequest.newBuilder()
           .setName(
               RollupPropertySourceLinkName.of("[PROPERTY]", "[ROLLUP_PROPERTY_SOURCE_LINK]")
                   .toString())
           .build();
   RollupPropertySourceLink response =
       analyticsAdminServiceClient.getRollupPropertySourceLink(request);
 }
 
Parameter
Name Description
request GetRollupPropertySourceLinkRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
RollupPropertySourceLink
public final RollupPropertySourceLink getRollupPropertySourceLink(RollupPropertySourceLinkName name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   RollupPropertySourceLinkName name =
       RollupPropertySourceLinkName.of("[PROPERTY]", "[ROLLUP_PROPERTY_SOURCE_LINK]");
   RollupPropertySourceLink response =
       analyticsAdminServiceClient.getRollupPropertySourceLink(name);
 }
 
Parameter
Name Description
name RollupPropertySourceLinkName

Required. The name of the roll-up property source link to lookup. Format: properties/{property_id}/rollupPropertySourceLinks/{rollup_property_source_link_id} Example: properties/123/rollupPropertySourceLinks/456

Returns
Type Description
RollupPropertySourceLink
public final RollupPropertySourceLink getRollupPropertySourceLink(String name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name =
       RollupPropertySourceLinkName.of("[PROPERTY]", "[ROLLUP_PROPERTY_SOURCE_LINK]").toString();
   RollupPropertySourceLink response =
       analyticsAdminServiceClient.getRollupPropertySourceLink(name);
 }
 
Parameter
Name Description
name String

Required. The name of the roll-up property source link to lookup. Format: properties/{property_id}/rollupPropertySourceLinks/{rollup_property_source_link_id} Example: properties/123/rollupPropertySourceLinks/456

Returns
Type Description
RollupPropertySourceLink

getRollupPropertySourceLinkCallable()

public final UnaryCallable<GetRollupPropertySourceLinkRequest,RollupPropertySourceLink> getRollupPropertySourceLinkCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetRollupPropertySourceLinkRequest request =
       GetRollupPropertySourceLinkRequest.newBuilder()
           .setName(
               RollupPropertySourceLinkName.of("[PROPERTY]", "[ROLLUP_PROPERTY_SOURCE_LINK]")
                   .toString())
           .build();
   ApiFuture<RollupPropertySourceLink> future =
       analyticsAdminServiceClient.getRollupPropertySourceLinkCallable().futureCall(request);
   // Do something.
   RollupPropertySourceLink response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetRollupPropertySourceLinkRequest,RollupPropertySourceLink>

getSKAdNetworkConversionValueSchema(GetSKAdNetworkConversionValueSchemaRequest request)

public final SKAdNetworkConversionValueSchema getSKAdNetworkConversionValueSchema(GetSKAdNetworkConversionValueSchemaRequest request)

Looks up a single SKAdNetworkConversionValueSchema.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetSKAdNetworkConversionValueSchemaRequest request =
       GetSKAdNetworkConversionValueSchemaRequest.newBuilder()
           .setName(
               SKAdNetworkConversionValueSchemaName.of(
                       "[PROPERTY]", "[DATA_STREAM]", "[SKADNETWORK_CONVERSION_VALUE_SCHEMA]")
                   .toString())
           .build();
   SKAdNetworkConversionValueSchema response =
       analyticsAdminServiceClient.getSKAdNetworkConversionValueSchema(request);
 }
 
Parameter
Name Description
request GetSKAdNetworkConversionValueSchemaRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
SKAdNetworkConversionValueSchema

getSKAdNetworkConversionValueSchema(SKAdNetworkConversionValueSchemaName name)

public final SKAdNetworkConversionValueSchema getSKAdNetworkConversionValueSchema(SKAdNetworkConversionValueSchemaName name)

Looks up a single SKAdNetworkConversionValueSchema.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   SKAdNetworkConversionValueSchemaName name =
       SKAdNetworkConversionValueSchemaName.of(
           "[PROPERTY]", "[DATA_STREAM]", "[SKADNETWORK_CONVERSION_VALUE_SCHEMA]");
   SKAdNetworkConversionValueSchema response =
       analyticsAdminServiceClient.getSKAdNetworkConversionValueSchema(name);
 }
 
Parameter
Name Description
name SKAdNetworkConversionValueSchemaName

Required. The resource name of SKAdNetwork conversion value schema to look up. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema/{skadnetwork_conversion_value_schema}

Returns
Type Description
SKAdNetworkConversionValueSchema

getSKAdNetworkConversionValueSchema(String name)

public final SKAdNetworkConversionValueSchema getSKAdNetworkConversionValueSchema(String name)

Looks up a single SKAdNetworkConversionValueSchema.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name =
       SKAdNetworkConversionValueSchemaName.of(
               "[PROPERTY]", "[DATA_STREAM]", "[SKADNETWORK_CONVERSION_VALUE_SCHEMA]")
           .toString();
   SKAdNetworkConversionValueSchema response =
       analyticsAdminServiceClient.getSKAdNetworkConversionValueSchema(name);
 }
 
Parameter
Name Description
name String

Required. The resource name of SKAdNetwork conversion value schema to look up. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema/{skadnetwork_conversion_value_schema}

Returns
Type Description
SKAdNetworkConversionValueSchema

getSKAdNetworkConversionValueSchemaCallable()

public final UnaryCallable<GetSKAdNetworkConversionValueSchemaRequest,SKAdNetworkConversionValueSchema> getSKAdNetworkConversionValueSchemaCallable()

Looks up a single SKAdNetworkConversionValueSchema.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetSKAdNetworkConversionValueSchemaRequest request =
       GetSKAdNetworkConversionValueSchemaRequest.newBuilder()
           .setName(
               SKAdNetworkConversionValueSchemaName.of(
                       "[PROPERTY]", "[DATA_STREAM]", "[SKADNETWORK_CONVERSION_VALUE_SCHEMA]")
                   .toString())
           .build();
   ApiFuture<SKAdNetworkConversionValueSchema> future =
       analyticsAdminServiceClient
           .getSKAdNetworkConversionValueSchemaCallable()
           .futureCall(request);
   // Do something.
   SKAdNetworkConversionValueSchema response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetSKAdNetworkConversionValueSchemaRequest,SKAdNetworkConversionValueSchema>
public final SearchAds360Link getSearchAds360Link(GetSearchAds360LinkRequest request)

Look up a single SearchAds360Link

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetSearchAds360LinkRequest request =
       GetSearchAds360LinkRequest.newBuilder()
           .setName(SearchAds360LinkName.of("[PROPERTY]", "[SEARCH_ADS_360_LINK]").toString())
           .build();
   SearchAds360Link response = analyticsAdminServiceClient.getSearchAds360Link(request);
 }
 
Parameter
Name Description
request GetSearchAds360LinkRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
SearchAds360Link
public final SearchAds360Link getSearchAds360Link(SearchAds360LinkName name)

Look up a single SearchAds360Link

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   SearchAds360LinkName name = SearchAds360LinkName.of("[PROPERTY]", "[SEARCH_ADS_360_LINK]");
   SearchAds360Link response = analyticsAdminServiceClient.getSearchAds360Link(name);
 }
 
Parameter
Name Description
name SearchAds360LinkName

Required. The name of the SearchAds360Link to get. Example format: properties/1234/SearchAds360Link/5678

Returns
Type Description
SearchAds360Link
public final SearchAds360Link getSearchAds360Link(String name)

Look up a single SearchAds360Link

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name = SearchAds360LinkName.of("[PROPERTY]", "[SEARCH_ADS_360_LINK]").toString();
   SearchAds360Link response = analyticsAdminServiceClient.getSearchAds360Link(name);
 }
 
Parameter
Name Description
name String

Required. The name of the SearchAds360Link to get. Example format: properties/1234/SearchAds360Link/5678

Returns
Type Description
SearchAds360Link

getSearchAds360LinkCallable()

public final UnaryCallable<GetSearchAds360LinkRequest,SearchAds360Link> getSearchAds360LinkCallable()

Look up a single SearchAds360Link

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetSearchAds360LinkRequest request =
       GetSearchAds360LinkRequest.newBuilder()
           .setName(SearchAds360LinkName.of("[PROPERTY]", "[SEARCH_ADS_360_LINK]").toString())
           .build();
   ApiFuture<SearchAds360Link> future =
       analyticsAdminServiceClient.getSearchAds360LinkCallable().futureCall(request);
   // Do something.
   SearchAds360Link response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetSearchAds360LinkRequest,SearchAds360Link>

getSettings()

public final AnalyticsAdminServiceSettings getSettings()
Returns
Type Description
AnalyticsAdminServiceSettings

getStub()

public AnalyticsAdminServiceStub getStub()
Returns
Type Description
AnalyticsAdminServiceStub

getSubpropertyEventFilter(GetSubpropertyEventFilterRequest request)

public final SubpropertyEventFilter getSubpropertyEventFilter(GetSubpropertyEventFilterRequest request)

Lookup for a single subproperty Event Filter.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetSubpropertyEventFilterRequest request =
       GetSubpropertyEventFilterRequest.newBuilder()
           .setName(
               SubpropertyEventFilterName.of("[PROPERTY]", "[SUB_PROPERTY_EVENT_FILTER]")
                   .toString())
           .build();
   SubpropertyEventFilter response =
       analyticsAdminServiceClient.getSubpropertyEventFilter(request);
 }
 
Parameter
Name Description
request GetSubpropertyEventFilterRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
SubpropertyEventFilter

getSubpropertyEventFilter(SubpropertyEventFilterName name)

public final SubpropertyEventFilter getSubpropertyEventFilter(SubpropertyEventFilterName name)

Lookup for a single subproperty Event Filter.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   SubpropertyEventFilterName name =
       SubpropertyEventFilterName.of("[PROPERTY]", "[SUB_PROPERTY_EVENT_FILTER]");
   SubpropertyEventFilter response = analyticsAdminServiceClient.getSubpropertyEventFilter(name);
 }
 
Parameter
Name Description
name SubpropertyEventFilterName

Required. Resource name of the subproperty event filter to lookup. Format: properties/property_id/subpropertyEventFilters/subproperty_event_filter Example: properties/123/subpropertyEventFilters/456

Returns
Type Description
SubpropertyEventFilter

getSubpropertyEventFilter(String name)

public final SubpropertyEventFilter getSubpropertyEventFilter(String name)

Lookup for a single subproperty Event Filter.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String name =
       SubpropertyEventFilterName.of("[PROPERTY]", "[SUB_PROPERTY_EVENT_FILTER]").toString();
   SubpropertyEventFilter response = analyticsAdminServiceClient.getSubpropertyEventFilter(name);
 }
 
Parameter
Name Description
name String

Required. Resource name of the subproperty event filter to lookup. Format: properties/property_id/subpropertyEventFilters/subproperty_event_filter Example: properties/123/subpropertyEventFilters/456

Returns
Type Description
SubpropertyEventFilter

getSubpropertyEventFilterCallable()

public final UnaryCallable<GetSubpropertyEventFilterRequest,SubpropertyEventFilter> getSubpropertyEventFilterCallable()

Lookup for a single subproperty Event Filter.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GetSubpropertyEventFilterRequest request =
       GetSubpropertyEventFilterRequest.newBuilder()
           .setName(
               SubpropertyEventFilterName.of("[PROPERTY]", "[SUB_PROPERTY_EVENT_FILTER]")
                   .toString())
           .build();
   ApiFuture<SubpropertyEventFilter> future =
       analyticsAdminServiceClient.getSubpropertyEventFilterCallable().futureCall(request);
   // Do something.
   SubpropertyEventFilter response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetSubpropertyEventFilterRequest,SubpropertyEventFilter>

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listAccessBindings(AccountName parent)

public final AnalyticsAdminServiceClient.ListAccessBindingsPagedResponse listAccessBindings(AccountName parent)

Lists all access bindings on an account or property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   AccountName parent = AccountName.of("[ACCOUNT]");
   for (AccessBinding element :
       analyticsAdminServiceClient.listAccessBindings(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent AccountName

Required. Formats: - accounts/{account} - properties/{property}

Returns
Type Description
AnalyticsAdminServiceClient.ListAccessBindingsPagedResponse

listAccessBindings(ListAccessBindingsRequest request)

public final AnalyticsAdminServiceClient.ListAccessBindingsPagedResponse listAccessBindings(ListAccessBindingsRequest request)

Lists all access bindings on an account or property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListAccessBindingsRequest request =
       ListAccessBindingsRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (AccessBinding element :
       analyticsAdminServiceClient.listAccessBindings(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListAccessBindingsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
AnalyticsAdminServiceClient.ListAccessBindingsPagedResponse

listAccessBindings(PropertyName parent)

public final AnalyticsAdminServiceClient.ListAccessBindingsPagedResponse listAccessBindings(PropertyName parent)

Lists all access bindings on an account or property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   PropertyName parent = PropertyName.of("[PROPERTY]");
   for (AccessBinding element :
       analyticsAdminServiceClient.listAccessBindings(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent PropertyName

Required. Formats: - accounts/{account} - properties/{property}

Returns
Type Description
AnalyticsAdminServiceClient.ListAccessBindingsPagedResponse

listAccessBindings(String parent)

public final AnalyticsAdminServiceClient.ListAccessBindingsPagedResponse listAccessBindings(String parent)

Lists all access bindings on an account or property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String parent = AccountName.of("[ACCOUNT]").toString();
   for (AccessBinding element :
       analyticsAdminServiceClient.listAccessBindings(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. Formats: - accounts/{account} - properties/{property}

Returns
Type Description
AnalyticsAdminServiceClient.ListAccessBindingsPagedResponse

listAccessBindingsCallable()

public final UnaryCallable<ListAccessBindingsRequest,ListAccessBindingsResponse> listAccessBindingsCallable()

Lists all access bindings on an account or property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListAccessBindingsRequest request =
       ListAccessBindingsRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListAccessBindingsResponse response =
         analyticsAdminServiceClient.listAccessBindingsCallable().call(request);
     for (AccessBinding element : response.getAccessBindingsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListAccessBindingsRequest,ListAccessBindingsResponse>

listAccessBindingsPagedCallable()

public final UnaryCallable<ListAccessBindingsRequest,AnalyticsAdminServiceClient.ListAccessBindingsPagedResponse> listAccessBindingsPagedCallable()

Lists all access bindings on an account or property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListAccessBindingsRequest request =
       ListAccessBindingsRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<AccessBinding> future =
       analyticsAdminServiceClient.listAccessBindingsPagedCallable().futureCall(request);
   // Do something.
   for (AccessBinding element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListAccessBindingsRequest,ListAccessBindingsPagedResponse>

listAccountSummaries(ListAccountSummariesRequest request)

public final AnalyticsAdminServiceClient.ListAccountSummariesPagedResponse listAccountSummaries(ListAccountSummariesRequest request)

Returns summaries of all accounts accessible by the caller.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListAccountSummariesRequest request =
       ListAccountSummariesRequest.newBuilder()
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (AccountSummary element :
       analyticsAdminServiceClient.listAccountSummaries(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListAccountSummariesRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
AnalyticsAdminServiceClient.ListAccountSummariesPagedResponse

listAccountSummariesCallable()

public final UnaryCallable<ListAccountSummariesRequest,ListAccountSummariesResponse> listAccountSummariesCallable()

Returns summaries of all accounts accessible by the caller.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListAccountSummariesRequest request =
       ListAccountSummariesRequest.newBuilder()
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListAccountSummariesResponse response =
         analyticsAdminServiceClient.listAccountSummariesCallable().call(request);
     for (AccountSummary element : response.getAccountSummariesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListAccountSummariesRequest,ListAccountSummariesResponse>

listAccountSummariesPagedCallable()

public final UnaryCallable<ListAccountSummariesRequest,AnalyticsAdminServiceClient.ListAccountSummariesPagedResponse> listAccountSummariesPagedCallable()

Returns summaries of all accounts accessible by the caller.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListAccountSummariesRequest request =
       ListAccountSummariesRequest.newBuilder()
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<AccountSummary> future =
       analyticsAdminServiceClient.listAccountSummariesPagedCallable().futureCall(request);
   // Do something.
   for (AccountSummary element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListAccountSummariesRequest,ListAccountSummariesPagedResponse>

listAccounts(ListAccountsRequest request)

public final AnalyticsAdminServiceClient.ListAccountsPagedResponse 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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListAccountsRequest request =
       ListAccountsRequest.newBuilder()
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setShowDeleted(true)
           .build();
   for (Account element : analyticsAdminServiceClient.listAccounts(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListAccountsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
AnalyticsAdminServiceClient.ListAccountsPagedResponse

listAccountsCallable()

public final UnaryCallable<ListAccountsRequest,ListAccountsResponse> listAccountsCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListAccountsRequest request =
       ListAccountsRequest.newBuilder()
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setShowDeleted(true)
           .build();
   while (true) {
     ListAccountsResponse response =
         analyticsAdminServiceClient.listAccountsCallable().call(request);
     for (Account element : response.getAccountsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListAccountsRequest,ListAccountsResponse>

listAccountsPagedCallable()

public final UnaryCallable<ListAccountsRequest,AnalyticsAdminServiceClient.ListAccountsPagedResponse> listAccountsPagedCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListAccountsRequest request =
       ListAccountsRequest.newBuilder()
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setShowDeleted(true)
           .build();
   ApiFuture<Account> future =
       analyticsAdminServiceClient.listAccountsPagedCallable().futureCall(request);
   // Do something.
   for (Account element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListAccountsRequest,ListAccountsPagedResponse>
public final AnalyticsAdminServiceClient.ListAdSenseLinksPagedResponse listAdSenseLinks(ListAdSenseLinksRequest request)

Lists AdSenseLinks on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListAdSenseLinksRequest request =
       ListAdSenseLinksRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (AdSenseLink element :
       analyticsAdminServiceClient.listAdSenseLinks(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListAdSenseLinksRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
AnalyticsAdminServiceClient.ListAdSenseLinksPagedResponse
public final AnalyticsAdminServiceClient.ListAdSenseLinksPagedResponse listAdSenseLinks(PropertyName parent)

Lists AdSenseLinks on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   PropertyName parent = PropertyName.of("[PROPERTY]");
   for (AdSenseLink element :
       analyticsAdminServiceClient.listAdSenseLinks(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent PropertyName

Required. Resource name of the parent property. Format: properties/{propertyId} Example: properties/1234

Returns
Type Description
AnalyticsAdminServiceClient.ListAdSenseLinksPagedResponse
public final AnalyticsAdminServiceClient.ListAdSenseLinksPagedResponse listAdSenseLinks(String parent)

Lists AdSenseLinks on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String parent = PropertyName.of("[PROPERTY]").toString();
   for (AdSenseLink element :
       analyticsAdminServiceClient.listAdSenseLinks(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. Resource name of the parent property. Format: properties/{propertyId} Example: properties/1234

Returns
Type Description
AnalyticsAdminServiceClient.ListAdSenseLinksPagedResponse

listAdSenseLinksCallable()

public final UnaryCallable<ListAdSenseLinksRequest,ListAdSenseLinksResponse> listAdSenseLinksCallable()

Lists AdSenseLinks on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListAdSenseLinksRequest request =
       ListAdSenseLinksRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListAdSenseLinksResponse response =
         analyticsAdminServiceClient.listAdSenseLinksCallable().call(request);
     for (AdSenseLink element : response.getAdsenseLinksList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListAdSenseLinksRequest,ListAdSenseLinksResponse>

listAdSenseLinksPagedCallable()

public final UnaryCallable<ListAdSenseLinksRequest,AnalyticsAdminServiceClient.ListAdSenseLinksPagedResponse> listAdSenseLinksPagedCallable()

Lists AdSenseLinks on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListAdSenseLinksRequest request =
       ListAdSenseLinksRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<AdSenseLink> future =
       analyticsAdminServiceClient.listAdSenseLinksPagedCallable().futureCall(request);
   // Do something.
   for (AdSenseLink element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListAdSenseLinksRequest,ListAdSenseLinksPagedResponse>

listAudiences(ListAudiencesRequest request)

public final AnalyticsAdminServiceClient.ListAudiencesPagedResponse listAudiences(ListAudiencesRequest request)

Lists Audiences on a property. Audiences created before 2020 may not be supported. Default audiences will not show filter definitions.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListAudiencesRequest request =
       ListAudiencesRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Audience element : analyticsAdminServiceClient.listAudiences(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListAudiencesRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
AnalyticsAdminServiceClient.ListAudiencesPagedResponse

listAudiences(PropertyName parent)

public final AnalyticsAdminServiceClient.ListAudiencesPagedResponse listAudiences(PropertyName parent)

Lists Audiences on a property. Audiences created before 2020 may not be supported. Default audiences will not show filter definitions.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   PropertyName parent = PropertyName.of("[PROPERTY]");
   for (Audience element : analyticsAdminServiceClient.listAudiences(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent PropertyName

Required. Example format: properties/1234

Returns
Type Description
AnalyticsAdminServiceClient.ListAudiencesPagedResponse

listAudiences(String parent)

public final AnalyticsAdminServiceClient.ListAudiencesPagedResponse listAudiences(String parent)

Lists Audiences on a property. Audiences created before 2020 may not be supported. Default audiences will not show filter definitions.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String parent = PropertyName.of("[PROPERTY]").toString();
   for (Audience element : analyticsAdminServiceClient.listAudiences(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. Example format: properties/1234

Returns
Type Description
AnalyticsAdminServiceClient.ListAudiencesPagedResponse

listAudiencesCallable()

public final UnaryCallable<ListAudiencesRequest,ListAudiencesResponse> listAudiencesCallable()

Lists Audiences on a property. Audiences created before 2020 may not be supported. Default audiences will not show filter definitions.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListAudiencesRequest request =
       ListAudiencesRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListAudiencesResponse response =
         analyticsAdminServiceClient.listAudiencesCallable().call(request);
     for (Audience element : response.getAudiencesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListAudiencesRequest,ListAudiencesResponse>

listAudiencesPagedCallable()

public final UnaryCallable<ListAudiencesRequest,AnalyticsAdminServiceClient.ListAudiencesPagedResponse> listAudiencesPagedCallable()

Lists Audiences on a property. Audiences created before 2020 may not be supported. Default audiences will not show filter definitions.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListAudiencesRequest request =
       ListAudiencesRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Audience> future =
       analyticsAdminServiceClient.listAudiencesPagedCallable().futureCall(request);
   // Do something.
   for (Audience element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListAudiencesRequest,ListAudiencesPagedResponse>
public final AnalyticsAdminServiceClient.ListBigQueryLinksPagedResponse listBigQueryLinks(ListBigQueryLinksRequest request)

Lists BigQuery Links on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListBigQueryLinksRequest request =
       ListBigQueryLinksRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (BigQueryLink element :
       analyticsAdminServiceClient.listBigQueryLinks(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListBigQueryLinksRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
AnalyticsAdminServiceClient.ListBigQueryLinksPagedResponse
public final AnalyticsAdminServiceClient.ListBigQueryLinksPagedResponse listBigQueryLinks(PropertyName parent)

Lists BigQuery Links on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   PropertyName parent = PropertyName.of("[PROPERTY]");
   for (BigQueryLink element :
       analyticsAdminServiceClient.listBigQueryLinks(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent PropertyName

Required. The name of the property to list BigQuery links under. Format: properties/{property_id} Example: properties/1234

Returns
Type Description
AnalyticsAdminServiceClient.ListBigQueryLinksPagedResponse
public final AnalyticsAdminServiceClient.ListBigQueryLinksPagedResponse listBigQueryLinks(String parent)

Lists BigQuery Links on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String parent = PropertyName.of("[PROPERTY]").toString();
   for (BigQueryLink element :
       analyticsAdminServiceClient.listBigQueryLinks(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. The name of the property to list BigQuery links under. Format: properties/{property_id} Example: properties/1234

Returns
Type Description
AnalyticsAdminServiceClient.ListBigQueryLinksPagedResponse

listBigQueryLinksCallable()

public final UnaryCallable<ListBigQueryLinksRequest,ListBigQueryLinksResponse> listBigQueryLinksCallable()

Lists BigQuery Links on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListBigQueryLinksRequest request =
       ListBigQueryLinksRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListBigQueryLinksResponse response =
         analyticsAdminServiceClient.listBigQueryLinksCallable().call(request);
     for (BigQueryLink element : response.getBigqueryLinksList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListBigQueryLinksRequest,ListBigQueryLinksResponse>

listBigQueryLinksPagedCallable()

public final UnaryCallable<ListBigQueryLinksRequest,AnalyticsAdminServiceClient.ListBigQueryLinksPagedResponse> listBigQueryLinksPagedCallable()

Lists BigQuery Links on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListBigQueryLinksRequest request =
       ListBigQueryLinksRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<BigQueryLink> future =
       analyticsAdminServiceClient.listBigQueryLinksPagedCallable().futureCall(request);
   // Do something.
   for (BigQueryLink element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListBigQueryLinksRequest,ListBigQueryLinksPagedResponse>

listCalculatedMetrics(ListCalculatedMetricsRequest request)

public final AnalyticsAdminServiceClient.ListCalculatedMetricsPagedResponse listCalculatedMetrics(ListCalculatedMetricsRequest request)

Lists CalculatedMetrics on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListCalculatedMetricsRequest request =
       ListCalculatedMetricsRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (CalculatedMetric element :
       analyticsAdminServiceClient.listCalculatedMetrics(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListCalculatedMetricsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
AnalyticsAdminServiceClient.ListCalculatedMetricsPagedResponse

listCalculatedMetrics(PropertyName parent)

public final AnalyticsAdminServiceClient.ListCalculatedMetricsPagedResponse listCalculatedMetrics(PropertyName parent)

Lists CalculatedMetrics on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   PropertyName parent = PropertyName.of("[PROPERTY]");
   for (CalculatedMetric element :
       analyticsAdminServiceClient.listCalculatedMetrics(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent PropertyName

Required. Example format: properties/1234

Returns
Type Description
AnalyticsAdminServiceClient.ListCalculatedMetricsPagedResponse

listCalculatedMetrics(String parent)

public final AnalyticsAdminServiceClient.ListCalculatedMetricsPagedResponse listCalculatedMetrics(String parent)

Lists CalculatedMetrics on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String parent = PropertyName.of("[PROPERTY]").toString();
   for (CalculatedMetric element :
       analyticsAdminServiceClient.listCalculatedMetrics(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. Example format: properties/1234

Returns
Type Description
AnalyticsAdminServiceClient.ListCalculatedMetricsPagedResponse

listCalculatedMetricsCallable()

public final UnaryCallable<ListCalculatedMetricsRequest,ListCalculatedMetricsResponse> listCalculatedMetricsCallable()

Lists CalculatedMetrics on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListCalculatedMetricsRequest request =
       ListCalculatedMetricsRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListCalculatedMetricsResponse response =
         analyticsAdminServiceClient.listCalculatedMetricsCallable().call(request);
     for (CalculatedMetric element : response.getCalculatedMetricsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListCalculatedMetricsRequest,ListCalculatedMetricsResponse>

listCalculatedMetricsPagedCallable()

public final UnaryCallable<ListCalculatedMetricsRequest,AnalyticsAdminServiceClient.ListCalculatedMetricsPagedResponse> listCalculatedMetricsPagedCallable()

Lists CalculatedMetrics on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListCalculatedMetricsRequest request =
       ListCalculatedMetricsRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<CalculatedMetric> future =
       analyticsAdminServiceClient.listCalculatedMetricsPagedCallable().futureCall(request);
   // Do something.
   for (CalculatedMetric element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListCalculatedMetricsRequest,ListCalculatedMetricsPagedResponse>

listChannelGroups(ListChannelGroupsRequest request)

public final AnalyticsAdminServiceClient.ListChannelGroupsPagedResponse listChannelGroups(ListChannelGroupsRequest request)

Lists ChannelGroups on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListChannelGroupsRequest request =
       ListChannelGroupsRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (ChannelGroup element :
       analyticsAdminServiceClient.listChannelGroups(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListChannelGroupsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
AnalyticsAdminServiceClient.ListChannelGroupsPagedResponse

listChannelGroups(PropertyName parent)

public final AnalyticsAdminServiceClient.ListChannelGroupsPagedResponse listChannelGroups(PropertyName parent)

Lists ChannelGroups on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   PropertyName parent = PropertyName.of("[PROPERTY]");
   for (ChannelGroup element :
       analyticsAdminServiceClient.listChannelGroups(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent PropertyName

Required. The property for which to list ChannelGroups. Example format: properties/1234

Returns
Type Description
AnalyticsAdminServiceClient.ListChannelGroupsPagedResponse

listChannelGroups(String parent)

public final AnalyticsAdminServiceClient.ListChannelGroupsPagedResponse listChannelGroups(String parent)

Lists ChannelGroups on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String parent = PropertyName.of("[PROPERTY]").toString();
   for (ChannelGroup element :
       analyticsAdminServiceClient.listChannelGroups(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. The property for which to list ChannelGroups. Example format: properties/1234

Returns
Type Description
AnalyticsAdminServiceClient.ListChannelGroupsPagedResponse

listChannelGroupsCallable()

public final UnaryCallable<ListChannelGroupsRequest,ListChannelGroupsResponse> listChannelGroupsCallable()

Lists ChannelGroups on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListChannelGroupsRequest request =
       ListChannelGroupsRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListChannelGroupsResponse response =
         analyticsAdminServiceClient.listChannelGroupsCallable().call(request);
     for (ChannelGroup element : response.getChannelGroupsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListChannelGroupsRequest,ListChannelGroupsResponse>

listChannelGroupsPagedCallable()

public final UnaryCallable<ListChannelGroupsRequest,AnalyticsAdminServiceClient.ListChannelGroupsPagedResponse> listChannelGroupsPagedCallable()

Lists ChannelGroups on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListChannelGroupsRequest request =
       ListChannelGroupsRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<ChannelGroup> future =
       analyticsAdminServiceClient.listChannelGroupsPagedCallable().futureCall(request);
   // Do something.
   for (ChannelGroup element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListChannelGroupsRequest,ListChannelGroupsPagedResponse>

listConnectedSiteTags(ListConnectedSiteTagsRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListConnectedSiteTagsRequest request =
       ListConnectedSiteTagsRequest.newBuilder().setProperty("property-993141291").build();
   ListConnectedSiteTagsResponse response =
       analyticsAdminServiceClient.listConnectedSiteTags(request);
 }
 
Parameter
Name Description
request ListConnectedSiteTagsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
ListConnectedSiteTagsResponse

listConnectedSiteTagsCallable()

public final UnaryCallable<ListConnectedSiteTagsRequest,ListConnectedSiteTagsResponse> listConnectedSiteTagsCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListConnectedSiteTagsRequest request =
       ListConnectedSiteTagsRequest.newBuilder().setProperty("property-993141291").build();
   ApiFuture<ListConnectedSiteTagsResponse> future =
       analyticsAdminServiceClient.listConnectedSiteTagsCallable().futureCall(request);
   // Do something.
   ListConnectedSiteTagsResponse response = future.get();
 }
 
Returns
Type Description
UnaryCallable<ListConnectedSiteTagsRequest,ListConnectedSiteTagsResponse>

listConversionEvents(ListConversionEventsRequest request) (deprecated)

public final AnalyticsAdminServiceClient.ListConversionEventsPagedResponse listConversionEvents(ListConversionEventsRequest request)

Deprecated. This method is deprecated and will be removed in the next major version update.

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListConversionEventsRequest request =
       ListConversionEventsRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (ConversionEvent element :
       analyticsAdminServiceClient.listConversionEvents(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListConversionEventsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
AnalyticsAdminServiceClient.ListConversionEventsPagedResponse

listConversionEvents(PropertyName parent) (deprecated)

public final AnalyticsAdminServiceClient.ListConversionEventsPagedResponse listConversionEvents(PropertyName parent)

Deprecated. This method is deprecated and will be removed in the next major version update.

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   PropertyName parent = PropertyName.of("[PROPERTY]");
   for (ConversionEvent element :
       analyticsAdminServiceClient.listConversionEvents(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent PropertyName

Required. The resource name of the parent property. Example: 'properties/123'

Returns
Type Description
AnalyticsAdminServiceClient.ListConversionEventsPagedResponse

listConversionEvents(String parent) (deprecated)

public final AnalyticsAdminServiceClient.ListConversionEventsPagedResponse listConversionEvents(String parent)

Deprecated. This method is deprecated and will be removed in the next major version update.

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String parent = PropertyName.of("[PROPERTY]").toString();
   for (ConversionEvent element :
       analyticsAdminServiceClient.listConversionEvents(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. The resource name of the parent property. Example: 'properties/123'

Returns
Type Description
AnalyticsAdminServiceClient.ListConversionEventsPagedResponse

listConversionEventsCallable() (deprecated)

public final UnaryCallable<ListConversionEventsRequest,ListConversionEventsResponse> listConversionEventsCallable()

Deprecated. This method is deprecated and will be removed in the next major version update.

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListConversionEventsRequest request =
       ListConversionEventsRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListConversionEventsResponse response =
         analyticsAdminServiceClient.listConversionEventsCallable().call(request);
     for (ConversionEvent element : response.getConversionEventsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListConversionEventsRequest,ListConversionEventsResponse>

listConversionEventsPagedCallable() (deprecated)

public final UnaryCallable<ListConversionEventsRequest,AnalyticsAdminServiceClient.ListConversionEventsPagedResponse> listConversionEventsPagedCallable()

Deprecated. This method is deprecated and will be removed in the next major version update.

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListConversionEventsRequest request =
       ListConversionEventsRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<ConversionEvent> future =
       analyticsAdminServiceClient.listConversionEventsPagedCallable().futureCall(request);
   // Do something.
   for (ConversionEvent element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListConversionEventsRequest,ListConversionEventsPagedResponse>

listCustomDimensions(ListCustomDimensionsRequest request)

public final AnalyticsAdminServiceClient.ListCustomDimensionsPagedResponse listCustomDimensions(ListCustomDimensionsRequest request)

Lists CustomDimensions on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListCustomDimensionsRequest request =
       ListCustomDimensionsRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (CustomDimension element :
       analyticsAdminServiceClient.listCustomDimensions(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListCustomDimensionsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
AnalyticsAdminServiceClient.ListCustomDimensionsPagedResponse

listCustomDimensions(PropertyName parent)

public final AnalyticsAdminServiceClient.ListCustomDimensionsPagedResponse listCustomDimensions(PropertyName parent)

Lists CustomDimensions on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   PropertyName parent = PropertyName.of("[PROPERTY]");
   for (CustomDimension element :
       analyticsAdminServiceClient.listCustomDimensions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent PropertyName

Required. Example format: properties/1234

Returns
Type Description
AnalyticsAdminServiceClient.ListCustomDimensionsPagedResponse

listCustomDimensions(String parent)

public final AnalyticsAdminServiceClient.ListCustomDimensionsPagedResponse listCustomDimensions(String parent)

Lists CustomDimensions on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String parent = PropertyName.of("[PROPERTY]").toString();
   for (CustomDimension element :
       analyticsAdminServiceClient.listCustomDimensions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. Example format: properties/1234

Returns
Type Description
AnalyticsAdminServiceClient.ListCustomDimensionsPagedResponse

listCustomDimensionsCallable()

public final UnaryCallable<ListCustomDimensionsRequest,ListCustomDimensionsResponse> listCustomDimensionsCallable()

Lists CustomDimensions on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListCustomDimensionsRequest request =
       ListCustomDimensionsRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListCustomDimensionsResponse response =
         analyticsAdminServiceClient.listCustomDimensionsCallable().call(request);
     for (CustomDimension element : response.getCustomDimensionsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListCustomDimensionsRequest,ListCustomDimensionsResponse>

listCustomDimensionsPagedCallable()

public final UnaryCallable<ListCustomDimensionsRequest,AnalyticsAdminServiceClient.ListCustomDimensionsPagedResponse> listCustomDimensionsPagedCallable()

Lists CustomDimensions on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListCustomDimensionsRequest request =
       ListCustomDimensionsRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<CustomDimension> future =
       analyticsAdminServiceClient.listCustomDimensionsPagedCallable().futureCall(request);
   // Do something.
   for (CustomDimension element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListCustomDimensionsRequest,ListCustomDimensionsPagedResponse>

listCustomMetrics(ListCustomMetricsRequest request)

public final AnalyticsAdminServiceClient.ListCustomMetricsPagedResponse listCustomMetrics(ListCustomMetricsRequest request)

Lists CustomMetrics on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListCustomMetricsRequest request =
       ListCustomMetricsRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (CustomMetric element :
       analyticsAdminServiceClient.listCustomMetrics(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListCustomMetricsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
AnalyticsAdminServiceClient.ListCustomMetricsPagedResponse

listCustomMetrics(PropertyName parent)

public final AnalyticsAdminServiceClient.ListCustomMetricsPagedResponse listCustomMetrics(PropertyName parent)

Lists CustomMetrics on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   PropertyName parent = PropertyName.of("[PROPERTY]");
   for (CustomMetric element :
       analyticsAdminServiceClient.listCustomMetrics(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent PropertyName

Required. Example format: properties/1234

Returns
Type Description
AnalyticsAdminServiceClient.ListCustomMetricsPagedResponse

listCustomMetrics(String parent)

public final AnalyticsAdminServiceClient.ListCustomMetricsPagedResponse listCustomMetrics(String parent)

Lists CustomMetrics on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String parent = PropertyName.of("[PROPERTY]").toString();
   for (CustomMetric element :
       analyticsAdminServiceClient.listCustomMetrics(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. Example format: properties/1234

Returns
Type Description
AnalyticsAdminServiceClient.ListCustomMetricsPagedResponse

listCustomMetricsCallable()

public final UnaryCallable<ListCustomMetricsRequest,ListCustomMetricsResponse> listCustomMetricsCallable()

Lists CustomMetrics on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListCustomMetricsRequest request =
       ListCustomMetricsRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListCustomMetricsResponse response =
         analyticsAdminServiceClient.listCustomMetricsCallable().call(request);
     for (CustomMetric element : response.getCustomMetricsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListCustomMetricsRequest,ListCustomMetricsResponse>

listCustomMetricsPagedCallable()

public final UnaryCallable<ListCustomMetricsRequest,AnalyticsAdminServiceClient.ListCustomMetricsPagedResponse> listCustomMetricsPagedCallable()

Lists CustomMetrics on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListCustomMetricsRequest request =
       ListCustomMetricsRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<CustomMetric> future =
       analyticsAdminServiceClient.listCustomMetricsPagedCallable().futureCall(request);
   // Do something.
   for (CustomMetric element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListCustomMetricsRequest,ListCustomMetricsPagedResponse>

listDataStreams(ListDataStreamsRequest request)

public final AnalyticsAdminServiceClient.ListDataStreamsPagedResponse listDataStreams(ListDataStreamsRequest request)

Lists DataStreams on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListDataStreamsRequest request =
       ListDataStreamsRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (DataStream element : analyticsAdminServiceClient.listDataStreams(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListDataStreamsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
AnalyticsAdminServiceClient.ListDataStreamsPagedResponse

listDataStreams(PropertyName parent)

public final AnalyticsAdminServiceClient.ListDataStreamsPagedResponse listDataStreams(PropertyName parent)

Lists DataStreams on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   PropertyName parent = PropertyName.of("[PROPERTY]");
   for (DataStream element : analyticsAdminServiceClient.listDataStreams(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent PropertyName

Required. Example format: properties/1234

Returns
Type Description
AnalyticsAdminServiceClient.ListDataStreamsPagedResponse

listDataStreams(String parent)

public final AnalyticsAdminServiceClient.ListDataStreamsPagedResponse listDataStreams(String parent)

Lists DataStreams on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String parent = PropertyName.of("[PROPERTY]").toString();
   for (DataStream element : analyticsAdminServiceClient.listDataStreams(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. Example format: properties/1234

Returns
Type Description
AnalyticsAdminServiceClient.ListDataStreamsPagedResponse

listDataStreamsCallable()

public final UnaryCallable<ListDataStreamsRequest,ListDataStreamsResponse> listDataStreamsCallable()

Lists DataStreams on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListDataStreamsRequest request =
       ListDataStreamsRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListDataStreamsResponse response =
         analyticsAdminServiceClient.listDataStreamsCallable().call(request);
     for (DataStream element : response.getDataStreamsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListDataStreamsRequest,ListDataStreamsResponse>

listDataStreamsPagedCallable()

public final UnaryCallable<ListDataStreamsRequest,AnalyticsAdminServiceClient.ListDataStreamsPagedResponse> listDataStreamsPagedCallable()

Lists DataStreams on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListDataStreamsRequest request =
       ListDataStreamsRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<DataStream> future =
       analyticsAdminServiceClient.listDataStreamsPagedCallable().futureCall(request);
   // Do something.
   for (DataStream element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListDataStreamsRequest,ListDataStreamsPagedResponse>

listDisplayVideo360AdvertiserLinkProposals(ListDisplayVideo360AdvertiserLinkProposalsRequest request)

public final AnalyticsAdminServiceClient.ListDisplayVideo360AdvertiserLinkProposalsPagedResponse listDisplayVideo360AdvertiserLinkProposals(ListDisplayVideo360AdvertiserLinkProposalsRequest request)

Lists DisplayVideo360AdvertiserLinkProposals on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListDisplayVideo360AdvertiserLinkProposalsRequest request =
       ListDisplayVideo360AdvertiserLinkProposalsRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (DisplayVideo360AdvertiserLinkProposal element :
       analyticsAdminServiceClient
           .listDisplayVideo360AdvertiserLinkProposals(request)
           .iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListDisplayVideo360AdvertiserLinkProposalsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
AnalyticsAdminServiceClient.ListDisplayVideo360AdvertiserLinkProposalsPagedResponse

listDisplayVideo360AdvertiserLinkProposals(PropertyName parent)

public final AnalyticsAdminServiceClient.ListDisplayVideo360AdvertiserLinkProposalsPagedResponse listDisplayVideo360AdvertiserLinkProposals(PropertyName parent)

Lists DisplayVideo360AdvertiserLinkProposals on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   PropertyName parent = PropertyName.of("[PROPERTY]");
   for (DisplayVideo360AdvertiserLinkProposal element :
       analyticsAdminServiceClient
           .listDisplayVideo360AdvertiserLinkProposals(parent)
           .iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent PropertyName

Required. Example format: properties/1234

Returns
Type Description
AnalyticsAdminServiceClient.ListDisplayVideo360AdvertiserLinkProposalsPagedResponse

listDisplayVideo360AdvertiserLinkProposals(String parent)

public final AnalyticsAdminServiceClient.ListDisplayVideo360AdvertiserLinkProposalsPagedResponse listDisplayVideo360AdvertiserLinkProposals(String parent)

Lists DisplayVideo360AdvertiserLinkProposals on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String parent = PropertyName.of("[PROPERTY]").toString();
   for (DisplayVideo360AdvertiserLinkProposal element :
       analyticsAdminServiceClient
           .listDisplayVideo360AdvertiserLinkProposals(parent)
           .iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. Example format: properties/1234

Returns
Type Description
AnalyticsAdminServiceClient.ListDisplayVideo360AdvertiserLinkProposalsPagedResponse

listDisplayVideo360AdvertiserLinkProposalsCallable()

public final UnaryCallable<ListDisplayVideo360AdvertiserLinkProposalsRequest,ListDisplayVideo360AdvertiserLinkProposalsResponse> listDisplayVideo360AdvertiserLinkProposalsCallable()

Lists DisplayVideo360AdvertiserLinkProposals on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListDisplayVideo360AdvertiserLinkProposalsRequest request =
       ListDisplayVideo360AdvertiserLinkProposalsRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListDisplayVideo360AdvertiserLinkProposalsResponse response =
         analyticsAdminServiceClient
             .listDisplayVideo360AdvertiserLinkProposalsCallable()
             .call(request);
     for (DisplayVideo360AdvertiserLinkProposal element :
         response.getDisplayVideo360AdvertiserLinkProposalsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListDisplayVideo360AdvertiserLinkProposalsRequest,ListDisplayVideo360AdvertiserLinkProposalsResponse>

listDisplayVideo360AdvertiserLinkProposalsPagedCallable()

public final UnaryCallable<ListDisplayVideo360AdvertiserLinkProposalsRequest,AnalyticsAdminServiceClient.ListDisplayVideo360AdvertiserLinkProposalsPagedResponse> listDisplayVideo360AdvertiserLinkProposalsPagedCallable()

Lists DisplayVideo360AdvertiserLinkProposals on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListDisplayVideo360AdvertiserLinkProposalsRequest request =
       ListDisplayVideo360AdvertiserLinkProposalsRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<DisplayVideo360AdvertiserLinkProposal> future =
       analyticsAdminServiceClient
           .listDisplayVideo360AdvertiserLinkProposalsPagedCallable()
           .futureCall(request);
   // Do something.
   for (DisplayVideo360AdvertiserLinkProposal element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListDisplayVideo360AdvertiserLinkProposalsRequest,ListDisplayVideo360AdvertiserLinkProposalsPagedResponse>
public final AnalyticsAdminServiceClient.ListDisplayVideo360AdvertiserLinksPagedResponse listDisplayVideo360AdvertiserLinks(ListDisplayVideo360AdvertiserLinksRequest request)

Lists all DisplayVideo360AdvertiserLinks on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListDisplayVideo360AdvertiserLinksRequest request =
       ListDisplayVideo360AdvertiserLinksRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (DisplayVideo360AdvertiserLink element :
       analyticsAdminServiceClient.listDisplayVideo360AdvertiserLinks(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListDisplayVideo360AdvertiserLinksRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
AnalyticsAdminServiceClient.ListDisplayVideo360AdvertiserLinksPagedResponse
public final AnalyticsAdminServiceClient.ListDisplayVideo360AdvertiserLinksPagedResponse listDisplayVideo360AdvertiserLinks(PropertyName parent)

Lists all DisplayVideo360AdvertiserLinks on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   PropertyName parent = PropertyName.of("[PROPERTY]");
   for (DisplayVideo360AdvertiserLink element :
       analyticsAdminServiceClient.listDisplayVideo360AdvertiserLinks(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent PropertyName

Required. Example format: properties/1234

Returns
Type Description
AnalyticsAdminServiceClient.ListDisplayVideo360AdvertiserLinksPagedResponse
public final AnalyticsAdminServiceClient.ListDisplayVideo360AdvertiserLinksPagedResponse listDisplayVideo360AdvertiserLinks(String parent)

Lists all DisplayVideo360AdvertiserLinks on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String parent = PropertyName.of("[PROPERTY]").toString();
   for (DisplayVideo360AdvertiserLink element :
       analyticsAdminServiceClient.listDisplayVideo360AdvertiserLinks(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. Example format: properties/1234

Returns
Type Description
AnalyticsAdminServiceClient.ListDisplayVideo360AdvertiserLinksPagedResponse

listDisplayVideo360AdvertiserLinksCallable()

public final UnaryCallable<ListDisplayVideo360AdvertiserLinksRequest,ListDisplayVideo360AdvertiserLinksResponse> listDisplayVideo360AdvertiserLinksCallable()

Lists all DisplayVideo360AdvertiserLinks on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListDisplayVideo360AdvertiserLinksRequest request =
       ListDisplayVideo360AdvertiserLinksRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListDisplayVideo360AdvertiserLinksResponse response =
         analyticsAdminServiceClient.listDisplayVideo360AdvertiserLinksCallable().call(request);
     for (DisplayVideo360AdvertiserLink element :
         response.getDisplayVideo360AdvertiserLinksList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListDisplayVideo360AdvertiserLinksRequest,ListDisplayVideo360AdvertiserLinksResponse>

listDisplayVideo360AdvertiserLinksPagedCallable()

public final UnaryCallable<ListDisplayVideo360AdvertiserLinksRequest,AnalyticsAdminServiceClient.ListDisplayVideo360AdvertiserLinksPagedResponse> listDisplayVideo360AdvertiserLinksPagedCallable()

Lists all DisplayVideo360AdvertiserLinks on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListDisplayVideo360AdvertiserLinksRequest request =
       ListDisplayVideo360AdvertiserLinksRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<DisplayVideo360AdvertiserLink> future =
       analyticsAdminServiceClient
           .listDisplayVideo360AdvertiserLinksPagedCallable()
           .futureCall(request);
   // Do something.
   for (DisplayVideo360AdvertiserLink element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListDisplayVideo360AdvertiserLinksRequest,ListDisplayVideo360AdvertiserLinksPagedResponse>

listEventCreateRules(DataStreamName parent)

public final AnalyticsAdminServiceClient.ListEventCreateRulesPagedResponse listEventCreateRules(DataStreamName parent)

Lists EventCreateRules on a web data stream.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DataStreamName parent = DataStreamName.of("[PROPERTY]", "[DATA_STREAM]");
   for (EventCreateRule element :
       analyticsAdminServiceClient.listEventCreateRules(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent DataStreamName

Required. Example format: properties/123/dataStreams/456

Returns
Type Description
AnalyticsAdminServiceClient.ListEventCreateRulesPagedResponse

listEventCreateRules(ListEventCreateRulesRequest request)

public final AnalyticsAdminServiceClient.ListEventCreateRulesPagedResponse listEventCreateRules(ListEventCreateRulesRequest request)

Lists EventCreateRules on a web data stream.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListEventCreateRulesRequest request =
       ListEventCreateRulesRequest.newBuilder()
           .setParent(DataStreamName.of("[PROPERTY]", "[DATA_STREAM]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (EventCreateRule element :
       analyticsAdminServiceClient.listEventCreateRules(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListEventCreateRulesRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
AnalyticsAdminServiceClient.ListEventCreateRulesPagedResponse

listEventCreateRules(String parent)

public final AnalyticsAdminServiceClient.ListEventCreateRulesPagedResponse listEventCreateRules(String parent)

Lists EventCreateRules on a web data stream.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String parent = DataStreamName.of("[PROPERTY]", "[DATA_STREAM]").toString();
   for (EventCreateRule element :
       analyticsAdminServiceClient.listEventCreateRules(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. Example format: properties/123/dataStreams/456

Returns
Type Description
AnalyticsAdminServiceClient.ListEventCreateRulesPagedResponse

listEventCreateRulesCallable()

public final UnaryCallable<ListEventCreateRulesRequest,ListEventCreateRulesResponse> listEventCreateRulesCallable()

Lists EventCreateRules on a web data stream.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListEventCreateRulesRequest request =
       ListEventCreateRulesRequest.newBuilder()
           .setParent(DataStreamName.of("[PROPERTY]", "[DATA_STREAM]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListEventCreateRulesResponse response =
         analyticsAdminServiceClient.listEventCreateRulesCallable().call(request);
     for (EventCreateRule element : response.getEventCreateRulesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListEventCreateRulesRequest,ListEventCreateRulesResponse>

listEventCreateRulesPagedCallable()

public final UnaryCallable<ListEventCreateRulesRequest,AnalyticsAdminServiceClient.ListEventCreateRulesPagedResponse> listEventCreateRulesPagedCallable()

Lists EventCreateRules on a web data stream.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListEventCreateRulesRequest request =
       ListEventCreateRulesRequest.newBuilder()
           .setParent(DataStreamName.of("[PROPERTY]", "[DATA_STREAM]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<EventCreateRule> future =
       analyticsAdminServiceClient.listEventCreateRulesPagedCallable().futureCall(request);
   // Do something.
   for (EventCreateRule element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListEventCreateRulesRequest,ListEventCreateRulesPagedResponse>

listEventEditRules(DataStreamName parent)

public final AnalyticsAdminServiceClient.ListEventEditRulesPagedResponse listEventEditRules(DataStreamName parent)

Lists EventEditRules on a web data stream.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DataStreamName parent = DataStreamName.of("[PROPERTY]", "[DATA_STREAM]");
   for (EventEditRule element :
       analyticsAdminServiceClient.listEventEditRules(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent DataStreamName

Required. Example format: properties/123/dataStreams/456

Returns
Type Description
AnalyticsAdminServiceClient.ListEventEditRulesPagedResponse

listEventEditRules(ListEventEditRulesRequest request)

public final AnalyticsAdminServiceClient.ListEventEditRulesPagedResponse listEventEditRules(ListEventEditRulesRequest request)

Lists EventEditRules on a web data stream.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListEventEditRulesRequest request =
       ListEventEditRulesRequest.newBuilder()
           .setParent(DataStreamName.of("[PROPERTY]", "[DATA_STREAM]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (EventEditRule element :
       analyticsAdminServiceClient.listEventEditRules(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListEventEditRulesRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
AnalyticsAdminServiceClient.ListEventEditRulesPagedResponse

listEventEditRules(String parent)

public final AnalyticsAdminServiceClient.ListEventEditRulesPagedResponse listEventEditRules(String parent)

Lists EventEditRules on a web data stream.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String parent = DataStreamName.of("[PROPERTY]", "[DATA_STREAM]").toString();
   for (EventEditRule element :
       analyticsAdminServiceClient.listEventEditRules(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. Example format: properties/123/dataStreams/456

Returns
Type Description
AnalyticsAdminServiceClient.ListEventEditRulesPagedResponse

listEventEditRulesCallable()

public final UnaryCallable<ListEventEditRulesRequest,ListEventEditRulesResponse> listEventEditRulesCallable()

Lists EventEditRules on a web data stream.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListEventEditRulesRequest request =
       ListEventEditRulesRequest.newBuilder()
           .setParent(DataStreamName.of("[PROPERTY]", "[DATA_STREAM]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListEventEditRulesResponse response =
         analyticsAdminServiceClient.listEventEditRulesCallable().call(request);
     for (EventEditRule element : response.getEventEditRulesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListEventEditRulesRequest,ListEventEditRulesResponse>

listEventEditRulesPagedCallable()

public final UnaryCallable<ListEventEditRulesRequest,AnalyticsAdminServiceClient.ListEventEditRulesPagedResponse> listEventEditRulesPagedCallable()

Lists EventEditRules on a web data stream.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListEventEditRulesRequest request =
       ListEventEditRulesRequest.newBuilder()
           .setParent(DataStreamName.of("[PROPERTY]", "[DATA_STREAM]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<EventEditRule> future =
       analyticsAdminServiceClient.listEventEditRulesPagedCallable().futureCall(request);
   // Do something.
   for (EventEditRule element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListEventEditRulesRequest,ListEventEditRulesPagedResponse>

listExpandedDataSets(ListExpandedDataSetsRequest request)

public final AnalyticsAdminServiceClient.ListExpandedDataSetsPagedResponse listExpandedDataSets(ListExpandedDataSetsRequest request)

Lists ExpandedDataSets on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListExpandedDataSetsRequest request =
       ListExpandedDataSetsRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (ExpandedDataSet element :
       analyticsAdminServiceClient.listExpandedDataSets(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListExpandedDataSetsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
AnalyticsAdminServiceClient.ListExpandedDataSetsPagedResponse

listExpandedDataSets(PropertyName parent)

public final AnalyticsAdminServiceClient.ListExpandedDataSetsPagedResponse listExpandedDataSets(PropertyName parent)

Lists ExpandedDataSets on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   PropertyName parent = PropertyName.of("[PROPERTY]");
   for (ExpandedDataSet element :
       analyticsAdminServiceClient.listExpandedDataSets(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent PropertyName

Required. Example format: properties/1234

Returns
Type Description
AnalyticsAdminServiceClient.ListExpandedDataSetsPagedResponse

listExpandedDataSets(String parent)

public final AnalyticsAdminServiceClient.ListExpandedDataSetsPagedResponse listExpandedDataSets(String parent)

Lists ExpandedDataSets on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String parent = PropertyName.of("[PROPERTY]").toString();
   for (ExpandedDataSet element :
       analyticsAdminServiceClient.listExpandedDataSets(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. Example format: properties/1234

Returns
Type Description
AnalyticsAdminServiceClient.ListExpandedDataSetsPagedResponse

listExpandedDataSetsCallable()

public final UnaryCallable<ListExpandedDataSetsRequest,ListExpandedDataSetsResponse> listExpandedDataSetsCallable()

Lists ExpandedDataSets on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListExpandedDataSetsRequest request =
       ListExpandedDataSetsRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListExpandedDataSetsResponse response =
         analyticsAdminServiceClient.listExpandedDataSetsCallable().call(request);
     for (ExpandedDataSet element : response.getExpandedDataSetsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListExpandedDataSetsRequest,ListExpandedDataSetsResponse>

listExpandedDataSetsPagedCallable()

public final UnaryCallable<ListExpandedDataSetsRequest,AnalyticsAdminServiceClient.ListExpandedDataSetsPagedResponse> listExpandedDataSetsPagedCallable()

Lists ExpandedDataSets on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListExpandedDataSetsRequest request =
       ListExpandedDataSetsRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<ExpandedDataSet> future =
       analyticsAdminServiceClient.listExpandedDataSetsPagedCallable().futureCall(request);
   // Do something.
   for (ExpandedDataSet element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListExpandedDataSetsRequest,ListExpandedDataSetsPagedResponse>
public final AnalyticsAdminServiceClient.ListFirebaseLinksPagedResponse listFirebaseLinks(ListFirebaseLinksRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListFirebaseLinksRequest request =
       ListFirebaseLinksRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (FirebaseLink element :
       analyticsAdminServiceClient.listFirebaseLinks(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListFirebaseLinksRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
AnalyticsAdminServiceClient.ListFirebaseLinksPagedResponse
public final AnalyticsAdminServiceClient.ListFirebaseLinksPagedResponse listFirebaseLinks(PropertyName parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   PropertyName parent = PropertyName.of("[PROPERTY]");
   for (FirebaseLink element :
       analyticsAdminServiceClient.listFirebaseLinks(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent PropertyName

Required. Format: properties/{property_id}

Example: properties/1234

Returns
Type Description
AnalyticsAdminServiceClient.ListFirebaseLinksPagedResponse
public final AnalyticsAdminServiceClient.ListFirebaseLinksPagedResponse listFirebaseLinks(String parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String parent = PropertyName.of("[PROPERTY]").toString();
   for (FirebaseLink element :
       analyticsAdminServiceClient.listFirebaseLinks(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. Format: properties/{property_id}

Example: properties/1234

Returns
Type Description
AnalyticsAdminServiceClient.ListFirebaseLinksPagedResponse

listFirebaseLinksCallable()

public final UnaryCallable<ListFirebaseLinksRequest,ListFirebaseLinksResponse> listFirebaseLinksCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListFirebaseLinksRequest request =
       ListFirebaseLinksRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListFirebaseLinksResponse response =
         analyticsAdminServiceClient.listFirebaseLinksCallable().call(request);
     for (FirebaseLink element : response.getFirebaseLinksList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListFirebaseLinksRequest,ListFirebaseLinksResponse>

listFirebaseLinksPagedCallable()

public final UnaryCallable<ListFirebaseLinksRequest,AnalyticsAdminServiceClient.ListFirebaseLinksPagedResponse> listFirebaseLinksPagedCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListFirebaseLinksRequest request =
       ListFirebaseLinksRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<FirebaseLink> future =
       analyticsAdminServiceClient.listFirebaseLinksPagedCallable().futureCall(request);
   // Do something.
   for (FirebaseLink element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListFirebaseLinksRequest,ListFirebaseLinksPagedResponse>
public final AnalyticsAdminServiceClient.ListGoogleAdsLinksPagedResponse listGoogleAdsLinks(ListGoogleAdsLinksRequest request)

Lists GoogleAdsLinks on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListGoogleAdsLinksRequest request =
       ListGoogleAdsLinksRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (GoogleAdsLink element :
       analyticsAdminServiceClient.listGoogleAdsLinks(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListGoogleAdsLinksRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
AnalyticsAdminServiceClient.ListGoogleAdsLinksPagedResponse
public final AnalyticsAdminServiceClient.ListGoogleAdsLinksPagedResponse listGoogleAdsLinks(PropertyName parent)

Lists GoogleAdsLinks on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   PropertyName parent = PropertyName.of("[PROPERTY]");
   for (GoogleAdsLink element :
       analyticsAdminServiceClient.listGoogleAdsLinks(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent PropertyName

Required. Example format: properties/1234

Returns
Type Description
AnalyticsAdminServiceClient.ListGoogleAdsLinksPagedResponse
public final AnalyticsAdminServiceClient.ListGoogleAdsLinksPagedResponse listGoogleAdsLinks(String parent)

Lists GoogleAdsLinks on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String parent = PropertyName.of("[PROPERTY]").toString();
   for (GoogleAdsLink element :
       analyticsAdminServiceClient.listGoogleAdsLinks(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. Example format: properties/1234

Returns
Type Description
AnalyticsAdminServiceClient.ListGoogleAdsLinksPagedResponse

listGoogleAdsLinksCallable()

public final UnaryCallable<ListGoogleAdsLinksRequest,ListGoogleAdsLinksResponse> listGoogleAdsLinksCallable()

Lists GoogleAdsLinks on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListGoogleAdsLinksRequest request =
       ListGoogleAdsLinksRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListGoogleAdsLinksResponse response =
         analyticsAdminServiceClient.listGoogleAdsLinksCallable().call(request);
     for (GoogleAdsLink element : response.getGoogleAdsLinksList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListGoogleAdsLinksRequest,ListGoogleAdsLinksResponse>

listGoogleAdsLinksPagedCallable()

public final UnaryCallable<ListGoogleAdsLinksRequest,AnalyticsAdminServiceClient.ListGoogleAdsLinksPagedResponse> listGoogleAdsLinksPagedCallable()

Lists GoogleAdsLinks on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListGoogleAdsLinksRequest request =
       ListGoogleAdsLinksRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<GoogleAdsLink> future =
       analyticsAdminServiceClient.listGoogleAdsLinksPagedCallable().futureCall(request);
   // Do something.
   for (GoogleAdsLink element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListGoogleAdsLinksRequest,ListGoogleAdsLinksPagedResponse>

listKeyEvents(ListKeyEventsRequest request)

public final AnalyticsAdminServiceClient.ListKeyEventsPagedResponse listKeyEvents(ListKeyEventsRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListKeyEventsRequest request =
       ListKeyEventsRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (KeyEvent element : analyticsAdminServiceClient.listKeyEvents(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListKeyEventsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
AnalyticsAdminServiceClient.ListKeyEventsPagedResponse

listKeyEvents(PropertyName parent)

public final AnalyticsAdminServiceClient.ListKeyEventsPagedResponse listKeyEvents(PropertyName parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   PropertyName parent = PropertyName.of("[PROPERTY]");
   for (KeyEvent element : analyticsAdminServiceClient.listKeyEvents(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent PropertyName

Required. The resource name of the parent property. Example: 'properties/123'

Returns
Type Description
AnalyticsAdminServiceClient.ListKeyEventsPagedResponse

listKeyEvents(String parent)

public final AnalyticsAdminServiceClient.ListKeyEventsPagedResponse listKeyEvents(String parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String parent = PropertyName.of("[PROPERTY]").toString();
   for (KeyEvent element : analyticsAdminServiceClient.listKeyEvents(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. The resource name of the parent property. Example: 'properties/123'

Returns
Type Description
AnalyticsAdminServiceClient.ListKeyEventsPagedResponse

listKeyEventsCallable()

public final UnaryCallable<ListKeyEventsRequest,ListKeyEventsResponse> listKeyEventsCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListKeyEventsRequest request =
       ListKeyEventsRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListKeyEventsResponse response =
         analyticsAdminServiceClient.listKeyEventsCallable().call(request);
     for (KeyEvent element : response.getKeyEventsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListKeyEventsRequest,ListKeyEventsResponse>

listKeyEventsPagedCallable()

public final UnaryCallable<ListKeyEventsRequest,AnalyticsAdminServiceClient.ListKeyEventsPagedResponse> listKeyEventsPagedCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListKeyEventsRequest request =
       ListKeyEventsRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<KeyEvent> future =
       analyticsAdminServiceClient.listKeyEventsPagedCallable().futureCall(request);
   // Do something.
   for (KeyEvent element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListKeyEventsRequest,ListKeyEventsPagedResponse>

listMeasurementProtocolSecrets(DataStreamName parent)

public final AnalyticsAdminServiceClient.ListMeasurementProtocolSecretsPagedResponse listMeasurementProtocolSecrets(DataStreamName parent)

Returns child MeasurementProtocolSecrets under the specified parent Property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DataStreamName parent = DataStreamName.of("[PROPERTY]", "[DATA_STREAM]");
   for (MeasurementProtocolSecret element :
       analyticsAdminServiceClient.listMeasurementProtocolSecrets(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent DataStreamName

Required. The resource name of the parent stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets

Returns
Type Description
AnalyticsAdminServiceClient.ListMeasurementProtocolSecretsPagedResponse

listMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest request)

public final AnalyticsAdminServiceClient.ListMeasurementProtocolSecretsPagedResponse listMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest request)

Returns child MeasurementProtocolSecrets under the specified parent Property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListMeasurementProtocolSecretsRequest request =
       ListMeasurementProtocolSecretsRequest.newBuilder()
           .setParent(DataStreamName.of("[PROPERTY]", "[DATA_STREAM]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (MeasurementProtocolSecret element :
       analyticsAdminServiceClient.listMeasurementProtocolSecrets(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListMeasurementProtocolSecretsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
AnalyticsAdminServiceClient.ListMeasurementProtocolSecretsPagedResponse

listMeasurementProtocolSecrets(String parent)

public final AnalyticsAdminServiceClient.ListMeasurementProtocolSecretsPagedResponse listMeasurementProtocolSecrets(String parent)

Returns child MeasurementProtocolSecrets under the specified parent Property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String parent = DataStreamName.of("[PROPERTY]", "[DATA_STREAM]").toString();
   for (MeasurementProtocolSecret element :
       analyticsAdminServiceClient.listMeasurementProtocolSecrets(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. The resource name of the parent stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets

Returns
Type Description
AnalyticsAdminServiceClient.ListMeasurementProtocolSecretsPagedResponse

listMeasurementProtocolSecretsCallable()

public final UnaryCallable<ListMeasurementProtocolSecretsRequest,ListMeasurementProtocolSecretsResponse> listMeasurementProtocolSecretsCallable()

Returns child MeasurementProtocolSecrets under the specified parent Property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListMeasurementProtocolSecretsRequest request =
       ListMeasurementProtocolSecretsRequest.newBuilder()
           .setParent(DataStreamName.of("[PROPERTY]", "[DATA_STREAM]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListMeasurementProtocolSecretsResponse response =
         analyticsAdminServiceClient.listMeasurementProtocolSecretsCallable().call(request);
     for (MeasurementProtocolSecret element : response.getMeasurementProtocolSecretsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListMeasurementProtocolSecretsRequest,ListMeasurementProtocolSecretsResponse>

listMeasurementProtocolSecretsPagedCallable()

public final UnaryCallable<ListMeasurementProtocolSecretsRequest,AnalyticsAdminServiceClient.ListMeasurementProtocolSecretsPagedResponse> listMeasurementProtocolSecretsPagedCallable()

Returns child MeasurementProtocolSecrets under the specified parent Property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListMeasurementProtocolSecretsRequest request =
       ListMeasurementProtocolSecretsRequest.newBuilder()
           .setParent(DataStreamName.of("[PROPERTY]", "[DATA_STREAM]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<MeasurementProtocolSecret> future =
       analyticsAdminServiceClient
           .listMeasurementProtocolSecretsPagedCallable()
           .futureCall(request);
   // Do something.
   for (MeasurementProtocolSecret element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListMeasurementProtocolSecretsRequest,ListMeasurementProtocolSecretsPagedResponse>

listProperties(ListPropertiesRequest request)

public final AnalyticsAdminServiceClient.ListPropertiesPagedResponse 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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListPropertiesRequest request =
       ListPropertiesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setShowDeleted(true)
           .build();
   for (Property element : analyticsAdminServiceClient.listProperties(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListPropertiesRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
AnalyticsAdminServiceClient.ListPropertiesPagedResponse

listPropertiesCallable()

public final UnaryCallable<ListPropertiesRequest,ListPropertiesResponse> listPropertiesCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListPropertiesRequest request =
       ListPropertiesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setShowDeleted(true)
           .build();
   while (true) {
     ListPropertiesResponse response =
         analyticsAdminServiceClient.listPropertiesCallable().call(request);
     for (Property element : response.getPropertiesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListPropertiesRequest,ListPropertiesResponse>

listPropertiesPagedCallable()

public final UnaryCallable<ListPropertiesRequest,AnalyticsAdminServiceClient.ListPropertiesPagedResponse> listPropertiesPagedCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListPropertiesRequest request =
       ListPropertiesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setShowDeleted(true)
           .build();
   ApiFuture<Property> future =
       analyticsAdminServiceClient.listPropertiesPagedCallable().futureCall(request);
   // Do something.
   for (Property element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListPropertiesRequest,ListPropertiesPagedResponse>
public final AnalyticsAdminServiceClient.ListRollupPropertySourceLinksPagedResponse 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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListRollupPropertySourceLinksRequest request =
       ListRollupPropertySourceLinksRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (RollupPropertySourceLink element :
       analyticsAdminServiceClient.listRollupPropertySourceLinks(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListRollupPropertySourceLinksRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
AnalyticsAdminServiceClient.ListRollupPropertySourceLinksPagedResponse
public final AnalyticsAdminServiceClient.ListRollupPropertySourceLinksPagedResponse listRollupPropertySourceLinks(PropertyName parent)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   PropertyName parent = PropertyName.of("[PROPERTY]");
   for (RollupPropertySourceLink element :
       analyticsAdminServiceClient.listRollupPropertySourceLinks(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent PropertyName

Required. The name of the roll-up property to list roll-up property source links under. Format: properties/{property_id} Example: properties/1234

Returns
Type Description
AnalyticsAdminServiceClient.ListRollupPropertySourceLinksPagedResponse
public final AnalyticsAdminServiceClient.ListRollupPropertySourceLinksPagedResponse listRollupPropertySourceLinks(String parent)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String parent = PropertyName.of("[PROPERTY]").toString();
   for (RollupPropertySourceLink element :
       analyticsAdminServiceClient.listRollupPropertySourceLinks(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. The name of the roll-up property to list roll-up property source links under. Format: properties/{property_id} Example: properties/1234

Returns
Type Description
AnalyticsAdminServiceClient.ListRollupPropertySourceLinksPagedResponse

listRollupPropertySourceLinksCallable()

public final UnaryCallable<ListRollupPropertySourceLinksRequest,ListRollupPropertySourceLinksResponse> listRollupPropertySourceLinksCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListRollupPropertySourceLinksRequest request =
       ListRollupPropertySourceLinksRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListRollupPropertySourceLinksResponse response =
         analyticsAdminServiceClient.listRollupPropertySourceLinksCallable().call(request);
     for (RollupPropertySourceLink element : response.getRollupPropertySourceLinksList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListRollupPropertySourceLinksRequest,ListRollupPropertySourceLinksResponse>

listRollupPropertySourceLinksPagedCallable()

public final UnaryCallable<ListRollupPropertySourceLinksRequest,AnalyticsAdminServiceClient.ListRollupPropertySourceLinksPagedResponse> listRollupPropertySourceLinksPagedCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListRollupPropertySourceLinksRequest request =
       ListRollupPropertySourceLinksRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<RollupPropertySourceLink> future =
       analyticsAdminServiceClient
           .listRollupPropertySourceLinksPagedCallable()
           .futureCall(request);
   // Do something.
   for (RollupPropertySourceLink element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListRollupPropertySourceLinksRequest,ListRollupPropertySourceLinksPagedResponse>

listSKAdNetworkConversionValueSchemas(DataStreamName parent)

public final AnalyticsAdminServiceClient.ListSKAdNetworkConversionValueSchemasPagedResponse listSKAdNetworkConversionValueSchemas(DataStreamName parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DataStreamName parent = DataStreamName.of("[PROPERTY]", "[DATA_STREAM]");
   for (SKAdNetworkConversionValueSchema element :
       analyticsAdminServiceClient.listSKAdNetworkConversionValueSchemas(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent DataStreamName

Required. The DataStream resource to list schemas for. Format: properties/{property_id}/dataStreams/{dataStream} Example: properties/1234/dataStreams/5678

Returns
Type Description
AnalyticsAdminServiceClient.ListSKAdNetworkConversionValueSchemasPagedResponse

listSKAdNetworkConversionValueSchemas(ListSKAdNetworkConversionValueSchemasRequest request)

public final AnalyticsAdminServiceClient.ListSKAdNetworkConversionValueSchemasPagedResponse listSKAdNetworkConversionValueSchemas(ListSKAdNetworkConversionValueSchemasRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListSKAdNetworkConversionValueSchemasRequest request =
       ListSKAdNetworkConversionValueSchemasRequest.newBuilder()
           .setParent(DataStreamName.of("[PROPERTY]", "[DATA_STREAM]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (SKAdNetworkConversionValueSchema element :
       analyticsAdminServiceClient.listSKAdNetworkConversionValueSchemas(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListSKAdNetworkConversionValueSchemasRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
AnalyticsAdminServiceClient.ListSKAdNetworkConversionValueSchemasPagedResponse

listSKAdNetworkConversionValueSchemas(String parent)

public final AnalyticsAdminServiceClient.ListSKAdNetworkConversionValueSchemasPagedResponse listSKAdNetworkConversionValueSchemas(String parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String parent = DataStreamName.of("[PROPERTY]", "[DATA_STREAM]").toString();
   for (SKAdNetworkConversionValueSchema element :
       analyticsAdminServiceClient.listSKAdNetworkConversionValueSchemas(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. The DataStream resource to list schemas for. Format: properties/{property_id}/dataStreams/{dataStream} Example: properties/1234/dataStreams/5678

Returns
Type Description
AnalyticsAdminServiceClient.ListSKAdNetworkConversionValueSchemasPagedResponse

listSKAdNetworkConversionValueSchemasCallable()

public final UnaryCallable<ListSKAdNetworkConversionValueSchemasRequest,ListSKAdNetworkConversionValueSchemasResponse> listSKAdNetworkConversionValueSchemasCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListSKAdNetworkConversionValueSchemasRequest request =
       ListSKAdNetworkConversionValueSchemasRequest.newBuilder()
           .setParent(DataStreamName.of("[PROPERTY]", "[DATA_STREAM]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListSKAdNetworkConversionValueSchemasResponse response =
         analyticsAdminServiceClient
             .listSKAdNetworkConversionValueSchemasCallable()
             .call(request);
     for (SKAdNetworkConversionValueSchema element :
         response.getSkadnetworkConversionValueSchemasList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListSKAdNetworkConversionValueSchemasRequest,ListSKAdNetworkConversionValueSchemasResponse>

listSKAdNetworkConversionValueSchemasPagedCallable()

public final UnaryCallable<ListSKAdNetworkConversionValueSchemasRequest,AnalyticsAdminServiceClient.ListSKAdNetworkConversionValueSchemasPagedResponse> listSKAdNetworkConversionValueSchemasPagedCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListSKAdNetworkConversionValueSchemasRequest request =
       ListSKAdNetworkConversionValueSchemasRequest.newBuilder()
           .setParent(DataStreamName.of("[PROPERTY]", "[DATA_STREAM]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<SKAdNetworkConversionValueSchema> future =
       analyticsAdminServiceClient
           .listSKAdNetworkConversionValueSchemasPagedCallable()
           .futureCall(request);
   // Do something.
   for (SKAdNetworkConversionValueSchema element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListSKAdNetworkConversionValueSchemasRequest,ListSKAdNetworkConversionValueSchemasPagedResponse>
public final AnalyticsAdminServiceClient.ListSearchAds360LinksPagedResponse listSearchAds360Links(ListSearchAds360LinksRequest request)

Lists all SearchAds360Links on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListSearchAds360LinksRequest request =
       ListSearchAds360LinksRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (SearchAds360Link element :
       analyticsAdminServiceClient.listSearchAds360Links(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListSearchAds360LinksRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
AnalyticsAdminServiceClient.ListSearchAds360LinksPagedResponse
public final AnalyticsAdminServiceClient.ListSearchAds360LinksPagedResponse listSearchAds360Links(PropertyName parent)

Lists all SearchAds360Links on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   PropertyName parent = PropertyName.of("[PROPERTY]");
   for (SearchAds360Link element :
       analyticsAdminServiceClient.listSearchAds360Links(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent PropertyName

Required. Example format: properties/1234

Returns
Type Description
AnalyticsAdminServiceClient.ListSearchAds360LinksPagedResponse
public final AnalyticsAdminServiceClient.ListSearchAds360LinksPagedResponse listSearchAds360Links(String parent)

Lists all SearchAds360Links on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String parent = PropertyName.of("[PROPERTY]").toString();
   for (SearchAds360Link element :
       analyticsAdminServiceClient.listSearchAds360Links(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. Example format: properties/1234

Returns
Type Description
AnalyticsAdminServiceClient.ListSearchAds360LinksPagedResponse

listSearchAds360LinksCallable()

public final UnaryCallable<ListSearchAds360LinksRequest,ListSearchAds360LinksResponse> listSearchAds360LinksCallable()

Lists all SearchAds360Links on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListSearchAds360LinksRequest request =
       ListSearchAds360LinksRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListSearchAds360LinksResponse response =
         analyticsAdminServiceClient.listSearchAds360LinksCallable().call(request);
     for (SearchAds360Link element : response.getSearchAds360LinksList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListSearchAds360LinksRequest,ListSearchAds360LinksResponse>

listSearchAds360LinksPagedCallable()

public final UnaryCallable<ListSearchAds360LinksRequest,AnalyticsAdminServiceClient.ListSearchAds360LinksPagedResponse> listSearchAds360LinksPagedCallable()

Lists all SearchAds360Links on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListSearchAds360LinksRequest request =
       ListSearchAds360LinksRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<SearchAds360Link> future =
       analyticsAdminServiceClient.listSearchAds360LinksPagedCallable().futureCall(request);
   // Do something.
   for (SearchAds360Link element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListSearchAds360LinksRequest,ListSearchAds360LinksPagedResponse>

listSubpropertyEventFilters(ListSubpropertyEventFiltersRequest request)

public final AnalyticsAdminServiceClient.ListSubpropertyEventFiltersPagedResponse listSubpropertyEventFilters(ListSubpropertyEventFiltersRequest request)

List all subproperty Event Filters on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListSubpropertyEventFiltersRequest request =
       ListSubpropertyEventFiltersRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (SubpropertyEventFilter element :
       analyticsAdminServiceClient.listSubpropertyEventFilters(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListSubpropertyEventFiltersRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
AnalyticsAdminServiceClient.ListSubpropertyEventFiltersPagedResponse

listSubpropertyEventFilters(PropertyName parent)

public final AnalyticsAdminServiceClient.ListSubpropertyEventFiltersPagedResponse listSubpropertyEventFilters(PropertyName parent)

List all subproperty Event Filters on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   PropertyName parent = PropertyName.of("[PROPERTY]");
   for (SubpropertyEventFilter element :
       analyticsAdminServiceClient.listSubpropertyEventFilters(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent PropertyName

Required. Resource name of the ordinary property. Format: properties/property_id Example: properties/123

Returns
Type Description
AnalyticsAdminServiceClient.ListSubpropertyEventFiltersPagedResponse

listSubpropertyEventFilters(String parent)

public final AnalyticsAdminServiceClient.ListSubpropertyEventFiltersPagedResponse listSubpropertyEventFilters(String parent)

List all subproperty Event Filters on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   String parent = PropertyName.of("[PROPERTY]").toString();
   for (SubpropertyEventFilter element :
       analyticsAdminServiceClient.listSubpropertyEventFilters(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. Resource name of the ordinary property. Format: properties/property_id Example: properties/123

Returns
Type Description
AnalyticsAdminServiceClient.ListSubpropertyEventFiltersPagedResponse

listSubpropertyEventFiltersCallable()

public final UnaryCallable<ListSubpropertyEventFiltersRequest,ListSubpropertyEventFiltersResponse> listSubpropertyEventFiltersCallable()

List all subproperty Event Filters on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListSubpropertyEventFiltersRequest request =
       ListSubpropertyEventFiltersRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListSubpropertyEventFiltersResponse response =
         analyticsAdminServiceClient.listSubpropertyEventFiltersCallable().call(request);
     for (SubpropertyEventFilter element : response.getSubpropertyEventFiltersList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListSubpropertyEventFiltersRequest,ListSubpropertyEventFiltersResponse>

listSubpropertyEventFiltersPagedCallable()

public final UnaryCallable<ListSubpropertyEventFiltersRequest,AnalyticsAdminServiceClient.ListSubpropertyEventFiltersPagedResponse> listSubpropertyEventFiltersPagedCallable()

List all subproperty Event Filters on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListSubpropertyEventFiltersRequest request =
       ListSubpropertyEventFiltersRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<SubpropertyEventFilter> future =
       analyticsAdminServiceClient
           .listSubpropertyEventFiltersPagedCallable()
           .futureCall(request);
   // Do something.
   for (SubpropertyEventFilter element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListSubpropertyEventFiltersRequest,ListSubpropertyEventFiltersPagedResponse>

provisionAccountTicket(ProvisionAccountTicketRequest request)

public final ProvisionAccountTicketResponse provisionAccountTicket(ProvisionAccountTicketRequest request)

Requests a ticket for creating an account.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ProvisionAccountTicketRequest request =
       ProvisionAccountTicketRequest.newBuilder()
           .setAccount(Account.newBuilder().build())
           .setRedirectUri("redirectUri1970337776")
           .build();
   ProvisionAccountTicketResponse response =
       analyticsAdminServiceClient.provisionAccountTicket(request);
 }
 
Parameter
Name Description
request ProvisionAccountTicketRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
ProvisionAccountTicketResponse

provisionAccountTicketCallable()

public final UnaryCallable<ProvisionAccountTicketRequest,ProvisionAccountTicketResponse> provisionAccountTicketCallable()

Requests a ticket for creating an account.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ProvisionAccountTicketRequest request =
       ProvisionAccountTicketRequest.newBuilder()
           .setAccount(Account.newBuilder().build())
           .setRedirectUri("redirectUri1970337776")
           .build();
   ApiFuture<ProvisionAccountTicketResponse> future =
       analyticsAdminServiceClient.provisionAccountTicketCallable().futureCall(request);
   // Do something.
   ProvisionAccountTicketResponse response = future.get();
 }
 
Returns
Type Description
UnaryCallable<ProvisionAccountTicketRequest,ProvisionAccountTicketResponse>

provisionSubproperty(ProvisionSubpropertyRequest request)

public final ProvisionSubpropertyResponse provisionSubproperty(ProvisionSubpropertyRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ProvisionSubpropertyRequest request =
       ProvisionSubpropertyRequest.newBuilder()
           .setSubproperty(Property.newBuilder().build())
           .setSubpropertyEventFilter(SubpropertyEventFilter.newBuilder().build())
           .build();
   ProvisionSubpropertyResponse response =
       analyticsAdminServiceClient.provisionSubproperty(request);
 }
 
Parameter
Name Description
request ProvisionSubpropertyRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
ProvisionSubpropertyResponse

provisionSubpropertyCallable()

public final UnaryCallable<ProvisionSubpropertyRequest,ProvisionSubpropertyResponse> provisionSubpropertyCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ProvisionSubpropertyRequest request =
       ProvisionSubpropertyRequest.newBuilder()
           .setSubproperty(Property.newBuilder().build())
           .setSubpropertyEventFilter(SubpropertyEventFilter.newBuilder().build())
           .build();
   ApiFuture<ProvisionSubpropertyResponse> future =
       analyticsAdminServiceClient.provisionSubpropertyCallable().futureCall(request);
   // Do something.
   ProvisionSubpropertyResponse response = future.get();
 }
 
Returns
Type Description
UnaryCallable<ProvisionSubpropertyRequest,ProvisionSubpropertyResponse>

reorderEventEditRules(ReorderEventEditRulesRequest request)

public final void reorderEventEditRules(ReorderEventEditRulesRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ReorderEventEditRulesRequest request =
       ReorderEventEditRulesRequest.newBuilder()
           .setParent(DataStreamName.of("[PROPERTY]", "[DATA_STREAM]").toString())
           .addAllEventEditRules(new ArrayList<String>())
           .build();
   analyticsAdminServiceClient.reorderEventEditRules(request);
 }
 
Parameter
Name Description
request ReorderEventEditRulesRequest

The request object containing all of the parameters for the API call.

reorderEventEditRulesCallable()

public final UnaryCallable<ReorderEventEditRulesRequest,Empty> reorderEventEditRulesCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ReorderEventEditRulesRequest request =
       ReorderEventEditRulesRequest.newBuilder()
           .setParent(DataStreamName.of("[PROPERTY]", "[DATA_STREAM]").toString())
           .addAllEventEditRules(new ArrayList<String>())
           .build();
   ApiFuture<Empty> future =
       analyticsAdminServiceClient.reorderEventEditRulesCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<ReorderEventEditRulesRequest,Empty>

runAccessReport(RunAccessReportRequest request)

public final RunAccessReportResponse runAccessReport(RunAccessReportRequest request)

Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years.

Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators.

These data access records include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see searchChangeHistoryEvents.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   RunAccessReportRequest request =
       RunAccessReportRequest.newBuilder()
           .setEntity("entity-1298275357")
           .addAllDimensions(new ArrayList<AccessDimension>())
           .addAllMetrics(new ArrayList<AccessMetric>())
           .addAllDateRanges(new ArrayList<AccessDateRange>())
           .setDimensionFilter(AccessFilterExpression.newBuilder().build())
           .setMetricFilter(AccessFilterExpression.newBuilder().build())
           .setOffset(-1019779949)
           .setLimit(102976443)
           .setTimeZone("timeZone-2077180903")
           .addAllOrderBys(new ArrayList<AccessOrderBy>())
           .setReturnEntityQuota(true)
           .setIncludeAllUsers(true)
           .setExpandGroups(true)
           .build();
   RunAccessReportResponse response = analyticsAdminServiceClient.runAccessReport(request);
 }
 
Parameter
Name Description
request RunAccessReportRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
RunAccessReportResponse

runAccessReportCallable()

public final UnaryCallable<RunAccessReportRequest,RunAccessReportResponse> runAccessReportCallable()

Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years.

Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators.

These data access records include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see searchChangeHistoryEvents.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   RunAccessReportRequest request =
       RunAccessReportRequest.newBuilder()
           .setEntity("entity-1298275357")
           .addAllDimensions(new ArrayList<AccessDimension>())
           .addAllMetrics(new ArrayList<AccessMetric>())
           .addAllDateRanges(new ArrayList<AccessDateRange>())
           .setDimensionFilter(AccessFilterExpression.newBuilder().build())
           .setMetricFilter(AccessFilterExpression.newBuilder().build())
           .setOffset(-1019779949)
           .setLimit(102976443)
           .setTimeZone("timeZone-2077180903")
           .addAllOrderBys(new ArrayList<AccessOrderBy>())
           .setReturnEntityQuota(true)
           .setIncludeAllUsers(true)
           .setExpandGroups(true)
           .build();
   ApiFuture<RunAccessReportResponse> future =
       analyticsAdminServiceClient.runAccessReportCallable().futureCall(request);
   // Do something.
   RunAccessReportResponse response = future.get();
 }
 
Returns
Type Description
UnaryCallable<RunAccessReportRequest,RunAccessReportResponse>

searchChangeHistoryEvents(SearchChangeHistoryEventsRequest request)

public final AnalyticsAdminServiceClient.SearchChangeHistoryEventsPagedResponse searchChangeHistoryEvents(SearchChangeHistoryEventsRequest request)

Searches through all changes to an account or its children given the specified set of filters.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   SearchChangeHistoryEventsRequest request =
       SearchChangeHistoryEventsRequest.newBuilder()
           .setAccount(AccountName.of("[ACCOUNT]").toString())
           .setProperty(PropertyName.of("[PROPERTY]").toString())
           .addAllResourceType(new ArrayList<ChangeHistoryResourceType>())
           .addAllAction(new ArrayList<ActionType>())
           .addAllActorEmail(new ArrayList<String>())
           .setEarliestChangeTime(Timestamp.newBuilder().build())
           .setLatestChangeTime(Timestamp.newBuilder().build())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (ChangeHistoryEvent element :
       analyticsAdminServiceClient.searchChangeHistoryEvents(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request SearchChangeHistoryEventsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
AnalyticsAdminServiceClient.SearchChangeHistoryEventsPagedResponse

searchChangeHistoryEventsCallable()

public final UnaryCallable<SearchChangeHistoryEventsRequest,SearchChangeHistoryEventsResponse> searchChangeHistoryEventsCallable()

Searches through all changes to an account or its children given the specified set of filters.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   SearchChangeHistoryEventsRequest request =
       SearchChangeHistoryEventsRequest.newBuilder()
           .setAccount(AccountName.of("[ACCOUNT]").toString())
           .setProperty(PropertyName.of("[PROPERTY]").toString())
           .addAllResourceType(new ArrayList<ChangeHistoryResourceType>())
           .addAllAction(new ArrayList<ActionType>())
           .addAllActorEmail(new ArrayList<String>())
           .setEarliestChangeTime(Timestamp.newBuilder().build())
           .setLatestChangeTime(Timestamp.newBuilder().build())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     SearchChangeHistoryEventsResponse response =
         analyticsAdminServiceClient.searchChangeHistoryEventsCallable().call(request);
     for (ChangeHistoryEvent element : response.getChangeHistoryEventsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<SearchChangeHistoryEventsRequest,SearchChangeHistoryEventsResponse>

searchChangeHistoryEventsPagedCallable()

public final UnaryCallable<SearchChangeHistoryEventsRequest,AnalyticsAdminServiceClient.SearchChangeHistoryEventsPagedResponse> searchChangeHistoryEventsPagedCallable()

Searches through all changes to an account or its children given the specified set of filters.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   SearchChangeHistoryEventsRequest request =
       SearchChangeHistoryEventsRequest.newBuilder()
           .setAccount(AccountName.of("[ACCOUNT]").toString())
           .setProperty(PropertyName.of("[PROPERTY]").toString())
           .addAllResourceType(new ArrayList<ChangeHistoryResourceType>())
           .addAllAction(new ArrayList<ActionType>())
           .addAllActorEmail(new ArrayList<String>())
           .setEarliestChangeTime(Timestamp.newBuilder().build())
           .setLatestChangeTime(Timestamp.newBuilder().build())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<ChangeHistoryEvent> future =
       analyticsAdminServiceClient.searchChangeHistoryEventsPagedCallable().futureCall(request);
   // Do something.
   for (ChangeHistoryEvent element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<SearchChangeHistoryEventsRequest,SearchChangeHistoryEventsPagedResponse>

setAutomatedGa4ConfigurationOptOut(SetAutomatedGa4ConfigurationOptOutRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   SetAutomatedGa4ConfigurationOptOutRequest request =
       SetAutomatedGa4ConfigurationOptOutRequest.newBuilder()
           .setProperty("property-993141291")
           .setOptOut(true)
           .build();
   SetAutomatedGa4ConfigurationOptOutResponse response =
       analyticsAdminServiceClient.setAutomatedGa4ConfigurationOptOut(request);
 }
 
Parameter
Name Description
request SetAutomatedGa4ConfigurationOptOutRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
SetAutomatedGa4ConfigurationOptOutResponse

setAutomatedGa4ConfigurationOptOutCallable()

public final UnaryCallable<SetAutomatedGa4ConfigurationOptOutRequest,SetAutomatedGa4ConfigurationOptOutResponse> setAutomatedGa4ConfigurationOptOutCallable()

Sets the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   SetAutomatedGa4ConfigurationOptOutRequest request =
       SetAutomatedGa4ConfigurationOptOutRequest.newBuilder()
           .setProperty("property-993141291")
           .setOptOut(true)
           .build();
   ApiFuture<SetAutomatedGa4ConfigurationOptOutResponse> future =
       analyticsAdminServiceClient
           .setAutomatedGa4ConfigurationOptOutCallable()
           .futureCall(request);
   // Do something.
   SetAutomatedGa4ConfigurationOptOutResponse response = future.get();
 }
 
Returns
Type Description
UnaryCallable<SetAutomatedGa4ConfigurationOptOutRequest,SetAutomatedGa4ConfigurationOptOutResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateAccessBinding(AccessBinding accessBinding)

public final AccessBinding updateAccessBinding(AccessBinding accessBinding)

Updates an access binding on an account or property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   AccessBinding accessBinding = AccessBinding.newBuilder().build();
   AccessBinding response = analyticsAdminServiceClient.updateAccessBinding(accessBinding);
 }
 
Parameter
Name Description
accessBinding AccessBinding

Required. The access binding to update.

Returns
Type Description
AccessBinding

updateAccessBinding(UpdateAccessBindingRequest request)

public final AccessBinding updateAccessBinding(UpdateAccessBindingRequest request)

Updates an access binding on an account or property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateAccessBindingRequest request =
       UpdateAccessBindingRequest.newBuilder()
           .setAccessBinding(AccessBinding.newBuilder().build())
           .build();
   AccessBinding response = analyticsAdminServiceClient.updateAccessBinding(request);
 }
 
Parameter
Name Description
request UpdateAccessBindingRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
AccessBinding

updateAccessBindingCallable()

public final UnaryCallable<UpdateAccessBindingRequest,AccessBinding> updateAccessBindingCallable()

Updates an access binding on an account or property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateAccessBindingRequest request =
       UpdateAccessBindingRequest.newBuilder()
           .setAccessBinding(AccessBinding.newBuilder().build())
           .build();
   ApiFuture<AccessBinding> future =
       analyticsAdminServiceClient.updateAccessBindingCallable().futureCall(request);
   // Do something.
   AccessBinding response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateAccessBindingRequest,AccessBinding>

updateAccount(Account account, FieldMask updateMask)

public final Account updateAccount(Account account, FieldMask updateMask)

Updates an account.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   Account account = Account.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Account response = analyticsAdminServiceClient.updateAccount(account, updateMask);
 }
 
Parameters
Name Description
account Account

Required. The account to update. The account's name field is used to identify the account.

updateMask FieldMask

Required. The list of fields to be updated. Field names must be in snake case (for example, "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Returns
Type Description
Account

updateAccount(UpdateAccountRequest request)

public final Account updateAccount(UpdateAccountRequest request)

Updates an account.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateAccountRequest request =
       UpdateAccountRequest.newBuilder()
           .setAccount(Account.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Account response = analyticsAdminServiceClient.updateAccount(request);
 }
 
Parameter
Name Description
request UpdateAccountRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
Account

updateAccountCallable()

public final UnaryCallable<UpdateAccountRequest,Account> updateAccountCallable()

Updates an account.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateAccountRequest request =
       UpdateAccountRequest.newBuilder()
           .setAccount(Account.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Account> future =
       analyticsAdminServiceClient.updateAccountCallable().futureCall(request);
   // Do something.
   Account response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateAccountRequest,Account>

updateAttributionSettings(AttributionSettings attributionSettings, FieldMask updateMask)

public final AttributionSettings updateAttributionSettings(AttributionSettings attributionSettings, FieldMask updateMask)

Updates attribution settings on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   AttributionSettings attributionSettings = AttributionSettings.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   AttributionSettings response =
       analyticsAdminServiceClient.updateAttributionSettings(attributionSettings, updateMask);
 }
 
Parameters
Name Description
attributionSettings AttributionSettings

Required. The attribution settings to update. The name field is used to identify the settings to be updated.

updateMask FieldMask

Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Returns
Type Description
AttributionSettings

updateAttributionSettings(UpdateAttributionSettingsRequest request)

public final AttributionSettings updateAttributionSettings(UpdateAttributionSettingsRequest request)

Updates attribution settings on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateAttributionSettingsRequest request =
       UpdateAttributionSettingsRequest.newBuilder()
           .setAttributionSettings(AttributionSettings.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   AttributionSettings response = analyticsAdminServiceClient.updateAttributionSettings(request);
 }
 
Parameter
Name Description
request UpdateAttributionSettingsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
AttributionSettings

updateAttributionSettingsCallable()

public final UnaryCallable<UpdateAttributionSettingsRequest,AttributionSettings> updateAttributionSettingsCallable()

Updates attribution settings on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateAttributionSettingsRequest request =
       UpdateAttributionSettingsRequest.newBuilder()
           .setAttributionSettings(AttributionSettings.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<AttributionSettings> future =
       analyticsAdminServiceClient.updateAttributionSettingsCallable().futureCall(request);
   // Do something.
   AttributionSettings response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateAttributionSettingsRequest,AttributionSettings>

updateAudience(Audience audience, FieldMask updateMask)

public final Audience updateAudience(Audience audience, FieldMask updateMask)

Updates an Audience on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   Audience audience = Audience.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Audience response = analyticsAdminServiceClient.updateAudience(audience, updateMask);
 }
 
Parameters
Name Description
audience Audience

Required. The audience to update. The audience's name field is used to identify the audience to be updated.

updateMask FieldMask

Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Returns
Type Description
Audience

updateAudience(UpdateAudienceRequest request)

public final Audience updateAudience(UpdateAudienceRequest request)

Updates an Audience on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateAudienceRequest request =
       UpdateAudienceRequest.newBuilder()
           .setAudience(Audience.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Audience response = analyticsAdminServiceClient.updateAudience(request);
 }
 
Parameter
Name Description
request UpdateAudienceRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
Audience

updateAudienceCallable()

public final UnaryCallable<UpdateAudienceRequest,Audience> updateAudienceCallable()

Updates an Audience on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateAudienceRequest request =
       UpdateAudienceRequest.newBuilder()
           .setAudience(Audience.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Audience> future =
       analyticsAdminServiceClient.updateAudienceCallable().futureCall(request);
   // Do something.
   Audience response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateAudienceRequest,Audience>
public final BigQueryLink updateBigQueryLink(BigQueryLink bigqueryLink, FieldMask updateMask)

Updates a BigQueryLink.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   BigQueryLink bigqueryLink = BigQueryLink.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   BigQueryLink response =
       analyticsAdminServiceClient.updateBigQueryLink(bigqueryLink, updateMask);
 }
 
Parameters
Name Description
bigqueryLink BigQueryLink

Required. The settings to update. The name field is used to identify the settings to be updated.

updateMask FieldMask

Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Returns
Type Description
BigQueryLink
public final BigQueryLink updateBigQueryLink(UpdateBigQueryLinkRequest request)

Updates a BigQueryLink.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateBigQueryLinkRequest request =
       UpdateBigQueryLinkRequest.newBuilder()
           .setBigqueryLink(BigQueryLink.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   BigQueryLink response = analyticsAdminServiceClient.updateBigQueryLink(request);
 }
 
Parameter
Name Description
request UpdateBigQueryLinkRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
BigQueryLink

updateBigQueryLinkCallable()

public final UnaryCallable<UpdateBigQueryLinkRequest,BigQueryLink> updateBigQueryLinkCallable()

Updates a BigQueryLink.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateBigQueryLinkRequest request =
       UpdateBigQueryLinkRequest.newBuilder()
           .setBigqueryLink(BigQueryLink.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<BigQueryLink> future =
       analyticsAdminServiceClient.updateBigQueryLinkCallable().futureCall(request);
   // Do something.
   BigQueryLink response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateBigQueryLinkRequest,BigQueryLink>

updateCalculatedMetric(CalculatedMetric calculatedMetric, FieldMask updateMask)

public final CalculatedMetric updateCalculatedMetric(CalculatedMetric calculatedMetric, FieldMask updateMask)

Updates a CalculatedMetric on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CalculatedMetric calculatedMetric = CalculatedMetric.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   CalculatedMetric response =
       analyticsAdminServiceClient.updateCalculatedMetric(calculatedMetric, updateMask);
 }
 
Parameters
Name Description
calculatedMetric CalculatedMetric

Required. The CalculatedMetric to update

updateMask FieldMask

Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Returns
Type Description
CalculatedMetric

updateCalculatedMetric(UpdateCalculatedMetricRequest request)

public final CalculatedMetric updateCalculatedMetric(UpdateCalculatedMetricRequest request)

Updates a CalculatedMetric on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateCalculatedMetricRequest request =
       UpdateCalculatedMetricRequest.newBuilder()
           .setCalculatedMetric(CalculatedMetric.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   CalculatedMetric response = analyticsAdminServiceClient.updateCalculatedMetric(request);
 }
 
Parameter
Name Description
request UpdateCalculatedMetricRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
CalculatedMetric

updateCalculatedMetricCallable()

public final UnaryCallable<UpdateCalculatedMetricRequest,CalculatedMetric> updateCalculatedMetricCallable()

Updates a CalculatedMetric on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateCalculatedMetricRequest request =
       UpdateCalculatedMetricRequest.newBuilder()
           .setCalculatedMetric(CalculatedMetric.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<CalculatedMetric> future =
       analyticsAdminServiceClient.updateCalculatedMetricCallable().futureCall(request);
   // Do something.
   CalculatedMetric response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateCalculatedMetricRequest,CalculatedMetric>

updateChannelGroup(ChannelGroup channelGroup, FieldMask updateMask)

public final ChannelGroup updateChannelGroup(ChannelGroup channelGroup, FieldMask updateMask)

Updates a ChannelGroup.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ChannelGroup channelGroup = ChannelGroup.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   ChannelGroup response =
       analyticsAdminServiceClient.updateChannelGroup(channelGroup, updateMask);
 }
 
Parameters
Name Description
channelGroup ChannelGroup

Required. The ChannelGroup to update. The resource's name field is used to identify the ChannelGroup to be updated.

updateMask FieldMask

Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Returns
Type Description
ChannelGroup

updateChannelGroup(UpdateChannelGroupRequest request)

public final ChannelGroup updateChannelGroup(UpdateChannelGroupRequest request)

Updates a ChannelGroup.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateChannelGroupRequest request =
       UpdateChannelGroupRequest.newBuilder()
           .setChannelGroup(ChannelGroup.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ChannelGroup response = analyticsAdminServiceClient.updateChannelGroup(request);
 }
 
Parameter
Name Description
request UpdateChannelGroupRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
ChannelGroup

updateChannelGroupCallable()

public final UnaryCallable<UpdateChannelGroupRequest,ChannelGroup> updateChannelGroupCallable()

Updates a ChannelGroup.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateChannelGroupRequest request =
       UpdateChannelGroupRequest.newBuilder()
           .setChannelGroup(ChannelGroup.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<ChannelGroup> future =
       analyticsAdminServiceClient.updateChannelGroupCallable().futureCall(request);
   // Do something.
   ChannelGroup response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateChannelGroupRequest,ChannelGroup>

updateConversionEvent(ConversionEvent conversionEvent, FieldMask updateMask) (deprecated)

public final ConversionEvent updateConversionEvent(ConversionEvent conversionEvent, FieldMask updateMask)

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ConversionEvent conversionEvent = ConversionEvent.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   ConversionEvent response =
       analyticsAdminServiceClient.updateConversionEvent(conversionEvent, updateMask);
 }
 
Parameters
Name Description
conversionEvent ConversionEvent

Required. The conversion event to update. The name field is used to identify the settings to be updated.

updateMask FieldMask

Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Returns
Type Description
ConversionEvent

updateConversionEvent(UpdateConversionEventRequest request) (deprecated)

public final ConversionEvent updateConversionEvent(UpdateConversionEventRequest request)

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateConversionEventRequest request =
       UpdateConversionEventRequest.newBuilder()
           .setConversionEvent(ConversionEvent.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ConversionEvent response = analyticsAdminServiceClient.updateConversionEvent(request);
 }
 
Parameter
Name Description
request UpdateConversionEventRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
ConversionEvent

updateConversionEventCallable() (deprecated)

public final UnaryCallable<UpdateConversionEventRequest,ConversionEvent> updateConversionEventCallable()

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateConversionEventRequest request =
       UpdateConversionEventRequest.newBuilder()
           .setConversionEvent(ConversionEvent.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<ConversionEvent> future =
       analyticsAdminServiceClient.updateConversionEventCallable().futureCall(request);
   // Do something.
   ConversionEvent response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateConversionEventRequest,ConversionEvent>

updateCustomDimension(CustomDimension customDimension, FieldMask updateMask)

public final CustomDimension updateCustomDimension(CustomDimension customDimension, FieldMask updateMask)

Updates a CustomDimension on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CustomDimension customDimension = CustomDimension.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   CustomDimension response =
       analyticsAdminServiceClient.updateCustomDimension(customDimension, updateMask);
 }
 
Parameters
Name Description
customDimension CustomDimension

The CustomDimension to update

updateMask FieldMask

Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Returns
Type Description
CustomDimension

updateCustomDimension(UpdateCustomDimensionRequest request)

public final CustomDimension updateCustomDimension(UpdateCustomDimensionRequest request)

Updates a CustomDimension on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateCustomDimensionRequest request =
       UpdateCustomDimensionRequest.newBuilder()
           .setCustomDimension(CustomDimension.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   CustomDimension response = analyticsAdminServiceClient.updateCustomDimension(request);
 }
 
Parameter
Name Description
request UpdateCustomDimensionRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
CustomDimension

updateCustomDimensionCallable()

public final UnaryCallable<UpdateCustomDimensionRequest,CustomDimension> updateCustomDimensionCallable()

Updates a CustomDimension on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateCustomDimensionRequest request =
       UpdateCustomDimensionRequest.newBuilder()
           .setCustomDimension(CustomDimension.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<CustomDimension> future =
       analyticsAdminServiceClient.updateCustomDimensionCallable().futureCall(request);
   // Do something.
   CustomDimension response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateCustomDimensionRequest,CustomDimension>

updateCustomMetric(CustomMetric customMetric, FieldMask updateMask)

public final CustomMetric updateCustomMetric(CustomMetric customMetric, FieldMask updateMask)

Updates a CustomMetric on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   CustomMetric customMetric = CustomMetric.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   CustomMetric response =
       analyticsAdminServiceClient.updateCustomMetric(customMetric, updateMask);
 }
 
Parameters
Name Description
customMetric CustomMetric

The CustomMetric to update

updateMask FieldMask

Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Returns
Type Description
CustomMetric

updateCustomMetric(UpdateCustomMetricRequest request)

public final CustomMetric updateCustomMetric(UpdateCustomMetricRequest request)

Updates a CustomMetric on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateCustomMetricRequest request =
       UpdateCustomMetricRequest.newBuilder()
           .setCustomMetric(CustomMetric.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   CustomMetric response = analyticsAdminServiceClient.updateCustomMetric(request);
 }
 
Parameter
Name Description
request UpdateCustomMetricRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
CustomMetric

updateCustomMetricCallable()

public final UnaryCallable<UpdateCustomMetricRequest,CustomMetric> updateCustomMetricCallable()

Updates a CustomMetric on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateCustomMetricRequest request =
       UpdateCustomMetricRequest.newBuilder()
           .setCustomMetric(CustomMetric.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<CustomMetric> future =
       analyticsAdminServiceClient.updateCustomMetricCallable().futureCall(request);
   // Do something.
   CustomMetric response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateCustomMetricRequest,CustomMetric>

updateDataRedactionSettings(DataRedactionSettings dataRedactionSettings, FieldMask updateMask)

public final DataRedactionSettings updateDataRedactionSettings(DataRedactionSettings dataRedactionSettings, FieldMask updateMask)

Updates a DataRedactionSettings on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DataRedactionSettings dataRedactionSettings = DataRedactionSettings.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   DataRedactionSettings response =
       analyticsAdminServiceClient.updateDataRedactionSettings(
           dataRedactionSettings, updateMask);
 }
 
Parameters
Name Description
dataRedactionSettings DataRedactionSettings

Required. The settings to update. The name field is used to identify the settings to be updated.

updateMask FieldMask

Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Returns
Type Description
DataRedactionSettings

updateDataRedactionSettings(UpdateDataRedactionSettingsRequest request)

public final DataRedactionSettings updateDataRedactionSettings(UpdateDataRedactionSettingsRequest request)

Updates a DataRedactionSettings on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateDataRedactionSettingsRequest request =
       UpdateDataRedactionSettingsRequest.newBuilder()
           .setDataRedactionSettings(DataRedactionSettings.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   DataRedactionSettings response =
       analyticsAdminServiceClient.updateDataRedactionSettings(request);
 }
 
Parameter
Name Description
request UpdateDataRedactionSettingsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
DataRedactionSettings

updateDataRedactionSettingsCallable()

public final UnaryCallable<UpdateDataRedactionSettingsRequest,DataRedactionSettings> updateDataRedactionSettingsCallable()

Updates a DataRedactionSettings on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateDataRedactionSettingsRequest request =
       UpdateDataRedactionSettingsRequest.newBuilder()
           .setDataRedactionSettings(DataRedactionSettings.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<DataRedactionSettings> future =
       analyticsAdminServiceClient.updateDataRedactionSettingsCallable().futureCall(request);
   // Do something.
   DataRedactionSettings response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateDataRedactionSettingsRequest,DataRedactionSettings>

updateDataRetentionSettings(DataRetentionSettings dataRetentionSettings, FieldMask updateMask)

public final DataRetentionSettings updateDataRetentionSettings(DataRetentionSettings dataRetentionSettings, FieldMask updateMask)

Updates the singleton data retention settings for this property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DataRetentionSettings dataRetentionSettings = DataRetentionSettings.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   DataRetentionSettings response =
       analyticsAdminServiceClient.updateDataRetentionSettings(
           dataRetentionSettings, updateMask);
 }
 
Parameters
Name Description
dataRetentionSettings DataRetentionSettings

Required. The settings to update. The name field is used to identify the settings to be updated.

updateMask FieldMask

Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Returns
Type Description
DataRetentionSettings

updateDataRetentionSettings(UpdateDataRetentionSettingsRequest request)

public final DataRetentionSettings updateDataRetentionSettings(UpdateDataRetentionSettingsRequest request)

Updates the singleton data retention settings for this property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateDataRetentionSettingsRequest request =
       UpdateDataRetentionSettingsRequest.newBuilder()
           .setDataRetentionSettings(DataRetentionSettings.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   DataRetentionSettings response =
       analyticsAdminServiceClient.updateDataRetentionSettings(request);
 }
 
Parameter
Name Description
request UpdateDataRetentionSettingsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
DataRetentionSettings

updateDataRetentionSettingsCallable()

public final UnaryCallable<UpdateDataRetentionSettingsRequest,DataRetentionSettings> updateDataRetentionSettingsCallable()

Updates the singleton data retention settings for this property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateDataRetentionSettingsRequest request =
       UpdateDataRetentionSettingsRequest.newBuilder()
           .setDataRetentionSettings(DataRetentionSettings.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<DataRetentionSettings> future =
       analyticsAdminServiceClient.updateDataRetentionSettingsCallable().futureCall(request);
   // Do something.
   DataRetentionSettings response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateDataRetentionSettingsRequest,DataRetentionSettings>

updateDataStream(DataStream dataStream, FieldMask updateMask)

public final DataStream updateDataStream(DataStream dataStream, FieldMask updateMask)

Updates a DataStream on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DataStream dataStream = DataStream.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   DataStream response = analyticsAdminServiceClient.updateDataStream(dataStream, updateMask);
 }
 
Parameters
Name Description
dataStream DataStream

The DataStream to update

updateMask FieldMask

Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Returns
Type Description
DataStream

updateDataStream(UpdateDataStreamRequest request)

public final DataStream updateDataStream(UpdateDataStreamRequest request)

Updates a DataStream on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateDataStreamRequest request =
       UpdateDataStreamRequest.newBuilder()
           .setDataStream(DataStream.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   DataStream response = analyticsAdminServiceClient.updateDataStream(request);
 }
 
Parameter
Name Description
request UpdateDataStreamRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
DataStream

updateDataStreamCallable()

public final UnaryCallable<UpdateDataStreamRequest,DataStream> updateDataStreamCallable()

Updates a DataStream on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateDataStreamRequest request =
       UpdateDataStreamRequest.newBuilder()
           .setDataStream(DataStream.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<DataStream> future =
       analyticsAdminServiceClient.updateDataStreamCallable().futureCall(request);
   // Do something.
   DataStream response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateDataStreamRequest,DataStream>
public final DisplayVideo360AdvertiserLink updateDisplayVideo360AdvertiserLink(DisplayVideo360AdvertiserLink displayVideo360AdvertiserLink, FieldMask updateMask)

Updates a DisplayVideo360AdvertiserLink on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   DisplayVideo360AdvertiserLink displayVideo360AdvertiserLink =
       DisplayVideo360AdvertiserLink.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   DisplayVideo360AdvertiserLink response =
       analyticsAdminServiceClient.updateDisplayVideo360AdvertiserLink(
           displayVideo360AdvertiserLink, updateMask);
 }
 
Parameters
Name Description
displayVideo360AdvertiserLink DisplayVideo360AdvertiserLink

The DisplayVideo360AdvertiserLink to update

updateMask FieldMask

Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Returns
Type Description
DisplayVideo360AdvertiserLink
public final DisplayVideo360AdvertiserLink updateDisplayVideo360AdvertiserLink(UpdateDisplayVideo360AdvertiserLinkRequest request)

Updates a DisplayVideo360AdvertiserLink on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateDisplayVideo360AdvertiserLinkRequest request =
       UpdateDisplayVideo360AdvertiserLinkRequest.newBuilder()
           .setDisplayVideo360AdvertiserLink(DisplayVideo360AdvertiserLink.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   DisplayVideo360AdvertiserLink response =
       analyticsAdminServiceClient.updateDisplayVideo360AdvertiserLink(request);
 }
 
Parameter
Name Description
request UpdateDisplayVideo360AdvertiserLinkRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
DisplayVideo360AdvertiserLink

updateDisplayVideo360AdvertiserLinkCallable()

public final UnaryCallable<UpdateDisplayVideo360AdvertiserLinkRequest,DisplayVideo360AdvertiserLink> updateDisplayVideo360AdvertiserLinkCallable()

Updates a DisplayVideo360AdvertiserLink on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateDisplayVideo360AdvertiserLinkRequest request =
       UpdateDisplayVideo360AdvertiserLinkRequest.newBuilder()
           .setDisplayVideo360AdvertiserLink(DisplayVideo360AdvertiserLink.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<DisplayVideo360AdvertiserLink> future =
       analyticsAdminServiceClient
           .updateDisplayVideo360AdvertiserLinkCallable()
           .futureCall(request);
   // Do something.
   DisplayVideo360AdvertiserLink response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateDisplayVideo360AdvertiserLinkRequest,DisplayVideo360AdvertiserLink>

updateEnhancedMeasurementSettings(EnhancedMeasurementSettings enhancedMeasurementSettings, FieldMask updateMask)

public final EnhancedMeasurementSettings updateEnhancedMeasurementSettings(EnhancedMeasurementSettings enhancedMeasurementSettings, FieldMask updateMask)

Updates the enhanced measurement settings for this data stream. Note that the stream must enable enhanced measurement for these settings to take effect.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   EnhancedMeasurementSettings enhancedMeasurementSettings =
       EnhancedMeasurementSettings.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   EnhancedMeasurementSettings response =
       analyticsAdminServiceClient.updateEnhancedMeasurementSettings(
           enhancedMeasurementSettings, updateMask);
 }
 
Parameters
Name Description
enhancedMeasurementSettings EnhancedMeasurementSettings

Required. The settings to update. The name field is used to identify the settings to be updated.

updateMask FieldMask

Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Returns
Type Description
EnhancedMeasurementSettings

updateEnhancedMeasurementSettings(UpdateEnhancedMeasurementSettingsRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateEnhancedMeasurementSettingsRequest request =
       UpdateEnhancedMeasurementSettingsRequest.newBuilder()
           .setEnhancedMeasurementSettings(EnhancedMeasurementSettings.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   EnhancedMeasurementSettings response =
       analyticsAdminServiceClient.updateEnhancedMeasurementSettings(request);
 }
 
Parameter
Name Description
request UpdateEnhancedMeasurementSettingsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
EnhancedMeasurementSettings

updateEnhancedMeasurementSettingsCallable()

public final UnaryCallable<UpdateEnhancedMeasurementSettingsRequest,EnhancedMeasurementSettings> updateEnhancedMeasurementSettingsCallable()

Updates the enhanced measurement settings for this data stream. Note that the stream must enable enhanced measurement for these settings to take effect.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateEnhancedMeasurementSettingsRequest request =
       UpdateEnhancedMeasurementSettingsRequest.newBuilder()
           .setEnhancedMeasurementSettings(EnhancedMeasurementSettings.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<EnhancedMeasurementSettings> future =
       analyticsAdminServiceClient
           .updateEnhancedMeasurementSettingsCallable()
           .futureCall(request);
   // Do something.
   EnhancedMeasurementSettings response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateEnhancedMeasurementSettingsRequest,EnhancedMeasurementSettings>

updateEventCreateRule(EventCreateRule eventCreateRule, FieldMask updateMask)

public final EventCreateRule updateEventCreateRule(EventCreateRule eventCreateRule, FieldMask updateMask)

Updates an EventCreateRule.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   EventCreateRule eventCreateRule = EventCreateRule.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   EventCreateRule response =
       analyticsAdminServiceClient.updateEventCreateRule(eventCreateRule, updateMask);
 }
 
Parameters
Name Description
eventCreateRule EventCreateRule

Required. The EventCreateRule to update. The resource's name field is used to identify the EventCreateRule to be updated.

updateMask FieldMask

Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Returns
Type Description
EventCreateRule

updateEventCreateRule(UpdateEventCreateRuleRequest request)

public final EventCreateRule updateEventCreateRule(UpdateEventCreateRuleRequest request)

Updates an EventCreateRule.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateEventCreateRuleRequest request =
       UpdateEventCreateRuleRequest.newBuilder()
           .setEventCreateRule(EventCreateRule.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   EventCreateRule response = analyticsAdminServiceClient.updateEventCreateRule(request);
 }
 
Parameter
Name Description
request UpdateEventCreateRuleRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
EventCreateRule

updateEventCreateRuleCallable()

public final UnaryCallable<UpdateEventCreateRuleRequest,EventCreateRule> updateEventCreateRuleCallable()

Updates an EventCreateRule.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateEventCreateRuleRequest request =
       UpdateEventCreateRuleRequest.newBuilder()
           .setEventCreateRule(EventCreateRule.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<EventCreateRule> future =
       analyticsAdminServiceClient.updateEventCreateRuleCallable().futureCall(request);
   // Do something.
   EventCreateRule response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateEventCreateRuleRequest,EventCreateRule>

updateEventEditRule(EventEditRule eventEditRule, FieldMask updateMask)

public final EventEditRule updateEventEditRule(EventEditRule eventEditRule, FieldMask updateMask)

Updates an EventEditRule.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   EventEditRule eventEditRule = EventEditRule.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   EventEditRule response =
       analyticsAdminServiceClient.updateEventEditRule(eventEditRule, updateMask);
 }
 
Parameters
Name Description
eventEditRule EventEditRule

Required. The EventEditRule to update. The resource's name field is used to identify the EventEditRule to be updated.

updateMask FieldMask

Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Returns
Type Description
EventEditRule

updateEventEditRule(UpdateEventEditRuleRequest request)

public final EventEditRule updateEventEditRule(UpdateEventEditRuleRequest request)

Updates an EventEditRule.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateEventEditRuleRequest request =
       UpdateEventEditRuleRequest.newBuilder()
           .setEventEditRule(EventEditRule.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   EventEditRule response = analyticsAdminServiceClient.updateEventEditRule(request);
 }
 
Parameter
Name Description
request UpdateEventEditRuleRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
EventEditRule

updateEventEditRuleCallable()

public final UnaryCallable<UpdateEventEditRuleRequest,EventEditRule> updateEventEditRuleCallable()

Updates an EventEditRule.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateEventEditRuleRequest request =
       UpdateEventEditRuleRequest.newBuilder()
           .setEventEditRule(EventEditRule.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<EventEditRule> future =
       analyticsAdminServiceClient.updateEventEditRuleCallable().futureCall(request);
   // Do something.
   EventEditRule response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateEventEditRuleRequest,EventEditRule>

updateExpandedDataSet(ExpandedDataSet expandedDataSet, FieldMask updateMask)

public final ExpandedDataSet updateExpandedDataSet(ExpandedDataSet expandedDataSet, FieldMask updateMask)

Updates a ExpandedDataSet on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ExpandedDataSet expandedDataSet = ExpandedDataSet.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   ExpandedDataSet response =
       analyticsAdminServiceClient.updateExpandedDataSet(expandedDataSet, updateMask);
 }
 
Parameters
Name Description
expandedDataSet ExpandedDataSet

Required. The ExpandedDataSet to update. The resource's name field is used to identify the ExpandedDataSet to be updated.

updateMask FieldMask

Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Returns
Type Description
ExpandedDataSet

updateExpandedDataSet(UpdateExpandedDataSetRequest request)

public final ExpandedDataSet updateExpandedDataSet(UpdateExpandedDataSetRequest request)

Updates a ExpandedDataSet on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateExpandedDataSetRequest request =
       UpdateExpandedDataSetRequest.newBuilder()
           .setExpandedDataSet(ExpandedDataSet.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ExpandedDataSet response = analyticsAdminServiceClient.updateExpandedDataSet(request);
 }
 
Parameter
Name Description
request UpdateExpandedDataSetRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
ExpandedDataSet

updateExpandedDataSetCallable()

public final UnaryCallable<UpdateExpandedDataSetRequest,ExpandedDataSet> updateExpandedDataSetCallable()

Updates a ExpandedDataSet on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateExpandedDataSetRequest request =
       UpdateExpandedDataSetRequest.newBuilder()
           .setExpandedDataSet(ExpandedDataSet.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<ExpandedDataSet> future =
       analyticsAdminServiceClient.updateExpandedDataSetCallable().futureCall(request);
   // Do something.
   ExpandedDataSet response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateExpandedDataSetRequest,ExpandedDataSet>
public final GoogleAdsLink updateGoogleAdsLink(GoogleAdsLink googleAdsLink, FieldMask updateMask)

Updates a GoogleAdsLink on a property

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GoogleAdsLink googleAdsLink = GoogleAdsLink.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   GoogleAdsLink response =
       analyticsAdminServiceClient.updateGoogleAdsLink(googleAdsLink, updateMask);
 }
 
Parameters
Name Description
googleAdsLink GoogleAdsLink

The GoogleAdsLink to update

updateMask FieldMask

Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Returns
Type Description
GoogleAdsLink
public final GoogleAdsLink updateGoogleAdsLink(UpdateGoogleAdsLinkRequest request)

Updates a GoogleAdsLink on a property

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateGoogleAdsLinkRequest request =
       UpdateGoogleAdsLinkRequest.newBuilder()
           .setGoogleAdsLink(GoogleAdsLink.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   GoogleAdsLink response = analyticsAdminServiceClient.updateGoogleAdsLink(request);
 }
 
Parameter
Name Description
request UpdateGoogleAdsLinkRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
GoogleAdsLink

updateGoogleAdsLinkCallable()

public final UnaryCallable<UpdateGoogleAdsLinkRequest,GoogleAdsLink> updateGoogleAdsLinkCallable()

Updates a GoogleAdsLink on a property

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateGoogleAdsLinkRequest request =
       UpdateGoogleAdsLinkRequest.newBuilder()
           .setGoogleAdsLink(GoogleAdsLink.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<GoogleAdsLink> future =
       analyticsAdminServiceClient.updateGoogleAdsLinkCallable().futureCall(request);
   // Do something.
   GoogleAdsLink response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateGoogleAdsLinkRequest,GoogleAdsLink>

updateGoogleSignalsSettings(GoogleSignalsSettings googleSignalsSettings, FieldMask updateMask)

public final GoogleSignalsSettings updateGoogleSignalsSettings(GoogleSignalsSettings googleSignalsSettings, FieldMask updateMask)

Updates Google Signals settings for a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   GoogleSignalsSettings googleSignalsSettings = GoogleSignalsSettings.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   GoogleSignalsSettings response =
       analyticsAdminServiceClient.updateGoogleSignalsSettings(
           googleSignalsSettings, updateMask);
 }
 
Parameters
Name Description
googleSignalsSettings GoogleSignalsSettings

Required. The settings to update. The name field is used to identify the settings to be updated.

updateMask FieldMask

Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Returns
Type Description
GoogleSignalsSettings

updateGoogleSignalsSettings(UpdateGoogleSignalsSettingsRequest request)

public final GoogleSignalsSettings updateGoogleSignalsSettings(UpdateGoogleSignalsSettingsRequest request)

Updates Google Signals settings for a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateGoogleSignalsSettingsRequest request =
       UpdateGoogleSignalsSettingsRequest.newBuilder()
           .setGoogleSignalsSettings(GoogleSignalsSettings.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   GoogleSignalsSettings response =
       analyticsAdminServiceClient.updateGoogleSignalsSettings(request);
 }
 
Parameter
Name Description
request UpdateGoogleSignalsSettingsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
GoogleSignalsSettings

updateGoogleSignalsSettingsCallable()

public final UnaryCallable<UpdateGoogleSignalsSettingsRequest,GoogleSignalsSettings> updateGoogleSignalsSettingsCallable()

Updates Google Signals settings for a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateGoogleSignalsSettingsRequest request =
       UpdateGoogleSignalsSettingsRequest.newBuilder()
           .setGoogleSignalsSettings(GoogleSignalsSettings.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<GoogleSignalsSettings> future =
       analyticsAdminServiceClient.updateGoogleSignalsSettingsCallable().futureCall(request);
   // Do something.
   GoogleSignalsSettings response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateGoogleSignalsSettingsRequest,GoogleSignalsSettings>

updateKeyEvent(KeyEvent keyEvent, FieldMask updateMask)

public final KeyEvent updateKeyEvent(KeyEvent keyEvent, FieldMask updateMask)

Updates a Key Event.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   KeyEvent keyEvent = KeyEvent.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   KeyEvent response = analyticsAdminServiceClient.updateKeyEvent(keyEvent, updateMask);
 }
 
Parameters
Name Description
keyEvent KeyEvent

Required. The Key Event to update. The name field is used to identify the settings to be updated.

updateMask FieldMask

Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Returns
Type Description
KeyEvent

updateKeyEvent(UpdateKeyEventRequest request)

public final KeyEvent updateKeyEvent(UpdateKeyEventRequest request)

Updates a Key Event.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateKeyEventRequest request =
       UpdateKeyEventRequest.newBuilder()
           .setKeyEvent(KeyEvent.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   KeyEvent response = analyticsAdminServiceClient.updateKeyEvent(request);
 }
 
Parameter
Name Description
request UpdateKeyEventRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
KeyEvent

updateKeyEventCallable()

public final UnaryCallable<UpdateKeyEventRequest,KeyEvent> updateKeyEventCallable()

Updates a Key Event.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateKeyEventRequest request =
       UpdateKeyEventRequest.newBuilder()
           .setKeyEvent(KeyEvent.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<KeyEvent> future =
       analyticsAdminServiceClient.updateKeyEventCallable().futureCall(request);
   // Do something.
   KeyEvent response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateKeyEventRequest,KeyEvent>

updateMeasurementProtocolSecret(MeasurementProtocolSecret measurementProtocolSecret, FieldMask updateMask)

public final MeasurementProtocolSecret updateMeasurementProtocolSecret(MeasurementProtocolSecret measurementProtocolSecret, FieldMask updateMask)

Updates a measurement protocol secret.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   MeasurementProtocolSecret measurementProtocolSecret =
       MeasurementProtocolSecret.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   MeasurementProtocolSecret response =
       analyticsAdminServiceClient.updateMeasurementProtocolSecret(
           measurementProtocolSecret, updateMask);
 }
 
Parameters
Name Description
measurementProtocolSecret MeasurementProtocolSecret

Required. The measurement protocol secret to update.

updateMask FieldMask

Required. The list of fields to be updated. Omitted fields will not be updated.

Returns
Type Description
MeasurementProtocolSecret

updateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest request)

public final MeasurementProtocolSecret updateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest request)

Updates a measurement protocol secret.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateMeasurementProtocolSecretRequest request =
       UpdateMeasurementProtocolSecretRequest.newBuilder()
           .setMeasurementProtocolSecret(MeasurementProtocolSecret.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   MeasurementProtocolSecret response =
       analyticsAdminServiceClient.updateMeasurementProtocolSecret(request);
 }
 
Parameter
Name Description
request UpdateMeasurementProtocolSecretRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
MeasurementProtocolSecret

updateMeasurementProtocolSecretCallable()

public final UnaryCallable<UpdateMeasurementProtocolSecretRequest,MeasurementProtocolSecret> updateMeasurementProtocolSecretCallable()

Updates a measurement protocol secret.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateMeasurementProtocolSecretRequest request =
       UpdateMeasurementProtocolSecretRequest.newBuilder()
           .setMeasurementProtocolSecret(MeasurementProtocolSecret.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<MeasurementProtocolSecret> future =
       analyticsAdminServiceClient.updateMeasurementProtocolSecretCallable().futureCall(request);
   // Do something.
   MeasurementProtocolSecret response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateMeasurementProtocolSecretRequest,MeasurementProtocolSecret>

updateProperty(Property property, FieldMask updateMask)

public final Property updateProperty(Property property, FieldMask updateMask)

Updates a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   Property property = Property.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Property response = analyticsAdminServiceClient.updateProperty(property, updateMask);
 }
 
Parameters
Name Description
property Property

Required. The property to update. The property's name field is used to identify the property to be updated.

updateMask FieldMask

Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Returns
Type Description
Property

updateProperty(UpdatePropertyRequest request)

public final Property updateProperty(UpdatePropertyRequest request)

Updates a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdatePropertyRequest request =
       UpdatePropertyRequest.newBuilder()
           .setProperty(Property.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Property response = analyticsAdminServiceClient.updateProperty(request);
 }
 
Parameter
Name Description
request UpdatePropertyRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
Property

updatePropertyCallable()

public final UnaryCallable<UpdatePropertyRequest,Property> updatePropertyCallable()

Updates a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdatePropertyRequest request =
       UpdatePropertyRequest.newBuilder()
           .setProperty(Property.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Property> future =
       analyticsAdminServiceClient.updatePropertyCallable().futureCall(request);
   // Do something.
   Property response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdatePropertyRequest,Property>

updateSKAdNetworkConversionValueSchema(SKAdNetworkConversionValueSchema skadnetworkConversionValueSchema, FieldMask updateMask)

public final SKAdNetworkConversionValueSchema updateSKAdNetworkConversionValueSchema(SKAdNetworkConversionValueSchema skadnetworkConversionValueSchema, FieldMask updateMask)

Updates a SKAdNetworkConversionValueSchema.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   SKAdNetworkConversionValueSchema skadnetworkConversionValueSchema =
       SKAdNetworkConversionValueSchema.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   SKAdNetworkConversionValueSchema response =
       analyticsAdminServiceClient.updateSKAdNetworkConversionValueSchema(
           skadnetworkConversionValueSchema, updateMask);
 }
 
Parameters
Name Description
skadnetworkConversionValueSchema SKAdNetworkConversionValueSchema

Required. SKAdNetwork conversion value schema to update.

updateMask FieldMask

Required. The list of fields to be updated. Omitted fields will not be updated.

Returns
Type Description
SKAdNetworkConversionValueSchema

updateSKAdNetworkConversionValueSchema(UpdateSKAdNetworkConversionValueSchemaRequest request)

public final SKAdNetworkConversionValueSchema updateSKAdNetworkConversionValueSchema(UpdateSKAdNetworkConversionValueSchemaRequest request)

Updates a SKAdNetworkConversionValueSchema.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateSKAdNetworkConversionValueSchemaRequest request =
       UpdateSKAdNetworkConversionValueSchemaRequest.newBuilder()
           .setSkadnetworkConversionValueSchema(
               SKAdNetworkConversionValueSchema.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   SKAdNetworkConversionValueSchema response =
       analyticsAdminServiceClient.updateSKAdNetworkConversionValueSchema(request);
 }
 
Parameter
Name Description
request UpdateSKAdNetworkConversionValueSchemaRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
SKAdNetworkConversionValueSchema

updateSKAdNetworkConversionValueSchemaCallable()

public final UnaryCallable<UpdateSKAdNetworkConversionValueSchemaRequest,SKAdNetworkConversionValueSchema> updateSKAdNetworkConversionValueSchemaCallable()

Updates a SKAdNetworkConversionValueSchema.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateSKAdNetworkConversionValueSchemaRequest request =
       UpdateSKAdNetworkConversionValueSchemaRequest.newBuilder()
           .setSkadnetworkConversionValueSchema(
               SKAdNetworkConversionValueSchema.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<SKAdNetworkConversionValueSchema> future =
       analyticsAdminServiceClient
           .updateSKAdNetworkConversionValueSchemaCallable()
           .futureCall(request);
   // Do something.
   SKAdNetworkConversionValueSchema response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateSKAdNetworkConversionValueSchemaRequest,SKAdNetworkConversionValueSchema>
public final SearchAds360Link updateSearchAds360Link(SearchAds360Link searchAds360Link, FieldMask updateMask)

Updates a SearchAds360Link on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   SearchAds360Link searchAds360Link = SearchAds360Link.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   SearchAds360Link response =
       analyticsAdminServiceClient.updateSearchAds360Link(searchAds360Link, updateMask);
 }
 
Parameters
Name Description
searchAds360Link SearchAds360Link

The SearchAds360Link to update

updateMask FieldMask

Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Returns
Type Description
SearchAds360Link
public final SearchAds360Link updateSearchAds360Link(UpdateSearchAds360LinkRequest request)

Updates a SearchAds360Link on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateSearchAds360LinkRequest request =
       UpdateSearchAds360LinkRequest.newBuilder()
           .setSearchAds360Link(SearchAds360Link.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   SearchAds360Link response = analyticsAdminServiceClient.updateSearchAds360Link(request);
 }
 
Parameter
Name Description
request UpdateSearchAds360LinkRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
SearchAds360Link

updateSearchAds360LinkCallable()

public final UnaryCallable<UpdateSearchAds360LinkRequest,SearchAds360Link> updateSearchAds360LinkCallable()

Updates a SearchAds360Link on a property.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateSearchAds360LinkRequest request =
       UpdateSearchAds360LinkRequest.newBuilder()
           .setSearchAds360Link(SearchAds360Link.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<SearchAds360Link> future =
       analyticsAdminServiceClient.updateSearchAds360LinkCallable().futureCall(request);
   // Do something.
   SearchAds360Link response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateSearchAds360LinkRequest,SearchAds360Link>

updateSubpropertyEventFilter(SubpropertyEventFilter subpropertyEventFilter, FieldMask updateMask)

public final SubpropertyEventFilter updateSubpropertyEventFilter(SubpropertyEventFilter subpropertyEventFilter, FieldMask updateMask)

Updates a subproperty Event Filter.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   SubpropertyEventFilter subpropertyEventFilter = SubpropertyEventFilter.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   SubpropertyEventFilter response =
       analyticsAdminServiceClient.updateSubpropertyEventFilter(
           subpropertyEventFilter, updateMask);
 }
 
Parameters
Name Description
subpropertyEventFilter SubpropertyEventFilter

Required. The subproperty event filter to update.

updateMask FieldMask

Required. The list of fields to update. Field names must be in snake case (for example, "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Returns
Type Description
SubpropertyEventFilter

updateSubpropertyEventFilter(UpdateSubpropertyEventFilterRequest request)

public final SubpropertyEventFilter updateSubpropertyEventFilter(UpdateSubpropertyEventFilterRequest request)

Updates a subproperty Event Filter.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateSubpropertyEventFilterRequest request =
       UpdateSubpropertyEventFilterRequest.newBuilder()
           .setSubpropertyEventFilter(SubpropertyEventFilter.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   SubpropertyEventFilter response =
       analyticsAdminServiceClient.updateSubpropertyEventFilter(request);
 }
 
Parameter
Name Description
request UpdateSubpropertyEventFilterRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
SubpropertyEventFilter

updateSubpropertyEventFilterCallable()

public final UnaryCallable<UpdateSubpropertyEventFilterRequest,SubpropertyEventFilter> updateSubpropertyEventFilterCallable()

Updates a subproperty Event Filter.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   UpdateSubpropertyEventFilterRequest request =
       UpdateSubpropertyEventFilterRequest.newBuilder()
           .setSubpropertyEventFilter(SubpropertyEventFilter.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<SubpropertyEventFilter> future =
       analyticsAdminServiceClient.updateSubpropertyEventFilterCallable().futureCall(request);
   // Do something.
   SubpropertyEventFilter response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateSubpropertyEventFilterRequest,SubpropertyEventFilter>