API de calidad de integración

Esta API solo está disponible en versión beta. Para acceder a la API, ponte en contacto con tu representante de Meta.

Los anunciantes que comparten eventos del servidor mediante la API de conversiones pueden ver en el administrador de eventos la calidad de las coincidencias de eventos (EMQ) en relación con cada evento. Sin embargo, esta información solo se muestra de forma individual y es difícil de escalar en los casos en que un proveedor de tecnología asociado, agencia asociada o anunciante administra cientos y miles de píxeles de Meta de sus negocios. La API de calidad de integración puede ayudar a resolver este problema a escala y mediante programación si se consolidan las métricas de calidad de integración.

Información sobre la calidad de las coincidencias de eventos

Calidad de las coincidencias de eventos

La calidad de las coincidencias de eventos (EMQ) es una puntuación (sobre un total de 10), que indica qué tan eficaz es la información del cliente que se envía desde tu servidor para asociar instancias de eventos a una cuenta de Facebook. Si la calidad de las coincidencias de eventos (EMQ) es alta, puede mejorar la atribución y el rendimiento de los anuncios. Ten en cuenta que esta métrica se encuentra en desarrollo.

Cómo se calcula

La calidad de las coincidencias de eventos se calcula observando qué parámetros de información del cliente se reciben desde tu servidor mediante la integración de la API de conversiones, la calidad de la información recibida y el porcentaje de instancias de eventos que coinciden con una cuenta de Meta.

Cómo se usa

La calidad de las coincidencias de eventos se usa para evaluar si envías a través de la API de conversiones la información adecuada del cliente para que coincidan tus eventos con una cuenta de Meta, y si configuraste correctamente los parámetros de información de tus clientes. Los parámetros de información del cliente ayudan a que tus eventos coincidan con una cuenta de Meta, de modo que puedas atribuir conversiones a tus anuncios y entregarlas a las personas con más probabilidades de convertirlas.

La calidad de las coincidencias de eventos se calcula en tiempo real. Obtén más información sobre las prácticas recomendadas de EMQ aquí.

La calidad de las coincidencias de eventos actualmente solo está disponible para eventos web. En relación con otros tipos de eventos, como los eventos offline y en tiendas físicas, los clientes potenciales de conversiones o cualquier integración en etapa alfa o beta, comunícate con tu representante de Meta para recibir orientación sobre cómo mejorar la calidad de coincidencia de eventos.

Casos de uso habituales

Los socios y las agencias pueden usar la API de calidad de integración para proporcionar estadísticas y un panel de calidad, al tiempo que ayudan a sus anunciantes a mejorar y optimizar sus integraciones. Los socios también pueden usar esta integración para controlar la estabilidad de la integración de sus API de conversiones. Los anunciantes pueden usar este punto de conexión para agregar datos de calidad de la integración para incorporarlos en su tarea de supervisión.

Autenticación

Autenticación de anunciantes a través del administrador comercial

En el administrador comercial, ve a la sección de usuario y selecciona la pestaña Usuario del sistema. Haz clic en el usuario específico del sistema que usas para la API de conversiones.
Ve al cuadro de diálogo "Asignar activo" y elige Píxeles. A continuación, selecciona los píxeles para los que deseas enviar eventos en nombre de otros usuarios.
En relación con los píxeles, selecciona el permiso "Gestionar píxel" y haz clic en Guardar cambios.
Vuelve a la página de detalles de tu usuario del sistema. Verifica que los píxeles seleccionados se puedan ver allí.
Para generar el token de acceso, sigue las instrucciones que se indican aquí.

Autenticación de la plataforma de socios

Debes solicitar autorización para enviar eventos en nombre de tus clientes. Tienes las siguientes opciones de autenticación:

Inicio de sesión con Facebook para empresas (recomendado)

El inicio de sesión con Facebook para empresas es la solución preferida de autenticación y autorización para proveedores de tecnología y desarrolladores de apps de negocios que necesitan acceso a los activos de sus clientes del negocio. Permite especificar el tipo de token de acceso, los tipos de activos y los permisos que necesita tu app, y guardarlos como valores configurados (configuración). Luego, puedes presentar los valores configurados a los clientes de negocios para que completen el proceso y otorguen a tu app acceso a sus activos comerciales.

Extensión de Meta para empresas (recomendado)

Con esta opción, la extensión de Facebook para empresas (MBE) devuelve toda la información necesaria para enviar eventos en nombre del cliente. La MBE proporciona un punto de conexión para recuperar los tokens de acceso de los usuarios del sistema que se crearon en el administrador comercial del cliente. Este proceso incluye permisos para enviar eventos del servidor y se lleva a cabo de manera automática y segura. La MBE se encuentra en etapa beta. Ponte en contacto con tu representante de Meta para obtener acceso.

El punto de conexión requiere un token de acceso del usuario como parámetro de entrada. Si eres usuario nuevo de la MBE, llama a este punto de conexión para recuperar el token de acceso del usuario del sistema cuando termines de configurar la MBE. Los usuarios preexistentes deben solicitar una nueva autenticación antes de llamar al nuevo punto de conexión de la API.

Compartir a través de un cliente un píxel de Meta con el administrador comercial del socio

Con esta opción, el cliente comparte su píxel de Meta con el socio mediante la configuración del administrador comercial o mediante la API. Luego, el socio puede asignar el usuario del sistema al píxel del cliente y generar un token de acceso para enviar eventos del servidor.

Recuperar la información sobre la calidad de integración del píxel

Puedes supervisar la puntuación de la calidad de las coincidencias de eventos por evento, junto con las claves de coincidencia que se envían, mediante el punto de conexión de la API, los parámetros y los campos que se indican a continuación:

Punto de conexión

