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 Аукционный пакет.

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

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

Перечисления
INVENTORY_SOURCE_PRODUCT_TYPE_UNSPECIFIED Тип продукта не указан или неизвестен в этой версии. Изменение источников инвентаризации для этого типа продукта через API не поддерживается.
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 Обязательство не является гарантированной поставкой.

ИсточникИнвентарияСпособДоставки

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

Перечисления
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 Состояние после того, как покупатель настроит гарантированный источник инвентаря.

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

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

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_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 )

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

PartnerAccessor

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

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

string ( int64 format)

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

РекламодательАксессоры

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

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

string ( int64 format)

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

Методы

create

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

editInventorySourceReadWriteAccessors

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

get

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

list

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

patch

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