REST Resource: advertisers.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)
    }
  ],
  "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)

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

Используется формат RFC 3339. Результат всегда будет Z-нормализованным, и в нем будут использоваться цифры дробных частей 0, 3, 6 или 9. Допустимы и другие типы нормализации. Примеры: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30".
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)

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

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

InventorySourceType

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

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

InventorySourceProductType

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

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

InventorySourceCommitment

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

Перечисления
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 Метод показа – тег.

InventorySourceStatus

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

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.

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

InventorySourceConfigStatus

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

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

RateDetails

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

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)

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

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

InventorySourceRateType

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

Перечисления
INVENTORY_SOURCE_RATE_TYPE_UNSPECIFIED Тип тарифа не указан или неизвестен в этой версии.
INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED Тип цены – фиксированная цена за тысячу показов.
INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR Тип цены – минимальная цена за тысячу показов.
INVENTORY_SOURCE_RATE_TYPE_CPD Тип цены – цена за день.
INVENTORY_SOURCE_RATE_TYPE_CPH Тип цены – цена за час.
INVENTORY_SOURCE_RATE_TYPE_FLAT Тип цены – фиксированная.

Деньги

Представляет денежную сумму с указанием валюты.

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

string

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

string (int64 format)

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

integer

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

TimeRange

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

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

string (Timestamp format)

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

Используется формат RFC 3339. Результат всегда будет Z-нормализованным, и в нем будут использоваться цифры дробных частей 0, 3, 6 или 9. Допустимы и другие типы нормализации. Примеры: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Обязательно. Верхняя граница диапазона дат (включительно).

Используется формат RFC 3339. Результат всегда будет Z-нормализованным, и в нем будут использоваться цифры дробных частей 0, 3, 6 или 9. Допустимы и другие типы нормализации. Примеры: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30".

CreativeConfig

Требования к креативам для источника инвентаря.

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "displayCreativeConfig": {
    object (InventorySourceDisplayCreativeConfig)
  },
  "videoCreativeConfig": {
    object (InventorySourceVideoCreativeConfig)
  }
  // End of mutually exclusive fields.
}
Поля
creativeType

enum (CreativeType)

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

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

Применимо, если creative_type – одно из следующих значений:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

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

object (InventorySourceDisplayCreativeConfig)

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

object (InventorySourceVideoCreativeConfig)

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

InventorySourceDisplayCreativeConfig

Конфигурация медийных креативов.

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

object (Dimensions)

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

InventorySourceVideoCreativeConfig

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

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

string (Duration format)

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

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

InventorySourceAccessors

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

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "partner": {
    object (PartnerAccessor)
  },
  "advertisers": {
    object (AdvertiserAccessors)
  }
  // End of mutually exclusive fields.
}
Поля
Партнеры или рекламодатели, у которых есть доступ к источнику инвентаря. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
partner

object (PartnerAccessor)

Партнер, у которого есть доступ к источнику инвентаря.
advertisers

object (AdvertiserAccessors)

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

PartnerAccessor

Партнер, у которого есть доступ к источнику инвентаря.

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

string (int64 format)

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

AdvertiserAccessors

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

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

string (int64 format)

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

Методы

get

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

list

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