REST Resource: accounts.budgetPlans

Resource: BudgetPlan

JSON representation
{
  "name": string,
  "type": enum (Type),
  "title": string,

  // Union field pacing can be only one of the following:
  "monthlyBudget": {
    object (MonthlyBudget)
  },
  "customBudget": {
    object (CustomBudget)
  }
  // End of list of possible types for union field pacing.
}
Fields
name

string

The resource name of the budget plan. Format: accounts/{account}/budgetPlans/{budgetPlan}

type

enum (Type)

Required. Budget plan type.

title

string

Title used to identify the budget plan in the dashboard.

The maximum length is 100 characters.

Union field pacing. Pacing is the rate at which a budget is spent. Waze Ads has two pacing options to control how quickly the budget is spent over time. Monthly pacing sets a budget which renews each month, while custom pacing sets a fixed budget to be spent between two dates. pacing can be only one of the following:
monthlyBudget

object (MonthlyBudget)

A recurring fixed monthly budget.

customBudget

object (CustomBudget)

A series of flights where a fixed sum of money is spent between two dates.

Type

Budget plan type.

Enums
TYPE_UNSPECIFIED Type unspecified.
SEARCH The type used for budget plans associated with SEARCH campaigns.
BILLABLE A budget plan with the cost based on the cost per thousand (CPM) set in a Campaign cpmBid.

MonthlyBudget

A budget which refreshes automatically every month.

JSON representation
{
  "amount": {
    object (Money)
  },
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}
Fields
amount

object (Money)

The maximum spend per month. The budget refreshes automatically every month on the 1st of the month. When the type is SEARCH, don't set this field.

There are restrictions on the minimum and maximum values permitted which depend on the duration and details of the campaign where the budget plan will be used. Use generateRateCard to see the constraints that apply.

startDate

object (Date)

The starting date for a campaign that uses this budget plan. When you create a budget plan, the start date can't be in the past.

If the date is partway through a month, then the amount for that month is pro-rated based on the available time that month.

This field is required for all monthly budgets.

The local time zone of the advertised location or region is used to determine when a campaign should start.

The start date must be within the next year.

endDate

object (Date)

Output only. The end date for a campaign that uses this budget plan.

End dates for monthly pacing are deprecated and no longer supported. This read-only field is populated for reading historical data.

The local time zone of the advertised location or region is used to determine when a campaign should end.

Date

Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:

  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are google.type.TimeOfDay and google.protobuf.Timestamp.

JSON representation
{
  "year": integer,
  "month": integer,
  "day": integer
}
Fields
year

integer

Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

month

integer

Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

day

integer

Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

CustomBudget

A specific amount to be spent between two specified dates.

JSON representation
{
  "flights": [
    {
      object (Flight)
    }
  ]
}
Fields
flights[]

object (Flight)

A budget plan flight specifies a fixed budget to be spent between two dates. Currently you must specify a single flight for all CustomBudget messages. The endDate of the final flight is the end of the budget plan, as well as when the associated campaign stops serving.

Flight

JSON representation
{
  "amount": {
    object (Money)
  },
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}
Fields
amount

object (Money)

Amount to be spent between the startDate and endDate specified in this message. When the type is SEARCH, don't set this field.

There are restrictions on the minimum and maximum values permitted which depend on the details of the campaign where the budget plan will be used. Use generateRateCard to see the constraints that apply.

startDate

object (Date)

The date when a campaign that uses this budget plan starts. This field is required for all flights.

The local time zone of the advertised location or region is used to determine when a campaign should start.

The start date must be within the next year.

endDate

object (Date)

The last date when a campaign that uses this budget plan serves. This field is required for all flights. This date is inclusive, so an endDate of June 11 2013 would serve ads on June 11 2013, but not June 12 2013.

The local time zone of the advertised location or region is used to determine when a campaign should end.

The end date must be within one year of the flight start date.

Methods

create

Creates a new budget plan.

get

Returns the requested budget plan.

list

Lists the budget plans from an account, ordered by name.

patch

Updates an existing budget plan.