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

Class KeywordPlanAdGroupServiceClient

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

    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 (KeywordPlanAdGroupServiceClient keywordPlanAdGroupServiceClient =
     KeywordPlanAdGroupServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<KeywordPlanAdGroupOperation> operations = new ArrayList<>();
   MutateKeywordPlanAdGroupsResponse response =
       keywordPlanAdGroupServiceClient.mutateKeywordPlanAdGroups(customerId, operations);
 }

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

    MutateKeywordPlanAdGroups

    Creates, updates, or removes Keyword Plan ad groups. Operation statuses are returned.

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

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

    • mutateKeywordPlanAdGroups(MutateKeywordPlanAdGroupsRequest request)

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

    • mutateKeywordPlanAdGroups(String customerId, List<KeywordPlanAdGroupOperation> operations)

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

    • mutateKeywordPlanAdGroupsCallable()

    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 KeywordPlanAdGroupServiceSettings 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
 KeywordPlanAdGroupServiceSettings keywordPlanAdGroupServiceSettings =
     KeywordPlanAdGroupServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 KeywordPlanAdGroupServiceClient keywordPlanAdGroupServiceClient =
     KeywordPlanAdGroupServiceClient.create(keywordPlanAdGroupServiceSettings);

    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
 KeywordPlanAdGroupServiceSettings keywordPlanAdGroupServiceSettings =
     KeywordPlanAdGroupServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 KeywordPlanAdGroupServiceClient keywordPlanAdGroupServiceClient =
     KeywordPlanAdGroupServiceClient.create(keywordPlanAdGroupServiceSettings);

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

    • Constructor Detail

      • KeywordPlanAdGroupServiceClient

        protected KeywordPlanAdGroupServiceClient​(KeywordPlanAdGroupServiceSettings settings)
                                   throws java.io.IOException
        Constructs an instance of KeywordPlanAdGroupServiceClient, 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 KeywordPlanAdGroupServiceClient create()
                                                    throws java.io.IOException
        Constructs an instance of KeywordPlanAdGroupServiceClient with default settings.
        Throws:
        java.io.IOException

      • create

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

      • mutateKeywordPlanAdGroups

        public final MutateKeywordPlanAdGroupsResponse mutateKeywordPlanAdGroups​(java.lang.String customerId,
                                                                         java.util.List<KeywordPlanAdGroupOperation> operations)
        Creates, updates, or removes Keyword Plan ad groups. Operation statuses are returned.

        List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [FieldMaskError]() [HeaderError]() [InternalError]() [KeywordPlanAdGroupError]() [KeywordPlanError]() [MutateError]() [NewResourceCreationError]() [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 (KeywordPlanAdGroupServiceClient keywordPlanAdGroupServiceClient =
     KeywordPlanAdGroupServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<KeywordPlanAdGroupOperation> operations = new ArrayList<>();
   MutateKeywordPlanAdGroupsResponse response =
       keywordPlanAdGroupServiceClient.mutateKeywordPlanAdGroups(customerId, operations);
 }
        Parameters:
        customerId - Required. The ID of the customer whose Keyword Plan ad groups are being modified.
        operations - Required. The list of operations to perform on individual Keyword Plan ad groups.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • mutateKeywordPlanAdGroups

        public final MutateKeywordPlanAdGroupsResponse mutateKeywordPlanAdGroups​(MutateKeywordPlanAdGroupsRequest request)
        Creates, updates, or removes Keyword Plan ad groups. Operation statuses are returned.

        List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [FieldMaskError]() [HeaderError]() [InternalError]() [KeywordPlanAdGroupError]() [KeywordPlanError]() [MutateError]() [NewResourceCreationError]() [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 (KeywordPlanAdGroupServiceClient keywordPlanAdGroupServiceClient =
     KeywordPlanAdGroupServiceClient.create()) {
   MutateKeywordPlanAdGroupsRequest request =
       MutateKeywordPlanAdGroupsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<KeywordPlanAdGroupOperation>())
           .setPartialFailure(true)
           .setValidateOnly(true)
           .build();
   MutateKeywordPlanAdGroupsResponse response =
       keywordPlanAdGroupServiceClient.mutateKeywordPlanAdGroups(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

      • mutateKeywordPlanAdGroupsCallable

        public final com.google.api.gax.rpc.UnaryCallable<MutateKeywordPlanAdGroupsRequest,​MutateKeywordPlanAdGroupsResponse> mutateKeywordPlanAdGroupsCallable()
        Creates, updates, or removes Keyword Plan ad groups. Operation statuses are returned.

        List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [FieldMaskError]() [HeaderError]() [InternalError]() [KeywordPlanAdGroupError]() [KeywordPlanError]() [MutateError]() [NewResourceCreationError]() [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 (KeywordPlanAdGroupServiceClient keywordPlanAdGroupServiceClient =
     KeywordPlanAdGroupServiceClient.create()) {
   MutateKeywordPlanAdGroupsRequest request =
       MutateKeywordPlanAdGroupsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<KeywordPlanAdGroupOperation>())
           .setPartialFailure(true)
           .setValidateOnly(true)
           .build();
   ApiFuture<MutateKeywordPlanAdGroupsResponse> future =
       keywordPlanAdGroupServiceClient.mutateKeywordPlanAdGroupsCallable().futureCall(request);
   // Do something.
   MutateKeywordPlanAdGroupsResponse 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