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

Class BrandSuggestionServiceClient

java.lang.Object
com.google.ads.googleads.v18.services.BrandSuggestionServiceClient
All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource, AutoCloseable
@Generated("by gapic-generator-java") public class BrandSuggestionServiceClient extends Object implements com.google.api.gax.core.BackgroundResource
Service Description: This service will suggest brands based on a prefix.

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 (BrandSuggestionServiceClient brandSuggestionServiceClient =
     BrandSuggestionServiceClient.create()) {
   String customerId = "customerId-1581184615";
   String brandPrefix = "brandPrefix-774313735";
   SuggestBrandsResponse response =
       brandSuggestionServiceClient.suggestBrands(customerId, brandPrefix);
 }

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

SuggestBrands

Rpc to return a list of matching brands based on a prefix for this customer.

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

  • suggestBrands(SuggestBrandsRequest request)

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

  • suggestBrands(String customerId, String brandPrefix)

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

  • suggestBrandsCallable()

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 BrandSuggestionServiceSettings 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
 BrandSuggestionServiceSettings brandSuggestionServiceSettings =
     BrandSuggestionServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 BrandSuggestionServiceClient brandSuggestionServiceClient =
     BrandSuggestionServiceClient.create(brandSuggestionServiceSettings);

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
 BrandSuggestionServiceSettings brandSuggestionServiceSettings =
     BrandSuggestionServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 BrandSuggestionServiceClient brandSuggestionServiceClient =
     BrandSuggestionServiceClient.create(brandSuggestionServiceSettings);

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

  • Constructor Details

    • BrandSuggestionServiceClient

      protected BrandSuggestionServiceClient(BrandSuggestionServiceSettings settings) throws IOException
      Constructs an instance of BrandSuggestionServiceClient, 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

    • BrandSuggestionServiceClient

      protected BrandSuggestionServiceClient(BrandSuggestionServiceStub stub)

  • Method Details

    • create

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

    • create

      public static final BrandSuggestionServiceClient create(BrandSuggestionServiceSettings settings) throws IOException
      Constructs an instance of BrandSuggestionServiceClient, 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 BrandSuggestionServiceClient create(BrandSuggestionServiceStub stub)
      Constructs an instance of BrandSuggestionServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(BrandSuggestionServiceSettings).

    • getSettings

      public final BrandSuggestionServiceSettings getSettings()

    • getStub

      public BrandSuggestionServiceStub getStub()

    • suggestBrands

      public final SuggestBrandsResponse suggestBrands(String customerId, String brandPrefix)
      Rpc to return a list of matching brands based on a prefix for this customer.

      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 (BrandSuggestionServiceClient brandSuggestionServiceClient =
     BrandSuggestionServiceClient.create()) {
   String customerId = "customerId-1581184615";
   String brandPrefix = "brandPrefix-774313735";
   SuggestBrandsResponse response =
       brandSuggestionServiceClient.suggestBrands(customerId, brandPrefix);
 }
      Parameters:
      customerId - Required. The ID of the customer onto which to apply the brand suggestion operation.
      brandPrefix - Required. The prefix of a brand name.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails

    • suggestBrands

      public final SuggestBrandsResponse suggestBrands(SuggestBrandsRequest request)
      Rpc to return a list of matching brands based on a prefix for this customer.

      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 (BrandSuggestionServiceClient brandSuggestionServiceClient =
     BrandSuggestionServiceClient.create()) {
   SuggestBrandsRequest request =
       SuggestBrandsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setBrandPrefix("brandPrefix-774313735")
           .addAllSelectedBrands(new ArrayList<String>())
           .build();
   SuggestBrandsResponse response = brandSuggestionServiceClient.suggestBrands(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

    • suggestBrandsCallable

      public final com.google.api.gax.rpc.UnaryCallable<SuggestBrandsRequest,SuggestBrandsResponse> suggestBrandsCallable()
      Rpc to return a list of matching brands based on a prefix for this customer.

      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 (BrandSuggestionServiceClient brandSuggestionServiceClient =
     BrandSuggestionServiceClient.create()) {
   SuggestBrandsRequest request =
       SuggestBrandsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setBrandPrefix("brandPrefix-774313735")
           .addAllSelectedBrands(new ArrayList<String>())
           .build();
   ApiFuture<SuggestBrandsResponse> future =
       brandSuggestionServiceClient.suggestBrandsCallable().futureCall(request);
   // Do something.
   SuggestBrandsResponse 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