Primeros pasos con la API de Singular Reporting

Documento

Bienvenido a la API de generación de informes de Singular, que ofrece estadísticas agregadas sobre sus campañas de marketing que puede incorporar a sus sistemas internos de BI o cuadros de mando de rendimiento de marketing.

Esta guía explica la API de generación de informes de Singular, cómo entender su caso de uso y cómo empezar a ejecutar consultas.

Lea esta guía en primer lugar y, a continuación, consulte laReferencia de la API deelaboración de informes para conocer los detalles técnicos.

¿Busca otra API?

¿O una función diferente?

Primeros pasos: Comprender su caso de uso

Singular recopila y sintetiza datos de diferentes orígenes (recomendamos leer Understanding Singular Reporting Data para una revisión en profundidad).

Cuando utiliza la API de generación de informes, puede elegir si desea ver

  • Datos agregados de sus redes publicitarias y agencias asociadas, como el coste de la campaña;
  • Datos agregados de su rastreador de atribución/MMP, que puede introducir en su sistema de BI y unir a los datos de la red según sea necesario;
  • O datos combinados, que son el resultado de la unión inteligente de Singular de los datos de la red y del rastreador para permitirle analizar su ROI con la mayor granularidad posible.

Aunque todas las consultas se ejecutan a través del mismo punto final (Crear informe asíncrono), difieren en los campos que se incluyen en la consulta.

Para empezar, comprenda lo que desea obtener de la API:

Su caso de uso:

Ver:

  • Utiliza Singular para recopilar datos de campañas de todas sus redes y agencias publicitarias.
  • Desea obtener datos sobre sus costes y tasas de ejecución.

Consulta de datos de red

  • Utiliza el servicio de atribución de Sing ular o ha configurado un conector de datos para su rastreador de atribución de terceros.
  • Desea extraer datos del rastreador, como conversiones e ingresos, e ingerirlos en su plataforma de BI o para su análisis.
  • Si une los datos del rastreador a los datos de la red publicitaria (como el coste de la campaña) para calcular su ROAS, tiene previsto utilizar sus propias herramientas para hacerlo.

Consulta de los datos del rastreador y los datos de la red por separado

  • Utiliza el servicio de atribución de Singular o ha configurado un conector de datos para su rastreador de atribución de terceros.
  • Desea aprovechar la lógica ya preparada de Singular para unir los datos de la red y del rastreador con la mayor granularidad posible.

Consulta de datos combinados

Tipos de datos disponibles a través de la API de generación de informes

Consulta de datos de red

Losdatos de red incluyen las estadísticas de campaña de todas las redes publicitarias que haya configurado en Singular. No incluye datos de su rastreador de atribución (si ha configurado alguno en Singular).

Por ejemplo, puede ejecutar una consulta para ver el coste (adn_cost) de cada una de sus campañas (adn_campaign_id) en un intervalo de fechas determinado.

Screen_Shot_2020-07-01_at_0.14.09.png

Campos disponibles para datos de red

Consulte la página Métricas y dimensiones para obtener una descripción de cada campo.

Dimensiones de red

Dimensiones básicas (deberían estar disponibles para todas las redes):

  • app
  • fuente
  • adn_campaign_id
  • adn_campaign_name
  • adn_campaign_url
  • id_conector_datos
  • nombre_fuente_conector_datos
  • nombre_usuario_del_conector_de_datos
  • data_connector_timestamp_utc

Dimensiones adicionales opcionales (el soporte varía según la red):

  • os
  • plataforma
  • campo_país
  • campo_región
  • campo_ciudad
  • campo_id_dma
  • campo_nombre_dma
  • adn_sub_adnetwork_name
  • adn_account_id
  • adn_account_name
  • adn_sub_campaign_id
  • adn_sub_campaign_name

Desglose de palabras clave y/o editores (el soporte varía según la red, no se puede extraer en la misma consulta que el desglose creativo):

  • keyword_id
  • palabra clave
  • publisher_id
  • publisher_site_id
  • publisher_site_name

