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

Class CampaignBudgetServiceClient

java.lang.Object

com.google.ads.googleads.v10.services.CampaignBudgetServiceClient

All Implemented Interfaces:

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

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

Service Description: Service to manage campaign budgets.

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 (CampaignBudgetServiceClient campaignBudgetServiceClient =
     CampaignBudgetServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<CampaignBudgetOperation> operations = new ArrayList<>();
   MutateCampaignBudgetsResponse response =
       campaignBudgetServiceClient.mutateCampaignBudgets(customerId, operations);
 }
 

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

To customize credentials:

 CampaignBudgetServiceSettings campaignBudgetServiceSettings =
     CampaignBudgetServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CampaignBudgetServiceClient campaignBudgetServiceClient =
     CampaignBudgetServiceClient.create(campaignBudgetServiceSettings);
 

To customize the endpoint:

 CampaignBudgetServiceSettings campaignBudgetServiceSettings =
     CampaignBudgetServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 CampaignBudgetServiceClient campaignBudgetServiceClient =
     CampaignBudgetServiceClient.create(campaignBudgetServiceSettings);
 

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CampaignBudgetServiceClient(CampaignBudgetServiceSettings settings)	Constructs an instance of CampaignBudgetServiceClient, using the given settings.
protected	CampaignBudgetServiceClient(CampaignBudgetServiceStub stub)

Method Summary

Modifier and Type	Method	Description
boolean	awaitTermination(long duration, java.util.concurrent.TimeUnit unit)
void	close()
static CampaignBudgetServiceClient	create()	Constructs an instance of CampaignBudgetServiceClient with default settings.
static CampaignBudgetServiceClient	create(CampaignBudgetServiceSettings settings)	Constructs an instance of CampaignBudgetServiceClient, using the given settings.
static CampaignBudgetServiceClient	create(CampaignBudgetServiceStub stub)	Constructs an instance of CampaignBudgetServiceClient, using the given stub for making calls.
CampaignBudgetServiceSettings	getSettings()
CampaignBudgetServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
MutateCampaignBudgetsResponse	mutateCampaignBudgets(MutateCampaignBudgetsRequest request)	Creates, updates, or removes campaign budgets.
MutateCampaignBudgetsResponse	mutateCampaignBudgets(java.lang.String customerId, java.util.List<CampaignBudgetOperation> operations)	Creates, updates, or removes campaign budgets.
com.google.api.gax.rpc.UnaryCallable<MutateCampaignBudgetsRequest,MutateCampaignBudgetsResponse>	mutateCampaignBudgetsCallable()	Creates, updates, or removes campaign budgets.
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

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

Constructor Detail

CampaignBudgetServiceClient

protected CampaignBudgetServiceClient(CampaignBudgetServiceSettings settings)
                               throws java.io.IOException

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

CampaignBudgetServiceClient

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

Method Detail

create

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

Constructs an instance of CampaignBudgetServiceClient with default settings.

Throws:

java.io.IOException

create

public static final CampaignBudgetServiceClient create(CampaignBudgetServiceSettings settings)
                                                throws java.io.IOException

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

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

getSettings

public final CampaignBudgetServiceSettings getSettings()

getStub

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

mutateCampaignBudgets

public final MutateCampaignBudgetsResponse mutateCampaignBudgets(java.lang.String customerId,
                                                                 java.util.List<CampaignBudgetOperation> operations)

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

List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CampaignBudgetError]() [DatabaseError]() [DistinctError]() [FieldError]() [FieldMaskError]() [HeaderError]() [InternalError]() [MutateError]() [NewResourceCreationError]() [OperationAccessDeniedError]() [QuotaError]() [RangeError]() [RequestError]() [ResourceCountLimitExceededError]() [StringLengthError]()

Sample code:

 try (CampaignBudgetServiceClient campaignBudgetServiceClient =
     CampaignBudgetServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<CampaignBudgetOperation> operations = new ArrayList<>();
   MutateCampaignBudgetsResponse response =
       campaignBudgetServiceClient.mutateCampaignBudgets(customerId, operations);
 }
 

Parameters:

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

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

Throws:

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

mutateCampaignBudgets

public final MutateCampaignBudgetsResponse mutateCampaignBudgets(MutateCampaignBudgetsRequest request)

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

List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CampaignBudgetError]() [DatabaseError]() [DistinctError]() [FieldError]() [FieldMaskError]() [HeaderError]() [InternalError]() [MutateError]() [NewResourceCreationError]() [OperationAccessDeniedError]() [QuotaError]() [RangeError]() [RequestError]() [ResourceCountLimitExceededError]() [StringLengthError]()

Sample code:

 try (CampaignBudgetServiceClient campaignBudgetServiceClient =
     CampaignBudgetServiceClient.create()) {
   MutateCampaignBudgetsRequest request =
       MutateCampaignBudgetsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<CampaignBudgetOperation>())
           .setPartialFailure(true)
           .setValidateOnly(true)
           .build();
   MutateCampaignBudgetsResponse response =
       campaignBudgetServiceClient.mutateCampaignBudgets(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

mutateCampaignBudgetsCallable

public final com.google.api.gax.rpc.UnaryCallable<MutateCampaignBudgetsRequest,MutateCampaignBudgetsResponse> mutateCampaignBudgetsCallable()

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

List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CampaignBudgetError]() [DatabaseError]() [DistinctError]() [FieldError]() [FieldMaskError]() [HeaderError]() [InternalError]() [MutateError]() [NewResourceCreationError]() [OperationAccessDeniedError]() [QuotaError]() [RangeError]() [RequestError]() [ResourceCountLimitExceededError]() [StringLengthError]()

Sample code:

 try (CampaignBudgetServiceClient campaignBudgetServiceClient =
     CampaignBudgetServiceClient.create()) {
   MutateCampaignBudgetsRequest request =
       MutateCampaignBudgetsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<CampaignBudgetOperation>())
           .setPartialFailure(true)
           .setValidateOnly(true)
           .build();
   ApiFuture<MutateCampaignBudgetsResponse> future =
       campaignBudgetServiceClient.mutateCampaignBudgetsCallable().futureCall(request);
   // Do something.
   MutateCampaignBudgetsResponse 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