Method: mediaPlanners.list

Отображает список всех учетных записей медиапланировщиков, к которым имеет доступ звонящий.

Для кураторов это позволит получить список всех медиапланеров, принявших условия сотрудничества с кураторами.

В других учетных записях попытка вывести список медиапланеров приведет к ошибке.

HTTP-запрос

GET https://curationpartners.googleapis.com/v1/mediaPlanners

В URL-адресе используется синтаксис транскодирования gRPC .

Параметры запроса

Параметры
pageSize

integer

Максимальное количество возвращаемых медиапланеров. Если не указано, будет возвращено не более 100 медиапланеров. Максимальное значение — 500; значения выше 500 будут принудительно уменьшены до 500.

pageToken

string

Необязательный параметр. Токен, идентифицирующий страницу результатов, которую должен вернуть сервер. Это значение получено из предыдущего вызова mediaPlanners.list в ListMediaPlannersResponse.nextPageToken .

filter

string

Необязательная строка запроса, использующая синтаксис фильтрации списков Cloud API . Поддерживаемые столбцы для фильтрации:

  • name
  • displayName
  • ancestorNames

Текст запроса

Тело запроса должно быть пустым.

Ответный текст

Ответ, содержащий информацию об учетной записи медиапланировщика.

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление 
{
  "mediaPlanners": [
    {
      object (MediaPlanner)
    }
  ],
  "nextPageToken": string
}
Поля
mediaPlanners[]

object ( MediaPlanner )

Список медиапланеров.

nextPageToken

string

Токен, который можно передать при последующем вызове метода mediaPlanners.list для получения следующей страницы результатов в ListMediaPlannersRequest.page_token .

Области полномочий

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/curation-partners

Медиапланнер

Представляет собой аккаунт медиапланера.

JSON-представление 
{
  "accountId": string,
  "name": string,
  "displayName": string,
  "ancestorNames": [
    string
  ]
}
Поля
accountId
(deprecated)

string

Только для вывода. Идентификатор учетной записи медиапланировщика.

name

string

Идентификатор. Уникальное имя ресурса медиапланировщика. Формат: mediaPlanners/{mediaPlannerAccountId} . Может использоваться для фильтрации ответа метода mediaPlanners.list .

displayName

string

Только для вывода. Отображаемое имя медиапланировщика. Может использоваться для фильтрации ответа метода [mediaPlanners.list][google.ads.authorizedbuyers.marketplace.v1main.MediaPlanners.ListMediaPlanners].

ancestorNames[]

string

Только вывод. Имена родительских объектов медиапланировщика. Формат: mediaPlanners/{mediaPlannerAccountId} . Может использоваться для фильтрации ответа метода mediaPlanners.list .