API de conversiones

Flujo de trabajo y ejemplos del administrador de parámetros

La biblioteca del administrador de parámetros es un SDK liviano de código abierto diseñado para adaptarse a la mayoría de los sistemas.

Flujo de trabajo

Puedes encontrar demostraciones de ejemplo para cada idioma en sus respectivos subdirectorios: una app de demostración basada en localhost se encuentra en la carpeta titulada /example. El archivo README muestra cómo ejecutar la app de demostración en el host local paso a paso.

SDK del lado del cliente

Directorio:

Guía de integración general:

  • Carga el SDK: clientParamBuilder se carga durante la inicialización de la página.
  • Llamar a las API del SDK: el sitio web del anunciante llama a las API proporcionadas por clientParamBuilder. Por ejemplo:
    • .processAndCollectAllParams guarda y actualiza fbp, fpc y fbi (si getIpFn está disponible)
      • Si getIpFn no está vacía, se guardará fbi en la cookie, en función del resultado de la función getIpFn.
      • Guarda fbc si corresponde.
      • Guarda fbp si corresponde.
    • .getNormalizedAndHashedPII: devuelve datos de PII normalizados y cifrados según el valor y el tipo de entrada.
    • .getFbc(), getFbp(), getClientIpAddress(): llama a .processAndCollectAllParams primero para configurarlo en cookies y recupera los resultados de la cookie. Nota: Esta API guardará/actualizará las cookies. Asegúrate de que el sitio web tenga el consentimiento del usuario para las cookies antes de realizar la llamada.
  • Envía la carga de la API de conversiones: el sitio web del anunciante envía la carga de la API de conversiones con los parámetros recuperados.

Consulta las instrucciones completas en el archivo README file.

SDK del servidor

Directorios:

Guía de integración general:

  • Importa la biblioteca del administrador de parámetros en la app del servidor del sitio web del anunciante.
  • Procesa la solicitud: llama a updatedCookieList = builder.processRequest con los datos de entrada.
  • Obtén las cookies que se establecerán: usa updatedCookieList o builder.getCookiesToSet para obtener una lista de las cookies que recomendamos guardar.
  • Guarda las cookies: el servidor del sitio web del anunciante guarda cookies en función de la lista anterior.
  • Recupera los parámetros. Recupera valores usando:
    • getFbc()
    • getFbp()
    • getClientIpAddress()
    • getNormalizedAndHashedPII()
  • Envía la carga de la API de conversiones: el sitio web del anunciante envía la carga con los parámetros anteriores.

[Recomendado] SDK del lado del cliente y del lado del servidor

También puedes integrar el SDK del lado del cliente y del lado del servidor en la misma aplicación web. Son compatibles entre sí y aprovechan las cookies para las principales interacciones. Esto puede ayudar a maximizar la efectividad de la biblioteca del administrador de parámetros.

haz clic en la imagen para ampliarla



  1. La aplicación cliente del anunciante carga el generador de parámetros en el lado del cliente e invoca processAndCollectAllParams de la API proporcionada con un puntero de función getIpFn.
  2. Se invocará el getIpFn proporcionado y se recuperará IPv6 de un punto de conexión configurado del anunciante, dependiendo de la implementación real de getIpFn.
  3. Se devolverá el IPv6 del punto de conexión configurado del anunciante y se pasará al administrador de parámetros del lado del cliente desde el valor devuelto de getIpFn. El IPv6 recuperado se guardará en la cookie con clave _fbi para recuperarlo más tarde.
  4. En el lado del cliente, inicia la comunicación habitual con el servidor de back-end usando la API de búsqueda (u otra comunicación de front-end y back-end) con las cookies de origen.
  5. En el servidor, integra la biblioteca en el lado del servidor según el lenguaje que hayas elegido en el punto de conexión receptor (por ejemplo, ExampleController) e invoca processRequest de la API proporcionada para gestionar la solicitud.
  6. La API processRequest devolverá una lista de cookies que recomendamos actualizar en el lado del cliente.
  7. Configura las cookies recomendadas en los encabezados de respuesta para indicarle al navegador cliente que las almacene.
  8. Invocar varias API proporcionadas como getFbc(), getFbp(), getClientIpAddress() y getNormalizedAndHashedPII().
  9. El SDK devolverá varios valores, como fbc, fbp, client_ip_address, email y número de teléfono phone number.
  10. Envía estos valores recuperados de vuelta a Meta a través de la API de conversiones.