Package com.google.ads.googleads.v18.services

Class CampaignServiceClient

java.lang.Object
com.google.ads.googleads.v18.services.CampaignServiceClient
All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource, AutoCloseable
@Generated("by gapic-generator-java") public class CampaignServiceClient extends 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: 


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 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().

Methods
Method Description Method Variants

MutateCampaigns

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]()

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • mutateCampaigns(MutateCampaignsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • mutateCampaigns(String customerId, List<CampaignOperation> operations)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • mutateCampaignsCallable()

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: 


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 CampaignServiceSettings campaignServiceSettings =
     CampaignServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CampaignServiceClient campaignServiceClient =
     CampaignServiceClient.create(campaignServiceSettings);

To customize the endpoint: 


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 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 Details

    • CampaignServiceClient

      protected CampaignServiceClient(CampaignServiceSettings settings) throws 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:
      IOException

    • CampaignServiceClient

      protected CampaignServiceClient(CampaignServiceStub stub)

  • Method Details

    • create

      public static final CampaignServiceClient create() throws IOException
      Constructs an instance of CampaignServiceClient with default settings.
      Throws:
      IOException

    • create

      public static final CampaignServiceClient create(CampaignServiceSettings settings) throws 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:
      IOException

    • create

      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

      public CampaignServiceStub getStub()

    • mutateCampaigns

      public final MutateCampaignsResponse mutateCampaigns(String customerId, 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: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 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: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 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: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 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 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, TimeUnit unit) throws InterruptedException
      Specified by:
      awaitTermination in interface com.google.api.gax.core.BackgroundResource
      Throws:
      InterruptedException