API de conversiones para eventos de la aplicación

La API de conversiones permite a los anunciantes enviar eventos de la web, de la aplicación, de la tienda física y de mensajes empresariales a Meta mediante un extremo único y no mediante varios orígenes. Esta consolidación simplificará la pila de tecnología de un anunciante y creará una vista más completa en el Administrador de eventos de Meta gracias al uso de conjuntos de datos.

En esta documentación se proporciona orientación para integrar los eventos de la aplicación en la API de conversiones.

Requisitos previos

1. Conjunto de datos

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

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

2. Permisos

• Para implementar una integración directa como anunciante, consulta los requisitos previos y los permisos en estas instrucciones.

• Para implementar la integración de la plataforma de socios, consulta los requisitos previos y los permisos en estas instrucciones.

Configuración

Enviar eventos de la aplicación a la API de conversiones

a. Vincular el identificador del conjunto de datos y el identificador de la aplicación

En el Administrador de eventos, hay dos formas de vincular la aplicación con un conjunto de datos:

• Selecciona la pestaña “Orígenes de datos”, busca la pestaña “Configurar” de la aplicación y lleva a cabo la vinculación.
• Selecciona la pestaña “Orígenes de datos” y, en la pestaña “Información general” de la aplicación, usa el botón “Vincular con conjunto de datos” en la sección “Toda la actividad”.

Una vez que completes la vinculación, el conjunto de datos incluye la aplicación conectada.

b. Campos obligatorios

Puedes consultar el conjunto actual de parámetros que se pueden enviar mediante la API de conversiones aquí. Para enviar eventos de la aplicación, los siguientes campos de server_event se pueden compartir en la carga útil:

• El parámetro action_source debe contener el valor app para los eventos de la aplicación.
• El valor de event_id es obligatorio para el caso de configuración de la eliminación de duplicados.
• Campos de app_data
• Campos de user_data
• Campos de custom_data

Campos de datos de la aplicación

Parámetros de información del cliente

Datos personalizados

En resumen, los eventos de la aplicación compartidos con la API de conversiones requerirán los siguientes parámetros de datos:

• action_source: debe establecerse en “app”. (Al utilizar la API de conversiones, aceptas que el parámetro action_source es adecuado hasta donde tú sabes).
• event_id: obligatorio para la configuración de la eliminación de duplicados; obtén más información en la sección “Configurar la eliminación de duplicados para varios canales”.
• advertiser_tracking_enabled
• application_tracking_enabled
• extinfo

A continuación se incluye un ejemplo de extinfo. Asegúrate de que todos los subparámetros siguientes estén rellenados y en orden secuencial. Si falta algo, usa una cadena vacía como marcador de posición.

c. Configurar la eliminación de duplicados para varios canales

El mecanismo de eliminación de duplicados será necesario para eliminar el tráfico de eventos duplicados entre la integración de la API de conversiones y todas las demás integraciones existentes que tengas con eventos de la aplicación, incluido el SDK, los MMP y la API de eventos de la aplicación.

Para los eventos de la aplicación, aplicamos la misma funcionalidad de eliminación de duplicados que existe para los eventos web. La lógica usa la eliminación de duplicados basada en el campo event_id y event_name (eventos de la API de conversiones y el SDK o la API de eventos de la aplicación que llevan el mismo valor de event_id). El parámetro event_id es un identificador que puede distinguir de forma única entre eventos similares. Los identificadores de eventos incorrectos pueden causar la eliminación errónea de duplicados de la conversión, lo que tiene un impacto en los informes de conversiones y el rendimiento de las campañas.

Puedes consultar la siguiente documentación para desarrolladores si quieres implementar la configuración de la eliminación de duplicados:

• Cómo configurar eventos de la aplicación
• Ejemplo de configuración de la eliminación de duplicados

A continuación se incluye un ejemplo de cómo registrar un evento personalizado. Para ello, pasa el nombre del evento como AppEvents.Name en el SDK para iOS:

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

Para los eventos de descarga de aplicación, ya existe un mecanismo de eliminación de duplicados que asegura que solo se atribuya una descarga en el intervalo de los últimos 90 días. Mantenemos el primer evento y anulamos los posteriores independientemente del origen de acción del que procedan. No hay ningún requisito para implementar la eliminación de duplicados para los eventos de la aplicación relacionados con eventos de descarga.

d. Enviar eventos

Para enviar nuevos eventos, haz una solicitud POST a la API de conversiones desde esta ruta: https://graph.facebook.com/{API_VERSION}/{DATASET_ID}/events?access_token={TOKEN}. Al realizar una publicación en este perímetro, Meta crea nuevos eventos del servidor de aplicaciones. Para obtener más información, consulta el siguiente documento para desarrolladores.

A continuación se ofrece información general sobre cómo se ajustan los parámetros al esquema general de la carga útil:

{
    "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 el asistente de carga útil para generar datos de cargas útiles:

• Elige el origen de acción app cuando proceda.
• Rellena la información de los eventos que se enviarán a Meta.
• De esta forma, se generará la carga útil de los eventos, que se puede usar como plantilla para la integración de la API de conversiones.

Utiliza la herramienta para probar eventos en el Administrador de eventos con fines de pruebas.

Más información

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