Méthodes d'API

GetReader

GetReader permet à un éditeur de vérifier si l'un de ses lecteurs avec un PPID connu a associé son abonnement à Google. À l'aide d'une requête GET, l'éditeur interroge un PPID associé à un ID de publication spécifique.

Requête

//GET /v1/publications/dailybugle.com/readers/6789

Réponse

Le point de terminaison renvoie soit un code 200 avec un corps JSON contenant l'created_time de l'abonnement associé, soit une erreur si aucun PPID n'est trouvé pour la publication. Pour en savoir plus, consultez la section Erreurs.

{
  "name": "publications/gtech-demo.appspot.com/readers/81112",  
  "create_time": "2022-04-19T04:53:40+00:00"
}

GetReaderEntitlements

GetReaderEntitlements permet à un éditeur d'interroger les droits d'accès pour un PPID qu'il a précédemment fourni. À l'aide d'une demande GET, l'éditeur demande les droits d'accès en fournissant un PPID et un ID de publication.

Requête

//GET /v1/publications/dailybugle.com/readers/6789/entitlements

Réponse

Si une requête aboutit, le format renvoyé est identique à celui utilisé pour stocker les droits d'accès avec la propriété UpdateReaderEntitlements PATCH.

{ 
  "name": "publications/dailybugle.com/readers/6789/entitlements",
  "entitlements": [  
      {
        "product_id": "dailybugle.com:basic",
        "subscription_token": "dnabhdufbwinkjanvejskenfw",
        "detail": "This is our basic plan",
        "expire_time": "2022-08-19T04:53:40+00:00"
      },
      {
        "product_id": "dailybugle.com:premium",
        "subscription_token": "wfwhddgdgnkhngfw",
        "detail": "This is our premium plan",
        "expire_time": "2022-07-19T04:53:40+00:00"
      },
      {
        "product_id": "dailybugle.com:deluxe",
        "subscription_token": "fefcbwinkjanvejfefw",
        "detail": "This is our deluxe plan",
        "expire_time": "2022-08-20T04:53:40+00:00"
      }
  ]
}

Pour les utilisateurs qui ne disposent pas de droits d'accès, mais qui ont un PPID associé (par exemple, un droit d'accès qui a expiré et a été supprimé définitivement), une demande de droits d'accès renvoie un tableau des droits d'accès vide dans l'objet des droits standards.

{ 
  "name": "publications/dailybugle.com/readers/6789/entitlements",
  "createTime": "2023-02-07T17:38:57.425577Z"
}

UpdateReaderEntitlements

UpdateReaderEntitlements permet de créer et de mettre à jour les droits d'accès d'un lecteur en fonction de son PPID.

Cet exemple de charge utile accorde au lecteur avec le PPID 6789 des droits d'accès à trois ID produit pour The Daily Bugle: dailybugle.com:basic, dailybugle.com:premium et dailybugle.com:deluxe. Lorsque le lecteur 6789 utilise ensuite les surfaces Google pour la recherche et Discover, la liste "Sources : vos abonnements" affiche tous les résultats pertinents provenant d'articles de dailybugle.com tagués avec l'un de ces ID produit.

Remarque :Cette méthode permet à la fois de créer les droits d'accès initiaux d'un lecteur et de les mettre à jour.

Requête

//PATCH /v1/publications/dailybugle.com/readers/6789/entitlements

{
  "name": "publications/dailybugle.com/readers/6789/entitlements",
  "entitlements": [  
      {
        "product_id": "dailybugle.com:basic",
        "subscription_token": "dnabhdufbwinkjanvejskenfw",
        "detail": "This is our basic plan",
        "expire_time": "2022-08-19T04:53:40+00:00"
      },
      {
        "product_id": "dailybugle.com:premium",
        "subscription_token": "wfwhddgdgnkhngfw",
        "detail": "This is our premium plan",
        "expire_time": "2022-07-19T04:53:40+00:00"
      },
      {
        "product_id": "dailybugle.com:deluxe",
        "subscription_token": "fefcbwinkjanvejfefw",
        "detail": "This is our deluxe plan",
        "expire_time": "2022-08-20T04:53:40+00:00"
      }
  ]
}

Réponse

Si une opération PATCH réussit, l'objet entitlements enregistré est renvoyé, au même format que GetReaderEntitlements.

DeleteReader

DeleteReader permet à un éditeur de supprimer manuellement l'abonnement associé d'un lecteur. À l'aide d'une requête DELETE, l'éditeur envoie un PPID pour qu'un ID de publication soit supprimé.

Remarque :Les lecteurs ne doivent pas disposer de droits d'accès à jour pour pouvoir être supprimés. Si vous devez supprimer un lecteur avec des droits d'accès actuels, vous devez d'abord supprimer ses droits d'accès avec UpdateReaderEntitlements avec un tableau vide. Le lecteur peut ensuite être supprimé.

Requête

//DELETE /v1/publications/dailybugle.com/readers/6789

Réponse

Une suppression réussie renvoie un code 200 avec un objet JSON {} vide.

{}