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

Class SmartCampaignSuggestServiceClient

  • All Implemented Interfaces:
    com.google.api.gax.core.BackgroundResource, java.lang.AutoCloseable
    @Generated("by gapic-generator-java")
public class SmartCampaignSuggestServiceClient
extends java.lang.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: 

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

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

    To customize credentials: 

    
 SmartCampaignSuggestServiceSettings smartCampaignSuggestServiceSettings =
     SmartCampaignSuggestServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SmartCampaignSuggestServiceClient smartCampaignSuggestServiceClient =
     SmartCampaignSuggestServiceClient.create(smartCampaignSuggestServiceSettings);

    To customize the endpoint: 

    
 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 Detail

      • SmartCampaignSuggestServiceClient

        protected SmartCampaignSuggestServiceClient​(SmartCampaignSuggestServiceSettings settings)
                                     throws java.io.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:
        java.io.IOException

      • SmartCampaignSuggestServiceClient

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

    • Method Detail

      • create

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

      • create

        public static final SmartCampaignSuggestServiceClient create​(SmartCampaignSuggestServiceSettings settings)
                                                      throws java.io.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:
        java.io.IOException

      • create

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

      • suggestSmartCampaignBudgetOptions

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

        Sample code: 

        
 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: 

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

        
 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: 

        
 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​(SuggestKeywordThemesRequest request)
        Suggests keyword themes to advertise on.

        Sample code: 

        
 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: 

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