REST Resource: exchanges.orders.products

Ресурс: Продукт

Продукт

JSON-представление 
{
  "name": string,
  "displayName": string,
  "externalDealId": string,
  "transactionType": enum (TransactionType),
  "pricingType": enum (PricingType),
  "updateTime": string,
  "startTime": string,
  "endTime": string,
  "rateDetails": {
    object (RateDetails)
  },
  "creativeConfig": [
    {
      object (CreativeConfig)
    }
  ],
  "makegood": boolean,
  "makegoodDetails": {
    object (MakegoodDetails)
  },
  "creativeSource": enum (CreativeSource),
  "mediumType": enum (MediumType),
  "audienceTargetingConfig": {
    object (AudienceTargetingConfig)
  },
  "targetingCriteria": {
    object (TargetingCriteria)
  },
  "forecastResult": {
    object (ForecastResult)
  },
  "errorDetails": {
    object (ErrorDetails)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "etag": string
}
Поля
name

string

Относительное имя маршрута для продукта. Сгенерировано сервером. Пример: "exchanges/1234/orders/5678/products/abc". Только вывод.

displayName

string

Отображаемое название продукта.

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

externalDealId

string

Внешний идентификатор. Это идентификатор сделки в системе обмена. Максимум 100 символов. Допустимые символы: буквы, цифры, подчёркивание, тире и точка. Должен быть уникальным для всех товаров. Обязательно.

transactionType

enum ( TransactionType )

Тип транзакции продукта. Обязательно.

pricingType

enum ( PricingType )

Тип цены для продукта. Обязательно.

updateTime
(deprecated)

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" .

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)

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

Использует 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 )

Подробности оценки. Обязательно.

creativeConfig[]

object ( CreativeConfig )

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

makegood
(deprecated)

boolean

Указывает, является ли продукт компенсационным продуктом.

makegoodDetails
(deprecated)

object ( MakegoodDetails )

Подробная информация о компенсации за продукт. Требуется, если продукт является компенсацией.

creativeSource

enum ( CreativeSource )

Источник креатива для продукта. Необязательный параметр, по умолчанию — CREATIVE_SOURCE_ADVERTISER. Не может быть изменён после создания продукта.

mediumType

enum ( MediumType )

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

audienceTargetingConfig

object ( AudienceTargetingConfig )

Необязательно. Выбранная конфигурация таргетинга аудитории применяется на уровне сделки на Exchange.

targetingCriteria

object ( TargetingCriteria )

Только вывод. Ссылки на критерии таргетинга продукта. Применимо только к сценариям мгновенных сделок.

forecastResult

object ( ForecastResult )

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

errorDetails

object ( ErrorDetails )

Сведения об ошибке необходимо указывать, если определённые поля продукта не могут быть обновлены. Требуется, если результат прогноза не может быть предоставлен из-за критерия таргетинга или невозможно обновить продукт. Применимо только к сценариям мгновенных сделок.

frequencyCap

object ( FrequencyCap )

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

etag

string

etag, который необходимо указать при обновлении товара. Его необходимо указывать только при обновлении, если поле etag не пустое. Применимо только к сценариям мгновенных сделок.

CreativeConfig

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

JSON-представление 
{
  "creativeType": enum (CreativeType),
  "dimensionCreativeConfig": {
    object (DimensionCreativeConfig)
  },
  "durationCreativeConfig": {
    object (DurationCreativeConfig)
  }
}
Поля
creativeType

enum ( CreativeType )

Тип объявления. Обязательно.

dimensionCreativeConfig

object ( DimensionCreativeConfig )

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

Это поле не поддерживается для нативных объявлений (CREATIVE_TYPE_NATIVE).

durationCreativeConfig

object ( DurationCreativeConfig )

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

CreativeType

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

Перечисления
CREATIVE_TYPE_UNSPECIFIED Тип креатива не указан. Недопустимое входное значение.
CREATIVE_TYPE_DISPLAY Креативный тип отображения.
CREATIVE_TYPE_VIDEO Креативный тип видео.
CREATIVE_TYPE_AUDIO Творческий тип аудио.
CREATIVE_TYPE_NATIVE Творческий тип туземца.

DimensionCreativeConfig

Отображение креативного размера в пикселях.

