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)
    }
  ],
  "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 дробных знаков. Допускаются также смещения, отличные от "Z". Примеры: "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 Поставщик товаров реализует свои товары через программу Preferred Deal.
PRIVATE_AUCTION Поставщик товаров реализует свою продукцию через частные аукционы.
PROGRAMMATIC_GUARANTEED Поставщик товарных запасов продает их через систему гарантированной программной закупки.
TAG_GUARANTEED Поставщик товаров реализует свою продукцию через Tag Guaranteed.
YOUTUBE_RESERVE Источник товаров продает их через YouTube Reserve.
INSTANT_RESERVE Источник данных о наличии товара осуществляет продажу товаров через функцию мгновенного резервирования. Изменение источников данных о наличии товара данного типа через API не поддерживается.
GUARANTEED_PACKAGE Источник товаров продает товары через гарантированную упаковку. Изменение источников товаров этого типа через API не поддерживается.
PROGRAMMATIC_TV Источник данных о наличии товара осуществляет продажу товаров через Programmtic 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 Тип ставки — CPM (фиксированная).
INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR Тип ставки — CPM (минимальная ставка).
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" , то 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.

TimeRange

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

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

string ( Timestamp format)

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

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

CreativeConfig

Креативная настройка требований к источнику данных инвентаризации.

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 )

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

InventorySourceVideoCreativeConfig

Настройки для создания видеороликов.

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

string ( Duration format)

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

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

InventorySourceAccessors

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

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)

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

AdvertiserAccessors

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

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

string ( int64 format)

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

Методы

create

 Создает новый источник складских запасов.

editInventorySourceReadWriteAccessors

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

get

 Получает источник данных об остатках на складе.

list

 Отображает список источников инвентаризации, доступных текущему пользователю.

patch

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