AnalyticsAdminServiceClient (Google Analytics Admin 0.17.0 API)

java.lang.Object
- com.google.analytics.admin.v1beta.AnalyticsAdminServiceClient

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

@BetaApi
 @Generated(value="by gapic-generator-java")
public class AnalyticsAdminServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

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().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

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.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`AnalyticsAdminServiceClient.ListAccountsFixedSizeCollection`
`static class`	`AnalyticsAdminServiceClient.ListAccountsPage`
`static class`	`AnalyticsAdminServiceClient.ListAccountsPagedResponse`
`static class`	`AnalyticsAdminServiceClient.ListAccountSummariesFixedSizeCollection`
`static class`	`AnalyticsAdminServiceClient.ListAccountSummariesPage`
`static class`	`AnalyticsAdminServiceClient.ListAccountSummariesPagedResponse`
`static class`	`AnalyticsAdminServiceClient.ListConversionEventsFixedSizeCollection`
`static class`	`AnalyticsAdminServiceClient.ListConversionEventsPage`
`static class`	`AnalyticsAdminServiceClient.ListConversionEventsPagedResponse`
`static class`	`AnalyticsAdminServiceClient.ListCustomDimensionsFixedSizeCollection`
`static class`	`AnalyticsAdminServiceClient.ListCustomDimensionsPage`
`static class`	`AnalyticsAdminServiceClient.ListCustomDimensionsPagedResponse`
`static class`	`AnalyticsAdminServiceClient.ListCustomMetricsFixedSizeCollection`
`static class`	`AnalyticsAdminServiceClient.ListCustomMetricsPage`
`static class`	`AnalyticsAdminServiceClient.ListCustomMetricsPagedResponse`
`static class`	`AnalyticsAdminServiceClient.ListDataStreamsFixedSizeCollection`
`static class`	`AnalyticsAdminServiceClient.ListDataStreamsPage`
`static class`	`AnalyticsAdminServiceClient.ListDataStreamsPagedResponse`
`static class`	`AnalyticsAdminServiceClient.ListFirebaseLinksFixedSizeCollection`
`static class`	`AnalyticsAdminServiceClient.ListFirebaseLinksPage`
`static class`	`AnalyticsAdminServiceClient.ListFirebaseLinksPagedResponse`
`static class`	`AnalyticsAdminServiceClient.ListGoogleAdsLinksFixedSizeCollection`
`static class`	`AnalyticsAdminServiceClient.ListGoogleAdsLinksPage`
`static class`	`AnalyticsAdminServiceClient.ListGoogleAdsLinksPagedResponse`
`static class`	`AnalyticsAdminServiceClient.ListMeasurementProtocolSecretsFixedSizeCollection`
`static class`	`AnalyticsAdminServiceClient.ListMeasurementProtocolSecretsPage`
`static class`	`AnalyticsAdminServiceClient.ListMeasurementProtocolSecretsPagedResponse`
`static class`	`AnalyticsAdminServiceClient.ListPropertiesFixedSizeCollection`
`static class`	`AnalyticsAdminServiceClient.ListPropertiesPage`
`static class`	`AnalyticsAdminServiceClient.ListPropertiesPagedResponse`
`static class`	`AnalyticsAdminServiceClient.SearchChangeHistoryEventsFixedSizeCollection`
`static class`	`AnalyticsAdminServiceClient.SearchChangeHistoryEventsPage`
`static class`	`AnalyticsAdminServiceClient.SearchChangeHistoryEventsPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AnalyticsAdminServiceClient(AnalyticsAdminServiceSettings settings)` Constructs an instance of AnalyticsAdminServiceClient, using the given settings.
`protected`	`AnalyticsAdminServiceClient(AnalyticsAdminServiceStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AcknowledgeUserDataCollectionResponse`	`acknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest request)` Acknowledges the terms of user data collection for the specified property.
`com.google.api.gax.rpc.UnaryCallable<AcknowledgeUserDataCollectionRequest,AcknowledgeUserDataCollectionResponse>`	`acknowledgeUserDataCollectionCallable()` Acknowledges the terms of user data collection for the specified property.
`void`	`archiveCustomDimension(ArchiveCustomDimensionRequest request)` Archives a CustomDimension on a property.
`void`	`archiveCustomDimension(CustomDimensionName name)` Archives a CustomDimension on a property.
`void`	`archiveCustomDimension(String name)` Archives a CustomDimension on a property.
`com.google.api.gax.rpc.UnaryCallable<ArchiveCustomDimensionRequest,com.google.protobuf.Empty>`	`archiveCustomDimensionCallable()` Archives a CustomDimension on a property.
`void`	`archiveCustomMetric(ArchiveCustomMetricRequest request)` Archives a CustomMetric on a property.
`void`	`archiveCustomMetric(CustomMetricName name)` Archives a CustomMetric on a property.
`void`	`archiveCustomMetric(String name)` Archives a CustomMetric on a property.
`com.google.api.gax.rpc.UnaryCallable<ArchiveCustomMetricRequest,com.google.protobuf.Empty>`	`archiveCustomMetricCallable()` Archives a CustomMetric on a property.
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static AnalyticsAdminServiceClient`	`create()` Constructs an instance of AnalyticsAdminServiceClient with default settings.
`static AnalyticsAdminServiceClient`	`create(AnalyticsAdminServiceSettings settings)` Constructs an instance of AnalyticsAdminServiceClient, using the given settings.
`static AnalyticsAdminServiceClient`	`create(AnalyticsAdminServiceStub stub)` Constructs an instance of AnalyticsAdminServiceClient, using the given stub for making calls.
`ConversionEvent`	`createConversionEvent(CreateConversionEventRequest request)` Creates a conversion event with the specified attributes.
`ConversionEvent`	`createConversionEvent(PropertyName parent, ConversionEvent conversionEvent)` Creates a conversion event with the specified attributes.
`ConversionEvent`	`createConversionEvent(String parent, ConversionEvent conversionEvent)` Creates a conversion event with the specified attributes.
`com.google.api.gax.rpc.UnaryCallable<CreateConversionEventRequest,ConversionEvent>`	`createConversionEventCallable()` Creates a conversion event with the specified attributes.
`CustomDimension`	`createCustomDimension(CreateCustomDimensionRequest request)` Creates a CustomDimension.
`CustomDimension`	`createCustomDimension(PropertyName parent, CustomDimension customDimension)` Creates a CustomDimension.
`CustomDimension`	`createCustomDimension(String parent, CustomDimension customDimension)` Creates a CustomDimension.
`com.google.api.gax.rpc.UnaryCallable<CreateCustomDimensionRequest,CustomDimension>`	`createCustomDimensionCallable()` Creates a CustomDimension.
`CustomMetric`	`createCustomMetric(CreateCustomMetricRequest request)` Creates a CustomMetric.
`CustomMetric`	`createCustomMetric(PropertyName parent, CustomMetric customMetric)` Creates a CustomMetric.
`CustomMetric`	`createCustomMetric(String parent, CustomMetric customMetric)` Creates a CustomMetric.
`com.google.api.gax.rpc.UnaryCallable<CreateCustomMetricRequest,CustomMetric>`	`createCustomMetricCallable()` Creates a CustomMetric.
`DataStream`	`createDataStream(CreateDataStreamRequest request)` Creates a DataStream.
`DataStream`	`createDataStream(PropertyName parent, DataStream dataStream)` Creates a DataStream.
`DataStream`	`createDataStream(String parent, DataStream dataStream)` Creates a DataStream.
`com.google.api.gax.rpc.UnaryCallable<CreateDataStreamRequest,DataStream>`	`createDataStreamCallable()` Creates a DataStream.
`FirebaseLink`	`createFirebaseLink(CreateFirebaseLinkRequest request)` Creates a FirebaseLink.
`FirebaseLink`	`createFirebaseLink(PropertyName parent, FirebaseLink firebaseLink)` Creates a FirebaseLink.
`FirebaseLink`	`createFirebaseLink(String parent, FirebaseLink firebaseLink)` Creates a FirebaseLink.
`com.google.api.gax.rpc.UnaryCallable<CreateFirebaseLinkRequest,FirebaseLink>`	`createFirebaseLinkCallable()` Creates a FirebaseLink.
`GoogleAdsLink`	`createGoogleAdsLink(CreateGoogleAdsLinkRequest request)` Creates a GoogleAdsLink.
`GoogleAdsLink`	`createGoogleAdsLink(PropertyName parent, GoogleAdsLink googleAdsLink)` Creates a GoogleAdsLink.
`GoogleAdsLink`	`createGoogleAdsLink(String parent, GoogleAdsLink googleAdsLink)` Creates a GoogleAdsLink.
`com.google.api.gax.rpc.UnaryCallable<CreateGoogleAdsLinkRequest,GoogleAdsLink>`	`createGoogleAdsLinkCallable()` Creates a GoogleAdsLink.
`MeasurementProtocolSecret`	`createMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest request)` Creates a measurement protocol secret.
`MeasurementProtocolSecret`	`createMeasurementProtocolSecret(DataStreamName parent, MeasurementProtocolSecret measurementProtocolSecret)` Creates a measurement protocol secret.
`MeasurementProtocolSecret`	`createMeasurementProtocolSecret(String parent, MeasurementProtocolSecret measurementProtocolSecret)` Creates a measurement protocol secret.
`com.google.api.gax.rpc.UnaryCallable<CreateMeasurementProtocolSecretRequest,MeasurementProtocolSecret>`	`createMeasurementProtocolSecretCallable()` Creates a measurement protocol secret.
`Property`	`createProperty(CreatePropertyRequest request)` Creates an "GA4" property with the specified location and attributes.
`Property`	`createProperty(Property property)` Creates an "GA4" property with the specified location and attributes.
`com.google.api.gax.rpc.UnaryCallable<CreatePropertyRequest,Property>`	`createPropertyCallable()` Creates an "GA4" property with the specified location and attributes.
`void`	`deleteAccount(AccountName name)` Marks target Account as soft-deleted (ie: "trashed") and returns it.
`void`	`deleteAccount(DeleteAccountRequest request)` Marks target Account as soft-deleted (ie: "trashed") and returns it.
`void`	`deleteAccount(String name)` Marks target Account as soft-deleted (ie: "trashed") and returns it.
`com.google.api.gax.rpc.UnaryCallable<DeleteAccountRequest,com.google.protobuf.Empty>`	`deleteAccountCallable()` Marks target Account as soft-deleted (ie: "trashed") and returns it.
`void`	`deleteConversionEvent(ConversionEventName name)` Deletes a conversion event in a property.
`void`	`deleteConversionEvent(DeleteConversionEventRequest request)` Deletes a conversion event in a property.
`void`	`deleteConversionEvent(String name)` Deletes a conversion event in a property.
`com.google.api.gax.rpc.UnaryCallable<DeleteConversionEventRequest,com.google.protobuf.Empty>`	`deleteConversionEventCallable()` Deletes a conversion event in a property.
`void`	`deleteDataStream(DataStreamName name)` Deletes a DataStream on a property.
`void`	`deleteDataStream(DeleteDataStreamRequest request)` Deletes a DataStream on a property.
`void`	`deleteDataStream(String name)` Deletes a DataStream on a property.
`com.google.api.gax.rpc.UnaryCallable<DeleteDataStreamRequest,com.google.protobuf.Empty>`	`deleteDataStreamCallable()` Deletes a DataStream on a property.
`void`	`deleteFirebaseLink(DeleteFirebaseLinkRequest request)` Deletes a FirebaseLink on a property
`void`	`deleteFirebaseLink(FirebaseLinkName name)` Deletes a FirebaseLink on a property
`void`	`deleteFirebaseLink(String name)` Deletes a FirebaseLink on a property
`com.google.api.gax.rpc.UnaryCallable<DeleteFirebaseLinkRequest,com.google.protobuf.Empty>`	`deleteFirebaseLinkCallable()` Deletes a FirebaseLink on a property
`void`	`deleteGoogleAdsLink(DeleteGoogleAdsLinkRequest request)` Deletes a GoogleAdsLink on a property
`void`	`deleteGoogleAdsLink(GoogleAdsLinkName name)` Deletes a GoogleAdsLink on a property
`void`	`deleteGoogleAdsLink(String name)` Deletes a GoogleAdsLink on a property
`com.google.api.gax.rpc.UnaryCallable<DeleteGoogleAdsLinkRequest,com.google.protobuf.Empty>`	`deleteGoogleAdsLinkCallable()` Deletes a GoogleAdsLink on a property
`void`	`deleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest request)` Deletes target MeasurementProtocolSecret.
`void`	`deleteMeasurementProtocolSecret(MeasurementProtocolSecretName name)` Deletes target MeasurementProtocolSecret.
`void`	`deleteMeasurementProtocolSecret(String name)` Deletes target MeasurementProtocolSecret.
`com.google.api.gax.rpc.UnaryCallable<DeleteMeasurementProtocolSecretRequest,com.google.protobuf.Empty>`	`deleteMeasurementProtocolSecretCallable()` Deletes target MeasurementProtocolSecret.
`Property`	`deleteProperty(DeletePropertyRequest request)` Marks target Property as soft-deleted (ie: "trashed") and returns it.
`Property`	`deleteProperty(PropertyName name)` Marks target Property as soft-deleted (ie: "trashed") and returns it.
`Property`	`deleteProperty(String name)` Marks target Property as soft-deleted (ie: "trashed") and returns it.
`com.google.api.gax.rpc.UnaryCallable<DeletePropertyRequest,Property>`	`deletePropertyCallable()` Marks target Property as soft-deleted (ie: "trashed") and returns it.
`Account`	`getAccount(AccountName name)` Lookup for a single Account.
`Account`	`getAccount(GetAccountRequest request)` Lookup for a single Account.
`Account`	`getAccount(String name)` Lookup for a single Account.
`com.google.api.gax.rpc.UnaryCallable<GetAccountRequest,Account>`	`getAccountCallable()` Lookup for a single Account.
`ConversionEvent`	`getConversionEvent(ConversionEventName name)` Retrieve a single conversion event.
`ConversionEvent`	`getConversionEvent(GetConversionEventRequest request)` Retrieve a single conversion event.
`ConversionEvent`	`getConversionEvent(String name)` Retrieve a single conversion event.
`com.google.api.gax.rpc.UnaryCallable<GetConversionEventRequest,ConversionEvent>`	`getConversionEventCallable()` Retrieve a single conversion event.
`CustomDimension`	`getCustomDimension(CustomDimensionName name)` Lookup for a single CustomDimension.
`CustomDimension`	`getCustomDimension(GetCustomDimensionRequest request)` Lookup for a single CustomDimension.
`CustomDimension`	`getCustomDimension(String name)` Lookup for a single CustomDimension.
`com.google.api.gax.rpc.UnaryCallable<GetCustomDimensionRequest,CustomDimension>`	`getCustomDimensionCallable()` Lookup for a single CustomDimension.
`CustomMetric`	`getCustomMetric(CustomMetricName name)` Lookup for a single CustomMetric.
`CustomMetric`	`getCustomMetric(GetCustomMetricRequest request)` Lookup for a single CustomMetric.
`CustomMetric`	`getCustomMetric(String name)` Lookup for a single CustomMetric.
`com.google.api.gax.rpc.UnaryCallable<GetCustomMetricRequest,CustomMetric>`	`getCustomMetricCallable()` Lookup for a single CustomMetric.
`DataRetentionSettings`	`getDataRetentionSettings(DataRetentionSettingsName name)` Returns the singleton data retention settings for this property.
`DataRetentionSettings`	`getDataRetentionSettings(GetDataRetentionSettingsRequest request)` Returns the singleton data retention settings for this property.
`DataRetentionSettings`	`getDataRetentionSettings(String name)` Returns the singleton data retention settings for this property.
`com.google.api.gax.rpc.UnaryCallable<GetDataRetentionSettingsRequest,DataRetentionSettings>`	`getDataRetentionSettingsCallable()` Returns the singleton data retention settings for this property.
`DataSharingSettings`	`getDataSharingSettings(DataSharingSettingsName name)` Get data sharing settings on an account.
`DataSharingSettings`	`getDataSharingSettings(GetDataSharingSettingsRequest request)` Get data sharing settings on an account.
`DataSharingSettings`	`getDataSharingSettings(String name)` Get data sharing settings on an account.
`com.google.api.gax.rpc.UnaryCallable<GetDataSharingSettingsRequest,DataSharingSettings>`	`getDataSharingSettingsCallable()` Get data sharing settings on an account.
`DataStream`	`getDataStream(DataStreamName name)` Lookup for a single DataStream.
`DataStream`	`getDataStream(GetDataStreamRequest request)` Lookup for a single DataStream.
`DataStream`	`getDataStream(String name)` Lookup for a single DataStream.
`com.google.api.gax.rpc.UnaryCallable<GetDataStreamRequest,DataStream>`	`getDataStreamCallable()` Lookup for a single DataStream.
`MeasurementProtocolSecret`	`getMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest request)` Lookup for a single "GA4" MeasurementProtocolSecret.
`MeasurementProtocolSecret`	`getMeasurementProtocolSecret(MeasurementProtocolSecretName name)` Lookup for a single "GA4" MeasurementProtocolSecret.
`MeasurementProtocolSecret`	`getMeasurementProtocolSecret(String name)` Lookup for a single "GA4" MeasurementProtocolSecret.
`com.google.api.gax.rpc.UnaryCallable<GetMeasurementProtocolSecretRequest,MeasurementProtocolSecret>`	`getMeasurementProtocolSecretCallable()` Lookup for a single "GA4" MeasurementProtocolSecret.
`Property`	`getProperty(GetPropertyRequest request)` Lookup for a single "GA4" Property.
`Property`	`getProperty(PropertyName name)` Lookup for a single "GA4" Property.
`Property`	`getProperty(String name)` Lookup for a single "GA4" Property.
`com.google.api.gax.rpc.UnaryCallable<GetPropertyRequest,Property>`	`getPropertyCallable()` Lookup for a single "GA4" Property.
`AnalyticsAdminServiceSettings`	`getSettings()`
`AnalyticsAdminServiceStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`AnalyticsAdminServiceClient.ListAccountsPagedResponse`	`listAccounts(ListAccountsRequest request)` Returns all accounts accessible by the caller.
`com.google.api.gax.rpc.UnaryCallable<ListAccountsRequest,ListAccountsResponse>`	`listAccountsCallable()` Returns all accounts accessible by the caller.
`com.google.api.gax.rpc.UnaryCallable<ListAccountsRequest,AnalyticsAdminServiceClient.ListAccountsPagedResponse>`	`listAccountsPagedCallable()` Returns all accounts accessible by the caller.
`AnalyticsAdminServiceClient.ListAccountSummariesPagedResponse`	`listAccountSummaries(ListAccountSummariesRequest request)` Returns summaries of all accounts accessible by the caller.
`com.google.api.gax.rpc.UnaryCallable<ListAccountSummariesRequest,ListAccountSummariesResponse>`	`listAccountSummariesCallable()` Returns summaries of all accounts accessible by the caller.
`com.google.api.gax.rpc.UnaryCallable<ListAccountSummariesRequest,AnalyticsAdminServiceClient.ListAccountSummariesPagedResponse>`	`listAccountSummariesPagedCallable()` Returns summaries of all accounts accessible by the caller.
`AnalyticsAdminServiceClient.ListConversionEventsPagedResponse`	`listConversionEvents(ListConversionEventsRequest request)` Returns a list of conversion events in the specified parent property.
`AnalyticsAdminServiceClient.ListConversionEventsPagedResponse`	`listConversionEvents(PropertyName parent)` Returns a list of conversion events in the specified parent property.
`AnalyticsAdminServiceClient.ListConversionEventsPagedResponse`	`listConversionEvents(String parent)` Returns a list of conversion events in the specified parent property.
`com.google.api.gax.rpc.UnaryCallable<ListConversionEventsRequest,ListConversionEventsResponse>`	`listConversionEventsCallable()` Returns a list of conversion events in the specified parent property.
`com.google.api.gax.rpc.UnaryCallable<ListConversionEventsRequest,AnalyticsAdminServiceClient.ListConversionEventsPagedResponse>`	`listConversionEventsPagedCallable()` Returns a list of conversion events in the specified parent property.
`AnalyticsAdminServiceClient.ListCustomDimensionsPagedResponse`	`listCustomDimensions(ListCustomDimensionsRequest request)` Lists CustomDimensions on a property.
`AnalyticsAdminServiceClient.ListCustomDimensionsPagedResponse`	`listCustomDimensions(PropertyName parent)` Lists CustomDimensions on a property.
`AnalyticsAdminServiceClient.ListCustomDimensionsPagedResponse`	`listCustomDimensions(String parent)` Lists CustomDimensions on a property.
`com.google.api.gax.rpc.UnaryCallable<ListCustomDimensionsRequest,ListCustomDimensionsResponse>`	`listCustomDimensionsCallable()` Lists CustomDimensions on a property.
`com.google.api.gax.rpc.UnaryCallable<ListCustomDimensionsRequest,AnalyticsAdminServiceClient.ListCustomDimensionsPagedResponse>`	`listCustomDimensionsPagedCallable()` Lists CustomDimensions on a property.
`AnalyticsAdminServiceClient.ListCustomMetricsPagedResponse`	`listCustomMetrics(ListCustomMetricsRequest request)` Lists CustomMetrics on a property.
`AnalyticsAdminServiceClient.ListCustomMetricsPagedResponse`	`listCustomMetrics(PropertyName parent)` Lists CustomMetrics on a property.
`AnalyticsAdminServiceClient.ListCustomMetricsPagedResponse`	`listCustomMetrics(String parent)` Lists CustomMetrics on a property.
`com.google.api.gax.rpc.UnaryCallable<ListCustomMetricsRequest,ListCustomMetricsResponse>`	`listCustomMetricsCallable()` Lists CustomMetrics on a property.
`com.google.api.gax.rpc.UnaryCallable<ListCustomMetricsRequest,AnalyticsAdminServiceClient.ListCustomMetricsPagedResponse>`	`listCustomMetricsPagedCallable()` Lists CustomMetrics on a property.
`AnalyticsAdminServiceClient.ListDataStreamsPagedResponse`	`listDataStreams(ListDataStreamsRequest request)` Lists DataStreams on a property.
`AnalyticsAdminServiceClient.ListDataStreamsPagedResponse`	`listDataStreams(PropertyName parent)` Lists DataStreams on a property.
`AnalyticsAdminServiceClient.ListDataStreamsPagedResponse`	`listDataStreams(String parent)` Lists DataStreams on a property.
`com.google.api.gax.rpc.UnaryCallable<ListDataStreamsRequest,ListDataStreamsResponse>`	`listDataStreamsCallable()` Lists DataStreams on a property.
`com.google.api.gax.rpc.UnaryCallable<ListDataStreamsRequest,AnalyticsAdminServiceClient.ListDataStreamsPagedResponse>`	`listDataStreamsPagedCallable()` Lists DataStreams on a property.
`AnalyticsAdminServiceClient.ListFirebaseLinksPagedResponse`	`listFirebaseLinks(ListFirebaseLinksRequest request)` Lists FirebaseLinks on a property.
`AnalyticsAdminServiceClient.ListFirebaseLinksPagedResponse`	`listFirebaseLinks(PropertyName parent)` Lists FirebaseLinks on a property.
`AnalyticsAdminServiceClient.ListFirebaseLinksPagedResponse`	`listFirebaseLinks(String parent)` Lists FirebaseLinks on a property.
`com.google.api.gax.rpc.UnaryCallable<ListFirebaseLinksRequest,ListFirebaseLinksResponse>`	`listFirebaseLinksCallable()` Lists FirebaseLinks on a property.
`com.google.api.gax.rpc.UnaryCallable<ListFirebaseLinksRequest,AnalyticsAdminServiceClient.ListFirebaseLinksPagedResponse>`	`listFirebaseLinksPagedCallable()` Lists FirebaseLinks on a property.
`AnalyticsAdminServiceClient.ListGoogleAdsLinksPagedResponse`	`listGoogleAdsLinks(ListGoogleAdsLinksRequest request)` Lists GoogleAdsLinks on a property.
`AnalyticsAdminServiceClient.ListGoogleAdsLinksPagedResponse`	`listGoogleAdsLinks(PropertyName parent)` Lists GoogleAdsLinks on a property.
`AnalyticsAdminServiceClient.ListGoogleAdsLinksPagedResponse`	`listGoogleAdsLinks(String parent)` Lists GoogleAdsLinks on a property.
`com.google.api.gax.rpc.UnaryCallable<ListGoogleAdsLinksRequest,ListGoogleAdsLinksResponse>`	`listGoogleAdsLinksCallable()` Lists GoogleAdsLinks on a property.
`com.google.api.gax.rpc.UnaryCallable<ListGoogleAdsLinksRequest,AnalyticsAdminServiceClient.ListGoogleAdsLinksPagedResponse>`	`listGoogleAdsLinksPagedCallable()` Lists GoogleAdsLinks on a property.
`AnalyticsAdminServiceClient.ListMeasurementProtocolSecretsPagedResponse`	`listMeasurementProtocolSecrets(DataStreamName parent)` Returns child MeasurementProtocolSecrets under the specified parent Property.
`AnalyticsAdminServiceClient.ListMeasurementProtocolSecretsPagedResponse`	`listMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest request)` Returns child MeasurementProtocolSecrets under the specified parent Property.
`AnalyticsAdminServiceClient.ListMeasurementProtocolSecretsPagedResponse`	`listMeasurementProtocolSecrets(String parent)` Returns child MeasurementProtocolSecrets under the specified parent Property.
`com.google.api.gax.rpc.UnaryCallable<ListMeasurementProtocolSecretsRequest,ListMeasurementProtocolSecretsResponse>`	`listMeasurementProtocolSecretsCallable()` Returns child MeasurementProtocolSecrets under the specified parent Property.
`com.google.api.gax.rpc.UnaryCallable<ListMeasurementProtocolSecretsRequest,AnalyticsAdminServiceClient.ListMeasurementProtocolSecretsPagedResponse>`	`listMeasurementProtocolSecretsPagedCallable()` Returns child MeasurementProtocolSecrets under the specified parent Property.
`AnalyticsAdminServiceClient.ListPropertiesPagedResponse`	`listProperties(ListPropertiesRequest request)` Returns child Properties under the specified parent Account.
`com.google.api.gax.rpc.UnaryCallable<ListPropertiesRequest,ListPropertiesResponse>`	`listPropertiesCallable()` Returns child Properties under the specified parent Account.
`com.google.api.gax.rpc.UnaryCallable<ListPropertiesRequest,AnalyticsAdminServiceClient.ListPropertiesPagedResponse>`	`listPropertiesPagedCallable()` Returns child Properties under the specified parent Account.
`ProvisionAccountTicketResponse`	`provisionAccountTicket(ProvisionAccountTicketRequest request)` Requests a ticket for creating an account.
`com.google.api.gax.rpc.UnaryCallable<ProvisionAccountTicketRequest,ProvisionAccountTicketResponse>`	`provisionAccountTicketCallable()` Requests a ticket for creating an account.
`AnalyticsAdminServiceClient.SearchChangeHistoryEventsPagedResponse`	`searchChangeHistoryEvents(SearchChangeHistoryEventsRequest request)` Searches through all changes to an account or its children given the specified set of filters.
`com.google.api.gax.rpc.UnaryCallable<SearchChangeHistoryEventsRequest,SearchChangeHistoryEventsResponse>`	`searchChangeHistoryEventsCallable()` Searches through all changes to an account or its children given the specified set of filters.
`com.google.api.gax.rpc.UnaryCallable<SearchChangeHistoryEventsRequest,AnalyticsAdminServiceClient.SearchChangeHistoryEventsPagedResponse>`	`searchChangeHistoryEventsPagedCallable()` Searches through all changes to an account or its children given the specified set of filters.
`void`	`shutdown()`
`void`	`shutdownNow()`
`Account`	`updateAccount(Account account, com.google.protobuf.FieldMask updateMask)` Updates an account.
`Account`	`updateAccount(UpdateAccountRequest request)` Updates an account.
`com.google.api.gax.rpc.UnaryCallable<UpdateAccountRequest,Account>`	`updateAccountCallable()` Updates an account.
`CustomDimension`	`updateCustomDimension(CustomDimension customDimension, com.google.protobuf.FieldMask updateMask)` Updates a CustomDimension on a property.
`CustomDimension`	`updateCustomDimension(UpdateCustomDimensionRequest request)` Updates a CustomDimension on a property.
`com.google.api.gax.rpc.UnaryCallable<UpdateCustomDimensionRequest,CustomDimension>`	`updateCustomDimensionCallable()` Updates a CustomDimension on a property.
`CustomMetric`	`updateCustomMetric(CustomMetric customMetric, com.google.protobuf.FieldMask updateMask)` Updates a CustomMetric on a property.
`CustomMetric`	`updateCustomMetric(UpdateCustomMetricRequest request)` Updates a CustomMetric on a property.
`com.google.api.gax.rpc.UnaryCallable<UpdateCustomMetricRequest,CustomMetric>`	`updateCustomMetricCallable()` Updates a CustomMetric on a property.
`DataRetentionSettings`	`updateDataRetentionSettings(DataRetentionSettings dataRetentionSettings, com.google.protobuf.FieldMask updateMask)` Updates the singleton data retention settings for this property.
`DataRetentionSettings`	`updateDataRetentionSettings(UpdateDataRetentionSettingsRequest request)` Updates the singleton data retention settings for this property.
`com.google.api.gax.rpc.UnaryCallable<UpdateDataRetentionSettingsRequest,DataRetentionSettings>`	`updateDataRetentionSettingsCallable()` Updates the singleton data retention settings for this property.
`DataStream`	`updateDataStream(DataStream dataStream, com.google.protobuf.FieldMask updateMask)` Updates a DataStream on a property.
`DataStream`	`updateDataStream(UpdateDataStreamRequest request)` Updates a DataStream on a property.
`com.google.api.gax.rpc.UnaryCallable<UpdateDataStreamRequest,DataStream>`	`updateDataStreamCallable()` Updates a DataStream on a property.
`GoogleAdsLink`	`updateGoogleAdsLink(GoogleAdsLink googleAdsLink, com.google.protobuf.FieldMask updateMask)` Updates a GoogleAdsLink on a property
`GoogleAdsLink`	`updateGoogleAdsLink(UpdateGoogleAdsLinkRequest request)` Updates a GoogleAdsLink on a property
`com.google.api.gax.rpc.UnaryCallable<UpdateGoogleAdsLinkRequest,GoogleAdsLink>`	`updateGoogleAdsLinkCallable()` Updates a GoogleAdsLink on a property
`MeasurementProtocolSecret`	`updateMeasurementProtocolSecret(MeasurementProtocolSecret measurementProtocolSecret, com.google.protobuf.FieldMask updateMask)` Updates a measurement protocol secret.
`MeasurementProtocolSecret`	`updateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest request)` Updates a measurement protocol secret.
`com.google.api.gax.rpc.UnaryCallable<UpdateMeasurementProtocolSecretRequest,MeasurementProtocolSecret>`	`updateMeasurementProtocolSecretCallable()` Updates a measurement protocol secret.
`Property`	`updateProperty(Property property, com.google.protobuf.FieldMask updateMask)` Updates a property.
`Property`	`updateProperty(UpdatePropertyRequest request)` Updates a property.
`com.google.api.gax.rpc.UnaryCallable<UpdatePropertyRequest,Property>`	`updatePropertyCallable()` Updates a property.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- AnalyticsAdminServiceClient
```
protected AnalyticsAdminServiceClient(AnalyticsAdminServiceSettings settings)
                               throws IOException
```
  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.
  
  Throws:
  
  IOException