Desglose creativo (el soporte varía según la red, normalmente no se puede extraer en la misma consulta que palabra clave/editor):

  • creative_type
  • adn_creative_id
  • adn_creative_name
  • creative_url
  • imagen_creativa
  • texto_creativo
  • ancho_creativo
  • altura_creativa
  • creative_is_video
  • asset_id
  • asset_name

Propiedades de la campaña (más información):

  • bid_type
  • estrategia_de_puja
  • importe_puja
  • objetivo_campaña
  • tipo_puja_estandarizada
  • estrategia_de_puja_estandarizada
  • importe_puja_original
  • estado_de_la_campaña
  • min_roas
  • original_metadata_currency

Dimensiones personalizadas:

Si ha definido dimensiones personalizadas basadas en estas dimensiones de red predeterminadas, puede extraerlas utilizando sus ID. Utilice el punto final de dimensiones personalizadas para obtener todas las dimensiones personalizadas definidas en su cuenta y sus ID.

Métricas de red
  • adn_cost
  • adn_original_cost
  • adn_original_currency
  • adn_impresiones
  • adn_clicks
  • adn_installs

Notas:

  • Singular intenta ofrecerle el mayor nivel de granularidad disponible, pero no todas las redes proporcionan todas las dimensiones. Consulte Conectores de datos en detalle para obtener más información sobre los datos que Singular extrae de cada fuente.
  • Estadísticas como impresiones, clics e instalaciones reportadas por una red publicitaria pueden no coincidir con las estadísticas reportadas por su rastreador de atribución.

Consulta por separado de los datos del rastreador y de los datos de la red

Puede utilizar la API para extraer datos del rastreador: estadísticas del servicio de atribución de Singular o de un rastreador de atribución de terceros que haya configurado en Singular (como Appsflyer o Google Analytics).

Por ejemplo, puede ejecutar una consulta para ver los clics (tracker_clicks) y las instalaciones (tracker_installs) de cada una de sus campañas (tracker_campaign_id) en un intervalo de fechas determinado. Las estadísticas del rastreador también incluyen eventos posteriores a la instalación e ingresos.

Screen_Shot_2020-07-01_at_0.15.21.png

Tras realizar una consulta sobre los datos del rastreador, puede unirlos a los datos de su red para poder calcular el IPC o el ROI de su campaña.

Sin embargo, ejecutar un informe combinado suele ser una forma más sencilla de obtener el mismo resultado.

Campos disponibles para los datos del seguidor

Consulte la página Métricas y dimensiones para obtener una descripción de cada campo.

Dimensiones del rastreador

Dimensiones básicas (deberían estar disponibles para todas las redes):

  • app
  • fuente
  • tracker_campaign_id

Dimensiones adicionales opcionales (el soporte varía según el rastreador):

  • tracker_campaign_name
  • os
  • plataforma
  • campo_país

Dimensiones personalizadas:

Si ha definido dimensiones personalizadas basadas en estas dimensiones predeterminadas del rastreador, puede extraerlas utilizando sus ID. Utilice el punto final de dimensiones personalizadas para obtener todas las dimensiones personalizadas definidas en su cuenta y sus ID.

Métricas del rastreador

Métricas básicas:

  • tracker_impressions
  • tracker_clicks
  • tracker_installs
  • tracker_conversions
  • seguimiento_recompromisos
  • usuarios_activos_diarios

Métricas decohorte:

  • ingresos
  • ingresos_originales

Para obtener una lista completa de las métricas de cohorte que puede utilizar, consulte el punto final Métricas de cohorte. Para obtener más información, consulte ¿Qué son las métricas de cohortes?

Tenga en cuenta que las métricas de cohortes incluyen cálculos basados en ratios como CPE y CPI. No recomendamos su uso en los informes de la API(más información).

Eventos:

Puede obtener las estadísticas de cualquier evento que haya definido. Tenga en cuenta que en lugar de utilizar el nombre del evento definido en la aplicación Singular, debe utilizar el ID generado automáticamente por el evento, que puede obtener en el punto final de métricas de cohortes.

