Descripción general

API de informes

La API de informes permite que un comercio interactúe con sus datos de rendimiento de manera programática a través del lenguaje de consultas de Merchant Center. Esto es similar a la capacidad de crear informes personalizados directamente en Merchant Center. La API de informes tiene los siguientes beneficios:

  • Permite que los grandes comercios importen datos de rendimiento de las fichas de productos a sus sistemas de informes internos o de terceros.
  • Permite que los usuarios, socios externos y agregadores que administran cuentas de Merchant Center accedan a los informes.

Los usuarios de la API pueden especificar qué datos de rendimiento desean recuperar en la respuesta de la llamada de búsqueda, por ejemplo:

  • Métricas que se mostrarán (por ejemplo: clics, impresiones)
  • Dimensiones en las que se segmentarán los datos (por ejemplo: OfferId, Date)
  • Condiciones que se deben cumplir (por ejemplo: Clics > 100)

El lenguaje de consulta de la API de Reporting puede consultar a Content API for Shopping para obtener métricas de rendimiento (clics, impresiones), posiblemente segmentadas por varias dimensiones (atributos del evento informados, como el programa y la fecha, y atributos del producto, como la marca, la categoría, etc.), mediante el método Search en el servicio Reports.

El resultado de una consulta al servicio Reports es una lista de instancias de ReportRow, en la que cada ReportRow representa los valores de las métricas solicitadas para los segmentos que especificaste en tu consulta. Si no se especifican segmentos, se muestra una sola fila con métricas agregadas en todos los segmentos. De lo contrario, si se solicita algún segmento junto con las métricas, la respuesta muestra una fila por cada tupla de segmento única. Es posible seleccionar varios segmentos y varias métricas en una sola consulta.

Cómo consultar métricas

Puedes consultar las métricas (clics, impresiones, CTR, etc.) que deseas que se muestren. Debes agregar un filtro en el período para consultar el servicio de informes. La siguiente consulta de muestra muestra una sola fila: la cantidad total de clics dentro de la condición agregada de un período.

SELECT metrics.clicks
FROM MerchantPerformanceView
WHERE segments.date BETWEEN '2020-12-01' AND '2020-12-21';

Respuesta de muestra

La respuesta de código JSON de muestra que aparece a continuación muestra cómo este comercio obtuvo 4,440 clics en todos sus productos en todos sus destinos entre el 1 y el 21 de diciembre de 2020.

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

Consulta de segmentos

Además de las métricas, también puedes consultar por segmentos, que pueden ser un atributo de un producto (offer_id, brand, category, etc.) o un atributo de un evento informado (date, program). Un evento informado es una impresión o un clic de un producto.

Los segmentos actúan de manera similar a un GROUP BY en SQL. Los segmentos dividen las métricas seleccionadas y agrupan por cada segmento en la cláusula SELECT. La siguiente consulta de muestra muestra los clics por día, ordenados por clics en orden descendente dentro de la condición agregada de un período. Solo se mostrarán las filas en las que al menos una métrica solicitada no sea cero.

SELECT
  segments.date,
  metrics.clicks
FROM MerchantPerformanceView
WHERE segments.date BETWEEN '2020-12-01' AND '2020-12-03'
ORDER BY metrics.clicks DESC;

Respuesta de muestra

La respuesta de código JSON de muestra que aparece a continuación muestra cómo este comercio recibió 1,546 clics en todos sus productos de todos sus destinos el 1 de diciembre de 2020 y 829 clics en todos los productos de todos sus destinos el 2 de diciembre de 2020. No se mostrará ningún objeto hasta el 3 de diciembre de 2020, ya que el comercio no recibió clics ese día.

{
  "results": [
    {
      "segments": {
        "date": {
          "year": 2020,
          "month": 12,
          "day": 1
        }
      },
      "metrics": {
        "clicks": "1546"
      }
    },
    {
      "segments": {
        "date": {
          "year": 2020,
          "month": 12,
          "day": 2
        }
      },
      "metrics": {
        "clicks": "829"
      }
    }
]}