- AnalyticsAdminServiceClient
```
protected AnalyticsAdminServiceClient(AnalyticsAdminServiceStub stub)
```

Method Detail

create

public static final AnalyticsAdminServiceClient create()
                                                throws IOException

Constructs an instance of AnalyticsAdminServiceClient with default settings.

Throws:: IOException

create
```
public static final AnalyticsAdminServiceClient create(AnalyticsAdminServiceSettings settings)
                                                throws IOException
```
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.

Throws:

IOException

create
```
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).

getSettings

public final AnalyticsAdminServiceSettings getSettings()

getStub

public AnalyticsAdminServiceStub getStub()

getAccount

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);
 }

Parameters:: name - Required. The name of the account to lookup. Format: accounts/{account} Example: "accounts/100"
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getAccount

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);
 }

Parameters:: name - Required. The name of the account to lookup. Format: accounts/{account} Example: "accounts/100"
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getAccount

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);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getAccountCallable

public final com.google.api.gax.rpc.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();
 }

listAccounts

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);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listAccountsPagedCallable

public final com.google.api.gax.rpc.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);
   }
 }

listAccountsCallable

public final com.google.api.gax.rpc.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;
     }
   }
 }

deleteAccount
```
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, UserLinks) 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);
 }
 
```
Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteAccount
```
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, UserLinks) 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);
 }
 
