A maneira de recuperar estatísticas e problemas agregados de produtos mudou. A funcionalidade que estava 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 aggregateProductStatuses
recurso.
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
accountstatusesda API Content for Shopping agora está dividido. Na API Merchant, os problemas no nível da conta estão disponíveis no recursoaccountissues, enquanto as estatísticas agregadas de produtos e os problemas no nível do item estão disponíveis no novo recursoaggregateProductStatuses. - Nova estrutura de recursos:
AggregateProductStatusé um novo recurso que representa as estatísticas e os problemas de uma combinação específica de contexto de relatórios e país. - Mecanismo de filtragem: em vez de usar parâmetros de consulta como
destinationspara selecionar dados, a API Merchant usa um métodolistcom umafilterstring para consultar contextos de relatórios e países específicos. - Remoção do campo de canal: o campo
channelnão é mais usado. Agora, essas informações fazem parte implicitamente doreportingContext.
Solicitações
A API Merchant usa uma solicitação GET com um parâmetro filter para recuperar status agregados do produto.
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 do produto | GET /content/v2.1/{merchantId}/accountstatuses/{accountId} |
GET /issueresolution/v1/accounts/{accountId}/aggregateProductStatuses |
Identificadores
A maneira 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. Fatias de dados específicas foram selecionadas 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 do produto foi atualizado para um método list que oferece suporte à 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 que contém 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órios 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 do produto 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 é substituído por reporting_context, que especifica o contexto do programa para as estatísticas. |
channel |
(nenhum campo equivalente) | O campo channel é removido. Agora, essas informações fazem parte do reporting_context. |
statistics |
stats |
O objeto statistics é renomeado para stats. Os nomes dos campos são convertidos para snake_case. Por exemplo, activeCount agora é active_count. |
itemLevelIssues.servability |
item_level_issues.severity |
O enum servability é substituído pelo enum severity para descrever o impacto de um problema. |
itemLevelIssues.attributeName |
item_level_issues.attribute |
O campo attributeName é renomeado para attribute. |
itemLevelIssues.documentation |
item_level_issues.documentation_uri |
O campo documentation é renomeado para documentation_uri. |
itemLevelIssues.numItems |
item_level_issues.product_count |
O campo numItems é renomeado para product_count. |