Migrar "accountstatuses" para "Aggregate Product Statuses"

A forma de recuperar estatísticas e problemas agregados de produtos mudou. A funcionalidade que antes estava disponível no recurso accountstatuses na API Content for Shopping agora está dividida em recursos dedicados na API Merchant. Este guia explica como migrar sua integração para usar o novo recurso aggregateProductStatuses.

principais diferenças

Confira as principais diferenças entre os recursos de status do produto na API Content for Shopping e na API Merchant:

  • Recursos dedicados: o recurso accountstatuses da API Content for Shopping agora está dividido. Na API Merchant, os problemas no nível da conta estão disponíveis no recurso accountissues, enquanto as estatísticas agregadas de produtos e os problemas no nível do item estão disponíveis no novo recurso aggregateProductStatuses.
  • Nova estrutura de recursos: AggregateProductStatus é um novo recurso que representa as estatísticas e os problemas de uma combinação específica de um contexto de relatório e um país.
  • Mecanismo de filtragem: em vez de usar parâmetros de consulta como destinations para selecionar dados, a API Merchant usa um método list com uma string filter para consultar contextos e países específicos de relatórios.
  • Remoção do campo de canal: o campo channel não é mais usado. Agora, essas informações fazem parte implicitamente do reportingContext.

Solicitações

A API Merchant usa uma solicitação GET com um parâmetro filter para recuperar status de produtos agregados. Para mais informações sobre a sintaxe do filtro, consulte Sintaxe do filtro.

GET https://merchantapi.googleapis.com/issueresolution/v1/{parent=accounts/*}/aggregateProductStatuses

Formato do URL de solicitação

Descrição da solicitação API Content for Shopping API Merchant
Receber estatísticas e problemas de produtos GET /content/v2.1/{merchantId}/accountstatuses/{accountId} GET /issueresolution/v1/accounts/{accountId}/aggregateProductStatuses

Identificadores

A maneira como os recursos são identificados mudou para dar suporte à nova estrutura.

Formato do identificador

Descrição do identificador API Content for Shopping API Merchant
Identificador de recursos O recurso foi identificado por accountId. Frações de dados específicas foram selecionadas com parâmetros de consulta. O nome do recurso identifica de forma exclusiva os dados de um contexto de relatório e país específicos: accounts/{account}/aggregateProductStatuses/{reportingContext}~{country}.

Métodos

O método para recuperar status de produtos foi atualizado para um método list que aceita filtragem.

Método da API Content for Shopping Método da API Merchant Disponibilidade e observações
accountstatuses.get aggregateProductStatuses.list O método accountstatuses.get retornava um único recurso com todas as estatísticas do produto. O novo método aggregateProductStatuses.list retorna uma lista de recursos, um para cada combinação de contexto de relatório e país. Use o parâmetro filter para recuperar dados específicos. Para problemas no nível da conta, use accountissues.list.

Mudanças detalhadas nos campos

Os campos de estatísticas e problemas de produtos foram atualizados e reestruturados no novo recurso AggregateProductStatus.

API Content for Shopping API Merchant Descrição
products aggregate_product_statuses A matriz products foi substituída pelo campo repetido aggregate_product_statuses na resposta da lista.
destination reporting_context O campo destination foi substituído por reporting_context, que especifica o contexto do programa para as estatísticas.
channel (nenhum campo equivalente) O campo channel foi removido. Essas informações agora fazem parte do reporting_context.
statistics stats O objeto statistics foi renomeado como stats. Os nomes de campo são convertidos em snake_case. Por exemplo, activeCount agora é active_count.
itemLevelIssues.servability item_level_issues.severity O tipo enumerado servability foi substituído pelo tipo enumerado severity para descrever o impacto de um problema.
itemLevelIssues.attributeName item_level_issues.attribute O campo attributeName foi renomeado como attribute.
itemLevelIssues.documentation item_level_issues.documentation_uri O campo documentation foi renomeado como documentation_uri.
itemLevelIssues.numItems item_level_issues.product_count O campo numItems foi renomeado como product_count.