Consulta de datos combinados

Puede utilizar la API para ejecutar una consulta combinada de red y rastreador, que muestra tanto los costes de su campaña como sus ingresos u otros KPI de rendimiento de campaña.

Este tipo de consulta hace uso de dimensiones y métricas especiales que se basan en los datos del rastreador y de la red, pero implican una lógica adicional entre bastidores, como se detalla a continuación.

Screen_Shot_2020-07-01_at_0.16.14.png

¿Qué hace una consulta combinada?

  1. Incluye estadísticas de red (como el coste) y estadísticas del rastreador (como las instalaciones y los ingresos) en la misma consulta.
  2. Las dimensiones inteligentes ayudan a combinar los datos de la red y del rastreador en la misma fila siempre que sea posible.

    Las dimensiones "combinadas" o "unificadas" de Singular se basan tanto en los datos de red como en los de seguimiento. Singular las procesa para corregir desajustes de datos comunes y asegurarse de que usted vea sus datos combinados con la mayor granularidad posible.

    Por ejemplo, el nombre de una campaña específica en el rastreador puede ser ligeramente diferente del nombre de la campaña extraído de la red publicitaria. Así que si ejecuta un informe de seguimiento y un informe de red y une los resultados, puede obtener filas divididas para la campaña, donde una fila tiene estadísticas de red y la otra tiene estadísticas de seguimiento. Pero si ejecuta un informe combinado (utilizando la dimensión unified_campaign_name), Singular se asegura de que pueda obtener tanto estadísticas de red como de seguimiento en la misma fila para la campaña.

  3. Las métricas inteligentes y personalizables extraen los datos de la fuente adecuada en cada caso.

    En situaciones en las que la misma estadística es ofrecida tanto por la red como por el rastreador, por ejemplo, el número de instalaciones por campaña en un intervalo de fechas determinado, la métrica combinada le ofrece una única fuente de verdad, eligiendo de forma inteligente la estadística del rastreador o la de la red basándose en el uso estándar del sector.

    Por ejemplo, la métrica custom_installs contiene el número de instalaciones del rastreador, a menos que se trate de una red autoatribuida(SAN) como Facebook o Twitter, en cuyo caso la estadística de red es más importante, y custom_installs contiene la métrica de red.

    Si la opción por defecto de Singular no funciona para su caso específico, puede hacer que Singular reconfigure métricas específicas para usted.

    Nota: las métricas personalizadas no están disponibles para los desgloses creativos. Seleccione métricas de red o métricas de seguimiento.

¿Qué ocurre si necesito conocer la fuente de mis métricas?

Es posible que desee conocer la fuente exacta de cada métrica para cada campaña, por ejemplo, si está intentando encontrar y solucionar discrepancias significativas entre la red y el rastreador.

En ese caso, puede añadir la métrica de red (consulte Campos disponibles para datos de red) y la métrica del seguidor (consulte Campos disponibles para datos del seguidor) al informe combinado. Por ejemplo, extraiga las tres métricas de instalación: custom_installs, adn_installs, tracker_installs.

De esta forma, puede utilizar custom_installs como su KPI pero ver si hay una diferencia significativa entre adn_installs y tracker_installs.

Campos disponibles para datos combinados

Consulte la página Métricas y dimensiones para obtener una descripción de cada campo.

Dimensiones

Dimensiones básicas (deberían estar disponibles para todas las redes y rastreadores):

  • app
  • fuente
  • unified_campaign_id
  • unified_campaign_name

Dimensiones adicionales opcionales (la compatibilidad varía según la red o el rastreador):

  • os
  • plataforma
  • campo_país
  • adn_sub_adnetwork_ name
  • adn_account_id
  • adn_account_name
  • sub_campaign_id
  • sub_campaign_name

Desglose de palabras clave y/o editores (el soporte varía según la red/seguidor, no se puede extraer en la misma consulta que el desglose creativo):

  • keyword_id
  • palabra clave
  • publisher_id
  • publisher_site_id
  • publisher_site_name

