Package com.google.ads.googleads.v10.services

Class CustomerManagerLinkServiceClient

  • All Implemented Interfaces:
    com.google.api.gax.core.BackgroundResource, java.lang.AutoCloseable
    @Generated("by gapic-generator-java")
public class CustomerManagerLinkServiceClient
extends java.lang.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: 

    
 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().

    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 CustomerManagerLinkServiceSettings to create(). For example:

    To customize credentials: 

    
 CustomerManagerLinkServiceSettings customerManagerLinkServiceSettings =
     CustomerManagerLinkServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CustomerManagerLinkServiceClient customerManagerLinkServiceClient =
     CustomerManagerLinkServiceClient.create(customerManagerLinkServiceSettings);

    To customize the endpoint: 

    
 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 Detail

      • CustomerManagerLinkServiceClient

        protected CustomerManagerLinkServiceClient​(CustomerManagerLinkServiceSettings settings)
                                    throws java.io.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:
        java.io.IOException

      • CustomerManagerLinkServiceClient

        @BetaApi("A restructuring of stub classes is planned, so this may break in the future")
protected CustomerManagerLinkServiceClient​(CustomerManagerLinkServiceStub stub)

    • Method Detail

      • create

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

      • create

        public static final CustomerManagerLinkServiceClient create​(CustomerManagerLinkServiceSettings settings)
                                                     throws java.io.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:
        java.io.IOException

      • create

        @BetaApi("A restructuring of stub classes is planned, so this may break in the future")
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).

      • mutateCustomerManagerLink

        public final MutateCustomerManagerLinkResponse mutateCustomerManagerLink​(java.lang.String customerId,
                                                                         java.util.List<CustomerManagerLinkOperation> operations)
        Creates or 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: 

        
 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)
        Creates or 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: 

        
 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()
        Creates or 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: 

        
 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​(java.lang.String customerId,
                                                     java.lang.String previousCustomerManagerLink,
                                                     java.lang.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. i.e: 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: 

        
 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. i.e: 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: 

        
 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. i.e: 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: 

        
 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 java.lang.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,
                                java.util.concurrent.TimeUnit unit)
                         throws java.lang.InterruptedException
        Specified by:
        awaitTermination in interface com.google.api.gax.core.BackgroundResource
        Throws:
        java.lang.InterruptedException