Method: firstPartyAndPartnerAudiences.list

Собственные аудитории и аудитории партнеров.

Порядок определяется параметром orderBy.

HTTP-запрос

GET https://displayvideo.googleapis.com/v5/firstPartyAndPartnerAudiences

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

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

Параметры
pageSize

integer

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

string

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

string

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

  • FirstPartyAndPartnerAudienceId (по умолчанию)
  • displayName

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

string

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

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

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

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

  • displayName

Примеры:

  • Все собственные аудитории и аудитории партнеров, отображаемое название которых содержит "Google": displayName:"Google".

Длина этого поля не должна превышать 500 символов.

Подробную информацию вы найдете в руководстве по фильтрации запросов LIST.
Обязательно. Идентификатор объекта DV360, в рамках которого выполняется запрос. Запрос LIST возвращает только собственные и партнерские аудитории, доступные объекту DV360, указанному в accessor. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
partnerId

string (int64 format)

Идентификатор партнера, у которого есть доступ к полученным собственным и партнерским аудиториям.
advertiserId

string (int64 format)

Идентификатор рекламодателя, у которого есть доступ к полученным собственным аудиториям и аудиториям партнеров.
Конец взаимоисключающих полей.

Тело запроса

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

Тело ответа

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

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

object (FirstPartyAndPartnerAudience)

Список собственных аудиторий и аудиторий партнеров. Свойства размера аудитории не будут включены.

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

string

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

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

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

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

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