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

Class CustomerLabelServiceClient

java.lang.Object

com.google.ads.googleads.v10.services.CustomerLabelServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, java.lang.AutoCloseable

@Generated("by gapic-generator-java")
public class CustomerLabelServiceClient
extends java.lang.Object
implements com.google.api.gax.core.BackgroundResource

Service Description: Service to manage labels on 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:

 try (CustomerLabelServiceClient customerLabelServiceClient =
     CustomerLabelServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<CustomerLabelOperation> operations = new ArrayList<>();
   MutateCustomerLabelsResponse response =
       customerLabelServiceClient.mutateCustomerLabels(customerId, operations);
 }
 

Note: close() needs to be called on the CustomerLabelServiceClient 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 CustomerLabelServiceSettings to create(). For example:

To customize credentials:

 CustomerLabelServiceSettings customerLabelServiceSettings =
     CustomerLabelServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CustomerLabelServiceClient customerLabelServiceClient =
     CustomerLabelServiceClient.create(customerLabelServiceSettings);
 

To customize the endpoint:

 CustomerLabelServiceSettings customerLabelServiceSettings =
     CustomerLabelServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 CustomerLabelServiceClient customerLabelServiceClient =
     CustomerLabelServiceClient.create(customerLabelServiceSettings);
 

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CustomerLabelServiceClient(CustomerLabelServiceSettings settings)	Constructs an instance of CustomerLabelServiceClient, using the given settings.
protected	CustomerLabelServiceClient(CustomerLabelServiceStub stub)

Method Summary

Modifier and Type	Method	Description
boolean	awaitTermination(long duration, java.util.concurrent.TimeUnit unit)
void	close()
static CustomerLabelServiceClient	create()	Constructs an instance of CustomerLabelServiceClient with default settings.
static CustomerLabelServiceClient	create(CustomerLabelServiceSettings settings)	Constructs an instance of CustomerLabelServiceClient, using the given settings.
static CustomerLabelServiceClient	create(CustomerLabelServiceStub stub)	Constructs an instance of CustomerLabelServiceClient, using the given stub for making calls.
CustomerLabelServiceSettings	getSettings()
CustomerLabelServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
MutateCustomerLabelsResponse	mutateCustomerLabels(MutateCustomerLabelsRequest request)	Creates and removes customer-label relationships.
MutateCustomerLabelsResponse	mutateCustomerLabels(java.lang.String customerId, java.util.List<CustomerLabelOperation> operations)	Creates and removes customer-label relationships.
com.google.api.gax.rpc.UnaryCallable<MutateCustomerLabelsRequest,MutateCustomerLabelsResponse>	mutateCustomerLabelsCallable()	Creates and removes customer-label relationships.
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CustomerLabelServiceClient

protected CustomerLabelServiceClient(CustomerLabelServiceSettings settings)
                              throws java.io.IOException

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

CustomerLabelServiceClient

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

Method Detail

create

public static final CustomerLabelServiceClient create()
                                               throws java.io.IOException

Constructs an instance of CustomerLabelServiceClient with default settings.

Throws:

java.io.IOException

create

public static final CustomerLabelServiceClient create(CustomerLabelServiceSettings settings)
                                               throws java.io.IOException

Constructs an instance of CustomerLabelServiceClient, 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 CustomerLabelServiceClient create(CustomerLabelServiceStub stub)

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

getSettings

public final CustomerLabelServiceSettings getSettings()

getStub

@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public CustomerLabelServiceStub getStub()

mutateCustomerLabels

public final MutateCustomerLabelsResponse mutateCustomerLabels(java.lang.String customerId,
                                                               java.util.List<CustomerLabelOperation> operations)

Creates and removes customer-label relationships. Operation statuses are returned.

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

Sample code:

 try (CustomerLabelServiceClient customerLabelServiceClient =
     CustomerLabelServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<CustomerLabelOperation> operations = new ArrayList<>();
   MutateCustomerLabelsResponse response =
       customerLabelServiceClient.mutateCustomerLabels(customerId, operations);
 }
 

Parameters:

customerId - Required. ID of the customer whose customer-label relationships are being modified.

operations - Required. The list of operations to perform on customer-label relationships.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

mutateCustomerLabels

public final MutateCustomerLabelsResponse mutateCustomerLabels(MutateCustomerLabelsRequest request)

Creates and removes customer-label relationships. Operation statuses are returned.

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

Sample code:

 try (CustomerLabelServiceClient customerLabelServiceClient =
     CustomerLabelServiceClient.create()) {
   MutateCustomerLabelsRequest request =
       MutateCustomerLabelsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<CustomerLabelOperation>())
           .setPartialFailure(true)
           .setValidateOnly(true)
           .build();
   MutateCustomerLabelsResponse response =
       customerLabelServiceClient.mutateCustomerLabels(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

mutateCustomerLabelsCallable

public final com.google.api.gax.rpc.UnaryCallable<MutateCustomerLabelsRequest,MutateCustomerLabelsResponse> mutateCustomerLabelsCallable()

Creates and removes customer-label relationships. Operation statuses are returned.

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

Sample code:

 try (CustomerLabelServiceClient customerLabelServiceClient =
     CustomerLabelServiceClient.create()) {
   MutateCustomerLabelsRequest request =
       MutateCustomerLabelsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<CustomerLabelOperation>())
           .setPartialFailure(true)
           .setValidateOnly(true)
           .build();
   ApiFuture<MutateCustomerLabelsResponse> future =
       customerLabelServiceClient.mutateCustomerLabelsCallable().futureCall(request);
   // Do something.
   MutateCustomerLabelsResponse 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