Guide du développeur de l'API Play Catalog

L'API Play Catalog permet aux plates-formes de téléchargement d'applications tierces enregistrées sur Google Play d'interroger les mises à jour du catalogue d'applications Google Play. 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 de l'API

L'exportation du catalogue Play est générée toutes les 24 heures. L'API Play Catalog 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 déterminer les noms de package qui ont été modifiés ou supprimés.
  2. Récupérer des 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 changé dans une fenêtre temporelle spécifique, appelez la appstorecatalog.recentUpdateEvents.list méthode.

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

  • avoir activé l'inclusion dans le catalogue pour la plate-forme de téléchargement d'applications appelante ;
  • être publiées et disponibles 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 lorsque l'application a récemment activé l'inclusion dans votre catalogue.
  • DELETION: déclenché lorsqu'une application est non publiée, désactivée de l'inclusion dans le catalogue, suspendue ou bloquée, ou qu'elle cesse de cibler les États-Unis.

2. Récupérer les vues d'application du catalogue

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

3. Bonnes pratiques et synchronisation

Pour maintenir une base de données de catalogue cohérente sur votre plate-forme, suivez ces consignes d'intégration :

  • Synchronisation quotidienne de l'exportation : 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.
    • Traiter les mises à jour:
      • 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 ou masquez-la aux 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 dans la fenêtre temporelle interrogée. appstorecatalog.recentAppViews.get renvoie toujours la vue d'application de la dernière modification.