Migrar "accountstatuses" para "Aggregate Product Statuses"

Mudamos a forma de recuperar estatísticas e problemas agregados de produtos. A funcionalidade antes disponível no recurso accountstatuses da 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.

Observação: na API Merchant, os problemas no nível da conta e os status agregados dos produtos são divididos. Consulte também nosso guia para migrar de accountstatuses para problemas com a conta.

principais diferenças

Estas são as principais diferenças entre os recursos de status do produto na API Content do 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 geração de relatórios.
  • Remoção do campo "Canal": o campo channel não é mais usado. Essas informações agora 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.

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

Formato do URL da 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 forma como os recursos são identificados mudou para oferecer 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. Segmentos de dados específicos foram selecionados com parâmetros de consulta. O nome do recurso identifica exclusivamente os dados de um contexto de relatórios 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 retornou um único recurso com todas as estatísticas de produtos. 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 é 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 é removido. Essas informações agora fazem parte do reporting_context.
statistics stats O objeto statistics foi renomeado como stats. Os nomes dos campos são convertidos para snake_case. Por exemplo, activeCount agora é active_count.
itemLevelIssues.servability item_level_issues.severity A enumeração servability foi substituída pela enumeração 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.