REST Resource: accounts.budgetPlans

Stay organized with collections Save and categorize content based on your preferences.

Resource: BudgetPlan

JSON representation 
{
  "name": string,
  "type": enum (Type),
  "title": string,
  "createTime": string,
  "updateTime": 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.
createTime

string (Timestamp format)

Output only. Time when this budget plan was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. Time when this budget plan was most recently updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
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)
  }
}
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.

Date

Represents a whole calendar date. All fields are required and must be non-zero.

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

integer

Year of the date. Required.
month

integer

Month of a year. Must be from 1 to 12. Required.
day

integer

Day of a month. Must be from 1 to 31 and valid for the year and month. Required.

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. A single flight must be specified 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.