Guia da API Play Catalog para desenvolvedores

A API Play Catalog permite que app stores de terceiros (3PAS, na sigla em inglês) registradas no Google Play sondem atualizações no catálogo de apps do Google Play. Os autores das chamadas podem recuperar detalhes do catálogo de apps que foram modificados ou removidos desde a última exportação diária.

Confira uma lista completa de endpoints, métodos e esquemas de recursos na Referência da API Play Catalog.

Antes de começar

Você precisa concluir o guia de iniciação principal para configurar o acesso à API, as credenciais de serviço e o projeto do Google Cloud antes de fazer chamadas para a API Play Catalog.


Design e arquitetura da API

A exportação do catálogo do Google Play é gerada a cada 24 horas. A API Play Catalog oferece um mecanismo de sondagem intradiária para recuperar atualizações que ocorreram desde a última exportação:

  1. Sondar eventos de atualização: consulte appstorecatalog.recentUpdateEvents.list com um período de startTime a endTime para descobrir quais nomes de pacotes foram modificados ou excluídos.
  2. Buscar visualizações detalhadas: para cada nome de pacote que passou por mudanças, chame appstorecatalog.recentAppViews.get para ver os metadados de CatalogAppView.

A API é somente leitura e retorna apenas eventos que ocorreram nas últimas 36 horas. Ela tem um limite de 2 QPS compartilhado entre os dois métodos.


1. Sondagem de eventos de atualização do catálogo

Para conseguir a lista de pacotes que mudaram em um período específico, chame o método appstorecatalog.recentUpdateEvents.list.

Só vão aparecer eventos de atualização para apps qualificados, que precisam:

  • Ter ativado a inclusão de catálogo para a app store de chamada.
  • Estar publicados e disponíveis nos Estados Unidos (EUA) na Google Play Store.

Sobre os tipos de atualização

  • MODIFICATION: acionada quando um app qualificado é modificado, é publicado pela primeira vez, começa a segmentar os EUA ou optou recentemente por ser incluído no seu catálogo.
  • DELETION: acionada quando um app tem a publicação cancelada, opta por sair do catálogo, é suspenso/bloqueado ou para de segmentar os EUA.

2. Como recuperar visualizações de apps do catálogo

Para cada pacote retornado com um evento MODIFICATION, é possível buscar os detalhes atualizados do catálogo chamando o método appstorecatalog.recentAppViews.get.


3. Práticas recomendadas e sincronização

Para manter um banco de dados de catálogo consistente na sua loja, siga estas diretrizes de integração:

  • Sincronização diária da exportação: importe a lista completa de apps qualificados usando a exportação diária do catálogo.
  • (Opcional) Sincronização intradiária: sonde o endpoint appstorecatalog.recentUpdateEvents.list regularmente (por exemplo, a cada minuto) com um período móvel. Confira se você está processando a paginação com o nextPageToken.
    • Processe atualizações:
      • Para eventos MODIFICATION, busque CatalogAppView atualizado usando appstorecatalog.recentAppViews.get e atualize seu banco de dados local.
      • Para eventos DELETION, remova o app das páginas de detalhes da loja ou oculte-o dos usuários.
    • Lide com eventos de modificação repetidos: talvez apareçam vários eventos MODIFICATION para o mesmo app. Isso significa que ele passou por várias mudanças no período consultado. appstorecatalog.recentAppViews.get sempre vai retornar a visualização do app da mudança mais recente.