API Reporting
Com a API Reporting, o comerciante pode interagir com os dados de performance de maneira 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 oferece os seguintes benefícios:
- Permite que grandes comerciantes importem dados de performance das informações do produto para os 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 querem recuperar na resposta da chamada de pesquisa, por exemplo:
- Métricas a serem retornadas (por exemplo, cliques, impressões)
- Dimensões nas quais segmentar os dados (por exemplo: OfferId, Date)
- Condições que precisam ser atendidas (por exemplo: cliques > 100)
A linguagem de consulta da API Reporting pode consultar a API Content for Shopping para conferir
métricas de performance (cliques, impressões), possivelmente segmentadas por várias
dimensões (atributos de eventos informados, como programa e data, e atributos
do 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, em que cada ReportRow representa os valores das métricas solicitadas dos segmentos especificados na consulta. Se nenhum segmento for especificado, uma única linha será retornada com métricas agregadas em todos os segmentos. Caso contrário, se algum segmento for solicitado junto com as métricas, a resposta 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
Consulte as métricas (cliques, impressões, CTR etc.) que você quer retornar. É preciso adicionar um filtro no período para consultar o serviço Relatórios. O exemplo de consulta abaixo retorna uma única linha: a quantidade agregada de cliques na 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 de código JSON abaixo mostra como esse comerciante teve 4.440 cliques somados em todos os produtos em todos os destinos entre 1o de dezembro de 2020 e 21 de dezembro de 2020.
{"results": [
{
"metrics": {
"clicks": "4,440"
}
}
]}
Consultar segmentos
Além das métricas, também é possível consultar segmentos, que podem ser um atributo de um produto (offer_id, brand, category etc.) ou de um evento informado (date, program). Um evento informado é uma impressão ou um clique de um produto.
Os segmentos agem de forma semelhante a um GROUP BY no SQL. Os segmentos dividem as métricas selecionadas, agrupando por cada segmento na cláusula SELECT. O exemplo de consulta abaixo retorna cliques por dia, ordenados por cliques em ordem decrescente dentro da condição adicionada em um período. Somente as linhas em que pelo menos uma métrica solicitada é 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 de código JSON abaixo mostra como esse comerciante recebeu 1.546 cliques em todos os produtos em todos os destinos em 1o 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, já que o comerciante não teve cliques naquele dia.
{
"results": [
{
"segments": {
"date": {
"year": 2020,
"month": 12,
"day": 1
}
},
"metrics": {
"clicks": "1546"
}
},
{
"segments": {
"date": {
"year": 2020,
"month": 12,
"day": 2
}
},
"metrics": {
"clicks": "829"
}
}
]}