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

Class InvoiceServiceClient

java.lang.Object
com.google.ads.googleads.v18.services.InvoiceServiceClient
All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource, AutoCloseable
@Generated("by gapic-generator-java") public class InvoiceServiceClient extends Object implements com.google.api.gax.core.BackgroundResource
Service Description: A service to fetch invoices issued for a billing setup during a given month.

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 (InvoiceServiceClient invoiceServiceClient = InvoiceServiceClient.create()) {
   String customerId = "customerId-1581184615";
   String billingSetup = "billingSetup-1435075390";
   String issueYear = "issueYear184914102";
   MonthOfYearEnum.MonthOfYear issueMonth = MonthOfYearEnum.MonthOfYear.forNumber(0);
   ListInvoicesResponse response =
       invoiceServiceClient.listInvoices(customerId, billingSetup, issueYear, issueMonth);
 }

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

ListInvoices

Returns all invoices associated with a billing setup, for a given month.

List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [InvoiceError]() [QuotaError]() [RequestError]()

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

  • listInvoices(ListInvoicesRequest request)

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

  • listInvoices(String customerId, String billingSetup, String issueYear, MonthOfYearEnum.MonthOfYear issueMonth)

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

  • listInvoicesCallable()

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 InvoiceServiceSettings 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
 InvoiceServiceSettings invoiceServiceSettings =
     InvoiceServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 InvoiceServiceClient invoiceServiceClient = InvoiceServiceClient.create(invoiceServiceSettings);

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
 InvoiceServiceSettings invoiceServiceSettings =
     InvoiceServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 InvoiceServiceClient invoiceServiceClient = InvoiceServiceClient.create(invoiceServiceSettings);

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

  • Constructor Details

    • InvoiceServiceClient

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

    • InvoiceServiceClient

      protected InvoiceServiceClient(InvoiceServiceStub stub)

  • Method Details

    • create

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

    • create

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

    • getSettings

      public final InvoiceServiceSettings getSettings()

    • getStub

      public InvoiceServiceStub getStub()

    • listInvoices

      public final ListInvoicesResponse listInvoices(String customerId, String billingSetup, String issueYear, MonthOfYearEnum.MonthOfYear issueMonth)
      Returns all invoices associated with a billing setup, for a given month.

      List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [InvoiceError]() [QuotaError]() [RequestError]()

      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 (InvoiceServiceClient invoiceServiceClient = InvoiceServiceClient.create()) {
   String customerId = "customerId-1581184615";
   String billingSetup = "billingSetup-1435075390";
   String issueYear = "issueYear184914102";
   MonthOfYearEnum.MonthOfYear issueMonth = MonthOfYearEnum.MonthOfYear.forNumber(0);
   ListInvoicesResponse response =
       invoiceServiceClient.listInvoices(customerId, billingSetup, issueYear, issueMonth);
 }
      Parameters:
      customerId - Required. The ID of the customer to fetch invoices for.
      billingSetup - Required. The billing setup resource name of the requested invoices.

      `customers/{customer_id}/billingSetups/{billing_setup_id}`

      issueYear - Required. The issue year to retrieve invoices, in yyyy format. Only invoices issued in 2019 or later can be retrieved.
      issueMonth - Required. The issue month to retrieve invoices.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails

    • listInvoices

      public final ListInvoicesResponse listInvoices(ListInvoicesRequest request)
      Returns all invoices associated with a billing setup, for a given month.

      List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [InvoiceError]() [QuotaError]() [RequestError]()

      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 (InvoiceServiceClient invoiceServiceClient = InvoiceServiceClient.create()) {
   ListInvoicesRequest request =
       ListInvoicesRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setBillingSetup("billingSetup-1435075390")
           .setIssueYear("issueYear184914102")
           .build();
   ListInvoicesResponse response = invoiceServiceClient.listInvoices(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

    • listInvoicesCallable

      public final com.google.api.gax.rpc.UnaryCallable<ListInvoicesRequest,ListInvoicesResponse> listInvoicesCallable()
      Returns all invoices associated with a billing setup, for a given month.

      List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [InvoiceError]() [QuotaError]() [RequestError]()

      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 (InvoiceServiceClient invoiceServiceClient = InvoiceServiceClient.create()) {
   ListInvoicesRequest request =
       ListInvoicesRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setBillingSetup("billingSetup-1435075390")
           .setIssueYear("issueYear184914102")
           .build();
   ApiFuture<ListInvoicesResponse> future =
       invoiceServiceClient.listInvoicesCallable().futureCall(request);
   // Do something.
   ListInvoicesResponse 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