Class CampaignFeedServiceClient
- java.lang.Object
-
- com.google.ads.googleads.v10.services.CampaignFeedServiceClient
-
- All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource,java.lang.AutoCloseable
@Generated("by gapic-generator-java") public class CampaignFeedServiceClient extends java.lang.Object implements com.google.api.gax.core.BackgroundResourceService Description: Service to manage campaign feeds.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 (CampaignFeedServiceClient campaignFeedServiceClient = CampaignFeedServiceClient.create()) { String customerId = "customerId-1581184615"; List<CampaignFeedOperation> operations = new ArrayList<>(); MutateCampaignFeedsResponse response = campaignFeedServiceClient.mutateCampaignFeeds(customerId, operations); }Note: close() needs to be called on the CampaignFeedServiceClient 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:
- 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.
- 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.
- 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 CampaignFeedServiceSettings to create(). For example:
To customize credentials:
CampaignFeedServiceSettings campaignFeedServiceSettings = CampaignFeedServiceSettings.newBuilder() .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials)) .build(); CampaignFeedServiceClient campaignFeedServiceClient = CampaignFeedServiceClient.create(campaignFeedServiceSettings);To customize the endpoint:
CampaignFeedServiceSettings campaignFeedServiceSettings = CampaignFeedServiceSettings.newBuilder().setEndpoint(myEndpoint).build(); CampaignFeedServiceClient campaignFeedServiceClient = CampaignFeedServiceClient.create(campaignFeedServiceSettings);Please refer to the GitHub repository's samples for more quickstart code snippets.
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedCampaignFeedServiceClient(CampaignFeedServiceSettings settings)Constructs an instance of CampaignFeedServiceClient, using the given settings.protectedCampaignFeedServiceClient(CampaignFeedServiceStub stub)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanawaitTermination(long duration, java.util.concurrent.TimeUnit unit)voidclose()static CampaignFeedServiceClientcreate()Constructs an instance of CampaignFeedServiceClient with default settings.static CampaignFeedServiceClientcreate(CampaignFeedServiceSettings settings)Constructs an instance of CampaignFeedServiceClient, using the given settings.static CampaignFeedServiceClientcreate(CampaignFeedServiceStub stub)Constructs an instance of CampaignFeedServiceClient, using the given stub for making calls.CampaignFeedServiceSettingsgetSettings()CampaignFeedServiceStubgetStub()booleanisShutdown()booleanisTerminated()MutateCampaignFeedsResponsemutateCampaignFeeds(MutateCampaignFeedsRequest request)Creates, updates, or removes campaign feeds.MutateCampaignFeedsResponsemutateCampaignFeeds(java.lang.String customerId, java.util.List<CampaignFeedOperation> operations)Creates, updates, or removes campaign feeds.com.google.api.gax.rpc.UnaryCallable<MutateCampaignFeedsRequest,MutateCampaignFeedsResponse>mutateCampaignFeedsCallable()Creates, updates, or removes campaign feeds.voidshutdown()voidshutdownNow()
-
-
-
Constructor Detail
-
CampaignFeedServiceClient
protected CampaignFeedServiceClient(CampaignFeedServiceSettings settings) throws java.io.IOException
Constructs an instance of CampaignFeedServiceClient, 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
-
CampaignFeedServiceClient
@BetaApi("A restructuring of stub classes is planned, so this may break in the future") protected CampaignFeedServiceClient(CampaignFeedServiceStub stub)
-
-
Method Detail
-
create
public static final CampaignFeedServiceClient create() throws java.io.IOException
Constructs an instance of CampaignFeedServiceClient with default settings.- Throws:
java.io.IOException
-
create
public static final CampaignFeedServiceClient create(CampaignFeedServiceSettings settings) throws java.io.IOException
Constructs an instance of CampaignFeedServiceClient, 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 CampaignFeedServiceClient create(CampaignFeedServiceStub stub)Constructs an instance of CampaignFeedServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(CampaignFeedServiceSettings).
-
getSettings
public final CampaignFeedServiceSettings getSettings()
-
getStub
@BetaApi("A restructuring of stub classes is planned, so this may break in the future") public CampaignFeedServiceStub getStub()
-
mutateCampaignFeeds
public final MutateCampaignFeedsResponse mutateCampaignFeeds(java.lang.String customerId, java.util.List<CampaignFeedOperation> operations)
Creates, updates, or removes campaign feeds. Operation statuses are returned.List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CampaignFeedError]() [CollectionSizeError]() [DatabaseError]() [DistinctError]() [FieldError]() [FunctionError]() [FunctionParsingError]() [HeaderError]() [IdError]() [InternalError]() [MutateError]() [NotEmptyError]() [NullError]() [OperationAccessDeniedError]() [OperatorError]() [QuotaError]() [RangeError]() [RequestError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]()
Sample code:
try (CampaignFeedServiceClient campaignFeedServiceClient = CampaignFeedServiceClient.create()) { String customerId = "customerId-1581184615"; List<CampaignFeedOperation> operations = new ArrayList<>(); MutateCampaignFeedsResponse response = campaignFeedServiceClient.mutateCampaignFeeds(customerId, operations); }- Parameters:
customerId- Required. The ID of the customer whose campaign feeds are being modified.operations- Required. The list of operations to perform on individual campaign feeds.- Throws:
com.google.api.gax.rpc.ApiException- if the remote call fails
-
mutateCampaignFeeds
public final MutateCampaignFeedsResponse mutateCampaignFeeds(MutateCampaignFeedsRequest request)
Creates, updates, or removes campaign feeds. Operation statuses are returned.List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CampaignFeedError]() [CollectionSizeError]() [DatabaseError]() [DistinctError]() [FieldError]() [FunctionError]() [FunctionParsingError]() [HeaderError]() [IdError]() [InternalError]() [MutateError]() [NotEmptyError]() [NullError]() [OperationAccessDeniedError]() [OperatorError]() [QuotaError]() [RangeError]() [RequestError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]()
Sample code:
try (CampaignFeedServiceClient campaignFeedServiceClient = CampaignFeedServiceClient.create()) { MutateCampaignFeedsRequest request = MutateCampaignFeedsRequest.newBuilder() .setCustomerId("customerId-1581184615") .addAllOperations(new ArrayList<CampaignFeedOperation>()) .setPartialFailure(true) .setValidateOnly(true) .build(); MutateCampaignFeedsResponse response = campaignFeedServiceClient.mutateCampaignFeeds(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
-
mutateCampaignFeedsCallable
public final com.google.api.gax.rpc.UnaryCallable<MutateCampaignFeedsRequest,MutateCampaignFeedsResponse> mutateCampaignFeedsCallable()
Creates, updates, or removes campaign feeds. Operation statuses are returned.List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CampaignFeedError]() [CollectionSizeError]() [DatabaseError]() [DistinctError]() [FieldError]() [FunctionError]() [FunctionParsingError]() [HeaderError]() [IdError]() [InternalError]() [MutateError]() [NotEmptyError]() [NullError]() [OperationAccessDeniedError]() [OperatorError]() [QuotaError]() [RangeError]() [RequestError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]()
Sample code:
try (CampaignFeedServiceClient campaignFeedServiceClient = CampaignFeedServiceClient.create()) { MutateCampaignFeedsRequest request = MutateCampaignFeedsRequest.newBuilder() .setCustomerId("customerId-1581184615") .addAllOperations(new ArrayList<CampaignFeedOperation>()) .setPartialFailure(true) .setValidateOnly(true) .build(); ApiFuture<MutateCampaignFeedsResponse> future = campaignFeedServiceClient.mutateCampaignFeedsCallable().futureCall(request); // Do something. MutateCampaignFeedsResponse response = future.get(); }
-
close
public final void close()
- Specified by:
closein interfacejava.lang.AutoCloseable
-
shutdown
public void shutdown()
- Specified by:
shutdownin interfacecom.google.api.gax.core.BackgroundResource
-
isShutdown
public boolean isShutdown()
- Specified by:
isShutdownin interfacecom.google.api.gax.core.BackgroundResource
-
isTerminated
public boolean isTerminated()
- Specified by:
isTerminatedin interfacecom.google.api.gax.core.BackgroundResource
-
shutdownNow
public void shutdownNow()
- Specified by:
shutdownNowin interfacecom.google.api.gax.core.BackgroundResource
-
awaitTermination
public boolean awaitTermination(long duration, java.util.concurrent.TimeUnit unit) throws java.lang.InterruptedException- Specified by:
awaitTerminationin interfacecom.google.api.gax.core.BackgroundResource- Throws:
java.lang.InterruptedException
-
-