```
Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteAccount

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, UserLinks) 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);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteAccountCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteAccountRequest,com.google.protobuf.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.

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();
 }

updateAccount

public final Account updateAccount(Account account,
                                   com.google.protobuf.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:: account - Required. The account to update. The account's `name` field is used to identify the account.; updateMask - 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.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

updateAccount

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);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

updateAccountCallable

public final com.google.api.gax.rpc.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();
 }

provisionAccountTicket

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);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

provisionAccountTicketCallable

public final com.google.api.gax.rpc.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();
 }

listAccountSummaries

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);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listAccountSummariesPagedCallable

public final com.google.api.gax.rpc.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);
   }
 }

listAccountSummariesCallable

public final com.google.api.gax.rpc.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;
     }
   }
 }

getProperty

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);
 }

Parameters:: name - Required. The name of the property to lookup. Format: properties/{property_id} Example: "properties/1000"
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getProperty

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);
 }

Parameters:: name - Required. The name of the property to lookup. Format: properties/{property_id} Example: "properties/1000"
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getProperty

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);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getPropertyCallable

public final com.google.api.gax.rpc.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();
 }

listProperties

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);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listPropertiesPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListPropertiesRequest,AnalyticsAdminServiceClient.ListPropertiesPagedResponse> listPropertiesPagedCallable()

Returns child Properties under the specified parent 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()) {
   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);
   }
 }

listPropertiesCallable

public final com.google.api.gax.rpc.UnaryCallable<ListPropertiesRequest,ListPropertiesResponse> listPropertiesCallable()

Returns child Properties under the specified parent 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()) {
   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;
     }
   }
 }

createProperty

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);
 }

Parameters:: property - Required. The property to create. Note: the supplied property must specify its parent.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createProperty

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);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createPropertyCallable

public final com.google.api.gax.rpc.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();
 }

deleteProperty
```
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, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772
Returns an error if the target is not found, or is not an 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);
 }
 