JSON-представление 
{
  "width": integer,
  "height": integer
}
Поля
width

integer

Ширина отображаемого креатива. Обязательно.

height

integer

Отображение высоты креатива. Обязательно.

ПродолжительностьCreativeConfig

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

JSON-представление 
{
  "duration": string,
  "durationMatchType": enum (DurationMatchType),
  "skippableMatchType": enum (SkippableMatchType)
}
Поля
duration

string ( Duration format)

Длительность видеорекламы в секундах. Обязательно.

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

durationMatchType

enum ( DurationMatchType )

Критерии соответствия продолжительности.

skippableMatchType

enum ( SkippableMatchType )

Пропускаемый тип видеообъявления.

ПродолжительностьСоответствияТип

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

Перечисления
DURATION_MATCH_TYPE_UNSPECIFIED Критерий соответствия длительности не указан или неизвестен в этой версии. Недопустимое входное значение.
DURATION_MATCH_TYPE_EQUAL_TO Длительность креатива должна быть такой же, как и требуемая длительность.
DURATION_MATCH_TYPE_LESS_THAN_OR_EQUAL_TO Длительность креатива должна быть равна или меньше требуемой длительности.

SkippableMatchType

Возможные форматы продукта.

Перечисления
SKIPPABLE_MATCH_TYPE_UNSPECIFIED Пропускаемый тип не указан или неизвестен в этой версии. Недопустимое входное значение.
SKIPPABLE_MATCH_TYPE_SKIPPABLE Рекламное объявление должно быть пропускаемым.
SKIPPABLE_MATCH_TYPE_NOT_SKIPPABLE Рекламное объявление не должно быть пропускаемым.
SKIPPABLE_MATCH_TYPE_ANY Объявление может быть пропускаемым или не пропускаемым.

MakegoodDetails

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

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

string

Исходный внешний идентификатор сделки, по которой запрашивается компенсация. Максимум 100 символов. Допустимые символы: буквы, цифры, подчёркивание, тире и точка. Обязательно.

reason

string

Причина, инициированная продавцом. Макс. 250 символов. Обязательно.

CreativeSource

Источник креативов: откуда будут подаваться креативы.

Перечисления
CREATIVE_SOURCE_UNSPECIFIED Источник креатива не указан или неизвестен в этой версии. Недопустимое входное значение.
CREATIVE_SOURCE_ADVERTISER Креативы будут обслуживаться DV3.
CREATIVE_SOURCE_PUBLISHER Креативы будут обслуживаться издателем. Креативы, размещенные издателем, в настоящее время не поддерживаются; любой запрос, пытающийся указать источник креативов как CREATIVE_SOURCE_PUBLISHER, завершится ошибкой.

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

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

JSON-представление 
{
  "audienceType": enum (AudienceType)
}
Поля
audienceType

enum ( AudienceType )

Тип аудитории. Обязательно.

Тип аудитории

Тип аудитории.

Перечисления
AUDIENCE_TYPE_UNSPECIFIED Тип аудитории не указан. Недопустимо для ввода.
AUDIENCE_TYPE_COMMERCE Тип аудитории «Коммерческая».

Критерии таргетинга

Указаны критерии таргетинга.

JSON-представление 
{
  "selectedTargetingOptions": [
    {
      object (SelectedTargetingOption)
    }
  ]
}
Поля
selectedTargetingOptions[]

object ( SelectedTargetingOption )

Выбранные варианты.

Выбранный вариант таргетинга

Выбранный вариант или варианты таргетинга для одного типа таргетинга.

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

  // Union field value can be only one of the following:
  "audienceSelection": {
    object (AudienceSelection)
  },
  "targetingSelection": {
    object (TargetingSelection)
  }
  // End of list of possible types for union field value.
}
Поля
type

enum ( TargetingType )

Тип таргетинга, связанный с выбранными параметрами.

value поля "Union". Можно включить только один тип выбора. Выбранный тип должен соответствовать типу TargetingType, выбранному для поля "type". value может быть только одним из следующих:
audienceSelection

object ( AudienceSelection )

Избранная аудитория.

targetingSelection

object ( TargetingSelection )

Общий набор идентификаторов выбранных опций.

Тип таргетинга

Типы таргетинга.

