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

Class SharedCriterionServiceClient

java.lang.Object

com.google.ads.googleads.v10.services.SharedCriterionServiceClient

All Implemented Interfaces:

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

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

Service Description: Service to manage shared criteria.

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 (SharedCriterionServiceClient sharedCriterionServiceClient =
     SharedCriterionServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<SharedCriterionOperation> operations = new ArrayList<>();
   MutateSharedCriteriaResponse response =
       sharedCriterionServiceClient.mutateSharedCriteria(customerId, operations);
 }
 

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

To customize credentials:

 SharedCriterionServiceSettings sharedCriterionServiceSettings =
     SharedCriterionServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SharedCriterionServiceClient sharedCriterionServiceClient =
     SharedCriterionServiceClient.create(sharedCriterionServiceSettings);
 

To customize the endpoint:

 SharedCriterionServiceSettings sharedCriterionServiceSettings =
     SharedCriterionServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 SharedCriterionServiceClient sharedCriterionServiceClient =
     SharedCriterionServiceClient.create(sharedCriterionServiceSettings);
 

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SharedCriterionServiceClient(SharedCriterionServiceSettings settings)	Constructs an instance of SharedCriterionServiceClient, using the given settings.
protected	SharedCriterionServiceClient(SharedCriterionServiceStub stub)

Method Summary

Modifier and Type	Method	Description
boolean	awaitTermination(long duration, java.util.concurrent.TimeUnit unit)
void	close()
static SharedCriterionServiceClient	create()	Constructs an instance of SharedCriterionServiceClient with default settings.
static SharedCriterionServiceClient	create(SharedCriterionServiceSettings settings)	Constructs an instance of SharedCriterionServiceClient, using the given settings.
static SharedCriterionServiceClient	create(SharedCriterionServiceStub stub)	Constructs an instance of SharedCriterionServiceClient, using the given stub for making calls.
SharedCriterionServiceSettings	getSettings()
SharedCriterionServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
MutateSharedCriteriaResponse	mutateSharedCriteria(MutateSharedCriteriaRequest request)	Creates or removes shared criteria.
MutateSharedCriteriaResponse	mutateSharedCriteria(java.lang.String customerId, java.util.List<SharedCriterionOperation> operations)	Creates or removes shared criteria.
com.google.api.gax.rpc.UnaryCallable<MutateSharedCriteriaRequest,MutateSharedCriteriaResponse>	mutateSharedCriteriaCallable()	Creates or removes shared criteria.
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

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

Constructor Detail

SharedCriterionServiceClient

protected SharedCriterionServiceClient(SharedCriterionServiceSettings settings)
                                throws java.io.IOException

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

SharedCriterionServiceClient

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

Method Detail

create

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

Constructs an instance of SharedCriterionServiceClient with default settings.

Throws:

java.io.IOException

create

public static final SharedCriterionServiceClient create(SharedCriterionServiceSettings settings)
                                                 throws java.io.IOException

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

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

getSettings

public final SharedCriterionServiceSettings getSettings()

getStub

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

mutateSharedCriteria

public final MutateSharedCriteriaResponse mutateSharedCriteria(java.lang.String customerId,
                                                               java.util.List<SharedCriterionOperation> operations)

Creates or removes shared criteria. Operation statuses are returned.

List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CriterionError]() [DatabaseError]() [DistinctError]() [FieldError]() [HeaderError]() [IdError]() [InternalError]() [MutateError]() [NotEmptyError]() [NullError]() [OperatorError]() [QuotaError]() [RangeError]() [RequestError]() [ResourceCountLimitExceededError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]()

Sample code:

 try (SharedCriterionServiceClient sharedCriterionServiceClient =
     SharedCriterionServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<SharedCriterionOperation> operations = new ArrayList<>();
   MutateSharedCriteriaResponse response =
       sharedCriterionServiceClient.mutateSharedCriteria(customerId, operations);
 }
 

Parameters:

customerId - Required. The ID of the customer whose shared criteria are being modified.

operations - Required. The list of operations to perform on individual shared criteria.

Throws:

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

mutateSharedCriteria

public final MutateSharedCriteriaResponse mutateSharedCriteria(MutateSharedCriteriaRequest request)

Creates or removes shared criteria. Operation statuses are returned.

List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CriterionError]() [DatabaseError]() [DistinctError]() [FieldError]() [HeaderError]() [IdError]() [InternalError]() [MutateError]() [NotEmptyError]() [NullError]() [OperatorError]() [QuotaError]() [RangeError]() [RequestError]() [ResourceCountLimitExceededError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]()

Sample code:

 try (SharedCriterionServiceClient sharedCriterionServiceClient =
     SharedCriterionServiceClient.create()) {
   MutateSharedCriteriaRequest request =
       MutateSharedCriteriaRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<SharedCriterionOperation>())
           .setPartialFailure(true)
           .setValidateOnly(true)
           .build();
   MutateSharedCriteriaResponse response =
       sharedCriterionServiceClient.mutateSharedCriteria(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

mutateSharedCriteriaCallable

public final com.google.api.gax.rpc.UnaryCallable<MutateSharedCriteriaRequest,MutateSharedCriteriaResponse> mutateSharedCriteriaCallable()

Creates or removes shared criteria. Operation statuses are returned.

List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CriterionError]() [DatabaseError]() [DistinctError]() [FieldError]() [HeaderError]() [IdError]() [InternalError]() [MutateError]() [NotEmptyError]() [NullError]() [OperatorError]() [QuotaError]() [RangeError]() [RequestError]() [ResourceCountLimitExceededError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]()

Sample code:

 try (SharedCriterionServiceClient sharedCriterionServiceClient =
     SharedCriterionServiceClient.create()) {
   MutateSharedCriteriaRequest request =
       MutateSharedCriteriaRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<SharedCriterionOperation>())
           .setPartialFailure(true)
           .setValidateOnly(true)
           .build();
   ApiFuture<MutateSharedCriteriaResponse> future =
       sharedCriterionServiceClient.mutateSharedCriteriaCallable().futureCall(request);
   // Do something.
   MutateSharedCriteriaResponse 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