https://graph.facebook.com/v21.0/<pixel_id>/integration_quality

Parámetros

Parámetro Descripción

Parámetro	Descripción
`agent_name` Cadena	Opcional. Se usa el valor normalizado del campo partner_agent para filtrar solo los eventos que se envían con el parámetro partner_agent en la solicitud POST /{pixel_id}/events (consulta cómo atribuir las prácticas recomendadas de los eventos aquí y aquí). Por ejemplo, si el valor de partner_agent es `[partner_name]_[majorversion]_[minorVersion]`, el valor normalizado de la cadena del agente será `partner_name` en minúscula. El `agent_name` te permite configurar el propio identificador de tu plataforma cuando envías eventos en nombre de un cliente. Si eres una agencia o un socio administrado, trabaja con tu representante de Meta para definir de mutuo acuerdo un identificador para tu plataforma. Si eres anunciante, por lo general, no deberías preocuparte por la atribución de `agent_name`. Si no proporcionas un `agent_name`, todos los eventos se incluirán en el cálculo de la EMQ, sin importar si los envió un agente.

agent_name

Cadena

Opcional.
Se usa el valor normalizado del campo partner_agent para filtrar solo los eventos que se envían con el parámetro partner_agent en la solicitud POST /{pixel_id}/events (consulta cómo atribuir las prácticas recomendadas de los eventos aquí y aquí).

Por ejemplo, si el valor de partner_agent es [partner_name]_[majorversion]_[minorVersion], el valor normalizado de la cadena del agente será partner_name en minúscula.

El agent_name te permite configurar el propio identificador de tu plataforma cuando envías eventos en nombre de un cliente. Si eres una agencia o un socio administrado, trabaja con tu representante de Meta para definir de mutuo acuerdo un identificador para tu plataforma.

Si eres anunciante, por lo general, no deberías preocuparte por la atribución de agent_name.

Si no proporcionas un agent_name, todos los eventos se incluirán en el cálculo de la EMQ, sin importar si los envió un agente.

Campos

Campo	Descripción
`event_name` Cadena	Un nombre del evento estándar o evento personalizado.
`event_match_quality` AdsPixelCAPIEMQ	La calidad de las coincidencias de eventos indica cuán eficaz puede ser la información de los clientes que se envía desde tu servidor para asociar las instancias de eventos con una cuenta de Facebook.

Ejemplo:

Explorados de la API Graph

GET/v21.0/<PIXEL_ID>/integration_quality?fields=event_match_quality,event_name&agent_name=<AGENT_NAME>&access_token=<ACCESS_TOKEN>

cURL

curl -X GET -G \
  -d 'fields="event_match_quality,event_name"' \
  -d 'agent_name="&lt;AGENT_NAME&gt;"' \
  -d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/<LATEST_VERSION>/<PIXEL_ID>/integration_quality

Respuesta de la API

{
  "data": [
    {
      "event_match_quality": {
        "composite_score": 5.1,
        "match_key_feedback": [
          {
            "identifier": "email",
            "coverage": {
              "percentage": 100
            }
          },
          {
            "identifier": "user_agent",
            "coverage": {
              "percentage": 100
            }
          },
          {
            "identifier": "external_id",
            "coverage": {
              "percentage": 100
            }
          }
        ]      
      },
      "event_name": "pLTVPurchase"
    },
    {
      "event_match_quality": {
        "composite_score": 7.2,
        "match_key_feedback": [
          {
            "identifier": "email",
            "coverage": {
              "percentage": 100
            }
          },
          {
            "identifier": "user_agent",
            "coverage": {
              "percentage": 100
            }
          },
          {
            "identifier": "phone",
            "coverage": {
              "percentage": 69.1
            }
          },
          {
            "identifier": "fbp",
            "coverage": {
              "percentage": 96.7
            }
          },
          {
            "identifier": "external_id",
            "coverage": {
              "percentage": 100
            }
          },
          {
            "identifier": "fbc",
            "coverage": {
              "percentage": 3.2
            }
          }
        ]
      },
      "event_name": "CompleteRegistration"
    }
  ]
}

Preguntas frecuentes

What is the access token used for?

The access token is used when partners send signal events or access the Setup Quality API on behalf of advertisers. The client system user access token onboarding method is not compatible with the EMQ API at the moment.

Enlace permanente

How should the partner_agent field be formatted?

The partner_agent value in your API GET request should be a normalized lowercase format. This field is now optional.

Enlace permanente

Más información

Prácticas recomendadas en relación con la API de conversiones.
Impulsar el rendimiento con una configuración optimizada de la API de conversiones.
Prácticas recomendadas para registrar la API de conversiones para socios.
Guía de calidad para configurar la API de conversiones del servicio de ayuda para empresas de Meta:

Prácticas recomendadas relacionadas con la API de conversiones para ayudar a impulsar el rendimiento de los anuncios. Estas prácticas recomendadas para el uso de la API de conversiones ayudarán a los negocios a mejorar el rendimiento de los anuncios y a reducir el costo por acción. Sugerimos seguir estas prácticas recomendadas después de la configuración inicial, pero también se pueden usar para actualizar las configuraciones actuales.

Consultar los detalles de los eventos del servidor en el administrador de eventos de Meta. Después de configurar la API de conversiones, los negocios pueden usar este artículo para aprender a supervisar eventos y parámetros, lo que les permitirá asegurarse de que su configuración esté funcionando de manera eficaz e identificar oportunidades de mejora. También pueden usar este artículo para aprender a usar los detalles de los eventos del servidor (coincidencias de eventos [calidad de coincidencias de eventos/EMQ]), actualización de los datos, resumen de eventos y deduplicación de eventos) en el administrador de eventos, con el fin de mejorar la configuración de la API de conversiones.