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

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

    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 KeywordPlanServiceSettings to create(). For example:

    To customize credentials: 

    
 KeywordPlanServiceSettings keywordPlanServiceSettings =
     KeywordPlanServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 KeywordPlanServiceClient keywordPlanServiceClient =
     KeywordPlanServiceClient.create(keywordPlanServiceSettings);

    To customize the endpoint: 

    
 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

      • KeywordPlanServiceClient

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

    • 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

        @BetaApi("A restructuring of stub classes is planned, so this may break in the future")
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).

      • getStub

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

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

        
 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: 

        
 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: 

        
 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();
 }

      • generateForecastCurve

        public final GenerateForecastCurveResponse generateForecastCurve​(KeywordPlanName keywordPlan)
        Returns the requested Keyword Plan forecast curve. Only the bidding strategy is considered for generating forecast curve. The bidding strategy value specified in the plan is ignored.

        To generate a forecast at a value specified in the plan, use KeywordPlanService.GenerateForecastMetrics.

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

        Sample code: 

        
 try (KeywordPlanServiceClient keywordPlanServiceClient = KeywordPlanServiceClient.create()) {
   KeywordPlanName keywordPlan = KeywordPlanName.of("[CUSTOMER_ID]", "[KEYWORD_PLAN_ID]");
   GenerateForecastCurveResponse response =
       keywordPlanServiceClient.generateForecastCurve(keywordPlan);
 }
        Parameters:
        keywordPlan - Required. The resource name of the keyword plan to be forecasted.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • generateForecastCurve

        public final GenerateForecastCurveResponse generateForecastCurve​(java.lang.String keywordPlan)
        Returns the requested Keyword Plan forecast curve. Only the bidding strategy is considered for generating forecast curve. The bidding strategy value specified in the plan is ignored.

        To generate a forecast at a value specified in the plan, use KeywordPlanService.GenerateForecastMetrics.

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

        Sample code: 

        
 try (KeywordPlanServiceClient keywordPlanServiceClient = KeywordPlanServiceClient.create()) {
   String keywordPlan = KeywordPlanName.of("[CUSTOMER_ID]", "[KEYWORD_PLAN_ID]").toString();
   GenerateForecastCurveResponse response =
       keywordPlanServiceClient.generateForecastCurve(keywordPlan);
 }
        Parameters:
        keywordPlan - Required. The resource name of the keyword plan to be forecasted.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • generateForecastCurve

        public final GenerateForecastCurveResponse generateForecastCurve​(GenerateForecastCurveRequest request)
        Returns the requested Keyword Plan forecast curve. Only the bidding strategy is considered for generating forecast curve. The bidding strategy value specified in the plan is ignored.

        To generate a forecast at a value specified in the plan, use KeywordPlanService.GenerateForecastMetrics.

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

        Sample code: 

        
 try (KeywordPlanServiceClient keywordPlanServiceClient = KeywordPlanServiceClient.create()) {
   GenerateForecastCurveRequest request =
       GenerateForecastCurveRequest.newBuilder()
           .setKeywordPlan(KeywordPlanName.of("[CUSTOMER_ID]", "[KEYWORD_PLAN_ID]").toString())
           .build();
   GenerateForecastCurveResponse response =
       keywordPlanServiceClient.generateForecastCurve(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

      • generateForecastCurveCallable

        public final com.google.api.gax.rpc.UnaryCallable<GenerateForecastCurveRequest,​GenerateForecastCurveResponse> generateForecastCurveCallable()
        Returns the requested Keyword Plan forecast curve. Only the bidding strategy is considered for generating forecast curve. The bidding strategy value specified in the plan is ignored.

        To generate a forecast at a value specified in the plan, use KeywordPlanService.GenerateForecastMetrics.

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

        Sample code: 

        
 try (KeywordPlanServiceClient keywordPlanServiceClient = KeywordPlanServiceClient.create()) {
   GenerateForecastCurveRequest request =
       GenerateForecastCurveRequest.newBuilder()
           .setKeywordPlan(KeywordPlanName.of("[CUSTOMER_ID]", "[KEYWORD_PLAN_ID]").toString())
           .build();
   ApiFuture<GenerateForecastCurveResponse> future =
       keywordPlanServiceClient.generateForecastCurveCallable().futureCall(request);
   // Do something.
   GenerateForecastCurveResponse response = future.get();
 }

      • generateForecastTimeSeries

        public final GenerateForecastTimeSeriesResponse generateForecastTimeSeries​(KeywordPlanName keywordPlan)
        Returns a forecast in the form of a time series for the Keyword Plan over the next 52 weeks. (1) Forecasts closer to the current date are generally more accurate than further out.

        (2) The forecast reflects seasonal trends using current and prior traffic patterns. The forecast period of the plan is ignored.

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

        Sample code: 

        
 try (KeywordPlanServiceClient keywordPlanServiceClient = KeywordPlanServiceClient.create()) {
   KeywordPlanName keywordPlan = KeywordPlanName.of("[CUSTOMER_ID]", "[KEYWORD_PLAN_ID]");
   GenerateForecastTimeSeriesResponse response =
       keywordPlanServiceClient.generateForecastTimeSeries(keywordPlan);
 }
        Parameters:
        keywordPlan - Required. The resource name of the keyword plan to be forecasted.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • generateForecastTimeSeries

        public final GenerateForecastTimeSeriesResponse generateForecastTimeSeries​(java.lang.String keywordPlan)
        Returns a forecast in the form of a time series for the Keyword Plan over the next 52 weeks. (1) Forecasts closer to the current date are generally more accurate than further out.

        (2) The forecast reflects seasonal trends using current and prior traffic patterns. The forecast period of the plan is ignored.

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

        Sample code: 

        
 try (KeywordPlanServiceClient keywordPlanServiceClient = KeywordPlanServiceClient.create()) {
   String keywordPlan = KeywordPlanName.of("[CUSTOMER_ID]", "[KEYWORD_PLAN_ID]").toString();
   GenerateForecastTimeSeriesResponse response =
       keywordPlanServiceClient.generateForecastTimeSeries(keywordPlan);
 }
        Parameters:
        keywordPlan - Required. The resource name of the keyword plan to be forecasted.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • generateForecastTimeSeries

        public final GenerateForecastTimeSeriesResponse generateForecastTimeSeries​(GenerateForecastTimeSeriesRequest request)
        Returns a forecast in the form of a time series for the Keyword Plan over the next 52 weeks. (1) Forecasts closer to the current date are generally more accurate than further out.

        (2) The forecast reflects seasonal trends using current and prior traffic patterns. The forecast period of the plan is ignored.

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

        Sample code: 

        
 try (KeywordPlanServiceClient keywordPlanServiceClient = KeywordPlanServiceClient.create()) {
   GenerateForecastTimeSeriesRequest request =
       GenerateForecastTimeSeriesRequest.newBuilder()
           .setKeywordPlan(KeywordPlanName.of("[CUSTOMER_ID]", "[KEYWORD_PLAN_ID]").toString())
           .build();
   GenerateForecastTimeSeriesResponse response =
       keywordPlanServiceClient.generateForecastTimeSeries(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

      • generateForecastTimeSeriesCallable

        public final com.google.api.gax.rpc.UnaryCallable<GenerateForecastTimeSeriesRequest,​GenerateForecastTimeSeriesResponse> generateForecastTimeSeriesCallable()
        Returns a forecast in the form of a time series for the Keyword Plan over the next 52 weeks. (1) Forecasts closer to the current date are generally more accurate than further out.

        (2) The forecast reflects seasonal trends using current and prior traffic patterns. The forecast period of the plan is ignored.

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

        Sample code: 

        
 try (KeywordPlanServiceClient keywordPlanServiceClient = KeywordPlanServiceClient.create()) {
   GenerateForecastTimeSeriesRequest request =
       GenerateForecastTimeSeriesRequest.newBuilder()
           .setKeywordPlan(KeywordPlanName.of("[CUSTOMER_ID]", "[KEYWORD_PLAN_ID]").toString())
           .build();
   ApiFuture<GenerateForecastTimeSeriesResponse> future =
       keywordPlanServiceClient.generateForecastTimeSeriesCallable().futureCall(request);
   // Do something.
   GenerateForecastTimeSeriesResponse response = future.get();
 }

      • generateForecastMetrics

        public final GenerateForecastMetricsResponse generateForecastMetrics​(KeywordPlanName keywordPlan)
        Returns the requested Keyword Plan forecasts.

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

        Sample code: 

        
 try (KeywordPlanServiceClient keywordPlanServiceClient = KeywordPlanServiceClient.create()) {
   KeywordPlanName keywordPlan = KeywordPlanName.of("[CUSTOMER_ID]", "[KEYWORD_PLAN_ID]");
   GenerateForecastMetricsResponse response =
       keywordPlanServiceClient.generateForecastMetrics(keywordPlan);
 }
        Parameters:
        keywordPlan - Required. The resource name of the keyword plan to be forecasted.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • generateForecastMetrics

        public final GenerateForecastMetricsResponse generateForecastMetrics​(java.lang.String keywordPlan)
        Returns the requested Keyword Plan forecasts.

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

        Sample code: 

        
 try (KeywordPlanServiceClient keywordPlanServiceClient = KeywordPlanServiceClient.create()) {
   String keywordPlan = KeywordPlanName.of("[CUSTOMER_ID]", "[KEYWORD_PLAN_ID]").toString();
   GenerateForecastMetricsResponse response =
       keywordPlanServiceClient.generateForecastMetrics(keywordPlan);
 }
        Parameters:
        keywordPlan - Required. The resource name of the keyword plan to be forecasted.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • generateForecastMetrics

        public final GenerateForecastMetricsResponse generateForecastMetrics​(GenerateForecastMetricsRequest request)
        Returns the requested Keyword Plan forecasts.

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

        Sample code: 

        
 try (KeywordPlanServiceClient keywordPlanServiceClient = KeywordPlanServiceClient.create()) {
   GenerateForecastMetricsRequest request =
       GenerateForecastMetricsRequest.newBuilder()
           .setKeywordPlan(KeywordPlanName.of("[CUSTOMER_ID]", "[KEYWORD_PLAN_ID]").toString())
           .build();
   GenerateForecastMetricsResponse response =
       keywordPlanServiceClient.generateForecastMetrics(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

      • generateForecastMetricsCallable

        public final com.google.api.gax.rpc.UnaryCallable<GenerateForecastMetricsRequest,​GenerateForecastMetricsResponse> generateForecastMetricsCallable()
        Returns the requested Keyword Plan forecasts.

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

        Sample code: 

        
 try (KeywordPlanServiceClient keywordPlanServiceClient = KeywordPlanServiceClient.create()) {
   GenerateForecastMetricsRequest request =
       GenerateForecastMetricsRequest.newBuilder()
           .setKeywordPlan(KeywordPlanName.of("[CUSTOMER_ID]", "[KEYWORD_PLAN_ID]").toString())
           .build();
   ApiFuture<GenerateForecastMetricsResponse> future =
       keywordPlanServiceClient.generateForecastMetricsCallable().futureCall(request);
   // Do something.
   GenerateForecastMetricsResponse response = future.get();
 }

      • generateHistoricalMetrics

        public final GenerateHistoricalMetricsResponse generateHistoricalMetrics​(KeywordPlanName keywordPlan)
        Returns the requested Keyword Plan historical metrics.

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

        Sample code: 

        
 try (KeywordPlanServiceClient keywordPlanServiceClient = KeywordPlanServiceClient.create()) {
   KeywordPlanName keywordPlan = KeywordPlanName.of("[CUSTOMER_ID]", "[KEYWORD_PLAN_ID]");
   GenerateHistoricalMetricsResponse response =
       keywordPlanServiceClient.generateHistoricalMetrics(keywordPlan);
 }
        Parameters:
        keywordPlan - Required. The resource name of the keyword plan of which historical metrics are requested.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • generateHistoricalMetrics

        public final GenerateHistoricalMetricsResponse generateHistoricalMetrics​(java.lang.String keywordPlan)
        Returns the requested Keyword Plan historical metrics.

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

        Sample code: 

        
 try (KeywordPlanServiceClient keywordPlanServiceClient = KeywordPlanServiceClient.create()) {
   String keywordPlan = KeywordPlanName.of("[CUSTOMER_ID]", "[KEYWORD_PLAN_ID]").toString();
   GenerateHistoricalMetricsResponse response =
       keywordPlanServiceClient.generateHistoricalMetrics(keywordPlan);
 }
        Parameters:
        keywordPlan - Required. The resource name of the keyword plan of which historical metrics are requested.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • generateHistoricalMetrics

        public final GenerateHistoricalMetricsResponse generateHistoricalMetrics​(GenerateHistoricalMetricsRequest request)
        Returns the requested Keyword Plan historical metrics.

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

        Sample code: 

        
 try (KeywordPlanServiceClient keywordPlanServiceClient = KeywordPlanServiceClient.create()) {
   GenerateHistoricalMetricsRequest request =
       GenerateHistoricalMetricsRequest.newBuilder()
           .setKeywordPlan(KeywordPlanName.of("[CUSTOMER_ID]", "[KEYWORD_PLAN_ID]").toString())
           .setAggregateMetrics(KeywordPlanAggregateMetrics.newBuilder().build())
           .setHistoricalMetricsOptions(HistoricalMetricsOptions.newBuilder().build())
           .build();
   GenerateHistoricalMetricsResponse response =
       keywordPlanServiceClient.generateHistoricalMetrics(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

      • generateHistoricalMetricsCallable

        public final com.google.api.gax.rpc.UnaryCallable<GenerateHistoricalMetricsRequest,​GenerateHistoricalMetricsResponse> generateHistoricalMetricsCallable()
        Returns the requested Keyword Plan historical metrics.

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

        Sample code: 

        
 try (KeywordPlanServiceClient keywordPlanServiceClient = KeywordPlanServiceClient.create()) {
   GenerateHistoricalMetricsRequest request =
       GenerateHistoricalMetricsRequest.newBuilder()
           .setKeywordPlan(KeywordPlanName.of("[CUSTOMER_ID]", "[KEYWORD_PLAN_ID]").toString())
           .setAggregateMetrics(KeywordPlanAggregateMetrics.newBuilder().build())
           .setHistoricalMetricsOptions(HistoricalMetricsOptions.newBuilder().build())
           .build();
   ApiFuture<GenerateHistoricalMetricsResponse> future =
       keywordPlanServiceClient.generateHistoricalMetricsCallable().futureCall(request);
   // Do something.
   GenerateHistoricalMetricsResponse 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