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

Class KeywordPlanAdGroupKeywordServiceClient

  • All Implemented Interfaces:
    com.google.api.gax.core.BackgroundResource, java.lang.AutoCloseable
    @Generated("by gapic-generator-java")
public class KeywordPlanAdGroupKeywordServiceClient
extends java.lang.Object
implements com.google.api.gax.core.BackgroundResource
    Service Description: Service to manage Keyword Plan ad group keywords. KeywordPlanAdGroup is required to add ad group keywords. Positive and negative keywords are supported. A maximum of 10,000 positive keywords are allowed per keyword plan. A maximum of 1,000 negative keywords are allower per keyword plan. This includes 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: 

    
 try (KeywordPlanAdGroupKeywordServiceClient keywordPlanAdGroupKeywordServiceClient =
     KeywordPlanAdGroupKeywordServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<KeywordPlanAdGroupKeywordOperation> operations = new ArrayList<>();
   MutateKeywordPlanAdGroupKeywordsResponse response =
       keywordPlanAdGroupKeywordServiceClient.mutateKeywordPlanAdGroupKeywords(
           customerId, operations);
 }

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

    To customize credentials: 

    
 KeywordPlanAdGroupKeywordServiceSettings keywordPlanAdGroupKeywordServiceSettings =
     KeywordPlanAdGroupKeywordServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 KeywordPlanAdGroupKeywordServiceClient keywordPlanAdGroupKeywordServiceClient =
     KeywordPlanAdGroupKeywordServiceClient.create(keywordPlanAdGroupKeywordServiceSettings);

    To customize the endpoint: 

    
 KeywordPlanAdGroupKeywordServiceSettings keywordPlanAdGroupKeywordServiceSettings =
     KeywordPlanAdGroupKeywordServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 KeywordPlanAdGroupKeywordServiceClient keywordPlanAdGroupKeywordServiceClient =
     KeywordPlanAdGroupKeywordServiceClient.create(keywordPlanAdGroupKeywordServiceSettings);

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

    • Constructor Detail

      • KeywordPlanAdGroupKeywordServiceClient

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

      • KeywordPlanAdGroupKeywordServiceClient

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

    • Method Detail

      • create

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

      • create

        @BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public static final KeywordPlanAdGroupKeywordServiceClient create​(KeywordPlanAdGroupKeywordServiceStub stub)
        Constructs an instance of KeywordPlanAdGroupKeywordServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(KeywordPlanAdGroupKeywordServiceSettings).

      • mutateKeywordPlanAdGroupKeywords

        public final MutateKeywordPlanAdGroupKeywordsResponse mutateKeywordPlanAdGroupKeywords​(java.lang.String customerId,
                                                                                       java.util.List<KeywordPlanAdGroupKeywordOperation> operations)
        Creates, updates, or removes Keyword Plan ad group keywords. Operation statuses are returned.

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

        Sample code: 

        
 try (KeywordPlanAdGroupKeywordServiceClient keywordPlanAdGroupKeywordServiceClient =
     KeywordPlanAdGroupKeywordServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<KeywordPlanAdGroupKeywordOperation> operations = new ArrayList<>();
   MutateKeywordPlanAdGroupKeywordsResponse response =
       keywordPlanAdGroupKeywordServiceClient.mutateKeywordPlanAdGroupKeywords(
           customerId, operations);
 }
        Parameters:
        customerId - Required. The ID of the customer whose Keyword Plan ad group keywords are being modified.
        operations - Required. The list of operations to perform on individual Keyword Plan ad group keywords.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • mutateKeywordPlanAdGroupKeywords

        public final MutateKeywordPlanAdGroupKeywordsResponse mutateKeywordPlanAdGroupKeywords​(MutateKeywordPlanAdGroupKeywordsRequest request)
        Creates, updates, or removes Keyword Plan ad group keywords. Operation statuses are returned.

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

        Sample code: 

        
 try (KeywordPlanAdGroupKeywordServiceClient keywordPlanAdGroupKeywordServiceClient =
     KeywordPlanAdGroupKeywordServiceClient.create()) {
   MutateKeywordPlanAdGroupKeywordsRequest request =
       MutateKeywordPlanAdGroupKeywordsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<KeywordPlanAdGroupKeywordOperation>())
           .setPartialFailure(true)
           .setValidateOnly(true)
           .build();
   MutateKeywordPlanAdGroupKeywordsResponse response =
       keywordPlanAdGroupKeywordServiceClient.mutateKeywordPlanAdGroupKeywords(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

      • mutateKeywordPlanAdGroupKeywordsCallable

        public final com.google.api.gax.rpc.UnaryCallable<MutateKeywordPlanAdGroupKeywordsRequest,​MutateKeywordPlanAdGroupKeywordsResponse> mutateKeywordPlanAdGroupKeywordsCallable()
        Creates, updates, or removes Keyword Plan ad group keywords. Operation statuses are returned.

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

        Sample code: 

        
 try (KeywordPlanAdGroupKeywordServiceClient keywordPlanAdGroupKeywordServiceClient =
     KeywordPlanAdGroupKeywordServiceClient.create()) {
   MutateKeywordPlanAdGroupKeywordsRequest request =
       MutateKeywordPlanAdGroupKeywordsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<KeywordPlanAdGroupKeywordOperation>())
           .setPartialFailure(true)
           .setValidateOnly(true)
           .build();
   ApiFuture<MutateKeywordPlanAdGroupKeywordsResponse> future =
       keywordPlanAdGroupKeywordServiceClient
           .mutateKeywordPlanAdGroupKeywordsCallable()
           .futureCall(request);
   // Do something.
   MutateKeywordPlanAdGroupKeywordsResponse 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