Gérer les droits d'accès aux offres privées

Lorsqu'un client achète une offre privée, Google crée un droit d'accès, qui indique que le client a acheté l'offre sur Cloud Marketplace.

Cet article explique comment gérer les droits d'accès de vos offres privées en utilisant l'API Partner Procurement.

Pour en savoir plus sur l'utilisation de l'API Partner Procurement pour les offres privées, consultez la page la documentation de référence.

Approuver un droit

Lorsqu'un client achète une offre privée, Cloud Marketplace crée un et envoie le message Pub/Sub suivant à votre produit:

{
  "eventId": "...",
  "eventType": "ENTITLEMENT_CREATION_REQUESTED",
  "entitlement": {
  "id": "ENTITLEMENT_ID",
  "updateTime": "...",
  "newOfferDuration": "P1Y6M", // Contract duration for the offer
  "newOfferEndTime": "", // Ending time for the offer
  },
}

Dans cet exemple, ENTITLEMENT_ID est un ID créé par Cloud Marketplace.

Si l'offre a été créée avec une durée, le message affiche la durée au format années et mois, et le champ newOfferEndTime est vide. Si l'offre était créé avec une heure de fin spécifiée, le message indique la date de fin de l'offre l'heure, et le champ newOfferDuration est vide.

Dans votre système, mettez à jour le compte de l'utilisateur pour indiquer qu'il a acheté l'offre. Pour approuver le droit, envoyez une requête HTTP POST à l'API Partner Procurement et envoyez l'ID ENTITLEMENT_ID que vous approuvez :

POST v1/providers/YOUR_PARTNER_ID/entitlements/ENTITLEMENT_ID:approve

Refuser un droit d'accès

Pour refuser un droit d'accès, utilisez la méthode reject dans votre requête HTTP POST:

POST v1/providers/YOUR_PARTNER_ID/entitlements/ENTITLEMENT_ID:reject

Remplacer une offre active

Selon la configuration de votre offre privée, votre client pourra peut-être remplacer son offre. Si un client sélectionne une nouvelle offre privée, vous recevez un message Pub/Sub au format suivant :

{
  "eventId": "...",
  "eventType": "ENTITLEMENT_PLAN_CHANGE_REQUESTED",
  "entitlement": {
  "id": "ENTITLEMENT_ID",
  "newPlan": "ultimate",   // New plan for the offer,
  "newOffer": "OFFER2",    // New offer,
  "updateTime": "...",
  "newOfferDuration": "P2Y",   // Contract duration for the new offer
  },
}

Dans cet exemple, OFFER2 correspond à l'offre de remplacement. ENTITLEMENT_ID est un ID créé par Cloud Marketplace. L'offre la durée est indiquée en années et en mois.

Pour approuver le remplacement de l'offre, envoyez la requête HTTP POST suivante à l'API Partner Procurement :

POST v1/providers/YOUR_PARTNER_ID/entitlements/ENTITLEMENT_ID:approvePlanChange

L'organisme demandeur doit avoir le plan de l'offre en cours d'approbation :

{
  "pendingPlanName": PLAN_NAME
}

Une fois la modification approuvée, vous recevez un autre message Pub/Sub lorsque la modification prend effet. Dans le message, le champ eventType devient ENTITLEMENT_PLAN_CHANGED. Pour vérifier l'état d'un plan, effectuez les opérations suivantes : HTTP GET à l'API Partner Procurement:

GET v1/providers/YOUR_PARTNER_ID/entitlements/ENTITLEMENT_ID

La réponse est semblable à la suivante, avec le champ d'état indiquant si la nouvelle offre est active ou si le changement d'offre est toujours en attente.

{
  "name": "providers/PARTNER_ID/entitlements/ENTITLEMENT_ID",
  "provider": "PARTNER_ID",
  "account": "USER_ACCOUNT_ID",
  "product": "example-server",
  "Offer":   "OFFER1",
  "plan": "pro",
  "state": "ENTITLEMENT_PENDING_PLAN_CHANGE",
  "newPendingOffer": "OFFER2",
  "newPendingPlan": "ultimate",
  "newOfferDuration": "P2Y",
  "newOfferEndTime": "",
  ...
}

Effectuer d'autres tâches de droit d'accès

Pour les autres tâches de droit qui ne sont pas spécifiques aux offres privées, consultez la documentation publique de Cloud Marketplace :

Liste des types d'événements pour les tâches de compte avec offre privée

Le tableau suivant inclut les eventType que votre produit peut recevoir dans Messages Pub/Sub pour les offres privées.

Pour obtenir la liste complète, consultez la liste des types d'événements pour les tâches de compte.

eventType Description
ENTITLEMENT_OFFER_ENDED Indique que l'offre privée d'un client est arrivée à expiration. L'offre déclenche un événement ENTITLEMENT_CANCELLED ou reste active avec un prix sans remise.

Étape suivante