java.lang.Object
- com.google.ads.googleads.v10.services.CampaignServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, java.lang.AutoCloseable
```
@Generated("by gapic-generator-java")
public class CampaignServiceClient
extends java.lang.Object
implements com.google.api.gax.core.BackgroundResource
```
Service Description: Service to manage campaigns.
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 (CampaignServiceClient campaignServiceClient = CampaignServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<CampaignOperation> operations = new ArrayList<>();
   MutateCampaignsResponse response =
       campaignServiceClient.mutateCampaigns(customerId, operations);
 }
 
```
Note: close() needs to be called on the CampaignServiceClient 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 CampaignServiceSettings to create(). For example:
To customize credentials:
```
 CampaignServiceSettings campaignServiceSettings =
     CampaignServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CampaignServiceClient campaignServiceClient =
     CampaignServiceClient.create(campaignServiceSettings);
 
```
To customize the endpoint:
```
 CampaignServiceSettings campaignServiceSettings =
     CampaignServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 CampaignServiceClient campaignServiceClient =
     CampaignServiceClient.create(campaignServiceSettings);
 
```
Please refer to the GitHub repository's samples for more quickstart code snippets.

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`CampaignServiceClient(CampaignServiceSettings settings)`	Constructs an instance of CampaignServiceClient, using the given settings.
`protected`	`CampaignServiceClient(CampaignServiceStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`awaitTermination(long duration, java.util.concurrent.TimeUnit unit)`
`void`	`close()`
`static CampaignServiceClient`	`create()`	Constructs an instance of CampaignServiceClient with default settings.
`static CampaignServiceClient`	`create(CampaignServiceSettings settings)`	Constructs an instance of CampaignServiceClient, using the given settings.
`static CampaignServiceClient`	`create(CampaignServiceStub stub)`	Constructs an instance of CampaignServiceClient, using the given stub for making calls.
`CampaignServiceSettings`	`getSettings()`
`CampaignServiceStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`MutateCampaignsResponse`	`mutateCampaigns(MutateCampaignsRequest request)`	Creates, updates, or removes campaigns.
`MutateCampaignsResponse`	`mutateCampaigns(java.lang.String customerId, java.util.List<CampaignOperation> operations)`	Creates, updates, or removes campaigns.
`com.google.api.gax.rpc.UnaryCallable<MutateCampaignsRequest,MutateCampaignsResponse>`	`mutateCampaignsCallable()`	Creates, updates, or removes campaigns.
`void`	`shutdown()`
`void`	`shutdownNow()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CampaignServiceClient
```
protected CampaignServiceClient(CampaignServiceSettings settings)
                         throws java.io.IOException
```
    Constructs an instance of CampaignServiceClient, 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
  - CampaignServiceClient
```
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
protected CampaignServiceClient(CampaignServiceStub stub)
```
- Method Detail
  - create
```
public static final CampaignServiceClient create()
                                          throws java.io.IOException
```
    Constructs an instance of CampaignServiceClient with default settings.
    
    Throws:
    
    java.io.IOException
  - create
```
public static final CampaignServiceClient create(CampaignServiceSettings settings)
                                          throws java.io.IOException
```
    Constructs an instance of CampaignServiceClient, 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 CampaignServiceClient create(CampaignServiceStub stub)
```
    Constructs an instance of CampaignServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(CampaignServiceSettings).
  - getSettings
```
public final CampaignServiceSettings getSettings()
```
  - getStub
```
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public CampaignServiceStub getStub()
```
  - mutateCampaigns
```
public final MutateCampaignsResponse mutateCampaigns(java.lang.String customerId,
                                                     java.util.List<CampaignOperation> operations)
```
    Creates, updates, or removes campaigns. Operation statuses are returned.
    List of thrown errors: [AdxError]() [AuthenticationError]() [AuthorizationError]() [BiddingError]() [BiddingStrategyError]() [CampaignBudgetError]() [CampaignError]() [ContextError]() [DatabaseError]() [DateError]() [DateRangeError]() [DistinctError]() [FieldError]() [FieldMaskError]() [HeaderError]() [IdError]() [InternalError]() [ListOperationError]() [MutateError]() [NewResourceCreationError]() [NotAllowlistedError]() [NotEmptyError]() [NullError]() [OperationAccessDeniedError]() [OperatorError]() [QuotaError]() [RangeError]() [RegionCodeError]() [RequestError]() [ResourceCountLimitExceededError]() [SettingError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]() [UrlFieldError]()
    Sample code:
    try (CampaignServiceClient campaignServiceClient = CampaignServiceClient.create()) { String customerId = "customerId-1581184615"; List<CampaignOperation> operations = new ArrayList<>(); MutateCampaignsResponse response = campaignServiceClient.mutateCampaigns(customerId, operations); }
    Parameters:
    
    customerId - Required. The ID of the customer whose campaigns are being modified.
    
    operations - Required. The list of operations to perform on individual campaigns.
    
    Throws:
    
    com.google.api.gax.rpc.ApiException - if the remote call fails
  - mutateCampaigns
```
public final MutateCampaignsResponse mutateCampaigns(MutateCampaignsRequest request)
```
    Creates, updates, or removes campaigns. Operation statuses are returned.
    List of thrown errors: [AdxError]() [AuthenticationError]() [AuthorizationError]() [BiddingError]() [BiddingStrategyError]() [CampaignBudgetError]() [CampaignError]() [ContextError]() [DatabaseError]() [DateError]() [DateRangeError]() [DistinctError]() [FieldError]() [FieldMaskError]() [HeaderError]() [IdError]() [InternalError]() [ListOperationError]() [MutateError]() [NewResourceCreationError]() [NotAllowlistedError]() [NotEmptyError]() [NullError]() [OperationAccessDeniedError]() [OperatorError]() [QuotaError]() [RangeError]() [RegionCodeError]() [RequestError]() [ResourceCountLimitExceededError]() [SettingError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]() [UrlFieldError]()
    Sample code:
    try (CampaignServiceClient campaignServiceClient = CampaignServiceClient.create()) { MutateCampaignsRequest request = MutateCampaignsRequest.newBuilder() .setCustomerId("customerId-1581184615") .addAllOperations(new ArrayList<CampaignOperation>()) .setPartialFailure(true) .setValidateOnly(true) .build(); MutateCampaignsResponse response = campaignServiceClient.mutateCampaigns(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
  - mutateCampaignsCallable
```
public final com.google.api.gax.rpc.UnaryCallable<MutateCampaignsRequest,MutateCampaignsResponse> mutateCampaignsCallable()
```
    Creates, updates, or removes campaigns. Operation statuses are returned.
    List of thrown errors: [AdxError]() [AuthenticationError]() [AuthorizationError]() [BiddingError]() [BiddingStrategyError]() [CampaignBudgetError]() [CampaignError]() [ContextError]() [DatabaseError]() [DateError]() [DateRangeError]() [DistinctError]() [FieldError]() [FieldMaskError]() [HeaderError]() [IdError]() [InternalError]() [ListOperationError]() [MutateError]() [NewResourceCreationError]() [NotAllowlistedError]() [NotEmptyError]() [NullError]() [OperationAccessDeniedError]() [OperatorError]() [QuotaError]() [RangeError]() [RegionCodeError]() [RequestError]() [ResourceCountLimitExceededError]() [SettingError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]() [UrlFieldError]()
    Sample code:
    try (CampaignServiceClient campaignServiceClient = CampaignServiceClient.create()) { MutateCampaignsRequest request = MutateCampaignsRequest.newBuilder() .setCustomerId("customerId-1581184615") .addAllOperations(new ArrayList<CampaignOperation>()) .setPartialFailure(true) .setValidateOnly(true) .build(); ApiFuture<MutateCampaignsResponse> future = campaignServiceClient.mutateCampaignsCallable().futureCall(request); // Do something. MutateCampaignsResponse 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

Class CampaignServiceClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CampaignServiceClient

CampaignServiceClient

Method Detail

create

create

create

getSettings

getStub

mutateCampaigns

mutateCampaigns

mutateCampaignsCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination