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

Class FeedItemTargetServiceClient

java.lang.Object

com.google.ads.googleads.v10.services.FeedItemTargetServiceClient

All Implemented Interfaces:

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

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

Service Description: Service to manage feed item targets.

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 (FeedItemTargetServiceClient feedItemTargetServiceClient =
     FeedItemTargetServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<FeedItemTargetOperation> operations = new ArrayList<>();
   MutateFeedItemTargetsResponse response =
       feedItemTargetServiceClient.mutateFeedItemTargets(customerId, operations);
 }
 

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

To customize credentials:

 FeedItemTargetServiceSettings feedItemTargetServiceSettings =
     FeedItemTargetServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 FeedItemTargetServiceClient feedItemTargetServiceClient =
     FeedItemTargetServiceClient.create(feedItemTargetServiceSettings);
 

To customize the endpoint:

 FeedItemTargetServiceSettings feedItemTargetServiceSettings =
     FeedItemTargetServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 FeedItemTargetServiceClient feedItemTargetServiceClient =
     FeedItemTargetServiceClient.create(feedItemTargetServiceSettings);
 

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FeedItemTargetServiceClient(FeedItemTargetServiceSettings settings)	Constructs an instance of FeedItemTargetServiceClient, using the given settings.
protected	FeedItemTargetServiceClient(FeedItemTargetServiceStub stub)

Method Summary

Modifier and Type	Method	Description
boolean	awaitTermination(long duration, java.util.concurrent.TimeUnit unit)
void	close()
static FeedItemTargetServiceClient	create()	Constructs an instance of FeedItemTargetServiceClient with default settings.
static FeedItemTargetServiceClient	create(FeedItemTargetServiceSettings settings)	Constructs an instance of FeedItemTargetServiceClient, using the given settings.
static FeedItemTargetServiceClient	create(FeedItemTargetServiceStub stub)	Constructs an instance of FeedItemTargetServiceClient, using the given stub for making calls.
FeedItemTargetServiceSettings	getSettings()
FeedItemTargetServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
MutateFeedItemTargetsResponse	mutateFeedItemTargets(MutateFeedItemTargetsRequest request)	Creates or removes feed item targets.
MutateFeedItemTargetsResponse	mutateFeedItemTargets(java.lang.String customerId, java.util.List<FeedItemTargetOperation> operations)	Creates or removes feed item targets.
com.google.api.gax.rpc.UnaryCallable<MutateFeedItemTargetsRequest,MutateFeedItemTargetsResponse>	mutateFeedItemTargetsCallable()	Creates or removes feed item targets.
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

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

Constructor Detail

FeedItemTargetServiceClient

protected FeedItemTargetServiceClient(FeedItemTargetServiceSettings settings)
                               throws java.io.IOException

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

FeedItemTargetServiceClient

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

Method Detail

create

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

Constructs an instance of FeedItemTargetServiceClient with default settings.

Throws:

java.io.IOException

create

public static final FeedItemTargetServiceClient create(FeedItemTargetServiceSettings settings)
                                                throws java.io.IOException

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

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

getSettings

public final FeedItemTargetServiceSettings getSettings()

getStub

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

mutateFeedItemTargets

public final MutateFeedItemTargetsResponse mutateFeedItemTargets(java.lang.String customerId,
                                                                 java.util.List<FeedItemTargetOperation> operations)

Creates or removes feed item targets. Operation statuses are returned.

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

Sample code:

 try (FeedItemTargetServiceClient feedItemTargetServiceClient =
     FeedItemTargetServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<FeedItemTargetOperation> operations = new ArrayList<>();
   MutateFeedItemTargetsResponse response =
       feedItemTargetServiceClient.mutateFeedItemTargets(customerId, operations);
 }
 

Parameters:

customerId - Required. The ID of the customer whose feed item targets are being modified.

operations - Required. The list of operations to perform on individual feed item targets.

Throws:

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

mutateFeedItemTargets

public final MutateFeedItemTargetsResponse mutateFeedItemTargets(MutateFeedItemTargetsRequest request)

Creates or removes feed item targets. Operation statuses are returned.

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

Sample code:

 try (FeedItemTargetServiceClient feedItemTargetServiceClient =
     FeedItemTargetServiceClient.create()) {
   MutateFeedItemTargetsRequest request =
       MutateFeedItemTargetsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<FeedItemTargetOperation>())
           .setPartialFailure(true)
           .setValidateOnly(true)
           .build();
   MutateFeedItemTargetsResponse response =
       feedItemTargetServiceClient.mutateFeedItemTargets(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

mutateFeedItemTargetsCallable

public final com.google.api.gax.rpc.UnaryCallable<MutateFeedItemTargetsRequest,MutateFeedItemTargetsResponse> mutateFeedItemTargetsCallable()

Creates or removes feed item targets. Operation statuses are returned.

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

Sample code:

 try (FeedItemTargetServiceClient feedItemTargetServiceClient =
     FeedItemTargetServiceClient.create()) {
   MutateFeedItemTargetsRequest request =
       MutateFeedItemTargetsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<FeedItemTargetOperation>())
           .setPartialFailure(true)
           .setValidateOnly(true)
           .build();
   ApiFuture<MutateFeedItemTargetsResponse> future =
       feedItemTargetServiceClient.mutateFeedItemTargetsCallable().futureCall(request);
   // Do something.
   MutateFeedItemTargetsResponse 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