REST Resource: inventorySources

Ресурс: InventorySource

Источник инвентаря.

JSON-представление
{
  "name": string,
  "inventorySourceId": string,
  "displayName": string,
  "inventorySourceType": enum (InventorySourceType),
  "inventorySourceProductType": enum (InventorySourceProductType),
  "commitment": enum (InventorySourceCommitment),
  "deliveryMethod": enum (InventorySourceDeliveryMethod),
  "dealId": string,
  "status": {
    object (InventorySourceStatus)
  },
  "exchange": enum (Exchange),
  "updateTime": string,
  "rateDetails": {
    object (RateDetails)
  },
  "publisherName": string,
  "timeRange": {
    object (TimeRange)
  },
  "creativeConfigs": [
    {
      object (CreativeConfig)
    }
  ],
  "subSitePropertyId": string,
  "guaranteedOrderId": string,
  "readWriteAccessors": {
    object (InventorySourceAccessors)
  },
  "readAdvertiserIds": [
    string
  ],
  "readPartnerIds": [
    string
  ]
}
Поля
name

string

Только вывод. Имя ресурса источника инвентаря.

inventorySourceId

string ( int64 format)

Только вывод. Уникальный идентификатор источника инвентаря. Назначается системой.

displayName

string

Отображаемое имя источника инвентаря.

Должен быть в кодировке UTF-8 с максимальным размером 240 байт.

inventorySourceType

enum ( InventorySourceType )

Обозначает тип источника инвентаризации.

inventorySourceProductType

enum ( InventorySourceProductType )

Только вывод. Тип продукта источника запасов, обозначающий способ продажи запасов.

commitment

enum ( InventorySourceCommitment )

Имеет ли источник запасов гарантированную или негарантированную доставку.

deliveryMethod

enum ( InventorySourceDeliveryMethod )

Способ доставки источника инвентаря.

  • Для негарантированных источников запасов единственным приемлемым значением является INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC .
  • Для гарантированных источников инвентаря допустимыми значениями являются INVENTORY_SOURCE_DELIVERY_METHOD_TAG и INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC .
dealId

string

Идентификатор в пространстве обмена, который однозначно идентифицирует источник инвентаря.

Должен быть уникальным для покупателей на каждой бирже, но не обязательно уникальным для разных бирж.

status

object ( InventorySourceStatus )

Настройки статуса источника инвентаря.

exchange

enum ( Exchange )

Биржа, которой принадлежит источник инвентаря.

updateTime

string ( Timestamp format)

Только вывод. Временная метка последнего обновления источника инвентаря. Назначается системой.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

rateDetails

object ( RateDetails )

Необходимый. Сведения о ставке источника инвентаря.

publisherName

string

Имя издателя/продавца источника инвентаря.

timeRange

object ( TimeRange )

Диапазон времени, когда этот источник инвентаря запускается и прекращает обслуживать.

creativeConfigs[]

object ( CreativeConfig )

Творческие требования к источнику инвентаря.

Не применимо к аукционным пакетам.

guaranteedOrderId

string

Неизменный. Идентификатор гарантированного заказа, которому принадлежит этот источник запасов.

Применимо только в том случае, если commitment INVENTORY_SOURCE_COMMITMENT_GUARANTEED .

readWriteAccessors

object ( InventorySourceAccessors )

Партнер или рекламодатели, имеющие доступ для чтения и записи к источнику инвентаря.

Вывод только в том случае, если commitment INVENTORY_SOURCE_COMMITMENT_GUARANTEED , и в этом случае методы доступа чтения/записи наследуются от родительского гарантированного порядка.

Требуется, если commitment INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED .

Если commitment имеет значение INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED и в этом поле указан партнер, все рекламодатели этого партнера автоматически получат доступ только для чтения к источнику ресурсов. Эти рекламодатели не будут включены в readAdvertiserIds .

readAdvertiserIds[]

string ( int64 format)

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

readPartnerIds[]

string ( int64 format)

Только вывод. Идентификаторы партнеров, имеющих доступ только для чтения к источнику ресурсов.

Все рекламодатели партнеров в этом поле наследуют доступ только для чтения к источнику инвентаря.

Тип источника инвентаря

Возможные типы источников инвентаря.

Перечисления
INVENTORY_SOURCE_TYPE_UNSPECIFIED Тип источника инвентаря в этой версии не указан или неизвестен.
INVENTORY_SOURCE_TYPE_PRIVATE Частный источник инвентаря.
INVENTORY_SOURCE_TYPE_AUCTION_PACKAGE Аукционный пакет.

ИнвентарьИсточникТипПродукта

Возможные типы продуктов источника запасов.

