Class AnalyticsAdminServiceClient (0.14.0)

Version 0.14.0

• 0.62.0 (latest)
• 0.61.0
• 0.59.0
• 0.58.0
• 0.57.0
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.49.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0

public class AnalyticsAdminServiceClient implements BackgroundResource

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

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

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

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

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

1. 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.
2. 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.
3. 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.newBuilder()
         .setTransportChannelProvider(
             AnalyticsAdminServiceSettings.defaultHttpJsonTransportProviderBuilder().build())
         .build();
 AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create(analyticsAdminServiceSettings);
 

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

Inheritance

java.lang.Object > AnalyticsAdminServiceClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final AnalyticsAdminServiceClient create()

Constructs an instance of AnalyticsAdminServiceClient with default settings.

Returns

Type	Description
AnalyticsAdminServiceClient

Exceptions

Type	Description
IOException

create(AnalyticsAdminServiceSettings settings)

public static final AnalyticsAdminServiceClient create(AnalyticsAdminServiceSettings settings)

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

Parameter

Name	Description
settings	AnalyticsAdminServiceSettings

Returns

Type	Description
AnalyticsAdminServiceClient

Exceptions

Type	Description
IOException

create(AnalyticsAdminServiceStub stub)

public static final AnalyticsAdminServiceClient create(AnalyticsAdminServiceStub stub)

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

Parameter

Name	Description
stub	AnalyticsAdminServiceStub

Returns

Type	Description
AnalyticsAdminServiceClient

Constructors

AnalyticsAdminServiceClient(AnalyticsAdminServiceSettings settings)

protected AnalyticsAdminServiceClient(AnalyticsAdminServiceSettings settings)

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

Parameter

Name	Description
settings	AnalyticsAdminServiceSettings

AnalyticsAdminServiceClient(AnalyticsAdminServiceStub stub)

protected AnalyticsAdminServiceClient(AnalyticsAdminServiceStub stub)

Parameter

Name	Description
stub	AnalyticsAdminServiceStub

Methods

acknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest request)

public final AcknowledgeUserDataCollectionResponse acknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest request)

Acknowledges the terms of user data collection for the specified property.

This acknowledgement must be completed (either in the Google Analytics UI or via this API) before MeasurementProtocolSecret resources may be created.

Sample code:

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

Parameter

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

Returns

Type	Description
AcknowledgeUserDataCollectionResponse

acknowledgeUserDataCollectionCallable()

public final UnaryCallable<AcknowledgeUserDataCollectionRequest,AcknowledgeUserDataCollectionResponse> acknowledgeUserDataCollectionCallable()

Acknowledges the terms of user data collection for the specified property.

This acknowledgement must be completed (either in the Google Analytics UI or via this API) before MeasurementProtocolSecret resources may be created.

Sample code:

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

Returns

Type	Description
UnaryCallable<AcknowledgeUserDataCollectionRequest,AcknowledgeUserDataCollectionResponse>

approveDisplayVideo360AdvertiserLinkProposal(ApproveDisplayVideo360AdvertiserLinkProposalRequest request)

public final ApproveDisplayVideo360AdvertiserLinkProposalResponse approveDisplayVideo360AdvertiserLinkProposal(ApproveDisplayVideo360AdvertiserLinkProposalRequest request)

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

Sample code:

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

Parameter

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

Returns

Type	Description
ApproveDisplayVideo360AdvertiserLinkProposalResponse

approveDisplayVideo360AdvertiserLinkProposalCallable()

public final UnaryCallable<ApproveDisplayVideo360AdvertiserLinkProposalRequest,ApproveDisplayVideo360AdvertiserLinkProposalResponse> approveDisplayVideo360AdvertiserLinkProposalCallable()

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

Sample code:

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

Returns

Type	Description
UnaryCallable<ApproveDisplayVideo360AdvertiserLinkProposalRequest,ApproveDisplayVideo360AdvertiserLinkProposalResponse>

archiveAudience(ArchiveAudienceRequest request)

public final void archiveAudience(ArchiveAudienceRequest request)

Archives an Audience on a property.

Sample code:

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

Parameter

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

archiveAudienceCallable()

public final UnaryCallable<ArchiveAudienceRequest,Empty> archiveAudienceCallable()

Archives an Audience on a property.

Sample code:

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

Returns

Type	Description
UnaryCallable<ArchiveAudienceRequest,Empty>

archiveCustomDimension(ArchiveCustomDimensionRequest request)

public final void archiveCustomDimension(ArchiveCustomDimensionRequest request)

Archives a CustomDimension on a property.

Sample code:

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

Parameter

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

archiveCustomDimension(CustomDimensionName name)

public final void archiveCustomDimension(CustomDimensionName name)

Archives a CustomDimension on a property.

Sample code:

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

Parameter

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

archiveCustomDimension(String name)

public final void archiveCustomDimension(String name)

Archives a CustomDimension on a property.

Sample code:

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

Parameter

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

archiveCustomDimensionCallable()

public final UnaryCallable<ArchiveCustomDimensionRequest,Empty> archiveCustomDimensionCallable()

Archives a CustomDimension on a property.

Sample code:

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

Returns

Type	Description
UnaryCallable<ArchiveCustomDimensionRequest,Empty>

archiveCustomMetric(ArchiveCustomMetricRequest request)

public final void archiveCustomMetric(ArchiveCustomMetricRequest request)

Archives a CustomMetric on a property.

Sample code:

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

Parameter

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

archiveCustomMetric(CustomMetricName name)

public final void archiveCustomMetric(CustomMetricName name)

Archives a CustomMetric on a property.

Sample code:

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

Parameter

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

archiveCustomMetric(String name)

public final void archiveCustomMetric(String name)

Archives a CustomMetric on a property.

Sample code:

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

Parameter

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

archiveCustomMetricCallable()

public final UnaryCallable<ArchiveCustomMetricRequest,Empty> archiveCustomMetricCallable()

Archives a CustomMetric on a property.

Sample code:

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

Returns

Type	Description
UnaryCallable<ArchiveCustomMetricRequest,Empty>

auditUserLinks(AuditUserLinksRequest request)

public final AnalyticsAdminServiceClient.AuditUserLinksPagedResponse auditUserLinks(AuditUserLinksRequest request)

Lists all user links on an account or property, including implicit ones that come from effective permissions granted by groups or organization admin roles.

If a returned user link does not have direct permissions, they cannot be removed from the account or property directly with the DeleteUserLink command. They have to be removed from the group/etc that gives them permissions, which is currently only usable/discoverable in the GA or GMP UIs.

Sample code:

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

Parameter

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

Returns

Type	Description
AnalyticsAdminServiceClient.AuditUserLinksPagedResponse

auditUserLinksCallable()

public final UnaryCallable<AuditUserLinksRequest,AuditUserLinksResponse> auditUserLinksCallable()

Lists all user links on an account or property, including implicit ones that come from effective permissions granted by groups or organization admin roles.

If a returned user link does not have direct permissions, they cannot be removed from the account or property directly with the DeleteUserLink command. They have to be removed from the group/etc that gives them permissions, which is currently only usable/discoverable in the GA or GMP UIs.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   AuditUserLinksRequest request =
       AuditUserLinksRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     AuditUserLinksResponse response =
         analyticsAdminServiceClient.auditUserLinksCallable().call(request);
     for (AuditUserLink element : response.getUserLinksList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<AuditUserLinksRequest,AuditUserLinksResponse>

auditUserLinksPagedCallable()

public final UnaryCallable<AuditUserLinksRequest,AnalyticsAdminServiceClient.AuditUserLinksPagedResponse> auditUserLinksPagedCallable()

Lists all user links on an account or property, including implicit ones that come from effective permissions granted by groups or organization admin roles.

If a returned user link does not have direct permissions, they cannot be removed from the account or property directly with the DeleteUserLink command. They have to be removed from the group/etc that gives them permissions, which is currently only usable/discoverable in the GA or GMP UIs.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   AuditUserLinksRequest request =
       AuditUserLinksRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<AuditUserLink> future =
       analyticsAdminServiceClient.auditUserLinksPagedCallable().futureCall(request);
   // Do something.
   for (AuditUserLink element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns

Type	Description
UnaryCallable<AuditUserLinksRequest,AuditUserLinksPagedResponse>

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters

Name	Description
duration	long
unit	TimeUnit

Returns

Type	Description
boolean

Exceptions

Type	Description
InterruptedException

batchCreateUserLinks(BatchCreateUserLinksRequest request)

public final BatchCreateUserLinksResponse batchCreateUserLinks(BatchCreateUserLinksRequest request)

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

This method is transactional. If any UserLink cannot be created, none of the UserLinks will be created.

Sample code:

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

Parameter

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

Returns

Type	Description
BatchCreateUserLinksResponse

batchCreateUserLinksCallable()

public final UnaryCallable<BatchCreateUserLinksRequest,BatchCreateUserLinksResponse> batchCreateUserLinksCallable()

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

This method is transactional. If any UserLink cannot be created, none of the UserLinks will be created.

Sample code:

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

Returns

Type	Description
UnaryCallable<BatchCreateUserLinksRequest,BatchCreateUserLinksResponse>

batchDeleteUserLinks(BatchDeleteUserLinksRequest request)

public final void batchDeleteUserLinks(BatchDeleteUserLinksRequest request)

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

Sample code:

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

Parameter

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

batchDeleteUserLinksCallable()

public final UnaryCallable<BatchDeleteUserLinksRequest,Empty> batchDeleteUserLinksCallable()

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

Sample code:

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

Returns

Type	Description
UnaryCallable<BatchDeleteUserLinksRequest,Empty>

batchGetUserLinks(BatchGetUserLinksRequest request)

public final BatchGetUserLinksResponse batchGetUserLinks(BatchGetUserLinksRequest request)

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

Sample code:

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

Parameter

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

Returns

Type	Description
BatchGetUserLinksResponse

batchGetUserLinksCallable()

public final UnaryCallable<BatchGetUserLinksRequest,BatchGetUserLinksResponse> batchGetUserLinksCallable()

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

Sample code:

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

Returns

Type	Description
UnaryCallable<BatchGetUserLinksRequest,BatchGetUserLinksResponse>

batchUpdateUserLinks(BatchUpdateUserLinksRequest request)

public final BatchUpdateUserLinksResponse batchUpdateUserLinks(BatchUpdateUserLinksRequest request)

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

Sample code:

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

Parameter

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

Returns

Type	Description
BatchUpdateUserLinksResponse

batchUpdateUserLinksCallable()

public final UnaryCallable<BatchUpdateUserLinksRequest,BatchUpdateUserLinksResponse> batchUpdateUserLinksCallable()

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

Sample code:

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

Returns

Type	Description
UnaryCallable<BatchUpdateUserLinksRequest,BatchUpdateUserLinksResponse>

cancelDisplayVideo360AdvertiserLinkProposal(CancelDisplayVideo360AdvertiserLinkProposalRequest request)

public final DisplayVideo360AdvertiserLinkProposal cancelDisplayVideo360AdvertiserLinkProposal(CancelDisplayVideo360AdvertiserLinkProposalRequest request)

Cancels a DisplayVideo360AdvertiserLinkProposal. Cancelling can mean either: - Declining a proposal initiated from Display & Video 360 - Withdrawing a proposal initiated from Google Analytics After being cancelled, a proposal will eventually be deleted automatically.

Sample code:

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

Parameter

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

Returns

Type	Description
DisplayVideo360AdvertiserLinkProposal

cancelDisplayVideo360AdvertiserLinkProposalCallable()

public final UnaryCallable<CancelDisplayVideo360AdvertiserLinkProposalRequest,DisplayVideo360AdvertiserLinkProposal> cancelDisplayVideo360AdvertiserLinkProposalCallable()

Cancels a DisplayVideo360AdvertiserLinkProposal. Cancelling can mean either: - Declining a proposal initiated from Display & Video 360 - Withdrawing a proposal initiated from Google Analytics After being cancelled, a proposal will eventually be deleted automatically.

Sample code:

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

Returns

Type	Description
UnaryCallable<CancelDisplayVideo360AdvertiserLinkProposalRequest,DisplayVideo360AdvertiserLinkProposal>

close()

public final void close()

createAudience(CreateAudienceRequest request)

public final Audience createAudience(CreateAudienceRequest request)

Creates an Audience.

Sample code:

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

Parameter

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

Returns

Type	Description
Audience

createAudience(PropertyName parent, Audience audience)

public final Audience createAudience(PropertyName parent, Audience audience)

Creates an Audience.

Sample code:

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

Parameters

Name	Description
parent	PropertyName Required. Example format: properties/1234
audience	Audience Required. The audience to create.

Returns

Type	Description
Audience

createAudience(String parent, Audience audience)

public final Audience createAudience(String parent, Audience audience)

Creates an Audience.

Sample code:

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

Parameters

Name	Description
parent	String Required. Example format: properties/1234
audience	Audience Required. The audience to create.

Returns

Type	Description
Audience

createAudienceCallable()

public final UnaryCallable<CreateAudienceRequest,Audience> createAudienceCallable()

Creates an Audience.

Sample code:

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

Returns

Type	Description
UnaryCallable<CreateAudienceRequest,Audience>

createConversionEvent(CreateConversionEventRequest request)

public final ConversionEvent createConversionEvent(CreateConversionEventRequest request)

Creates a conversion event with the specified attributes.

Sample code:

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

Parameter

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

Returns

Type	Description
ConversionEvent

createConversionEvent(PropertyName parent, ConversionEvent conversionEvent)

public final ConversionEvent createConversionEvent(PropertyName parent, ConversionEvent conversionEvent)

Creates a conversion event with the specified attributes.

Sample code:

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

Parameters

Name	Description
parent	PropertyName Required. The resource name of the parent property where this conversion event will be created. Format: properties/123
conversionEvent	ConversionEvent Required. The conversion event to create.

Returns

Type	Description
ConversionEvent

createConversionEvent(String parent, ConversionEvent conversionEvent)

public final ConversionEvent createConversionEvent(String parent, ConversionEvent conversionEvent)

Creates a conversion event with the specified attributes.

Sample code:

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

Parameters

Name	Description
parent	String Required. The resource name of the parent property where this conversion event will be created. Format: properties/123
conversionEvent	ConversionEvent Required. The conversion event to create.

Returns

Type	Description
ConversionEvent

createConversionEventCallable()

public final UnaryCallable<CreateConversionEventRequest,ConversionEvent> createConversionEventCallable()

Creates a conversion event with the specified attributes.

Sample code:

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

Returns

Type	Description
UnaryCallable<CreateConversionEventRequest,ConversionEvent>

createCustomDimension(CreateCustomDimensionRequest request)

public final CustomDimension createCustomDimension(CreateCustomDimensionRequest request)

Creates a CustomDimension.

Sample code:

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

Parameter

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

Returns

Type	Description
CustomDimension

createCustomDimension(PropertyName parent, CustomDimension customDimension)

public final CustomDimension createCustomDimension(PropertyName parent, CustomDimension customDimension)

Creates a CustomDimension.

Sample code:

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

Parameters

Name	Description
parent	PropertyName Required. Example format: properties/1234
customDimension	CustomDimension Required. The CustomDimension to create.

Returns

Type	Description
CustomDimension

createCustomDimension(String parent, CustomDimension customDimension)

public final CustomDimension createCustomDimension(String parent, CustomDimension customDimension)

Creates a CustomDimension.

Sample code:

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

Parameters

Name	Description
parent	String Required. Example format: properties/1234
customDimension	CustomDimension Required. The CustomDimension to create.

Returns

Type	Description
CustomDimension

createCustomDimensionCallable()

public final UnaryCallable<CreateCustomDimensionRequest,CustomDimension> createCustomDimensionCallable()

Creates a CustomDimension.

Sample code:

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

Returns

Type	Description
UnaryCallable<CreateCustomDimensionRequest,CustomDimension>

createCustomMetric(CreateCustomMetricRequest request)

public final CustomMetric createCustomMetric(CreateCustomMetricRequest request)

Creates a CustomMetric.

Sample code:

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

Parameter

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

Returns

Type	Description
CustomMetric

createCustomMetric(PropertyName parent, CustomMetric customMetric)

public final CustomMetric createCustomMetric(PropertyName parent, CustomMetric customMetric)

Creates a CustomMetric.

Sample code:

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

Parameters

Name	Description
parent	PropertyName Required. Example format: properties/1234
customMetric	CustomMetric Required. The CustomMetric to create.

Returns

Type	Description
CustomMetric

createCustomMetric(String parent, CustomMetric customMetric)

public final CustomMetric createCustomMetric(String parent, CustomMetric customMetric)

Creates a CustomMetric.

Sample code:

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

Parameters

Name	Description
parent	String Required. Example format: properties/1234
customMetric	CustomMetric Required. The CustomMetric to create.

Returns

Type	Description
CustomMetric

createCustomMetricCallable()

public final UnaryCallable<CreateCustomMetricRequest,CustomMetric> createCustomMetricCallable()

Creates a CustomMetric.

Sample code:

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

Returns

Type	Description
UnaryCallable<CreateCustomMetricRequest,CustomMetric>

createDataStream(CreateDataStreamRequest request)

public final DataStream createDataStream(CreateDataStreamRequest request)

Creates a DataStream.

Sample code:

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

Parameter

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

Returns

Type	Description
DataStream

createDataStream(PropertyName parent, DataStream dataStream)

public final DataStream createDataStream(PropertyName parent, DataStream dataStream)

Creates a DataStream.

Sample code:

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

Parameters

Name	Description
parent	PropertyName Required. Example format: properties/1234
dataStream	DataStream Required. The DataStream to create.

Returns

Type	Description
DataStream

createDataStream(String parent, DataStream dataStream)

public final DataStream createDataStream(String parent, DataStream dataStream)

Creates a DataStream.

Sample code:

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

Parameters

Name	Description
parent	String Required. Example format: properties/1234
dataStream	DataStream Required. The DataStream to create.

Returns

Type	Description
DataStream

createDataStreamCallable()

public final UnaryCallable<CreateDataStreamRequest,DataStream> createDataStreamCallable()

Creates a DataStream.

Sample code:

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

Returns

Type	Description
UnaryCallable<CreateDataStreamRequest,DataStream>

createDisplayVideo360AdvertiserLink(CreateDisplayVideo360AdvertiserLinkRequest request)

public final DisplayVideo360AdvertiserLink createDisplayVideo360AdvertiserLink(CreateDisplayVideo360AdvertiserLinkRequest request)

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

Sample code:

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

Parameter

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

Returns

Type	Description
DisplayVideo360AdvertiserLink

createDisplayVideo360AdvertiserLink(PropertyName parent, DisplayVideo360AdvertiserLink displayVideo360AdvertiserLink)

public final DisplayVideo360AdvertiserLink createDisplayVideo360AdvertiserLink(PropertyName parent, DisplayVideo360AdvertiserLink displayVideo360AdvertiserLink)

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

Sample code:

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

Parameters

Name	Description
parent	PropertyName Required. Example format: properties/1234
displayVideo360AdvertiserLink	DisplayVideo360AdvertiserLink Required. The DisplayVideo360AdvertiserLink to create.

Returns

Type	Description
DisplayVideo360AdvertiserLink

createDisplayVideo360AdvertiserLink(String parent, DisplayVideo360AdvertiserLink displayVideo360AdvertiserLink)

public final DisplayVideo360AdvertiserLink createDisplayVideo360AdvertiserLink(String parent, DisplayVideo360AdvertiserLink displayVideo360AdvertiserLink)

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

Sample code:

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

Parameters

Name	Description
parent	String Required. Example format: properties/1234
displayVideo360AdvertiserLink	DisplayVideo360AdvertiserLink Required. The DisplayVideo360AdvertiserLink to create.

Returns

Type	Description
DisplayVideo360AdvertiserLink

createDisplayVideo360AdvertiserLinkCallable()

public final UnaryCallable<CreateDisplayVideo360AdvertiserLinkRequest,DisplayVideo360AdvertiserLink> createDisplayVideo360AdvertiserLinkCallable()

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

Sample code:

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

Returns

Type	Description
UnaryCallable<CreateDisplayVideo360AdvertiserLinkRequest,DisplayVideo360AdvertiserLink>

createDisplayVideo360AdvertiserLinkProposal(CreateDisplayVideo360AdvertiserLinkProposalRequest request)

public final DisplayVideo360AdvertiserLinkProposal createDisplayVideo360AdvertiserLinkProposal(CreateDisplayVideo360AdvertiserLinkProposalRequest request)

Creates a DisplayVideo360AdvertiserLinkProposal.

Sample code:

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

Parameter

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

Returns

Type	Description
DisplayVideo360AdvertiserLinkProposal

createDisplayVideo360AdvertiserLinkProposal(PropertyName parent, DisplayVideo360AdvertiserLinkProposal displayVideo360AdvertiserLinkProposal)

public final DisplayVideo360AdvertiserLinkProposal createDisplayVideo360AdvertiserLinkProposal(PropertyName parent, DisplayVideo360AdvertiserLinkProposal displayVideo360AdvertiserLinkProposal)

Creates a DisplayVideo360AdvertiserLinkProposal.

Sample code:

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

Parameters

Name	Description
parent	PropertyName Required. Example format: properties/1234
displayVideo360AdvertiserLinkProposal	DisplayVideo360AdvertiserLinkProposal Required. The DisplayVideo360AdvertiserLinkProposal to create.

Returns

Type	Description
DisplayVideo360AdvertiserLinkProposal

createDisplayVideo360AdvertiserLinkProposal(String parent, DisplayVideo360AdvertiserLinkProposal displayVideo360AdvertiserLinkProposal)

public final DisplayVideo360AdvertiserLinkProposal createDisplayVideo360AdvertiserLinkProposal(String parent, DisplayVideo360AdvertiserLinkProposal displayVideo360AdvertiserLinkProposal)

Creates a DisplayVideo360AdvertiserLinkProposal.

Sample code:

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

Parameters

Name	Description
parent	String Required. Example format: properties/1234
displayVideo360AdvertiserLinkProposal	DisplayVideo360AdvertiserLinkProposal Required. The DisplayVideo360AdvertiserLinkProposal to create.

Returns

Type	Description
DisplayVideo360AdvertiserLinkProposal

createDisplayVideo360AdvertiserLinkProposalCallable()

public final UnaryCallable<CreateDisplayVideo360AdvertiserLinkProposalRequest,DisplayVideo360AdvertiserLinkProposal> createDisplayVideo360AdvertiserLinkProposalCallable()

Creates a DisplayVideo360AdvertiserLinkProposal.

Sample code:

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

Returns

Type	Description
UnaryCallable<CreateDisplayVideo360AdvertiserLinkProposalRequest,DisplayVideo360AdvertiserLinkProposal>

createFirebaseLink(CreateFirebaseLinkRequest request)

public final FirebaseLink createFirebaseLink(CreateFirebaseLinkRequest request)

Creates a FirebaseLink.

Properties can have at most one FirebaseLink.

Sample code:

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

Parameter

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

Returns

Type	Description
FirebaseLink

createFirebaseLink(PropertyName parent, FirebaseLink firebaseLink)

public final FirebaseLink createFirebaseLink(PropertyName parent, FirebaseLink firebaseLink)

Creates a FirebaseLink.

Properties can have at most one FirebaseLink.

Sample code:

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

Parameters

Name	Description
parent	PropertyName Required. Format: properties/{property_id} Example: properties/1234
firebaseLink	FirebaseLink Required. The Firebase link to create.

Returns

Type	Description
FirebaseLink

createFirebaseLink(String parent, FirebaseLink firebaseLink)

public final FirebaseLink createFirebaseLink(String parent, FirebaseLink firebaseLink)

Creates a FirebaseLink.

Properties can have at most one FirebaseLink.

Sample code:

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

Parameters

Name	Description
parent	String Required. Format: properties/{property_id} Example: properties/1234
firebaseLink	FirebaseLink Required. The Firebase link to create.

Returns

Type	Description
FirebaseLink

createFirebaseLinkCallable()

public final UnaryCallable<CreateFirebaseLinkRequest,FirebaseLink> createFirebaseLinkCallable()

Creates a FirebaseLink.

Properties can have at most one FirebaseLink.

Sample code:

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

Returns

Type	Description
UnaryCallable<CreateFirebaseLinkRequest,FirebaseLink>

createGoogleAdsLink(CreateGoogleAdsLinkRequest request)

public final GoogleAdsLink createGoogleAdsLink(CreateGoogleAdsLinkRequest request)

Creates a GoogleAdsLink.

Sample code:

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

Parameter

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

Returns

Type	Description
GoogleAdsLink

createGoogleAdsLink(PropertyName parent, GoogleAdsLink googleAdsLink)

public final GoogleAdsLink createGoogleAdsLink(PropertyName parent, GoogleAdsLink googleAdsLink)

Creates a GoogleAdsLink.

Sample code:

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

Parameters

Name	Description
parent	PropertyName Required. Example format: properties/1234
googleAdsLink	GoogleAdsLink Required. The GoogleAdsLink to create.

Returns

Type	Description
GoogleAdsLink

createGoogleAdsLink(String parent, GoogleAdsLink googleAdsLink)

public final GoogleAdsLink createGoogleAdsLink(String parent, GoogleAdsLink googleAdsLink)

Creates a GoogleAdsLink.

Sample code:

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

Parameters

Name	Description
parent	String Required. Example format: properties/1234
googleAdsLink	GoogleAdsLink Required. The GoogleAdsLink to create.

Returns

Type	Description
GoogleAdsLink

createGoogleAdsLinkCallable()

public final UnaryCallable<CreateGoogleAdsLinkRequest,GoogleAdsLink> createGoogleAdsLinkCallable()

Creates a GoogleAdsLink.

Sample code:

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

Returns

Type	Description
UnaryCallable<CreateGoogleAdsLinkRequest,GoogleAdsLink>

createMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest request)

public final MeasurementProtocolSecret createMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest request)

Creates a measurement protocol secret.

Sample code:

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

Parameter

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

Returns

Type	Description
MeasurementProtocolSecret

createMeasurementProtocolSecret(DataStreamName parent, MeasurementProtocolSecret measurementProtocolSecret)

public final MeasurementProtocolSecret createMeasurementProtocolSecret(DataStreamName parent, MeasurementProtocolSecret measurementProtocolSecret)

Creates a measurement protocol secret.

Sample code:

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

Parameters

Name	Description
parent	DataStreamName Required. The parent resource where this secret will be created. Format: properties/{property}/dataStreams/{dataStream}
measurementProtocolSecret	MeasurementProtocolSecret Required. The measurement protocol secret to create.

Returns

Type	Description
MeasurementProtocolSecret

createMeasurementProtocolSecret(String parent, MeasurementProtocolSecret measurementProtocolSecret)

public final MeasurementProtocolSecret createMeasurementProtocolSecret(String parent, MeasurementProtocolSecret measurementProtocolSecret)

Creates a measurement protocol secret.

Sample code:

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

Parameters

Name	Description
parent	String Required. The parent resource where this secret will be created. Format: properties/{property}/dataStreams/{dataStream}
measurementProtocolSecret	MeasurementProtocolSecret Required. The measurement protocol secret to create.

Returns

Type	Description
MeasurementProtocolSecret

createMeasurementProtocolSecretCallable()

public final UnaryCallable<CreateMeasurementProtocolSecretRequest,MeasurementProtocolSecret> createMeasurementProtocolSecretCallable()

Creates a measurement protocol secret.

Sample code:

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

Returns

Type	Description
UnaryCallable<CreateMeasurementProtocolSecretRequest,MeasurementProtocolSecret>

createProperty(CreatePropertyRequest request)

public final Property createProperty(CreatePropertyRequest request)

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

Sample code:

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

Parameter

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

Returns

Type	Description
Property

createProperty(Property property)

public final Property createProperty(Property property)

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

Sample code:

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

Parameter

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

Returns

Type	Description
Property

createPropertyCallable()

