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

Class CampaignAssetServiceClient

java.lang.Object

com.google.ads.googleads.v10.services.CampaignAssetServiceClient

All Implemented Interfaces:

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

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

Service Description: Service to manage campaign assets.

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 (CampaignAssetServiceClient campaignAssetServiceClient =
     CampaignAssetServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<CampaignAssetOperation> operations = new ArrayList<>();
   MutateCampaignAssetsResponse response =
       campaignAssetServiceClient.mutateCampaignAssets(customerId, operations);
 }
 

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

To customize credentials:

 CampaignAssetServiceSettings campaignAssetServiceSettings =
     CampaignAssetServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CampaignAssetServiceClient campaignAssetServiceClient =
     CampaignAssetServiceClient.create(campaignAssetServiceSettings);
 

To customize the endpoint:

 CampaignAssetServiceSettings campaignAssetServiceSettings =
     CampaignAssetServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 CampaignAssetServiceClient campaignAssetServiceClient =
     CampaignAssetServiceClient.create(campaignAssetServiceSettings);
 

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CampaignAssetServiceClient(CampaignAssetServiceSettings settings)	Constructs an instance of CampaignAssetServiceClient, using the given settings.
protected	CampaignAssetServiceClient(CampaignAssetServiceStub stub)

Method Summary

Modifier and Type	Method	Description
boolean	awaitTermination(long duration, java.util.concurrent.TimeUnit unit)
void	close()
static CampaignAssetServiceClient	create()	Constructs an instance of CampaignAssetServiceClient with default settings.
static CampaignAssetServiceClient	create(CampaignAssetServiceSettings settings)	Constructs an instance of CampaignAssetServiceClient, using the given settings.
static CampaignAssetServiceClient	create(CampaignAssetServiceStub stub)	Constructs an instance of CampaignAssetServiceClient, using the given stub for making calls.
CampaignAssetServiceSettings	getSettings()
CampaignAssetServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
MutateCampaignAssetsResponse	mutateCampaignAssets(MutateCampaignAssetsRequest request)	Creates, updates, or removes campaign assets.
MutateCampaignAssetsResponse	mutateCampaignAssets(java.lang.String customerId, java.util.List<CampaignAssetOperation> operations)	Creates, updates, or removes campaign assets.
com.google.api.gax.rpc.UnaryCallable<MutateCampaignAssetsRequest,MutateCampaignAssetsResponse>	mutateCampaignAssetsCallable()	Creates, updates, or removes campaign assets.
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

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

Constructor Detail

CampaignAssetServiceClient

protected CampaignAssetServiceClient(CampaignAssetServiceSettings settings)
                              throws java.io.IOException

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

CampaignAssetServiceClient

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

Method Detail

create

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

Constructs an instance of CampaignAssetServiceClient with default settings.

Throws:

java.io.IOException

create

public static final CampaignAssetServiceClient create(CampaignAssetServiceSettings settings)
                                               throws java.io.IOException

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

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

getSettings

public final CampaignAssetServiceSettings getSettings()

getStub

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

mutateCampaignAssets

public final MutateCampaignAssetsResponse mutateCampaignAssets(java.lang.String customerId,
                                                               java.util.List<CampaignAssetOperation> operations)

Creates, updates, or removes campaign assets. Operation statuses are returned.

List of thrown errors: [AssetLinkError]() [AuthenticationError]() [AuthorizationError]() [ContextError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [NotAllowlistedError]() [QuotaError]() [RequestError]()

Sample code:

 try (CampaignAssetServiceClient campaignAssetServiceClient =
     CampaignAssetServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<CampaignAssetOperation> operations = new ArrayList<>();
   MutateCampaignAssetsResponse response =
       campaignAssetServiceClient.mutateCampaignAssets(customerId, operations);
 }
 

Parameters:

customerId - Required. The ID of the customer whose campaign assets are being modified.

operations - Required. The list of operations to perform on individual campaign assets.

Throws:

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

mutateCampaignAssets

public final MutateCampaignAssetsResponse mutateCampaignAssets(MutateCampaignAssetsRequest request)

Creates, updates, or removes campaign assets. Operation statuses are returned.

List of thrown errors: [AssetLinkError]() [AuthenticationError]() [AuthorizationError]() [ContextError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [NotAllowlistedError]() [QuotaError]() [RequestError]()

Sample code:

 try (CampaignAssetServiceClient campaignAssetServiceClient =
     CampaignAssetServiceClient.create()) {
   MutateCampaignAssetsRequest request =
       MutateCampaignAssetsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<CampaignAssetOperation>())
           .setPartialFailure(true)
           .setValidateOnly(true)
           .build();
   MutateCampaignAssetsResponse response =
       campaignAssetServiceClient.mutateCampaignAssets(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

mutateCampaignAssetsCallable

public final com.google.api.gax.rpc.UnaryCallable<MutateCampaignAssetsRequest,MutateCampaignAssetsResponse> mutateCampaignAssetsCallable()

Creates, updates, or removes campaign assets. Operation statuses are returned.

List of thrown errors: [AssetLinkError]() [AuthenticationError]() [AuthorizationError]() [ContextError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [MutateError]() [NotAllowlistedError]() [QuotaError]() [RequestError]()

Sample code:

 try (CampaignAssetServiceClient campaignAssetServiceClient =
     CampaignAssetServiceClient.create()) {
   MutateCampaignAssetsRequest request =
       MutateCampaignAssetsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<CampaignAssetOperation>())
           .setPartialFailure(true)
           .setValidateOnly(true)
           .build();
   ApiFuture<MutateCampaignAssetsResponse> future =
       campaignAssetServiceClient.mutateCampaignAssetsCallable().futureCall(request);
   // Do something.
   MutateCampaignAssetsResponse 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