Перечисления
INVENTORY_SOURCE_PRODUCT_TYPE_UNSPECIFIED В этой версии тип продукта не указан или неизвестен. Изменение источников инвентаря этого типа продукта не поддерживается через API.
PREFERRED_DEAL Источник инвентаря продает инвентарь через приоритетную сделку.
PRIVATE_AUCTION Источник инвентаря продает инвентарь через частный аукцион.
PROGRAMMATIC_GUARANTEED Источник инвентаря продает инвентарь через гарантированные алгоритмические продажи.
TAG_GUARANTEED Источник инвентаря продает инвентарь через гарантию тегов.
YOUTUBE_RESERVE Источник инвентаря продает инвентарь через YouTube Reserve.
INSTANT_RESERVE Источник инвентаря продает инвентарь через Instant Reserve. Изменение источников инвентаря этого типа продукта не поддерживается через API.
GUARANTEED_PACKAGE Источник инвентаря продает инвентарь через Гарантированный пакет. Изменение источников инвентаря этого типа продукта не поддерживается через API.
PROGRAMMATIC_TV Источник инвентаря продает инвентарь через Programmtic TV. Изменение источников инвентаря этого типа продукта не поддерживается через API.
AUCTION_PACKAGE Источник инвентаря продает инвентарь через пакет аукционов. Изменение источников инвентаря этого типа продукта не поддерживается через API.

Обязательство по инвентаризации

Возможные типы обязательств для источника запасов.

Перечисления
INVENTORY_SOURCE_COMMITMENT_UNSPECIFIED В этой версии обязательство не указано или неизвестно.
INVENTORY_SOURCE_COMMITMENT_GUARANTEED Обязательство гарантирует доставку.
INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED Обязательство является негарантированной доставкой.

Метод InventorySourceDeliveryMethod

Возможные способы доставки для источника запасов.

Перечисления
INVENTORY_SOURCE_DELIVERY_METHOD_UNSPECIFIED В этой версии способ доставки не указан или неизвестен.
INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC Способ доставки – программный.
INVENTORY_SOURCE_DELIVERY_METHOD_TAG Способ доставки-бирка.

Статус источника инвентаря

Настройки, связанные со статусом источника инвентаря.

JSON-представление
{
  "entityStatus": enum (EntityStatus),
  "entityPauseReason": string,
  "sellerStatus": enum (EntityStatus),
  "sellerPauseReason": string,
  "configStatus": enum (InventorySourceConfigStatus)
}
Поля
entityStatus

enum ( EntityStatus )

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

Допустимые значения: ENTITY_STATUS_ACTIVE , ENTITY_STATUS_ARCHIVED и ENTITY_STATUS_PAUSED . Значение по умолчанию — ENTITY_STATUS_ACTIVE .

entityPauseReason

string

Указанная пользователем причина приостановки работы этого источника инвентаря.

Не должно превышать 100 символов.

Применимо только в том случае, если для entityStatus установлено значение ENTITY_STATUS_PAUSED .

sellerStatus

enum ( EntityStatus )

Только вывод. Статус, установленный продавцом для источника запасов.

Применимо только к источникам инвентаря, синхронизированным непосредственно с издателями. Допустимые значения: ENTITY_STATUS_ACTIVE и ENTITY_STATUS_PAUSED .

sellerPauseReason

string

Только вывод. Продавец указал причину приостановки использования этого источника ресурсов.

Применимо только для источников инвентаря, синхронизированных непосредственно с издателями, и когда для sellerStatus установлено значение ENTITY_STATUS_PAUSED .

configStatus

enum ( InventorySourceConfigStatus )

Только вывод. Статус конфигурации источника инвентаризации.

Применимо только для гарантированных источников инвентаря. Допустимые значения: INVENTORY_SOURCE_CONFIG_STATUS_PENDING и INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED .

Прежде чем он сможет показываться, необходимо настроить источник инвентаря (заполнить обязательные поля, выбрать креативы и выбрать кампанию по умолчанию).

Статус инвентаризацииSourceConfig

Возможные состояния конфигурации для гарантированного источника инвентаря.

Перечисления
INVENTORY_SOURCE_CONFIG_STATUS_UNSPECIFIED Статус одобрения в этой версии не указан или неизвестен.
INVENTORY_SOURCE_CONFIG_STATUS_PENDING Начальное состояние гарантированного источника запасов. Источник инвентаря в этом состоянии необходимо настроить.
INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED Состояние после того, как покупатель настроил гарантированный источник ресурсов.

ОценитьПодробнее

Настройки источника инвентаря, связанные с оценкой.

JSON-представление
{
  "inventorySourceRateType": enum (InventorySourceRateType),
  "rate": {
    object (Money)
  },
  "unitsPurchased": string,
  "minimumSpend": {
    object (Money)
  }
}
Поля
inventorySourceRateType

enum ( InventorySourceRateType )

Тип тарифа.

Допустимые значения: INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED , INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR и INVENTORY_SOURCE_RATE_TYPE_CPD .

rate

object ( Money )

Ставка для источника инвентаря.

unitsPurchased

string ( int64 format)

Требуется для гарантированных источников инвентаря. Количество показов, гарантированное продавцом.

minimumSpend

object ( Money )

Только вывод. Сумма, которую покупатель обязался потратить на источник ресурсов заранее.

