Performance reports

A API Merchant oferece relatórios de performance, por exemplo, product_performance_view. Esta página explica a estrutura dos relatórios de performance.

Métricas

É possível consultar as métricas (por exemplo, clicks e impressions) que você quer receber. É necessário adicionar um filtro no período para consultar o serviço de relatórios em busca de dados de performance.

Confira um exemplo de consulta que retorna uma única linha, com o número total de cliques no período especificado:

SELECT clicks
FROM product_performance_view
WHERE date BETWEEN '2023-12-01' AND '2023-12-21'

Você precisa especificar os dados que quer receber. Caracteres curinga (por exemplo, SELECT *) retornam um erro.

A resposta de exemplo a seguir mostra que o comerciante teve 4.440 cliques no total, em todos os produtos e métodos de marketing, entre 1º de dezembro de 2023 e 21 de dezembro de 2023.

{
  "results": [
    {
      "productPerformanceView": {
        "clicks": "4,440"
      }
    }
  ]
}

Importante: se você não selecionar nenhum campo de segmentos na consulta, só vai receber uma linha de métricas.

Segmentos

É possível usar campos de segmentos para segmentação nos relatórios de performance. Por exemplo, a consulta marketing_method retorna um relatório com uma linha para cada método de marketing e as métricas que você especifica para esse método na cláusula SELECT.

Os campos de segmentos podem ser atributos de produto (por exemplo, offer_id, brand e category) ou de evento (por exemplo, date e marketing_method).

Os campos de segmentos funcionam de maneira semelhante a um GROUP BY no SQL. Os campos de segmentos dividem as métricas selecionadas, agrupando-as por cada segmento na cláusula SELECT.

Confira um exemplo de consulta que retorna cliques por dia, em ordem decrescente por clicks, na condição adicionada de um período. Somente as linhas em que pelo menos uma métrica solicitada for diferente de zero são retornadas.

SELECT
  date,
  clicks
FROM product_performance_view
WHERE date BETWEEN '2023-12-01' AND '2023-12-03'
ORDER BY clicks DESC

A resposta de amostra a seguir mostra que o comerciante teve 1.546 cliques em todos os produtos e em todos os métodos de marketing em 1º de dezembro de 2023 e 829 cliques em todos os produtos e em todos os métodos de marketing em 2 de dezembro de 2023. O comerciante não teve cliques em 3 de dezembro de 2023, então nada é retornado para essa data.

{
  "results": [
    {
      "productPerformanceView": {
        "date": {
          "year": 2023,
          "month": 12,
          "day": 1
        },
        "clicks": "1546"
      }
    },
    {
      "productPerformanceView": {
        "date": {
          "year": 2023,
          "month": 12,
          "day": 2
        },
        "clicks": "829"
      }
    }
  ]
}

Importante :só é possível selecionar campos de segmentos específicos se você também selecionar métricas. Se você não selecionar nenhuma métrica na consulta, a API Merchant Reports vai retornar um erro.

Assim como nos relatórios personalizados do Merchant Center, é possível especificar vários segmentos na mesma consulta com a API Merchant Reports.

Confira um exemplo de consulta que retorna os cliques de todos os produtos na sua conta durante um período de 30 dias, segmentados por marketing_method e offer_id:

SELECT marketing_method, offer_id, clicks
FROM product_performance_view
WHERE date BETWEEN '2023-11-01' AND '2023-11-30'

A resposta dessa consulta inclui uma linha para cada combinação de offer_id e marketing_method, com o número de cliques para essa combinação:

{
  "results": [
    {
      "productPerformanceView": {
        "marketingMethod": "ADS",
        "offerId": "12345",
        "clicks": "38"
      }
    },
    {
      "productPerformanceView": {
        "marketingMethod": "ADS",
        "offerId": "12346",
        "clicks": "125"
      }
    },
    {
      "productPerformanceView": {
        "marketingMethod": "ORGANIC",
        "offerId": "12346",
        "clicks": "23"
      }
    },
    {
      "productPerformanceView": {
        "marketingMethod": "ADS",
        "offerId": "12347",
        "clicks": "8"
      }
    },
    {
      "productPerformanceView": {
        "marketingMethod": "ORGANIC",
        "offerId": "12347",
        "clicks": "3"
      }
    }
  ]
}

Atenção: como uma nova linha é retornada para cada combinação de campos de segmentos na cláusula SELECT, o número total de linhas na resposta aumenta exponencialmente com cada campo de segmentos adicional.

Categoria e tipo de produto

A linguagem de consulta do Merchant Center oferece suporte à segmentação de métricas por dois grupos de atributos que você pode definir para organizar seu inventário:

Níveis de categoria

Categorias da taxonomia de produtos do Google. O Google pode atribuir automaticamente a categoria ao seu produto se nenhuma foi fornecida ou refinar ainda mais a categoria fornecida.

Níveis de tipo de produto

Tipos de produtos que você atribui com base na sua categorização. Ao contrário dos níveis de categoria, não há um conjunto predefinido de valores aceitos.

Os atributos de categoria e tipo de produto são organizados em uma hierarquia com vários níveis. A especificação do produto separa cada nível com o caractere >, mas você seleciona cada nível da hierarquia separadamente nos relatórios.

Por exemplo, considere um produto com os seguintes níveis de tipo de produto:

Home & Garden > Kitchen & Dining > Kitchen Appliances > Refrigerators

Os relatórios retornam cada nível no próprio campo:

Segmento	Valor
product_type_l1	Home & Garden
product_type_l2	Kitchen & Dining
product_type_l3	Kitchen Appliances
product_type_l4	Refrigerators

Métricas de moeda e preço

As métricas de preço, como conversion_value, são representadas usando o tipo Price. Se a métrica estiver disponível em várias moedas, o valor de cada uma delas será retornado em uma linha separada. Por exemplo, a consulta a seguir:

SELECT conversion_value
FROM product_performance_view
WHERE date = '2023-11-01'

retorna os seguintes resultados:

{
  "results": [
    {
      "productPerformanceView": {
        "conversionValue": {
          "amountMicros": "150000000",
          "currencyCode": "USD"
        }
      }
    },
    {
      "productPerformanceView": {
        "conversionValue": {
          "amountMicros": "70000000",
          "currencyCode": "CAD"
        }
      }
    }
  ]
}

Se você solicitar métricas de preço e não preço em uma consulta, as métricas de preço serão retornadas em linhas de resultado separadas das métricas não relacionadas a preço, uma linha de resultado por código de moeda. Por exemplo, a consulta a seguir:

SELECT conversions, conversion_value
FROM product_performance_view
WHERE date = '2020-11-01'

retorna a seguinte resposta:

{
  "results": [
    {
      "productPerformanceView": {
        "conversions": "27",
        "conversionValue": {
          "amountMicros": "0",
          "currencyCode": ""
        }
      }
    },
    {
      "productPerformanceView": {
        "conversions": "0",
        "conversionValue": {
          "amountMicros": "150000000",
          "currencyCode": "USD"
        }
      }
    },
    {
      "productPerformanceView": {
        "conversions": "0",
        "conversionValue": {
          "amountMicros": "70000000",
          "currencyCode": "CAD"
        }
      }
    }
  ]
}

Todos os campos selecionados são retornados na resposta, mesmo que o valor ainda seja o padrão ou zero.