Obtén información sobre cómo registrar fuentes para atribuir clics y vistas a los eventos correspondientes.
Una fuente de atribución es un evento relacionado con un anuncio (un clic o una vista) al que una tecnología publicitaria puede adjuntar los siguientes tipos de información:
- Datos de informes contextuales, como el ID de la creatividad del anuncio, información sobre la campaña o la ubicación geográfica.
- Es un destino de conversión, como el sitio donde esperas que el usuario genere una conversión.
Si sigues los pasos que se indican en este documento, podrás registrar las fuentes (impresiones de anuncios o clics) a las que el navegador luego atribuirá las conversiones.
Métodos de registro
Para registrar fuentes de atribución, usa elementos HTML o llamadas de JavaScript:
- Etiqueta
<a>
- Etiqueta
<img>
- Etiqueta
<script>
fetch
llamadaXMLHttpRequest
window.open
llamada
Esto genera solicitudes de red a las que luego respondes con un encabezado de respuesta HTTP de registro de fuente.
Registra fuentes para clics o vistas
Si deseas registrar una fuente de atribución para clics o vistas, sigue los pasos que se describen aquí. Siguen los pasos completos. Este es el resumen:
- Inicia el registro de la fuente. Usa un elemento HTML o una llamada de JavaScript para realizar una solicitud. Este paso es diferente para los clics y las vistas, como verás en las siguientes secciones.
Completa el registro de la fuente. Para ello, responde con el encabezado de registro de la fuente. Cuando recibas esa solicitud, responde con el encabezado
Attribution-Reporting-Register-Source
. En ese encabezado, especifica la configuración deseada de Attribution Reporting. Este paso es el mismo para los clics y las vistas.Ejemplo de informes de resumen:
{ "aggregation_keys": { "campaignCounts": "0x159", "geoValue": "0x5" }, "aggregatable_report_window": "86400", "destination": "https://example.com" }
Ejemplo de informes a nivel del evento:
{ "source_event_id": "12340873456", "destination": "[eTLD+1]", "expiry": "[64-bit signed integer]", "priority": "[64-bit signed integer]", "event_report_window": "[64-bit signed integer]" }
Atributos obligatorios y opcionales
A medida que uses elementos HTML o realices llamadas de JavaScript para registrar fuentes, es posible que debas usar attributionsrc
o attributionReporting
. Consulta la siguiente tabla para obtener detalles sobre cuándo son obligatorios.
Si attributionsrc
es opcional, su uso indica que la solicitud es apta para Attribution Reporting. Si usas attributionsrc
, el navegador envía el encabezado Attribution-Reporting-Eligible
. También es útil para la medición de app a Web: si attributionsrc
está presente, el navegador envía el encabezado Attribution-Reporting-Support
.
Método de registro | Origen |
---|---|
Etiqueta <a> |
(fuente de navegación) El valor attributionsrc es obligatorio. |
Etiqueta <img> |
(fuente del evento) El valor attributionsrc es obligatorio. |
Etiqueta <script> |
(fuente del evento) El valor attributionsrc es obligatorio. |
fetch llamada |
La opción attributionReporting es obligatoria. |
XMLHttpRequest |
La opción attributionReporting es obligatoria. |
window.open llamada |
(fuente de navegación) El valor attributionsrc es obligatorio. |
Paso 1: Inicia el registro de la fuente
El paso 1 es diferente para los clics y las vistas.
Si deseas registrar una fuente de atribución para un clic, puedes usar una etiqueta <a>
o window.open()
de JavaScript.
Usa un ancla
Agregue attributionsrc
a las etiquetas <a>
existentes para las que desea medir impresiones o clics:
<a href="https://shoes.example/..." attributionsrc>Click me</a>
Revisa el código de ejemplo para obtener más información.
Uso de una secuencia de comandos
Llama a window.open()
con attributionsrc
:
window.open(
"https://shoes.example/...",
"_blank",
"attributionsrc");
Para tener en cuenta, este método debe llamarse en un plazo de 5 segundos después de la interacción del usuario.
En lugar de agregar attributionsrc
solo, para una imagen o secuencia de comandos, puedes especificar un solo valor de URL:
<a href=... attributionsrc="https://a.example/register-source">Click me</a>
En el caso de JavaScript, si le asignas un valor a attributionsrc
, asegúrate de codificar esa URL en caso de que contenga caracteres especiales, como =
, que puedan hacer que el parámetro se analice de forma incorrecta.
Codifica de la siguiente manera:
const encodedUrl = encodeURIComponent(
"https://adtech.example/attribution_source?ad_id=...");
window.open(
"https://shoes.example/landing",
"_blank",
`attributionsrc=${encodedUrl}`);
attributionsrc
también puede tomar una lista de URLs separadas por espacios, como se muestra aquí con una etiqueta <a>
:
<a href=... attributionsrc="https://a.example/register-source
https://b.example/register-source">Click me</a>
o tal como está aquí con window.open()
.
window.open("...", "_blank", `attributionsrc=${encodedUrl1}
attributionsrc=${encodedUrl2}`)
En esos casos, ambas URLs reciben solicitudes attributionsrc
aptas para la fuente de navegación (solicitudes que incluyen el encabezado Attribution-Reporting-Eligible
).
attributionsrc
con o sin un valor
Como viste anteriormente, puedes especificar attributionsrc
sin una URL. También puedes especificar una sola URL. Además, puedes usar una lista de URLs separadas por espacios.
El uso de URLs hace que el navegador inicie una solicitud de recuperación de keepalive independiente, una para cada URL, que incluye el encabezado de la solicitud Attribution-Reporting-Eligible
.
Esto es útil si deseas realizar el registro de la fuente respondiendo a una solicitud independiente de la solicitud principal del elemento.
Por ejemplo, si necesitas registrar fuentes para clics en un elemento ancla, es posible que, en realidad, no tengas el control del destino. En este caso, querrás una configuración mediante la cual envíes el encabezado de registro de la fuente como respuesta a una solicitud que es independiente de la navegación y que puedes controlar por completo. Cuando especificas un valor explícito para attributionsrc
, le indicas al navegador que realice esa solicitud adicional y configura su destino.
Si quieres registrar una fuente de atribución para una vista, puedes usar una etiqueta de imagen o secuencia de comandos a la que agregarás el atributo attributionsrc
.
Como alternativa, puedes usar JavaScript fetch()
o XMLHttpRequest()
.
Con una imagen
<img attributionsrc
src="https://adtech.example/attribution_source?ad_id=...">
Con un guion
<script attributionsrc
src="https://adtech.example/attribution_source?ad_id=..."></script>
De manera opcional, puedes especificar un valor de URL para attributionsrc
de la misma manera que para los clics; es decir, para una imagen o secuencia de comandos , puedes configurar la URL de attributionsrc
o las URLs de esta manera:
Con una sola URL:
<img attributionsrc="https://adtech.example/attribution_source?ad_id=123">
Con una lista de URLs:
<img attributionsrc="https://a.example/register-source
https://b.example/register-source">
Usa fetch()
o XMLHttpRequest()
Este código simula de forma eficaz lo que haría una solicitud HTML con attributionsrc
:
const attributionReporting = {
eventSourceEligible: true,
triggerEligible: false,
};
// Optionally set keepalive to ensure the request outlives the page.
window.fetch("https://adtech.example/attribution_source?my_ad_id=123",
{ keepalive: true, attributionReporting });
const attributionReporting = {
eventSourceEligible: true,
triggerEligible: false,
};
const req = new XMLHttpRequest();
req.open("GET", url);
req.setAttributionReporting(attributionReporting);
req.send();
Paso 2: Responde con un encabezado (clics y vistas)
El siguiente paso para los clics y las vistas es responder con el encabezado Attribution-Reporting-Register-Source
.
Revisa el código de ejemplo para obtener más información.
Cuando recibas la solicitud del navegador en el servidor, responde e incluye el encabezado Attribution-Reporting-Register-Source
en tu respuesta.
res.set(
"Attribution-Reporting-Register-Source",
JSON.stringify({
// Use source_event_id to map it to any granular information
// you need at ad-serving time
source_event_id: "412444888111012",
destination: "https://advertiser.example",
// Optional fields
expiry: "604800",
priority: "100",
debug_key: "122939999"
})
);
Una vez que se convierta en string, el encabezado se verá de la siguiente manera:
{"source_event_id":"412444888111012","destination":"https://advertiser.example","expiry":"604800","priority":"100","debug_key":"122939999"}
Próximos pasos
Obtén información para registrar activadores de atribución.