Method: mediaPlanners.list

Lists all media planner accounts that the caller has access to.

For curators, this will return all media planners that have accepted curator terms.

For other accounts, attempting to list media planners will return an error.

HTTP request

GET https://authorizedbuyersmarketplace.googleapis.com/v1beta/mediaPlanners

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
pageSize

integer

The maximum number of media planners to return. If unspecified, at most 100 media planners will be returned. The maximum value is 500; values above 500 will be coerced to 500.
pageToken

string

A token identifying a page of results the server should return.

This value is received from a previous mediaPlanners.list call in ListMediaPlannersResponse.nextPageToken.
filter

string

Optional query string using the Cloud API list filtering syntax. Supported columns for filtering are:

  • name
  • displayName
  • ancestorNames

Request body

The request body must be empty.

Response body

A response containing media planner account information.

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

JSON representation 
{
  "mediaPlanners": [
    {
      object (MediaPlanner)
    }
  ],
  "nextPageToken": string
}
Fields
mediaPlanners[]

object (MediaPlanner)

List of media planners.
nextPageToken

string

A token which can be passed to a subsequent call to the mediaPlanners.list method to retrieve the next page of results in ListMediaPlannersRequest.pageToken.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/authorized-buyers-marketplace

MediaPlanner

Represents a media planner account.

JSON representation 
{
  "accountId": string,
  "name": string,
  "displayName": string,
  "ancestorNames": [
    string
  ]
}
Fields
accountId
(deprecated)

string

Output only. Account ID of the media planner.
name

string

Identifier. The unique resource name of the media planner. Format: mediaPlanners/{mediaPlannerAccountId} Can be used to filter the response of the mediaPlanners.list method.
displayName

string

Output only. The display name of the media planner. Can be used to filter the response of the mediaPlanners.list method.
ancestorNames[]

string

Output only. The ancestor names of the media planner. Format: mediaPlanners/{mediaPlannerAccountId} Can be used to filter the response of the mediaPlanners.list method.