REST Resource: monetization.onetimeproducts.purchaseOptions.offers

Ressource : OneTimeProductOffer

Offre unique pour un produit ponctuel.

Représentation 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.
}
Champs
packageName

string

Obligatoire. Immuable. Nom du package de l'application à laquelle appartient le produit parent.

productId

string

Obligatoire. Immuable. ID du produit parent auquel appartient cette offre.

purchaseOptionId

string

Obligatoire. Immuable. ID de l'option d'achat à laquelle cette offre est associée.

offerId

string

Obligatoire. Immuable. ID de cette offre de produit. Cet ID doit être unique dans l'option d'achat. Il doit commencer par un chiffre ou une lettre minuscule, et il ne peut inclure que des lettres minuscules (a-z), des chiffres (0-9) et des traits d'union (-). La longueur maximale est de 63 caractères.

state

enum (State)

Uniquement en sortie. État actuel de cette offre. Ce champ ne peut pas être modifié en mettant à jour la ressource. Utilisez plutôt les points de terminaison dédiés.

regionalPricingAndAvailabilityConfigs[]

object (RegionalPricingAndAvailabilityConfig)

Ensemble d'informations sur la tarification et la disponibilité régionales pour cette offre. Ne doit pas comporter d'entrées en double avec le même code de région.

offerTags[]

object (OfferTag)

Facultatif. Liste de 20 tags personnalisés maximum spécifiés pour cette offre et renvoyés à l'application via la bibliothèque de facturation.

regionsVersion

object (RegionsVersion)

Uniquement en sortie. Version de la configuration des régions utilisée pour générer l'offre de produit ponctuel.

Champ d'union offer_type. Type de cette offre. Un seul doit être défini. offer_type ne peut être qu'un des éléments suivants :
preOrderOffer

object (OneTimeProductPreOrderOffer)

Offre de précommande.

discountedOffer

object (OneTimeProductDiscountedOffer)

Offre avec remise

État

État actuel de l'offre.

Enums
STATE_UNSPECIFIED Valeur par défaut, ne doit jamais être utilisée.
DRAFT L'offre n'est pas et n'a jamais été disponible pour les utilisateurs.
ACTIVE L'offre est disponible pour les utilisateurs tant que ses conditions sont remplies.
CANCELLED Cet état est spécifique aux précommandes. L'offre est annulée et n'est plus disponible pour les utilisateurs. Toutes les commandes en attente associées à cette offre ont été annulées.
INACTIVE Cet état est spécifique aux offres à prix réduit. L'offre n'est plus disponible pour les utilisateurs.

OneTimeProductPreOrderOffer

Configuration spécifique aux offres de précommande.

Représentation JSON
{
  "startTime": string,
  "endTime": string,
  "releaseTime": string,
  "priceChangeBehavior": enum (PreOrderPriceChangeBehavior)
}
Champs
startTime

string (Timestamp format)

Obligatoire. Heure à laquelle la précommande sera disponible.

Utilise la norme RFC 3339, où le résultat généré est toujours normalisé avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

endTime

string (Timestamp format)

Obligatoire. Heure à laquelle la précommande ne sera plus disponible.

Utilise la norme RFC 3339, où le résultat généré est toujours normalisé avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

releaseTime

string (Timestamp format)

Obligatoire. Heure à laquelle le produit associé à la précommande sera disponible et les commandes de précommande traitées.

Utilise la norme RFC 3339, où le résultat généré est toujours normalisé avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

priceChangeBehavior

enum (PreOrderPriceChangeBehavior)

Obligatoire. Immuable. Spécifie l'impact des changements de prix sur les précommandes existantes.

PreOrderPriceChangeBehavior

Spécifie l'impact des changements de prix sur les précommandes existantes.

