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

Class CustomAudienceServiceClient

java.lang.Object

com.google.ads.googleads.v10.services.CustomAudienceServiceClient

All Implemented Interfaces:

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

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

Service Description: Service to manage custom audiences.

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 (CustomAudienceServiceClient customAudienceServiceClient =
     CustomAudienceServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<CustomAudienceOperation> operations = new ArrayList<>();
   MutateCustomAudiencesResponse response =
       customAudienceServiceClient.mutateCustomAudiences(customerId, operations);
 }
 

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

To customize credentials:

 CustomAudienceServiceSettings customAudienceServiceSettings =
     CustomAudienceServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CustomAudienceServiceClient customAudienceServiceClient =
     CustomAudienceServiceClient.create(customAudienceServiceSettings);
 

To customize the endpoint:

 CustomAudienceServiceSettings customAudienceServiceSettings =
     CustomAudienceServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 CustomAudienceServiceClient customAudienceServiceClient =
     CustomAudienceServiceClient.create(customAudienceServiceSettings);
 

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CustomAudienceServiceClient(CustomAudienceServiceSettings settings)	Constructs an instance of CustomAudienceServiceClient, using the given settings.
protected	CustomAudienceServiceClient(CustomAudienceServiceStub stub)

Method Summary

Modifier and Type	Method	Description
boolean	awaitTermination(long duration, java.util.concurrent.TimeUnit unit)
void	close()
static CustomAudienceServiceClient	create()	Constructs an instance of CustomAudienceServiceClient with default settings.
static CustomAudienceServiceClient	create(CustomAudienceServiceSettings settings)	Constructs an instance of CustomAudienceServiceClient, using the given settings.
static CustomAudienceServiceClient	create(CustomAudienceServiceStub stub)	Constructs an instance of CustomAudienceServiceClient, using the given stub for making calls.
CustomAudienceServiceSettings	getSettings()
CustomAudienceServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
MutateCustomAudiencesResponse	mutateCustomAudiences(MutateCustomAudiencesRequest request)	Creates or updates custom audiences.
MutateCustomAudiencesResponse	mutateCustomAudiences(java.lang.String customerId, java.util.List<CustomAudienceOperation> operations)	Creates or updates custom audiences.
com.google.api.gax.rpc.UnaryCallable<MutateCustomAudiencesRequest,MutateCustomAudiencesResponse>	mutateCustomAudiencesCallable()	Creates or updates custom audiences.
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomAudienceServiceClient

protected CustomAudienceServiceClient(CustomAudienceServiceSettings settings)
                               throws java.io.IOException

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

CustomAudienceServiceClient

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

Method Detail

create

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

Constructs an instance of CustomAudienceServiceClient with default settings.

Throws:

java.io.IOException

create

public static final CustomAudienceServiceClient create(CustomAudienceServiceSettings settings)
                                                throws java.io.IOException

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

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

getSettings

public final CustomAudienceServiceSettings getSettings()

getStub

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

mutateCustomAudiences

public final MutateCustomAudiencesResponse mutateCustomAudiences(java.lang.String customerId,
                                                                 java.util.List<CustomAudienceOperation> operations)

Creates or updates custom audiences. Operation statuses are returned.

List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CustomAudienceError]() [CustomInterestError]() [FieldError]() [FieldMaskError]() [HeaderError]() [InternalError]() [MutateError]() [OperationAccessDeniedError]() [PolicyViolationError]() [QuotaError]() [RequestError]()

Sample code:

 try (CustomAudienceServiceClient customAudienceServiceClient =
     CustomAudienceServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<CustomAudienceOperation> operations = new ArrayList<>();
   MutateCustomAudiencesResponse response =
       customAudienceServiceClient.mutateCustomAudiences(customerId, operations);
 }
 

Parameters:

customerId - Required. The ID of the customer whose custom audiences are being modified.

operations - Required. The list of operations to perform on individual custom audiences.

Throws:

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

mutateCustomAudiences

public final MutateCustomAudiencesResponse mutateCustomAudiences(MutateCustomAudiencesRequest request)

Creates or updates custom audiences. Operation statuses are returned.

List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CustomAudienceError]() [CustomInterestError]() [FieldError]() [FieldMaskError]() [HeaderError]() [InternalError]() [MutateError]() [OperationAccessDeniedError]() [PolicyViolationError]() [QuotaError]() [RequestError]()

Sample code:

 try (CustomAudienceServiceClient customAudienceServiceClient =
     CustomAudienceServiceClient.create()) {
   MutateCustomAudiencesRequest request =
       MutateCustomAudiencesRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<CustomAudienceOperation>())
           .setValidateOnly(true)
           .build();
   MutateCustomAudiencesResponse response =
       customAudienceServiceClient.mutateCustomAudiences(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

mutateCustomAudiencesCallable

public final com.google.api.gax.rpc.UnaryCallable<MutateCustomAudiencesRequest,MutateCustomAudiencesResponse> mutateCustomAudiencesCallable()

Creates or updates custom audiences. Operation statuses are returned.

List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CustomAudienceError]() [CustomInterestError]() [FieldError]() [FieldMaskError]() [HeaderError]() [InternalError]() [MutateError]() [OperationAccessDeniedError]() [PolicyViolationError]() [QuotaError]() [RequestError]()

Sample code:

 try (CustomAudienceServiceClient customAudienceServiceClient =
     CustomAudienceServiceClient.create()) {
   MutateCustomAudiencesRequest request =
       MutateCustomAudiencesRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<CustomAudienceOperation>())
           .setValidateOnly(true)
           .build();
   ApiFuture<MutateCustomAudiencesResponse> future =
       customAudienceServiceClient.mutateCustomAudiencesCallable().futureCall(request);
   // Do something.
   MutateCustomAudiencesResponse 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