Method: firstPartyAndPartnerAudiences.list

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

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

HTTP-запрос

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

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

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

Параметры
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 .

accessor параметру объединения. Необходимый. Определяет, в рамках какого объекта DV360 делается запрос. Запрос LIST вернет только объекты первой стороны и партнерской аудитории, которые доступны объекту DV360, указанному в accessor . 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 .