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

Class KeywordPlanCampaignKeywordServiceClient

java.lang.Object
com.google.ads.googleads.v18.services.KeywordPlanCampaignKeywordServiceClient
All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource, AutoCloseable
@Generated("by gapic-generator-java") public class KeywordPlanCampaignKeywordServiceClient extends Object implements com.google.api.gax.core.BackgroundResource
Service Description: Service to manage Keyword Plan campaign keywords. KeywordPlanCampaign is required to add the campaign keywords. Only negative keywords are supported. A maximum of 1000 negative keywords are allowed per plan. This includes both campaign negative keywords and ad group negative keywords.

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 (KeywordPlanCampaignKeywordServiceClient keywordPlanCampaignKeywordServiceClient =
     KeywordPlanCampaignKeywordServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<KeywordPlanCampaignKeywordOperation> operations = new ArrayList<>();
   MutateKeywordPlanCampaignKeywordsResponse response =
       keywordPlanCampaignKeywordServiceClient.mutateKeywordPlanCampaignKeywords(
           customerId, operations);
 }

Note: close() needs to be called on the KeywordPlanCampaignKeywordServiceClient 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

MutateKeywordPlanCampaignKeywords

Creates, updates, or removes Keyword Plan campaign keywords. Operation statuses are returned.

List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [KeywordPlanAdGroupKeywordError]() [KeywordPlanCampaignKeywordError]() [QuotaError]() [RequestError]() [ResourceCountLimitExceededError]()

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

  • mutateKeywordPlanCampaignKeywords(MutateKeywordPlanCampaignKeywordsRequest request)

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

  • mutateKeywordPlanCampaignKeywords(String customerId, List<KeywordPlanCampaignKeywordOperation> operations)

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

  • mutateKeywordPlanCampaignKeywordsCallable()

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 KeywordPlanCampaignKeywordServiceSettings 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
 KeywordPlanCampaignKeywordServiceSettings keywordPlanCampaignKeywordServiceSettings =
     KeywordPlanCampaignKeywordServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 KeywordPlanCampaignKeywordServiceClient keywordPlanCampaignKeywordServiceClient =
     KeywordPlanCampaignKeywordServiceClient.create(keywordPlanCampaignKeywordServiceSettings);

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
 KeywordPlanCampaignKeywordServiceSettings keywordPlanCampaignKeywordServiceSettings =
     KeywordPlanCampaignKeywordServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 KeywordPlanCampaignKeywordServiceClient keywordPlanCampaignKeywordServiceClient =
     KeywordPlanCampaignKeywordServiceClient.create(keywordPlanCampaignKeywordServiceSettings);

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

  • Constructor Details

    • KeywordPlanCampaignKeywordServiceClient

      protected KeywordPlanCampaignKeywordServiceClient(KeywordPlanCampaignKeywordServiceSettings settings) throws IOException
      Constructs an instance of KeywordPlanCampaignKeywordServiceClient, 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

    • KeywordPlanCampaignKeywordServiceClient

      protected KeywordPlanCampaignKeywordServiceClient(KeywordPlanCampaignKeywordServiceStub stub)

  • Method Details

    • create

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

    • create

      public static final KeywordPlanCampaignKeywordServiceClient create(KeywordPlanCampaignKeywordServiceSettings settings) throws IOException
      Constructs an instance of KeywordPlanCampaignKeywordServiceClient, 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 KeywordPlanCampaignKeywordServiceClient create(KeywordPlanCampaignKeywordServiceStub stub)
      Constructs an instance of KeywordPlanCampaignKeywordServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(KeywordPlanCampaignKeywordServiceSettings).

    • getSettings

      public final KeywordPlanCampaignKeywordServiceSettings getSettings()

    • getStub

      public KeywordPlanCampaignKeywordServiceStub getStub()

    • mutateKeywordPlanCampaignKeywords

      public final MutateKeywordPlanCampaignKeywordsResponse mutateKeywordPlanCampaignKeywords(String customerId, List<KeywordPlanCampaignKeywordOperation> operations)
      Creates, updates, or removes Keyword Plan campaign keywords. Operation statuses are returned.

      List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [KeywordPlanAdGroupKeywordError]() [KeywordPlanCampaignKeywordError]() [QuotaError]() [RequestError]() [ResourceCountLimitExceededError]()

      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 (KeywordPlanCampaignKeywordServiceClient keywordPlanCampaignKeywordServiceClient =
     KeywordPlanCampaignKeywordServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<KeywordPlanCampaignKeywordOperation> operations = new ArrayList<>();
   MutateKeywordPlanCampaignKeywordsResponse response =
       keywordPlanCampaignKeywordServiceClient.mutateKeywordPlanCampaignKeywords(
           customerId, operations);
 }
      Parameters:
      customerId - Required. The ID of the customer whose campaign keywords are being modified.
      operations - Required. The list of operations to perform on individual Keyword Plan campaign keywords.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails

    • mutateKeywordPlanCampaignKeywords

      public final MutateKeywordPlanCampaignKeywordsResponse mutateKeywordPlanCampaignKeywords(MutateKeywordPlanCampaignKeywordsRequest request)
      Creates, updates, or removes Keyword Plan campaign keywords. Operation statuses are returned.

      List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [KeywordPlanAdGroupKeywordError]() [KeywordPlanCampaignKeywordError]() [QuotaError]() [RequestError]() [ResourceCountLimitExceededError]()

      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 (KeywordPlanCampaignKeywordServiceClient keywordPlanCampaignKeywordServiceClient =
     KeywordPlanCampaignKeywordServiceClient.create()) {
   MutateKeywordPlanCampaignKeywordsRequest request =
       MutateKeywordPlanCampaignKeywordsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<KeywordPlanCampaignKeywordOperation>())
           .setPartialFailure(true)
           .setValidateOnly(true)
           .build();
   MutateKeywordPlanCampaignKeywordsResponse response =
       keywordPlanCampaignKeywordServiceClient.mutateKeywordPlanCampaignKeywords(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

    • mutateKeywordPlanCampaignKeywordsCallable

      public final com.google.api.gax.rpc.UnaryCallable<MutateKeywordPlanCampaignKeywordsRequest,MutateKeywordPlanCampaignKeywordsResponse> mutateKeywordPlanCampaignKeywordsCallable()
      Creates, updates, or removes Keyword Plan campaign keywords. Operation statuses are returned.

      List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [KeywordPlanAdGroupKeywordError]() [KeywordPlanCampaignKeywordError]() [QuotaError]() [RequestError]() [ResourceCountLimitExceededError]()

      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 (KeywordPlanCampaignKeywordServiceClient keywordPlanCampaignKeywordServiceClient =
     KeywordPlanCampaignKeywordServiceClient.create()) {
   MutateKeywordPlanCampaignKeywordsRequest request =
       MutateKeywordPlanCampaignKeywordsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<KeywordPlanCampaignKeywordOperation>())
           .setPartialFailure(true)
           .setValidateOnly(true)
           .build();
   ApiFuture<MutateKeywordPlanCampaignKeywordsResponse> future =
       keywordPlanCampaignKeywordServiceClient
           .mutateKeywordPlanCampaignKeywordsCallable()
           .futureCall(request);
   // Do something.
   MutateKeywordPlanCampaignKeywordsResponse 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