public final UnaryCallable<CreatePropertyRequest,Property> createPropertyCallable()

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

Sample code:

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

Returns

Type	Description
UnaryCallable<CreatePropertyRequest,Property>

createUserLink(AccountName parent, UserLink userLink)

public final UserLink createUserLink(AccountName parent, UserLink userLink)

Creates a user link on an account or property.

If the user with the specified email already has permissions on the account or property, then the user's existing permissions will be unioned with the permissions specified in the new UserLink.

Sample code:

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

Parameters

Name	Description
parent	AccountName Required. Example format: accounts/1234
userLink	UserLink Required. The user link to create.

Returns

Type	Description
UserLink

createUserLink(CreateUserLinkRequest request)

public final UserLink createUserLink(CreateUserLinkRequest request)

Creates a user link on an account or property.

If the user with the specified email already has permissions on the account or property, then the user's existing permissions will be unioned with the permissions specified in the new UserLink.

Sample code:

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

Parameter

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

Returns

Type	Description
UserLink

createUserLink(PropertyName parent, UserLink userLink)

public final UserLink createUserLink(PropertyName parent, UserLink userLink)

Creates a user link on an account or property.

If the user with the specified email already has permissions on the account or property, then the user's existing permissions will be unioned with the permissions specified in the new UserLink.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating 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]");
   UserLink userLink = UserLink.newBuilder().build();
   UserLink response = analyticsAdminServiceClient.createUserLink(parent, userLink);
 }
 

Parameters

Name	Description
parent	PropertyName Required. Example format: accounts/1234
userLink	UserLink Required. The user link to create.

Returns

Type	Description
UserLink

createUserLink(String parent, UserLink userLink)

public final UserLink createUserLink(String parent, UserLink userLink)

Creates a user link on an account or property.

If the user with the specified email already has permissions on the account or property, then the user's existing permissions will be unioned with the permissions specified in the new UserLink.

Sample code:

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

Parameters

Name	Description
parent	String Required. Example format: accounts/1234
userLink	UserLink Required. The user link to create.

Returns

Type	Description
UserLink

createUserLinkCallable()

public final UnaryCallable<CreateUserLinkRequest,UserLink> createUserLinkCallable()

Creates a user link on an account or property.

If the user with the specified email already has permissions on the account or property, then the user's existing permissions will be unioned with the permissions specified in the new UserLink.

Sample code:

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

Returns

Type	Description
UnaryCallable<CreateUserLinkRequest,UserLink>

deleteAccount(AccountName name)

public final void deleteAccount(AccountName name)

Marks target Account as soft-deleted (ie: "trashed") and returns it.

This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI.

If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772

Returns an error if the target is not found.

Sample code:

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

Parameter

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

deleteAccount(DeleteAccountRequest request)

public final void deleteAccount(DeleteAccountRequest request)

Marks target Account as soft-deleted (ie: "trashed") and returns it.

This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI.

If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772

Returns an error if the target is not found.

Sample code:

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

Parameter

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

deleteAccount(String name)

public final void deleteAccount(String name)

Marks target Account as soft-deleted (ie: "trashed") and returns it.

This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI.

If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772

Returns an error if the target is not found.

Sample code:

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

Parameter

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

deleteAccountCallable()

public final UnaryCallable<DeleteAccountRequest,Empty> deleteAccountCallable()

Marks target Account as soft-deleted (ie: "trashed") and returns it.

This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI.

If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772

Returns an error if the target is not found.

Sample code:

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

Returns

Type	Description
UnaryCallable<DeleteAccountRequest,Empty>

deleteConversionEvent(ConversionEventName name)

public final void deleteConversionEvent(ConversionEventName name)

Deletes a conversion event in a property.

Sample code:

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

Parameter

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

deleteConversionEvent(DeleteConversionEventRequest request)

public final void deleteConversionEvent(DeleteConversionEventRequest request)

Deletes a conversion event in a property.

Sample code:

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

Parameter

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

deleteConversionEvent(String name)

public final void deleteConversionEvent(String name)

Deletes a conversion event in a property.

Sample code:

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

Parameter

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

deleteConversionEventCallable()

public final UnaryCallable<DeleteConversionEventRequest,Empty> deleteConversionEventCallable()

Deletes a conversion event in a property.

Sample code:

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

Returns

Type	Description
UnaryCallable<DeleteConversionEventRequest,Empty>

deleteDataStream(DataStreamName name)

public final void deleteDataStream(DataStreamName name)

Deletes a DataStream on a property.

Sample code:

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

Parameter

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

deleteDataStream(DeleteDataStreamRequest request)

public final void deleteDataStream(DeleteDataStreamRequest request)

Deletes a DataStream on a property.

Sample code:

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

Parameter

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

deleteDataStream(String name)

public final void deleteDataStream(String name)

Deletes a DataStream on a property.

Sample code:

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

Parameter

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

deleteDataStreamCallable()

public final UnaryCallable<DeleteDataStreamRequest,Empty> deleteDataStreamCallable()

Deletes a DataStream on a property.

Sample code:

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

Returns

Type	Description
UnaryCallable<DeleteDataStreamRequest,Empty>

deleteDisplayVideo360AdvertiserLink(DeleteDisplayVideo360AdvertiserLinkRequest request)

public final void deleteDisplayVideo360AdvertiserLink(DeleteDisplayVideo360AdvertiserLinkRequest request)

Deletes a DisplayVideo360AdvertiserLink on a property.

Sample code:

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

Parameter

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

deleteDisplayVideo360AdvertiserLink(DisplayVideo360AdvertiserLinkName name)

public final void deleteDisplayVideo360AdvertiserLink(DisplayVideo360AdvertiserLinkName name)

Deletes a DisplayVideo360AdvertiserLink on a property.

Sample code:

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

Parameter

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

deleteDisplayVideo360AdvertiserLink(String name)

public final void deleteDisplayVideo360AdvertiserLink(String name)

Deletes a DisplayVideo360AdvertiserLink on a property.

Sample code:

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

Parameter

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

deleteDisplayVideo360AdvertiserLinkCallable()

public final UnaryCallable<DeleteDisplayVideo360AdvertiserLinkRequest,Empty> deleteDisplayVideo360AdvertiserLinkCallable()

Deletes a DisplayVideo360AdvertiserLink on a property.

Sample code:

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

Returns

Type	Description
UnaryCallable<DeleteDisplayVideo360AdvertiserLinkRequest,Empty>

deleteDisplayVideo360AdvertiserLinkProposal(DeleteDisplayVideo360AdvertiserLinkProposalRequest request)

public final void deleteDisplayVideo360AdvertiserLinkProposal(DeleteDisplayVideo360AdvertiserLinkProposalRequest request)

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

Sample code:

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

Parameter

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

deleteDisplayVideo360AdvertiserLinkProposal(DisplayVideo360AdvertiserLinkProposalName name)

public final void deleteDisplayVideo360AdvertiserLinkProposal(DisplayVideo360AdvertiserLinkProposalName name)

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

Sample code:

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

Parameter

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

deleteDisplayVideo360AdvertiserLinkProposal(String name)

public final void deleteDisplayVideo360AdvertiserLinkProposal(String name)

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

Sample code:

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

Parameter

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

deleteDisplayVideo360AdvertiserLinkProposalCallable()

public final UnaryCallable<DeleteDisplayVideo360AdvertiserLinkProposalRequest,Empty> deleteDisplayVideo360AdvertiserLinkProposalCallable()

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

Sample code:

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

Returns

Type	Description
UnaryCallable<DeleteDisplayVideo360AdvertiserLinkProposalRequest,Empty>

deleteFirebaseLink(DeleteFirebaseLinkRequest request)

public final void deleteFirebaseLink(DeleteFirebaseLinkRequest request)

Deletes a FirebaseLink on a property

Sample code:

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

Parameter

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

deleteFirebaseLink(FirebaseLinkName name)

public final void deleteFirebaseLink(FirebaseLinkName name)

Deletes a FirebaseLink on a property

Sample code:

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

Parameter

Name	Description
name	FirebaseLinkName Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: properties/1234/firebaseLinks/5678

deleteFirebaseLink(String name)

public final void deleteFirebaseLink(String name)

Deletes a FirebaseLink on a property

Sample code:

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

Parameter

Name	Description
name	String Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: properties/1234/firebaseLinks/5678

deleteFirebaseLinkCallable()

public final UnaryCallable<DeleteFirebaseLinkRequest,Empty> deleteFirebaseLinkCallable()

Deletes a FirebaseLink on a property

Sample code:

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

Returns

Type	Description
UnaryCallable<DeleteFirebaseLinkRequest,Empty>

deleteGoogleAdsLink(DeleteGoogleAdsLinkRequest request)

public final void deleteGoogleAdsLink(DeleteGoogleAdsLinkRequest request)

Deletes a GoogleAdsLink on a property

Sample code:

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

Parameter

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

deleteGoogleAdsLink(GoogleAdsLinkName name)

public final void deleteGoogleAdsLink(GoogleAdsLinkName name)

Deletes a GoogleAdsLink on a property

Sample code:

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

Parameter

Name	Description
name	GoogleAdsLinkName Required. Example format: properties/1234/googleAdsLinks/5678

deleteGoogleAdsLink(String name)

public final void deleteGoogleAdsLink(String name)

Deletes a GoogleAdsLink on a property

Sample code:

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

Parameter

Name	Description
name	String Required. Example format: properties/1234/googleAdsLinks/5678

deleteGoogleAdsLinkCallable()

public final UnaryCallable<DeleteGoogleAdsLinkRequest,Empty> deleteGoogleAdsLinkCallable()

Deletes a GoogleAdsLink on a property

Sample code:

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

Returns

Type	Description
UnaryCallable<DeleteGoogleAdsLinkRequest,Empty>

deleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest request)

public final void deleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest request)

Deletes target MeasurementProtocolSecret.

Sample code:

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

Parameter

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

deleteMeasurementProtocolSecret(MeasurementProtocolSecretName name)

public final void deleteMeasurementProtocolSecret(MeasurementProtocolSecretName name)

Deletes target MeasurementProtocolSecret.

Sample code:

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

Parameter

Name	Description
name	MeasurementProtocolSecretName Required. The name of the MeasurementProtocolSecret to delete. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

deleteMeasurementProtocolSecret(String name)

public final void deleteMeasurementProtocolSecret(String name)

Deletes target MeasurementProtocolSecret.

Sample code:

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

Parameter

Name	Description
name	String Required. The name of the MeasurementProtocolSecret to delete. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

deleteMeasurementProtocolSecretCallable()

public final UnaryCallable<DeleteMeasurementProtocolSecretRequest,Empty> deleteMeasurementProtocolSecretCallable()

Deletes target MeasurementProtocolSecret.

Sample code:

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

Returns

Type	Description
UnaryCallable<DeleteMeasurementProtocolSecretRequest,Empty>

deleteProperty(DeletePropertyRequest request)

public final Property deleteProperty(DeletePropertyRequest request)

Marks target Property as soft-deleted (ie: "trashed") and returns it.

This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI.

If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772

Returns an error if the target is not found, or is not an GA4 Property.

Sample code:

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

Parameter

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

Returns

Type	Description
Property

deleteProperty(PropertyName name)

public final Property deleteProperty(PropertyName name)

Marks target Property as soft-deleted (ie: "trashed") and returns it.

This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI.

If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772

Returns an error if the target is not found, or is not an GA4 Property.

Sample code:

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

Parameter

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

Returns

Type	Description
Property

deleteProperty(String name)

public final Property deleteProperty(String name)

Marks target Property as soft-deleted (ie: "trashed") and returns it.

This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI.

If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772

Returns an error if the target is not found, or is not an GA4 Property.

Sample code:

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

Parameter

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

Returns

Type	Description
Property

deletePropertyCallable()

public final UnaryCallable<DeletePropertyRequest,Property> deletePropertyCallable()

Marks target Property as soft-deleted (ie: "trashed") and returns it.

This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI.

If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772

Returns an error if the target is not found, or is not an GA4 Property.

Sample code:

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

Returns

Type	Description
UnaryCallable<DeletePropertyRequest,Property>

deleteUserLink(DeleteUserLinkRequest request)

public final void deleteUserLink(DeleteUserLinkRequest request)

Deletes a user link on an account or property.

Sample code:

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

Parameter

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

deleteUserLink(UserLinkName name)

public final void deleteUserLink(UserLinkName name)

Deletes a user link on an account or property.

Sample code:

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

Parameter

Name	Description
name	UserLinkName Required. Example format: accounts/1234/userLinks/5678

deleteUserLink(String name)

public final void deleteUserLink(String name)

Deletes a user link on an account or property.

Sample code:

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

Parameter

Name	Description
name	String Required. Example format: accounts/1234/userLinks/5678

deleteUserLinkCallable()

public final UnaryCallable<DeleteUserLinkRequest,Empty> deleteUserLinkCallable()

Deletes a user link on an account or property.

Sample code:

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

Returns

Type	Description
UnaryCallable<DeleteUserLinkRequest,Empty>

getAccount(AccountName name)

public final Account getAccount(AccountName name)

Lookup for a single Account.

Sample code:

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

Parameter

Name	Description
name	AccountName Required. The name of the account to lookup. Format: accounts/{account} Example: "accounts/100"

Returns

Type	Description
Account

getAccount(GetAccountRequest request)

public final Account getAccount(GetAccountRequest request)

Lookup for a single Account.

Sample code:

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

Parameter

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

Returns

Type	Description
Account

getAccount(String name)

public final Account getAccount(String name)

Lookup for a single Account.

Sample code:

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

Parameter

Name	Description
name	String Required. The name of the account to lookup. Format: accounts/{account} Example: "accounts/100"

Returns

Type	Description
Account

getAccountCallable()

public final UnaryCallable<GetAccountRequest,Account> getAccountCallable()

Lookup for a single Account.

Sample code:

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

Returns

Type	Description
UnaryCallable<GetAccountRequest,Account>

getAttributionSettings(AttributionSettingsName name)

public final AttributionSettings getAttributionSettings(AttributionSettingsName name)

Lookup for a AttributionSettings singleton.

Sample code:

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

