API de calidad de la integración

Esta API está en fase beta. Ponte en contacto con tu representante de Meta para obtener acceso.

Los anunciantes que comparten eventos del servidor mediante la API de conversiones pueden consultar la calidad de las coincidencias de eventos en el Administrador de eventos. Sin embargo, esto solo funciona de forma individual y es difícil de ampliar en aquellos casos en los que el socio proveedor de tecnología, la agencia partner o el anunciante administra cientos o miles de píxeles de Meta para sus empresas. La API de calidad de la integración puede ayudar a resolver este problema al consolidar las métricas de calidad de la integración mediante programación a escala.

Información sobre la calidad de las coincidencias de eventos

Calidad de las coincidencias de eventos

La calidad de las coincidencias de eventos es una puntuación (sobre diez) que indica cómo de eficaz puede resultar la información del cliente enviada desde tu servidor a la hora de hacer coincidir instancias de eventos con una cuenta de Facebook. Una calidad de coincidencia de eventos alta puede mejorar el rendimiento y la atribución de los anuncios. Ten en cuenta que esta métrica está en desarrollo.

Cómo se calcula

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

Cómo se utiliza

La calidad de las coincidencias de eventos se usa para evaluar si estás enviando mediante la API de conversiones la información del cliente adecuada para hacer coincidir los eventos con una cuenta de Meta y para evaluar si has configurado correctamente los parámetros de información de tus clientes. Los parámetros de información de los clientes contribuyen a hacer coincidir tus eventos con una cuenta de Meta, de modo que puedas atribuir conversiones a tus anuncios y entregarlos a las personas con más probabilidades de realizar conversiones.

La calidad de las coincidencias de eventos se calcula en tiempo real. Puedes obtener más información acerca de las prácticas recomendadas sobre la calidad de las coincidencias de eventos aquí.

Actualmente, la calidad de las coincidencias de eventos solo está disponible para los eventos web. En el caso de otros tipos de eventos (como las ventas en el negocio físico y fuera de internet, los eventos de la aplicación, los clientes potenciales de conversión o las integraciones en las fases alfa o beta), ponte en contacto con el representante de Meta para que te oriente sobre cómo mejorar la calidad de las coincidencias.

Casos de uso habituales

Los socios y las agencias pueden usar la API de calidad de la integración para proporcionar un panel de calidad e insights a la vez que ayudan a sus anunciantes a mejorar y optimizar sus integraciones. Los socios también pueden usar esta integración para supervisar la estabilidad de su integración de la API de conversiones. Los anunciantes pueden usar este extremo para consolidar los datos de calidad de la integración a fin de incorporarlos en sus tareas de supervisión.

Autenticación

Autenticación del anunciante mediante Business Manager

En Business Manager, dirígete a la sección Usuarios y selecciona la pestaña Usuario del sistema. Haz clic en el usuario específico del sistema que vas a usar para la API de conversiones.
Ve al cuadro de diálogo Asignar activo y elige Píxeles. A continuación, selecciona los píxeles en nombre de los cuales quieres enviar eventos.
Para cada píxel, selecciona el permiso Administrar píxel y haz clic en Guardar cambios.
Vuelve a la página de detalles del usuario del sistema. Comprueba que los píxeles seleccionados estén visibles.
Para generar el identificador de acceso, sigue las instrucciones que se indican aquí.

Autenticación de la plataforma de socios

Primero debes pedir autorización para enviar eventos en nombre de tus clientes. Dispones de 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 recomendada de autenticación y autorización para los proveedores de tecnología y los desarrolladores de aplicaciones para empresas que necesitan acceso a los activos comerciales de sus clientes. Te permite especificar el tipo de identificador de acceso, el tipo de activos y los permisos que necesita tu aplicación, y guardarlos como un conjunto (configuración). Después, puedes proporcionar el conjunto a tus clientes empresariales para que completen el proceso y concedan a la aplicación acceso a los activos comerciales.

Extensión de Meta para empresas (recomendado)

Con esta opción, la extensión de Meta para empresas (MBE) devuelve toda la información que necesitas para enviar eventos en nombre del cliente. MBE proporciona un extremo para recuperar los identificadores de acceso de usuario del sistema creados en la cuenta de Business Manager del cliente. Este proceso incluye permisos para enviar eventos del servidor y se realiza de forma automática y segura. MBE se encuentra en fase beta. Para obtener acceso, ponte en contacto con tu representante de Meta.