```
Parameters:

name - Required. The name of the Property to soft-delete. Format: properties/{property_id} Example: "properties/1000"

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteProperty
```
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, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772
Returns an error if the target is not found, or is not an 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);
 }
 
```
Parameters:

name - Required. The name of the Property to soft-delete. Format: properties/{property_id} Example: "properties/1000"

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteProperty

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, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772

Returns an error if the target is not found, or is not an 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);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deletePropertyCallable

public final com.google.api.gax.rpc.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.

Returns an error if the target is not found, or is not an 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();
 }

updateProperty

public final Property updateProperty(Property property,
                                     com.google.protobuf.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:: property - Required. The property to update. The property's `name` field is used to identify the property to be updated.; updateMask - 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.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

updateProperty

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);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

updatePropertyCallable

public final com.google.api.gax.rpc.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();
 }

createFirebaseLink

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:: parent - Required. Format: properties/{property_id} Example: properties/1234; firebaseLink - Required. The Firebase link to create.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createFirebaseLink

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:: parent - Required. Format: properties/{property_id} Example: properties/1234; firebaseLink - Required. The Firebase link to create.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createFirebaseLink

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);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createFirebaseLinkCallable

public final com.google.api.gax.rpc.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();
 }

deleteFirebaseLink

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);
 }

Parameters:: name - Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: properties/1234/firebaseLinks/5678
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteFirebaseLink

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);
 }

Parameters:: name - Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: properties/1234/firebaseLinks/5678
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteFirebaseLink

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);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteFirebaseLinkCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteFirebaseLinkRequest,com.google.protobuf.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();
 }

listFirebaseLinks

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);
   }
 }

Parameters:: parent - Required. Format: properties/{property_id} Example: properties/1234
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listFirebaseLinks

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);
   }
 }

Parameters:: parent - Required. Format: properties/{property_id} Example: properties/1234
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listFirebaseLinks

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);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listFirebaseLinksPagedCallable

public final com.google.api.gax.rpc.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);
   }
 }

listFirebaseLinksCallable

public final com.google.api.gax.rpc.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;
     }
   }
 }

createGoogleAdsLink

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:: parent - Required. Example format: properties/1234; googleAdsLink - Required. The GoogleAdsLink to create.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createGoogleAdsLink

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:: parent - Required. Example format: properties/1234; googleAdsLink - Required. The GoogleAdsLink to create.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createGoogleAdsLink

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);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createGoogleAdsLinkCallable

public final com.google.api.gax.rpc.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();
 }

updateGoogleAdsLink

public final GoogleAdsLink updateGoogleAdsLink(GoogleAdsLink googleAdsLink,
                                               com.google.protobuf.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:: googleAdsLink - The GoogleAdsLink to update; updateMask - 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.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

updateGoogleAdsLink

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);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

updateGoogleAdsLinkCallable

public final com.google.api.gax.rpc.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();
 }

deleteGoogleAdsLink

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);
 }

Parameters:: name - Required. Example format: properties/1234/googleAdsLinks/5678
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteGoogleAdsLink

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);
 }

Parameters:: name - Required. Example format: properties/1234/googleAdsLinks/5678
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteGoogleAdsLink

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);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteGoogleAdsLinkCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteGoogleAdsLinkRequest,com.google.protobuf.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();
 }

listGoogleAdsLinks

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);
   }
 }

Parameters:: parent - Required. Example format: properties/1234
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listGoogleAdsLinks

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);
   }
 }

Parameters:: parent - Required. Example format: properties/1234
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listGoogleAdsLinks

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);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listGoogleAdsLinksPagedCallable

public final com.google.api.gax.rpc.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);
   }
 }

listGoogleAdsLinksCallable

public final com.google.api.gax.rpc.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;
     }
   }
 }

getDataSharingSettings

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);
 }

Parameters:: name - Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: "accounts/1000/dataSharingSettings"
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getDataSharingSettings

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);
 }

Parameters:: name - Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: "accounts/1000/dataSharingSettings"
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getDataSharingSettings

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);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getDataSharingSettingsCallable

public final com.google.api.gax.rpc.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();
 }

getMeasurementProtocolSecret

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);
 }

Parameters:: name - Required. The name of the measurement protocol secret to lookup. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getMeasurementProtocolSecret

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);
 }

Parameters:: name - Required. The name of the measurement protocol secret to lookup. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getMeasurementProtocolSecret

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);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getMeasurementProtocolSecretCallable

public final com.google.api.gax.rpc.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();
 }

listMeasurementProtocolSecrets

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);
   }
 }

Parameters:: parent - Required. The resource name of the parent stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listMeasurementProtocolSecrets

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);
   }
 }

Parameters:: parent - Required. The resource name of the parent stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listMeasurementProtocolSecrets

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);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listMeasurementProtocolSecretsPagedCallable

public final com.google.api.gax.rpc.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);
   }
 }

listMeasurementProtocolSecretsCallable

public final com.google.api.gax.rpc.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;
     }
   }
 }

createMeasurementProtocolSecret

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:: parent - Required. The parent resource where this secret will be created. Format: properties/{property}/dataStreams/{dataStream}; measurementProtocolSecret - Required. The measurement protocol secret to create.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createMeasurementProtocolSecret

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:: parent - Required. The parent resource where this secret will be created. Format: properties/{property}/dataStreams/{dataStream}; measurementProtocolSecret - Required. The measurement protocol secret to create.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createMeasurementProtocolSecret

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);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createMeasurementProtocolSecretCallable

public final com.google.api.gax.rpc.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();
 }

deleteMeasurementProtocolSecret

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);
 }

Parameters:: name - Required. The name of the MeasurementProtocolSecret to delete. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteMeasurementProtocolSecret

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);
 }

Parameters:: name - Required. The name of the MeasurementProtocolSecret to delete. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteMeasurementProtocolSecret

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);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteMeasurementProtocolSecretCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteMeasurementProtocolSecretRequest,com.google.protobuf.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();
 }

updateMeasurementProtocolSecret

public final MeasurementProtocolSecret updateMeasurementProtocolSecret(MeasurementProtocolSecret measurementProtocolSecret,
                                                                       com.google.protobuf.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:: measurementProtocolSecret - Required. The measurement protocol secret to update.; updateMask - The list of fields to be updated. Omitted fields will not be updated.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

updateMeasurementProtocolSecret

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);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

updateMeasurementProtocolSecretCallable

public final com.google.api.gax.rpc.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();
 }

acknowledgeUserDataCollection

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 via 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);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

acknowledgeUserDataCollectionCallable

public final com.google.api.gax.rpc.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 via 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();
 }

searchChangeHistoryEvents

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);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

searchChangeHistoryEventsPagedCallable

public final com.google.api.gax.rpc.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);
   }
 }

searchChangeHistoryEventsCallable

public final com.google.api.gax.rpc.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;
     }
   }
 }

createConversionEvent

public final ConversionEvent createConversionEvent(PropertyName parent,
                                                   ConversionEvent conversionEvent)

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:: parent - Required. The resource name of the parent property where this conversion event will be created. Format: properties/123; conversionEvent - Required. The conversion event to create.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createConversionEvent

public final ConversionEvent createConversionEvent(String parent,
                                                   ConversionEvent conversionEvent)

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:: parent - Required. The resource name of the parent property where this conversion event will be created. Format: properties/123; conversionEvent - Required. The conversion event to create.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createConversionEvent

public final ConversionEvent createConversionEvent(CreateConversionEventRequest request)

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);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createConversionEventCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateConversionEventRequest,ConversionEvent> createConversionEventCallable()

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();
 }

getConversionEvent

public final ConversionEvent getConversionEvent(ConversionEventName name)

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);
 }

Parameters:: name - Required. The resource name of the conversion event to retrieve. Format: properties/{property}/conversionEvents/{conversion_event} Example: "properties/123/conversionEvents/456"
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getConversionEvent

public final ConversionEvent getConversionEvent(String name)

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);
 }

Parameters:: name - Required. The resource name of the conversion event to retrieve. Format: properties/{property}/conversionEvents/{conversion_event} Example: "properties/123/conversionEvents/456"
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getConversionEvent

public final ConversionEvent getConversionEvent(GetConversionEventRequest request)

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);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getConversionEventCallable

public final com.google.api.gax.rpc.UnaryCallable<GetConversionEventRequest,ConversionEvent> getConversionEventCallable()

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();
 }

deleteConversionEvent

public final void deleteConversionEvent(ConversionEventName name)

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);
 }

Parameters:: name - Required. The resource name of the conversion event to delete. Format: properties/{property}/conversionEvents/{conversion_event} Example: "properties/123/conversionEvents/456"
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteConversionEvent

public final void deleteConversionEvent(String name)

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);
 }

Parameters:: name - Required. The resource name of the conversion event to delete. Format: properties/{property}/conversionEvents/{conversion_event} Example: "properties/123/conversionEvents/456"
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteConversionEvent

public final void deleteConversionEvent(DeleteConversionEventRequest request)

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);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteConversionEventCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteConversionEventRequest,com.google.protobuf.Empty> deleteConversionEventCallable()

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();
 }

listConversionEvents

public final AnalyticsAdminServiceClient.ListConversionEventsPagedResponse listConversionEvents(PropertyName parent)

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);
   }
 }

Parameters:: parent - Required. The resource name of the parent property. Example: 'properties/123'
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listConversionEvents

public final AnalyticsAdminServiceClient.ListConversionEventsPagedResponse listConversionEvents(String parent)

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);
   }
 }

Parameters:: parent - Required. The resource name of the parent property. Example: 'properties/123'
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listConversionEvents

public final AnalyticsAdminServiceClient.ListConversionEventsPagedResponse listConversionEvents(ListConversionEventsRequest request)

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);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listConversionEventsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListConversionEventsRequest,AnalyticsAdminServiceClient.ListConversionEventsPagedResponse> listConversionEventsPagedCallable()

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);
   }
 }

listConversionEventsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListConversionEventsRequest,ListConversionEventsResponse> listConversionEventsCallable()

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;
     }
   }
 }

createCustomDimension

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:: parent - Required. Example format: properties/1234; customDimension - Required. The CustomDimension to create.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createCustomDimension

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:: parent - Required. Example format: properties/1234; customDimension - Required. The CustomDimension to create.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createCustomDimension

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);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createCustomDimensionCallable

public final com.google.api.gax.rpc.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();
 }

updateCustomDimension

public final CustomDimension updateCustomDimension(CustomDimension customDimension,
                                                   com.google.protobuf.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:: customDimension - The CustomDimension to update; updateMask - 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.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

updateCustomDimension

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);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

updateCustomDimensionCallable

public final com.google.api.gax.rpc.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();
 }

listCustomDimensions

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);
   }
 }

Parameters:: parent - Required. Example format: properties/1234
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listCustomDimensions

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);
   }
 }

Parameters:: parent - Required. Example format: properties/1234
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listCustomDimensions

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);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listCustomDimensionsPagedCallable

public final com.google.api.gax.rpc.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);
   }
 }

listCustomDimensionsCallable

public final com.google.api.gax.rpc.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;
     }
   }
 }

archiveCustomDimension

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);
 }

Parameters:: name - Required. The name of the CustomDimension to archive. Example format: properties/1234/customDimensions/5678
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

archiveCustomDimension

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);
 }

Parameters:: name - Required. The name of the CustomDimension to archive. Example format: properties/1234/customDimensions/5678
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

archiveCustomDimension

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);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

archiveCustomDimensionCallable

public final com.google.api.gax.rpc.UnaryCallable<ArchiveCustomDimensionRequest,com.google.protobuf.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();
 }

getCustomDimension

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);
 }

Parameters:: name - Required. The name of the CustomDimension to get. Example format: properties/1234/customDimensions/5678
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getCustomDimension

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);
 }

Parameters:: name - Required. The name of the CustomDimension to get. Example format: properties/1234/customDimensions/5678
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getCustomDimension

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);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getCustomDimensionCallable

public final com.google.api.gax.rpc.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();
 }

createCustomMetric

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:: parent - Required. Example format: properties/1234; customMetric - Required. The CustomMetric to create.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createCustomMetric

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:: parent - Required. Example format: properties/1234; customMetric - Required. The CustomMetric to create.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createCustomMetric

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);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createCustomMetricCallable

public final com.google.api.gax.rpc.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();
 }

updateCustomMetric

public final CustomMetric updateCustomMetric(CustomMetric customMetric,
                                             com.google.protobuf.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:: customMetric - The CustomMetric to update; updateMask - 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.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

updateCustomMetric

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);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

updateCustomMetricCallable

public final com.google.api.gax.rpc.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();
 }

listCustomMetrics

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);
   }
 }

Parameters:: parent - Required. Example format: properties/1234
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listCustomMetrics

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);
   }
 }

Parameters:: parent - Required. Example format: properties/1234
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listCustomMetrics

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);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listCustomMetricsPagedCallable

public final com.google.api.gax.rpc.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);
   }
 }

listCustomMetricsCallable

public final com.google.api.gax.rpc.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;
     }
   }
 }

archiveCustomMetric

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);
 }

Parameters:: name - Required. The name of the CustomMetric to archive. Example format: properties/1234/customMetrics/5678
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

archiveCustomMetric

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);
 }

Parameters:: name - Required. The name of the CustomMetric to archive. Example format: properties/1234/customMetrics/5678
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

archiveCustomMetric

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);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

archiveCustomMetricCallable

public final com.google.api.gax.rpc.UnaryCallable<ArchiveCustomMetricRequest,com.google.protobuf.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();
 }

getCustomMetric

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);
 }

Parameters:: name - Required. The name of the CustomMetric to get. Example format: properties/1234/customMetrics/5678
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getCustomMetric

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);
 }

Parameters:: name - Required. The name of the CustomMetric to get. Example format: properties/1234/customMetrics/5678
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getCustomMetric

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);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getCustomMetricCallable

public final com.google.api.gax.rpc.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();
 }

getDataRetentionSettings

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);
 }

Parameters:: name - Required. The name of the settings to lookup. Format: properties/{property}/dataRetentionSettings Example: "properties/1000/dataRetentionSettings"
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getDataRetentionSettings

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);
 }

Parameters:: name - Required. The name of the settings to lookup. Format: properties/{property}/dataRetentionSettings Example: "properties/1000/dataRetentionSettings"
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getDataRetentionSettings

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);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getDataRetentionSettingsCallable

public final com.google.api.gax.rpc.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();
 }

updateDataRetentionSettings

public final DataRetentionSettings updateDataRetentionSettings(DataRetentionSettings dataRetentionSettings,
                                                               com.google.protobuf.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:: dataRetentionSettings - Required. The settings to update. The `name` field is used to identify the settings to be updated.; updateMask - 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.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

updateDataRetentionSettings

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);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

updateDataRetentionSettingsCallable

public final com.google.api.gax.rpc.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();
 }

createDataStream

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:: parent - Required. Example format: properties/1234; dataStream - Required. The DataStream to create.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createDataStream

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:: parent - Required. Example format: properties/1234; dataStream - Required. The DataStream to create.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createDataStream

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);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createDataStreamCallable

public final com.google.api.gax.rpc.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();
 }

deleteDataStream

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);
 }

Parameters:: name - Required. The name of the DataStream to delete. Example format: properties/1234/dataStreams/5678
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteDataStream

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);
 }

Parameters:: name - Required. The name of the DataStream to delete. Example format: properties/1234/dataStreams/5678
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteDataStream

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);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteDataStreamCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteDataStreamRequest,com.google.protobuf.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();
 }

updateDataStream

public final DataStream updateDataStream(DataStream dataStream,
                                         com.google.protobuf.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:: dataStream - The DataStream to update; updateMask - 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.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

updateDataStream

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);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

updateDataStreamCallable

public final com.google.api.gax.rpc.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();
 }