REST Resource: purchases.productsv2

Ressource : ProductPurchaseV2

Une ressource ProductPurchaseV2 indique l'état de l'achat d'un produit intégré par un utilisateur.

Représentation JSON
{
  "productLineItem": [
    {
      object (ProductLineItem)
    }
  ],
  "kind": string,
  "purchaseStateContext": {
    object (PurchaseStateContext)
  },
  "testPurchaseContext": {
    object (TestPurchaseContext)
  },
  "orderId": string,
  "obfuscatedExternalAccountId": string,
  "obfuscatedExternalProfileId": string,
  "regionCode": string,
  "purchaseCompletionTime": string,
  "acknowledgementState": enum (AcknowledgementState)
}
Champs
productLineItem[]

object (ProductLineItem)

Contient des informations au niveau de l'article pour un ProductPurchaseV2.

kind

string

Ce type représente un objet ProductPurchaseV2 dans le service androidpublisher.

purchaseStateContext

object (PurchaseStateContext)

Informations sur l'état de l'achat.

testPurchaseContext

object (TestPurchaseContext)

Informations sur les achats tests. Ce paramètre ne sera défini que pour les achats tests.

orderId

string

ID de la commande associée à l'achat du produit intégré. Ne peut pas être défini si aucun bon de commande n'est associé à l'achat.

obfuscatedExternalAccountId

string

Version obscurcie de l'ID associé de manière unique au compte de l'utilisateur dans votre application. N'est présent que s'il a été spécifié à l'aide de https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid lors de l'achat.

obfuscatedExternalProfileId

string

Version obscurcie de l'ID associé de manière unique au profil de l'utilisateur dans votre application. N'est présent que s'il a été spécifié à l'aide de https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid lors de l'achat.

regionCode

string

Code de région de facturation ISO 3166-1 alpha-2 de l'utilisateur au moment où le produit lui a été accordé.

purchaseCompletionTime

string (Timestamp format)

Heure à laquelle l'achat a été effectué, c'est-à-dire lorsque PurchaseState est passé à PURCHASED. Ce champ ne s'affiche qu'une fois le paiement effectué. Par exemple, si l'utilisateur a lancé une transaction en attente (https://developer.android.com/google/play/billing/integrate#pending), ce champ ne sera pas renseigné tant que l'utilisateur n'aura pas effectué les étapes requises pour finaliser la transaction.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

acknowledgementState

enum (AcknowledgementState)

Uniquement en sortie. État de confirmation de l'achat.

PurchaseStateContext

Contexte de l'état de l'achat.

Représentation JSON
{
  "purchaseState": enum (PurchaseState)
}
Champs
purchaseState

enum (PurchaseState)

Uniquement en sortie. État de l'achat.

PurchaseState

États d'achat possibles.

Enums
PURCHASE_STATE_UNSPECIFIED État de l'achat non spécifié. Cette valeur ne doit jamais être définie.
PURCHASED Achat effectué.
CANCELLED Commande annulée.
PENDING L'achat est en attente et n'a pas encore été finalisé. Pour en savoir plus sur la gestion des achats en attente, consultez la page https://developer.android.com/google/play/billing/integrate#pending.

TestPurchaseContext

Contexte d'un achat test.

Représentation JSON
{
  "fopType": enum (FopType)
}
Champs
fopType

enum (FopType)

Type de FOP de l'achat test.

FopType

Types de FOP possibles.

Enums
FOP_TYPE_UNSPECIFIED Type de FOP non spécifié. Cette valeur ne doit jamais être définie.
TEST L'achat a été effectué à l'aide d'une carte test.

ProductLineItem

Contient des informations au niveau de l'article pour un ProductPurchaseV2.

Représentation JSON
{
  "productId": string,
  "productOfferDetails": {
    object (ProductOfferDetails)
  }
}
Champs
productId

string

ID du produit acheté (par exemple, "mensuel001").

productOfferDetails

object (ProductOfferDetails)

Détails de l'offre pour cet article.

ProductOfferDetails

Informations sur les détails de l'offre concernant un élément de ligne d'achat.

Représentation JSON
{
  "offerTags": [
    string
  ],
  "offerId": string,
  "purchaseOptionId": string,
  "rentOfferDetails": {
    object (RentOfferDetails)
  },
  "offerToken": string,
  "quantity": integer,
  "refundableQuantity": integer,
  "consumptionState": enum (ConsumptionState)
}
Champs
offerTags[]

string

Les derniers tags d'offre associés à l'offre. Il inclut les tags hérités de l'option d'achat.

offerId

string

ID de l'offre. Uniquement présent pour les offres.

purchaseOptionId

string

ID de l'option d'achat.

rentOfferDetails

object (RentOfferDetails)

Fournissez des informations sur les offres de location. Ce paramètre ne sera défini que pour les éléments de campagne de location.

offerToken

string

Jeton d'offre par transaction utilisé pour créer cet élément de ligne d'achat.

quantity

integer

Quantité associée à l'achat du produit intégré.

refundableQuantity

integer

Quantité éligible au remboursement, c'est-à-dire la quantité qui n'a pas encore été remboursée. La valeur reflète les remboursements partiels et totaux basés sur la quantité.

consumptionState

enum (ConsumptionState)

Uniquement en sortie. État de consommation de l'achat.

RentOfferDetails

Ce type ne comporte aucun champ.

Informations sur l'offre liées à un élément de campagne de location.

ConsumptionState

États de consommation possibles.

Enums
CONSUMPTION_STATE_UNSPECIFIED État de consommation non spécifié. Cette valeur ne doit jamais être définie.
CONSUMPTION_STATE_YET_TO_BE_CONSUMED Pas encore consommé.
CONSUMPTION_STATE_CONSUMED Déjà utilisé.

AcknowledgementState

État d'accusé de réception du produit ponctuel.

Enums
ACKNOWLEDGEMENT_STATE_UNSPECIFIED État d'accusé de réception non spécifié.
ACKNOWLEDGEMENT_STATE_PENDING L'achat n'a pas encore été confirmé.
ACKNOWLEDGEMENT_STATE_ACKNOWLEDGED L'achat est confirmé.

Méthodes

getproductpurchasev2

Vérifie l'état d'achat et de consommation d'un article intégré.

Codes d'erreur

Les opérations de cette ressource renvoient les codes d'erreur HTTP suivants :

Code d'erreur Motif Solution
5xx Erreur générique sur le serveur Google Play. Réessayez d'envoyer votre demande.

Si le problème persiste, contactez votre responsable de compte Google Play ou envoyez une demande d'assistance. Pensez à consulter le tableau de bord d'état Play pour voir si des interruptions de service sont connues.

409 Erreur de mise à jour simultanée.

Une tentative de mise à jour d'un objet en cours de mise à jour a été effectuée. Par exemple, un achat est confirmé en appelant la méthode acknowledgePurchase() de la bibliothèque Play Billing et la méthode purchases.products.acknowledge de l'API Play Developer en même temps.

Réessayez d'envoyer votre demande.