Desglose creativo (el soporte varía según la red, sólo disponible para usuarios del servicio de atribución de Singular):

  • tipo_creativo
  • adn_creative_id
  • adn_creative_name
  • URL_creativa
  • imagen_creativa
  • texto_creativo
  • ancho_creativo
  • altura_creativa
  • creative_is_video

Dimensiones personalizadas:

Si ha definido dimensiones personalizadas basadas en estas dimensiones predeterminadas, puede extraerlas utilizando sus ID. Utilice el punto final de dimensiones personalizadas para obtener todas las dimensiones personalizadas definidas en su cuenta y sus ID.

Métricas

Métricas básicas:

  • adn_cos
  • adn_coste_original
  • adn_original_currency
  • custom_impressions
  • custom_clicks
  • custom_installs
  • tracker_conversions
  • tracker_reengagements
  • usuarios_activos_diarios

Métricas para creatividades de vídeo y campañas basadas en vídeo:

  • video_views
  • video_views_25pct
  • video_views_50pct
  • video_views_75pct
  • visionados_vídeo_completados
  • índice_vídeo_visto_completado

Métricas de la cohorte:

  • ingresos
  • ingresos_originales

Para obtener una lista completa de las métricas de cohorte que puede utilizar, consulte el punto final Métricas de cohorte. Para obtener más información, consulte ¿Qué son las métricas de cohortes?

Tenga en cuenta que las métricas de cohortes incluyen cálculos basados en ratios como CPE y CPI. No recomendamos su uso en los informes de la API(más información).

Eventos:

Puede obtener las estadísticas de cualquier evento que haya definido. Tenga en cuenta que en lugar de utilizar el nombre del evento como se define en la aplicación Singular, tiene que utilizar el ID autogenerado del evento, que puede obtener desde el punto final de métricas de cohortes.

Notas:

    • Singular intenta ofrecerle el mayor nivel de granularidad disponible, pero no todas las redes y rastreadores admiten todos los desgloses. Consulte Conectores de datos en detalle para obtener más información sobre los datos que Singular extrae de cada fuente.
  • Los informes combinados a nivel creativo sólo están disponibles para los usuarios del servicio de atribución de Singular.
  • Las métricas personalizadas no están disponibles para los desgloses creativos. Seleccione métricas de red ("adn_...") o métricas de seguimiento ("tracker_...").

Resumen: ¿Qué tipos de datos están disponibles para usted?

Utilizo Singular para...
Analytics + Singular Attribution Sólo Analytics, pero configuro Singular para que extraiga datos de mi rastreador de terceros Extraer datos sólo de mis redes publicitarias
Datos de red Disponible Disponible Disponible
Datos de seguimiento Disponible Disponible -
Campos combinados Disponible Disponible para redes autoatribuidas (sin desglose creativo) -

Cómo consultar la API de informes

Una vez que haya decidido qué tipo de datos desea consultar y haya hecho una lista de las métricas y dimensiones específicas que le interesan, a continuación se explica cómo utilizar la API de elaboración de informes.

Ejecución de una consulta básica

1

Consulte el punto final Crear informe asíncrono (consulte la referencia del punto final), especificando las métricas y dimensiones que ha elegido.

Esto generará una consulta de informe asíncrona y devolverá un ID de informe.

2

Utilizando el ID del informe, consulte el endpoint de la API Get Report Status (ver referencia del endpoint) para ver cuándo ha terminado de ejecutarse el informe.

Cuando el informe haya finalizado, el endpoint Obtener Estado del Informe devolverá una URL del informe.

3

Descargue el informe desde la URL del informe.

Screen_Shot_2021-07-07_at_16.48.30.png

Nota: Debido a la gran cantidad de datos procesados por Singular, recomendamos filtrar cada consulta a una sola fuente (red) o conector de datos y a un solo día. Por ejemplo, si está ejecutando un informe sobre sus campañas de Facebook de los últimos 7 días, ejecute 7 informes distintos. Así te asegurarás de que las consultas no sean demasiado pesadas.

