Visão geral

API Reporting

Com a API Reporting, o comerciante pode interagir com os dados de performance dele programaticamente, usando a linguagem de consulta do Merchant Center. Isso é semelhante a a 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 o seus sistemas de relatórios internos ou de terceiros.
• Permite que usuários, parceiros terceirizados e agregadores que gerenciam o Merchant Center Central de relatórios de acesso às contas.

Os usuários da API podem especificar quais dados de desempenho gostariam de recuperar no Pesquisar resposta da chamada, como:

• 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 sobre métricas de desempenho (cliques, impressões), possivelmente segmentadas por várias dimensões (atributos de eventos informados, como programa e data, e produtos atributos, como marca, categoria etc.), usando o método Search na serviço Reports.

O resultado de uma consulta ao serviço Reports é uma lista de ReportRow instâncias, com cada ReportRow representando os valores das métricas solicitadas para os segmentos especificados na consulta. Se nenhum segmento for especificado, um único é retornada com métricas agregadas em todos os segmentos. Caso contrário, se houver segmentos são solicitados junto com as métricas, a resposta mostrará uma linha para cada tupla de segmento único. É 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 quiser retornados. É necessário adicionar um filtro no período para consultar os relatórios serviço. O exemplo de consulta abaixo retorna uma única linha: o valor agregado 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. somada a 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, você também pode consultar segmentos, que podem ser um atributo do um produto (offer_id, brand, category etc.) ou um atributo de uma (date, program). Um evento informado é uma impressão ou um clique para um produto.

Os segmentos agem de forma semelhante a um GROUP BY no SQL. Os segmentos dividem os segmentos selecionados e agrupando por 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 de 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 para os produtos em todos os destinos no dia 1o de dezembro de 2020. e 829 cliques em todos os produtos em todos os destinos no 2 de dezembro de 2020. Nenhum objeto será retornado em 3 de dezembro de 2020 desde 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"
      }
    }
]}