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

Class KeywordPlanIdeaServiceClient

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

    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 (KeywordPlanIdeaServiceClient keywordPlanIdeaServiceClient =
     KeywordPlanIdeaServiceClient.create()) {
   GenerateKeywordIdeasRequest request =
       GenerateKeywordIdeasRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setLanguage("language-1613589672")
           .addAllGeoTargetConstants(new ArrayList<String>())
           .setIncludeAdultKeywords(true)
           .setPageToken("pageToken873572522")
           .setPageSize(883849137)
           .addAllKeywordAnnotation(
               new ArrayList<KeywordPlanKeywordAnnotationEnum.KeywordPlanKeywordAnnotation>())
           .setAggregateMetrics(KeywordPlanAggregateMetrics.newBuilder().build())
           .setHistoricalMetricsOptions(HistoricalMetricsOptions.newBuilder().build())
           .build();
   for (GenerateKeywordIdeaResult element :
       keywordPlanIdeaServiceClient.generateKeywordIdeas(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

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

    To customize credentials: 

    
 KeywordPlanIdeaServiceSettings keywordPlanIdeaServiceSettings =
     KeywordPlanIdeaServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 KeywordPlanIdeaServiceClient keywordPlanIdeaServiceClient =
     KeywordPlanIdeaServiceClient.create(keywordPlanIdeaServiceSettings);

    To customize the endpoint: 

    
 KeywordPlanIdeaServiceSettings keywordPlanIdeaServiceSettings =
     KeywordPlanIdeaServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 KeywordPlanIdeaServiceClient keywordPlanIdeaServiceClient =
     KeywordPlanIdeaServiceClient.create(keywordPlanIdeaServiceSettings);

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

    • Constructor Detail

      • KeywordPlanIdeaServiceClient

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

      • KeywordPlanIdeaServiceClient

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

    • Method Detail

      • create

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

      • create

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

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

      • getStub

        @BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public KeywordPlanIdeaServiceStub getStub()

      • generateKeywordIdeas

        public final KeywordPlanIdeaServiceClient.GenerateKeywordIdeasPagedResponse generateKeywordIdeas​(GenerateKeywordIdeasRequest request)
        Returns a list of keyword ideas.

        List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CollectionSizeError]() [HeaderError]() [InternalError]() [KeywordPlanIdeaError]() [QuotaError]() [RequestError]()

        Sample code: 

        
 try (KeywordPlanIdeaServiceClient keywordPlanIdeaServiceClient =
     KeywordPlanIdeaServiceClient.create()) {
   GenerateKeywordIdeasRequest request =
       GenerateKeywordIdeasRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setLanguage("language-1613589672")
           .addAllGeoTargetConstants(new ArrayList<String>())
           .setIncludeAdultKeywords(true)
           .setPageToken("pageToken873572522")
           .setPageSize(883849137)
           .addAllKeywordAnnotation(
               new ArrayList<KeywordPlanKeywordAnnotationEnum.KeywordPlanKeywordAnnotation>())
           .setAggregateMetrics(KeywordPlanAggregateMetrics.newBuilder().build())
           .setHistoricalMetricsOptions(HistoricalMetricsOptions.newBuilder().build())
           .build();
   for (GenerateKeywordIdeaResult element :
       keywordPlanIdeaServiceClient.generateKeywordIdeas(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
        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

      • generateKeywordIdeasPagedCallable

        public final com.google.api.gax.rpc.UnaryCallable<GenerateKeywordIdeasRequest,​KeywordPlanIdeaServiceClient.GenerateKeywordIdeasPagedResponse> generateKeywordIdeasPagedCallable()
        Returns a list of keyword ideas.

        List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CollectionSizeError]() [HeaderError]() [InternalError]() [KeywordPlanIdeaError]() [QuotaError]() [RequestError]()

        Sample code: 

        
 try (KeywordPlanIdeaServiceClient keywordPlanIdeaServiceClient =
     KeywordPlanIdeaServiceClient.create()) {
   GenerateKeywordIdeasRequest request =
       GenerateKeywordIdeasRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setLanguage("language-1613589672")
           .addAllGeoTargetConstants(new ArrayList<String>())
           .setIncludeAdultKeywords(true)
           .setPageToken("pageToken873572522")
           .setPageSize(883849137)
           .addAllKeywordAnnotation(
               new ArrayList<KeywordPlanKeywordAnnotationEnum.KeywordPlanKeywordAnnotation>())
           .setAggregateMetrics(KeywordPlanAggregateMetrics.newBuilder().build())
           .setHistoricalMetricsOptions(HistoricalMetricsOptions.newBuilder().build())
           .build();
   ApiFuture<GenerateKeywordIdeaResult> future =
       keywordPlanIdeaServiceClient.generateKeywordIdeasPagedCallable().futureCall(request);
   // Do something.
   for (GenerateKeywordIdeaResult element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

      • generateKeywordIdeasCallable

        public final com.google.api.gax.rpc.UnaryCallable<GenerateKeywordIdeasRequest,​GenerateKeywordIdeaResponse> generateKeywordIdeasCallable()
        Returns a list of keyword ideas.

        List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CollectionSizeError]() [HeaderError]() [InternalError]() [KeywordPlanIdeaError]() [QuotaError]() [RequestError]()

        Sample code: 

        
 try (KeywordPlanIdeaServiceClient keywordPlanIdeaServiceClient =
     KeywordPlanIdeaServiceClient.create()) {
   GenerateKeywordIdeasRequest request =
       GenerateKeywordIdeasRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setLanguage("language-1613589672")
           .addAllGeoTargetConstants(new ArrayList<String>())
           .setIncludeAdultKeywords(true)
           .setPageToken("pageToken873572522")
           .setPageSize(883849137)
           .addAllKeywordAnnotation(
               new ArrayList<KeywordPlanKeywordAnnotationEnum.KeywordPlanKeywordAnnotation>())
           .setAggregateMetrics(KeywordPlanAggregateMetrics.newBuilder().build())
           .setHistoricalMetricsOptions(HistoricalMetricsOptions.newBuilder().build())
           .build();
   while (true) {
     GenerateKeywordIdeaResponse response =
         keywordPlanIdeaServiceClient.generateKeywordIdeasCallable().call(request);
     for (GenerateKeywordIdeaResult element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

      • 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