Package com.google.ads.googleads.v18.services

Class SmartCampaignSuggestServiceClient

java.lang.Object
com.google.ads.googleads.v18.services.SmartCampaignSuggestServiceClient
All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource, AutoCloseable
@Generated("by gapic-generator-java") public class SmartCampaignSuggestServiceClient extends Object implements com.google.api.gax.core.BackgroundResource
Service Description: Service to get suggestions for Smart Campaigns.

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 (SmartCampaignSuggestServiceClient smartCampaignSuggestServiceClient =
     SmartCampaignSuggestServiceClient.create()) {
   SuggestSmartCampaignBudgetOptionsRequest request =
       SuggestSmartCampaignBudgetOptionsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .build();
   SuggestSmartCampaignBudgetOptionsResponse response =
       smartCampaignSuggestServiceClient.suggestSmartCampaignBudgetOptions(request);
 }

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

SuggestSmartCampaignBudgetOptions

Returns BudgetOption suggestions.

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

  • suggestSmartCampaignBudgetOptions(SuggestSmartCampaignBudgetOptionsRequest request)

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

  • suggestSmartCampaignBudgetOptionsCallable()

SuggestSmartCampaignAd

Suggests a Smart campaign ad compatible with the Ad family of resources, based on data points such as targeting and the business to advertise.

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

  • suggestSmartCampaignAd(SuggestSmartCampaignAdRequest request)

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

  • suggestSmartCampaignAd(String customerId, SmartCampaignSuggestionInfo suggestionInfo)

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

  • suggestSmartCampaignAdCallable()

SuggestKeywordThemes

