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

Class CustomInterestServiceClient

java.lang.Object
com.google.ads.googleads.v18.services.CustomInterestServiceClient
All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource, AutoCloseable
@Generated("by gapic-generator-java") public class CustomInterestServiceClient extends Object implements com.google.api.gax.core.BackgroundResource
Service Description: Service to manage custom interests.

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 (CustomInterestServiceClient customInterestServiceClient =
     CustomInterestServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<CustomInterestOperation> operations = new ArrayList<>();
   MutateCustomInterestsResponse response =
       customInterestServiceClient.mutateCustomInterests(customerId, operations);
 }

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

MutateCustomInterests

Creates or updates custom interests. Operation statuses are returned.

List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CriterionError]() [CustomInterestError]() [HeaderError]() [InternalError]() [MutateError]() [PolicyViolationError]() [QuotaError]() [RequestError]() [StringLengthError]()

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

  • mutateCustomInterests(MutateCustomInterestsRequest request)

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

  • mutateCustomInterests(String customerId, List<CustomInterestOperation> operations)

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

  • mutateCustomInterestsCallable()

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 CustomInterestServiceSettings 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
 CustomInterestServiceSettings customInterestServiceSettings =
     CustomInterestServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CustomInterestServiceClient customInterestServiceClient =
     CustomInterestServiceClient.create(customInterestServiceSettings);

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
 CustomInterestServiceSettings customInterestServiceSettings =
     CustomInterestServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 CustomInterestServiceClient customInterestServiceClient =
     CustomInterestServiceClient.create(customInterestServiceSettings);

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

  • Constructor Details

    • CustomInterestServiceClient

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

    • CustomInterestServiceClient

      protected CustomInterestServiceClient(CustomInterestServiceStub stub)

  • Method Details

    • create

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

    • create

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

    • getSettings

      public final CustomInterestServiceSettings getSettings()

    • getStub

      public CustomInterestServiceStub getStub()

    • mutateCustomInterests

      public final MutateCustomInterestsResponse mutateCustomInterests(String customerId, List<CustomInterestOperation> operations)
      Creates or updates custom interests. Operation statuses are returned.

      List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CriterionError]() [CustomInterestError]() [HeaderError]() [InternalError]() [MutateError]() [PolicyViolationError]() [QuotaError]() [RequestError]() [StringLengthError]()

      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 (CustomInterestServiceClient customInterestServiceClient =
     CustomInterestServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<CustomInterestOperation> operations = new ArrayList<>();
   MutateCustomInterestsResponse response =
       customInterestServiceClient.mutateCustomInterests(customerId, operations);
 }
      Parameters:
      customerId - Required. The ID of the customer whose custom interests are being modified.
      operations - Required. The list of operations to perform on individual custom interests.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails

    • mutateCustomInterests

      public final MutateCustomInterestsResponse mutateCustomInterests(MutateCustomInterestsRequest request)
      Creates or updates custom interests. Operation statuses are returned.

      List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CriterionError]() [CustomInterestError]() [HeaderError]() [InternalError]() [MutateError]() [PolicyViolationError]() [QuotaError]() [RequestError]() [StringLengthError]()

      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 (CustomInterestServiceClient customInterestServiceClient =
     CustomInterestServiceClient.create()) {
   MutateCustomInterestsRequest request =
       MutateCustomInterestsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<CustomInterestOperation>())
           .setValidateOnly(true)
           .build();
   MutateCustomInterestsResponse response =
       customInterestServiceClient.mutateCustomInterests(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

    • mutateCustomInterestsCallable

      public final com.google.api.gax.rpc.UnaryCallable<MutateCustomInterestsRequest,MutateCustomInterestsResponse> mutateCustomInterestsCallable()
      Creates or updates custom interests. Operation statuses are returned.

      List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CriterionError]() [CustomInterestError]() [HeaderError]() [InternalError]() [MutateError]() [PolicyViolationError]() [QuotaError]() [RequestError]() [StringLengthError]()

      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 (CustomInterestServiceClient customInterestServiceClient =
     CustomInterestServiceClient.create()) {
   MutateCustomInterestsRequest request =
       MutateCustomInterestsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<CustomInterestOperation>())
           .setValidateOnly(true)
           .build();
   ApiFuture<MutateCustomInterestsResponse> future =
       customInterestServiceClient.mutateCustomInterestsCallable().futureCall(request);
   // Do something.
   MutateCustomInterestsResponse 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