Raw data de transmisión de Push API

Premium
Para:
Marketers Desarrolladores
Última actualización:

En resumen: Transmite el raw data de eventos de atribución a tus puntos de conexión del lado del servidor.

6970_Push_API_image.png

API push

La Push API transmite el raw data generado por la atribución de AppsFlyer y la atribución de SKAdNetwork (SKAN) como mensajes a tus servidores. Puedes seleccionar los tipos y el contenido de los mensajes y establecer los puntos de conexión de destino.

Los tipos de mensajes disponibles, la actualización de los datos y los campos dependen del marco de atribución (AppsFlyer o SKAN) como se describe en las secciones siguientes. 

Mensajes de atribución de AppsFlyer

Características del mensaje

Característica Detalles
Segregación de tipos de mensajes
  • Los mensajes se pueden segregar por punto de conexión (máximo de 6 puntos de conexión por aplicación) o puedes determinar el tipo de mensaje examinando el valor de los campos enumerados:
    • event_name
    • conversion_type
    • campaign_type 
  • Los valores de los campos, por tipo de mensaje, se indican en la tabla siguiente.

Ejemplo:

Un mensaje contiene lo siguiente:

  • conversion_type=install
  • campaign_type=organic
  • event_name=install

Usa la tabla para determinar que este evento es el evento de instalación de un usuario orgánico. 
Actualización de los datos

Los mensajes se envían poco después de que el evento se registra en la plataforma de AppsFlyer. Esto suele ser en cuestión de minutos. 
Contenido del mensaje (campos)
  • Los mensajes tienen una estructura key:value.
  • Consulta los campos de la Push API de atribución de AppsFlyer disponibles.
  • Cada clave representa un campo de raw data. Consulta la descripción de los campos de raw data en AppsFlyer. 
  • Las claves en blanco o nulas no se envían en absoluto.
  • El ejemplo contiene campos nulos y vacíos. Los postbacks reales no tienen campos vacíos ni nulos. El ejemplo proporcionado tiene un formato JSON.
Formato de los campos de marca de tiempo
  • Para campos de marca de tiempo en UTC: yyyy-mm-dd hh:mm:ss.sss. Por ejemplo, se muestra como 2019-09-17 00:09:00.123. Un evento tuvo lugar a las 18:00 hora de Tokio. La hora del evento se convierte a UTC, que es a las 09:00. La hora registrada es la de UTC. 
  • Marcas de tiempo de la zona horaria seleccionada (específicas de la aplicación): yyyy-mm-dd hh:mm:ss.sss±th:tm. Por ejemplo 2019-09-17 18:00:16.000+0900. Un evento tuvo lugar a las 18:00 hora de Tokio. La hora del evento que se muestra se registra como 18:00+09:00. 09:00 es la zona horaria de Tokio. 

Tipos de mensajes disponibles

Contexto de atribución Tipo de mensaje Campo conversion_type campo campaign_type campo event_name Campo event_type
La adquisición de usuarios Instalación* install

No orgánica: UA

Orgánico: organic

install

  • install

  • organic-install
Adquisición de usuarios  Instalar eventos in-app install

No orgánica: UA

Orgánico: organic

Nombres de eventos definidos por el anunciante

  • install-in-app-event

  • organic-install-in-app-event

Retargeting

 Re-engagement re-engagement retargeting re-engagement

re-engagement
Retargeting  Eventos in-app de recaptación re-engagement retargeting Nombres de eventos definidos por el anunciante

re-engagement-in-app-event
Retargeting  Reatribución  Reinstalación retargeting Reatribución

Reatribución
Adquisición de usuarios  Reinstalación Reinstalación

No orgánica: UA

Orgánico: organic

Reinstalación

  • Reinstalación

  • organic-reinstall
Retargeting Eventos in-app de reatribución Reinstalación retargeting Nombres de eventos definidos por el anunciante

re-attribution-in-app-event
* Algunas instalaciones relacionadas con la atribución por impresiones se atribuyen a la fuente de medios restringida.

Campos exclusivos

Nombre para mostrar Nombre de Push API
Divisa seleccionada* selected_currency
Ingresos en la divisa seleccionada revenue_in_selected_
currency
Costo en la divisa seleccionada cost_in_selected_
currency
Zona horaria seleccionada para la hora de descarga del dispositivo device_download_time_selected_timezone
Zona horaria seleccionada para la hora de toque atribuido attributed_touch_time_selected_timezone
Zona horaria seleccionada para la hora de instalación install_time_selected_
timezone
Zona horaria seleccionada para la hora del evento event_time_selected_
timezone

Zona horaria seleccionada(*)

 selected_timezone
* Esta es la configuración vigente a nivel aplicación en el momento en que se envía el mensaje API.

