com.google.ads.googleads.v17.resources.AccountBudgetOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-ads-stubs-v17 Show documentation
Show all versions of google-ads-stubs-v17 Show documentation
Stubs for GAAPI version google-ads-stubs-v17
The newest version!
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/ads/googleads/v17/resources/account_budget.proto
// Protobuf Java Version: 3.25.3
package com.google.ads.googleads.v17.resources;
public interface AccountBudgetOrBuilder extends
// @@protoc_insertion_point(interface_extends:google.ads.googleads.v17.resources.AccountBudget)
com.google.protobuf.MessageOrBuilder {
/**
*
* 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) = { ... }
* @return The resourceName.
*/
java.lang.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) = { ... }
* @return The bytes for resourceName.
*/
com.google.protobuf.ByteString
getResourceNameBytes();
/**
*
* Output only. The ID of the account-level budget.
*
*
* optional int64 id = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return Whether the id field is set.
*/
boolean hasId();
/**
*
* Output only. The ID of the account-level budget.
*
*
* optional int64 id = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return The id.
*/
long getId();
/**
*
* 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) = { ... }
* @return Whether the billingSetup field is set.
*/
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) = { ... }
* @return The billingSetup.
*/
java.lang.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) = { ... }
* @return The bytes for billingSetup.
*/
com.google.protobuf.ByteString
getBillingSetupBytes();
/**
*
* Output only. The status of this account-level budget.
*
*
* .google.ads.googleads.v17.enums.AccountBudgetStatusEnum.AccountBudgetStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return The enum numeric value on the wire for status.
*/
int getStatusValue();
/**
*
* Output only. The status of this account-level budget.
*
*
* .google.ads.googleads.v17.enums.AccountBudgetStatusEnum.AccountBudgetStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return The status.
*/
com.google.ads.googleads.v17.enums.AccountBudgetStatusEnum.AccountBudgetStatus getStatus();
/**
*
* Output only. The name of the account-level budget.
*
*
* optional string name = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return Whether the name field is set.
*/
boolean hasName();
/**
*
* Output only. The name of the account-level budget.
*
*
* optional string name = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return The name.
*/
java.lang.String getName();
/**
*
* Output only. The name of the account-level budget.
*
*
* optional string name = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return The bytes for name.
*/
com.google.protobuf.ByteString
getNameBytes();
/**
*
* 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];
* @return Whether the proposedStartDateTime field is set.
*/
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];
* @return The proposedStartDateTime.
*/
java.lang.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];
* @return The bytes for proposedStartDateTime.
*/
com.google.protobuf.ByteString
getProposedStartDateTimeBytes();
/**
*
* 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];
* @return Whether the approvedStartDateTime field is set.
*/
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];
* @return The approvedStartDateTime.
*/
java.lang.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];
* @return The bytes for approvedStartDateTime.
*/
com.google.protobuf.ByteString
getApprovedStartDateTimeBytes();
/**
*
* 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];
* @return The totalAdjustmentsMicros.
*/
long getTotalAdjustmentsMicros();
/**
*
* 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];
* @return The amountServedMicros.
*/
long getAmountServedMicros();
/**
*
* 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];
* @return Whether the purchaseOrderNumber field is set.
*/
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];
* @return The purchaseOrderNumber.
*/
java.lang.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];
* @return The bytes for purchaseOrderNumber.
*/
com.google.protobuf.ByteString
getPurchaseOrderNumberBytes();
/**
*
* Output only. Notes associated with the budget.
*
*
* optional string notes = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return Whether the notes field is set.
*/
boolean hasNotes();
/**
*
* Output only. Notes associated with the budget.
*
*
* optional string notes = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return The notes.
*/
java.lang.String getNotes();
/**
*
* Output only. Notes associated with the budget.
*
*
* optional string notes = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return The bytes for notes.
*/
com.google.protobuf.ByteString
getNotesBytes();
/**
*
* Output only. The pending proposal to modify this budget, if applicable.
*
*
* .google.ads.googleads.v17.resources.AccountBudget.PendingAccountBudgetProposal pending_proposal = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return Whether the pendingProposal field is set.
*/
boolean hasPendingProposal();
/**
*
* Output only. The pending proposal to modify this budget, if applicable.
*
*
* .google.ads.googleads.v17.resources.AccountBudget.PendingAccountBudgetProposal pending_proposal = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return The pendingProposal.
*/
com.google.ads.googleads.v17.resources.AccountBudget.PendingAccountBudgetProposal getPendingProposal();
/**
*
* Output only. The pending proposal to modify this budget, if applicable.
*
*
* .google.ads.googleads.v17.resources.AccountBudget.PendingAccountBudgetProposal pending_proposal = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
*/
com.google.ads.googleads.v17.resources.AccountBudget.PendingAccountBudgetProposalOrBuilder getPendingProposalOrBuilder();
/**
*
* 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];
* @return Whether the proposedEndDateTime field is set.
*/
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];
* @return The proposedEndDateTime.
*/
java.lang.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];
* @return The bytes for proposedEndDateTime.
*/
com.google.protobuf.ByteString
getProposedEndDateTimeBytes();
/**
*
* Output only. The proposed end time as a well-defined type, for example,
* FOREVER.
*
*
* .google.ads.googleads.v17.enums.TimeTypeEnum.TimeType proposed_end_time_type = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return Whether the proposedEndTimeType field is set.
*/
boolean hasProposedEndTimeType();
/**
*
* Output only. The proposed end time as a well-defined type, for example,
* FOREVER.
*
*
* .google.ads.googleads.v17.enums.TimeTypeEnum.TimeType proposed_end_time_type = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return The enum numeric value on the wire for proposedEndTimeType.
*/
int getProposedEndTimeTypeValue();
/**
*
* Output only. The proposed end time as a well-defined type, for example,
* FOREVER.
*
*
* .google.ads.googleads.v17.enums.TimeTypeEnum.TimeType proposed_end_time_type = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return The proposedEndTimeType.
*/
com.google.ads.googleads.v17.enums.TimeTypeEnum.TimeType getProposedEndTimeType();
/**
*
* 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];
* @return Whether the approvedEndDateTime field is set.
*/
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];
* @return The approvedEndDateTime.
*/
java.lang.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];
* @return The bytes for approvedEndDateTime.
*/
com.google.protobuf.ByteString
getApprovedEndDateTimeBytes();
/**
*
* Output only. The approved end time as a well-defined type, for example,
* FOREVER.
*
*
* .google.ads.googleads.v17.enums.TimeTypeEnum.TimeType approved_end_time_type = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return Whether the approvedEndTimeType field is set.
*/
boolean hasApprovedEndTimeType();
/**
*
* Output only. The approved end time as a well-defined type, for example,
* FOREVER.
*
*
* .google.ads.googleads.v17.enums.TimeTypeEnum.TimeType approved_end_time_type = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return The enum numeric value on the wire for approvedEndTimeType.
*/
int getApprovedEndTimeTypeValue();
/**
*
* Output only. The approved end time as a well-defined type, for example,
* FOREVER.
*
*
* .google.ads.googleads.v17.enums.TimeTypeEnum.TimeType approved_end_time_type = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return The approvedEndTimeType.
*/
com.google.ads.googleads.v17.enums.TimeTypeEnum.TimeType getApprovedEndTimeType();
/**
*
* 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];
* @return Whether the proposedSpendingLimitMicros field is set.
*/
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];
* @return The proposedSpendingLimitMicros.
*/
long getProposedSpendingLimitMicros();
/**
*
* Output only. The proposed spending limit as a well-defined type, for
* example, INFINITE.
*
*
* .google.ads.googleads.v17.enums.SpendingLimitTypeEnum.SpendingLimitType proposed_spending_limit_type = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return Whether the proposedSpendingLimitType field is set.
*/
boolean hasProposedSpendingLimitType();
/**
*
* Output only. The proposed spending limit as a well-defined type, for
* example, INFINITE.
*
*
* .google.ads.googleads.v17.enums.SpendingLimitTypeEnum.SpendingLimitType proposed_spending_limit_type = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return The enum numeric value on the wire for proposedSpendingLimitType.
*/
int getProposedSpendingLimitTypeValue();
/**
*
* Output only. The proposed spending limit as a well-defined type, for
* example, INFINITE.
*
*
* .google.ads.googleads.v17.enums.SpendingLimitTypeEnum.SpendingLimitType proposed_spending_limit_type = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return The proposedSpendingLimitType.
*/
com.google.ads.googleads.v17.enums.SpendingLimitTypeEnum.SpendingLimitType getProposedSpendingLimitType();
/**
*
* 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];
* @return Whether the approvedSpendingLimitMicros field is set.
*/
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];
* @return The approvedSpendingLimitMicros.
*/
long getApprovedSpendingLimitMicros();
/**
*
* 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.v17.enums.SpendingLimitTypeEnum.SpendingLimitType approved_spending_limit_type = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return Whether the approvedSpendingLimitType field is set.
*/
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.v17.enums.SpendingLimitTypeEnum.SpendingLimitType approved_spending_limit_type = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return The enum numeric value on the wire for approvedSpendingLimitType.
*/
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.v17.enums.SpendingLimitTypeEnum.SpendingLimitType approved_spending_limit_type = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return The approvedSpendingLimitType.
*/
com.google.ads.googleads.v17.enums.SpendingLimitTypeEnum.SpendingLimitType getApprovedSpendingLimitType();
/**
*
* 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];
* @return Whether the adjustedSpendingLimitMicros field is set.
*/
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];
* @return The adjustedSpendingLimitMicros.
*/
long getAdjustedSpendingLimitMicros();
/**
*
* 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.v17.enums.SpendingLimitTypeEnum.SpendingLimitType adjusted_spending_limit_type = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return Whether the adjustedSpendingLimitType field is set.
*/
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.v17.enums.SpendingLimitTypeEnum.SpendingLimitType adjusted_spending_limit_type = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return The enum numeric value on the wire for adjustedSpendingLimitType.
*/
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.v17.enums.SpendingLimitTypeEnum.SpendingLimitType adjusted_spending_limit_type = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return The adjustedSpendingLimitType.
*/
com.google.ads.googleads.v17.enums.SpendingLimitTypeEnum.SpendingLimitType getAdjustedSpendingLimitType();
com.google.ads.googleads.v17.resources.AccountBudget.ProposedEndTimeCase getProposedEndTimeCase();
com.google.ads.googleads.v17.resources.AccountBudget.ApprovedEndTimeCase getApprovedEndTimeCase();
com.google.ads.googleads.v17.resources.AccountBudget.ProposedSpendingLimitCase getProposedSpendingLimitCase();
com.google.ads.googleads.v17.resources.AccountBudget.ApprovedSpendingLimitCase getApprovedSpendingLimitCase();
com.google.ads.googleads.v17.resources.AccountBudget.AdjustedSpendingLimitCase getAdjustedSpendingLimitCase();
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy