Method: sellers.adUnits.list

Перечисляет рекламные блоки.

  • Например, GET /v1/sellers/seller111/adUnits.
  • Возвращает список рекламных блоков и токен для получения следующей страницы в случае успеха.
  • Возвращает код ошибки PERMISSION_DENIED если у пользователя нет доступа к продавцу или идентификатор продавца не существует.
  • Возвращает код ошибки INVALID_ARGUMENT если продавцы предоставляют неверный размер страницы или токен страницы.

HTTP-запрос

GET https://dv360outofhomeseller.googleapis.com/v1/{parent=sellers/*}/adUnits

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

Параметры пути

Параметры
parent

string

Необходимый. Продавец, которому принадлежит эта коллекция рекламных блоков. Формат: продавцы/{продавец}

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

Параметры
pageSize

integer

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

pageToken

string

Значение nextPageToken, возвращенное из предыдущего запроса списка, если таковой имеется.

filter

string

Фильтр списка. В настоящее время поддерживается фильтрация внешнего идентификатора и состояния с синтаксисом: «externalId = [EXTERNAL_ID]» и «state = [STATE]». Логические операторы AND и OR можно использовать для объединения фильтров. AD_UNIT_STATE_DELETED нельзя использовать для отображения удаленных рекламных блоков, вместо этого используйте showDeleted.

orderBy

string

Порядок по строке, используемый для указания порядка сортировки результатов. В настоящее время поддерживается упорядочивание по updateTime . Укажите «updateTime», чтобы получить результаты, отсортированные по updateTime в порядке возрастания, или «updateTime desc» для убывания.

showDeleted

boolean

Возвращать ли обратимо удаленные рекламные блоки.

Тело запроса

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

Тело ответа

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

Ответное сообщение для InventoryService.ListAdUnits.

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

object ( AdUnit )

Список рекламных блоков.

nextPageToken

string

Токен для получения следующей страницы результатов. Передайте это значение в поле pageToken при последующем вызове метода adUnits.list , чтобы получить следующую страницу результатов.

Области авторизации

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

  • https://www.googleapis.com/auth/doubleclickbidmanager

Дополнительную информацию см. в обзоре OAuth 2.0 .