Package com.google.ads.googleads.v22.services

Class GoalServiceClient

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

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 (GoalServiceClient goalServiceClient = GoalServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<GoalOperation> operations = new ArrayList<>();
   MutateGoalsResponse response = goalServiceClient.mutateGoals(customerId, operations);
 }

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

MutateGoals

Create or update goals.

List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]() [GoalError]() [GoalServicesError]()

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

  • mutateGoals(MutateGoalsRequest request)

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

  • mutateGoals(String customerId, List<GoalOperation> operations)

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

  • mutateGoalsCallable()

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 GoalServiceSettings 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
 GoalServiceSettings goalServiceSettings =
     GoalServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 GoalServiceClient goalServiceClient = GoalServiceClient.create(goalServiceSettings);

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
 GoalServiceSettings goalServiceSettings =
     GoalServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 GoalServiceClient goalServiceClient = GoalServiceClient.create(goalServiceSettings);

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

  • Constructor Details

    • GoalServiceClient

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

    • GoalServiceClient

      protected GoalServiceClient(GoalServiceStub stub)

  • Method Details

    • create

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

    • create

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

    • getSettings

      public final GoalServiceSettings getSettings()

    • getStub

      public GoalServiceStub getStub()

    • mutateGoals

      public final MutateGoalsResponse mutateGoals(String customerId, List<GoalOperation> operations)
      Create or update goals.

      List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]() [GoalError]() [GoalServicesError]()

      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 (GoalServiceClient goalServiceClient = GoalServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<GoalOperation> operations = new ArrayList<>();
   MutateGoalsResponse response = goalServiceClient.mutateGoals(customerId, operations);
 }
      Parameters:
      customerId - Required. The ID of the customer whose goals are being modified.
      operations - Required. The list of operations to perform on the goals.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails

    • mutateGoals

      public final MutateGoalsResponse mutateGoals(MutateGoalsRequest request)
      Create or update goals.

      List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]() [GoalError]() [GoalServicesError]()

      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 (GoalServiceClient goalServiceClient = GoalServiceClient.create()) {
   MutateGoalsRequest request =
       MutateGoalsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<GoalOperation>())
           .setPartialFailure(true)
           .setValidateOnly(true)
           .build();
   MutateGoalsResponse response = goalServiceClient.mutateGoals(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

    • mutateGoalsCallable

      public final com.google.api.gax.rpc.UnaryCallable<MutateGoalsRequest,MutateGoalsResponse> mutateGoalsCallable()
      Create or update goals.

      List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]() [GoalError]() [GoalServicesError]()

      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 (GoalServiceClient goalServiceClient = GoalServiceClient.create()) {
   MutateGoalsRequest request =
       MutateGoalsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<GoalOperation>())
           .setPartialFailure(true)
           .setValidateOnly(true)
           .build();
   ApiFuture<MutateGoalsResponse> future =
       goalServiceClient.mutateGoalsCallable().futureCall(request);
   // Do something.
   MutateGoalsResponse 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