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

Class CampaignSharedSetServiceClient

java.lang.Object

com.google.ads.googleads.v10.services.CampaignSharedSetServiceClient

All Implemented Interfaces:

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

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

Service Description: Service to manage campaign shared sets.

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 (CampaignSharedSetServiceClient campaignSharedSetServiceClient =
     CampaignSharedSetServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<CampaignSharedSetOperation> operations = new ArrayList<>();
   MutateCampaignSharedSetsResponse response =
       campaignSharedSetServiceClient.mutateCampaignSharedSets(customerId, operations);
 }
 

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

To customize credentials:

 CampaignSharedSetServiceSettings campaignSharedSetServiceSettings =
     CampaignSharedSetServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CampaignSharedSetServiceClient campaignSharedSetServiceClient =
     CampaignSharedSetServiceClient.create(campaignSharedSetServiceSettings);
 

To customize the endpoint:

 CampaignSharedSetServiceSettings campaignSharedSetServiceSettings =
     CampaignSharedSetServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 CampaignSharedSetServiceClient campaignSharedSetServiceClient =
     CampaignSharedSetServiceClient.create(campaignSharedSetServiceSettings);
 

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CampaignSharedSetServiceClient(CampaignSharedSetServiceSettings settings)	Constructs an instance of CampaignSharedSetServiceClient, using the given settings.
protected	CampaignSharedSetServiceClient(CampaignSharedSetServiceStub stub)

Method Summary

Modifier and Type	Method	Description
boolean	awaitTermination(long duration, java.util.concurrent.TimeUnit unit)
void	close()
static CampaignSharedSetServiceClient	create()	Constructs an instance of CampaignSharedSetServiceClient with default settings.
static CampaignSharedSetServiceClient	create(CampaignSharedSetServiceSettings settings)	Constructs an instance of CampaignSharedSetServiceClient, using the given settings.
static CampaignSharedSetServiceClient	create(CampaignSharedSetServiceStub stub)	Constructs an instance of CampaignSharedSetServiceClient, using the given stub for making calls.
CampaignSharedSetServiceSettings	getSettings()
CampaignSharedSetServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
MutateCampaignSharedSetsResponse	mutateCampaignSharedSets(MutateCampaignSharedSetsRequest request)	Creates or removes campaign shared sets.
MutateCampaignSharedSetsResponse	mutateCampaignSharedSets(java.lang.String customerId, java.util.List<CampaignSharedSetOperation> operations)	Creates or removes campaign shared sets.
com.google.api.gax.rpc.UnaryCallable<MutateCampaignSharedSetsRequest,MutateCampaignSharedSetsResponse>	mutateCampaignSharedSetsCallable()	Creates or removes campaign shared sets.
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

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

Constructor Detail

CampaignSharedSetServiceClient

protected CampaignSharedSetServiceClient(CampaignSharedSetServiceSettings settings)
                                  throws java.io.IOException

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

CampaignSharedSetServiceClient

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

Method Detail

create

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

Constructs an instance of CampaignSharedSetServiceClient with default settings.

Throws:

java.io.IOException

create

public static final CampaignSharedSetServiceClient create(CampaignSharedSetServiceSettings settings)
                                                   throws java.io.IOException

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

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

getSettings

public final CampaignSharedSetServiceSettings getSettings()

getStub

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

mutateCampaignSharedSets

public final MutateCampaignSharedSetsResponse mutateCampaignSharedSets(java.lang.String customerId,
                                                                       java.util.List<CampaignSharedSetOperation> operations)

Creates or removes campaign shared sets. Operation statuses are returned.

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

Sample code:

 try (CampaignSharedSetServiceClient campaignSharedSetServiceClient =
     CampaignSharedSetServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<CampaignSharedSetOperation> operations = new ArrayList<>();
   MutateCampaignSharedSetsResponse response =
       campaignSharedSetServiceClient.mutateCampaignSharedSets(customerId, operations);
 }
 

Parameters:

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

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

Throws:

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

mutateCampaignSharedSets

public final MutateCampaignSharedSetsResponse mutateCampaignSharedSets(MutateCampaignSharedSetsRequest request)

Creates or removes campaign shared sets. Operation statuses are returned.

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

Sample code:

 try (CampaignSharedSetServiceClient campaignSharedSetServiceClient =
     CampaignSharedSetServiceClient.create()) {
   MutateCampaignSharedSetsRequest request =
       MutateCampaignSharedSetsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<CampaignSharedSetOperation>())
           .setPartialFailure(true)
           .setValidateOnly(true)
           .build();
   MutateCampaignSharedSetsResponse response =
       campaignSharedSetServiceClient.mutateCampaignSharedSets(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

mutateCampaignSharedSetsCallable

public final com.google.api.gax.rpc.UnaryCallable<MutateCampaignSharedSetsRequest,MutateCampaignSharedSetsResponse> mutateCampaignSharedSetsCallable()

Creates or removes campaign shared sets. Operation statuses are returned.

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

Sample code:

 try (CampaignSharedSetServiceClient campaignSharedSetServiceClient =
     CampaignSharedSetServiceClient.create()) {
   MutateCampaignSharedSetsRequest request =
       MutateCampaignSharedSetsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<CampaignSharedSetOperation>())
           .setPartialFailure(true)
           .setValidateOnly(true)
           .build();
   ApiFuture<MutateCampaignSharedSetsResponse> future =
       campaignSharedSetServiceClient.mutateCampaignSharedSetsCallable().futureCall(request);
   // Do something.
   MutateCampaignSharedSetsResponse 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