Parameter

Name	Description
name	AttributionSettingsName Required. The name of the attribution settings to retrieve. Format: properties/{property}/attributionSettings

Returns

Type	Description
AttributionSettings

getAttributionSettings(GetAttributionSettingsRequest request)

public final AttributionSettings getAttributionSettings(GetAttributionSettingsRequest request)

Lookup for a AttributionSettings singleton.

Sample code:

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

Parameter

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

Returns

Type	Description
AttributionSettings

getAttributionSettings(String name)

public final AttributionSettings getAttributionSettings(String name)

Lookup for a AttributionSettings singleton.

Sample code:

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

Parameter

Name	Description
name	String Required. The name of the attribution settings to retrieve. Format: properties/{property}/attributionSettings

Returns

Type	Description
AttributionSettings

getAttributionSettingsCallable()

public final UnaryCallable<GetAttributionSettingsRequest,AttributionSettings> getAttributionSettingsCallable()

Lookup for a AttributionSettings singleton.

Sample code:

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

Returns

Type	Description
UnaryCallable<GetAttributionSettingsRequest,AttributionSettings>

getAudience(AudienceName name)

public final Audience getAudience(AudienceName name)

Lookup for a single Audience. Audiences created before 2020 may not be supported.

Sample code:

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

Parameter

Name	Description
name	AudienceName Required. The name of the Audience to get. Example format: properties/1234/audiences/5678

Returns

Type	Description
Audience

getAudience(GetAudienceRequest request)

public final Audience getAudience(GetAudienceRequest request)

Lookup for a single Audience. Audiences created before 2020 may not be supported.

Sample code:

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

Parameter

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

Returns

Type	Description
Audience

getAudience(String name)

public final Audience getAudience(String name)

Lookup for a single Audience. Audiences created before 2020 may not be supported.

Sample code:

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

Parameter

Name	Description
name	String Required. The name of the Audience to get. Example format: properties/1234/audiences/5678

Returns

Type	Description
Audience

getAudienceCallable()

public final UnaryCallable<GetAudienceRequest,Audience> getAudienceCallable()

Lookup for a single Audience. Audiences created before 2020 may not be supported.

Sample code:

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

Returns

Type	Description
UnaryCallable<GetAudienceRequest,Audience>

getConversionEvent(ConversionEventName name)

public final ConversionEvent getConversionEvent(ConversionEventName name)

Retrieve a single conversion event.

Sample code:

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

Parameter

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

Returns

Type	Description
ConversionEvent

getConversionEvent(GetConversionEventRequest request)

public final ConversionEvent getConversionEvent(GetConversionEventRequest request)

Retrieve a single conversion event.

Sample code:

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

Parameter

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

Returns

Type	Description
ConversionEvent

getConversionEvent(String name)

public final ConversionEvent getConversionEvent(String name)

Retrieve a single conversion event.

Sample code:

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

Parameter

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

Returns

Type	Description
ConversionEvent

getConversionEventCallable()

public final UnaryCallable<GetConversionEventRequest,ConversionEvent> getConversionEventCallable()

Retrieve a single conversion event.

Sample code:

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

Returns

Type	Description
UnaryCallable<GetConversionEventRequest,ConversionEvent>

getCustomDimension(CustomDimensionName name)

public final CustomDimension getCustomDimension(CustomDimensionName name)

Lookup for a single CustomDimension.

Sample code:

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

Parameter

Name	Description
name	CustomDimensionName Required. The name of the CustomDimension to get. Example format: properties/1234/customDimensions/5678

Returns

Type	Description
CustomDimension

getCustomDimension(GetCustomDimensionRequest request)

public final CustomDimension getCustomDimension(GetCustomDimensionRequest request)

Lookup for a single CustomDimension.

Sample code:

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

Parameter

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

Returns

Type	Description
CustomDimension

getCustomDimension(String name)

public final CustomDimension getCustomDimension(String name)

Lookup for a single CustomDimension.

Sample code:

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

Parameter

Name	Description
name	String Required. The name of the CustomDimension to get. Example format: properties/1234/customDimensions/5678

Returns

Type	Description
CustomDimension

getCustomDimensionCallable()

public final UnaryCallable<GetCustomDimensionRequest,CustomDimension> getCustomDimensionCallable()

Lookup for a single CustomDimension.

Sample code:

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

Returns

Type	Description
UnaryCallable<GetCustomDimensionRequest,CustomDimension>

getCustomMetric(CustomMetricName name)

public final CustomMetric getCustomMetric(CustomMetricName name)

Lookup for a single CustomMetric.

Sample code:

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

Parameter

Name	Description
name	CustomMetricName Required. The name of the CustomMetric to get. Example format: properties/1234/customMetrics/5678

Returns

Type	Description
CustomMetric

getCustomMetric(GetCustomMetricRequest request)

public final CustomMetric getCustomMetric(GetCustomMetricRequest request)

Lookup for a single CustomMetric.

Sample code:

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

Parameter

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

Returns

Type	Description
CustomMetric

getCustomMetric(String name)

public final CustomMetric getCustomMetric(String name)

Lookup for a single CustomMetric.

Sample code:

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

Parameter

Name	Description
name	String Required. The name of the CustomMetric to get. Example format: properties/1234/customMetrics/5678

Returns

Type	Description
CustomMetric

getCustomMetricCallable()

public final UnaryCallable<GetCustomMetricRequest,CustomMetric> getCustomMetricCallable()

Lookup for a single CustomMetric.

Sample code:

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

Returns

Type	Description
UnaryCallable<GetCustomMetricRequest,CustomMetric>

getDataRetentionSettings(DataRetentionSettingsName name)

public final DataRetentionSettings getDataRetentionSettings(DataRetentionSettingsName name)

Returns the singleton data retention settings for this property.

Sample code:

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

Parameter

Name	Description
name	DataRetentionSettingsName Required. The name of the settings to lookup. Format: properties/{property}/dataRetentionSettings Example: "properties/1000/dataRetentionSettings"

Returns

Type	Description
DataRetentionSettings

getDataRetentionSettings(GetDataRetentionSettingsRequest request)

public final DataRetentionSettings getDataRetentionSettings(GetDataRetentionSettingsRequest request)

Returns the singleton data retention settings for this property.

Sample code:

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

Parameter

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

Returns

Type	Description
DataRetentionSettings

getDataRetentionSettings(String name)

public final DataRetentionSettings getDataRetentionSettings(String name)

Returns the singleton data retention settings for this property.

Sample code:

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

Parameter

Name	Description
name	String Required. The name of the settings to lookup. Format: properties/{property}/dataRetentionSettings Example: "properties/1000/dataRetentionSettings"

Returns

Type	Description
DataRetentionSettings

getDataRetentionSettingsCallable()

public final UnaryCallable<GetDataRetentionSettingsRequest,DataRetentionSettings> getDataRetentionSettingsCallable()

Returns the singleton data retention settings for this property.

Sample code:

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

Returns

Type	Description
UnaryCallable<GetDataRetentionSettingsRequest,DataRetentionSettings>

getDataSharingSettings(DataSharingSettingsName name)

public final DataSharingSettings getDataSharingSettings(DataSharingSettingsName name)

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

Sample code:

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

Parameter

Name	Description
name	DataSharingSettingsName Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: "accounts/1000/dataSharingSettings"

Returns

Type	Description
DataSharingSettings

getDataSharingSettings(GetDataSharingSettingsRequest request)

public final DataSharingSettings getDataSharingSettings(GetDataSharingSettingsRequest request)

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

Sample code:

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

Parameter

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

Returns

Type	Description
DataSharingSettings

getDataSharingSettings(String name)

public final DataSharingSettings getDataSharingSettings(String name)

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

Sample code:

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

Parameter

Name	Description
name	String Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: "accounts/1000/dataSharingSettings"

Returns

Type	Description
DataSharingSettings

getDataSharingSettingsCallable()

public final UnaryCallable<GetDataSharingSettingsRequest,DataSharingSettings> getDataSharingSettingsCallable()

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

Sample code:

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

Returns

Type	Description
UnaryCallable<GetDataSharingSettingsRequest,DataSharingSettings>

getDataStream(DataStreamName name)

public final DataStream getDataStream(DataStreamName name)

Lookup for a single DataStream.

Sample code:

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

Parameter

Name	Description
name	DataStreamName Required. The name of the DataStream to get. Example format: properties/1234/dataStreams/5678

Returns

Type	Description
DataStream

getDataStream(GetDataStreamRequest request)

public final DataStream getDataStream(GetDataStreamRequest request)

Lookup for a single DataStream.

Sample code:

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

Parameter

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

Returns

Type	Description
DataStream

getDataStream(String name)

public final DataStream getDataStream(String name)

Lookup for a single DataStream.

Sample code:

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

Parameter

Name	Description
name	String Required. The name of the DataStream to get. Example format: properties/1234/dataStreams/5678

Returns

Type	Description
DataStream

getDataStreamCallable()

public final UnaryCallable<GetDataStreamRequest,DataStream> getDataStreamCallable()

Lookup for a single DataStream.

Sample code:

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

Returns

Type	Description
UnaryCallable<GetDataStreamRequest,DataStream>

getDisplayVideo360AdvertiserLink(DisplayVideo360AdvertiserLinkName name)

public final DisplayVideo360AdvertiserLink getDisplayVideo360AdvertiserLink(DisplayVideo360AdvertiserLinkName name)

Look up a single DisplayVideo360AdvertiserLink

Sample code:

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

Parameter

Name	Description
name	DisplayVideo360AdvertiserLinkName Required. The name of the DisplayVideo360AdvertiserLink to get. Example format: properties/1234/displayVideo360AdvertiserLink/5678

Returns

Type	Description
DisplayVideo360AdvertiserLink

getDisplayVideo360AdvertiserLink(GetDisplayVideo360AdvertiserLinkRequest request)

public final DisplayVideo360AdvertiserLink getDisplayVideo360AdvertiserLink(GetDisplayVideo360AdvertiserLinkRequest request)

Look up a single DisplayVideo360AdvertiserLink

Sample code:

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

Parameter

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

Returns

Type	Description
DisplayVideo360AdvertiserLink

getDisplayVideo360AdvertiserLink(String name)

public final DisplayVideo360AdvertiserLink getDisplayVideo360AdvertiserLink(String name)

Look up a single DisplayVideo360AdvertiserLink

Sample code:

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

Parameter

Name	Description
name	String Required. The name of the DisplayVideo360AdvertiserLink to get. Example format: properties/1234/displayVideo360AdvertiserLink/5678

Returns

Type	Description
DisplayVideo360AdvertiserLink

getDisplayVideo360AdvertiserLinkCallable()

public final UnaryCallable<GetDisplayVideo360AdvertiserLinkRequest,DisplayVideo360AdvertiserLink> getDisplayVideo360AdvertiserLinkCallable()

Look up a single DisplayVideo360AdvertiserLink

Sample code:

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

Returns

Type	Description
UnaryCallable<GetDisplayVideo360AdvertiserLinkRequest,DisplayVideo360AdvertiserLink>

getDisplayVideo360AdvertiserLinkProposal(DisplayVideo360AdvertiserLinkProposalName name)

public final DisplayVideo360AdvertiserLinkProposal getDisplayVideo360AdvertiserLinkProposal(DisplayVideo360AdvertiserLinkProposalName name)

Lookup for a single DisplayVideo360AdvertiserLinkProposal.

Sample code:

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

Parameter

Name	Description
name	DisplayVideo360AdvertiserLinkProposalName Required. The name of the DisplayVideo360AdvertiserLinkProposal to get. Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678

Returns

Type	Description
DisplayVideo360AdvertiserLinkProposal

getDisplayVideo360AdvertiserLinkProposal(GetDisplayVideo360AdvertiserLinkProposalRequest request)

public final DisplayVideo360AdvertiserLinkProposal getDisplayVideo360AdvertiserLinkProposal(GetDisplayVideo360AdvertiserLinkProposalRequest request)

Lookup for a single DisplayVideo360AdvertiserLinkProposal.

Sample code:

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

Parameter

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

Returns

Type	Description
DisplayVideo360AdvertiserLinkProposal

getDisplayVideo360AdvertiserLinkProposal(String name)

public final DisplayVideo360AdvertiserLinkProposal getDisplayVideo360AdvertiserLinkProposal(String name)

Lookup for a single DisplayVideo360AdvertiserLinkProposal.

Sample code:

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

Parameter

Name	Description
name	String Required. The name of the DisplayVideo360AdvertiserLinkProposal to get. Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678

Returns

Type	Description
DisplayVideo360AdvertiserLinkProposal

getDisplayVideo360AdvertiserLinkProposalCallable()

public final UnaryCallable<GetDisplayVideo360AdvertiserLinkProposalRequest,DisplayVideo360AdvertiserLinkProposal> getDisplayVideo360AdvertiserLinkProposalCallable()

Lookup for a single DisplayVideo360AdvertiserLinkProposal.

Sample code:

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

Returns

Type	Description
UnaryCallable<GetDisplayVideo360AdvertiserLinkProposalRequest,DisplayVideo360AdvertiserLinkProposal>

getGlobalSiteTag(GetGlobalSiteTagRequest request)

public final GlobalSiteTag getGlobalSiteTag(GetGlobalSiteTagRequest request)

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

Sample code:

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

Parameter

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

Returns

Type	Description
GlobalSiteTag

getGlobalSiteTag(GlobalSiteTagName name)

public final GlobalSiteTag getGlobalSiteTag(GlobalSiteTagName name)

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

Sample code:

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

Parameter

Name	Description
name	GlobalSiteTagName Required. The name of the site tag to lookup. Note that site tags are singletons and do not have unique IDs. Format: properties/{property_id}/dataStreams/{stream_id}/globalSiteTag Example: "properties/123/dataStreams/456/globalSiteTag"

Returns

Type	Description
GlobalSiteTag

getGlobalSiteTag(String name)

public final GlobalSiteTag getGlobalSiteTag(String name)

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

Sample code:

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

Parameter

