API Reporting
Com a API Reporting, um comerciante pode interagir com os dados de desempenho de maneira programática usando a linguagem de consulta do Merchant Center. Esse processo é 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 desempenho 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 os relatórios.
Os usuários da API podem especificar quais dados de desempenho querem recuperar na resposta da chamada de pesquisa, como:
- Métricas que serão retornadas (por exemplo: cliques, impressões)
- Dimensões em que os dados serão segmentados (por exemplo: OfferId, Data)
- 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
métricas de performance (cliques, impressões), possivelmente segmentadas por várias
dimensões (atributos de eventos 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 para o serviço Reports é uma lista de instâncias de ReportRow, em que cada ReportRow representa os valores das métricas solicitadas para os 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 com as métricas, a resposta vai mostrar uma linha para cada tupla de segmento única. É 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 retornar. É preciso adicionar um filtro no período para consultar o serviço de relatórios. O exemplo de consulta abaixo retorna uma única linha: o valor agregado 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 recebeu 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 decrescentes dentro da 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 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 em 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"
}
}
]}