API Reporting
A API Reporting permite que um comerciante trabalhe com os dados de performance de forma programática usando a linguagem de consulta do Merchant Center. Isso é semelhante à capacidade de criar relatórios personalizados diretamente no Merchant Center. A API Reporting tem os seguintes benefícios:
- Permite que grandes comerciantes importem dados de performance das listagens de produtos para sistemas de relatórios internos ou de terceiros.
- Permite que usuários, parceiros terceirizados e agregadores que gerenciam contas do Merchant Center acessem relatórios.
Os usuários da API podem especificar quais dados de desempenho gostariam de recuperar na resposta da chamada de pesquisa, como:
- Métricas a serem retornadas (por exemplo, cliques, impressões)
- Dimensões para segmentar os dados (por exemplo, OfferId, Date)
- Condições que precisam ser atendidas (por exemplo, cliques > 100)
A linguagem de consulta da API Reports pode consultar a API Content para o Shopping em busca de
métricas de performance (cliques, impressões), possivelmente segmentadas por várias
dimensões (atributos de evento informados, como programa e data, e atributos de
produto, como marca, categoria etc.), usando o método Search no
serviço Reports.
O resultado de uma consulta ao serviço Reports é uma lista de instâncias ReportRow, com cada ReportRow representando os valores das métricas solicitadas
para os segmentos especificados na consulta. Se nenhum segmento for especificado, uma única linha será retornada com as métricas agregadas em todos os segmentos. Caso contrário, se algum segmento for solicitado com métricas, a resposta vai mostrar uma linha para cada tupla de segmento exclusiva. É possível selecionar vários segmentos e
várias métricas em uma única consulta.
Consultar métricas
É possível consultar as métricas (cliques, impressões, CTR etc.) que você quer receber. É necessário adicionar um filtro ao período para consultar o serviço de relatórios. A consulta de exemplo abaixo retorna uma única linha: o valor agregado de cliques dentro da condição adicionada de um período.
SELECT metrics.clicks
FROM MerchantPerformanceView
WHERE segments.date BETWEEN '2020-12-01' AND '2020-12-21';
Exemplo de resposta
O exemplo de resposta do código JSON abaixo mostra como esse comerciante teve 4.440 cliques somados em todos os produtos em todos os destinos entre 1º de dezembro de 2020 e 21 de dezembro de 2020.
{"results": [
{
"metrics": {
"clicks": "4,440"
}
}
]}
Consultar segmentos
Além das métricas, você também pode consultar segmentos, que podem ser um atributo de
um produto (offer_id, brand, category etc.) ou um atributo de um evento
informado (date, program). Um evento informado é uma impressão ou um clique para um
produto.
Os segmentos funcionam de maneira semelhante a um GROUP BY no SQL. Os segmentos dividem as métricas selecionadas, agrupando-as por cada segmento na cláusula SELECT. A consulta de exemplo abaixo
retorna cliques por dia, ordenados por cliques em ordem decrescente na condição adicionada
de um período. Somente as linhas em que pelo menos uma métrica solicitada for diferente de zero serão
retornadas.
SELECT
segments.date,
metrics.clicks
FROM MerchantPerformanceView
WHERE segments.date BETWEEN '2020-12-01' AND '2020-12-03'
ORDER BY metrics.clicks DESC;
Exemplo de resposta
O exemplo de resposta do código JSON abaixo mostra como esse comerciante teve 1.546 cliques em todos os produtos em todos os destinos em 1º de dezembro de 2020 e 829 cliques em todos os produtos em todos os destinos em 2 de dezembro de 2020. Nenhum objeto será retornado para 3 de dezembro de 2020, porque o comerciante não teve cliques nesse dia.
{
"results": [
{
"segments": {
"date": {
"year": 2020,
"month": 12,
"day": 1
}
},
"metrics": {
"clicks": "1546"
}
},
{
"segments": {
"date": {
"year": 2020,
"month": 12,
"day": 2
}
},
"metrics": {
"clicks": "829"
}
}
]}