Package com.google.ads.googleads.v18.resources

Interface AccountBudgetOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
AccountBudget, AccountBudget.Builder
public interface AccountBudgetOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getResourceName

      String getResourceName()
       Output only. The resource name of the account-level budget.
 AccountBudget resource names have the form:

 `customers/{customer_id}/accountBudgets/{account_budget_id}`
      string resource_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Returns:
      The resourceName.

    • getResourceNameBytes

      com.google.protobuf.ByteString getResourceNameBytes()
       Output only. The resource name of the account-level budget.
 AccountBudget resource names have the form:

 `customers/{customer_id}/accountBudgets/{account_budget_id}`
      string resource_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for resourceName.

    • hasId

      boolean hasId()
       Output only. The ID of the account-level budget.
      optional int64 id = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the id field is set.

    • getId

      long getId()
       Output only. The ID of the account-level budget.
      optional int64 id = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The id.

    • hasBillingSetup

      boolean hasBillingSetup()
       Output only. The resource name of the billing setup associated with this
 account-level budget.  BillingSetup resource names have the form:

 `customers/{customer_id}/billingSetups/{billing_setup_id}`
      optional string billing_setup = 24 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Returns:
      Whether the billingSetup field is set.

    • getBillingSetup

      String getBillingSetup()
       Output only. The resource name of the billing setup associated with this
 account-level budget.  BillingSetup resource names have the form:

 `customers/{customer_id}/billingSetups/{billing_setup_id}`
      optional string billing_setup = 24 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Returns:
      The billingSetup.

    • getBillingSetupBytes

      com.google.protobuf.ByteString getBillingSetupBytes()
       Output only. The resource name of the billing setup associated with this
 account-level budget.  BillingSetup resource names have the form:

 `customers/{customer_id}/billingSetups/{billing_setup_id}`
      optional string billing_setup = 24 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for billingSetup.

    • getStatusValue

      int getStatusValue()
       Output only. The status of this account-level budget.
      .google.ads.googleads.v18.enums.AccountBudgetStatusEnum.AccountBudgetStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for status.

    • getStatus

      AccountBudgetStatusEnum.AccountBudgetStatus getStatus()
       Output only. The status of this account-level budget.
      .google.ads.googleads.v18.enums.AccountBudgetStatusEnum.AccountBudgetStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The status.

    • hasName

      boolean hasName()
       Output only. The name of the account-level budget.
      optional string name = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the name field is set.

    • getName

      String getName()
       Output only. The name of the account-level budget.
      optional string name = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Output only. The name of the account-level budget.
      optional string name = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for name.

    • hasProposedStartDateTime

      boolean hasProposedStartDateTime()
       Output only. The proposed start time of the account-level budget in
 yyyy-MM-dd HH:mm:ss format.  If a start time type of NOW was proposed,
 this is the time of request.
      optional string proposed_start_date_time = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the proposedStartDateTime field is set.

    • getProposedStartDateTime

      String getProposedStartDateTime()
       Output only. The proposed start time of the account-level budget in
 yyyy-MM-dd HH:mm:ss format.  If a start time type of NOW was proposed,
 this is the time of request.
      optional string proposed_start_date_time = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The proposedStartDateTime.

    • getProposedStartDateTimeBytes

      com.google.protobuf.ByteString getProposedStartDateTimeBytes()
       Output only. The proposed start time of the account-level budget in
 yyyy-MM-dd HH:mm:ss format.  If a start time type of NOW was proposed,
 this is the time of request.
      optional string proposed_start_date_time = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for proposedStartDateTime.

    • hasApprovedStartDateTime

      boolean hasApprovedStartDateTime()
       Output only. The approved start time of the account-level budget in
 yyyy-MM-dd HH:mm:ss format.

 For example, if a new budget is approved after the proposed start time,
 the approved start time is the time of approval.
      optional string approved_start_date_time = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the approvedStartDateTime field is set.

    • getApprovedStartDateTime

      String getApprovedStartDateTime()
       Output only. The approved start time of the account-level budget in
 yyyy-MM-dd HH:mm:ss format.

 For example, if a new budget is approved after the proposed start time,
 the approved start time is the time of approval.
      optional string approved_start_date_time = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The approvedStartDateTime.

    • getApprovedStartDateTimeBytes

      com.google.protobuf.ByteString getApprovedStartDateTimeBytes()
       Output only. The approved start time of the account-level budget in
 yyyy-MM-dd HH:mm:ss format.

 For example, if a new budget is approved after the proposed start time,
 the approved start time is the time of approval.
      optional string approved_start_date_time = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for approvedStartDateTime.

    • getTotalAdjustmentsMicros

      long getTotalAdjustmentsMicros()
       Output only. The total adjustments amount.

 An example of an adjustment is courtesy credits.
      int64 total_adjustments_micros = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The totalAdjustmentsMicros.

    • getAmountServedMicros

      long getAmountServedMicros()
       Output only. The value of Ads that have been served, in micros.

 This includes overdelivery costs, in which case a credit might be
 automatically applied to the budget (see total_adjustments_micros).
      int64 amount_served_micros = 34 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The amountServedMicros.

    • hasPurchaseOrderNumber

      boolean hasPurchaseOrderNumber()
       Output only. A purchase order number is a value that helps users reference
 this budget in their monthly invoices.
      optional string purchase_order_number = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the purchaseOrderNumber field is set.

    • getPurchaseOrderNumber

      String getPurchaseOrderNumber()
       Output only. A purchase order number is a value that helps users reference
 this budget in their monthly invoices.
      optional string purchase_order_number = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The purchaseOrderNumber.

    • getPurchaseOrderNumberBytes

      com.google.protobuf.ByteString getPurchaseOrderNumberBytes()
       Output only. A purchase order number is a value that helps users reference
 this budget in their monthly invoices.
      optional string purchase_order_number = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for purchaseOrderNumber.

    • hasNotes

      boolean hasNotes()
       Output only. Notes associated with the budget.
      optional string notes = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the notes field is set.

    • getNotes

      String getNotes()
       Output only. Notes associated with the budget.
      optional string notes = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The notes.

    • getNotesBytes

      com.google.protobuf.ByteString getNotesBytes()
       Output only. Notes associated with the budget.
      optional string notes = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for notes.

    • hasPendingProposal

      boolean hasPendingProposal()
       Output only. The pending proposal to modify this budget, if applicable.
      .google.ads.googleads.v18.resources.AccountBudget.PendingAccountBudgetProposal pending_proposal = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the pendingProposal field is set.

    • getPendingProposal

      AccountBudget.PendingAccountBudgetProposal getPendingProposal()
       Output only. The pending proposal to modify this budget, if applicable.
      .google.ads.googleads.v18.resources.AccountBudget.PendingAccountBudgetProposal pending_proposal = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The pendingProposal.

    • getPendingProposalOrBuilder

      AccountBudget.PendingAccountBudgetProposalOrBuilder getPendingProposalOrBuilder()
       Output only. The pending proposal to modify this budget, if applicable.
      .google.ads.googleads.v18.resources.AccountBudget.PendingAccountBudgetProposal pending_proposal = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasProposedEndDateTime

      boolean hasProposedEndDateTime()
       Output only. The proposed end time in yyyy-MM-dd HH:mm:ss format.
      string proposed_end_date_time = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the proposedEndDateTime field is set.

    • getProposedEndDateTime

      String getProposedEndDateTime()
       Output only. The proposed end time in yyyy-MM-dd HH:mm:ss format.
      string proposed_end_date_time = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The proposedEndDateTime.

    • getProposedEndDateTimeBytes

      com.google.protobuf.ByteString getProposedEndDateTimeBytes()
       Output only. The proposed end time in yyyy-MM-dd HH:mm:ss format.
      string proposed_end_date_time = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for proposedEndDateTime.

    • hasProposedEndTimeType

      boolean hasProposedEndTimeType()
       Output only. The proposed end time as a well-defined type, for example,
 FOREVER.
      .google.ads.googleads.v18.enums.TimeTypeEnum.TimeType proposed_end_time_type = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the proposedEndTimeType field is set.

    • getProposedEndTimeTypeValue

      int getProposedEndTimeTypeValue()
       Output only. The proposed end time as a well-defined type, for example,
 FOREVER.
      .google.ads.googleads.v18.enums.TimeTypeEnum.TimeType proposed_end_time_type = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for proposedEndTimeType.

    • getProposedEndTimeType

      TimeTypeEnum.TimeType getProposedEndTimeType()
       Output only. The proposed end time as a well-defined type, for example,
 FOREVER.
      .google.ads.googleads.v18.enums.TimeTypeEnum.TimeType proposed_end_time_type = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The proposedEndTimeType.

    • hasApprovedEndDateTime

      boolean hasApprovedEndDateTime()
       Output only. The approved end time in yyyy-MM-dd HH:mm:ss format.
      string approved_end_date_time = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the approvedEndDateTime field is set.

    • getApprovedEndDateTime

      String getApprovedEndDateTime()
       Output only. The approved end time in yyyy-MM-dd HH:mm:ss format.
      string approved_end_date_time = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The approvedEndDateTime.

    • getApprovedEndDateTimeBytes

      com.google.protobuf.ByteString getApprovedEndDateTimeBytes()
       Output only. The approved end time in yyyy-MM-dd HH:mm:ss format.
      string approved_end_date_time = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for approvedEndDateTime.

    • hasApprovedEndTimeType

      boolean hasApprovedEndTimeType()
       Output only. The approved end time as a well-defined type, for example,
 FOREVER.
      .google.ads.googleads.v18.enums.TimeTypeEnum.TimeType approved_end_time_type = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the approvedEndTimeType field is set.

    • getApprovedEndTimeTypeValue

      int getApprovedEndTimeTypeValue()
       Output only. The approved end time as a well-defined type, for example,
 FOREVER.
      .google.ads.googleads.v18.enums.TimeTypeEnum.TimeType approved_end_time_type = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for approvedEndTimeType.

    • getApprovedEndTimeType

      TimeTypeEnum.TimeType getApprovedEndTimeType()
       Output only. The approved end time as a well-defined type, for example,
 FOREVER.
      .google.ads.googleads.v18.enums.TimeTypeEnum.TimeType approved_end_time_type = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The approvedEndTimeType.

    • hasProposedSpendingLimitMicros

      boolean hasProposedSpendingLimitMicros()
       Output only. The proposed spending limit in micros.  One million is
 equivalent to one unit.
      int64 proposed_spending_limit_micros = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the proposedSpendingLimitMicros field is set.

    • getProposedSpendingLimitMicros

      long getProposedSpendingLimitMicros()
       Output only. The proposed spending limit in micros.  One million is
 equivalent to one unit.
      int64 proposed_spending_limit_micros = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The proposedSpendingLimitMicros.

    • hasProposedSpendingLimitType

      boolean hasProposedSpendingLimitType()
       Output only. The proposed spending limit as a well-defined type, for
 example, INFINITE.
      .google.ads.googleads.v18.enums.SpendingLimitTypeEnum.SpendingLimitType proposed_spending_limit_type = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the proposedSpendingLimitType field is set.

    • getProposedSpendingLimitTypeValue

      int getProposedSpendingLimitTypeValue()
       Output only. The proposed spending limit as a well-defined type, for
 example, INFINITE.
      .google.ads.googleads.v18.enums.SpendingLimitTypeEnum.SpendingLimitType proposed_spending_limit_type = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for proposedSpendingLimitType.

    • getProposedSpendingLimitType

      SpendingLimitTypeEnum.SpendingLimitType getProposedSpendingLimitType()
       Output only. The proposed spending limit as a well-defined type, for
 example, INFINITE.
      .google.ads.googleads.v18.enums.SpendingLimitTypeEnum.SpendingLimitType proposed_spending_limit_type = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The proposedSpendingLimitType.

    • hasApprovedSpendingLimitMicros

      boolean hasApprovedSpendingLimitMicros()
       Output only. The approved spending limit in micros.  One million is
 equivalent to one unit.  This will only be populated if the proposed
 spending limit is finite, and will always be greater than or equal to the
 proposed spending limit.
      int64 approved_spending_limit_micros = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the approvedSpendingLimitMicros field is set.

    • getApprovedSpendingLimitMicros

      long getApprovedSpendingLimitMicros()
       Output only. The approved spending limit in micros.  One million is
 equivalent to one unit.  This will only be populated if the proposed
 spending limit is finite, and will always be greater than or equal to the
 proposed spending limit.
      int64 approved_spending_limit_micros = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The approvedSpendingLimitMicros.

    • hasApprovedSpendingLimitType

      boolean hasApprovedSpendingLimitType()
       Output only. The approved spending limit as a well-defined type, for
 example, INFINITE.  This will only be populated if the approved spending
 limit is INFINITE.
      .google.ads.googleads.v18.enums.SpendingLimitTypeEnum.SpendingLimitType approved_spending_limit_type = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the approvedSpendingLimitType field is set.

    • getApprovedSpendingLimitTypeValue

      int getApprovedSpendingLimitTypeValue()
       Output only. The approved spending limit as a well-defined type, for
 example, INFINITE.  This will only be populated if the approved spending
 limit is INFINITE.
      .google.ads.googleads.v18.enums.SpendingLimitTypeEnum.SpendingLimitType approved_spending_limit_type = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for approvedSpendingLimitType.

    • getApprovedSpendingLimitType

      SpendingLimitTypeEnum.SpendingLimitType getApprovedSpendingLimitType()
       Output only. The approved spending limit as a well-defined type, for
 example, INFINITE.  This will only be populated if the approved spending
 limit is INFINITE.
      .google.ads.googleads.v18.enums.SpendingLimitTypeEnum.SpendingLimitType approved_spending_limit_type = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The approvedSpendingLimitType.

    • hasAdjustedSpendingLimitMicros

      boolean hasAdjustedSpendingLimitMicros()
       Output only. The adjusted spending limit in micros.  One million is
 equivalent to one unit.

 If the approved spending limit is finite, the adjusted
 spending limit may vary depending on the types of adjustments applied
 to this budget, if applicable.

 The different kinds of adjustments are described here:
 https://support.google.com/google-ads/answer/1704323

 For example, a debit adjustment reduces how much the account is
 allowed to spend.
      int64 adjusted_spending_limit_micros = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the adjustedSpendingLimitMicros field is set.

    • getAdjustedSpendingLimitMicros

      long getAdjustedSpendingLimitMicros()
       Output only. The adjusted spending limit in micros.  One million is
 equivalent to one unit.

 If the approved spending limit is finite, the adjusted
 spending limit may vary depending on the types of adjustments applied
 to this budget, if applicable.

 The different kinds of adjustments are described here:
 https://support.google.com/google-ads/answer/1704323

 For example, a debit adjustment reduces how much the account is
 allowed to spend.
      int64 adjusted_spending_limit_micros = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The adjustedSpendingLimitMicros.

    • hasAdjustedSpendingLimitType

      boolean hasAdjustedSpendingLimitType()
       Output only. The adjusted spending limit as a well-defined type, for
 example, INFINITE. This will only be populated if the adjusted spending
 limit is INFINITE, which is guaranteed to be true if the approved
 spending limit is INFINITE.
      .google.ads.googleads.v18.enums.SpendingLimitTypeEnum.SpendingLimitType adjusted_spending_limit_type = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the adjustedSpendingLimitType field is set.

    • getAdjustedSpendingLimitTypeValue

      int getAdjustedSpendingLimitTypeValue()
       Output only. The adjusted spending limit as a well-defined type, for
 example, INFINITE. This will only be populated if the adjusted spending
 limit is INFINITE, which is guaranteed to be true if the approved
 spending limit is INFINITE.
      .google.ads.googleads.v18.enums.SpendingLimitTypeEnum.SpendingLimitType adjusted_spending_limit_type = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for adjustedSpendingLimitType.

    • getAdjustedSpendingLimitType

      SpendingLimitTypeEnum.SpendingLimitType getAdjustedSpendingLimitType()
       Output only. The adjusted spending limit as a well-defined type, for
 example, INFINITE. This will only be populated if the adjusted spending
 limit is INFINITE, which is guaranteed to be true if the approved
 spending limit is INFINITE.
      .google.ads.googleads.v18.enums.SpendingLimitTypeEnum.SpendingLimitType adjusted_spending_limit_type = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The adjustedSpendingLimitType.

    • getProposedEndTimeCase

      AccountBudget.ProposedEndTimeCase getProposedEndTimeCase()

    • getApprovedEndTimeCase

      AccountBudget.ApprovedEndTimeCase getApprovedEndTimeCase()

    • getProposedSpendingLimitCase

      AccountBudget.ProposedSpendingLimitCase getProposedSpendingLimitCase()

    • getApprovedSpendingLimitCase

      AccountBudget.ApprovedSpendingLimitCase getApprovedSpendingLimitCase()

    • getAdjustedSpendingLimitCase

      AccountBudget.AdjustedSpendingLimitCase getAdjustedSpendingLimitCase()