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

Class ListInvoicesRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.ads.googleads.v23.services.ListInvoicesRequest
All Implemented Interfaces:
ListInvoicesRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class ListInvoicesRequest extends com.google.protobuf.GeneratedMessage implements ListInvoicesRequestOrBuilder
 Request message for fetching the invoices of a given billing setup that were
 issued during a given month.
Protobuf type google.ads.googleads.v23.services.ListInvoicesRequest
See Also:

  • Field Details

    • CUSTOMER_ID_FIELD_NUMBER

      public static final int CUSTOMER_ID_FIELD_NUMBER
      See Also:

    • BILLING_SETUP_FIELD_NUMBER

      public static final int BILLING_SETUP_FIELD_NUMBER
      See Also:

    • ISSUE_YEAR_FIELD_NUMBER

      public static final int ISSUE_YEAR_FIELD_NUMBER
      See Also:

    • ISSUE_MONTH_FIELD_NUMBER

      public static final int ISSUE_MONTH_FIELD_NUMBER
      See Also:

    • INCLUDE_GRANULAR_LEVEL_INVOICE_DETAILS_FIELD_NUMBER

      public static final int INCLUDE_GRANULAR_LEVEL_INVOICE_DETAILS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getCustomerId

      public String getCustomerId()
       Required. The ID of the customer to fetch invoices for.
      string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getCustomerId in interface ListInvoicesRequestOrBuilder
      Returns:
      The customerId.

    • getCustomerIdBytes

      public com.google.protobuf.ByteString getCustomerIdBytes()
       Required. The ID of the customer to fetch invoices for.
      string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getCustomerIdBytes in interface ListInvoicesRequestOrBuilder
      Returns:
      The bytes for customerId.

    • getBillingSetup

      public String getBillingSetup()
       Required. The billing setup resource name of the requested invoices.

 `customers/{customer_id}/billingSetups/{billing_setup_id}`
      string billing_setup = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getBillingSetup in interface ListInvoicesRequestOrBuilder
      Returns:
      The billingSetup.

    • getBillingSetupBytes

      public com.google.protobuf.ByteString getBillingSetupBytes()
       Required. The billing setup resource name of the requested invoices.

 `customers/{customer_id}/billingSetups/{billing_setup_id}`
      string billing_setup = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getBillingSetupBytes in interface ListInvoicesRequestOrBuilder
      Returns:
      The bytes for billingSetup.

    • getIssueYear

      public String getIssueYear()
       Required. The issue year to retrieve invoices, in yyyy format. Only
 invoices issued in 2019 or later can be retrieved.
      string issue_year = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getIssueYear in interface ListInvoicesRequestOrBuilder
      Returns:
      The issueYear.

    • getIssueYearBytes

      public com.google.protobuf.ByteString getIssueYearBytes()
       Required. The issue year to retrieve invoices, in yyyy format. Only
 invoices issued in 2019 or later can be retrieved.
      string issue_year = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getIssueYearBytes in interface ListInvoicesRequestOrBuilder
      Returns:
      The bytes for issueYear.

    • getIssueMonthValue

      public int getIssueMonthValue()
       Required. The issue month to retrieve invoices.
      .google.ads.googleads.v23.enums.MonthOfYearEnum.MonthOfYear issue_month = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getIssueMonthValue in interface ListInvoicesRequestOrBuilder
      Returns:
      The enum numeric value on the wire for issueMonth.

    • getIssueMonth

      public MonthOfYearEnum.MonthOfYear getIssueMonth()
       Required. The issue month to retrieve invoices.
      .google.ads.googleads.v23.enums.MonthOfYearEnum.MonthOfYear issue_month = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getIssueMonth in interface ListInvoicesRequestOrBuilder
      Returns:
      The issueMonth.

    • getIncludeGranularLevelInvoiceDetails

      public boolean getIncludeGranularLevelInvoiceDetails()
       Optional. When true, the response will include more granular level invoice
 details such as campaign level cost breakdown, itemized regulatory costs
 and adjustments. The default value is false.
      bool include_granular_level_invoice_details = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getIncludeGranularLevelInvoiceDetails in interface ListInvoicesRequestOrBuilder
      Returns:
      The includeGranularLevelInvoiceDetails.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static ListInvoicesRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListInvoicesRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListInvoicesRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListInvoicesRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListInvoicesRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListInvoicesRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListInvoicesRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ListInvoicesRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ListInvoicesRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ListInvoicesRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ListInvoicesRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ListInvoicesRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public ListInvoicesRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static ListInvoicesRequest.Builder newBuilder()

    • newBuilder

      public static ListInvoicesRequest.Builder newBuilder(ListInvoicesRequest prototype)

    • toBuilder

      public ListInvoicesRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected ListInvoicesRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static ListInvoicesRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ListInvoicesRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<ListInvoicesRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public ListInvoicesRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder