API de conversiones para eventos de la app

La API de conversiones permite a los anunciantes enviar eventos web, de la app, de la tienda física y de mensajes comerciales a Meta a través de un único punto de conexión en lugar de hacerlo a través de orígenes múltiples. Esta consolidación puede simplificar la pila de tecnología de un anunciante y crear una vista más completa dentro del administrador de eventos de Meta si se utilizan conjuntos de datos.

Esta documentación proporciona orientación para integrar eventos de la app en la API de conversiones.

Requisitos previos

1. Conjunto de datos

Los eventos de la app enviados mediante la API de conversiones deben estar asociados a un conjunto de datos.

Puedes realizar la llamada GET a https://graph.facebook.com/v16.0/{ads-pixel-id}/is_consolidated_container con el fin de detectar si el conjunto de datos del anunciante está consolidado y, por lo tanto, cumple los requisitos para pasar eventos offline con la API de conversiones.

2. Permisos

• Si deseas implementar una integración directa como anunciante, sigue las instrucciones que se encuentran aquí para obtener los requisitos y permisos.

• Si deseas implementar una integración de la plataforma de socios, sigue las instrucciones que se encuentran aquí para obtener información sobre los requisitos y permisos.

Configuración

Enviar eventos de la app a la API de conversiones

a. Vincular el identificador del conjunto de datos y el identificador de la app

En el administrador de eventos, hay dos formas posibles de vincular tu app con un conjunto de datos:

• Selecciona la pestaña "Orígenes de datos", busca la pestaña "Configuración" de tu app y realiza la vinculación.
• Selecciona la pestaña "Orígenes de datos" en la pestaña "Información general" de tu app, utiliza el botón "Vincular con el conjunto de datos" en la sección "Toda la actividad".

Una vez que completes la vinculación, el conjunto de datos incluirá la app conectada.

b. Campos obligatorios

Puedes hacer referencia aquí al conjunto de parámetros actuales que se pueden enviar a través de la API de conversiones. Para enviar eventos de la app, es posible compartir el siguiente valor server_event fields en la carga útil:

• El parámetro action_source debe contener el valor app de los eventos de la app.
• El event_id es obligatorio en el caso de configurar la deduplicación.
• app_data fields
• user_data fields
• custom_data fields

Campos de datos de la app

Parámetros de información del cliente

Datos personalizados

En resumen, los eventos de la app que se comparten utilizando la API de conversiones requerirán los siguientes parámetros de datos:

• action_source: debe configurarse en "app". (si usas la API de conversiones, aceptas que el parámetro action_source es preciso, según tus conocimientos).
• event_id: obligatorio si se desea configurar la deduplicación. Ver detalles en la sección "Configurar la deduplicación de varios canales".
• advertiser_tracking_enabled
• application_tracking_enabled
• extinfo

A continuación, se presenta un ejemplo de extinfo. Asegúrate de que todos los siguientes subparámetros estén completos y en orden secuencial. Si falta alguno, usa una cadena vacía para reemplazarlo.

c. Configurar la deduplicación de varios canales

El mecanismo de deduplicación será obligatorio si se desea eliminar el tráfico de eventos duplicados entre la integración de la API de conversiones y todas las demás integraciones anteriores que tengas con eventos de la app, entre los que se incluyen SDK, MMP y API de eventos de la app.

En relación con los eventos de la app, aplicamos la misma funcionalidad de deduplicación que existe para eventos web. La lógica utiliza la deduplicación basada en el campo event_id y event_name (API de conversiones y SDK / Eventos de la API de eventos de la app presentan el mismo event_id). El parámetro event_id es un identificador que puede distinguir de manera única entre eventos similares. Los identificadores de eventos imprecisos pueden hacer que la deduplicación de tu conversación sea incorrecta y afectar, además, los informes sobre conversiones y el rendimiento de las campañas.

Puedes consultar la siguiente documentación para desarrolladores para implementar la configuración de la deduplicación:

• Cómo configurar eventos de la app
• Ejemplo de configuración de la deduplicación

Aquí hay un ejemplo de cómo registrar un evento personalizado. Para hacerlo, pasa el nombre del evento como AppEvents.Name en el SDK para iOS:

AppEvents.shared.logEvent(.achievedLevel, parameters: [AppEvents.ParameterName(rawValue: "event_id"): "123"])

En relación con los eventos de instalación de apps, ya existe un mecanismo de deduplicación que asegura que solo se atribuya una instalación en un intervalo anterior de los 90 días. Mantenemos el primer evento y soltamos los posteriores sin tener en cuenta el origen de acción del que provengan. No es obligatorio implementar la deduplicación de eventos de la app relacionados con los eventos de instalación.

d. Enviar eventos

Para enviar nuevos eventos, realiza una solicitud POST a la API de conversiones desde este ruta: https://graph.facebook.com/{API_VERSION}/{DATASET_ID}/events?access_token={TOKEN}. Cuando publicas en este perímetro, Meta crea nuevos eventos de servidor de la app. Para obtener más detalles, consulta el siguiente documento para desarrolladores.

Aquí puedes ver información general sobre cómo encajan los parámetros en el esquema general de la carga:

{
    "data": [
        {
            "event_name": "Purchase",
            "event_time": 1684389752,
            "action_source": "app",
            "user_data": {
                "em": [
                    "30a79640dfd8293d4f4965ec11821f640ca77979ca0a6b365f06372f81a3f602"
                ],
                "ph": [
                    "74234e98afe7498fb5daf1f36ac2d78acc339464f950703b8c019892f982b90b",
                    "74234e98afe7498fb5daf1f36ac2d78acc339464f950703b8c019892f982b90b"
                ],
                "madid": "bbbbbbbbbbbb",
      "anon_id": "cccccccc"
            },
            "custom_data": {
                "currency": "USD",
                "value": "142.52"
            },
            "app_data": {
                "advertiser_tracking_enabled": "True",
                "application_tracking_enabled": "True",
                "campaign_ids": "aaaaaaaaa",
                "extinfo": [
                    "a2",
                    "com.some.app",
                    "771",
                    "Version 7.7.1",
                    "10.1.1",
                    "OnePlus6",
                    "en_US",
                    "GMT-1",
                    "TMobile",
                    "1920",
                    "1080",
                    "2.00",
                    "2",
                    "128",
                    "8",
                    "USA/New York"
                ]
            }
        }
    ]
}

Solución de problemas

Puedes usar la herramienta de ayuda de carga para generar datos de carga:

• Elige el origen de acción app si corresponde.
• Rellena la información de los eventos que se enviarán a Meta.
• Se generará la carga útil del evento, que se puede utilizar como plantilla para integrar la API de conversiones.

Utiliza la herramienta "Probar eventos" en el administrador de eventos para realizar pruebas.

Más información

• Información general de la API de conversiones
• Uso de la API de conversiones
• Parámetros de la API de conversiones
• Prácticas recomendadas