Name	Description
name	String Required. The name of the site tag to lookup. Note that site tags are singletons and do not have unique IDs. Format: properties/{property_id}/dataStreams/{stream_id}/globalSiteTag Example: "properties/123/dataStreams/456/globalSiteTag"

Returns

Type	Description
GlobalSiteTag

getGlobalSiteTagCallable()

public final UnaryCallable<GetGlobalSiteTagRequest,GlobalSiteTag> getGlobalSiteTagCallable()

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

Sample code:

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

Returns

Type	Description
UnaryCallable<GetGlobalSiteTagRequest,GlobalSiteTag>

getGoogleSignalsSettings(GetGoogleSignalsSettingsRequest request)

public final GoogleSignalsSettings getGoogleSignalsSettings(GetGoogleSignalsSettingsRequest request)

Lookup for Google Signals settings for a property.

Sample code:

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

Parameter

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

Returns

Type	Description
GoogleSignalsSettings

getGoogleSignalsSettings(GoogleSignalsSettingsName name)

public final GoogleSignalsSettings getGoogleSignalsSettings(GoogleSignalsSettingsName name)

Lookup for Google Signals settings for a property.

Sample code:

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

Parameter

Name	Description
name	GoogleSignalsSettingsName Required. The name of the google signals settings to retrieve. Format: properties/{property}/googleSignalsSettings

Returns

Type	Description
GoogleSignalsSettings

getGoogleSignalsSettings(String name)

public final GoogleSignalsSettings getGoogleSignalsSettings(String name)

Lookup for Google Signals settings for a property.

Sample code:

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

Parameter

Name	Description
name	String Required. The name of the google signals settings to retrieve. Format: properties/{property}/googleSignalsSettings

Returns

Type	Description
GoogleSignalsSettings

getGoogleSignalsSettingsCallable()

public final UnaryCallable<GetGoogleSignalsSettingsRequest,GoogleSignalsSettings> getGoogleSignalsSettingsCallable()

Lookup for Google Signals settings for a property.

Sample code:

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

Returns

Type	Description
UnaryCallable<GetGoogleSignalsSettingsRequest,GoogleSignalsSettings>

getMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest request)

public final MeasurementProtocolSecret getMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest request)

Lookup for a single "GA4" MeasurementProtocolSecret.

Sample code:

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

Parameter

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

Returns

Type	Description
MeasurementProtocolSecret

getMeasurementProtocolSecret(MeasurementProtocolSecretName name)

public final MeasurementProtocolSecret getMeasurementProtocolSecret(MeasurementProtocolSecretName name)

Lookup for a single "GA4" MeasurementProtocolSecret.

Sample code:

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

Parameter

Name	Description
name	MeasurementProtocolSecretName Required. The name of the measurement protocol secret to lookup. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

Returns

Type	Description
MeasurementProtocolSecret

getMeasurementProtocolSecret(String name)

public final MeasurementProtocolSecret getMeasurementProtocolSecret(String name)

Lookup for a single "GA4" MeasurementProtocolSecret.

Sample code:

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

Parameter

Name	Description
name	String Required. The name of the measurement protocol secret to lookup. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

Returns

Type	Description
MeasurementProtocolSecret

getMeasurementProtocolSecretCallable()

public final UnaryCallable<GetMeasurementProtocolSecretRequest,MeasurementProtocolSecret> getMeasurementProtocolSecretCallable()

Lookup for a single "GA4" MeasurementProtocolSecret.

Sample code:

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

Returns

Type	Description
UnaryCallable<GetMeasurementProtocolSecretRequest,MeasurementProtocolSecret>

getProperty(GetPropertyRequest request)

public final Property getProperty(GetPropertyRequest request)

Lookup for a single "GA4" Property.

Sample code:

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

Parameter

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

Returns

Type	Description
Property

getProperty(PropertyName name)

public final Property getProperty(PropertyName name)

Lookup for a single "GA4" Property.

Sample code:

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

Parameter

Name	Description
name	PropertyName Required. The name of the property to lookup. Format: properties/{property_id} Example: "properties/1000"

Returns

Type	Description
Property

getProperty(String name)

public final Property getProperty(String name)

Lookup for a single "GA4" Property.

Sample code:

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

Parameter

Name	Description
name	String Required. The name of the property to lookup. Format: properties/{property_id} Example: "properties/1000"

Returns

Type	Description
Property

getPropertyCallable()

public final UnaryCallable<GetPropertyRequest,Property> getPropertyCallable()

Lookup for a single "GA4" Property.

Sample code:

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

Returns

Type	Description
UnaryCallable<GetPropertyRequest,Property>

getSettings()

public final AnalyticsAdminServiceSettings getSettings()

Returns

Type	Description
AnalyticsAdminServiceSettings

getStub()

public AnalyticsAdminServiceStub getStub()

Returns

Type	Description
AnalyticsAdminServiceStub

getUserLink(GetUserLinkRequest request)

public final UserLink getUserLink(GetUserLinkRequest request)

Gets information about a user's link to an account or property.

Sample code:

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

Parameter

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

Returns

Type	Description
UserLink

getUserLink(UserLinkName name)

public final UserLink getUserLink(UserLinkName name)

Gets information about a user's link to an account or property.

Sample code:

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

Parameter

Name	Description
name	UserLinkName Required. Example format: accounts/1234/userLinks/5678

Returns

Type	Description
UserLink

getUserLink(String name)

public final UserLink getUserLink(String name)

Gets information about a user's link to an account or property.

Sample code:

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

Parameter

Name	Description
name	String Required. Example format: accounts/1234/userLinks/5678

Returns

Type	Description
UserLink

getUserLinkCallable()

public final UnaryCallable<GetUserLinkRequest,UserLink> getUserLinkCallable()

Gets information about a user's link to an account or property.

Sample code:

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

Returns

Type	Description
UnaryCallable<GetUserLinkRequest,UserLink>

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

listAccountSummaries(ListAccountSummariesRequest request)

public final AnalyticsAdminServiceClient.ListAccountSummariesPagedResponse listAccountSummaries(ListAccountSummariesRequest request)

Returns summaries of all accounts accessible by the caller.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListAccountSummariesRequest request =
       ListAccountSummariesRequest.newBuilder()
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (AccountSummary element :
       analyticsAdminServiceClient.listAccountSummaries(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

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

Returns

Type	Description
AnalyticsAdminServiceClient.ListAccountSummariesPagedResponse

listAccountSummariesCallable()

public final UnaryCallable<ListAccountSummariesRequest,ListAccountSummariesResponse> listAccountSummariesCallable()

Returns summaries of all accounts accessible by the caller.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListAccountSummariesRequest request =
       ListAccountSummariesRequest.newBuilder()
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListAccountSummariesResponse response =
         analyticsAdminServiceClient.listAccountSummariesCallable().call(request);
     for (AccountSummary element : response.getAccountSummariesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListAccountSummariesRequest,ListAccountSummariesResponse>

listAccountSummariesPagedCallable()

public final UnaryCallable<ListAccountSummariesRequest,AnalyticsAdminServiceClient.ListAccountSummariesPagedResponse> listAccountSummariesPagedCallable()

Returns summaries of all accounts accessible by the caller.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListAccountSummariesRequest request =
       ListAccountSummariesRequest.newBuilder()
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<AccountSummary> future =
       analyticsAdminServiceClient.listAccountSummariesPagedCallable().futureCall(request);
   // Do something.
   for (AccountSummary element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns

Type	Description
UnaryCallable<ListAccountSummariesRequest,ListAccountSummariesPagedResponse>

listAccounts(ListAccountsRequest request)

public final AnalyticsAdminServiceClient.ListAccountsPagedResponse listAccounts(ListAccountsRequest request)

Returns all accounts accessible by the caller.

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

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListAccountsRequest request =
       ListAccountsRequest.newBuilder()
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setShowDeleted(true)
           .build();
   for (Account element : analyticsAdminServiceClient.listAccounts(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

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

Returns

Type	Description
AnalyticsAdminServiceClient.ListAccountsPagedResponse

listAccountsCallable()

public final UnaryCallable<ListAccountsRequest,ListAccountsResponse> listAccountsCallable()

Returns all accounts accessible by the caller.

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

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListAccountsRequest request =
       ListAccountsRequest.newBuilder()
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setShowDeleted(true)
           .build();
   while (true) {
     ListAccountsResponse response =
         analyticsAdminServiceClient.listAccountsCallable().call(request);
     for (Account element : response.getAccountsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListAccountsRequest,ListAccountsResponse>

listAccountsPagedCallable()

public final UnaryCallable<ListAccountsRequest,AnalyticsAdminServiceClient.ListAccountsPagedResponse> listAccountsPagedCallable()

Returns all accounts accessible by the caller.

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

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListAccountsRequest request =
       ListAccountsRequest.newBuilder()
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setShowDeleted(true)
           .build();
   ApiFuture<Account> future =
       analyticsAdminServiceClient.listAccountsPagedCallable().futureCall(request);
   // Do something.
   for (Account element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns

Type	Description
UnaryCallable<ListAccountsRequest,ListAccountsPagedResponse>

listAudiences(ListAudiencesRequest request)

public final AnalyticsAdminServiceClient.ListAudiencesPagedResponse listAudiences(ListAudiencesRequest request)

Lists Audiences on a property. Audiences created before 2020 may not be supported.

Sample code:

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

Parameter

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

Returns

Type	Description
AnalyticsAdminServiceClient.ListAudiencesPagedResponse

listAudiences(PropertyName parent)

public final AnalyticsAdminServiceClient.ListAudiencesPagedResponse listAudiences(PropertyName parent)

Lists Audiences on a property. Audiences created before 2020 may not be supported.

Sample code:

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

Parameter

Name	Description
parent	PropertyName Required. Example format: properties/1234

Returns

Type	Description
AnalyticsAdminServiceClient.ListAudiencesPagedResponse

listAudiences(String parent)

public final AnalyticsAdminServiceClient.ListAudiencesPagedResponse listAudiences(String parent)

Lists Audiences on a property. Audiences created before 2020 may not be supported.

Sample code:

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

Parameter

Name	Description
parent	String Required. Example format: properties/1234

Returns

Type	Description
AnalyticsAdminServiceClient.ListAudiencesPagedResponse

listAudiencesCallable()

public final UnaryCallable<ListAudiencesRequest,ListAudiencesResponse> listAudiencesCallable()

Lists Audiences on a property. Audiences created before 2020 may not be supported.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListAudiencesRequest request =
       ListAudiencesRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListAudiencesResponse response =
         analyticsAdminServiceClient.listAudiencesCallable().call(request);
     for (Audience element : response.getAudiencesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListAudiencesRequest,ListAudiencesResponse>

listAudiencesPagedCallable()

public final UnaryCallable<ListAudiencesRequest,AnalyticsAdminServiceClient.ListAudiencesPagedResponse> listAudiencesPagedCallable()

Lists Audiences on a property. Audiences created before 2020 may not be supported.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListAudiencesRequest request =
       ListAudiencesRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Audience> future =
       analyticsAdminServiceClient.listAudiencesPagedCallable().futureCall(request);
   // Do something.
   for (Audience element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns

Type	Description
UnaryCallable<ListAudiencesRequest,ListAudiencesPagedResponse>

listConversionEvents(ListConversionEventsRequest request)

public final AnalyticsAdminServiceClient.ListConversionEventsPagedResponse listConversionEvents(ListConversionEventsRequest request)

Returns a list of conversion events in the specified parent property.

Returns an empty list if no conversion events are found.

Sample code:

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

Parameter

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

Returns

Type	Description
AnalyticsAdminServiceClient.ListConversionEventsPagedResponse

listConversionEvents(PropertyName parent)

public final AnalyticsAdminServiceClient.ListConversionEventsPagedResponse listConversionEvents(PropertyName parent)

Returns a list of conversion events in the specified parent property.

Returns an empty list if no conversion events are found.

Sample code:

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

Parameter

Name	Description
parent	PropertyName Required. The resource name of the parent property. Example: 'properties/123'

Returns

Type	Description
AnalyticsAdminServiceClient.ListConversionEventsPagedResponse

listConversionEvents(String parent)

public final AnalyticsAdminServiceClient.ListConversionEventsPagedResponse listConversionEvents(String parent)

Returns a list of conversion events in the specified parent property.

Returns an empty list if no conversion events are found.

Sample code:

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

Parameter

Name	Description
parent	String Required. The resource name of the parent property. Example: 'properties/123'

Returns

Type	Description
AnalyticsAdminServiceClient.ListConversionEventsPagedResponse

listConversionEventsCallable()

public final UnaryCallable<ListConversionEventsRequest,ListConversionEventsResponse> listConversionEventsCallable()

Returns a list of conversion events in the specified parent property.

Returns an empty list if no conversion events are found.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListConversionEventsRequest request =
       ListConversionEventsRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListConversionEventsResponse response =
         analyticsAdminServiceClient.listConversionEventsCallable().call(request);
     for (ConversionEvent element : response.getConversionEventsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListConversionEventsRequest,ListConversionEventsResponse>

listConversionEventsPagedCallable()

public final UnaryCallable<ListConversionEventsRequest,AnalyticsAdminServiceClient.ListConversionEventsPagedResponse> listConversionEventsPagedCallable()

Returns a list of conversion events in the specified parent property.

Returns an empty list if no conversion events are found.

Sample code:

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

Returns

Type	Description
UnaryCallable<ListConversionEventsRequest,ListConversionEventsPagedResponse>

listCustomDimensions(ListCustomDimensionsRequest request)

public final AnalyticsAdminServiceClient.ListCustomDimensionsPagedResponse listCustomDimensions(ListCustomDimensionsRequest request)

Lists CustomDimensions on a property.

Sample code:

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

Parameter

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

Returns

Type	Description
AnalyticsAdminServiceClient.ListCustomDimensionsPagedResponse

listCustomDimensions(PropertyName parent)

public final AnalyticsAdminServiceClient.ListCustomDimensionsPagedResponse listCustomDimensions(PropertyName parent)

Lists CustomDimensions on a property.

Sample code:

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

Parameter

Name	Description
parent	PropertyName Required. Example format: properties/1234

Returns

Type	Description
AnalyticsAdminServiceClient.ListCustomDimensionsPagedResponse

listCustomDimensions(String parent)

public final AnalyticsAdminServiceClient.ListCustomDimensionsPagedResponse listCustomDimensions(String parent)

Lists CustomDimensions on a property.

Sample code:

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

Parameter

Name	Description
parent	String Required. Example format: properties/1234

Returns

Type	Description
AnalyticsAdminServiceClient.ListCustomDimensionsPagedResponse

listCustomDimensionsCallable()

public final UnaryCallable<ListCustomDimensionsRequest,ListCustomDimensionsResponse> listCustomDimensionsCallable()

Lists CustomDimensions on a property.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListCustomDimensionsRequest request =
       ListCustomDimensionsRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListCustomDimensionsResponse response =
         analyticsAdminServiceClient.listCustomDimensionsCallable().call(request);
     for (CustomDimension element : response.getCustomDimensionsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListCustomDimensionsRequest,ListCustomDimensionsResponse>

listCustomDimensionsPagedCallable()

public final UnaryCallable<ListCustomDimensionsRequest,AnalyticsAdminServiceClient.ListCustomDimensionsPagedResponse> listCustomDimensionsPagedCallable()

Lists CustomDimensions on a property.

Sample code:

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

Returns

Type	Description
UnaryCallable<ListCustomDimensionsRequest,ListCustomDimensionsPagedResponse>

listCustomMetrics(ListCustomMetricsRequest request)

public final AnalyticsAdminServiceClient.ListCustomMetricsPagedResponse listCustomMetrics(ListCustomMetricsRequest request)

Lists CustomMetrics on a property.

Sample code:

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

Parameter

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

Returns

Type	Description
AnalyticsAdminServiceClient.ListCustomMetricsPagedResponse

listCustomMetrics(PropertyName parent)

public final AnalyticsAdminServiceClient.ListCustomMetricsPagedResponse listCustomMetrics(PropertyName parent)

Lists CustomMetrics on a property.

Sample code:

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

Parameter

Name	Description
parent	PropertyName Required. Example format: properties/1234

Returns

Type	Description
AnalyticsAdminServiceClient.ListCustomMetricsPagedResponse

listCustomMetrics(String parent)

public final AnalyticsAdminServiceClient.ListCustomMetricsPagedResponse listCustomMetrics(String parent)

Lists CustomMetrics on a property.

Sample code:

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

Parameter

Name	Description
parent	String Required. Example format: properties/1234

Returns

Type	Description
AnalyticsAdminServiceClient.ListCustomMetricsPagedResponse

listCustomMetricsCallable()

public final UnaryCallable<ListCustomMetricsRequest,ListCustomMetricsResponse> listCustomMetricsCallable()

Lists CustomMetrics on a property.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListCustomMetricsRequest request =
       ListCustomMetricsRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListCustomMetricsResponse response =
         analyticsAdminServiceClient.listCustomMetricsCallable().call(request);
     for (CustomMetric element : response.getCustomMetricsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListCustomMetricsRequest,ListCustomMetricsResponse>

listCustomMetricsPagedCallable()

public final UnaryCallable<ListCustomMetricsRequest,AnalyticsAdminServiceClient.ListCustomMetricsPagedResponse> listCustomMetricsPagedCallable()

Lists CustomMetrics on a property.

Sample code:

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

Returns

Type	Description
UnaryCallable<ListCustomMetricsRequest,ListCustomMetricsPagedResponse>

listDataStreams(ListDataStreamsRequest request)

public final AnalyticsAdminServiceClient.ListDataStreamsPagedResponse listDataStreams(ListDataStreamsRequest request)

Lists DataStreams on a property.

Sample code:

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

Parameter

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

Returns

Type	Description
AnalyticsAdminServiceClient.ListDataStreamsPagedResponse

listDataStreams(PropertyName parent)

public final AnalyticsAdminServiceClient.ListDataStreamsPagedResponse listDataStreams(PropertyName parent)

Lists DataStreams on a property.

Sample code:

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

Parameter

Name	Description
parent	PropertyName Required. Example format: properties/1234

Returns

Type	Description
AnalyticsAdminServiceClient.ListDataStreamsPagedResponse

listDataStreams(String parent)

public final AnalyticsAdminServiceClient.ListDataStreamsPagedResponse listDataStreams(String parent)

Lists DataStreams on a property.

Sample code:

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

Parameter

Name	Description
parent	String Required. Example format: properties/1234

Returns

Type	Description
AnalyticsAdminServiceClient.ListDataStreamsPagedResponse

listDataStreamsCallable()

public final UnaryCallable<ListDataStreamsRequest,ListDataStreamsResponse> listDataStreamsCallable()

Lists DataStreams on a property.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListDataStreamsRequest request =
       ListDataStreamsRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListDataStreamsResponse response =
         analyticsAdminServiceClient.listDataStreamsCallable().call(request);
     for (DataStream element : response.getDataStreamsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListDataStreamsRequest,ListDataStreamsResponse>

listDataStreamsPagedCallable()

public final UnaryCallable<ListDataStreamsRequest,AnalyticsAdminServiceClient.ListDataStreamsPagedResponse> listDataStreamsPagedCallable()

Lists DataStreams on a property.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListDataStreamsRequest request =
       ListDataStreamsRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<DataStream> future =
       analyticsAdminServiceClient.listDataStreamsPagedCallable().futureCall(request);
   // Do something.
   for (DataStream element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns

Type	Description
UnaryCallable<ListDataStreamsRequest,ListDataStreamsPagedResponse>

listDisplayVideo360AdvertiserLinkProposals(ListDisplayVideo360AdvertiserLinkProposalsRequest request)

public final AnalyticsAdminServiceClient.ListDisplayVideo360AdvertiserLinkProposalsPagedResponse listDisplayVideo360AdvertiserLinkProposals(ListDisplayVideo360AdvertiserLinkProposalsRequest request)

Lists DisplayVideo360AdvertiserLinkProposals on a property.

Sample code:

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

Parameter

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

Returns

Type	Description
AnalyticsAdminServiceClient.ListDisplayVideo360AdvertiserLinkProposalsPagedResponse

listDisplayVideo360AdvertiserLinkProposals(PropertyName parent)

public final AnalyticsAdminServiceClient.ListDisplayVideo360AdvertiserLinkProposalsPagedResponse listDisplayVideo360AdvertiserLinkProposals(PropertyName parent)

Lists DisplayVideo360AdvertiserLinkProposals on a property.

Sample code:

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

Parameter

Name	Description
parent	PropertyName Required. Example format: properties/1234

Returns

Type	Description
AnalyticsAdminServiceClient.ListDisplayVideo360AdvertiserLinkProposalsPagedResponse

listDisplayVideo360AdvertiserLinkProposals(String parent)

public final AnalyticsAdminServiceClient.ListDisplayVideo360AdvertiserLinkProposalsPagedResponse listDisplayVideo360AdvertiserLinkProposals(String parent)

Lists DisplayVideo360AdvertiserLinkProposals on a property.

Sample code:

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

Parameter

Name	Description
parent	String Required. Example format: properties/1234

Returns

Type	Description
AnalyticsAdminServiceClient.ListDisplayVideo360AdvertiserLinkProposalsPagedResponse

listDisplayVideo360AdvertiserLinkProposalsCallable()

public final UnaryCallable<ListDisplayVideo360AdvertiserLinkProposalsRequest,ListDisplayVideo360AdvertiserLinkProposalsResponse> listDisplayVideo360AdvertiserLinkProposalsCallable()

Lists DisplayVideo360AdvertiserLinkProposals on a property.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListDisplayVideo360AdvertiserLinkProposalsRequest request =
       ListDisplayVideo360AdvertiserLinkProposalsRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListDisplayVideo360AdvertiserLinkProposalsResponse response =
         analyticsAdminServiceClient
             .listDisplayVideo360AdvertiserLinkProposalsCallable()
             .call(request);
     for (DisplayVideo360AdvertiserLinkProposal element :
         response.getDisplayVideo360AdvertiserLinkProposalsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListDisplayVideo360AdvertiserLinkProposalsRequest,ListDisplayVideo360AdvertiserLinkProposalsResponse>

listDisplayVideo360AdvertiserLinkProposalsPagedCallable()

public final UnaryCallable<ListDisplayVideo360AdvertiserLinkProposalsRequest,AnalyticsAdminServiceClient.ListDisplayVideo360AdvertiserLinkProposalsPagedResponse> listDisplayVideo360AdvertiserLinkProposalsPagedCallable()

Lists DisplayVideo360AdvertiserLinkProposals on a property.

Sample code:

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

Returns

Type	Description
UnaryCallable<ListDisplayVideo360AdvertiserLinkProposalsRequest,ListDisplayVideo360AdvertiserLinkProposalsPagedResponse>

listDisplayVideo360AdvertiserLinks(ListDisplayVideo360AdvertiserLinksRequest request)

public final AnalyticsAdminServiceClient.ListDisplayVideo360AdvertiserLinksPagedResponse listDisplayVideo360AdvertiserLinks(ListDisplayVideo360AdvertiserLinksRequest request)

Lists all DisplayVideo360AdvertiserLinks on a property.

Sample code:

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

Parameter

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

Returns

Type	Description
AnalyticsAdminServiceClient.ListDisplayVideo360AdvertiserLinksPagedResponse

listDisplayVideo360AdvertiserLinks(PropertyName parent)

public final AnalyticsAdminServiceClient.ListDisplayVideo360AdvertiserLinksPagedResponse listDisplayVideo360AdvertiserLinks(PropertyName parent)

Lists all DisplayVideo360AdvertiserLinks on a property.

Sample code:

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

Parameter

Name	Description
parent	PropertyName Required. Example format: properties/1234

Returns

Type	Description
AnalyticsAdminServiceClient.ListDisplayVideo360AdvertiserLinksPagedResponse

listDisplayVideo360AdvertiserLinks(String parent)

public final AnalyticsAdminServiceClient.ListDisplayVideo360AdvertiserLinksPagedResponse listDisplayVideo360AdvertiserLinks(String parent)

Lists all DisplayVideo360AdvertiserLinks on a property.

Sample code:

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

Parameter

Name	Description
parent	String Required. Example format: properties/1234

Returns

Type	Description
AnalyticsAdminServiceClient.ListDisplayVideo360AdvertiserLinksPagedResponse

listDisplayVideo360AdvertiserLinksCallable()

public final UnaryCallable<ListDisplayVideo360AdvertiserLinksRequest,ListDisplayVideo360AdvertiserLinksResponse> listDisplayVideo360AdvertiserLinksCallable()

Lists all DisplayVideo360AdvertiserLinks on a property.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListDisplayVideo360AdvertiserLinksRequest request =
       ListDisplayVideo360AdvertiserLinksRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListDisplayVideo360AdvertiserLinksResponse response =
         analyticsAdminServiceClient.listDisplayVideo360AdvertiserLinksCallable().call(request);
     for (DisplayVideo360AdvertiserLink element :
         response.getDisplayVideo360AdvertiserLinksList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListDisplayVideo360AdvertiserLinksRequest,ListDisplayVideo360AdvertiserLinksResponse>

listDisplayVideo360AdvertiserLinksPagedCallable()

public final UnaryCallable<ListDisplayVideo360AdvertiserLinksRequest,AnalyticsAdminServiceClient.ListDisplayVideo360AdvertiserLinksPagedResponse> listDisplayVideo360AdvertiserLinksPagedCallable()

Lists all DisplayVideo360AdvertiserLinks on a property.

Sample code:

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

Returns

Type	Description
UnaryCallable<ListDisplayVideo360AdvertiserLinksRequest,ListDisplayVideo360AdvertiserLinksPagedResponse>

listFirebaseLinks(ListFirebaseLinksRequest request)

public final AnalyticsAdminServiceClient.ListFirebaseLinksPagedResponse listFirebaseLinks(ListFirebaseLinksRequest request)

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

Sample code:

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

Parameter

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

Returns

Type	Description
AnalyticsAdminServiceClient.ListFirebaseLinksPagedResponse

listFirebaseLinks(PropertyName parent)

public final AnalyticsAdminServiceClient.ListFirebaseLinksPagedResponse listFirebaseLinks(PropertyName parent)

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

Sample code:

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

Parameter

Name	Description
parent	PropertyName Required. Format: properties/{property_id} Example: properties/1234

Returns

Type	Description
AnalyticsAdminServiceClient.ListFirebaseLinksPagedResponse

listFirebaseLinks(String parent)

public final AnalyticsAdminServiceClient.ListFirebaseLinksPagedResponse listFirebaseLinks(String parent)

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

Sample code:

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

Parameter

Name	Description
parent	String Required. Format: properties/{property_id} Example: properties/1234

Returns

Type	Description
AnalyticsAdminServiceClient.ListFirebaseLinksPagedResponse

listFirebaseLinksCallable()

public final UnaryCallable<ListFirebaseLinksRequest,ListFirebaseLinksResponse> listFirebaseLinksCallable()

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

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListFirebaseLinksRequest request =
       ListFirebaseLinksRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListFirebaseLinksResponse response =
         analyticsAdminServiceClient.listFirebaseLinksCallable().call(request);
     for (FirebaseLink element : response.getFirebaseLinksList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListFirebaseLinksRequest,ListFirebaseLinksResponse>

listFirebaseLinksPagedCallable()

public final UnaryCallable<ListFirebaseLinksRequest,AnalyticsAdminServiceClient.ListFirebaseLinksPagedResponse> listFirebaseLinksPagedCallable()

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

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListFirebaseLinksRequest request =
       ListFirebaseLinksRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<FirebaseLink> future =
       analyticsAdminServiceClient.listFirebaseLinksPagedCallable().futureCall(request);
   // Do something.
   for (FirebaseLink element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns

Type	Description
UnaryCallable<ListFirebaseLinksRequest,ListFirebaseLinksPagedResponse>

listGoogleAdsLinks(ListGoogleAdsLinksRequest request)

public final AnalyticsAdminServiceClient.ListGoogleAdsLinksPagedResponse listGoogleAdsLinks(ListGoogleAdsLinksRequest request)

Lists GoogleAdsLinks on a property.

Sample code:

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

Parameter

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

Returns

Type	Description
AnalyticsAdminServiceClient.ListGoogleAdsLinksPagedResponse

listGoogleAdsLinks(PropertyName parent)

public final AnalyticsAdminServiceClient.ListGoogleAdsLinksPagedResponse listGoogleAdsLinks(PropertyName parent)

Lists GoogleAdsLinks on a property.

Sample code:

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

Parameter

Name	Description
parent	PropertyName Required. Example format: properties/1234

Returns

Type	Description
AnalyticsAdminServiceClient.ListGoogleAdsLinksPagedResponse

listGoogleAdsLinks(String parent)

public final AnalyticsAdminServiceClient.ListGoogleAdsLinksPagedResponse listGoogleAdsLinks(String parent)

Lists GoogleAdsLinks on a property.

Sample code:

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

Parameter

Name	Description
parent	String Required. Example format: properties/1234

Returns

Type	Description
AnalyticsAdminServiceClient.ListGoogleAdsLinksPagedResponse

listGoogleAdsLinksCallable()

public final UnaryCallable<ListGoogleAdsLinksRequest,ListGoogleAdsLinksResponse> listGoogleAdsLinksCallable()

Lists GoogleAdsLinks on a property.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListGoogleAdsLinksRequest request =
       ListGoogleAdsLinksRequest.newBuilder()
           .setParent(PropertyName.of("[PROPERTY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListGoogleAdsLinksResponse response =
         analyticsAdminServiceClient.listGoogleAdsLinksCallable().call(request);
     for (GoogleAdsLink element : response.getGoogleAdsLinksList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListGoogleAdsLinksRequest,ListGoogleAdsLinksResponse>

listGoogleAdsLinksPagedCallable()

public final UnaryCallable<ListGoogleAdsLinksRequest,AnalyticsAdminServiceClient.ListGoogleAdsLinksPagedResponse> listGoogleAdsLinksPagedCallable()

Lists GoogleAdsLinks on a property.

Sample code:

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

Returns

Type	Description
UnaryCallable<ListGoogleAdsLinksRequest,ListGoogleAdsLinksPagedResponse>

listMeasurementProtocolSecrets(DataStreamName parent)

public final AnalyticsAdminServiceClient.ListMeasurementProtocolSecretsPagedResponse listMeasurementProtocolSecrets(DataStreamName parent)

Returns child MeasurementProtocolSecrets under the specified parent Property.

Sample code:

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

Parameter

Name	Description
parent	DataStreamName Required. The resource name of the parent stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets

Returns

Type	Description
AnalyticsAdminServiceClient.ListMeasurementProtocolSecretsPagedResponse

listMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest request)

public final AnalyticsAdminServiceClient.ListMeasurementProtocolSecretsPagedResponse listMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest request)

Returns child MeasurementProtocolSecrets under the specified parent Property.

Sample code:

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

Parameter

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

Returns

Type	Description
AnalyticsAdminServiceClient.ListMeasurementProtocolSecretsPagedResponse

listMeasurementProtocolSecrets(String parent)

public final AnalyticsAdminServiceClient.ListMeasurementProtocolSecretsPagedResponse listMeasurementProtocolSecrets(String parent)

Returns child MeasurementProtocolSecrets under the specified parent Property.

Sample code:

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

Parameter

Name	Description
parent	String Required. The resource name of the parent stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets

Returns

Type	Description
AnalyticsAdminServiceClient.ListMeasurementProtocolSecretsPagedResponse

listMeasurementProtocolSecretsCallable()

public final UnaryCallable<ListMeasurementProtocolSecretsRequest,ListMeasurementProtocolSecretsResponse> listMeasurementProtocolSecretsCallable()

Returns child MeasurementProtocolSecrets under the specified parent Property.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListMeasurementProtocolSecretsRequest request =
       ListMeasurementProtocolSecretsRequest.newBuilder()
           .setParent(DataStreamName.of("[PROPERTY]", "[DATA_STREAM]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListMeasurementProtocolSecretsResponse response =
         analyticsAdminServiceClient.listMeasurementProtocolSecretsCallable().call(request);
     for (MeasurementProtocolSecret element : response.getMeasurementProtocolSecretsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListMeasurementProtocolSecretsRequest,ListMeasurementProtocolSecretsResponse>

listMeasurementProtocolSecretsPagedCallable()

public final UnaryCallable<ListMeasurementProtocolSecretsRequest,AnalyticsAdminServiceClient.ListMeasurementProtocolSecretsPagedResponse> listMeasurementProtocolSecretsPagedCallable()

Returns child MeasurementProtocolSecrets under the specified parent Property.

Sample code:

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

Returns

Type	Description
UnaryCallable<ListMeasurementProtocolSecretsRequest,ListMeasurementProtocolSecretsPagedResponse>

listProperties(ListPropertiesRequest request)

public final AnalyticsAdminServiceClient.ListPropertiesPagedResponse listProperties(ListPropertiesRequest request)

Returns child Properties under the specified parent Account.

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

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListPropertiesRequest request =
       ListPropertiesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setShowDeleted(true)
           .build();
   for (Property element : analyticsAdminServiceClient.listProperties(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

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

Returns

Type	Description
AnalyticsAdminServiceClient.ListPropertiesPagedResponse

listPropertiesCallable()

public final UnaryCallable<ListPropertiesRequest,ListPropertiesResponse> listPropertiesCallable()

Returns child Properties under the specified parent Account.

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

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListPropertiesRequest request =
       ListPropertiesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setShowDeleted(true)
           .build();
   while (true) {
     ListPropertiesResponse response =
         analyticsAdminServiceClient.listPropertiesCallable().call(request);
     for (Property element : response.getPropertiesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListPropertiesRequest,ListPropertiesResponse>

listPropertiesPagedCallable()

public final UnaryCallable<ListPropertiesRequest,AnalyticsAdminServiceClient.ListPropertiesPagedResponse> listPropertiesPagedCallable()

Returns child Properties under the specified parent Account.

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

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListPropertiesRequest request =
       ListPropertiesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setShowDeleted(true)
           .build();
   ApiFuture<Property> future =
       analyticsAdminServiceClient.listPropertiesPagedCallable().futureCall(request);
   // Do something.
   for (Property element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns

Type	Description
UnaryCallable<ListPropertiesRequest,ListPropertiesPagedResponse>

listUserLinks(AccountName parent)

public final AnalyticsAdminServiceClient.ListUserLinksPagedResponse listUserLinks(AccountName parent)

Lists all user links on an account or property.

Sample code:

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

Parameter

Name	Description
parent	AccountName Required. Example format: accounts/1234

Returns

Type	Description
AnalyticsAdminServiceClient.ListUserLinksPagedResponse

listUserLinks(ListUserLinksRequest request)

public final AnalyticsAdminServiceClient.ListUserLinksPagedResponse listUserLinks(ListUserLinksRequest request)

Lists all user links on an account or property.

Sample code:

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

Parameter

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

Returns

Type	Description
AnalyticsAdminServiceClient.ListUserLinksPagedResponse

listUserLinks(PropertyName parent)

public final AnalyticsAdminServiceClient.ListUserLinksPagedResponse listUserLinks(PropertyName parent)

Lists all user links on an account or property.

Sample code:

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

Parameter

Name	Description
parent	PropertyName Required. Example format: accounts/1234

Returns

Type	Description
AnalyticsAdminServiceClient.ListUserLinksPagedResponse

listUserLinks(String parent)

public final AnalyticsAdminServiceClient.ListUserLinksPagedResponse listUserLinks(String parent)

Lists all user links on an account or property.

Sample code:

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

Parameter

Name	Description
parent	String Required. Example format: accounts/1234

Returns

Type	Description
AnalyticsAdminServiceClient.ListUserLinksPagedResponse

listUserLinksCallable()

public final UnaryCallable<ListUserLinksRequest,ListUserLinksResponse> listUserLinksCallable()

Lists all user links on an account or property.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListUserLinksRequest request =
       ListUserLinksRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListUserLinksResponse response =
         analyticsAdminServiceClient.listUserLinksCallable().call(request);
     for (UserLink element : response.getUserLinksList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListUserLinksRequest,ListUserLinksResponse>

listUserLinksPagedCallable()

public final UnaryCallable<ListUserLinksRequest,AnalyticsAdminServiceClient.ListUserLinksPagedResponse> listUserLinksPagedCallable()

Lists all user links on an account or property.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   ListUserLinksRequest request =
       ListUserLinksRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<UserLink> future =
       analyticsAdminServiceClient.listUserLinksPagedCallable().futureCall(request);
   // Do something.
   for (UserLink element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns

Type	Description
UnaryCallable<ListUserLinksRequest,ListUserLinksPagedResponse>

provisionAccountTicket(ProvisionAccountTicketRequest request)

public final ProvisionAccountTicketResponse provisionAccountTicket(ProvisionAccountTicketRequest request)

Requests a ticket for creating an account.

Sample code:

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

Parameter

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

Returns

Type	Description
ProvisionAccountTicketResponse

provisionAccountTicketCallable()

public final UnaryCallable<ProvisionAccountTicketRequest,ProvisionAccountTicketResponse> provisionAccountTicketCallable()

Requests a ticket for creating an account.

Sample code:

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

Returns

Type	Description
UnaryCallable<ProvisionAccountTicketRequest,ProvisionAccountTicketResponse>

runAccessReport(RunAccessReportRequest request)

public final RunAccessReportResponse runAccessReport(RunAccessReportRequest request)

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

Data Access Reports can be requested for a property. The property must be in Google Analytics 360. This method is only available to Administrators.

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

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   RunAccessReportRequest request =
       RunAccessReportRequest.newBuilder()
           .setEntity("entity-1298275357")
           .addAllDimensions(new ArrayList<AccessDimension>())
           .addAllMetrics(new ArrayList<AccessMetric>())
           .addAllDateRanges(new ArrayList<AccessDateRange>())
           .setDimensionFilter(AccessFilterExpression.newBuilder().build())
           .setMetricFilter(AccessFilterExpression.newBuilder().build())
           .setOffset(-1019779949)
           .setLimit(102976443)
           .setTimeZone("timeZone-2077180903")
           .addAllOrderBys(new ArrayList<AccessOrderBy>())
           .setReturnEntityQuota(true)
           .build();
   RunAccessReportResponse response = analyticsAdminServiceClient.runAccessReport(request);
 }
 

Parameter

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

Returns

Type	Description
RunAccessReportResponse

runAccessReportCallable()

public final UnaryCallable<RunAccessReportRequest,RunAccessReportResponse> runAccessReportCallable()

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

Data Access Reports can be requested for a property. The property must be in Google Analytics 360. This method is only available to Administrators.

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

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   RunAccessReportRequest request =
       RunAccessReportRequest.newBuilder()
           .setEntity("entity-1298275357")
           .addAllDimensions(new ArrayList<AccessDimension>())
           .addAllMetrics(new ArrayList<AccessMetric>())
           .addAllDateRanges(new ArrayList<AccessDateRange>())
           .setDimensionFilter(AccessFilterExpression.newBuilder().build())
           .setMetricFilter(AccessFilterExpression.newBuilder().build())
           .setOffset(-1019779949)
           .setLimit(102976443)
           .setTimeZone("timeZone-2077180903")
           .addAllOrderBys(new ArrayList<AccessOrderBy>())
           .setReturnEntityQuota(true)
           .build();
   ApiFuture<RunAccessReportResponse> future =
       analyticsAdminServiceClient.runAccessReportCallable().futureCall(request);
   // Do something.
   RunAccessReportResponse response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<RunAccessReportRequest,RunAccessReportResponse>

searchChangeHistoryEvents(SearchChangeHistoryEventsRequest request)

public final AnalyticsAdminServiceClient.SearchChangeHistoryEventsPagedResponse searchChangeHistoryEvents(SearchChangeHistoryEventsRequest request)

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

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   SearchChangeHistoryEventsRequest request =
       SearchChangeHistoryEventsRequest.newBuilder()
           .setAccount(AccountName.of("[ACCOUNT]").toString())
           .setProperty(PropertyName.of("[PROPERTY]").toString())
           .addAllResourceType(new ArrayList<ChangeHistoryResourceType>())
           .addAllAction(new ArrayList<ActionType>())
           .addAllActorEmail(new ArrayList<String>())
           .setEarliestChangeTime(Timestamp.newBuilder().build())
           .setLatestChangeTime(Timestamp.newBuilder().build())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (ChangeHistoryEvent element :
       analyticsAdminServiceClient.searchChangeHistoryEvents(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

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

Returns

Type	Description
AnalyticsAdminServiceClient.SearchChangeHistoryEventsPagedResponse

searchChangeHistoryEventsCallable()

public final UnaryCallable<SearchChangeHistoryEventsRequest,SearchChangeHistoryEventsResponse> searchChangeHistoryEventsCallable()

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

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   SearchChangeHistoryEventsRequest request =
       SearchChangeHistoryEventsRequest.newBuilder()
           .setAccount(AccountName.of("[ACCOUNT]").toString())
           .setProperty(PropertyName.of("[PROPERTY]").toString())
           .addAllResourceType(new ArrayList<ChangeHistoryResourceType>())
           .addAllAction(new ArrayList<ActionType>())
           .addAllActorEmail(new ArrayList<String>())
           .setEarliestChangeTime(Timestamp.newBuilder().build())
           .setLatestChangeTime(Timestamp.newBuilder().build())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     SearchChangeHistoryEventsResponse response =
         analyticsAdminServiceClient.searchChangeHistoryEventsCallable().call(request);
     for (ChangeHistoryEvent element : response.getChangeHistoryEventsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<SearchChangeHistoryEventsRequest,SearchChangeHistoryEventsResponse>

searchChangeHistoryEventsPagedCallable()

public final UnaryCallable<SearchChangeHistoryEventsRequest,AnalyticsAdminServiceClient.SearchChangeHistoryEventsPagedResponse> searchChangeHistoryEventsPagedCallable()

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

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
     AnalyticsAdminServiceClient.create()) {
   SearchChangeHistoryEventsRequest request =
       SearchChangeHistoryEventsRequest.newBuilder()
           .setAccount(AccountName.of("[ACCOUNT]").toString())
           .setProperty(PropertyName.of("[PROPERTY]").toString())
           .addAllResourceType(new ArrayList<ChangeHistoryResourceType>())
           .addAllAction(new ArrayList<ActionType>())
           .addAllActorEmail(new ArrayList<String>())
           .setEarliestChangeTime(Timestamp.newBuilder().build())
           .setLatestChangeTime(Timestamp.newBuilder().build())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<ChangeHistoryEvent> future =
       analyticsAdminServiceClient.searchChangeHistoryEventsPagedCallable().futureCall(request);
   // Do something.
   for (ChangeHistoryEvent element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns

Type	Description
UnaryCallable<SearchChangeHistoryEventsRequest,SearchChangeHistoryEventsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateAccount(Account account, FieldMask updateMask)

public final Account updateAccount(Account account, FieldMask updateMask)

Updates an account.

Sample code:

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

Parameters

Name	Description
account	Account Required. The account to update. The account's name field is used to identify the account.
updateMask	FieldMask Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Returns

Type	Description
Account

updateAccount(UpdateAccountRequest request)

public final Account updateAccount(UpdateAccountRequest request)

Updates an account.

Sample code:

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

Parameter

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

Returns

Type	Description
Account

updateAccountCallable()

public final UnaryCallable<UpdateAccountRequest,Account> updateAccountCallable()

Updates an account.

Sample code:

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

Returns

Type	Description
UnaryCallable<UpdateAccountRequest,Account>

updateAttributionSettings(AttributionSettings attributionSettings, FieldMask updateMask)

public final AttributionSettings updateAttributionSettings(AttributionSettings attributionSettings, FieldMask updateMask)

Updates attribution settings on a property.

Sample code:

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

Parameters

Name	Description
attributionSettings	AttributionSettings Required. The attribution settings to update. The name field is used to identify the settings to be updated.
updateMask	FieldMask Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Returns

Type	Description
AttributionSettings

updateAttributionSettings(UpdateAttributionSettingsRequest request)

public final AttributionSettings updateAttributionSettings(UpdateAttributionSettingsRequest request)

Updates attribution settings on a property.

Sample code:

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

Parameter

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

Returns

Type	Description
AttributionSettings

updateAttributionSettingsCallable()

public final UnaryCallable<UpdateAttributionSettingsRequest,AttributionSettings> updateAttributionSettingsCallable()

Updates attribution settings on a property.

Sample code:

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

Returns

Type	Description
UnaryCallable<UpdateAttributionSettingsRequest,AttributionSettings>

updateAudience(Audience audience, FieldMask updateMask)

public final Audience updateAudience(Audience audience, FieldMask updateMask)

Updates an Audience on a property.

Sample code:

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

Parameters

Name	Description
audience	Audience Required. The audience to update. The audience's name field is used to identify the audience to be updated.
updateMask	FieldMask Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Returns

Type	Description
Audience

updateAudience(UpdateAudienceRequest request)

public final Audience updateAudience(UpdateAudienceRequest request)

Updates an Audience on a property.

Sample code:

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

Parameter

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

Returns

Type	Description
Audience

updateAudienceCallable()

public final UnaryCallable<UpdateAudienceRequest,Audience> updateAudienceCallable()

Updates an Audience on a property.

Sample code:

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

Returns

Type	Description
UnaryCallable<UpdateAudienceRequest,Audience>

updateCustomDimension(CustomDimension customDimension, FieldMask updateMask)

public final CustomDimension updateCustomDimension(CustomDimension customDimension, FieldMask updateMask)

Updates a CustomDimension on a property.

Sample code:

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

Parameters

Name	Description
customDimension	CustomDimension The CustomDimension to update
updateMask	FieldMask Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Returns

Type	Description
CustomDimension

updateCustomDimension(UpdateCustomDimensionRequest request)

public final CustomDimension updateCustomDimension(UpdateCustomDimensionRequest request)

Updates a CustomDimension on a property.

Sample code:

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

Parameter

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

Returns

Type	Description
CustomDimension

updateCustomDimensionCallable()

public final UnaryCallable<UpdateCustomDimensionRequest,CustomDimension> updateCustomDimensionCallable()

Updates a CustomDimension on a property.

Sample code:

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

Returns

Type	Description
UnaryCallable<UpdateCustomDimensionRequest,CustomDimension>

updateCustomMetric(CustomMetric customMetric, FieldMask updateMask)

public final CustomMetric updateCustomMetric(CustomMetric customMetric, FieldMask updateMask)

Updates a CustomMetric on a property.

Sample code:

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

Parameters

Name	Description
customMetric	CustomMetric The CustomMetric to update
updateMask	FieldMask Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Returns

Type	Description
CustomMetric

updateCustomMetric(UpdateCustomMetricRequest request)

public final CustomMetric updateCustomMetric(UpdateCustomMetricRequest request)

Updates a CustomMetric on a property.

Sample code:

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

Parameter

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

Returns

Type	Description
CustomMetric

updateCustomMetricCallable()

public final UnaryCallable<UpdateCustomMetricRequest,CustomMetric> updateCustomMetricCallable()

Updates a CustomMetric on a property.

Sample code:

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

Returns

Type	Description
UnaryCallable<UpdateCustomMetricRequest,CustomMetric>

updateDataRetentionSettings(DataRetentionSettings dataRetentionSettings, FieldMask updateMask)

public final DataRetentionSettings updateDataRetentionSettings(DataRetentionSettings dataRetentionSettings, FieldMask updateMask)

Updates the singleton data retention settings for this property.

Sample code:

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

Parameters

Name	Description
dataRetentionSettings	DataRetentionSettings Required. The settings to update. The name field is used to identify the settings to be updated.
updateMask	FieldMask Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Returns

Type	Description
DataRetentionSettings

updateDataRetentionSettings(UpdateDataRetentionSettingsRequest request)

public final DataRetentionSettings updateDataRetentionSettings(UpdateDataRetentionSettingsRequest request)

Updates the singleton data retention settings for this property.

Sample code:

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

Parameter

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

Returns

Type	Description
DataRetentionSettings

updateDataRetentionSettingsCallable()

public final UnaryCallable<UpdateDataRetentionSettingsRequest,DataRetentionSettings> updateDataRetentionSettingsCallable()

Updates the singleton data retention settings for this property.

Sample code:

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

Returns

Type	Description
UnaryCallable<UpdateDataRetentionSettingsRequest,DataRetentionSettings>

updateDataStream(DataStream dataStream, FieldMask updateMask)

public final DataStream updateDataStream(DataStream dataStream, FieldMask updateMask)

Updates a DataStream on a property.

Sample code:

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

Parameters

Name	Description
dataStream	DataStream The DataStream to update
updateMask	FieldMask Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Returns

Type	Description
DataStream

updateDataStream(UpdateDataStreamRequest request)

public final DataStream updateDataStream(UpdateDataStreamRequest request)

Updates a DataStream on a property.

Sample code:

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

Parameter

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

Returns

Type	Description
DataStream

updateDataStreamCallable()

public final UnaryCallable<UpdateDataStreamRequest,DataStream> updateDataStreamCallable()

Updates a DataStream on a property.

Sample code:

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

Returns

Type	Description
UnaryCallable<UpdateDataStreamRequest,DataStream>

updateDisplayVideo360AdvertiserLink(DisplayVideo360AdvertiserLink displayVideo360AdvertiserLink, FieldMask updateMask)

public final DisplayVideo360AdvertiserLink updateDisplayVideo360AdvertiserLink(DisplayVideo360AdvertiserLink displayVideo360AdvertiserLink, FieldMask updateMask)

Updates a DisplayVideo360AdvertiserLink on a property.

Sample code:

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

Parameters

Name	Description
displayVideo360AdvertiserLink	DisplayVideo360AdvertiserLink The DisplayVideo360AdvertiserLink to update
updateMask	FieldMask Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Returns

Type	Description
DisplayVideo360AdvertiserLink

updateDisplayVideo360AdvertiserLink(UpdateDisplayVideo360AdvertiserLinkRequest request)

public final DisplayVideo360AdvertiserLink updateDisplayVideo360AdvertiserLink(UpdateDisplayVideo360AdvertiserLinkRequest request)

Updates a DisplayVideo360AdvertiserLink on a property.

Sample code:

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

Parameter

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

Returns

Type	Description
DisplayVideo360AdvertiserLink

updateDisplayVideo360AdvertiserLinkCallable()

public final UnaryCallable<UpdateDisplayVideo360AdvertiserLinkRequest,DisplayVideo360AdvertiserLink> updateDisplayVideo360AdvertiserLinkCallable()

Updates a DisplayVideo360AdvertiserLink on a property.

Sample code:

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

Returns

Type	Description
UnaryCallable<UpdateDisplayVideo360AdvertiserLinkRequest,DisplayVideo360AdvertiserLink>

updateGoogleAdsLink(GoogleAdsLink googleAdsLink, FieldMask updateMask)

public final GoogleAdsLink updateGoogleAdsLink(GoogleAdsLink googleAdsLink, FieldMask updateMask)

Updates a GoogleAdsLink on a property

Sample code:

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

Parameters

Name	Description
googleAdsLink	GoogleAdsLink The GoogleAdsLink to update
updateMask	FieldMask Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Returns

Type	Description
GoogleAdsLink

updateGoogleAdsLink(UpdateGoogleAdsLinkRequest request)

public final GoogleAdsLink updateGoogleAdsLink(UpdateGoogleAdsLinkRequest request)

Updates a GoogleAdsLink on a property

Sample code:

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

Parameter

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

Returns

Type	Description
GoogleAdsLink

updateGoogleAdsLinkCallable()

public final UnaryCallable<UpdateGoogleAdsLinkRequest,GoogleAdsLink> updateGoogleAdsLinkCallable()

Updates a GoogleAdsLink on a property

Sample code:

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

Returns

Type	Description
UnaryCallable<UpdateGoogleAdsLinkRequest,GoogleAdsLink>

updateGoogleSignalsSettings(GoogleSignalsSettings googleSignalsSettings, FieldMask updateMask)

public final GoogleSignalsSettings updateGoogleSignalsSettings(GoogleSignalsSettings googleSignalsSettings, FieldMask updateMask)

Updates Google Signals settings for a property.

Sample code:

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

Parameters

Name	Description
googleSignalsSettings	GoogleSignalsSettings Required. The settings to update. The name field is used to identify the settings to be updated.
updateMask	FieldMask Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Returns

Type	Description
GoogleSignalsSettings

updateGoogleSignalsSettings(UpdateGoogleSignalsSettingsRequest request)

public final GoogleSignalsSettings updateGoogleSignalsSettings(UpdateGoogleSignalsSettingsRequest request)

Updates Google Signals settings for a property.

Sample code:

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

Parameter

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

Returns

Type	Description
GoogleSignalsSettings

updateGoogleSignalsSettingsCallable()

public final UnaryCallable<UpdateGoogleSignalsSettingsRequest,GoogleSignalsSettings> updateGoogleSignalsSettingsCallable()

Updates Google Signals settings for a property.

Sample code:

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

Returns

Type	Description
UnaryCallable<UpdateGoogleSignalsSettingsRequest,GoogleSignalsSettings>

updateMeasurementProtocolSecret(MeasurementProtocolSecret measurementProtocolSecret, FieldMask updateMask)

public final MeasurementProtocolSecret updateMeasurementProtocolSecret(MeasurementProtocolSecret measurementProtocolSecret, FieldMask updateMask)

Updates a measurement protocol secret.

Sample code:

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

Parameters

Name	Description
measurementProtocolSecret	MeasurementProtocolSecret Required. The measurement protocol secret to update.
updateMask	FieldMask The list of fields to be updated. Omitted fields will not be updated.

Returns

Type	Description
MeasurementProtocolSecret

updateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest request)

public final MeasurementProtocolSecret updateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest request)

Updates a measurement protocol secret.

Sample code:

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

Parameter

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

Returns

Type	Description
MeasurementProtocolSecret

updateMeasurementProtocolSecretCallable()

public final UnaryCallable<UpdateMeasurementProtocolSecretRequest,MeasurementProtocolSecret> updateMeasurementProtocolSecretCallable()

Updates a measurement protocol secret.

Sample code:

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

Returns

Type	Description
UnaryCallable<UpdateMeasurementProtocolSecretRequest,MeasurementProtocolSecret>

updateProperty(Property property, FieldMask updateMask)

public final Property updateProperty(Property property, FieldMask updateMask)

Updates a property.

Sample code:

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

Parameters

Name	Description
property	Property Required. The property to update. The property's name field is used to identify the property to be updated.
updateMask	FieldMask Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Returns

Type	Description
Property

updateProperty(UpdatePropertyRequest request)

public final Property updateProperty(UpdatePropertyRequest request)

Updates a property.

Sample code:

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

Parameter

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

Returns

Type	Description
Property

updatePropertyCallable()

public final UnaryCallable<UpdatePropertyRequest,Property> updatePropertyCallable()

Updates a property.

Sample code:

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

Returns

Type	Description
UnaryCallable<UpdatePropertyRequest,Property>

updateUserLink(UpdateUserLinkRequest request)

public final UserLink updateUserLink(UpdateUserLinkRequest request)

Updates a user link on an account or property.

Sample code:

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

Parameter

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

Returns

Type	Description
UserLink

updateUserLink(UserLink userLink)

public final UserLink updateUserLink(UserLink userLink)

Updates a user link on an account or property.

Sample code:

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

Parameter

Name	Description
userLink	UserLink Required. The user link to update.

Returns

Type	Description
UserLink

updateUserLinkCallable()

public final UnaryCallable<UpdateUserLinkRequest,UserLink> updateUserLinkCallable()

Updates a user link on an account or property.

Sample code:

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

Returns

Type	Description
UnaryCallable<UpdateUserLinkRequest,UserLink>