Применимо только для гарантированных источников инвентаря.

Инвентарисаурцерейтетип

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

Перечисления
INVENTORY_SOURCE_RATE_TYPE_UNSPECIFIED В этой версии тип тарифа не указан или неизвестен.
INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED Тип ставки — CPM (фиксированная).
INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR Тип ставки — CPM (минимальная цена).
INVENTORY_SOURCE_RATE_TYPE_CPD Тип тарифа — Стоимость за день.
INVENTORY_SOURCE_RATE_TYPE_FLAT Тип тарифа — «Фиксированный».

Деньги

Представляет сумму денег с типом валюты.

JSON-представление
{
  "currencyCode": string,
  "units": string,
  "nanos": integer
}
Поля
currencyCode

string

Трехбуквенный код валюты, определенный в ISO 4217.

units

string ( int64 format)

Целые единицы суммы. Например, если currencyCode равен "USD" , то 1 единица равна одному доллару США.

nanos

integer

Количество нано (10^-9) единиц суммы. Значение должно находиться в диапазоне от -999 999 999 до +999 999 999 включительно. Если units положительны, nanos должен быть положительным или нулевым. Если units равны нулю, nanos может быть положительным, нулевым или отрицательным. Если units измерения отрицательные, nanos должно быть отрицательным или нулевым. Например, -1,75 доллара США представлены как units = -1 и nanos = -750 000 000.

Временной диапазон

Временной диапазон.

JSON-представление
{
  "startTime": string,
  "endTime": string
}
Поля
startTime

string ( Timestamp format)

Необходимый. Нижняя граница временного диапазона включительно.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

endTime

string ( Timestamp format)

Необходимый. Верхняя граница временного диапазона включительно.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

КреативКонфиг

Конфигурация требований к креативам для источника инвентаря.

JSON-представление
{
  "creativeType": enum (CreativeType),

  // Union field creative_config_scheme can be only one of the following:
  "displayCreativeConfig": {
    object (InventorySourceDisplayCreativeConfig)
  },
  "videoCreativeConfig": {
    object (InventorySourceVideoCreativeConfig)
  }
  // End of list of possible types for union field creative_config_scheme.
}
Поля
creativeType

enum ( CreativeType )

Тип креатива, который можно назначить источнику ресурсов. Поддерживаются только следующие типы:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

Поле объединения creative_config_scheme . Применимо, когда creative_type является одним из:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

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

displayCreativeConfig

object ( InventorySourceDisplayCreativeConfig )

Конфигурация показа креативов. Применимо, когда creativeType имеет значение CREATIVE_TYPE_STANDARD .

videoCreativeConfig

object ( InventorySourceVideoCreativeConfig )

Конфигурация для видеокреативов. Применимо, когда creativeType имеет значение CREATIVE_TYPE_VIDEO .

InventorySourceDisplayCreativeConfig

Конфигурация показа креативов.

JSON-представление
{
  "creativeSize": {
    object (Dimensions)
  }
}
Поля
creativeSize

object ( Dimensions )

Требования к размерам медийных креативов, которые можно назначить источнику ресурсов.

ИнвентарьИсточникВидеоCreativeConfig

Конфигурация для видеокреативов.

JSON-представление
{
  "duration": string
}
Поля
duration

string ( Duration format)

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

Длительность в секундах, содержащая до девяти дробных цифр и оканчивающаяся на « s ». Пример: "3.5s" .

ИнвентаризацияSourceAccessors

Партнер или рекламодатели, имеющие доступ к источнику инвентаря.

JSON-представление
{

  // Union field accessors can be only one of the following:
  "partner": {
    object (PartnerAccessor)
  },
  "advertisers": {
    object (AdvertiserAccessors)
  }
  // End of list of possible types for union field accessors.
}
Поля
accessors доступа к полям объединения. Партнер или рекламодатели, имеющие доступ к источнику инвентаря. accessors могут быть только одним из следующих:
partner

object ( PartnerAccessor )

Партнер, имеющий доступ к источнику ресурсов.

advertisers

object ( AdvertiserAccessors )

Рекламодатели, имеющие доступ к источнику инвентаря. Все рекламодатели должны принадлежать одному партнеру.

ПартнерДоступ

Партнер, имеющий доступ к источнику ресурсов.

JSON-представление
{
  "partnerId": string
}
Поля
partnerId

string ( int64 format)

Идентификатор партнера.

РекламодательДоступы

Рекламодатели, имеющие доступ к источнику инвентаря.

JSON-представление
{
  "advertiserIds": [
    string
  ]
}
Поля
advertiserIds[]

string ( int64 format)

Идентификаторы рекламодателей.

Методы

create

 Создает новый источник инвентаря.

editInventorySourceReadWriteAccessors

 Редактирует средства доступа для чтения/записи источника инвентаря.

get

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

list

 Перечисляет источники инвентаря, доступные текущему пользователю.

patch

 Обновляет существующий источник инвентаря.