Package com.google.ads.googleads.v15.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: 

    
 // 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 (KeywordPlanIdeaServiceClient keywordPlanIdeaServiceClient =
     KeywordPlanIdeaServiceClient.create()) {
   GenerateKeywordHistoricalMetricsRequest request =
       GenerateKeywordHistoricalMetricsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllKeywords(new ArrayList<String>())
           .setLanguage("language-1613589672")
           .setIncludeAdultKeywords(true)
           .addAllGeoTargetConstants(new ArrayList<String>())
           .setAggregateMetrics(KeywordPlanAggregateMetrics.newBuilder().build())
           .setHistoricalMetricsOptions(HistoricalMetricsOptions.newBuilder().build())
           .build();
   GenerateKeywordHistoricalMetricsResponse response =
       keywordPlanIdeaServiceClient.generateKeywordHistoricalMetrics(request);
 }

    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().

    Methods
    Method Description Method Variants

    GenerateKeywordIdeas

    Returns a list of keyword ideas.

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

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

    • generateKeywordIdeas(GenerateKeywordIdeasRequest request)

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

    • generateKeywordIdeasPagedCallable()

    • generateKeywordIdeasCallable()

    GenerateKeywordHistoricalMetrics

    Returns a list of keyword historical metrics.

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

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

    • generateKeywordHistoricalMetrics(GenerateKeywordHistoricalMetricsRequest request)

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

    • generateKeywordHistoricalMetricsCallable()

    GenerateAdGroupThemes

    Returns a list of suggested AdGroups and suggested modifications (text, match type) for the given keywords.

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

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

    • generateAdGroupThemes(GenerateAdGroupThemesRequest request)

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

    • generateAdGroupThemesCallable()

    GenerateKeywordForecastMetrics

    Returns metrics (such as impressions, clicks, total cost) of a keyword forecast for the given campaign.

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

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

    • generateKeywordForecastMetrics(GenerateKeywordForecastMetricsRequest request)

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

    • generateKeywordForecastMetricsCallable()

    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: 

    
 // 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
 KeywordPlanIdeaServiceSettings keywordPlanIdeaServiceSettings =
     KeywordPlanIdeaServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 KeywordPlanIdeaServiceClient keywordPlanIdeaServiceClient =
     KeywordPlanIdeaServiceClient.create(keywordPlanIdeaServiceSettings);

    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
 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

    • 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

        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).

      • 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: 

        
 // 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 (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: 

        
 // 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 (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: 

        
 // 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 (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.getResultsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

      • generateKeywordHistoricalMetrics

        public final GenerateKeywordHistoricalMetricsResponse generateKeywordHistoricalMetrics​(GenerateKeywordHistoricalMetricsRequest request)
        Returns a list of keyword historical metrics.

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

        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 (KeywordPlanIdeaServiceClient keywordPlanIdeaServiceClient =
     KeywordPlanIdeaServiceClient.create()) {
   GenerateKeywordHistoricalMetricsRequest request =
       GenerateKeywordHistoricalMetricsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllKeywords(new ArrayList<String>())
           .setLanguage("language-1613589672")
           .setIncludeAdultKeywords(true)
           .addAllGeoTargetConstants(new ArrayList<String>())
           .setAggregateMetrics(KeywordPlanAggregateMetrics.newBuilder().build())
           .setHistoricalMetricsOptions(HistoricalMetricsOptions.newBuilder().build())
           .build();
   GenerateKeywordHistoricalMetricsResponse response =
       keywordPlanIdeaServiceClient.generateKeywordHistoricalMetrics(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

      • generateKeywordHistoricalMetricsCallable

        public final com.google.api.gax.rpc.UnaryCallable<GenerateKeywordHistoricalMetricsRequest,​GenerateKeywordHistoricalMetricsResponse> generateKeywordHistoricalMetricsCallable()
        Returns a list of keyword historical metrics.

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

        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 (KeywordPlanIdeaServiceClient keywordPlanIdeaServiceClient =
     KeywordPlanIdeaServiceClient.create()) {
   GenerateKeywordHistoricalMetricsRequest request =
       GenerateKeywordHistoricalMetricsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllKeywords(new ArrayList<String>())
           .setLanguage("language-1613589672")
           .setIncludeAdultKeywords(true)
           .addAllGeoTargetConstants(new ArrayList<String>())
           .setAggregateMetrics(KeywordPlanAggregateMetrics.newBuilder().build())
           .setHistoricalMetricsOptions(HistoricalMetricsOptions.newBuilder().build())
           .build();
   ApiFuture<GenerateKeywordHistoricalMetricsResponse> future =
       keywordPlanIdeaServiceClient
           .generateKeywordHistoricalMetricsCallable()
           .futureCall(request);
   // Do something.
   GenerateKeywordHistoricalMetricsResponse response = future.get();
 }

      • generateAdGroupThemes

        public final GenerateAdGroupThemesResponse generateAdGroupThemes​(GenerateAdGroupThemesRequest request)
        Returns a list of suggested AdGroups and suggested modifications (text, match type) for the given keywords.

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

        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 (KeywordPlanIdeaServiceClient keywordPlanIdeaServiceClient =
     KeywordPlanIdeaServiceClient.create()) {
   GenerateAdGroupThemesRequest request =
       GenerateAdGroupThemesRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllKeywords(new ArrayList<String>())
           .addAllAdGroups(new ArrayList<String>())
           .build();
   GenerateAdGroupThemesResponse response =
       keywordPlanIdeaServiceClient.generateAdGroupThemes(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

      • generateAdGroupThemesCallable

        public final com.google.api.gax.rpc.UnaryCallable<GenerateAdGroupThemesRequest,​GenerateAdGroupThemesResponse> generateAdGroupThemesCallable()
        Returns a list of suggested AdGroups and suggested modifications (text, match type) for the given keywords.

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

        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 (KeywordPlanIdeaServiceClient keywordPlanIdeaServiceClient =
     KeywordPlanIdeaServiceClient.create()) {
   GenerateAdGroupThemesRequest request =
       GenerateAdGroupThemesRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllKeywords(new ArrayList<String>())
           .addAllAdGroups(new ArrayList<String>())
           .build();
   ApiFuture<GenerateAdGroupThemesResponse> future =
       keywordPlanIdeaServiceClient.generateAdGroupThemesCallable().futureCall(request);
   // Do something.
   GenerateAdGroupThemesResponse response = future.get();
 }

      • generateKeywordForecastMetrics

        public final GenerateKeywordForecastMetricsResponse generateKeywordForecastMetrics​(GenerateKeywordForecastMetricsRequest request)
        Returns metrics (such as impressions, clicks, total cost) of a keyword forecast for the given campaign.

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

        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 (KeywordPlanIdeaServiceClient keywordPlanIdeaServiceClient =
     KeywordPlanIdeaServiceClient.create()) {
   GenerateKeywordForecastMetricsRequest request =
       GenerateKeywordForecastMetricsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setCurrencyCode("currencyCode1004773790")
           .setForecastPeriod(DateRange.newBuilder().build())
           .setCampaign(CampaignToForecast.newBuilder().build())
           .build();
   GenerateKeywordForecastMetricsResponse response =
       keywordPlanIdeaServiceClient.generateKeywordForecastMetrics(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

      • generateKeywordForecastMetricsCallable

        public final com.google.api.gax.rpc.UnaryCallable<GenerateKeywordForecastMetricsRequest,​GenerateKeywordForecastMetricsResponse> generateKeywordForecastMetricsCallable()
        Returns metrics (such as impressions, clicks, total cost) of a keyword forecast for the given campaign.

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

        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 (KeywordPlanIdeaServiceClient keywordPlanIdeaServiceClient =
     KeywordPlanIdeaServiceClient.create()) {
   GenerateKeywordForecastMetricsRequest request =
       GenerateKeywordForecastMetricsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setCurrencyCode("currencyCode1004773790")
           .setForecastPeriod(DateRange.newBuilder().build())
           .setCampaign(CampaignToForecast.newBuilder().build())
           .build();
   ApiFuture<GenerateKeywordForecastMetricsResponse> future =
       keywordPlanIdeaServiceClient.generateKeywordForecastMetricsCallable().futureCall(request);
   // Do something.
   GenerateKeywordForecastMetricsResponse 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