Перечисления
TARGETING_TYPE_UNSPECIFIED Неуказанный тип таргетинга, недопустимый для ввода.
TARGETING_TYPE_AUDIENCE Тип целевой аудитории.
TARGETING_TYPE_COUNTRY Тип таргетинга — страна.
TARGETING_TYPE_DMA Тип нацеливания dma.
TARGETING_TYPE_PROGRAMMER Программист целевого типа.
TARGETING_TYPE_BRAND Тип таргетинга — бренд.
TARGETING_TYPE_CONTENT_GENRE Тип таргетинга, жанр контента.
TARGETING_TYPE_DEVICE Устройство прицельного типа.
TARGETING_TYPE_OPERATING_SYSTEM Тип нацеливания операционной системы.
TARGETING_TYPE_RATING Рейтинг типа таргетинга.
TARGETING_TYPE_ENVIRONMENT Тип таргетинга на окружающую среду.
TARGETING_TYPE_LANGUAGE Язык типа таргетинга.
TARGETING_TYPE_GEO География типа таргетинга.
TARGETING_TYPE_AGE Тип таргетинга - возраст.
TARGETING_TYPE_GENDER Тип таргетинга — пол.
TARGETING_TYPE_CONTEXTUAL_SEGMENT Тип таргетинга – контекстный сегмент.
TARGETING_TYPE_REQUEST_FORMAT Формат запроса типа таргетинга.
TARGETING_TYPE_PUBLISHER Тип таргетинга — издатель.
TARGETING_TYPE_INVENTORY_SIZE Размер шрифта таргетинга.
TARGETING_TYPE_NETWORK Тип таргетинга — сеть.
TARGETING_TYPE_PLATFORM Тип таргетинга платформы.
TARGETING_TYPE_VIDEO_DELIVERY_TYPE Тип таргетинга Тип доставки видео.
TARGETING_TYPE_VIDEO_MINIMUM_PLAYER_SIZE Тип таргетинга видео минимальный размер проигрывателя.

Выбор аудитории

Выбранные варианты таргетинга аудитории.

JSON-представление 
{
  "includedOrGroups": [
    {
      object (OrGroup)
    }
  ],
  "excludedOptionIds": [
    string
  ]
}
Поля
includedOrGroups[]

object ( OrGroup )

Включенные варианты объединяются с помощью AND, каждый включенный вариант может быть отдельным вариантом или группой вариантов, объединенных с помощью OR.

excludedOptionIds[]

string ( int64 format)

Исключенные варианты соединяются с помощью ИЛИ.

ИлиГруппа

Группа выбранных вариантов, объединенных оператором ИЛИ.

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

string ( int64 format)

Идентификаторы выбранных опций.

Выбор таргетинга

Набор из одного или нескольких выбранных идентификаторов параметров, применимых для большинства типов таргетинга.

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

string ( int64 format)

Идентификаторы выбранных опций.

ПрогнозРезультат

Указан прогнозируемый результат.

JSON-представление 
{
  "forecasts": [
    {
      object (Forecast)
    }
  ]
}
Поля
forecasts[]

object ( Forecast )

Прогноз. «forecastCategory» должен быть уникальным для каждого указанного элемента.

Прогноз

Прогноз указанной категории прогноза.

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

  // Union field forecast_data can be only one of the following:
  "number": string,
  "percentage": integer,
  "cpmPrice": {
    object (Money)
  },
  "cpmRange": {
    object (CpmRange)
  },
  "forecastBreakdownData": {
    object (ForecastBreakdownData)
  }
  // End of list of possible types for union field forecast_data.
}
Поля
forecastCategory

enum ( ForecastCategory )

Указанная категория прогноза, представленная прогнозной статистикой.

Объединенное поле forecast_data . Можно включить только один тип статистических данных. Заполняемые данные должны соответствовать полю "forecastCategory". forecast_data может быть только одним из следующих:
number

string ( int64 format)

Числовые данные.

percentage

integer

Процентные данные.

cpmPrice

object ( Money )

Данные о ценах CPM.

cpmRange

object ( CpmRange )

Данные о диапазоне цен CPM.

forecastBreakdownData

object ( ForecastBreakdownData )

Прогноз данных по разбивке.

ПрогнозКатегория

Прогнозируемая категория.