Enums
PRE_ORDER_PRICE_CHANGE_BEHAVIOR_UNSPECIFIED Comportement de changement de prix non spécifié. Ne doit pas être utilisé.
PRE_ORDER_PRICE_CHANGE_BEHAVIOR_TWO_POINT_LOWEST L'acheteur est facturé au prix le plus bas entre le prix initial au moment de la précommande et le prix de l'offre finale à la date de sortie.
PRE_ORDER_PRICE_CHANGE_BEHAVIOR_NEW_ORDERS_ONLY L'acheteur bénéficie du même prix que celui de la précommande, quels que soient les changements de prix qui ont pu avoir lieu après la précommande.

OneTimeProductDiscountedOffer

Configuration spécifique aux offres à prix réduit.

Représentation JSON
{
  "startTime": string,
  "endTime": string,
  "redemptionLimit": string
}
Champs
startTime

string (Timestamp format)

Heure à laquelle l'offre sera disponible.

Utilise la norme RFC 3339, où le résultat généré est toujours normalisé avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

endTime

string (Timestamp format)

Heure à laquelle l'offre ne sera plus disponible.

Utilise la norme RFC 3339, où le résultat généré est toujours normalisé avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

redemptionLimit

string (int64 format)

Facultatif. Nombre de fois où cette offre peut être utilisée. Si elle n'est pas définie ou est définie sur 0, les utilisateurs peuvent profiter d'un nombre illimité d'offres. Sinon, il doit s'agir d'un nombre compris entre 1 et 50 (inclus).

RegionalPricingAndAvailabilityConfig

Configuration de la disponibilité et de la tarification régionales pour une offre de produit ponctuel.

Représentation 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.
}
Champs
regionCode

string

Obligatoire. Code de région auquel s'applique cette configuration, tel que défini par la norme ISO 3166-2, par exemple "US".

availability

enum (Availability)

Obligatoire. Disponibilité pour cette région.

Champ d'union price_override. Le remplacement du prix de cette offre. Un seul doit être défini. price_override ne peut être qu'un des éléments suivants :
noOverride

object (OneTimeProductOfferNoPriceOverrideOptions)

Le prix défini dans l'option d'achat pour cette région sera utilisé.

relativeDiscount

number

Fraction du prix de l'option d'achat que l'utilisateur paie pour cette offre. Par exemple, si le prix de l'option d'achat pour cette région est de 12 $, une remise de 50 % correspondrait à un prix de 6 $. La remise doit être spécifiée sous forme de fraction strictement supérieure à 0 et strictement inférieure à 1. Le prix obtenu sera arrondi à l'unité facturable la plus proche (par exemple, les centimes pour l'USD). La remise relative est considérée comme non valide si le prix remisé est inférieur au prix minimal autorisé dans cette région.

absoluteDiscount

object (Money)

Valeur absolue de la remise soustraite du prix de l'option d'achat.

Elle doit être comprise entre 0 et le prix de l'option d'achat.

OneTimeProductOfferNoPriceOverrideOptions

Ce type ne comporte aucun champ.

Options pour les offres de produits ponctuels sans remplacement du prix régional.

Disponibilité

Disponibilité de l'offre

Enums
AVAILABILITY_UNSPECIFIED Disponibilité non spécifiée. Ne doit pas être utilisé.
AVAILABLE L'offre est disponible pour les utilisateurs.
NO_LONGER_AVAILABLE L'offre n'est plus disponible pour les utilisateurs. Cette valeur ne peut être utilisée que si la disponibilité a été définie précédemment sur "DISPONIBLE".

Méthodes

activate

Active une offre de produit ponctuel.

batchDelete

Supprime une ou plusieurs offres de produits ponctuels.

batchGet

Lit une ou plusieurs offres de produits ponctuels.

batchUpdate

Crée ou met à jour une ou plusieurs offres de produits ponctuels.

batchUpdateStates

Met à jour l'état d'un lot d'offres de produits ponctuels.

cancel

Annule une offre de produit ponctuel.

deactivate

Désactive une offre de produit ponctuel.

list

Liste toutes les offres associées à une application, un produit ou une option d'achat donnés.