REST Resource: monetization.onetimeproducts.purchaseOptions.offers

Источник: OneTimeProductOffer

Единое предложение на разовый товар.

JSON-представление 
{
  "packageName": string,
  "productId": string,
  "purchaseOptionId": string,
  "offerId": string,
  "state": enum (State),
  "regionalPricingAndAvailabilityConfigs": [
    {
      object (RegionalPricingAndAvailabilityConfig)
    }
  ],
  "offerTags": [
    {
      object (OfferTag)
    }
  ],
  "regionsVersion": {
    object (RegionsVersion)
  },

  // Union field offer_type can be only one of the following:
  "preOrderOffer": {
    object (OneTimeProductPreOrderOffer)
  },
  "discountedOffer": {
    object (OneTimeProductDiscountedOffer)
  }
  // End of list of possible types for union field offer_type.
}
Поля
packageName

string

Обязательный параметр. Неизменяемый. Имя пакета приложения, к которому относится родительский продукт.

productId

string

Обязательный параметр. Неизменяемый. Идентификатор родительского продукта, к которому относится это предложение.

purchaseOptionId

string

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

offerId

string

Обязательно. Неизменяемо. Идентификатор данного предложения товара. Должен быть уникальным в рамках выбранного варианта покупки. Он должен начинаться с цифры или строчной буквы и может содержать только строчные буквы (az), цифры (0-9) и дефисы (-). Максимальная длина — 63 символа.

state

enum ( State )

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

regionalPricingAndAvailabilityConfigs[]

object ( RegionalPricingAndAvailabilityConfig )

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

offerTags[]

object ( OfferTag )

Необязательно. Список из до 20 пользовательских тегов, указанных для этого предложения и возвращаемых в приложение через библиотеку платежей.

regionsVersion

object ( RegionsVersion )

Только выходные данные. Версия конфигурации регионов, которая использовалась для генерации разового предложения продукта.

Поле объединения offer_type . Тип данного предложения. Необходимо указать ровно один тип. offer_type может принимать только одно из следующих значений:
preOrderOffer

object ( OneTimeProductPreOrderOffer )

Предложение предварительного заказа.

discountedOffer

object ( OneTimeProductDiscountedOffer )

Скидка.

Состояние

Текущее состояние предложения.

Перечисления
STATE_UNSPECIFIED Значение по умолчанию, использовать его никогда не следует.
DRAFT Данное предложение недоступно и никогда не было доступно пользователям.
ACTIVE Предложение доступно пользователям при соблюдении его условий.
CANCELLED Это относится только к предварительным заказам. Предложение аннулировано и недоступно для пользователей. Все ожидающие заказы, связанные с этим предложением, были аннулированы.
INACTIVE Это состояние характерно только для предложений со скидкой. Предложение больше недоступно для пользователей.

Предложение по одноразовому предварительному заказу товара

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

JSON-представление 
{
  "startTime": string,
  "endTime": string,
  "releaseTime": string,
  "priceChangeBehavior": enum (PreOrderPriceChangeBehavior)
}
Поля
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" .

releaseTime

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

priceChangeBehavior

enum ( PreOrderPriceChangeBehavior )

Обязательный параметр. Неизменяемый. Указывает, как изменения цен влияют на существующие предварительные заказы.

Поведение изменения цены предварительного заказа

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

Перечисления
PRE_ORDER_PRICE_CHANGE_BEHAVIOR_UNSPECIFIED Неуказанное поведение при изменении цены. Не подлежит использованию.
PRE_ORDER_PRICE_CHANGE_BEHAVIOR_TWO_POINT_LOWEST С покупателя взимается минимальная сумма, представляющая собой разницу между первоначальной ценой на момент предварительного заказа и окончательной ценой предложения в день релиза.
PRE_ORDER_PRICE_CHANGE_BEHAVIOR_NEW_ORDERS_ONLY Покупатель получает ту же цену, что и при предварительном заказе, независимо от любых изменений цен, которые могли произойти после предварительного заказа.

Одноразовое предложение со скидкой на товар

Настройки, специфичные для предложений со скидкой.

JSON-представление 
{
  "startTime": string,
  "endTime": string,
  "redemptionLimit": 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" .

redemptionLimit

string ( int64 format)

Необязательно. Количество раз, когда можно воспользоваться этим предложением. Если значение не указано или равно 0, количество использований предложения неограничено. В противном случае должно быть числом от 1 до 50 включительно.

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

Региональная настройка ценообразования и доступности для разового предложения продукта.

JSON-представление 
{
  "regionCode": string,
  "availability": enum (Availability),

  // Union field price_override can be only one of the following:
  "noOverride": {
    object (OneTimeProductOfferNoPriceOverrideOptions)
  },
  "relativeDiscount": number,
  "absoluteDiscount": {
    object (Money)
  }
  // End of list of possible types for union field price_override.
}
Поля
regionCode

string

Обязательно. Код региона, к которому относится данная конфигурация, как определено в ISO 3166-2, например, «США».

availability

enum ( Availability )

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

Поле объединения price_override . Переопределение цены для данного предложения. Должно быть установлено ровно одно значение. price_override может принимать только одно из следующих значений:
noOverride

object ( OneTimeProductOfferNoPriceOverrideOptions )

Будет использована цена, указанная в варианте покупки для данного региона.

relativeDiscount

number

Доля от цены опциона на покупку, которую пользователь платит за это предложение. Например, если цена опциона на покупку в этом регионе составляет 12 долларов, то скидка в 50% будет соответствовать цене в 6 долларов. Скидка должна быть указана в виде дроби, строго большей 0 и строго меньшей 1. Полученная цена будет округлена до ближайшей расчетной единицы (например, центов для долларов США). Относительная скидка считается недействительной, если цена со скидкой оказывается меньше минимальной цены, разрешенной в этом регионе.

absoluteDiscount

object ( Money )

Абсолютное значение скидки, вычитаемой из цены опциона на покупку.

Значение должно находиться в диапазоне от 0 до цены опциона на покупку.

OneTimeProductOfferNoPriceOverrideOptions

Этот тип не содержит полей.

Варианты разовых предложений товаров без региональной ценовой корректировки.

Доступность

Доступность предложения.

Перечисления
AVAILABILITY_UNSPECIFIED Доступность не указана. Использовать нельзя.
AVAILABLE Предложение доступно пользователям.
NO_LONGER_AVAILABLE Предложение больше недоступно для пользователей. Это значение можно использовать только в том случае, если ранее оно было отмечено как «ДОСТУПНО».

Методы

activate

 Активирует разовое предложение продукта.

batchDelete

 Удаляет одно или несколько разовых предложений товаров.

batchGet

 Прочитывает одно или несколько разовых предложений товаров.

batchUpdate

 Создает или обновляет одно или несколько разовых предложений товаров.

batchUpdateStates

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

cancel

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

deactivate

 Отключает разовое предложение товара.

list

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

коды ошибок

При работе с этим ресурсом возвращаются следующие коды ошибок HTTP:

Код ошибки Причина Описание Разрешение