Package com.google.ads.googleads.v23.services

Class IncentiveServiceClient

java.lang.Object
com.google.ads.googleads.v23.services.IncentiveServiceClient
All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource, AutoCloseable
@Generated("by gapic-generator-java") public class IncentiveServiceClient extends Object implements com.google.api.gax.core.BackgroundResource
Service Description: Service to support incentive related operations.

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 (IncentiveServiceClient incentiveServiceClient = IncentiveServiceClient.create()) {
   FetchIncentiveRequest request =
       FetchIncentiveRequest.newBuilder()
           .setLanguageCode("languageCode-2092349083")
           .setCountryCode("countryCode-1477067101")
           .setEmail("email96619420")
           .build();
   FetchIncentiveResponse response = incentiveServiceClient.fetchIncentive(request);
 }

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

FetchIncentive

Returns incentives for a given user.

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

  • fetchIncentive(FetchIncentiveRequest request)

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

  • fetchIncentiveCallable()

ApplyIncentive

Applies the incentive for the ads customer.

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

  • applyIncentive(ApplyIncentiveRequest request)

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

  • applyIncentive(String countryCode)

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

  • applyIncentiveCallable()

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 IncentiveServiceSettings 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
 IncentiveServiceSettings incentiveServiceSettings =
     IncentiveServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 IncentiveServiceClient incentiveServiceClient =
     IncentiveServiceClient.create(incentiveServiceSettings);

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
 IncentiveServiceSettings incentiveServiceSettings =
     IncentiveServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 IncentiveServiceClient incentiveServiceClient =
     IncentiveServiceClient.create(incentiveServiceSettings);

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

  • Constructor Details

    • IncentiveServiceClient

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

    • IncentiveServiceClient

      protected IncentiveServiceClient(IncentiveServiceStub stub)

  • Method Details

    • create

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

    • create

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

    • getSettings

      public final IncentiveServiceSettings getSettings()

    • getStub

      public IncentiveServiceStub getStub()

    • fetchIncentive

      public final FetchIncentiveResponse fetchIncentive(FetchIncentiveRequest request)
      Returns incentives for a given user.

      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 (IncentiveServiceClient incentiveServiceClient = IncentiveServiceClient.create()) {
   FetchIncentiveRequest request =
       FetchIncentiveRequest.newBuilder()
           .setLanguageCode("languageCode-2092349083")
           .setCountryCode("countryCode-1477067101")
           .setEmail("email96619420")
           .build();
   FetchIncentiveResponse response = incentiveServiceClient.fetchIncentive(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

    • fetchIncentiveCallable

      public final com.google.api.gax.rpc.UnaryCallable<FetchIncentiveRequest,FetchIncentiveResponse> fetchIncentiveCallable()
      Returns incentives for a given user.

      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 (IncentiveServiceClient incentiveServiceClient = IncentiveServiceClient.create()) {
   FetchIncentiveRequest request =
       FetchIncentiveRequest.newBuilder()
           .setLanguageCode("languageCode-2092349083")
           .setCountryCode("countryCode-1477067101")
           .setEmail("email96619420")
           .build();
   ApiFuture<FetchIncentiveResponse> future =
       incentiveServiceClient.fetchIncentiveCallable().futureCall(request);
   // Do something.
   FetchIncentiveResponse response = future.get();
 }

    • applyIncentive

      public final ApplyIncentiveResponse applyIncentive(String countryCode)
      Applies the incentive for the ads 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 (IncentiveServiceClient incentiveServiceClient = IncentiveServiceClient.create()) {
   String countryCode = "countryCode-1477067101";
   ApplyIncentiveResponse response = incentiveServiceClient.applyIncentive(countryCode);
 }
      Parameters:
      countryCode - Required. User's country code. Required. This field must be equal to the Google Ads account's billing country. Incentive eligibility, terms of service, and reward values are often country-specific. This country code is used to ensure the selected incentive is applicable to the user. Possible country codes: https://developers.google.com/google-ads/api/data/codes-formats#country_codes
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails

    • applyIncentive

      public final ApplyIncentiveResponse applyIncentive(ApplyIncentiveRequest request)
      Applies the incentive for the ads 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 (IncentiveServiceClient incentiveServiceClient = IncentiveServiceClient.create()) {
   ApplyIncentiveRequest request =
       ApplyIncentiveRequest.newBuilder()
           .setSelectedIncentiveId(1678975891)
           .setCustomerId("customerId-1581184615")
           .setCountryCode("countryCode-1477067101")
           .build();
   ApplyIncentiveResponse response = incentiveServiceClient.applyIncentive(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

    • applyIncentiveCallable

      public final com.google.api.gax.rpc.UnaryCallable<ApplyIncentiveRequest,ApplyIncentiveResponse> applyIncentiveCallable()
      Applies the incentive for the ads 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 (IncentiveServiceClient incentiveServiceClient = IncentiveServiceClient.create()) {
   ApplyIncentiveRequest request =
       ApplyIncentiveRequest.newBuilder()
           .setSelectedIncentiveId(1678975891)
           .setCustomerId("customerId-1581184615")
           .setCountryCode("countryCode-1477067101")
           .build();
   ApiFuture<ApplyIncentiveResponse> future =
       incentiveServiceClient.applyIncentiveCallable().futureCall(request);
   // Do something.
   ApplyIncentiveResponse 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