Mensajes de atribución de SKAN

Esta sección describe los mensajes (tipos de reportes) disponibles para SKAN y cómo identificar los mensajes. Lee esta sección y, a continuación, Configura el punto de conexión de atribución de SKAN.

Lectura relacionada: Campos de raw data de SKAN. Los mensajes de la Push API tienen la estructura y los campos equivalentes. 

Características del mensaje:

Característica Detalles
Segregación de tipos de mensajes
  • Todos los mensajes se envían al punto de conexión 1 que has configurado.
  • Para determinar el tipo de mensaje, usa los siguientes campos:
    • event_name
    • skad_redownload
  • Los valores de los campos, por tipo de mensaje, se indican en la tabla siguiente.

Ejemplo:

Un mensaje contiene lo siguiente:

  • event_name: install
  • skad_redownload: true

Debido a que skad_redownload: true, determina que se trata de un evento de redescarga. 
Actualización de los datos
  • Instalaciones, redescarga y eventos in-app:
    • Procesado diariamente
    • Enviados a tu punto de conexión el día siguiente a la recepción del postback de iOS por parte de AppsFlyer
    • Seguramente recibirán mensajes de eventos de 05:00 a 08:00 UTC (la hora exacta varía)
    • Ejemplo: los postbacks recibidos el lunes se envían a partir del martes a las 05:00 UTC
  • Copia de postbacks de iOS y postbacks: los mensajes se envían poco después de que llegan a AppsFlyer
Ejemplo de mensajes La hoja de cálculo contiene ejemplos de mensajes. El ejemplo proporcionado tiene un formato JSON.Mensajes de ejemplo SKAN.

Tipos de mensajes para la atribución de SKAN

Tipo de mensaje 

campo event_name

campo skad_redownload

Campo event_type
Instalaciones  install
  • Valores posibles: falso, en blanco, nulo.
  • Si el campo no está en el mensaje, considera el valor como falso. 

skad-installs
Redescargas  install True

skad-re-downloads
Eventos in-app 

Nombre del evento configurado por el anunciante

 Nombre del evento configurado por el anunciante

skad-in-app-events
Postbacks de iOS

Nunca disponible en este mensaje

 A veces disponible

skad-postbacks
Copia de postbacks

Nunca disponible en este mensaje

 A veces disponible

skad-postbacks-copy


Determinar el tipo de mensaje de atribución de SKAN

Nota: Esto no se aplica a los mensajes de copia de postbacks, que llegan directamente desde iOS.

PushAPI-2_en-us.png

Configurar los puntos de conexión de Push API

 Precaución

No uses la Push API para enviar datos atribuidos a AppsFlyer a terceros por los siguientes motivos:

  • Puedes infringir las normas de privacidad, como la CCPA, si el usuario eligió la exclusión opcional para no enviar sus datos a terceros.
  • Algunas fuentes de medios restringen la forma en que se utilizan, comparten con terceros o ambos los datos proporcionados por los usuarios. Asegúrate de cumplir con los términos de uso de la fuente de medios.
    Por ejemplo, Twitter, Snapchat, Pinterest.

Nota: Esta precaución no se aplica a los datos SKAN. Usa la Push API para enviar datos SKAN a puntos de conexión de terceros.

Para configurar la API Push, completa la lista de acciones.

Lista de verificación de configuración de la API Push

Paso n. º  Atribución de AppsFlyer Atribución de SKAdNetwork 
1

Si ya tienes un punto de conexión de la API Push activo, puedes omitir este paso. 

Completa los requisitos del lado del servidor.
2

Para la atribución de AppsFlyer, planifica la configuración del punto de conexión con la lista de verificación de planificación de la API Push.

No correponde
3

Configura el punto de conexión de atribución de AppsFlyer

Configura el punto de conexión de atribución de SKAdNetwork

Requisitos del lado del servidor (tu servidor)

Asegúrate de que tu servidor cumpla con los siguientes requisitos: 

Requisitos del lado del servidor

URL de punto de conexión
  • Nombre de dominio válido
  • Número máximo de puntos de conexión únicos por aplicación: 
    • AppsFlyer: 6 puntos de conexión
    • SKAdNetwork: 3 puntos de conexión
Código de respuesta de punto de conexión Al recibir un mensaje, tu punto de conexión debe devolver un código de estado HTTP 200.
Agregar los servidores de AppsFlyer a la lista de permitidos

Agrega a la lista de permitidos las direcciones IP de los servidores de AppsFlyer en tus firewalls y sistemas de seguridad para garantizar la comunicación con el punto de conexión.
Versiones de TLS
Puertos 

Puertos: 80, 443

