Method: advertisers.adAssets.list

Возвращает список объектов объявлений, связанных с идентификатором рекламодателя.

Поддерживается только получение объектов AdAssetType AD_ASSET_TYPE_YOUTUBE_VIDEO.

HTTP-запрос

GET https://displayvideo.googleapis.com/v5/advertisers/{advertiserId}/adAssets

URL имеет синтаксис gRPC Transcoding.

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

Параметры
advertiserId

string (int64 format)

Обязательно. Идентификатор рекламодателя, которому принадлежат объекты объявлений.

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

Параметры
pageSize

integer

Необязательное поле. Запрошенный размер страницы. Значение должно быть в диапазоне от 1 до 5000. Если не указано, по умолчанию будет использоваться 5000. Если указано недопустимое значение, возвращается код ошибки INVALID_ARGUMENT.
pageToken

string

Необязательное поле. Токен, идентифицирующий страницу результатов, которую должен вернуть сервер. Обычно это значение nextPageToken, возвращенное предыдущим вызовом метода adAssets.list. Если значение не указано, будет возвращена первая страница результатов.
orderBy

string

Необязательное поле. Поле, по которому нужно отсортировать список. Допустимые значения:

  • entityStatus
  • youtubeVideoAsset.youtubeVideoId
  • adAssetId (по умолчанию)

По умолчанию используется порядок сортировки по возрастанию. Чтобы указать порядок по убыванию, добавьте к названию поля суффикс desc. Пример: adAssetId desc.
filter

string

Необязательное поле. Позволяет фильтровать результаты по полям объектов объявлений.

Поддерживаемый синтаксис:

  • Ограничение имеет следующий формат: {field} {operator} {value}.
  • Во всех полях должен использоваться оператор EQUALS (=).

Поддерживаемые поля:

  • youtubeVideoAsset.youtubeVideoId
  • entityStatus

Примеры:

  • Все активные объекты видеообъявлений YouTube, относящиеся к рекламодателю: entityStatus=ENTITY_STATUS_ACTIVE

Тело запроса

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

Тело ответа

Ответное сообщение для adAssets.list.

Ниже приведена структура данных в ответе, полученном на запрос.

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

object (AdAsset)

Список объектов объявлений. В списке будут только объекты типа AdAssetType AD_ASSET_TYPE_YOUTUBE_VIDEO.

Если список пуст, он не будет показан.
nextPageToken

string

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

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

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

  • https://www.googleapis.com/auth/display-video

Дополнительную информацию вы найдете в OAuth 2.0 Overview.