El extremo necesita un identificador de acceso de usuario como parámetro de entrada. Si eres un usuario nuevo de MBE, llama a este extremo para obtener el identificador de acceso de usuario del sistema cuando termines de configurar MBE. Los usuarios existentes deben solicitar una nueva autenticación para poder llamar al nuevo extremo de la API.

Uso compartido del cliente de un píxel de Meta con la cuenta de Business Manager del socio

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

Recuperar información sobre la calidad de la integración de los píxeles

Puedes supervisar la puntuación de calidad de las coincidencias de eventos por evento, así como las claves de coincidencia que se envían, usando el extremo de la API, los parámetros y los campos siguientes:

Extremo

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

Parámetros

Parámetro Descripción

Parámetro	Descripción
`agent_name` Cadena	Opcional. El valor normalizado del campo partner_agent se utiliza para filtrar solo los eventos enviados con el parámetro partner_agent en una solicitud POST /{pixel_id}/events (consulta las prácticas recomendadas para atribuir los eventos aquí y aquí). Por ejemplo, si el valor de partner_agent es `[partner_name]_[majorversion]_[minorVersion]`, el valor de la cadena agent normalizado será `partner_name`, en minúsculas. El campo `agent_name` te permite establecer tu propio identificador de plataforma cuando envíes eventos en nombre de un cliente. Si eres un socio administrado o una agencia administrada, acude a tu representante de Meta para acordar un identificador para tu plataforma. Si eres anunciante, en general, no tendrás que preocuparte por la atribución de `agent_name`. Si no proporcionas un valor para `agent_name`, todos los eventos, independientemente de si los ha enviado un agent o no, se incluirán en el cálculo de la calidad de las coincidencias de eventos.

agent_name

Cadena

Opcional.
El valor normalizado del campo partner_agent se utiliza para filtrar solo los eventos enviados con el parámetro partner_agent en una solicitud POST /{pixel_id}/events (consulta las prácticas recomendadas para atribuir los eventos aquí y aquí).

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

El campo agent_name te permite establecer tu propio identificador de plataforma cuando envíes eventos en nombre de un cliente. Si eres un socio administrado o una agencia administrada, acude a tu representante de Meta para acordar un identificador para tu plataforma.

Si eres anunciante, en general, no tendrás que preocuparte por la atribución de agent_name.

Si no proporcionas un valor para agent_name, todos los eventos, independientemente de si los ha enviado un agent o no, se incluirán en el cálculo de la calidad de las coincidencias de eventos.

Campos

Campo	Descripción
`event_name` Cadena	Nombre de un evento estándar o un evento personalizado.
`event_match_quality` AdsPixelCAPIEMQ	La calidad de las coincidencias de eventos indica en qué medida puede ser eficaz la información sobre clientes enviada desde tu servidor a la hora de hacer coincidir instancias de eventos con una cuenta de Facebook.

Ejemplo

Explorador 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 de la API de conversiones.
Aumentar el rendimiento con una configuración optimizada de la API de conversiones.
Prácticas recomendadas para socios para incorporarse a la API de conversiones.
Guía del Servicio de ayuda de Meta para empresas sobre la calidad de la configuración de la API de conversiones:

Prácticas recomendadas sobre la API de conversiones para mejorar el rendimiento de tus anuncios. Estas prácticas recomendadas sobre la API de conversiones pueden ayudar a las empresas a mejorar el rendimiento de los anuncios y reducir el coste por acción. Sugerimos seguir estas prácticas recomendadas tras la configuración inicial, aunque también pueden utilizarse para actualizar las configuraciones existentes.

Consultar los detalles de eventos del servidor en el Administrador de eventos de Meta. Una vez que las empresas han configurado la API de conversiones, pueden consultar este artículo para obtener más información sobre cómo supervisar eventos y parámetros a fin de asegurarse de que la configuración funciona correctamente e identificar oportunidades de mejora. También pueden consultar el artículo para aprender más sobre los detalles de los eventos del servidor (coincidencias de eventos [calidad de las coincidencias de eventos], actualización de los datos, información general sobre los eventos y eliminación de duplicados de los eventos) en el Administrador de eventos a fin de mejorar la configuración de la API de conversiones.