Lista de verificación de planificación de la API Push para la atribución de AppsFlyer

  • Usa esa lista de verificación para planificar la configuración de tus puntos de conexión de atribución de AppsFlyer. Los números en la figura coinciden con los números de fila en la lista de verificación.
  • Esta sección no es relevante para la atribución de SKAdNetwork. Consulta Configurar la atribución de SKAdNetwork.

Punto de conexión 

PushAPI_us-en.png

Tabla de planificación de los puntos de conexión

No.

Configuración

 Detalles Usa esta columna para registrar la configuración planificada
1

Método

POST o GET

  

2

URL de punto de conexión

 -  
3 Tipos de mensajes de evento
  • Selecciona al menos un tipo de mensaje de evento.
  • Para seleccionar mensajes de eventos in-app, debes atribuir un evento in-app. Si no lo haces, no podrás seleccionar mensajes de eventos in-app. 

InappSelectionDisabled_us-en.png

 

4
  • Campos 
  • La lista de campos es común para todos los tipos de mensajes.

 Advertencia

Si marcas Seleccionar todo, los campos recién agregados también se seleccionarán automáticamente. Por favor, asegúrate de que puedes admitir todos los campos nuevos agregados automáticamente al esquema para evitar problemas.

Selecciona los campos requeridos.

  • Los campos más comunes ya están seleccionados de forma predeterminada.
  • No enviamos campos vacíos o nulos
  
5

Tipo de eventos in-app

 

Filtra por eventos in-app para reducir el tráfico enviado a tu punto de conexión.

  • Selecciona uno o más, o todos los eventos in-app. Nota: Si el evento no aparece en la lista, búscalo. 
  • Si seleccionas todo, los eventos in-app nuevos se agregan automáticamente. 
  • Solo puedes seleccionar un evento in-app después de que se haya atribuido al menos una vez. Si es necesario, usa S2S para disparar el evento.
  • mceclip1.png
  

Configura el punto de conexión de atribución de AppsFlyer

Nota: Solo el propietario de la cuenta de AppsFlyer puede realizar cambios en la configuración de la Push API. Los demás usuarios de la cuenta pueden ver la configuración.

Para agregar un punto de conexión de atribución de AppsFlyer:
  1. Ve a Integración > Acceso a API.Desplázate hacia abajo hasta la sección Push API.
  2. Haz clic en Agregar punto de conexión. 
  3. Selecciona un método HTTP: POST o GET
  4. Ingresa la URL del punto de conexión. Si recibes el mensaje de que esta URL no es segura, comunícate con el soporte técnico de AppsFlyer.
  5. Selecciona uno o más tipos de eventos. Nota: Si los mensajes de eventos in-app están deshabilitados, significa que no se han atribuido eventos in-app hasta el momento. 
  6. Selecciona los campos para completar el mensaje de la Push API. Nota:
    • Los campos obligatorios siempre se envían: ID de la aplicación, nombre del evento, hora del evento, identificador de anunciante (IDFA) para iOS o ID de publicidad para Android.
    • Usa los controles representados en la figura a continuación para seleccionar campos opcionales. 

      PushAPIFieldSelect1.jpg

      • Los campos más comunes ya están seleccionados de forma predeterminada. Puedes cancelar las selecciones.
      • Selecciona campos opcionales según sea necesario.
      • Usa Borrar todo para desactivar todos los campos opcionales seleccionados.
      • No enviamos campos nulos o vacíos y la clave asociada. Ten esto en cuenta al planificar tus procedimientos de análisis/importación.
  7. Selecciona uno o más (hasta 52 eventos) o  Todos los eventos in-app.
    • La lista se completa por tipos de eventos que ya se han atribuido. Si falta un evento, envía un evento que contenga este tipo utilizando un dispositivo de prueba. 
  8. Haz clic en Guardar.
    La API Push ahora está activa. Los datos de conversión continúan enviándose al punto de conexión.
  9. Prueba el punto de conexión utilizando el procedimiento que sigue.

Para probar el punto de conexión:

  1. Haz clic en Enviar prueba. 
    Aparece un mensaje de resultado de la prueba debajo del botón Enviar prueba. 
    Se envía un mensaje de prueba al punto de conexión. Si la prueba falla, asegúrate de que las direcciones IP de AppsFlyer estén en la lista de permitidos. 
    Nota: Se utiliza un mecanismo de tiempo de espera que tiene una duración de 2 segundos. Si AppsFlyer no recibe un mensaje de OK durante este tiempo, AppsFlyer lo considera como un error en el envío del mensaje. 
  2. Comprueba que tu punto de conexión recibió el mensaje de prueba.
    Ver una copia del mensaje enviado.

Configura el punto de conexión de atribución de SKAdNetwork

