Package com.google.ads.googleads.v15.services

Class CustomerServiceClient

  • All Implemented Interfaces:
    com.google.api.gax.core.BackgroundResource, java.lang.AutoCloseable
    @Generated("by gapic-generator-java")
public class CustomerServiceClient
extends java.lang.Object
implements com.google.api.gax.core.BackgroundResource
    Service Description: Service to manage customers.

    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 (CustomerServiceClient customerServiceClient = CustomerServiceClient.create()) {
   String customerId = "customerId-1581184615";
   CustomerOperation operation = CustomerOperation.newBuilder().build();
   MutateCustomerResponse response = customerServiceClient.mutateCustomer(customerId, operation);
 }

    Note: close() needs to be called on the CustomerServiceClient 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

    MutateCustomer

    Updates a customer. Operation statuses are returned.

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

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

    • mutateCustomer(MutateCustomerRequest request)

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

    • mutateCustomer(String customerId, CustomerOperation operation)

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

    • mutateCustomerCallable()

    ListAccessibleCustomers

    Returns resource names of customers directly accessible by the user authenticating the call.

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

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

    • listAccessibleCustomers(ListAccessibleCustomersRequest request)

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

    • listAccessibleCustomersCallable()

    CreateCustomerClient

    Creates a new client under manager. The new client customer is returned.

    List of thrown errors: [AccessInvitationError]() [AuthenticationError]() [AuthorizationError]() [CurrencyCodeError]() [HeaderError]() [InternalError]() [ManagerLinkError]() [QuotaError]() [RequestError]() [StringLengthError]() [TimeZoneError]()

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

    • createCustomerClient(CreateCustomerClientRequest request)

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

    • createCustomerClient(String customerId, Customer customerClient)

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

    • createCustomerClientCallable()

    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 CustomerServiceSettings 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
 CustomerServiceSettings customerServiceSettings =
     CustomerServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CustomerServiceClient customerServiceClient =
     CustomerServiceClient.create(customerServiceSettings);

    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
 CustomerServiceSettings customerServiceSettings =
     CustomerServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 CustomerServiceClient customerServiceClient =
     CustomerServiceClient.create(customerServiceSettings);

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

    • Constructor Detail

      • CustomerServiceClient

        protected CustomerServiceClient​(CustomerServiceSettings settings)
                         throws java.io.IOException
        Constructs an instance of CustomerServiceClient, 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

    • Method Detail

      • create

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

      • create

        public static final CustomerServiceClient create​(CustomerServiceSettings settings)
                                          throws java.io.IOException
        Constructs an instance of CustomerServiceClient, 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

        public static final CustomerServiceClient create​(CustomerServiceStub stub)
        Constructs an instance of CustomerServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(CustomerServiceSettings).

      • mutateCustomer

        public final MutateCustomerResponse mutateCustomer​(java.lang.String customerId,
                                                   CustomerOperation operation)
        Updates a customer. Operation statuses are returned.

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

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CustomerServiceClient customerServiceClient = CustomerServiceClient.create()) {
   String customerId = "customerId-1581184615";
   CustomerOperation operation = CustomerOperation.newBuilder().build();
   MutateCustomerResponse response = customerServiceClient.mutateCustomer(customerId, operation);
 }
        Parameters:
        customerId - Required. The ID of the customer being modified.
        operation - Required. The operation to perform on the customer
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • mutateCustomer

        public final MutateCustomerResponse mutateCustomer​(MutateCustomerRequest request)
        Updates a customer. Operation statuses are returned.

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

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CustomerServiceClient customerServiceClient = CustomerServiceClient.create()) {
   MutateCustomerRequest request =
       MutateCustomerRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setOperation(CustomerOperation.newBuilder().build())
           .setValidateOnly(true)
           .build();
   MutateCustomerResponse response = customerServiceClient.mutateCustomer(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

      • mutateCustomerCallable

        public final com.google.api.gax.rpc.UnaryCallable<MutateCustomerRequest,​MutateCustomerResponse> mutateCustomerCallable()
        Updates a customer. Operation statuses are returned.

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

        Sample code: 

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

      • listAccessibleCustomers

        public final ListAccessibleCustomersResponse listAccessibleCustomers​(ListAccessibleCustomersRequest request)
        Returns resource names of customers directly accessible by the user authenticating the call.

        List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [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 (CustomerServiceClient customerServiceClient = CustomerServiceClient.create()) {
   ListAccessibleCustomersRequest request = ListAccessibleCustomersRequest.newBuilder().build();
   ListAccessibleCustomersResponse response =
       customerServiceClient.listAccessibleCustomers(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

      • listAccessibleCustomersCallable

        public final com.google.api.gax.rpc.UnaryCallable<ListAccessibleCustomersRequest,​ListAccessibleCustomersResponse> listAccessibleCustomersCallable()
        Returns resource names of customers directly accessible by the user authenticating the call.

        List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [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 (CustomerServiceClient customerServiceClient = CustomerServiceClient.create()) {
   ListAccessibleCustomersRequest request = ListAccessibleCustomersRequest.newBuilder().build();
   ApiFuture<ListAccessibleCustomersResponse> future =
       customerServiceClient.listAccessibleCustomersCallable().futureCall(request);
   // Do something.
   ListAccessibleCustomersResponse response = future.get();
 }

      • createCustomerClient

        public final CreateCustomerClientResponse createCustomerClient​(java.lang.String customerId,
                                                               Customer customerClient)
        Creates a new client under manager. The new client customer is returned.

        List of thrown errors: [AccessInvitationError]() [AuthenticationError]() [AuthorizationError]() [CurrencyCodeError]() [HeaderError]() [InternalError]() [ManagerLinkError]() [QuotaError]() [RequestError]() [StringLengthError]() [TimeZoneError]()

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CustomerServiceClient customerServiceClient = CustomerServiceClient.create()) {
   String customerId = "customerId-1581184615";
   Customer customerClient = Customer.newBuilder().build();
   CreateCustomerClientResponse response =
       customerServiceClient.createCustomerClient(customerId, customerClient);
 }
        Parameters:
        customerId - Required. The ID of the Manager under whom client customer is being created.
        customerClient - Required. The new client customer to create. The resource name on this customer will be ignored.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • createCustomerClient

        public final CreateCustomerClientResponse createCustomerClient​(CreateCustomerClientRequest request)
        Creates a new client under manager. The new client customer is returned.

        List of thrown errors: [AccessInvitationError]() [AuthenticationError]() [AuthorizationError]() [CurrencyCodeError]() [HeaderError]() [InternalError]() [ManagerLinkError]() [QuotaError]() [RequestError]() [StringLengthError]() [TimeZoneError]()

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CustomerServiceClient customerServiceClient = CustomerServiceClient.create()) {
   CreateCustomerClientRequest request =
       CreateCustomerClientRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setCustomerClient(Customer.newBuilder().build())
           .setEmailAddress("emailAddress-1070931784")
           .setValidateOnly(true)
           .build();
   CreateCustomerClientResponse response = customerServiceClient.createCustomerClient(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

      • createCustomerClientCallable

        public final com.google.api.gax.rpc.UnaryCallable<CreateCustomerClientRequest,​CreateCustomerClientResponse> createCustomerClientCallable()
        Creates a new client under manager. The new client customer is returned.

        List of thrown errors: [AccessInvitationError]() [AuthenticationError]() [AuthorizationError]() [CurrencyCodeError]() [HeaderError]() [InternalError]() [ManagerLinkError]() [QuotaError]() [RequestError]() [StringLengthError]() [TimeZoneError]()

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CustomerServiceClient customerServiceClient = CustomerServiceClient.create()) {
   CreateCustomerClientRequest request =
       CreateCustomerClientRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setCustomerClient(Customer.newBuilder().build())
           .setEmailAddress("emailAddress-1070931784")
           .setValidateOnly(true)
           .build();
   ApiFuture<CreateCustomerClientResponse> future =
       customerServiceClient.createCustomerClientCallable().futureCall(request);
   // Do something.
   CreateCustomerClientResponse 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