Method: inventorySources.list
Перечисляет источники инвентаря, доступные текущему пользователю.
Порядок определяется параметром orderBy
. Если filter
entityStatus
не указан, источники инвентаря со статусом сущности ENTITY_STATUS_ARCHIVED
не будут включены в результаты.
HTTP-запрос
GET https://displayvideo.googleapis.com/v3/inventorySources
URL-адрес использует синтаксис транскодирования gRPC .
Параметры запроса
Параметры |
---|
pageSize | integer Запрошенный размер страницы. Должно быть от 1 до 200 . Если не указано, по умолчанию будет 100 . |
pageToken | string Токен, идентифицирующий страницу результатов, которую должен вернуть сервер. Обычно это значение nextPageToken , возвращенное из предыдущего вызова метода inventorySources.list . Если не указано, будет возвращена первая страница результатов. |
orderBy | string Поле, по которому сортируется список. Приемлемые значения: -
displayName (по умолчанию)
По умолчанию порядок сортировки — по возрастанию. Чтобы указать порядок убывания поля, к имени поля следует добавить суффикс «desc». Например, displayName desc . |
filter | string Позволяет фильтровать по полям источника инвентаря. Поддерживаемый синтаксис: - Выражения фильтра состоят из одного или нескольких ограничений.
- Ограничения могут объединяться логическими операторами
AND или OR . Последовательность ограничений неявно использует AND . - Ограничение имеет форму
{field} {operator} {value} . - Во всех полях должен использоваться оператор
EQUALS (=) .
Поддерживаемые поля: -
status.entityStatus -
commitment -
deliveryMethod -
rateDetails.rateType -
exchange
Примеры: - Все активные источники инвентаря:
status.entityStatus="ENTITY_STATUS_ACTIVE" - Источники инвентаря, принадлежащие Google Ad Manager или биржам Rubicon:
exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"
Длина этого поля не должна превышать 500 символов. Дополнительную информацию можно найти в нашем руководстве по запросам фильтров LIST . |
accessor параметру объединения. Необходимый. Определяет, в рамках какого объекта DV360 делается запрос. Запрос LIST вернет только те объекты источника ресурсов, которые доступны объекту DV360, указанному в accessor . accessor может быть только одним из следующих: |
partnerId | string ( int64 format) Идентификатор партнера, имеющего доступ к источнику инвентаря. |
advertiserId | string ( int64 format) Идентификатор рекламодателя, имеющего доступ к источнику инвентаря. |
Тело запроса
Тело запроса должно быть пустым.
Тело ответа
В случае успеха тело ответа содержит данные следующей структуры:
JSON-представление |
---|
{
"inventorySources": [
{
object (InventorySource )
}
],
"nextPageToken": string
} |
Поля |
---|
inventorySources[] | object ( InventorySource ) Список источников инвентаризации. Этот список будет отсутствовать, если он пуст. |
nextPageToken | string Токен для получения следующей страницы результатов. Передайте это значение в поле pageToken при последующем вызове метода inventorySources.list , чтобы получить следующую страницу результатов. |
Области авторизации
Требуется следующая область действия OAuth:
-
https://www.googleapis.com/auth/display-video
Для получения дополнительной информации см.OAuth 2.0 Overview .
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2025-02-25 UTC.
[null,null,["Последнее обновление: 2025-02-25 UTC."],[[["Lists inventory sources accessible to the current user, ordered by `orderBy` parameter and excluding archived sources unless filtered."],["Supports pagination with `pageSize` and `pageToken` for retrieving results in manageable chunks."],["Offers filtering options using the `filter` parameter for refining results based on entity status, commitment, delivery method, rate type, or exchange."],["Requires specifying an `accessor` (either `partnerId` or `advertiserId`) to identify the DV360 entity for access control."],["Uses `GET` request to `https://displayvideo.googleapis.com/v3/inventorySources` and requires `https://www.googleapis.com/auth/display-video` authorization scope."]]],["This API lists accessible inventory sources for a user via a `GET` request to `https://displayvideo.googleapis.com/v3/inventorySources`. Key parameters include `pageSize`, `pageToken`, `orderBy` for sorting, and `filter` for filtering by fields like `entityStatus`, `commitment`, or `exchange`. The request body must be empty. The response includes a list of inventory sources and a `nextPageToken` for pagination. The call requires authorization scope: `https://www.googleapis.com/auth/display-video`. A union parameter called `accessor` is required to identify the DV360 entity the request is being made from.\n"]]