Nota: Solo el propietario de la cuenta de AppsFlyer puede realizar cambios en la configuración de la Push API. Los demás usuarios de la cuenta pueden ver la configuración.

Para agregar un punto de conexión de Push API de SKAdNetwork:
  1. Ve a Integración > Acceso a API.Desplázate hacia abajo hasta la sección Push API.
  2. Selecciona SKAdNetwork como entidad atribuidora. 
  3. Haz clic en Agregar punto de conexión. 
    Nota    : Puedes definir de 1 a 3 puntos de conexión de SKAdNetwork por aplicación. 
  4. Selecciona un método HTTP: POST o GET
  5. Ingresa la URL del punto de conexión. Si recibes el mensaje de que esta URL no es segura, comunícate con el soporte técnico de AppsFlyer.
  6. No enviamos campos nulos o vacíos y la clave asociada. Ten esto en cuenta al planificar tus procedimientos de análisis/importación.
  7. Haz clic en Guardar.
    La Push API ahora está activa. Los datos se envían al punto de conexión. 

Procedimientos adicionales: gestión de puntos de conexión

Cambiar un punto de conexión

Nota: Solo el propietario de la cuenta de AppsFlyer puede realizar cambios en la configuración de la Push API. Los demás usuarios de la cuenta pueden ver la configuración.

Para modificar la configuración del punto de conexión: 

  1. Ve a Integración > Acceso a API.
    Desplázate hacia abajo hasta la sección Push API.
  2. Localiza el punto de conexión a modificar.
  3. Haz las modificaciones.
  4. Haz clic en Guardar.

Eliminar un punto de conexión

Nota: Solo el propietario de la cuenta de AppsFlyer puede realizar cambios en la configuración de la Push API. Los demás usuarios de la cuenta pueden ver la configuración.

Para eliminar un punto de conexión:

  1. Ve a Integración > Acceso a API.
    Desplázate hacia abajo hasta la sección de acceso a Push API.
  2. Haz clic en Eliminar punto de conexión.
  3. Haz clic en Guardar. Se elimina el punto de conexión. 

Solución de problemas, rasgos y limitaciones

Fallo del mensaje de prueba

Si no recibes el mensaje de prueba y restringes el acceso a tus servidores por dirección IP: asegúrate de que todas las direcciones IP de AppsFlyer estén en la lista de permitidos. 

Duplicar eventos in-app de retargeting

Los eventos in-app de retargeting se duplican cuando se lleva a cabo un evento de compra como parte de una campaña de retargeting durante la ventana de re-engagement de la UA. Esto se hace para atribuir ingresos tanto a la fuente de medios de la UA como a la fuente de medios de retargeting. 

Solo obtendrás un evento duplicado si has habilitado ambos:

  • Instalar eventos in-app
  • Eventos In-App de Retargeting

Identificar y deduplicar eventos in-app

 

La selección de mensajes de eventos in-app está deshabilitada

InappSelectionDisabled_us-en.png

  • Los mensajes de eventos in-app solo se pueden seleccionar después de que se haya atribuido un evento in-app.
  • Usa un dispositivo de prueba para generar un evento in-app o usa la API S2S para hacerlo manualmente. 

Faltan mensajes push y CloudFront

¿Estás utilizando Amazon CloudFront como punto de conexión? Si es así, verifica si CloudFront está rechazando el mensaje con el código de rechazo 421. Si este es el caso, consulta Elegir cómo CloudFront atiende las solicitudes HTTPS

Mensajes de error del punto de conexión

Síntoma: El mensaje esta URL no es segura aparece cuando configuras la URL del punto de conexión.

Acción requerida: Comunícate con el soporte técnico de AppsFlyer; incluye el ID de aplicación, la URL del punto de conexión y una captura de pantalla del mensaje de error.

Especificaciones y limitaciones

Especificación Observaciones 
Redes de publicidad No disponible 
Agencias No disponible
Zona horaria específica de la aplicación Compatible
Divisa específica de la aplicación  Compatible
Limitaciones de tamaño No correponde
Orgánica  Sí
No orgánico Sí
Actualización de los datos Continua 
Historial de datos No se admite. Si faltan datos, utiliza Pull API para obtener los datos. En el caso de SKAN, puedes obtener algunos datos históricos a través de Data Locker (limitado por la ventana de disponibilidad de Data Locker). 

Acceso del propietario/usuario de la cuenta

Solo el propietario de la cuenta de AppsFlyer puede realizar cambios en la configuración de la Push API.

  • Cada cuenta de AppsFlyer tiene solo un propietario de cuenta. Este es el primer usuario de AppsFlyer (creado en el momento de abrir la cuenta).

Los demás usuarios de la cuenta pueden ver la configuración de la Push API, pero no pueden realizar cambios.

Consulta también