Registra las fuentes de atribución

Obtén información sobre cómo registrar fuentes para atribuir los clics y las 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, la información sobre la campaña o la ubicación geográfica - Un destino de conversión, como el sitio donde espera que el usuario genere una conversión.

Sigue los pasos que se indican en este documento para registrar las fuentes (impresiones de anuncios o clics) a las que el navegador atribuye 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 llamada
  • XMLHttpRequest
  • window.open

Esto genera solicitudes de red a las que luego respondes con un encabezado de respuesta HTTP de registro de fuente.

Cómo registrar fuentes para los clics o las vistas

Si deseas registrar una fuente de atribución para clics o vistas, sigue los pasos que se indican aquí. Sigue los pasos completos. Este es el resumen:

  1. 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.
  2. 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 usas elementos HTML o haces llamadas de JavaScript para registrar fuentes, es posible que debas usar attributionsrc o attributionReporting. Consulta la siguiente tabla para obtener detalles sobre cuándo se requieren.

Si attributionsrc es opcional, usarlo 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)
attributionsrc es obligatorio.
Etiqueta <img> (fuente del evento)
attributionsrc es obligatorio.
Etiqueta <script> (fuente del evento)
attributionsrc es obligatorio.
fetch llamada La opción attributionReporting es obligatoria.
XMLHttpRequest La opción attributionReporting es obligatoria.
window.open() (fuente de navegación)
attributionsrc es obligatorio

Paso 1: Inicia el registro de la fuente

El paso 1 es diferente para los clics y las vistas. Abre las pestañas correspondientes a cada una de ellas.

Si deseas registrar una fuente de atribución para un clic, puedes usar una etiqueta <a> o window.open() de JavaScript.

Usa un ancla

Agrega attributionsrc a las etiquetas <a> existentes para las que deseas medir las impresiones o los 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 que se tenga 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 por sí solo, puedes especificar un solo valor de URL para una imagen o una secuencia de comandos:

<a href=... attributionsrc="https://a.example/register-source">

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 haría que el parámetro se analice incorrectamente.

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 ilustra aquí con una etiqueta de anclaje:

<!-- With an anchor tag -->
<a href=... attributionsrc="https://a.example/register-source 
  https://b.example/register-source"> 

o como está aquí con window.open().

// With window.open()
window.open('...', '_blank', attributionsrc=${encodedUrl1}
  attributionsrc=${encodedUrl2})

En esos casos, ambas URLs reciben solicitudes navigation-source-eligible attributionsrc (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, solo para las fuentes (no aplicable a los activadores), 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 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 de clics en un elemento de anclaje, es posible que en realidad no tengas el control del destino; en este caso, querrás una configuración en la que envíes el encabezado de registro de origen como respuesta a una solicitud que sea independiente de la navegación y que puedas controlar por completo. Si especificas un valor explícito para attributionsrc, le indicas al navegador que realice esa solicitud adicional y configure su destino.

Para el paso 1 del registro de vistas, ve a las pestañas y selecciona el paso 1.

Si deseas registrar una fuente de atribución para una vista, puedes usar una etiqueta de imagen o de 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=..."/>

De manera opcional, puedes especificar un valor de URL para attributionsrc de la misma manera que para los clics; es decir, en el caso de una imagen o secuencia de comandos , puedes configurar la URL de attributionsrc o las URLs de esta manera:

Con una sola URL:

 attributionsrc="https://adtech.example/attribution_source?ad_id=123"

Con una lista de URLs:

  attributionsrc="https://a.example/register-source
    https://b.example/register-source"

Usa fetch() o XMLHttpRequest()

Este código simula de forma efectiva lo que haría una solicitud HTML con attributionsrc:

// With fetch
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 });
// With XHR
const attributionReporting = {
  eventSourceEligible: true,
  triggerEligible: false,
};

const req = new XMLHttpRequest();
  req.open('GET', url);
  req.setAttributionReporting(
    attributionReporting);
  req.send();

Para el paso 1 del registro de clics, ve a las pestañas y selecciona el paso 1 de Clics.


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 en tu respuesta el encabezado Attribution-Reporting-Register-Source.

 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 en cadena, 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.