REST Resource: exchanges.orders.products

Ресурс: Product

Товар

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)
  },
  "program": string,
  "buyerCustomParameters": {
    string: string,
    ...
  },
  "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. Допустимы и другие типы нормализации. Примеры: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30".
startTime

string (Timestamp format)

Время, когда товар становится активным. Должно быть раньше endTime. Время начала не может быть более чем на год в будущем. Обязательно.

Используется формат 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)

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

Используется формат 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)

Подробные сведения о тарифе. Обязательно.
creativeConfig[]

object (CreativeConfig)

Требования к креативам для продукта. Обязательно для товаров с типом транзакции "Зарезервировано".
makegood
(deprecated)

boolean

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

object (MakegoodDetails)

Информация о компенсации за продукт. Обязательно, если товар является компенсацией.
creativeSource

enum (CreativeSource)

Источник креатива для товара. Необязательный параметр. По умолчанию используется значение CREATIVE_SOURCE_ADVERTISER. После создания товара его идентификатор нельзя изменить.
mediumType

enum (MediumType)

Тип носителя для товара. Если значение не указано, по умолчанию используется DIGITAL (для обратной совместимости). После создания товара его идентификатор нельзя изменить.
audienceTargetingConfig

object (AudienceTargetingConfig)

Необязательное поле. Конфигурация выбора целевой аудитории, которая применяется на уровне сделки на бирже.
targetingCriteria

object (TargetingCriteria)

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

object (ForecastResult)

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

object (ErrorDetails)

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

object (FrequencyCap)

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

string

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

map (key: string, value: string)

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

Объект содержит список из нескольких пар ("key": value). Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
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 Тип креатива – нативный. Это не поддерживается для продуктов с типом транзакции RESERVED.

DimensionCreativeConfig

Размеры креатива в пикселях.

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

integer

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

integer

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

DurationCreativeConfig

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

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

string (Duration format)

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

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

enum (DurationMatchType)

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

enum (SkippableMatchType)

Тип видеокреатива с возможностью пропуска.

DurationMatchType

Соответствие критериям по длительности видеокреатива.

Перечисления
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, будет отклонен.

AudienceTargetingConfig

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

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

enum (AudienceType)

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

AudienceType

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

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

TargetingCriteria

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

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

object (SelectedTargetingOption)

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

SelectedTargetingOption

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

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "audienceSelection": {
    object (AudienceSelection)
  },
  "targetingSelection": {
    object (TargetingSelection)
  }
  // End of mutually exclusive fields.
}
Поля
type

enum (TargetingType)

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

object (AudienceSelection)

Выбранная аудитория.
targetingSelection

object (TargetingSelection)

Общий набор идентификаторов выбранных вариантов.
Конец взаимоисключающих полей.

TargetingType

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

Перечисления
TARGETING_TYPE_UNSPECIFIED Тип таргетинга не указан, недопустим для ввода.
TARGETING_TYPE_AUDIENCE Тип таргетинга: аудитория.
TARGETING_TYPE_COUNTRY Тип таргетинга: страна.
TARGETING_TYPE_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 Тип таргетинга: минимальный размер видеопроигрывателя.
TARGETING_TYPE_VIDEO_COMPLETION Тип таргетинга: место размещения в видео.
TARGETING_TYPE_VIEWABILITY Таргетинг на основе видимости.
TARGETING_TYPE_REWARDED Тип таргетинга: объявления с вознаграждением.
TARGETING_TYPE_VIDEO_AD_DURATION_THRESHOLD_SEC Пороговое значение длительности видеообъявления для типа таргетинга (в секундах)
TARGETING_TYPE_VIDEO_PLACEMENT Тип таргетинга: место размещения в видео.
TARGETING_TYPE_VIDEO_PLAYBACK_METHOD Тип таргетинга "Метод воспроизведения видео".
TARGETING_TYPE_APP_ID Идентификатор приложения с таргетингом по типу.
TARGETING_TYPE_DOMAIN_URL Тип таргетинга: URL домена.
TARGETING_TYPE_CTR CTR по типу таргетинга.
TARGETING_TYPE_DEMOGRAPHICS Тип таргетинга: демографический.
TARGETING_TYPE_RESTRICTED_CATEGORY Тип таргетинга: категория с ограничениями.
TARGETING_TYPE_AD_POSITION Тип таргетинга: позиция объявления.
TARGETING_TYPE_DAY_AND_TIME Тип таргетинга: день и время.
TARGETING_TYPE_RETAIL_MEDIA_AUDIENCE Тип таргетинга: аудитория розничной рекламы.

AudienceSelection

Выбранные варианты целевых аудиторий.

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

object (OrGroup)

Включенные варианты объединяются оператором И. Каждый из них может быть отдельным вариантом или группой вариантов, объединенных оператором ИЛИ.
excludedOptionIds[]

string (int64 format)

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

OrGroup

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

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

string (int64 format)

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

TargetingSelection

Выбранные и исключенные настройки таргетинга, применимые к большинству типов таргетинга.

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

string (int64 format)

Только для вывода. Идентификаторы выбранных параметров таргетинга DV3, которые передаются на биржу. Может возвращаться вместе с excludedOptionIds, если эти два списка не пересекаются.
externalIds[]

string

Только для вывода. Идентификаторы выбранных вариантов таргетинга, предоставленные биржей. Может возвращаться вместе с excludedExternalIds, если эти два списка не пересекаются.
excludedOptionIds[]

string (int64 format)

Только для вывода. Идентификаторы исключенных параметров таргетинга DV3, которые передаются бирже. Может возвращаться вместе с optionIds, если эти два списка не пересекаются.
excludedExternalIds[]

string

Только для вывода. Идентификаторы исключенных параметров таргетинга, предоставленные биржей. Может возвращаться вместе с externalIds, если эти два списка не пересекаются.

ForecastResult

Указан результат прогноза.

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

object (Forecast)

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

Прогноз

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

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "number": string,
  "percentage": integer,
  "cpmPrice": {
    object (Money)
  },
  "cpmRange": {
    object (CpmRange)
  },
  "forecastBreakdownData": {
    object (ForecastBreakdownData)
  }
  // End of mutually exclusive fields.
}
Поля
forecastCategory

enum (ForecastCategory)

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

string (int64 format)

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

integer

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

object (Money)

Данные о цене за тысячу показов.
cpmRange

object (CpmRange)

Данные о диапазоне цены за тысячу показов.
forecastBreakdownData

object (ForecastBreakdownData)

Данные о распределении прогнозов.
Конец взаимоисключающих полей.

ForecastCategory

Категория прогноза.

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

CpmRange

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

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

object (Money)

Нижняя граница диапазона цены за тысячу показов.
maxCpm

object (Money)

Верхняя граница диапазона цены за тысячу показов.

ForecastBreakdownData

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

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

object (ForecastBreakdown)

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

ForecastBreakdown

Прогноз с разбивкой по выбранному параметру таргетинга.

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "impressions": string
  // End of mutually exclusive fields.
}
Поля
selectedTargetingOption

object (SelectedTargetingOption)

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

string (int64 format)

Прогнозируемое число показов.
Конец взаимоисключающих полей.

ErrorDetails

Сведения об ошибках, которые возникли при обновлении.

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)

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

TimeUnit

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

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

Методы

create

 Создает товар.

get

 Возвращает товар.

list

 Возвращает список товаров.

patch

 Обновляет товар.