Package com.google.ads.googleads.v14.services

Class KeywordPlanServiceClient

  • All Implemented Interfaces:
    com.google.api.gax.core.BackgroundResource, java.lang.AutoCloseable
    @Generated("by gapic-generator-java")
public class KeywordPlanServiceClient
extends java.lang.Object
implements com.google.api.gax.core.BackgroundResource
    Service Description: Service to manage keyword plans.

    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 (KeywordPlanServiceClient keywordPlanServiceClient = KeywordPlanServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<KeywordPlanOperation> operations = new ArrayList<>();
   MutateKeywordPlansResponse response =
       keywordPlanServiceClient.mutateKeywordPlans(customerId, operations);
 }

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

    MutateKeywordPlans

    Creates, updates, or removes keyword plans. Operation statuses are returned.

    List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [KeywordPlanError]() [MutateError]() [NewResourceCreationError]() [QuotaError]() [RequestError]() [ResourceCountLimitExceededError]() [StringLengthError]()

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

    • mutateKeywordPlans(MutateKeywordPlansRequest request)

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

    • mutateKeywordPlans(String customerId, List<KeywordPlanOperation> operations)

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

    • mutateKeywordPlansCallable()

    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 KeywordPlanServiceSettings 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
 KeywordPlanServiceSettings keywordPlanServiceSettings =
     KeywordPlanServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 KeywordPlanServiceClient keywordPlanServiceClient =
     KeywordPlanServiceClient.create(keywordPlanServiceSettings);

    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
 KeywordPlanServiceSettings keywordPlanServiceSettings =
     KeywordPlanServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 KeywordPlanServiceClient keywordPlanServiceClient =
     KeywordPlanServiceClient.create(keywordPlanServiceSettings);

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

    • Constructor Detail

      • KeywordPlanServiceClient

        protected KeywordPlanServiceClient​(KeywordPlanServiceSettings settings)
                            throws java.io.IOException
        Constructs an instance of KeywordPlanServiceClient, 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

    • Method Detail

      • create

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

      • create

        public static final KeywordPlanServiceClient create​(KeywordPlanServiceSettings settings)
                                             throws java.io.IOException
        Constructs an instance of KeywordPlanServiceClient, 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

        public static final KeywordPlanServiceClient create​(KeywordPlanServiceStub stub)
        Constructs an instance of KeywordPlanServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(KeywordPlanServiceSettings).

      • mutateKeywordPlans

        public final MutateKeywordPlansResponse mutateKeywordPlans​(java.lang.String customerId,
                                                           java.util.List<KeywordPlanOperation> operations)
        Creates, updates, or removes keyword plans. Operation statuses are returned.

        List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [KeywordPlanError]() [MutateError]() [NewResourceCreationError]() [QuotaError]() [RequestError]() [ResourceCountLimitExceededError]() [StringLengthError]()

        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 (KeywordPlanServiceClient keywordPlanServiceClient = KeywordPlanServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<KeywordPlanOperation> operations = new ArrayList<>();
   MutateKeywordPlansResponse response =
       keywordPlanServiceClient.mutateKeywordPlans(customerId, operations);
 }
        Parameters:
        customerId - Required. The ID of the customer whose keyword plans are being modified.
        operations - Required. The list of operations to perform on individual keyword plans.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • mutateKeywordPlans

        public final MutateKeywordPlansResponse mutateKeywordPlans​(MutateKeywordPlansRequest request)
        Creates, updates, or removes keyword plans. Operation statuses are returned.

        List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [KeywordPlanError]() [MutateError]() [NewResourceCreationError]() [QuotaError]() [RequestError]() [ResourceCountLimitExceededError]() [StringLengthError]()

        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 (KeywordPlanServiceClient keywordPlanServiceClient = KeywordPlanServiceClient.create()) {
   MutateKeywordPlansRequest request =
       MutateKeywordPlansRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<KeywordPlanOperation>())
           .setPartialFailure(true)
           .setValidateOnly(true)
           .build();
   MutateKeywordPlansResponse response = keywordPlanServiceClient.mutateKeywordPlans(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

      • mutateKeywordPlansCallable

        public final com.google.api.gax.rpc.UnaryCallable<MutateKeywordPlansRequest,​MutateKeywordPlansResponse> mutateKeywordPlansCallable()
        Creates, updates, or removes keyword plans. Operation statuses are returned.

        List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [KeywordPlanError]() [MutateError]() [NewResourceCreationError]() [QuotaError]() [RequestError]() [ResourceCountLimitExceededError]() [StringLengthError]()

        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 (KeywordPlanServiceClient keywordPlanServiceClient = KeywordPlanServiceClient.create()) {
   MutateKeywordPlansRequest request =
       MutateKeywordPlansRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<KeywordPlanOperation>())
           .setPartialFailure(true)
           .setValidateOnly(true)
           .build();
   ApiFuture<MutateKeywordPlansResponse> future =
       keywordPlanServiceClient.mutateKeywordPlansCallable().futureCall(request);
   // Do something.
   MutateKeywordPlansResponse 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