Method: accounts.budgetPlans.list

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

HTTP request

GET https://ads.wazeapis.com/v1/{parent=accounts/*}/budgetPlans

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The name of the account that owns this collection of budget plans.

Query parameters

Parameters
pageSize

integer

The maximum number of budget plans to return. The service might return fewer than this value. If unspecified, at most 50 budget plans are returned. The maximum value is 1000; values above 1000 are coerced to 1000.

pageToken

string

A page token, received from a previous budgetPlans.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to budgetPlans.list must match the call that provided the page token.

The token will expire and is not guaranteed to work indefinitely.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

JSON representation
{
  "budgetPlans": [
    {
      object (BudgetPlan)
    }
  ],
  "nextPageToken": string,
  "totalSize": string
}
Fields
budgetPlans[]

object (BudgetPlan)

The BudgetPlan resources from the specified account.

nextPageToken

string

A token that can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

totalSize

string (int64 format)

The total number of budget plans in the specified account.