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

Class ListInvoicesRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.ExtendableBuilder<com.google.protobuf.GeneratedMessageV3,BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<ListInvoicesRequest.Builder>
com.google.ads.googleads.v23.services.ListInvoicesRequest.Builder
All Implemented Interfaces:
ListInvoicesRequestOrBuilder, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ListInvoicesRequest
public static final class ListInvoicesRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<ListInvoicesRequest.Builder> 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

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Overrides:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ListInvoicesRequest.Builder>

    • clear

      public ListInvoicesRequest.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<ListInvoicesRequest.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<ListInvoicesRequest.Builder>

    • getDefaultInstanceForType

      public ListInvoicesRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

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

    • buildPartial

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

    • clone

      public ListInvoicesRequest.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<ListInvoicesRequest.Builder>

    • setField

      public ListInvoicesRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<ListInvoicesRequest.Builder>

    • clearField

      public ListInvoicesRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ListInvoicesRequest.Builder>

    • clearOneof

      public ListInvoicesRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ListInvoicesRequest.Builder>

    • setRepeatedField

      public ListInvoicesRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListInvoicesRequest.Builder>

    • addRepeatedField

      public ListInvoicesRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListInvoicesRequest.Builder>

    • mergeFrom

      public ListInvoicesRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListInvoicesRequest.Builder>

    • mergeFrom

      public ListInvoicesRequest.Builder mergeFrom(ListInvoicesRequest other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.ExtendableBuilder<com.google.protobuf.GeneratedMessageV3,ListInvoicesRequest.Builder>

    • mergeFrom

      public ListInvoicesRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListInvoicesRequest.Builder>
      Throws:
      IOException

    • 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.

    • setCustomerId

      public ListInvoicesRequest.Builder setCustomerId(String value)
       Required. The ID of the customer to fetch invoices for.
      string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The customerId to set.
      Returns:
      This builder for chaining.

    • clearCustomerId

      public ListInvoicesRequest.Builder clearCustomerId()
       Required. The ID of the customer to fetch invoices for.
      string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.

    • setCustomerIdBytes

      public ListInvoicesRequest.Builder setCustomerIdBytes(com.google.protobuf.ByteString value)
       Required. The ID of the customer to fetch invoices for.
      string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The bytes for customerId to set.
      Returns:
      This builder for chaining.

    • 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.

    • setBillingSetup

      public ListInvoicesRequest.Builder setBillingSetup(String value)
       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];
      Parameters:
      value - The billingSetup to set.
      Returns:
      This builder for chaining.

    • clearBillingSetup

      public ListInvoicesRequest.Builder clearBillingSetup()
       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];
      Returns:
      This builder for chaining.

    • setBillingSetupBytes

      public ListInvoicesRequest.Builder setBillingSetupBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for billingSetup to set.
      Returns:
      This builder for chaining.

    • 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.

    • setIssueYear

      public ListInvoicesRequest.Builder setIssueYear(String value)
       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];
      Parameters:
      value - The issueYear to set.
      Returns:
      This builder for chaining.

    • clearIssueYear

      public ListInvoicesRequest.Builder clearIssueYear()
       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];
      Returns:
      This builder for chaining.

    • setIssueYearBytes

      public ListInvoicesRequest.Builder setIssueYearBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for issueYear to set.
      Returns:
      This builder for chaining.

    • 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.

    • setIssueMonthValue

      public ListInvoicesRequest.Builder setIssueMonthValue(int value)
       Required. The issue month to retrieve invoices.
      .google.ads.googleads.v23.enums.MonthOfYearEnum.MonthOfYear issue_month = 4 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The enum numeric value on the wire for issueMonth to set.
      Returns:
      This builder for chaining.

    • 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.

    • setIssueMonth

      public ListInvoicesRequest.Builder setIssueMonth(MonthOfYearEnum.MonthOfYear value)
       Required. The issue month to retrieve invoices.
      .google.ads.googleads.v23.enums.MonthOfYearEnum.MonthOfYear issue_month = 4 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The issueMonth to set.
      Returns:
      This builder for chaining.

    • clearIssueMonth

      public ListInvoicesRequest.Builder clearIssueMonth()
       Required. The issue month to retrieve invoices.
      .google.ads.googleads.v23.enums.MonthOfYearEnum.MonthOfYear issue_month = 4 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.

    • 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.

    • setIncludeGranularLevelInvoiceDetails

      public ListInvoicesRequest.Builder setIncludeGranularLevelInvoiceDetails(boolean value)
       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];
      Parameters:
      value - The includeGranularLevelInvoiceDetails to set.
      Returns:
      This builder for chaining.

    • clearIncludeGranularLevelInvoiceDetails

      public ListInvoicesRequest.Builder clearIncludeGranularLevelInvoiceDetails()
       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];
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final ListInvoicesRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListInvoicesRequest.Builder>

    • mergeUnknownFields

      public final ListInvoicesRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListInvoicesRequest.Builder>