Class AccountLabelsServiceClient (0.15.0)

Service Description: Manages Merchant Center and CSS accounts labels.

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 (AccountLabelsServiceClient accountLabelsServiceClient =
     AccountLabelsServiceClient.create()) {
   AccountName parent = AccountName.of("[ACCOUNT]");
   AccountLabel accountLabel = AccountLabel.newBuilder().build();
   AccountLabel response = accountLabelsServiceClient.createAccountLabel(parent, accountLabel);
 }
 

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

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 AccountLabelsServiceSettings 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
 AccountLabelsServiceSettings accountLabelsServiceSettings =
     AccountLabelsServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AccountLabelsServiceClient accountLabelsServiceClient =
     AccountLabelsServiceClient.create(accountLabelsServiceSettings);
 

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
 AccountLabelsServiceSettings accountLabelsServiceSettings =
     AccountLabelsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 AccountLabelsServiceClient accountLabelsServiceClient =
     AccountLabelsServiceClient.create(accountLabelsServiceSettings);
 

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
 AccountLabelsServiceSettings accountLabelsServiceSettings =
     AccountLabelsServiceSettings.newHttpJsonBuilder().build();
 AccountLabelsServiceClient accountLabelsServiceClient =
     AccountLabelsServiceClient.create(accountLabelsServiceSettings);
 

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

Constructs an instance of AccountLabelsServiceClient with default settings.

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

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

Constructs an instance of AccountLabelsServiceClient, 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.

Creates a new label, not assigned to any 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 (AccountLabelsServiceClient accountLabelsServiceClient =
     AccountLabelsServiceClient.create()) {
   AccountName parent = AccountName.of("[ACCOUNT]");
   AccountLabel accountLabel = AccountLabel.newBuilder().build();
   AccountLabel response = accountLabelsServiceClient.createAccountLabel(parent, accountLabel);
 }
 

Creates a new label, not assigned to any 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 (AccountLabelsServiceClient accountLabelsServiceClient =
     AccountLabelsServiceClient.create()) {
   CreateAccountLabelRequest request =
       CreateAccountLabelRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setAccountLabel(AccountLabel.newBuilder().build())
           .build();
   AccountLabel response = accountLabelsServiceClient.createAccountLabel(request);
 }
 

Creates a new label, not assigned to any 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 (AccountLabelsServiceClient accountLabelsServiceClient =
     AccountLabelsServiceClient.create()) {
   String parent = AccountName.of("[ACCOUNT]").toString();
   AccountLabel accountLabel = AccountLabel.newBuilder().build();
   AccountLabel response = accountLabelsServiceClient.createAccountLabel(parent, accountLabel);
 }
 

Creates a new label, not assigned to any 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 (AccountLabelsServiceClient accountLabelsServiceClient =
     AccountLabelsServiceClient.create()) {
   CreateAccountLabelRequest request =
       CreateAccountLabelRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setAccountLabel(AccountLabel.newBuilder().build())
           .build();
   ApiFuture<AccountLabel> future =
       accountLabelsServiceClient.createAccountLabelCallable().futureCall(request);
   // Do something.
   AccountLabel response = future.get();
 }
 

Deletes a label and removes it from all accounts to which it was assigned.

Sample code:

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

Deletes a label and removes it from all accounts to which it was assigned.

Sample code:

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

Deletes a label and removes it from all accounts to which it was assigned.

Sample code:

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

Deletes a label and removes it from all accounts to which it was assigned.

Sample code:

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

Lists the labels assigned to 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 (AccountLabelsServiceClient accountLabelsServiceClient =
     AccountLabelsServiceClient.create()) {
   AccountName parent = AccountName.of("[ACCOUNT]");
   for (AccountLabel element :
       accountLabelsServiceClient.listAccountLabels(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Lists the labels assigned to 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 (AccountLabelsServiceClient accountLabelsServiceClient =
     AccountLabelsServiceClient.create()) {
   ListAccountLabelsRequest request =
       ListAccountLabelsRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (AccountLabel element :
       accountLabelsServiceClient.listAccountLabels(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Lists the labels assigned to 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 (AccountLabelsServiceClient accountLabelsServiceClient =
     AccountLabelsServiceClient.create()) {
   String parent = AccountName.of("[ACCOUNT]").toString();
   for (AccountLabel element :
       accountLabelsServiceClient.listAccountLabels(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Lists the labels assigned to 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 (AccountLabelsServiceClient accountLabelsServiceClient =
     AccountLabelsServiceClient.create()) {
   ListAccountLabelsRequest request =
       ListAccountLabelsRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListAccountLabelsResponse response =
         accountLabelsServiceClient.listAccountLabelsCallable().call(request);
     for (AccountLabel element : response.getAccountLabelsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Lists the labels assigned to 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 (AccountLabelsServiceClient accountLabelsServiceClient =
     AccountLabelsServiceClient.create()) {
   ListAccountLabelsRequest request =
       ListAccountLabelsRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<AccountLabel> future =
       accountLabelsServiceClient.listAccountLabelsPagedCallable().futureCall(request);
   // Do something.
   for (AccountLabel element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Updates a label.

Sample code:

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

Updates a label.

Sample code:

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

Updates a label.

Sample code:

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