Informes diarios

Los datos de Singular se actualizan diariamente. Por lo general, querrás extraer tus datos de Singular todos los días, incluidos:

  • Datos de ayer
  • Datos históricos que puedan haber sido actualizados por sus redes.

En sus informes diarios habituales, le recomendamos que utilice las siguientes ventanas temporales para extraer datos históricos:

Tipo de consulta Ventana de tiempo recomendada
Datos de red 7 días atrás.
Datos de seguimiento o datos combinados Un período tan largo como su período de cohorte más largo. Por ejemplo, si tiene cohortes de 30 días, consulte 30 días atrás. Si no está extrayendo datos de cohortes, como ingresos, suele ser suficiente con extraer datos de 7 días atrás.

Comprobación de la disponibilidad de datos

Puede utilizar el punto final Estado de disponibilidad de datos para comprobar para cada conector de datos si Singular tiene datos de ese conector para la fecha dada, y cuándo fue la última vez que se actualizaron los datos.

El uso más común de este punto final es comprobar si los datos ya están disponibles para ayer para cada uno de sus conectores de datos. De esta forma, si todos los conectores de datos están listos, puede empezar a ejecutar informes para todos sus datos. Si sólo algunos de los conectores de datos tienen datos mientras que otros no, usted decide si desea esperar a que todos terminen o ejecutar un informe en cada fuente de datos a medida que sus datos estén disponibles. (Para ejecutar un informe en un único conector de datos en Crear informe asíncrono, filtre el informe por data_connector_id).

Tenga en cuenta que Singular no recomienda ejecutar un informe en más de un conector/fuente de datos en la misma consulta.

Screen_Shot_2021-07-07_at_16.48.49.png

Nota sobre "conector de datos" frente a "fuente":

En Singular, una "fuente" es un socio de red publicitaria del que Singular extrae sus datos publicitarios. Un "conector de datos " es una herramienta que se conecta a una red publicitaria y extrae datos de ella.

Dependiendo de su configuración, puede tener varios conectores de datos que compartan la misma fuente. Esto significa que extraen datos en Singular desde la misma plataforma (pero con diferentes nombres de cuenta, configuraciones, etc.).

El punto final de disponibilidad de datos devuelve la disponibilidad por conector de datos en lugar de por fuente. Si utiliza el nuevo parámetro "expanded=true" (recomendado), los resultados incluyen el parámetro data_connector_id, que puede utilizar para filtrar su informe.

Consejo: data_connector_id es un campo de red. Si ejecuta un informe que incluye datos de red y de rastreador, incluir data_connector_id significa que los datos de red y de rastreador se dividirán en filas separadas (consulte Unir datos de red y de rastreador">Unir datos de red y de rastreador). Para solucionarlo, cuando empiece a procesar los resultados en su plataforma de BI, simplemente agrupe los resultados por origen y no incluya el campo data_connector_id.

Comprobación de la actualidad de los datos

Para ver cómo de actualizados están los datos de su red en Singular, incluya la dimensión data_connector_timestamp_utc en la consulta de su informe.

Esta dimensión incluye la fecha y la hora en que Singular comenzó a extraer los datos del conector de datos (independientemente del tiempo que se tardó en ingerir, procesar y guardar los datos en la base de datos de Singular).Screen_Shot_2021-07-07_at_16.49.09.png

Algunos ejemplos de casos de uso de la marca de tiempo de los datos son:

  • Si está experimentando discrepancias entre los informes de Singular y los datos de su cuadro de mando de red.
  • Si está utilizando destinos de datos de Singular (ETL) para extraer datos de Singular en su plataforma de BI y desea ver si Singular tiene datos más recientes.

Consejo: data_connector_id es un campo de red. Si ejecuta un informe que incluye datos de red y de rastreador, la inclusión de data_connector_id significa que los datos de red y de rastreador se dividirán en filas separadas (consulte Unión de datos de red y de rastreador).