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

Class ReservationServiceClient

java.lang.Object
com.google.ads.googleads.v23.services.ReservationServiceClient
All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource, AutoCloseable
@Generated("by gapic-generator-java") public class ReservationServiceClient extends Object implements com.google.api.gax.core.BackgroundResource
Service Description: Service for reservation related operations. This service is not publicly available.

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 (ReservationServiceClient reservationServiceClient = ReservationServiceClient.create()) {
   String customerId = "customerId-1581184615";
   QuoteCampaignsResponse response = reservationServiceClient.quoteCampaigns(customerId);
 }

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

QuoteCampaigns

Proposes quotes for booking campaigns. This request can have a latency of 30 seconds.

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

  • quoteCampaigns(QuoteCampaignsRequest request)

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

  • quoteCampaigns(String customerId)

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

  • quoteCampaignsCallable()

BookCampaigns

Books the requested campaigns. This request can have a latency of 30 seconds.

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

  • bookCampaigns(BookCampaignsRequest request)

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

  • bookCampaigns(String customerId)

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

  • bookCampaignsCallable()

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 ReservationServiceSettings 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
 ReservationServiceSettings reservationServiceSettings =
     ReservationServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ReservationServiceClient reservationServiceClient =
     ReservationServiceClient.create(reservationServiceSettings);

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
 ReservationServiceSettings reservationServiceSettings =
     ReservationServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ReservationServiceClient reservationServiceClient =
     ReservationServiceClient.create(reservationServiceSettings);

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

  • Constructor Details

    • ReservationServiceClient

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

    • ReservationServiceClient

      protected ReservationServiceClient(ReservationServiceStub stub)

  • Method Details

    • create

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

    • create

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

    • getSettings

      public final ReservationServiceSettings getSettings()

    • getStub

      public ReservationServiceStub getStub()

    • quoteCampaigns

      public final QuoteCampaignsResponse quoteCampaigns(String customerId)
      Proposes quotes for booking campaigns. This request can have a latency of 30 seconds.

      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 (ReservationServiceClient reservationServiceClient = ReservationServiceClient.create()) {
   String customerId = "customerId-1581184615";
   QuoteCampaignsResponse response = reservationServiceClient.quoteCampaigns(customerId);
 }
      Parameters:
      customerId - Required. The ID of the customer making the request.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails

    • quoteCampaigns

      public final QuoteCampaignsResponse quoteCampaigns(QuoteCampaignsRequest request)
      Proposes quotes for booking campaigns. This request can have a latency of 30 seconds.

      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 (ReservationServiceClient reservationServiceClient = ReservationServiceClient.create()) {
   QuoteCampaignsRequest request =
       QuoteCampaignsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setOperation(QuoteCampaignsOperation.newBuilder().build())
           .build();
   QuoteCampaignsResponse response = reservationServiceClient.quoteCampaigns(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

    • quoteCampaignsCallable

      public final com.google.api.gax.rpc.UnaryCallable<QuoteCampaignsRequest,QuoteCampaignsResponse> quoteCampaignsCallable()
      Proposes quotes for booking campaigns. This request can have a latency of 30 seconds.

      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 (ReservationServiceClient reservationServiceClient = ReservationServiceClient.create()) {
   QuoteCampaignsRequest request =
       QuoteCampaignsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setOperation(QuoteCampaignsOperation.newBuilder().build())
           .build();
   ApiFuture<QuoteCampaignsResponse> future =
       reservationServiceClient.quoteCampaignsCallable().futureCall(request);
   // Do something.
   QuoteCampaignsResponse response = future.get();
 }

    • bookCampaigns

      public final BookCampaignsResponse bookCampaigns(String customerId)
      Books the requested campaigns. This request can have a latency of 30 seconds.

      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 (ReservationServiceClient reservationServiceClient = ReservationServiceClient.create()) {
   String customerId = "customerId-1581184615";
   BookCampaignsResponse response = reservationServiceClient.bookCampaigns(customerId);
 }
      Parameters:
      customerId - Required. The ID of the customer making the request.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails

    • bookCampaigns

      public final BookCampaignsResponse bookCampaigns(BookCampaignsRequest request)
      Books the requested campaigns. This request can have a latency of 30 seconds.

      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 (ReservationServiceClient reservationServiceClient = ReservationServiceClient.create()) {
   BookCampaignsRequest request =
       BookCampaignsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setOperation(BookCampaignsOperation.newBuilder().build())
           .build();
   BookCampaignsResponse response = reservationServiceClient.bookCampaigns(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

    • bookCampaignsCallable

      public final com.google.api.gax.rpc.UnaryCallable<BookCampaignsRequest,BookCampaignsResponse> bookCampaignsCallable()
      Books the requested campaigns. This request can have a latency of 30 seconds.

      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 (ReservationServiceClient reservationServiceClient = ReservationServiceClient.create()) {
   BookCampaignsRequest request =
       BookCampaignsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setOperation(BookCampaignsOperation.newBuilder().build())
           .build();
   ApiFuture<BookCampaignsResponse> future =
       reservationServiceClient.bookCampaignsCallable().futureCall(request);
   // Do something.
   BookCampaignsResponse 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