Package com.google.ads.googleads.v18.services

Class CustomerManagerLinkServiceClient

java.lang.Object
com.google.ads.googleads.v18.services.CustomerManagerLinkServiceClient
All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource, AutoCloseable
@Generated("by gapic-generator-java") public class CustomerManagerLinkServiceClient extends Object implements com.google.api.gax.core.BackgroundResource
Service Description: Service to manage customer-manager links.

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 (CustomerManagerLinkServiceClient customerManagerLinkServiceClient =
     CustomerManagerLinkServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<CustomerManagerLinkOperation> operations = new ArrayList<>();
   MutateCustomerManagerLinkResponse response =
       customerManagerLinkServiceClient.mutateCustomerManagerLink(customerId, operations);
 }

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

Methods
Method Description Method Variants

MutateCustomerManagerLink

Updates customer manager links. Operation statuses are returned.

List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [FieldMaskError]() [HeaderError]() [InternalError]() [ManagerLinkError]() [MutateError]() [QuotaError]() [RequestError]()

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • mutateCustomerManagerLink(MutateCustomerManagerLinkRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • mutateCustomerManagerLink(String customerId, List<CustomerManagerLinkOperation> operations)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • mutateCustomerManagerLinkCallable()

MoveManagerLink

Moves a client customer to a new manager customer. This simplifies the complex request that requires two operations to move a client customer to a new manager, for example: 1. Update operation with Status INACTIVE (previous manager) and, 2. Update operation with Status ACTIVE (new manager).

List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]()

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • moveManagerLink(MoveManagerLinkRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • moveManagerLink(String customerId, String previousCustomerManagerLink, String newManager)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • moveManagerLinkCallable()

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 CustomerManagerLinkServiceSettings 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
 CustomerManagerLinkServiceSettings customerManagerLinkServiceSettings =
     CustomerManagerLinkServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CustomerManagerLinkServiceClient customerManagerLinkServiceClient =
     CustomerManagerLinkServiceClient.create(customerManagerLinkServiceSettings);

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
 CustomerManagerLinkServiceSettings customerManagerLinkServiceSettings =
     CustomerManagerLinkServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 CustomerManagerLinkServiceClient customerManagerLinkServiceClient =
     CustomerManagerLinkServiceClient.create(customerManagerLinkServiceSettings);

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

  • Constructor Details

    • CustomerManagerLinkServiceClient

      protected CustomerManagerLinkServiceClient(CustomerManagerLinkServiceSettings settings) throws IOException
      Constructs an instance of CustomerManagerLinkServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
      Throws:
      IOException

    • CustomerManagerLinkServiceClient

      protected CustomerManagerLinkServiceClient(CustomerManagerLinkServiceStub stub)

  • Method Details

    • create

      public static final CustomerManagerLinkServiceClient create() throws IOException
      Constructs an instance of CustomerManagerLinkServiceClient with default settings.
      Throws:
      IOException

    • create

      public static final CustomerManagerLinkServiceClient create(CustomerManagerLinkServiceSettings settings) throws IOException
      Constructs an instance of CustomerManagerLinkServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
      Throws:
      IOException

    • create

      public static final CustomerManagerLinkServiceClient create(CustomerManagerLinkServiceStub stub)
      Constructs an instance of CustomerManagerLinkServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(CustomerManagerLinkServiceSettings).

    • getSettings

      public final CustomerManagerLinkServiceSettings getSettings()

    • getStub

      public CustomerManagerLinkServiceStub getStub()

    • mutateCustomerManagerLink

      public final MutateCustomerManagerLinkResponse mutateCustomerManagerLink(String customerId, List<CustomerManagerLinkOperation> operations)
      Updates customer manager links. Operation statuses are returned.

      List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [FieldMaskError]() [HeaderError]() [InternalError]() [ManagerLinkError]() [MutateError]() [QuotaError]() [RequestError]()

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CustomerManagerLinkServiceClient customerManagerLinkServiceClient =
     CustomerManagerLinkServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<CustomerManagerLinkOperation> operations = new ArrayList<>();
   MutateCustomerManagerLinkResponse response =
       customerManagerLinkServiceClient.mutateCustomerManagerLink(customerId, operations);
 }
      Parameters:
      customerId - Required. The ID of the customer whose customer manager links are being modified.
      operations - Required. The list of operations to perform on individual customer manager links.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails

    • mutateCustomerManagerLink

      public final MutateCustomerManagerLinkResponse mutateCustomerManagerLink(MutateCustomerManagerLinkRequest request)
      Updates customer manager links. Operation statuses are returned.

      List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [FieldMaskError]() [HeaderError]() [InternalError]() [ManagerLinkError]() [MutateError]() [QuotaError]() [RequestError]()

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CustomerManagerLinkServiceClient customerManagerLinkServiceClient =
     CustomerManagerLinkServiceClient.create()) {
   MutateCustomerManagerLinkRequest request =
       MutateCustomerManagerLinkRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<CustomerManagerLinkOperation>())
           .setValidateOnly(true)
           .build();
   MutateCustomerManagerLinkResponse response =
       customerManagerLinkServiceClient.mutateCustomerManagerLink(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails

    • mutateCustomerManagerLinkCallable

      public final com.google.api.gax.rpc.UnaryCallable<MutateCustomerManagerLinkRequest,MutateCustomerManagerLinkResponse> mutateCustomerManagerLinkCallable()
      Updates customer manager links. Operation statuses are returned.

      List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [FieldMaskError]() [HeaderError]() [InternalError]() [ManagerLinkError]() [MutateError]() [QuotaError]() [RequestError]()

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CustomerManagerLinkServiceClient customerManagerLinkServiceClient =
     CustomerManagerLinkServiceClient.create()) {
   MutateCustomerManagerLinkRequest request =
       MutateCustomerManagerLinkRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<CustomerManagerLinkOperation>())
           .setValidateOnly(true)
           .build();
   ApiFuture<MutateCustomerManagerLinkResponse> future =
       customerManagerLinkServiceClient.mutateCustomerManagerLinkCallable().futureCall(request);
   // Do something.
   MutateCustomerManagerLinkResponse response = future.get();
 }

    • moveManagerLink

      public final MoveManagerLinkResponse moveManagerLink(String customerId, String previousCustomerManagerLink, String newManager)
      Moves a client customer to a new manager customer. This simplifies the complex request that requires two operations to move a client customer to a new manager, for example: 1. Update operation with Status INACTIVE (previous manager) and, 2. Update operation with Status ACTIVE (new manager).

      List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]()

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CustomerManagerLinkServiceClient customerManagerLinkServiceClient =
     CustomerManagerLinkServiceClient.create()) {
   String customerId = "customerId-1581184615";
   String previousCustomerManagerLink = "previousCustomerManagerLink-222598638";
   String newManager = "newManager1429989869";
   MoveManagerLinkResponse response =
       customerManagerLinkServiceClient.moveManagerLink(
           customerId, previousCustomerManagerLink, newManager);
 }
      Parameters:
      customerId - Required. The ID of the client customer that is being moved.
      previousCustomerManagerLink - Required. The resource name of the previous CustomerManagerLink. The resource name has the form: `customers/{customer_id}/customerManagerLinks/{manager_customer_id}~{manager_link_id}`
      newManager - Required. The resource name of the new manager customer that the client wants to move to. Customer resource names have the format: "customers/{customer_id}"
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails

    • moveManagerLink

      public final MoveManagerLinkResponse moveManagerLink(MoveManagerLinkRequest request)
      Moves a client customer to a new manager customer. This simplifies the complex request that requires two operations to move a client customer to a new manager, for example: 1. Update operation with Status INACTIVE (previous manager) and, 2. Update operation with Status ACTIVE (new manager).

      List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]()

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CustomerManagerLinkServiceClient customerManagerLinkServiceClient =
     CustomerManagerLinkServiceClient.create()) {
   MoveManagerLinkRequest request =
       MoveManagerLinkRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setPreviousCustomerManagerLink("previousCustomerManagerLink-222598638")
           .setNewManager("newManager1429989869")
           .setValidateOnly(true)
           .build();
   MoveManagerLinkResponse response = customerManagerLinkServiceClient.moveManagerLink(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails

    • moveManagerLinkCallable

      public final com.google.api.gax.rpc.UnaryCallable<MoveManagerLinkRequest,MoveManagerLinkResponse> moveManagerLinkCallable()
      Moves a client customer to a new manager customer. This simplifies the complex request that requires two operations to move a client customer to a new manager, for example: 1. Update operation with Status INACTIVE (previous manager) and, 2. Update operation with Status ACTIVE (new manager).

      List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [QuotaError]() [RequestError]()

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CustomerManagerLinkServiceClient customerManagerLinkServiceClient =
     CustomerManagerLinkServiceClient.create()) {
   MoveManagerLinkRequest request =
       MoveManagerLinkRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setPreviousCustomerManagerLink("previousCustomerManagerLink-222598638")
           .setNewManager("newManager1429989869")
           .setValidateOnly(true)
           .build();
   ApiFuture<MoveManagerLinkResponse> future =
       customerManagerLinkServiceClient.moveManagerLinkCallable().futureCall(request);
   // Do something.
   MoveManagerLinkResponse response = future.get();
 }

    • close

      public final void close()
      Specified by:
      close in interface AutoCloseable

    • shutdown

      public void shutdown()
      Specified by:
      shutdown in interface com.google.api.gax.core.BackgroundResource

    • isShutdown

      public boolean isShutdown()
      Specified by:
      isShutdown in interface com.google.api.gax.core.BackgroundResource

    • isTerminated

      public boolean isTerminated()
      Specified by:
      isTerminated in interface com.google.api.gax.core.BackgroundResource

    • shutdownNow

      public void shutdownNow()
      Specified by:
      shutdownNow in interface com.google.api.gax.core.BackgroundResource

    • awaitTermination

      public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
      Specified by:
      awaitTermination in interface com.google.api.gax.core.BackgroundResource
      Throws:
      InterruptedException