Guide du développeur de l'API Play Catalog

L'API Play Catalog permet aux magasins d'applications tiers (3PAS) enregistrés sur Google Play d'interroger le catalogue d'applications Google Play pour obtenir des mises à jour. Les appelants peuvent récupérer les détails du catalogue pour les applications qui ont été modifiées ou supprimées depuis la dernière exportation quotidienne du catalogue.

Pour obtenir la liste complète des points de terminaison, des méthodes et des schémas de ressources, consultez la documentation de référence de l'API Play Catalog.

Avant de commencer

Vous devez suivre le guide de démarrage principal pour configurer votre accès à l'API, vos identifiants de service et votre projet Google Cloud avant de pouvoir effectuer des appels à l'API Play Catalog.

Conception et architecture des API

L'exportation du catalogue Play est générée toutes les 24 heures. L'API Catalogue Play fournit un mécanisme d'interrogation intrajournalier pour récupérer les mises à jour qui ont eu lieu depuis la dernière exportation :

  1. Interroger les événements de mise à jour : vous interrogez appstorecatalog.recentUpdateEvents.list avec une fenêtre startTime et endTime pour trouver les noms de packages qui ont été modifiés ou supprimés.
  2. Récupérer les vues détaillées : pour chaque nom de package modifié, vous appelez appstorecatalog.recentAppViews.get pour récupérer les métadonnées CatalogAppView détaillées.

L'API est en lecture seule et est limitée aux événements survenus au cours des 36 dernières heures. L'API a une limite de 2 RPS partagée entre les deux méthodes.

1. Interroger les événements de mise à jour du catalogue

Pour récupérer la liste des packages qui ont été modifiés au cours d'une période spécifique, appelez la méthode appstorecatalog.recentUpdateEvents.list.

Seuls les événements de mise à jour pour les applications éligibles sont renvoyés. Les applications éligibles doivent :

  • L'inclusion du catalogue pour la plate-forme de téléchargement d'applications d'appel a été activée.
  • Publiée et disponible aux États-Unis sur le Google Play Store.

Comprendre les types de mises à jour

  • MODIFICATION : déclenché lorsqu'une application éligible est modifiée, publiée pour la première fois, commence à cibler les États-Unis ou lorsqu'elle a été ajoutée à votre catalogue.
  • DELETION : déclenché lorsqu'une application est non publiée, exclue de l'inclusion dans le catalogue, suspendue ou bloquée, ou lorsqu'elle cesse de cibler les États-Unis.

2. Récupérer les vues des applications du catalogue

Pour chaque package renvoyé avec un événement MODIFICATION, vous pouvez récupérer les détails mis à jour de son catalogue en appelant la méthode appstorecatalog.recentAppViews.get.

3. Bonnes pratiques et synchronisation

Pour maintenir une base de données de catalogue cohérente dans votre boutique, suivez ces consignes d'intégration :

  • Synchronisation de l'exportation quotidienne : importez la liste complète des applications éligibles à l'aide de l'exportation quotidienne du catalogue.
  • (Facultatif) Synchronisation intrajournalière : interrogez régulièrement le point de terminaison appstorecatalog.recentUpdateEvents.list (par exemple, toutes les minutes) avec une fenêtre temporelle mobile. Assurez-vous de gérer la pagination à l'aide de nextPageToken.
    • Mises à jour concernant les processus :
      • Pour les événements MODIFICATION, récupérez le CatalogAppView mis à jour à l'aide de appstorecatalog.recentAppViews.get et mettez à jour votre base de données locale.
      • Pour les événements DELETION, supprimez l'application des fiches de votre plate-forme de téléchargement ou masquez-la pour les utilisateurs.
    • Gérer les événements de modification répétés : vous pouvez voir plusieurs événements MODIFICATION pour la même application. Cela signifie que l'application a été modifiée plusieurs fois au cours de la période demandée. appstorecatalog.recentAppViews.get renverra toujours la vue Application de la dernière modification.