@BetaApi @Generated(value="by gapic-generator-java") public class AnalyticsAdminServiceClient extends Object implements com.google.api.gax.core.BackgroundResource
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().
| Method | Description | Method Variants |
|---|---|---|
GetAccount |
Lookup for a single Account. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListAccounts |
Returns all accounts accessible by the caller. Note that these accounts might not currently have GA properties. Soft-deleted (ie: "trashed") accounts are excluded by default. Returns an empty list if no relevant accounts are found. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteAccount |
Marks target Account as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI. If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateAccount |
Updates an account. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ProvisionAccountTicket |
Requests a ticket for creating an account. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListAccountSummaries |
Returns summaries of all accounts accessible by the caller. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetProperty |
Lookup for a single GA Property. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListProperties |
Returns child Properties under the specified parent Account. Properties will be excluded if the caller does not have access. Soft-deleted (ie: "trashed") properties are excluded by default. Returns an empty list if no relevant properties are found. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateProperty |
Creates a Google Analytics property with the specified location and attributes. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteProperty |
Marks target Property as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI. If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateProperty |
Updates a property. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateFirebaseLink |
Creates a FirebaseLink. Properties can have at most one FirebaseLink. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteFirebaseLink |
Deletes a FirebaseLink on a property |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListFirebaseLinks |
Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateGoogleAdsLink |
Creates a GoogleAdsLink. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateGoogleAdsLink |
Updates a GoogleAdsLink on a property |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteGoogleAdsLink |
Deletes a GoogleAdsLink on a property |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListGoogleAdsLinks |
Lists GoogleAdsLinks on a property. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetDataSharingSettings |
Get data sharing settings on an account. Data sharing settings are singletons. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetMeasurementProtocolSecret |
Lookup for a single MeasurementProtocolSecret. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListMeasurementProtocolSecrets |
Returns child MeasurementProtocolSecrets under the specified parent Property. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateMeasurementProtocolSecret |
Creates a measurement protocol secret. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteMeasurementProtocolSecret |
Deletes target MeasurementProtocolSecret. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateMeasurementProtocolSecret |
Updates a measurement protocol secret. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
AcknowledgeUserDataCollection |
Acknowledges the terms of user data collection for the specified property. This acknowledgement must be completed (either in the Google Analytics UI or through this API) before MeasurementProtocolSecret resources may be created. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
SearchChangeHistoryEvents |
Searches through all changes to an account or its children given the specified set of filters. Only returns the subset of changes supported by the API. The UI may return additional changes. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateConversionEvent |
Deprecated: Use `CreateKeyEvent` instead. Creates a conversion event with the specified attributes. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateConversionEvent |
Deprecated: Use `UpdateKeyEvent` instead. Updates a conversion event with the specified attributes. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetConversionEvent |
Deprecated: Use `GetKeyEvent` instead. Retrieve a single conversion event. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteConversionEvent |
Deprecated: Use `DeleteKeyEvent` instead. Deletes a conversion event in a property. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListConversionEvents |
Deprecated: Use `ListKeyEvents` instead. Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateKeyEvent |
Creates a Key Event. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateKeyEvent |
Updates a Key Event. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetKeyEvent |
Retrieve a single Key Event. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteKeyEvent |
Deletes a Key Event. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListKeyEvents |
Returns a list of Key Events in the specified parent property. Returns an empty list if no Key Events are found. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateCustomDimension |
Creates a CustomDimension. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateCustomDimension |
Updates a CustomDimension on a property. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListCustomDimensions |
Lists CustomDimensions on a property. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ArchiveCustomDimension |
Archives a CustomDimension on a property. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetCustomDimension |
Lookup for a single CustomDimension. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateCustomMetric |
Creates a CustomMetric. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateCustomMetric |
Updates a CustomMetric on a property. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListCustomMetrics |
Lists CustomMetrics on a property. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ArchiveCustomMetric |
Archives a CustomMetric on a property. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetCustomMetric |
Lookup for a single CustomMetric. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetDataRetentionSettings |
Returns the singleton data retention settings for this property. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateDataRetentionSettings |
Updates the singleton data retention settings for this property. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateDataStream |
Creates a DataStream. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteDataStream |
Deletes a DataStream on a property. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateDataStream |
Updates a DataStream on a property. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListDataStreams |
Lists DataStreams on a property. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetDataStream |
Lookup for a single DataStream. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
RunAccessReport |
Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA UI Reporting, GA UI Explorations, GA Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents). To give your feedback on this API, complete the [Google Analytics Access Reports feedback](https://docs.google.com/forms/d/e/1FAIpQLSdmEBUrMzAEdiEKk5TV5dEHvDUZDRlgWYdQdAeSdtR4hVjEhw/viewform) form. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return 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.
| Modifier | Constructor and Description |
|---|---|
protected |
AnalyticsAdminServiceClient(AnalyticsAdminServiceSettings settings)
Constructs an instance of AnalyticsAdminServiceClient, using the given settings.
|
protected |
AnalyticsAdminServiceClient(AnalyticsAdminServiceStub stub) |
| 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)
Deprecated.
This method is deprecated and will be removed in the next major version update.
|
ConversionEvent |
createConversionEvent(PropertyName parent,
ConversionEvent conversionEvent)
Deprecated.
This method is deprecated and will be removed in the next major version update.
|
ConversionEvent |
createConversionEvent(String parent,
ConversionEvent conversionEvent)
Deprecated.
This method is deprecated and will be removed in the next major version update.
|
com.google.api.gax.rpc.UnaryCallable<CreateConversionEventRequest,ConversionEvent> |
createConversionEventCallable()
Deprecated.
This method is deprecated and will be removed in the next major version update.
|
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.
|
KeyEvent |
createKeyEvent(CreateKeyEventRequest request)
Creates a Key Event.
|
KeyEvent |
createKeyEvent(PropertyName parent,
KeyEvent keyEvent)
Creates a Key Event.
|
KeyEvent |
createKeyEvent(String parent,
KeyEvent keyEvent)
Creates a Key Event.
|
com.google.api.gax.rpc.UnaryCallable<CreateKeyEventRequest,KeyEvent> |
createKeyEventCallable()
Creates a Key Event.
|
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 a Google Analytics property with the specified location and attributes.
|
Property |
createProperty(Property property)
Creates a Google Analytics property with the specified location and attributes.
|
com.google.api.gax.rpc.UnaryCallable<CreatePropertyRequest,Property> |
createPropertyCallable()
Creates a Google Analytics 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)
Deprecated.
This method is deprecated and will be removed in the next major version update.
|
void |
deleteConversionEvent(DeleteConversionEventRequest request)
Deprecated.
This method is deprecated and will be removed in the next major version update.
|
void |
deleteConversionEvent(String name)
Deprecated.
This method is deprecated and will be removed in the next major version update.
|
com.google.api.gax.rpc.UnaryCallable<DeleteConversionEventRequest,com.google.protobuf.Empty> |
deleteConversionEventCallable()
Deprecated.
This method is deprecated and will be removed in the next major version update.
|
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
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
|
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);
}
|
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);
}
|
com.google.api.gax.rpc.UnaryCallable<DeleteFirebaseLinkRequest,com.google.protobuf.Empty> |
deleteFirebaseLinkCallable()
Deletes a FirebaseLink on a property
Sample code:
{@code
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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
|
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);
}
|
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);
}
|
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);
}
|
com.google.api.gax.rpc.UnaryCallable<DeleteGoogleAdsLinkRequest,com.google.protobuf.Empty> |
deleteGoogleAdsLinkCallable()
Deletes a GoogleAdsLink on a property
Sample code:
{@code
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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
|
void |
deleteKeyEvent(DeleteKeyEventRequest request)
Deletes a Key Event.
|
void |
deleteKeyEvent(KeyEventName name)
Deletes a Key Event.
|
void |
deleteKeyEvent(String name)
Deletes a Key Event.
|
com.google.api.gax.rpc.UnaryCallable<DeleteKeyEventRequest,com.google.protobuf.Empty> |
deleteKeyEventCallable()
Deletes a Key Event.
|
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)
Deprecated.
This method is deprecated and will be removed in the next major version update.
|
ConversionEvent |
getConversionEvent(GetConversionEventRequest request)
Deprecated.
This method is deprecated and will be removed in the next major version update.
|
ConversionEvent |
getConversionEvent(String name)
Deprecated.
This method is deprecated and will be removed in the next major version update.
|
com.google.api.gax.rpc.UnaryCallable<GetConversionEventRequest,ConversionEvent> |
getConversionEventCallable()
Deprecated.
This method is deprecated and will be removed in the next major version update.
|
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.
|
KeyEvent |
getKeyEvent(GetKeyEventRequest request)
Retrieve a single Key Event.
|
KeyEvent |
getKeyEvent(KeyEventName name)
Retrieve a single Key Event.
|
KeyEvent |
getKeyEvent(String name)
Retrieve a single Key Event.
|
com.google.api.gax.rpc.UnaryCallable<GetKeyEventRequest,KeyEvent> |
getKeyEventCallable()
Retrieve a single Key Event.
|
MeasurementProtocolSecret |
getMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest request)
Lookup for a single MeasurementProtocolSecret.
|
MeasurementProtocolSecret |
getMeasurementProtocolSecret(MeasurementProtocolSecretName name)
Lookup for a single MeasurementProtocolSecret.
|
MeasurementProtocolSecret |
getMeasurementProtocolSecret(String name)
Lookup for a single MeasurementProtocolSecret.
|
com.google.api.gax.rpc.UnaryCallable<GetMeasurementProtocolSecretRequest,MeasurementProtocolSecret> |
getMeasurementProtocolSecretCallable()
Lookup for a single MeasurementProtocolSecret.
|
Property |
getProperty(GetPropertyRequest request)
Lookup for a single GA Property.
|
Property |
getProperty(PropertyName name)
Lookup for a single GA Property.
|
Property |
getProperty(String name)
Lookup for a single GA Property.
|
com.google.api.gax.rpc.UnaryCallable<GetPropertyRequest,Property> |
getPropertyCallable()
Lookup for a single GA 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)
Deprecated.
This method is deprecated and will be removed in the next major version update.
|
AnalyticsAdminServiceClient.ListConversionEventsPagedResponse |
listConversionEvents(PropertyName parent)
Deprecated.
This method is deprecated and will be removed in the next major version update.
|
AnalyticsAdminServiceClient.ListConversionEventsPagedResponse |
listConversionEvents(String parent)
Deprecated.
This method is deprecated and will be removed in the next major version update.
|
com.google.api.gax.rpc.UnaryCallable<ListConversionEventsRequest,ListConversionEventsResponse> |
listConversionEventsCallable()
Deprecated.
This method is deprecated and will be removed in the next major version update.
|
com.google.api.gax.rpc.UnaryCallable<ListConversionEventsRequest,AnalyticsAdminServiceClient.ListConversionEventsPagedResponse> |
listConversionEventsPagedCallable()
Deprecated.
This method is deprecated and will be removed in the next major version update.
|
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.ListKeyEventsPagedResponse |
listKeyEvents(ListKeyEventsRequest request)
Returns a list of Key Events in the specified parent property.
|
AnalyticsAdminServiceClient.ListKeyEventsPagedResponse |
listKeyEvents(PropertyName parent)
Returns a list of Key Events in the specified parent property.
|
AnalyticsAdminServiceClient.ListKeyEventsPagedResponse |
listKeyEvents(String parent)
Returns a list of Key Events in the specified parent property.
|
com.google.api.gax.rpc.UnaryCallable<ListKeyEventsRequest,ListKeyEventsResponse> |
listKeyEventsCallable()
Returns a list of Key Events in the specified parent property.
|
com.google.api.gax.rpc.UnaryCallable<ListKeyEventsRequest,AnalyticsAdminServiceClient.ListKeyEventsPagedResponse> |
listKeyEventsPagedCallable()
Returns a list of Key Events in the specified parent 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.
|
RunAccessReportResponse |
runAccessReport(RunAccessReportRequest request)
Returns a customized report of data access records.
|
com.google.api.gax.rpc.UnaryCallable<RunAccessReportRequest,RunAccessReportResponse> |
runAccessReportCallable()
Returns a customized report of data access records.
|
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.
|
ConversionEvent |
updateConversionEvent(ConversionEvent conversionEvent,
com.google.protobuf.FieldMask updateMask)
Deprecated.
This method is deprecated and will be removed in the next major version update.
|
ConversionEvent |
updateConversionEvent(UpdateConversionEventRequest request)
Deprecated.
This method is deprecated and will be removed in the next major version update.
|
com.google.api.gax.rpc.UnaryCallable<UpdateConversionEventRequest,ConversionEvent> |
updateConversionEventCallable()
Deprecated.
This method is deprecated and will be removed in the next major version update.
|
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
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
|
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);
}
|
com.google.api.gax.rpc.UnaryCallable<UpdateGoogleAdsLinkRequest,GoogleAdsLink> |
updateGoogleAdsLinkCallable()
Updates a GoogleAdsLink on a property
Sample code:
{@code
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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
|
KeyEvent |
updateKeyEvent(KeyEvent keyEvent,
com.google.protobuf.FieldMask updateMask)
Updates a Key Event.
|
KeyEvent |
updateKeyEvent(UpdateKeyEventRequest request)
Updates a Key Event.
|
com.google.api.gax.rpc.UnaryCallable<UpdateKeyEventRequest,KeyEvent> |
updateKeyEventCallable()
Updates a Key Event.
|
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.
|
protected AnalyticsAdminServiceClient(AnalyticsAdminServiceSettings settings) throws IOException
IOExceptionprotected AnalyticsAdminServiceClient(AnalyticsAdminServiceStub stub)
public static final AnalyticsAdminServiceClient create() throws IOException
IOExceptionpublic static final AnalyticsAdminServiceClient create(AnalyticsAdminServiceSettings settings) throws IOException
IOExceptionpublic static final AnalyticsAdminServiceClient create(AnalyticsAdminServiceStub stub)
public final AnalyticsAdminServiceSettings getSettings()
public AnalyticsAdminServiceStub getStub()
public final Account getAccount(AccountName name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
name - Required. The name of the account to lookup. Format: accounts/{account} Example:
"accounts/100"com.google.api.gax.rpc.ApiException - if the remote call failspublic final Account getAccount(String name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
name - Required. The name of the account to lookup. Format: accounts/{account} Example:
"accounts/100"com.google.api.gax.rpc.ApiException - if the remote call failspublic final Account getAccount(GetAccountRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<GetAccountRequest,Account> getAccountCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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();
}
public final AnalyticsAdminServiceClient.ListAccountsPagedResponse listAccounts(ListAccountsRequest request)
Note that these accounts might not currently have GA properties. Soft-deleted (ie: "trashed") accounts are excluded by default. Returns an empty list if no relevant accounts are found.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<ListAccountsRequest,AnalyticsAdminServiceClient.ListAccountsPagedResponse> listAccountsPagedCallable()
Note that these accounts might not currently have GA properties. Soft-deleted (ie: "trashed") accounts are excluded by default. Returns an empty list if no relevant accounts are found.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
}
public final com.google.api.gax.rpc.UnaryCallable<ListAccountsRequest,ListAccountsResponse> listAccountsCallable()
Note that these accounts might not currently have GA properties. Soft-deleted (ie: "trashed") accounts are excluded by default. Returns an empty list if no relevant accounts are found.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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;
}
}
}
public final void deleteAccount(AccountName name)
This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI.
If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772
Returns an error if the target is not found.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
AnalyticsAdminServiceClient.create()) {
AccountName name = AccountName.of("[ACCOUNT]");
analyticsAdminServiceClient.deleteAccount(name);
}
name - Required. The name of the Account to soft-delete. Format: accounts/{account}
Example: "accounts/100"com.google.api.gax.rpc.ApiException - if the remote call failspublic final void deleteAccount(String name)
This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI.
If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772
Returns an error if the target is not found.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
AnalyticsAdminServiceClient.create()) {
String name = AccountName.of("[ACCOUNT]").toString();
analyticsAdminServiceClient.deleteAccount(name);
}
name - Required. The name of the Account to soft-delete. Format: accounts/{account}
Example: "accounts/100"com.google.api.gax.rpc.ApiException - if the remote call failspublic final void deleteAccount(DeleteAccountRequest request)
This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI.
If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772
Returns an error if the target is not found.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
AnalyticsAdminServiceClient.create()) {
DeleteAccountRequest request =
DeleteAccountRequest.newBuilder().setName(AccountName.of("[ACCOUNT]").toString()).build();
analyticsAdminServiceClient.deleteAccount(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<DeleteAccountRequest,com.google.protobuf.Empty> deleteAccountCallable()
This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI.
If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772
Returns an error if the target is not found.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
AnalyticsAdminServiceClient.create()) {
DeleteAccountRequest request =
DeleteAccountRequest.newBuilder().setName(AccountName.of("[ACCOUNT]").toString()).build();
ApiFuture<Empty> future =
analyticsAdminServiceClient.deleteAccountCallable().futureCall(request);
// Do something.
future.get();
}
public final Account updateAccount(Account account, com.google.protobuf.FieldMask updateMask)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
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
(for example, "field_to_update"). Omitted fields will not be updated. To replace the entire
entity, use one path with the string "*" to match all fields.com.google.api.gax.rpc.ApiException - if the remote call failspublic final Account updateAccount(UpdateAccountRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<UpdateAccountRequest,Account> updateAccountCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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();
}
public final ProvisionAccountTicketResponse provisionAccountTicket(ProvisionAccountTicketRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<ProvisionAccountTicketRequest,ProvisionAccountTicketResponse> provisionAccountTicketCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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();
}
public final AnalyticsAdminServiceClient.ListAccountSummariesPagedResponse listAccountSummaries(ListAccountSummariesRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<ListAccountSummariesRequest,AnalyticsAdminServiceClient.ListAccountSummariesPagedResponse> listAccountSummariesPagedCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
}
public final com.google.api.gax.rpc.UnaryCallable<ListAccountSummariesRequest,ListAccountSummariesResponse> listAccountSummariesCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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;
}
}
}
public final Property getProperty(PropertyName name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
name - Required. The name of the property to lookup. Format: properties/{property_id}
Example: "properties/1000"com.google.api.gax.rpc.ApiException - if the remote call failspublic final Property getProperty(String name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
name - Required. The name of the property to lookup. Format: properties/{property_id}
Example: "properties/1000"com.google.api.gax.rpc.ApiException - if the remote call failspublic final Property getProperty(GetPropertyRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<GetPropertyRequest,Property> getPropertyCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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();
}
public final AnalyticsAdminServiceClient.ListPropertiesPagedResponse listProperties(ListPropertiesRequest request)
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);
}
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<ListPropertiesRequest,AnalyticsAdminServiceClient.ListPropertiesPagedResponse> listPropertiesPagedCallable()
Properties will be excluded if the caller does not have access. Soft-deleted (ie: "trashed") properties are excluded by default. Returns an empty list if no relevant properties are found.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
AnalyticsAdminServiceClient.create()) {
ListPropertiesRequest request =
ListPropertiesRequest.newBuilder()
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setShowDeleted(true)
.build();
ApiFuture<Property> future =
analyticsAdminServiceClient.listPropertiesPagedCallable().futureCall(request);
// Do something.
for (Property element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
public final com.google.api.gax.rpc.UnaryCallable<ListPropertiesRequest,ListPropertiesResponse> listPropertiesCallable()
Properties will be excluded if the caller does not have access. Soft-deleted (ie: "trashed") properties are excluded by default. Returns an empty list if no relevant properties are found.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
AnalyticsAdminServiceClient.create()) {
ListPropertiesRequest request =
ListPropertiesRequest.newBuilder()
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setShowDeleted(true)
.build();
while (true) {
ListPropertiesResponse response =
analyticsAdminServiceClient.listPropertiesCallable().call(request);
for (Property element : response.getPropertiesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
public final Property createProperty(Property property)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
property - Required. The property to create. Note: the supplied property must specify its
parent.com.google.api.gax.rpc.ApiException - if the remote call failspublic final Property createProperty(CreatePropertyRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<CreatePropertyRequest,Property> createPropertyCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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();
}
public final Property deleteProperty(PropertyName name)
This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI.
If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772
Returns an error if the target is not found.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
name - Required. The name of the Property to soft-delete. Format: properties/{property_id}
Example: "properties/1000"com.google.api.gax.rpc.ApiException - if the remote call failspublic final Property deleteProperty(String name)
This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI.
If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772
Returns an error if the target is not found.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
name - Required. The name of the Property to soft-delete. Format: properties/{property_id}
Example: "properties/1000"com.google.api.gax.rpc.ApiException - if the remote call failspublic final Property deleteProperty(DeletePropertyRequest request)
This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI.
If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772
Returns an error if the target is not found.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<DeletePropertyRequest,Property> deletePropertyCallable()
This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI.
If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772
Returns an error if the target is not found.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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();
}
public final Property updateProperty(Property property, com.google.protobuf.FieldMask updateMask)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
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.com.google.api.gax.rpc.ApiException - if the remote call failspublic final Property updateProperty(UpdatePropertyRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<UpdatePropertyRequest,Property> updatePropertyCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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();
}
public final FirebaseLink createFirebaseLink(PropertyName parent, FirebaseLink 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);
}
parent - Required. Format: properties/{property_id}
Example: `properties/1234`
firebaseLink - Required. The Firebase link to create.com.google.api.gax.rpc.ApiException - if the remote call failspublic final FirebaseLink createFirebaseLink(String parent, FirebaseLink 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);
}
parent - Required. Format: properties/{property_id}
Example: `properties/1234`
firebaseLink - Required. The Firebase link to create.com.google.api.gax.rpc.ApiException - if the remote call failspublic final FirebaseLink createFirebaseLink(CreateFirebaseLinkRequest request)
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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<CreateFirebaseLinkRequest,FirebaseLink> createFirebaseLinkCallable()
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();
}
public final void deleteFirebaseLink(FirebaseLinkName name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
name - Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id}
Example: `properties/1234/firebaseLinks/5678`
com.google.api.gax.rpc.ApiException - if the remote call failspublic final void deleteFirebaseLink(String name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
name - Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id}
Example: `properties/1234/firebaseLinks/5678`
com.google.api.gax.rpc.ApiException - if the remote call failspublic final void deleteFirebaseLink(DeleteFirebaseLinkRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<DeleteFirebaseLinkRequest,com.google.protobuf.Empty> deleteFirebaseLinkCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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();
}
public final AnalyticsAdminServiceClient.ListFirebaseLinksPagedResponse listFirebaseLinks(PropertyName parent)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
}
parent - Required. Format: properties/{property_id}
Example: `properties/1234`
com.google.api.gax.rpc.ApiException - if the remote call failspublic final AnalyticsAdminServiceClient.ListFirebaseLinksPagedResponse listFirebaseLinks(String parent)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
}
parent - Required. Format: properties/{property_id}
Example: `properties/1234`
com.google.api.gax.rpc.ApiException - if the remote call failspublic final AnalyticsAdminServiceClient.ListFirebaseLinksPagedResponse listFirebaseLinks(ListFirebaseLinksRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<ListFirebaseLinksRequest,AnalyticsAdminServiceClient.ListFirebaseLinksPagedResponse> listFirebaseLinksPagedCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
}
public final com.google.api.gax.rpc.UnaryCallable<ListFirebaseLinksRequest,ListFirebaseLinksResponse> listFirebaseLinksCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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;
}
}
}
public final GoogleAdsLink createGoogleAdsLink(PropertyName parent, GoogleAdsLink 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);
}
parent - Required. Example format: properties/1234googleAdsLink - Required. The GoogleAdsLink to create.com.google.api.gax.rpc.ApiException - if the remote call failspublic final GoogleAdsLink createGoogleAdsLink(String parent, GoogleAdsLink 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);
}
parent - Required. Example format: properties/1234googleAdsLink - Required. The GoogleAdsLink to create.com.google.api.gax.rpc.ApiException - if the remote call failspublic final GoogleAdsLink createGoogleAdsLink(CreateGoogleAdsLinkRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<CreateGoogleAdsLinkRequest,GoogleAdsLink> createGoogleAdsLinkCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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();
}
public final GoogleAdsLink updateGoogleAdsLink(GoogleAdsLink googleAdsLink, com.google.protobuf.FieldMask updateMask)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
googleAdsLink - The GoogleAdsLink to updateupdateMask - 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.com.google.api.gax.rpc.ApiException - if the remote call failspublic final GoogleAdsLink updateGoogleAdsLink(UpdateGoogleAdsLinkRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<UpdateGoogleAdsLinkRequest,GoogleAdsLink> updateGoogleAdsLinkCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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();
}
public final void deleteGoogleAdsLink(GoogleAdsLinkName name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
name - Required. Example format: properties/1234/googleAdsLinks/5678com.google.api.gax.rpc.ApiException - if the remote call failspublic final void deleteGoogleAdsLink(String name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
name - Required. Example format: properties/1234/googleAdsLinks/5678com.google.api.gax.rpc.ApiException - if the remote call failspublic final void deleteGoogleAdsLink(DeleteGoogleAdsLinkRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<DeleteGoogleAdsLinkRequest,com.google.protobuf.Empty> deleteGoogleAdsLinkCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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();
}
public final AnalyticsAdminServiceClient.ListGoogleAdsLinksPagedResponse listGoogleAdsLinks(PropertyName parent)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
}
parent - Required. Example format: properties/1234com.google.api.gax.rpc.ApiException - if the remote call failspublic final AnalyticsAdminServiceClient.ListGoogleAdsLinksPagedResponse listGoogleAdsLinks(String parent)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
}
parent - Required. Example format: properties/1234com.google.api.gax.rpc.ApiException - if the remote call failspublic final AnalyticsAdminServiceClient.ListGoogleAdsLinksPagedResponse listGoogleAdsLinks(ListGoogleAdsLinksRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<ListGoogleAdsLinksRequest,AnalyticsAdminServiceClient.ListGoogleAdsLinksPagedResponse> listGoogleAdsLinksPagedCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
}
public final com.google.api.gax.rpc.UnaryCallable<ListGoogleAdsLinksRequest,ListGoogleAdsLinksResponse> listGoogleAdsLinksCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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;
}
}
}
public final DataSharingSettings getDataSharingSettings(DataSharingSettingsName name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
name - Required. The name of the settings to lookup. Format:
accounts/{account}/dataSharingSettings
Example: `accounts/1000/dataSharingSettings`
com.google.api.gax.rpc.ApiException - if the remote call failspublic final DataSharingSettings getDataSharingSettings(String name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
name - Required. The name of the settings to lookup. Format:
accounts/{account}/dataSharingSettings
Example: `accounts/1000/dataSharingSettings`
com.google.api.gax.rpc.ApiException - if the remote call failspublic final DataSharingSettings getDataSharingSettings(GetDataSharingSettingsRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<GetDataSharingSettingsRequest,DataSharingSettings> getDataSharingSettingsCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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();
}
public final MeasurementProtocolSecret getMeasurementProtocolSecret(MeasurementProtocolSecretName name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
name - Required. The name of the measurement protocol secret to lookup. Format:
properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}com.google.api.gax.rpc.ApiException - if the remote call failspublic final MeasurementProtocolSecret getMeasurementProtocolSecret(String name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
name - Required. The name of the measurement protocol secret to lookup. Format:
properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}com.google.api.gax.rpc.ApiException - if the remote call failspublic final MeasurementProtocolSecret getMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<GetMeasurementProtocolSecretRequest,MeasurementProtocolSecret> getMeasurementProtocolSecretCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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();
}
public final AnalyticsAdminServiceClient.ListMeasurementProtocolSecretsPagedResponse listMeasurementProtocolSecrets(DataStreamName parent)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
}
parent - Required. The resource name of the parent stream. Format:
properties/{property}/dataStreams/{dataStream}/measurementProtocolSecretscom.google.api.gax.rpc.ApiException - if the remote call failspublic final AnalyticsAdminServiceClient.ListMeasurementProtocolSecretsPagedResponse listMeasurementProtocolSecrets(String parent)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
}
parent - Required. The resource name of the parent stream. Format:
properties/{property}/dataStreams/{dataStream}/measurementProtocolSecretscom.google.api.gax.rpc.ApiException - if the remote call failspublic final AnalyticsAdminServiceClient.ListMeasurementProtocolSecretsPagedResponse listMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<ListMeasurementProtocolSecretsRequest,AnalyticsAdminServiceClient.ListMeasurementProtocolSecretsPagedResponse> listMeasurementProtocolSecretsPagedCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
}
public final com.google.api.gax.rpc.UnaryCallable<ListMeasurementProtocolSecretsRequest,ListMeasurementProtocolSecretsResponse> listMeasurementProtocolSecretsCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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;
}
}
}
public final MeasurementProtocolSecret createMeasurementProtocolSecret(DataStreamName parent, MeasurementProtocolSecret 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()) {
DataStreamName parent = DataStreamName.of("[PROPERTY]", "[DATA_STREAM]");
MeasurementProtocolSecret measurementProtocolSecret =
MeasurementProtocolSecret.newBuilder().build();
MeasurementProtocolSecret response =
analyticsAdminServiceClient.createMeasurementProtocolSecret(
parent, measurementProtocolSecret);
}
parent - Required. The parent resource where this secret will be created. Format:
properties/{property}/dataStreams/{dataStream}measurementProtocolSecret - Required. The measurement protocol secret to create.com.google.api.gax.rpc.ApiException - if the remote call failspublic final MeasurementProtocolSecret createMeasurementProtocolSecret(String parent, MeasurementProtocolSecret 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 parent = DataStreamName.of("[PROPERTY]", "[DATA_STREAM]").toString();
MeasurementProtocolSecret measurementProtocolSecret =
MeasurementProtocolSecret.newBuilder().build();
MeasurementProtocolSecret response =
analyticsAdminServiceClient.createMeasurementProtocolSecret(
parent, measurementProtocolSecret);
}
parent - Required. The parent resource where this secret will be created. Format:
properties/{property}/dataStreams/{dataStream}measurementProtocolSecret - Required. The measurement protocol secret to create.com.google.api.gax.rpc.ApiException - if the remote call failspublic final MeasurementProtocolSecret createMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<CreateMeasurementProtocolSecretRequest,MeasurementProtocolSecret> createMeasurementProtocolSecretCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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();
}
public final void deleteMeasurementProtocolSecret(MeasurementProtocolSecretName name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
name - Required. The name of the MeasurementProtocolSecret to delete. Format:
properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}com.google.api.gax.rpc.ApiException - if the remote call failspublic final void deleteMeasurementProtocolSecret(String name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
name - Required. The name of the MeasurementProtocolSecret to delete. Format:
properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}com.google.api.gax.rpc.ApiException - if the remote call failspublic final void deleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<DeleteMeasurementProtocolSecretRequest,com.google.protobuf.Empty> deleteMeasurementProtocolSecretCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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();
}
public final MeasurementProtocolSecret updateMeasurementProtocolSecret(MeasurementProtocolSecret measurementProtocolSecret, com.google.protobuf.FieldMask updateMask)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
measurementProtocolSecret - Required. The measurement protocol secret to update.updateMask - Required. The list of fields to be updated. Omitted fields will not be
updated.com.google.api.gax.rpc.ApiException - if the remote call failspublic final MeasurementProtocolSecret updateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<UpdateMeasurementProtocolSecretRequest,MeasurementProtocolSecret> updateMeasurementProtocolSecretCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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();
}
public final AcknowledgeUserDataCollectionResponse acknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest request)
This acknowledgement must be completed (either in the Google Analytics UI or through this API) before MeasurementProtocolSecret resources may be created.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
AnalyticsAdminServiceClient.create()) {
AcknowledgeUserDataCollectionRequest request =
AcknowledgeUserDataCollectionRequest.newBuilder()
.setProperty(PropertyName.of("[PROPERTY]").toString())
.setAcknowledgement("acknowledgement1769490938")
.build();
AcknowledgeUserDataCollectionResponse response =
analyticsAdminServiceClient.acknowledgeUserDataCollection(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<AcknowledgeUserDataCollectionRequest,AcknowledgeUserDataCollectionResponse> acknowledgeUserDataCollectionCallable()
This acknowledgement must be completed (either in the Google Analytics UI or through this API) before MeasurementProtocolSecret resources may be created.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
AnalyticsAdminServiceClient.create()) {
AcknowledgeUserDataCollectionRequest request =
AcknowledgeUserDataCollectionRequest.newBuilder()
.setProperty(PropertyName.of("[PROPERTY]").toString())
.setAcknowledgement("acknowledgement1769490938")
.build();
ApiFuture<AcknowledgeUserDataCollectionResponse> future =
analyticsAdminServiceClient.acknowledgeUserDataCollectionCallable().futureCall(request);
// Do something.
AcknowledgeUserDataCollectionResponse response = future.get();
}
public final AnalyticsAdminServiceClient.SearchChangeHistoryEventsPagedResponse searchChangeHistoryEvents(SearchChangeHistoryEventsRequest request)
Only returns the subset of changes supported by the API. The UI may return additional changes.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<SearchChangeHistoryEventsRequest,AnalyticsAdminServiceClient.SearchChangeHistoryEventsPagedResponse> searchChangeHistoryEventsPagedCallable()
Only returns the subset of changes supported by the API. The UI may return additional changes.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
}
public final com.google.api.gax.rpc.UnaryCallable<SearchChangeHistoryEventsRequest,SearchChangeHistoryEventsResponse> searchChangeHistoryEventsCallable()
Only returns the subset of changes supported by the API. The UI may return additional changes.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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;
}
}
}
@Deprecated public final ConversionEvent createConversionEvent(PropertyName parent, ConversionEvent conversionEvent)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
parent - Required. The resource name of the parent property where this conversion event
will be created. Format: properties/123conversionEvent - Required. The conversion event to create.com.google.api.gax.rpc.ApiException - if the remote call fails@Deprecated public final ConversionEvent createConversionEvent(String parent, ConversionEvent conversionEvent)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
parent - Required. The resource name of the parent property where this conversion event
will be created. Format: properties/123conversionEvent - Required. The conversion event to create.com.google.api.gax.rpc.ApiException - if the remote call fails@Deprecated public final ConversionEvent createConversionEvent(CreateConversionEventRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call fails@Deprecated public final com.google.api.gax.rpc.UnaryCallable<CreateConversionEventRequest,ConversionEvent> createConversionEventCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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();
}
@Deprecated public final ConversionEvent updateConversionEvent(ConversionEvent conversionEvent, com.google.protobuf.FieldMask updateMask)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
AnalyticsAdminServiceClient.create()) {
ConversionEvent conversionEvent = ConversionEvent.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
ConversionEvent response =
analyticsAdminServiceClient.updateConversionEvent(conversionEvent, updateMask);
}
conversionEvent - Required. The conversion event 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.com.google.api.gax.rpc.ApiException - if the remote call fails@Deprecated public final ConversionEvent updateConversionEvent(UpdateConversionEventRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
AnalyticsAdminServiceClient.create()) {
UpdateConversionEventRequest request =
UpdateConversionEventRequest.newBuilder()
.setConversionEvent(ConversionEvent.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ConversionEvent response = analyticsAdminServiceClient.updateConversionEvent(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call fails@Deprecated public final com.google.api.gax.rpc.UnaryCallable<UpdateConversionEventRequest,ConversionEvent> updateConversionEventCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
AnalyticsAdminServiceClient.create()) {
UpdateConversionEventRequest request =
UpdateConversionEventRequest.newBuilder()
.setConversionEvent(ConversionEvent.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<ConversionEvent> future =
analyticsAdminServiceClient.updateConversionEventCallable().futureCall(request);
// Do something.
ConversionEvent response = future.get();
}
@Deprecated public final ConversionEvent getConversionEvent(ConversionEventName name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
name - Required. The resource name of the conversion event to retrieve. Format:
properties/{property}/conversionEvents/{conversion_event} Example:
"properties/123/conversionEvents/456"com.google.api.gax.rpc.ApiException - if the remote call fails@Deprecated public final ConversionEvent getConversionEvent(String name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
name - Required. The resource name of the conversion event to retrieve. Format:
properties/{property}/conversionEvents/{conversion_event} Example:
"properties/123/conversionEvents/456"com.google.api.gax.rpc.ApiException - if the remote call fails@Deprecated public final ConversionEvent getConversionEvent(GetConversionEventRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call fails@Deprecated public final com.google.api.gax.rpc.UnaryCallable<GetConversionEventRequest,ConversionEvent> getConversionEventCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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();
}
@Deprecated public final void deleteConversionEvent(ConversionEventName name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
name - Required. The resource name of the conversion event to delete. Format:
properties/{property}/conversionEvents/{conversion_event} Example:
"properties/123/conversionEvents/456"com.google.api.gax.rpc.ApiException - if the remote call fails@Deprecated public final void deleteConversionEvent(String name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
name - Required. The resource name of the conversion event to delete. Format:
properties/{property}/conversionEvents/{conversion_event} Example:
"properties/123/conversionEvents/456"com.google.api.gax.rpc.ApiException - if the remote call fails@Deprecated public final void deleteConversionEvent(DeleteConversionEventRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call fails@Deprecated public final com.google.api.gax.rpc.UnaryCallable<DeleteConversionEventRequest,com.google.protobuf.Empty> deleteConversionEventCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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();
}
@Deprecated public final AnalyticsAdminServiceClient.ListConversionEventsPagedResponse listConversionEvents(PropertyName parent)
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);
}
}
parent - Required. The resource name of the parent property. Example: 'properties/123'com.google.api.gax.rpc.ApiException - if the remote call fails@Deprecated public final AnalyticsAdminServiceClient.ListConversionEventsPagedResponse listConversionEvents(String parent)
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);
}
}
parent - Required. The resource name of the parent property. Example: 'properties/123'com.google.api.gax.rpc.ApiException - if the remote call fails@Deprecated public final AnalyticsAdminServiceClient.ListConversionEventsPagedResponse listConversionEvents(ListConversionEventsRequest request)
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);
}
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call fails@Deprecated public final com.google.api.gax.rpc.UnaryCallable<ListConversionEventsRequest,AnalyticsAdminServiceClient.ListConversionEventsPagedResponse> listConversionEventsPagedCallable()
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);
}
}
@Deprecated public final com.google.api.gax.rpc.UnaryCallable<ListConversionEventsRequest,ListConversionEventsResponse> listConversionEventsCallable()
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;
}
}
}
public final KeyEvent createKeyEvent(PropertyName parent, KeyEvent keyEvent)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
AnalyticsAdminServiceClient.create()) {
PropertyName parent = PropertyName.of("[PROPERTY]");
KeyEvent keyEvent = KeyEvent.newBuilder().build();
KeyEvent response = analyticsAdminServiceClient.createKeyEvent(parent, keyEvent);
}
parent - Required. The resource name of the parent property where this Key Event will be
created. Format: properties/123keyEvent - Required. The Key Event to create.com.google.api.gax.rpc.ApiException - if the remote call failspublic final KeyEvent createKeyEvent(String parent, KeyEvent keyEvent)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
AnalyticsAdminServiceClient.create()) {
String parent = PropertyName.of("[PROPERTY]").toString();
KeyEvent keyEvent = KeyEvent.newBuilder().build();
KeyEvent response = analyticsAdminServiceClient.createKeyEvent(parent, keyEvent);
}
parent - Required. The resource name of the parent property where this Key Event will be
created. Format: properties/123keyEvent - Required. The Key Event to create.com.google.api.gax.rpc.ApiException - if the remote call failspublic final KeyEvent createKeyEvent(CreateKeyEventRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
AnalyticsAdminServiceClient.create()) {
CreateKeyEventRequest request =
CreateKeyEventRequest.newBuilder()
.setKeyEvent(KeyEvent.newBuilder().build())
.setParent(PropertyName.of("[PROPERTY]").toString())
.build();
KeyEvent response = analyticsAdminServiceClient.createKeyEvent(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<CreateKeyEventRequest,KeyEvent> createKeyEventCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
AnalyticsAdminServiceClient.create()) {
CreateKeyEventRequest request =
CreateKeyEventRequest.newBuilder()
.setKeyEvent(KeyEvent.newBuilder().build())
.setParent(PropertyName.of("[PROPERTY]").toString())
.build();
ApiFuture<KeyEvent> future =
analyticsAdminServiceClient.createKeyEventCallable().futureCall(request);
// Do something.
KeyEvent response = future.get();
}
public final KeyEvent updateKeyEvent(KeyEvent keyEvent, com.google.protobuf.FieldMask updateMask)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
AnalyticsAdminServiceClient.create()) {
KeyEvent keyEvent = KeyEvent.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
KeyEvent response = analyticsAdminServiceClient.updateKeyEvent(keyEvent, updateMask);
}
keyEvent - Required. The Key Event 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.com.google.api.gax.rpc.ApiException - if the remote call failspublic final KeyEvent updateKeyEvent(UpdateKeyEventRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
AnalyticsAdminServiceClient.create()) {
UpdateKeyEventRequest request =
UpdateKeyEventRequest.newBuilder()
.setKeyEvent(KeyEvent.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
KeyEvent response = analyticsAdminServiceClient.updateKeyEvent(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<UpdateKeyEventRequest,KeyEvent> updateKeyEventCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
AnalyticsAdminServiceClient.create()) {
UpdateKeyEventRequest request =
UpdateKeyEventRequest.newBuilder()
.setKeyEvent(KeyEvent.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<KeyEvent> future =
analyticsAdminServiceClient.updateKeyEventCallable().futureCall(request);
// Do something.
KeyEvent response = future.get();
}
public final KeyEvent getKeyEvent(KeyEventName name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
AnalyticsAdminServiceClient.create()) {
KeyEventName name = KeyEventName.of("[PROPERTY]", "[KEY_EVENT]");
KeyEvent response = analyticsAdminServiceClient.getKeyEvent(name);
}
name - Required. The resource name of the Key Event to retrieve. Format:
properties/{property}/keyEvents/{key_event} Example: "properties/123/keyEvents/456"com.google.api.gax.rpc.ApiException - if the remote call failspublic final KeyEvent getKeyEvent(String name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
AnalyticsAdminServiceClient.create()) {
String name = KeyEventName.of("[PROPERTY]", "[KEY_EVENT]").toString();
KeyEvent response = analyticsAdminServiceClient.getKeyEvent(name);
}
name - Required. The resource name of the Key Event to retrieve. Format:
properties/{property}/keyEvents/{key_event} Example: "properties/123/keyEvents/456"com.google.api.gax.rpc.ApiException - if the remote call failspublic final KeyEvent getKeyEvent(GetKeyEventRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
AnalyticsAdminServiceClient.create()) {
GetKeyEventRequest request =
GetKeyEventRequest.newBuilder()
.setName(KeyEventName.of("[PROPERTY]", "[KEY_EVENT]").toString())
.build();
KeyEvent response = analyticsAdminServiceClient.getKeyEvent(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<GetKeyEventRequest,KeyEvent> getKeyEventCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
AnalyticsAdminServiceClient.create()) {
GetKeyEventRequest request =
GetKeyEventRequest.newBuilder()
.setName(KeyEventName.of("[PROPERTY]", "[KEY_EVENT]").toString())
.build();
ApiFuture<KeyEvent> future =
analyticsAdminServiceClient.getKeyEventCallable().futureCall(request);
// Do something.
KeyEvent response = future.get();
}
public final void deleteKeyEvent(KeyEventName name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
AnalyticsAdminServiceClient.create()) {
KeyEventName name = KeyEventName.of("[PROPERTY]", "[KEY_EVENT]");
analyticsAdminServiceClient.deleteKeyEvent(name);
}
name - Required. The resource name of the Key Event to delete. Format:
properties/{property}/keyEvents/{key_event} Example: "properties/123/keyEvents/456"com.google.api.gax.rpc.ApiException - if the remote call failspublic final void deleteKeyEvent(String name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
AnalyticsAdminServiceClient.create()) {
String name = KeyEventName.of("[PROPERTY]", "[KEY_EVENT]").toString();
analyticsAdminServiceClient.deleteKeyEvent(name);
}
name - Required. The resource name of the Key Event to delete. Format:
properties/{property}/keyEvents/{key_event} Example: "properties/123/keyEvents/456"com.google.api.gax.rpc.ApiException - if the remote call failspublic final void deleteKeyEvent(DeleteKeyEventRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
AnalyticsAdminServiceClient.create()) {
DeleteKeyEventRequest request =
DeleteKeyEventRequest.newBuilder()
.setName(KeyEventName.of("[PROPERTY]", "[KEY_EVENT]").toString())
.build();
analyticsAdminServiceClient.deleteKeyEvent(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<DeleteKeyEventRequest,com.google.protobuf.Empty> deleteKeyEventCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
AnalyticsAdminServiceClient.create()) {
DeleteKeyEventRequest request =
DeleteKeyEventRequest.newBuilder()
.setName(KeyEventName.of("[PROPERTY]", "[KEY_EVENT]").toString())
.build();
ApiFuture<Empty> future =
analyticsAdminServiceClient.deleteKeyEventCallable().futureCall(request);
// Do something.
future.get();
}
public final AnalyticsAdminServiceClient.ListKeyEventsPagedResponse listKeyEvents(PropertyName parent)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
AnalyticsAdminServiceClient.create()) {
PropertyName parent = PropertyName.of("[PROPERTY]");
for (KeyEvent element : analyticsAdminServiceClient.listKeyEvents(parent).iterateAll()) {
// doThingsWith(element);
}
}
parent - Required. The resource name of the parent property. Example: 'properties/123'com.google.api.gax.rpc.ApiException - if the remote call failspublic final AnalyticsAdminServiceClient.ListKeyEventsPagedResponse listKeyEvents(String parent)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
AnalyticsAdminServiceClient.create()) {
String parent = PropertyName.of("[PROPERTY]").toString();
for (KeyEvent element : analyticsAdminServiceClient.listKeyEvents(parent).iterateAll()) {
// doThingsWith(element);
}
}
parent - Required. The resource name of the parent property. Example: 'properties/123'com.google.api.gax.rpc.ApiException - if the remote call failspublic final AnalyticsAdminServiceClient.ListKeyEventsPagedResponse listKeyEvents(ListKeyEventsRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
AnalyticsAdminServiceClient.create()) {
ListKeyEventsRequest request =
ListKeyEventsRequest.newBuilder()
.setParent(PropertyName.of("[PROPERTY]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (KeyEvent element : analyticsAdminServiceClient.listKeyEvents(request).iterateAll()) {
// doThingsWith(element);
}
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<ListKeyEventsRequest,AnalyticsAdminServiceClient.ListKeyEventsPagedResponse> listKeyEventsPagedCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
AnalyticsAdminServiceClient.create()) {
ListKeyEventsRequest request =
ListKeyEventsRequest.newBuilder()
.setParent(PropertyName.of("[PROPERTY]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<KeyEvent> future =
analyticsAdminServiceClient.listKeyEventsPagedCallable().futureCall(request);
// Do something.
for (KeyEvent element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
public final com.google.api.gax.rpc.UnaryCallable<ListKeyEventsRequest,ListKeyEventsResponse> listKeyEventsCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
AnalyticsAdminServiceClient.create()) {
ListKeyEventsRequest request =
ListKeyEventsRequest.newBuilder()
.setParent(PropertyName.of("[PROPERTY]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListKeyEventsResponse response =
analyticsAdminServiceClient.listKeyEventsCallable().call(request);
for (KeyEvent element : response.getKeyEventsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
public final CustomDimension createCustomDimension(PropertyName parent, CustomDimension 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);
}
parent - Required. Example format: properties/1234customDimension - Required. The CustomDimension to create.com.google.api.gax.rpc.ApiException - if the remote call failspublic final CustomDimension createCustomDimension(String parent, CustomDimension 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);
}
parent - Required. Example format: properties/1234customDimension - Required. The CustomDimension to create.com.google.api.gax.rpc.ApiException - if the remote call failspublic final CustomDimension createCustomDimension(CreateCustomDimensionRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<CreateCustomDimensionRequest,CustomDimension> createCustomDimensionCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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();
}
public final CustomDimension updateCustomDimension(CustomDimension customDimension, com.google.protobuf.FieldMask updateMask)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
customDimension - The CustomDimension to updateupdateMask - 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.com.google.api.gax.rpc.ApiException - if the remote call failspublic final CustomDimension updateCustomDimension(UpdateCustomDimensionRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<UpdateCustomDimensionRequest,CustomDimension> updateCustomDimensionCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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();
}
public final AnalyticsAdminServiceClient.ListCustomDimensionsPagedResponse listCustomDimensions(PropertyName parent)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
}
parent - Required. Example format: properties/1234com.google.api.gax.rpc.ApiException - if the remote call failspublic final AnalyticsAdminServiceClient.ListCustomDimensionsPagedResponse listCustomDimensions(String parent)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
}
parent - Required. Example format: properties/1234com.google.api.gax.rpc.ApiException - if the remote call failspublic final AnalyticsAdminServiceClient.ListCustomDimensionsPagedResponse listCustomDimensions(ListCustomDimensionsRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<ListCustomDimensionsRequest,AnalyticsAdminServiceClient.ListCustomDimensionsPagedResponse> listCustomDimensionsPagedCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
}
public final com.google.api.gax.rpc.UnaryCallable<ListCustomDimensionsRequest,ListCustomDimensionsResponse> listCustomDimensionsCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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;
}
}
}
public final void archiveCustomDimension(CustomDimensionName name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
name - Required. The name of the CustomDimension to archive. Example format:
properties/1234/customDimensions/5678com.google.api.gax.rpc.ApiException - if the remote call failspublic final void archiveCustomDimension(String name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
name - Required. The name of the CustomDimension to archive. Example format:
properties/1234/customDimensions/5678com.google.api.gax.rpc.ApiException - if the remote call failspublic final void archiveCustomDimension(ArchiveCustomDimensionRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<ArchiveCustomDimensionRequest,com.google.protobuf.Empty> archiveCustomDimensionCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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();
}
public final CustomDimension getCustomDimension(CustomDimensionName name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
name - Required. The name of the CustomDimension to get. Example format:
properties/1234/customDimensions/5678com.google.api.gax.rpc.ApiException - if the remote call failspublic final CustomDimension getCustomDimension(String name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
name - Required. The name of the CustomDimension to get. Example format:
properties/1234/customDimensions/5678com.google.api.gax.rpc.ApiException - if the remote call failspublic final CustomDimension getCustomDimension(GetCustomDimensionRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<GetCustomDimensionRequest,CustomDimension> getCustomDimensionCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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();
}
public final CustomMetric createCustomMetric(PropertyName parent, CustomMetric 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);
}
parent - Required. Example format: properties/1234customMetric - Required. The CustomMetric to create.com.google.api.gax.rpc.ApiException - if the remote call failspublic final CustomMetric createCustomMetric(String parent, CustomMetric 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);
}
parent - Required. Example format: properties/1234customMetric - Required. The CustomMetric to create.com.google.api.gax.rpc.ApiException - if the remote call failspublic final CustomMetric createCustomMetric(CreateCustomMetricRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<CreateCustomMetricRequest,CustomMetric> createCustomMetricCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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();
}
public final CustomMetric updateCustomMetric(CustomMetric customMetric, com.google.protobuf.FieldMask updateMask)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
customMetric - The CustomMetric to updateupdateMask - 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.com.google.api.gax.rpc.ApiException - if the remote call failspublic final CustomMetric updateCustomMetric(UpdateCustomMetricRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<UpdateCustomMetricRequest,CustomMetric> updateCustomMetricCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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();
}
public final AnalyticsAdminServiceClient.ListCustomMetricsPagedResponse listCustomMetrics(PropertyName parent)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
}
parent - Required. Example format: properties/1234com.google.api.gax.rpc.ApiException - if the remote call failspublic final AnalyticsAdminServiceClient.ListCustomMetricsPagedResponse listCustomMetrics(String parent)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
}
parent - Required. Example format: properties/1234com.google.api.gax.rpc.ApiException - if the remote call failspublic final AnalyticsAdminServiceClient.ListCustomMetricsPagedResponse listCustomMetrics(ListCustomMetricsRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<ListCustomMetricsRequest,AnalyticsAdminServiceClient.ListCustomMetricsPagedResponse> listCustomMetricsPagedCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
}
public final com.google.api.gax.rpc.UnaryCallable<ListCustomMetricsRequest,ListCustomMetricsResponse> listCustomMetricsCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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;
}
}
}
public final void archiveCustomMetric(CustomMetricName name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
name - Required. The name of the CustomMetric to archive. Example format:
properties/1234/customMetrics/5678com.google.api.gax.rpc.ApiException - if the remote call failspublic final void archiveCustomMetric(String name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
name - Required. The name of the CustomMetric to archive. Example format:
properties/1234/customMetrics/5678com.google.api.gax.rpc.ApiException - if the remote call failspublic final void archiveCustomMetric(ArchiveCustomMetricRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<ArchiveCustomMetricRequest,com.google.protobuf.Empty> archiveCustomMetricCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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();
}
public final CustomMetric getCustomMetric(CustomMetricName name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
name - Required. The name of the CustomMetric to get. Example format:
properties/1234/customMetrics/5678com.google.api.gax.rpc.ApiException - if the remote call failspublic final CustomMetric getCustomMetric(String name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
name - Required. The name of the CustomMetric to get. Example format:
properties/1234/customMetrics/5678com.google.api.gax.rpc.ApiException - if the remote call failspublic final CustomMetric getCustomMetric(GetCustomMetricRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<GetCustomMetricRequest,CustomMetric> getCustomMetricCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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();
}
public final DataRetentionSettings getDataRetentionSettings(DataRetentionSettingsName name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
name - Required. The name of the settings to lookup. Format:
properties/{property}/dataRetentionSettings Example:
"properties/1000/dataRetentionSettings"com.google.api.gax.rpc.ApiException - if the remote call failspublic final DataRetentionSettings getDataRetentionSettings(String name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
name - Required. The name of the settings to lookup. Format:
properties/{property}/dataRetentionSettings Example:
"properties/1000/dataRetentionSettings"com.google.api.gax.rpc.ApiException - if the remote call failspublic final DataRetentionSettings getDataRetentionSettings(GetDataRetentionSettingsRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<GetDataRetentionSettingsRequest,DataRetentionSettings> getDataRetentionSettingsCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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();
}
public final DataRetentionSettings updateDataRetentionSettings(DataRetentionSettings dataRetentionSettings, com.google.protobuf.FieldMask updateMask)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
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.com.google.api.gax.rpc.ApiException - if the remote call failspublic final DataRetentionSettings updateDataRetentionSettings(UpdateDataRetentionSettingsRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<UpdateDataRetentionSettingsRequest,DataRetentionSettings> updateDataRetentionSettingsCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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();
}
public final DataStream createDataStream(PropertyName parent, DataStream 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);
}
parent - Required. Example format: properties/1234dataStream - Required. The DataStream to create.com.google.api.gax.rpc.ApiException - if the remote call failspublic final DataStream createDataStream(String parent, DataStream 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);
}
parent - Required. Example format: properties/1234dataStream - Required. The DataStream to create.com.google.api.gax.rpc.ApiException - if the remote call failspublic final DataStream createDataStream(CreateDataStreamRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<CreateDataStreamRequest,DataStream> createDataStreamCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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();
}
public final void deleteDataStream(DataStreamName name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
name - Required. The name of the DataStream to delete. Example format:
properties/1234/dataStreams/5678com.google.api.gax.rpc.ApiException - if the remote call failspublic final void deleteDataStream(String name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
name - Required. The name of the DataStream to delete. Example format:
properties/1234/dataStreams/5678com.google.api.gax.rpc.ApiException - if the remote call failspublic final void deleteDataStream(DeleteDataStreamRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<DeleteDataStreamRequest,com.google.protobuf.Empty> deleteDataStreamCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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();
}
public final DataStream updateDataStream(DataStream dataStream, com.google.protobuf.FieldMask updateMask)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
dataStream - The DataStream to updateupdateMask - 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.com.google.api.gax.rpc.ApiException - if the remote call failspublic final DataStream updateDataStream(UpdateDataStreamRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<UpdateDataStreamRequest,DataStream> updateDataStreamCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating 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();
}
public final AnalyticsAdminServiceClient.ListDataStreamsPagedResponse listDataStreams(PropertyName parent)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
AnalyticsAdminServiceClient.create()) {
PropertyName parent = PropertyName.of("[PROPERTY]");
for (DataStream element : analyticsAdminServiceClient.listDataStreams(parent).iterateAll()) {
// doThingsWith(element);
}
}
parent - Required. Example format: properties/1234com.google.api.gax.rpc.ApiException - if the remote call failspublic final AnalyticsAdminServiceClient.ListDataStreamsPagedResponse listDataStreams(String parent)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
AnalyticsAdminServiceClient.create()) {
String parent = PropertyName.of("[PROPERTY]").toString();
for (DataStream element : analyticsAdminServiceClient.listDataStreams(parent).iterateAll()) {
// doThingsWith(element);
}
}
parent - Required. Example format: properties/1234com.google.api.gax.rpc.ApiException - if the remote call failspublic final AnalyticsAdminServiceClient.ListDataStreamsPagedResponse listDataStreams(ListDataStreamsRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
AnalyticsAdminServiceClient.create()) {
ListDataStreamsRequest request =
ListDataStreamsRequest.newBuilder()
.setParent(PropertyName.of("[PROPERTY]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (DataStream element : analyticsAdminServiceClient.listDataStreams(request).iterateAll()) {
// doThingsWith(element);
}
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<ListDataStreamsRequest,AnalyticsAdminServiceClient.ListDataStreamsPagedResponse> listDataStreamsPagedCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
AnalyticsAdminServiceClient.create()) {
ListDataStreamsRequest request =
ListDataStreamsRequest.newBuilder()
.setParent(PropertyName.of("[PROPERTY]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<DataStream> future =
analyticsAdminServiceClient.listDataStreamsPagedCallable().futureCall(request);
// Do something.
for (DataStream element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
public final com.google.api.gax.rpc.UnaryCallable<ListDataStreamsRequest,ListDataStreamsResponse> listDataStreamsCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
AnalyticsAdminServiceClient.create()) {
ListDataStreamsRequest request =
ListDataStreamsRequest.newBuilder()
.setParent(PropertyName.of("[PROPERTY]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListDataStreamsResponse response =
analyticsAdminServiceClient.listDataStreamsCallable().call(request);
for (DataStream element : response.getDataStreamsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
public final DataStream getDataStream(DataStreamName name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
AnalyticsAdminServiceClient.create()) {
DataStreamName name = DataStreamName.of("[PROPERTY]", "[DATA_STREAM]");
DataStream response = analyticsAdminServiceClient.getDataStream(name);
}
name - Required. The name of the DataStream to get. Example format:
properties/1234/dataStreams/5678com.google.api.gax.rpc.ApiException - if the remote call failspublic final DataStream getDataStream(String name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
AnalyticsAdminServiceClient.create()) {
String name = DataStreamName.of("[PROPERTY]", "[DATA_STREAM]").toString();
DataStream response = analyticsAdminServiceClient.getDataStream(name);
}
name - Required. The name of the DataStream to get. Example format:
properties/1234/dataStreams/5678com.google.api.gax.rpc.ApiException - if the remote call failspublic final DataStream getDataStream(GetDataStreamRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
AnalyticsAdminServiceClient.create()) {
GetDataStreamRequest request =
GetDataStreamRequest.newBuilder()
.setName(DataStreamName.of("[PROPERTY]", "[DATA_STREAM]").toString())
.build();
DataStream response = analyticsAdminServiceClient.getDataStream(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<GetDataStreamRequest,DataStream> getDataStreamCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
AnalyticsAdminServiceClient.create()) {
GetDataStreamRequest request =
GetDataStreamRequest.newBuilder()
.setName(DataStreamName.of("[PROPERTY]", "[DATA_STREAM]").toString())
.build();
ApiFuture<DataStream> future =
analyticsAdminServiceClient.getDataStreamCallable().futureCall(request);
// Do something.
DataStream response = future.get();
}
public final RunAccessReportResponse runAccessReport(RunAccessReportRequest request)
Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators.
These data access records include GA UI Reporting, GA UI Explorations, GA Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).
To give your feedback on this API, complete the [Google Analytics Access Reports feedback](https://docs.google.com/forms/d/e/1FAIpQLSdmEBUrMzAEdiEKk5TV5dEHvDUZDRlgWYdQdAeSdtR4hVjEhw/viewform) form.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
AnalyticsAdminServiceClient.create()) {
RunAccessReportRequest request =
RunAccessReportRequest.newBuilder()
.setEntity("entity-1298275357")
.addAllDimensions(new ArrayList<AccessDimension>())
.addAllMetrics(new ArrayList<AccessMetric>())
.addAllDateRanges(new ArrayList<AccessDateRange>())
.setDimensionFilter(AccessFilterExpression.newBuilder().build())
.setMetricFilter(AccessFilterExpression.newBuilder().build())
.setOffset(-1019779949)
.setLimit(102976443)
.setTimeZone("timeZone-2077180903")
.addAllOrderBys(new ArrayList<AccessOrderBy>())
.setReturnEntityQuota(true)
.setIncludeAllUsers(true)
.setExpandGroups(true)
.build();
RunAccessReportResponse response = analyticsAdminServiceClient.runAccessReport(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<RunAccessReportRequest,RunAccessReportResponse> runAccessReportCallable()
Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators.
These data access records include GA UI Reporting, GA UI Explorations, GA Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).
To give your feedback on this API, complete the [Google Analytics Access Reports feedback](https://docs.google.com/forms/d/e/1FAIpQLSdmEBUrMzAEdiEKk5TV5dEHvDUZDRlgWYdQdAeSdtR4hVjEhw/viewform) form.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
AnalyticsAdminServiceClient.create()) {
RunAccessReportRequest request =
RunAccessReportRequest.newBuilder()
.setEntity("entity-1298275357")
.addAllDimensions(new ArrayList<AccessDimension>())
.addAllMetrics(new ArrayList<AccessMetric>())
.addAllDateRanges(new ArrayList<AccessDateRange>())
.setDimensionFilter(AccessFilterExpression.newBuilder().build())
.setMetricFilter(AccessFilterExpression.newBuilder().build())
.setOffset(-1019779949)
.setLimit(102976443)
.setTimeZone("timeZone-2077180903")
.addAllOrderBys(new ArrayList<AccessOrderBy>())
.setReturnEntityQuota(true)
.setIncludeAllUsers(true)
.setExpandGroups(true)
.build();
ApiFuture<RunAccessReportResponse> future =
analyticsAdminServiceClient.runAccessReportCallable().futureCall(request);
// Do something.
RunAccessReportResponse response = future.get();
}
public final void close()
close in interface AutoCloseablepublic void shutdown()
shutdown in interface com.google.api.gax.core.BackgroundResourcepublic boolean isShutdown()
isShutdown in interface com.google.api.gax.core.BackgroundResourcepublic boolean isTerminated()
isTerminated in interface com.google.api.gax.core.BackgroundResourcepublic void shutdownNow()
shutdownNow in interface com.google.api.gax.core.BackgroundResourcepublic boolean awaitTermination(long duration,
TimeUnit unit)
throws InterruptedException
awaitTermination in interface com.google.api.gax.core.BackgroundResourceInterruptedExceptionCopyright © 2025 Google LLC. All rights reserved.