Package com.google.analytics.admin.v1beta (0.20.0)

A client to Google Analytics Admin API

The interfaces provided are listed below, along with usage samples.

AnalyticsAdminServiceClient

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

Sample for AnalyticsAdminServiceClient:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating 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);
 }

Classes

Account

A resource message representing a Google Analytics account.

Protobuf type google.analytics.admin.v1beta.Account

Account.Builder

A resource message representing a Google Analytics account.

Protobuf type google.analytics.admin.v1beta.Account

AccountSummary

A virtual resource representing an overview of an account and all its child GA4 properties.

Protobuf type google.analytics.admin.v1beta.AccountSummary

AccountSummary.Builder

A virtual resource representing an overview of an account and all its child GA4 properties.

Protobuf type google.analytics.admin.v1beta.AccountSummary

AcknowledgeUserDataCollectionRequest

Request message for AcknowledgeUserDataCollection RPC.

Protobuf type google.analytics.admin.v1beta.AcknowledgeUserDataCollectionRequest

AcknowledgeUserDataCollectionRequest.Builder

Request message for AcknowledgeUserDataCollection RPC.

Protobuf type google.analytics.admin.v1beta.AcknowledgeUserDataCollectionRequest

AcknowledgeUserDataCollectionResponse

Response message for AcknowledgeUserDataCollection RPC.

Protobuf type google.analytics.admin.v1beta.AcknowledgeUserDataCollectionResponse

AcknowledgeUserDataCollectionResponse.Builder

Response message for AcknowledgeUserDataCollection RPC.

Protobuf type google.analytics.admin.v1beta.AcknowledgeUserDataCollectionResponse

AnalyticsAdminServiceClient

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

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


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

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

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

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

See the individual methods for example code.

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

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

To customize credentials:


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

To customize the endpoint:


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

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


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

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

AnalyticsAdminServiceClient.ListAccountSummariesFixedSizeCollection

AnalyticsAdminServiceClient.ListAccountSummariesPage

AnalyticsAdminServiceClient.ListAccountSummariesPagedResponse

AnalyticsAdminServiceClient.ListAccountsFixedSizeCollection

AnalyticsAdminServiceClient.ListAccountsPage

AnalyticsAdminServiceClient.ListAccountsPagedResponse

AnalyticsAdminServiceClient.ListConversionEventsFixedSizeCollection

AnalyticsAdminServiceClient.ListConversionEventsPage

AnalyticsAdminServiceClient.ListConversionEventsPagedResponse

AnalyticsAdminServiceClient.ListCustomDimensionsFixedSizeCollection

AnalyticsAdminServiceClient.ListCustomDimensionsPage

AnalyticsAdminServiceClient.ListCustomDimensionsPagedResponse

AnalyticsAdminServiceClient.ListCustomMetricsFixedSizeCollection

AnalyticsAdminServiceClient.ListCustomMetricsPage

AnalyticsAdminServiceClient.ListCustomMetricsPagedResponse

AnalyticsAdminServiceClient.ListDataStreamsFixedSizeCollection

AnalyticsAdminServiceClient.ListDataStreamsPage

AnalyticsAdminServiceClient.ListDataStreamsPagedResponse

AnalyticsAdminServiceClient.ListFirebaseLinksFixedSizeCollection

AnalyticsAdminServiceClient.ListFirebaseLinksPage

AnalyticsAdminServiceClient.ListFirebaseLinksPagedResponse

AnalyticsAdminServiceClient.ListGoogleAdsLinksFixedSizeCollection

AnalyticsAdminServiceClient.ListGoogleAdsLinksPage

AnalyticsAdminServiceClient.ListGoogleAdsLinksPagedResponse

AnalyticsAdminServiceClient.ListMeasurementProtocolSecretsFixedSizeCollection

AnalyticsAdminServiceClient.ListMeasurementProtocolSecretsPage

AnalyticsAdminServiceClient.ListMeasurementProtocolSecretsPagedResponse

AnalyticsAdminServiceClient.ListPropertiesFixedSizeCollection

AnalyticsAdminServiceClient.ListPropertiesPage

AnalyticsAdminServiceClient.ListPropertiesPagedResponse