API de informes
La API de Informes permite que un comercio interactúe con sus datos de rendimiento de forma programática a través del lenguaje de consultas de Merchant Center. Esta función es similar a la capacidad de crear informes personalizados directamente en Merchant Center. La API de Reporting tiene los siguientes beneficios:
- Permite que los comercios grandes importen datos de rendimiento de las fichas de productos a sus sistemas de informes internos o de terceros.
- Permite que los usuarios, los socios externos y los 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 a Search, por ejemplo:
- Métricas que se devolverán (por ejemplo, Clics, Impresiones)
- Dimensiones según las cuales se segmentarán los datos (por ejemplo, OfferId, Date)
- Condiciones que se deben cumplir (por ejemplo, Clics > 100)
El lenguaje de consultas de la API de Reporting puede consultar la API de Content for Shopping para obtener métricas de rendimiento (clics, impresiones), posiblemente segmentadas por varias dimensiones (atributos de eventos registrados, como programa y fecha, y atributos de productos, como marca, categoría, etcétera), con el método Search en el servicio Reports.
El resultado de una consulta al servicio de 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 devuelve una sola fila con las métricas agregadas en todos los segmentos. De lo contrario, si se solicitan segmentos junto con las métricas, la respuesta muestra una fila para cada tupla de segmento única. Es posible seleccionar varios segmentos y varias métricas en una sola consulta.
Consulta 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 Reports. La siguiente consulta de ejemplo devuelve una sola fila: la cantidad agregada 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 ejemplo que se muestra a continuación indica que este comercio tuvo 4,440 clics en total en todos sus productos y destinos entre el 1 y el 21 de diciembre de 2020.
{"results": [
{
"metrics": {
"clicks": "4,440"
}
}
]}
Consulta segmentos
Junto con las métricas, también puedes consultar segmentos, que pueden ser un atributo de un producto (offer_id, brand, category, etc.) o un atributo de un evento registrado (date, program). Un evento registrado es una impresión o un clic para un producto.
Los segmentos actúan de manera similar a un GROUP BY en SQL. Los segmentos dividen las métricas seleccionadas y las agrupan según cada segmento de la cláusula SELECT. La siguiente consulta de ejemplo devuelve los clics por día, ordenados de forma descendente según la cantidad de clics dentro de la condición agregada de un período. Solo se devolverá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 siguiente respuesta de código JSON de ejemplo muestra cómo este comercio tuvo 1,546 clics en todos sus productos y destinos el 1 de diciembre de 2020, y 829 clics en todos sus productos y destinos el 2 de diciembre de 2020. No se devolverá ningún objeto para el 3 de diciembre de 2020, ya que el comercio no tuvo 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"
}
}
]}