Перечисления
FORECAST_CATEGORY_UNSPECIFIED Категория не указана. Недопустимо для ввода.
FORECAST_CATEGORY_TOTAL_OPPORTUNITIES Общее количество возможностей. Числовые данные.
FORECAST_CATEGORY_TOTAL_AUDIENCE Общая аудитория. Численные данные.
FORECAST_CATEGORY_DIGITAL_TRP Цифровые целевые рейтинговые баллы. Процентные данные.
FORECAST_CATEGORY_SUGGESTED_CPM Рекомендуемая цена CPM. Диапазон CPM или данные о цене CPM.
FORECAST_CATEGORY_UNIQUE_REACH Прогноз уникального охвата. Числовые данные.
FORECAST_CATEGORY_FORECAST_BREAKDOWN Разбивка прогноза. Данные разбивки прогноза.

CpmRange

Диапазон CPM содержит минимальное и максимальное значение CPM.

JSON-представление 
{
  "minCpm": {
    object (Money)
  },
  "maxCpm": {
    object (Money)
  }
}
Поля
minCpm

object ( Money )

Нижняя граница диапазона CPM.

maxCpm

object ( Money )

Верхняя граница диапазона CPM.

Прогноз данных разбивки

Данные по разбивке прогнозов содержат список разбивок прогнозов.

JSON-представление 
{
  "forecastBreakdowns": [
    {
      object (ForecastBreakdown)
    }
  ]
}
Поля
forecastBreakdowns[]

object ( ForecastBreakdown )

Список разбивок прогнозов.

ПрогнозРазбивка

Прогноз разбивки выбранного варианта таргетинга.

JSON-представление 
{
  "selectedTargetingOption": {
    object (SelectedTargetingOption)
  },

  // Union field breakdown_data can be only one of the following:
  "impressions": string
  // End of list of possible types for union field breakdown_data.
}
Поля
selectedTargetingOption

object ( SelectedTargetingOption )

Выбранный вариант или варианты таргетинга для одного типа таргетинга.

Поле объединения breakdown_data . Может быть включен только один тип данных разбивки. breakdown_data может быть только одним из следующих:
impressions

string ( int64 format)

Прогнозируем впечатления.

Подробности ошибки

Подробности ошибки указываются, если обновление содержит ошибки.

JSON-представление 
{
  "message": string,
  "instantDealErrorStatus": enum (InstantDealErrorStatus)
}
Поля
message

string

Сообщение, выдаваемое при возникновении ошибок в обновлении.

instantDealErrorStatus

enum ( InstantDealErrorStatus )

Статус ошибки указывается, когда обновление содержит ошибки для мгновенных сделок.

InstantDealErrorStatus

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

Перечисления
INSTANT_DEAL_ERROR_STATUS_UNSPECIFIED Неуказанный статус ошибки.
INSTANT_DEAL_ERROR_STATUS_INVENTORY_UNAVAILABLE Статус ошибки указывает на то, что инвентарь недоступен.
INSTANT_DEAL_ERROR_STATUS_FORECAST_UNAVAILABLE Статус ошибки указывает на то, что прогноз недоступен.
INSTANT_DEAL_ERROR_STATUS_INVALID_INPUT Статус ошибки указывает на недопустимые поля ввода.

FrequencyCap

Сколько раз пользователю может быть показано одно и то же объявление в течение определенного периода времени

JSON-представление 
{
  "timeUnit": enum (TimeUnit),
  "maxImpressions": string
}
Поля
timeUnit

enum ( TimeUnit )

Единица времени, в которой будет применяться ограничение частоты.

maxImpressions

string ( int64 format)

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

Единица времени

Единица времени, в которой будет применяться ограничение частоты.

Перечисления
TIME_UNIT_UNSPECIFIED Неопределенная единица времени.
TIME_UNIT_LIFETIME Ограничение частоты будет применяться в течение всего срока службы.
TIME_UNIT_MONTHS Ограничение частоты будет применяться к нескольким месяцам.
TIME_UNIT_WEEKS Ограничение частоты будет применяться к нескольким неделям.
TIME_UNIT_DAYS Ограничение частоты будет применяться к нескольким дням.

Методы

create

 Создает продукт.

get

 Получает продукт.

list

 Перечисляет продукты.

patch

 Обновляет продукт.