Suggests keyword themes to advertise on.

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

  • suggestKeywordThemes(SuggestKeywordThemesRequest request)

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

  • suggestKeywordThemes(String customerId, SmartCampaignSuggestionInfo suggestionInfo)

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

  • suggestKeywordThemesCallable()

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 SmartCampaignSuggestServiceSettings 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
 SmartCampaignSuggestServiceSettings smartCampaignSuggestServiceSettings =
     SmartCampaignSuggestServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SmartCampaignSuggestServiceClient smartCampaignSuggestServiceClient =
     SmartCampaignSuggestServiceClient.create(smartCampaignSuggestServiceSettings);

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
 SmartCampaignSuggestServiceSettings smartCampaignSuggestServiceSettings =
     SmartCampaignSuggestServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 SmartCampaignSuggestServiceClient smartCampaignSuggestServiceClient =
     SmartCampaignSuggestServiceClient.create(smartCampaignSuggestServiceSettings);

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

  • Constructor Details

    • SmartCampaignSuggestServiceClient

      protected SmartCampaignSuggestServiceClient(SmartCampaignSuggestServiceSettings settings) throws IOException
      Constructs an instance of SmartCampaignSuggestServiceClient, 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:
      IOException

    • SmartCampaignSuggestServiceClient

      protected SmartCampaignSuggestServiceClient(SmartCampaignSuggestServiceStub stub)

  • Method Details

    • create

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

    • create

      public static final SmartCampaignSuggestServiceClient create(SmartCampaignSuggestServiceSettings settings) throws IOException
      Constructs an instance of SmartCampaignSuggestServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
      Throws:
      IOException

    • create

      public static final SmartCampaignSuggestServiceClient create(SmartCampaignSuggestServiceStub stub)
      Constructs an instance of SmartCampaignSuggestServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(SmartCampaignSuggestServiceSettings).

    • getSettings

      public final SmartCampaignSuggestServiceSettings getSettings()

    • getStub

      public SmartCampaignSuggestServiceStub getStub()

    • suggestSmartCampaignBudgetOptions

      public final SuggestSmartCampaignBudgetOptionsResponse suggestSmartCampaignBudgetOptions(SuggestSmartCampaignBudgetOptionsRequest request)
      Returns BudgetOption suggestions.

      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 (SmartCampaignSuggestServiceClient smartCampaignSuggestServiceClient =
     SmartCampaignSuggestServiceClient.create()) {
   SuggestSmartCampaignBudgetOptionsRequest request =
       SuggestSmartCampaignBudgetOptionsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .build();
   SuggestSmartCampaignBudgetOptionsResponse response =
       smartCampaignSuggestServiceClient.suggestSmartCampaignBudgetOptions(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

    • suggestSmartCampaignBudgetOptionsCallable

      public final com.google.api.gax.rpc.UnaryCallable<SuggestSmartCampaignBudgetOptionsRequest,SuggestSmartCampaignBudgetOptionsResponse> suggestSmartCampaignBudgetOptionsCallable()
      Returns BudgetOption suggestions.

      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 (SmartCampaignSuggestServiceClient smartCampaignSuggestServiceClient =
     SmartCampaignSuggestServiceClient.create()) {
   SuggestSmartCampaignBudgetOptionsRequest request =
       SuggestSmartCampaignBudgetOptionsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .build();
   ApiFuture<SuggestSmartCampaignBudgetOptionsResponse> future =
       smartCampaignSuggestServiceClient
           .suggestSmartCampaignBudgetOptionsCallable()
           .futureCall(request);
   // Do something.
   SuggestSmartCampaignBudgetOptionsResponse response = future.get();
 }

    • suggestSmartCampaignAd

      public final SuggestSmartCampaignAdResponse suggestSmartCampaignAd(String customerId, SmartCampaignSuggestionInfo suggestionInfo)
      Suggests a Smart campaign ad compatible with the Ad family of resources, based on data points such as targeting and the business to advertise.

      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 (SmartCampaignSuggestServiceClient smartCampaignSuggestServiceClient =
     SmartCampaignSuggestServiceClient.create()) {
   String customerId = "customerId-1581184615";
   SmartCampaignSuggestionInfo suggestionInfo = SmartCampaignSuggestionInfo.newBuilder().build();
   SuggestSmartCampaignAdResponse response =
       smartCampaignSuggestServiceClient.suggestSmartCampaignAd(customerId, suggestionInfo);
 }
      Parameters:
      customerId - Required. The ID of the customer.
      suggestionInfo - Required. Inputs used to suggest a Smart campaign ad. Required fields: final_url, language_code, keyword_themes. Optional but recommended fields to improve the quality of the suggestion: business_setting and geo_target.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails

    • suggestSmartCampaignAd

      public final SuggestSmartCampaignAdResponse suggestSmartCampaignAd(SuggestSmartCampaignAdRequest request)
      Suggests a Smart campaign ad compatible with the Ad family of resources, based on data points such as targeting and the business to advertise.

      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 (SmartCampaignSuggestServiceClient smartCampaignSuggestServiceClient =
     SmartCampaignSuggestServiceClient.create()) {
   SuggestSmartCampaignAdRequest request =
       SuggestSmartCampaignAdRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setSuggestionInfo(SmartCampaignSuggestionInfo.newBuilder().build())
           .build();
   SuggestSmartCampaignAdResponse response =
       smartCampaignSuggestServiceClient.suggestSmartCampaignAd(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

    • suggestSmartCampaignAdCallable

      public final com.google.api.gax.rpc.UnaryCallable<SuggestSmartCampaignAdRequest,SuggestSmartCampaignAdResponse> suggestSmartCampaignAdCallable()
      Suggests a Smart campaign ad compatible with the Ad family of resources, based on data points such as targeting and the business to advertise.

      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 (SmartCampaignSuggestServiceClient smartCampaignSuggestServiceClient =
     SmartCampaignSuggestServiceClient.create()) {
   SuggestSmartCampaignAdRequest request =
       SuggestSmartCampaignAdRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setSuggestionInfo(SmartCampaignSuggestionInfo.newBuilder().build())
           .build();
   ApiFuture<SuggestSmartCampaignAdResponse> future =
       smartCampaignSuggestServiceClient.suggestSmartCampaignAdCallable().futureCall(request);
   // Do something.
   SuggestSmartCampaignAdResponse response = future.get();
 }

    • suggestKeywordThemes

      public final SuggestKeywordThemesResponse suggestKeywordThemes(String customerId, SmartCampaignSuggestionInfo suggestionInfo)
      Suggests keyword themes to advertise on.

      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 (SmartCampaignSuggestServiceClient smartCampaignSuggestServiceClient =
     SmartCampaignSuggestServiceClient.create()) {
   String customerId = "customerId-1581184615";
   SmartCampaignSuggestionInfo suggestionInfo = SmartCampaignSuggestionInfo.newBuilder().build();
   SuggestKeywordThemesResponse response =
       smartCampaignSuggestServiceClient.suggestKeywordThemes(customerId, suggestionInfo);
 }
      Parameters:
      customerId - Required. The ID of the customer.
      suggestionInfo - Required. Information to get keyword theme suggestions. Required fields:
      • suggestion_info.final_url
      • suggestion_info.language_code
      • suggestion_info.geo_target

      Recommended fields:

      • suggestion_info.business_setting
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails

    • suggestKeywordThemes

      public final SuggestKeywordThemesResponse suggestKeywordThemes(SuggestKeywordThemesRequest request)
      Suggests keyword themes to advertise on.

      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 (SmartCampaignSuggestServiceClient smartCampaignSuggestServiceClient =
     SmartCampaignSuggestServiceClient.create()) {
   SuggestKeywordThemesRequest request =
       SuggestKeywordThemesRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setSuggestionInfo(SmartCampaignSuggestionInfo.newBuilder().build())
           .build();
   SuggestKeywordThemesResponse response =
       smartCampaignSuggestServiceClient.suggestKeywordThemes(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

    • suggestKeywordThemesCallable

      public final com.google.api.gax.rpc.UnaryCallable<SuggestKeywordThemesRequest,SuggestKeywordThemesResponse> suggestKeywordThemesCallable()
      Suggests keyword themes to advertise on.

      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 (SmartCampaignSuggestServiceClient smartCampaignSuggestServiceClient =
     SmartCampaignSuggestServiceClient.create()) {
   SuggestKeywordThemesRequest request =
       SuggestKeywordThemesRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setSuggestionInfo(SmartCampaignSuggestionInfo.newBuilder().build())
           .build();
   ApiFuture<SuggestKeywordThemesResponse> future =
       smartCampaignSuggestServiceClient.suggestKeywordThemesCallable().futureCall(request);
   // Do something.
   SuggestKeywordThemesResponse response = future.get();
 }

    • close

      public final void close()
      Specified by:
      close in interface 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, TimeUnit unit) throws InterruptedException
      Specified by:
      awaitTermination in interface com.google.api.gax.core.BackgroundResource
      Throws:
      InterruptedException