Guida per gli sviluppatori dell'API Play Catalog

L'API Play Catalog consente agli store di app di terze parti (3PAS) registrati su Google Play di eseguire il polling per gli aggiornamenti del catalogo di app di Google Play. I chiamanti possono recuperare i dettagli del catalogo per le app che sono state modificate o rimosse dall'ultima esportazione giornaliera del catalogo.

Per un elenco completo di endpoint, metodi e schemi di risorse, consulta il Riferimento API Play Catalog.

Prima di iniziare

Prima di poter effettuare chiamate all'API Play Catalog, devi completare la Guida introduttiva principale per configurare l'accesso all'API, le credenziali di servizio e il progetto Google Cloud.

Architettura e design dell'API

L'esportazione del catalogo Play viene generata ogni 24 ore. L'API Play Catalog fornisce un meccanismo di polling infragiornaliero per recuperare gli aggiornamenti avvenuti dall'ultima esportazione:

  1. Esegui il polling per gli eventi di aggiornamento: esegui una query su appstorecatalog.recentUpdateEvents.list con una startTime e endTime finestra per trovare i nomi dei pacchetti modificati o eliminati.
  2. Recupera le visualizzazioni dettagliate: per ogni nome del pacchetto modificato, chiama appstorecatalog.recentAppViews.get per recuperare i metadati dettagliati di CatalogAppView.

L'API è di sola lettura ed è limitata alla restituzione degli eventi avvenuti nelle ultime 36 ore. L'API ha un limite di QPS di 2 condiviso tra entrambi i metodi.

1. Eseguire il polling per gli eventi di aggiornamento del catalogo

Per recuperare l'elenco dei pacchetti modificati in un intervallo di tempo specifico, chiama il appstorecatalog.recentUpdateEvents.list metodo.

Vengono restituiti solo gli eventi di aggiornamento per le app idonee. Le app idonee devono:

  • Avere attivato l'inclusione nel catalogo per lo store di app chiamante.
  • Essere pubblicate e disponibili negli Stati Uniti sul Google Play Store.

Informazioni sui tipi di aggiornamento

  • MODIFICATION: attivato quando un'app idonea viene modificata, pubblicata per la prima volta, inizia a essere rivolta agli Stati Uniti o quando l'app ha appena attivato l'inclusione nel tuo catalogo.
  • DELETION: attivato quando un'app viene annullata la pubblicazione, disattivata l'inclusione nel catalogo, sospesa o bloccata oppure non è più rivolta agli Stati Uniti.

2. Recuperare le visualizzazioni delle app del catalogo

Per ogni pacchetto restituito con un evento MODIFICATION, puoi recuperare i dettagli del catalogo aggiornati chiamando il metodo appstorecatalog.recentAppViews.get.

3. Best practice e sincronizzazione

Per mantenere un database del catalogo coerente nel tuo store, segui queste linee guida per l'integrazione:

  • Sincronizzazione dell'esportazione giornaliera: importa l'elenco completo delle app idonee utilizzando l' esportazione giornaliera del catalogo.
  • (Facoltativo) Sincronizzazione infragiornaliera: esegui regolarmente il polling dell'endpoint appstorecatalog.recentUpdateEvents.list (ad es. ogni minuto) con una finestra temporale mobile. Assicurati di gestire la paginazione utilizzando nextPageToken.
    • Elabora gli aggiornamenti:
      • Per gli eventi MODIFICATION, recupera CatalogAppView aggiornato utilizzando appstorecatalog.recentAppViews.get e aggiorna il database locale.
      • Per gli eventi DELETION, rimuovi l'app dalle schede dello store o nascondila agli utenti.
    • Gestisci gli eventi di modifica ripetuti: potresti visualizzare più eventi MODIFICATION per la stessa app. Ciò significa che l'app è stata modificata più volte nella finestra temporale di cui hai eseguito la query. appstorecatalog.recentAppViews.get restituirà sempre la visualizzazione dell'app dell'ultima modifica.