Conceptos básicos de la API de Private Agregación

Conceptos clave de la API de Private Aggregation

¿Para quién está destinado este documento?

La API de Private Aggregation permite la recopilación de datos agregados de los worklets con acceso a datos de varios sitios. Los conceptos que se comparten aquí son importantes para los desarrolladores que crean informes funciones en el almacenamiento compartido y la API de Protected Audience.

  • Si eres un desarrollador que crea un sistema de informes para la medición entre sitios
  • Si eres especialista en marketing, científico de datos o cualquier otro informe de resumen consumidor, comprender estos mecanismos te ayudará a tomar decisiones de diseño decisiones para recuperar un informe de resumen optimizado.

Términos clave

Antes de leer este documento, te recomendamos que te familiarices con los términos y conceptos clave. Cada uno de estos términos se describirá en detalle aquí.

  • Una clave de agregación (también conocida como bucket) es una recopilación predeterminada de datos. Por ejemplo, es posible que quieras recopilar un bucket de datos de ubicación en el que el navegador informa el país de la fuente de datos. Una clave de agregación puede contener más de una dimensión (por ejemplo, el país y el ID del widget de contenido).
  • Un valor agregable es un dato individual que se recopila en una clave de agregación. Si quieres medir cuántos usuarios de Francia vieron tu contenido, por lo tanto, France es una dimensión del clave de agregación y el viewCount de 1 es el valor agregable.
  • Los informes agregables se generan y encriptan en un navegador. Para el API de Private Aggregation, contiene datos sobre un solo evento.
  • El servicio de agregación procesa los datos de los informes agregables para crear un informe de resumen.
  • Un informe de resumen es el resultado final del servicio de agregación y contiene datos de usuarios agregados con ruido y datos de conversiones detallados.
  • Un worklet es una pieza de infraestructura que te permite ejecutar funciones específicas de JavaScript y la información de vuelta al solicitante. Dentro de un worklet, puedes ejecutar JavaScript, pero no puedes interactuar ni comunicarte con la página externa.

Flujo de trabajo de agregación privada

Cuando llamas a la API de Private Aggregation con una clave de agregación y un con un valor agregable, el navegador genera un informe agregable. Los informes se envían a tu servidor, que los agrupa. El servicio de agregación procesará los informes por lotes más adelante y se generará un informe de resumen.

Los datos fluyen del cliente al recopilador y, luego, al servicio de agregación para generar un informe de resumen.
  1. Cuando llamas a la API de agregación privada, el cliente (navegador) genera y envía el informe agregable a tu servidor para que se recopile.
  2. Tu servidor recopila los informes de los clientes y los agrupa para enviarlos al servicio de agregación.
  3. Una vez que hayas recopilado suficientes informes, los enviarás por lotes y los enviarás al de agregación, que se ejecuta en un entorno de ejecución confiable, para generar un informe de resumen.

El flujo de trabajo que se describe en esta sección es similar al de la API de Attribution Reporting. Sin embargo, los Informes de atribución asocian los datos recopilados de un evento de impresión y un evento de conversión, que ocurren en diferentes momentos. La agregación privada mide un único entre sitios.

Clave de agregación

Una clave de agregación (“clave” para abreviar) representa el bucket al que los valores agregables se acumularán. Se pueden codificar una o más dimensiones en la clave. Una dimensión representa un aspecto sobre el que deseas obtener más información, como el grupo etario de los usuarios o el recuento de impresiones de una campaña publicitaria.

Por ejemplo, puedes tener un widget incorporado en varios sitios y querer analizar el país de los usuarios que lo vieron. Estás mirando para responder preguntas como “¿Cuántos de los usuarios que vieron mi widget están del país X?". Para generar informes sobre esta pregunta, puedes configurar una clave de agregación que codifique dos dimensiones: el ID del widget y el ID del país.

La clave proporcionada a la API de Private Aggregation es una BigInt, que consta de varias dimensiones. En este ejemplo, las dimensiones son el ID del widget y el ID del país. Supongamos que el ID del widget puede tener hasta 4 dígitos. largo, como 1234, y cada país se asigna a un número en orden alfabético como Afganistán es 1, Francia es 61 y Zimbabue es '195'. Por lo tanto, la clave agregable tendría 7 dígitos, mientras que los primeros 4 caracteres están reservados para WidgetID; los últimos 3 caracteres reservado para CountryID.

Supongamos que la clave representa el recuento de usuarios de Francia (ID de país 061) que vieron el ID del widget 3276. La clave de agregación es 3276061.

Clave de agregación
ID del widget ID del país
3276 061

La clave de agregación también se puede generar con un mecanismo de hash, como SHA-256 Por ejemplo, la cadena {"WidgetId":3276,"CountryID":67} puede generar un hash y, luego, convertirse en Valor BigInt de 42943797454801331377966796057547478208888578253058197330928948081739249096287n Si el valor de hash tiene más de 128 bits, puedes truncarlo para asegurarte de que no supere el valor máximo permitido del bucket de 2^128−1.

Dentro de una tarea de trabajo de almacenamiento compartido, puedes acceder a los módulos crypto y TextEncoder que pueden ayudarte a generar un hash. Para obtener más información sobre cómo generar un hash, consulta SubtleCrypto.digest() en MDN.

En el siguiente ejemplo, se describe cómo puedes generar una clave de bucket a partir de un valor con codificación hash:

async function convertToBucket(data) {
  // Encode as UTF-8 Uint8Array
  const encodedData = new TextEncoder().encode(data);

  // Generate SHA-256 hash
  const hashBuffer = await crypto.subtle.digest('SHA-256', encodedData);

  // Truncate the hash
  const truncatedHash = Array.from(new Uint8Array(hashBuffer, 0, 16));

  // Convert the byte sequence to a decimal
  return truncatedHash.reduce((acc, curr) => acc * 256n + BigInt(curr), 0n);
}

const data = {
  WidgetId: 3276,
  CountryID: 67
};

const dataString = JSON.stringify(data);
const bucket = await convertToBucket(dataString);

console.log(bucket); // 126200478277438733997751102134640640264n

Valor agregable

Los valores agregables se suman por clave en muchos usuarios para generar estadísticas agregadas en forma de valores de resumen en los informes de resumen.

Ahora, volvamos a la pregunta de ejemplo anterior: “¿Cuántos de los usuarios que vieron mi widget son de Francia?" La respuesta a esta pregunta se verá aproximadamente así: "Aproximadamente 4,881 usuarios que vieron mi widget con el ID 3276 son de Francia". El valor agregable es 1 para cada usuario, y "4881 usuarios" es el valor agregado que es la suma de todos los valores agregables para esa clave de agregación.

Clave de agregación Valor agregable
ID del widget ID del país Recuento de vistas
3276 061 1

En este ejemplo, incrementamos el valor en 1 para cada usuario que ve el widget. En la práctica, el valor agregable se puede escalar para mejorar la señal a ruido relación de aspecto.

Presupuesto de contribución

Cada llamada a la API de Private Aggregation se denomina contribución. Para proteger privacidad del usuario, la cantidad de contribuciones que se pueden recopilar de un individuos son limitados.

Cuando sumas todos los valores agregables en todas las claves de agregación, la suma debe ser inferior al presupuesto de contribución. El presupuesto se limita a cada trabajo. origin, por día, y es independientes para la API de Protected Audience y los worklets de almacenamiento compartido. Una línea de tiempo de las últimas 24 horas aproximadamente. Si un nuevo cliente o un informe agregable haría que se exceda el presupuesto, el informe no crear.

El presupuesto de contribución está representado por el parámetro L1 y es se establece en 216 (65,536) cada diez minutos al día, con un respaldo de 220

(1,048,576). Consulta la explicación para obtener más información sobre estos parámetros.

El valor del presupuesto de contribución es arbitrario, pero el ruido se ajusta a él. Puedes usar este presupuesto para maximizar la relación señal-ruido en los valores de resumen (que se explica con más detalle en la sección Ruido y escalamiento).

Si deseas obtener más información sobre los presupuestos de contribución, consulta el explicación. Además, consulta el presupuesto de contribuciones para obtener más orientación.

Límite de contribución por informe

El límite de contribución puede variar según el emisor. Por el momento, los informes generados para los llamadores de la API de Shared Storage tienen un límite de 20 contribuciones por informe. Por otro lado, los llamadores de la API de Protected Audience tienen un límite de 100 contribuciones por informe. Se eligieron estos límites para equilibrar la cantidad de contribuciones que se pueden incorporar con el tamaño de la carga útil.

En el caso del almacenamiento compartido, las contribuciones realizadas en un solo run() o selectURL() se agrupan en lotes en un informe. En el caso de Protected Audience, las contribuciones que realiza un solo origen dentro de una subasta se agrupan en lotes.

Contribuciones con padding

Las contribuciones se modifican aún más con una función de padding. El acto de rellenar protege la información sobre el número real de contribuciones incorporadas en el informe agregable. El padding aumenta la carga útil con contribuciones de null. (es decir, con un valor de 0) para alcanzar una longitud fija.

Informes agregables

Una vez que el usuario invoca la API de Private Aggregation, el navegador genera informes agregables que el servicio de agregación procesará más adelante para generar informes de resumen. Un informe agregable tiene formato JSON y contiene una lista encriptada de contribuciones, cada una de las cuales es un par {aggregation key, aggregatable value}. Los informes agregables se envían con un retraso aleatorio de hasta una hora.

Las contribuciones están encriptadas y no se pueden leer fuera del servicio de agregación. El servicio de agregación desencripta los informes y genera un informe de resumen. El coordinador, que actúa como servicio de administración de claves, emite la clave de encriptación para el navegador y la clave de desencriptación para el servicio de agregación. El coordinador mantiene una lista de hashes binarios de la imagen del servicio para verificar. que el llamador pueda recibir la clave de desencriptación.

Un ejemplo de informe agregable con debug automático habilitado:

  "aggregation_service_payloads": [
    {
      "debug_cleartext_payload": "omRkYXRhgaJldmFsdWVEAAAAgGZidWNrZXRQAAAAAAAAAAAAAAAAAAAE0mlvcGVyYXRpb25paGlzdG9ncmFt",
      "key_id": "2cc72b6a-b92f-4b78-b929-e3048294f4d6",
      "payload": "a9Mk3XxvnfX70FsKrzcLNZPy+00kWYnoXF23ZpNXPz/Htv1KCzl/exzplqVlM/wvXdKUXCCtiGrDEL7BQ6MCbQp1NxbWzdXfdsZHGkZaLS2eF+vXw2UmLFH+BUg/zYMu13CxHtlNSFcZQQTwnCHb"
    }
  ],
  "debug_key": "777",
  "shared_info": "{\"api\":\"shared-storage\",\"debug_mode\":\"enabled\",\"report_id\":\"5bc74ea5-7656-43da-9d76-5ea3ebb5fca5\",\"reporting_origin\":\"https://localhost:4437\",\"scheduled_report_time\":\"1664907229\",\"version\":\"0.1\"}"

Los informes agregables se pueden inspeccionar desde la página chrome://private-aggregation-internals:

captura de pantalla de la página de componentes internos de la API de Private Aggregation

Para fines de prueba, el botón "Enviar informes seleccionados" se puede usar para enviar el informe al servidor de inmediato.

Recopilar y agrupar en lotes informes

El navegador envía los informes agregables al origen del worklet que contiene la llamada a la API de Private Aggregation, mediante los atributos ruta:

  • Para Shared Storage: /.well-known/private-aggregation/report-shared-storage
  • Para Protected Audience: /.well-known/private-aggregation/report-protected-audience

En estos extremos, deberás operar un servidor que actúe como recopilador y que reciba los informes agregables que envían los clientes.

Luego, el servidor debe agrupar los informes y enviarlo a la herramienta de Servicio. Crea lotes según la información disponible en la carga útil no encriptada del informe agregable, como el campo shared_info. Idealmente, Los lotes deben contener 100 o más informes por lote.

Puedes decidir realizar lotes a diario o semanalmente. Esta estrategia es flexible y puedes cambiar tu estrategia de lotes para eventos específicos en los que esperas más volumen, por ejemplo, los días del año en los que se esperan más impresiones. Los lotes deben incluir informes de la misma versión de la API, el mismo origen de informes y el mismo horario de informes programado.

Servicio de agregación

El servicio se ejecuta en un TEE, desencripta los informes agregables y agrega
para crear el informe de resumen final.

El servicio de agregación recibe informes agregables encriptados del recopilador y genera informes de resumen.

Para desencriptar la carga útil del informe, el servicio de agregación recupera una clave de desencriptación del coordinador. El servicio se ejecuta en un entorno de ejecución confiable (TEE), que proporciona un nivel de garantía para la integridad de los datos, la confidencialidad de los datos y la integridad del código. Aunque seas el propietario del servicio y lo administres, no tendrás visibilidad de los datos que se procesan dentro del TEE.

Resumen de informes

Informes de resumen le permiten ver los datos que ha recopilado con ruido agregado. Puedes solicitar informes de resumen para un conjunto determinado de claves.

Un informe de resumen contiene un conjunto de pares clave-valor de estilo diccionario JSON. Cada par contiene lo siguiente:

  • bucket: Es la clave de agregación como una cadena de números binarios. Si la clave de agregación que se usa es "123", el bucket es "1111011".
  • value: Es el valor de resumen de un objetivo de medición determinado, que se resume a partir de todos los informes agregables disponibles con ruido agregado.

Por ejemplo:

[
  {"bucket":` `"111001001",` `"value":` `"2558500"},
  {"bucket":` `"111101001",` `"value":` `"3256211"},
  {"bucket":` `"111101001",` `"value":` `"6536542"},
]

Ruido y escalamiento

Para preservar la privacidad del usuario, el servicio de agregación agrega ruido una vez a cada valor de resumen cada vez que se solicita un informe de resumen. Los valores de ruido son extraídas de forma aleatoria de una probabilidad de Laplace distribución. Si bien no tienes control directo sobre las formas en que se agrega el ruido, puedes influir en el impacto del ruido en los datos de medición.

La distribución del ruido es la misma independientemente de la suma de todos los valores que se pueden agrupar. Por lo tanto, cuanto más altos sean los valores agregables, menor será el impacto del ruido un modelo de AA.

Por ejemplo, digamos que la distribución de ruido tiene una desviación estándar de 100 y está centrada en cero. Si el valor del informe agregable recopilado (o "valor agregable") es solo 200, la desviación estándar del ruido sería el 50% del valor agregado. Sin embargo, si el valor agregable es de 20,000, la desviación estándar del ruido solo sería del 0.5% del valor agregado. Por lo tanto, el valor agregable de 20,000 tendría una relación señal/ruido mucho más alta.

Por lo tanto, multiplicar tu valor agregable por un factor de escalamiento puede ayudarte reducir el ruido. El factor de escalamiento representa cuánto deseas escalar un valor agregado determinado.

El ruido es constante independientemente del valor agregado.

El escalamiento de los valores mediante la elección de un factor de escalamiento más alto reduce el ruido relativo. Sin embargo, esto también suma todas las contribuciones de todos los buckets para alcanzar el límite del presupuesto de contribución más rápido. Si reduces los valores eligiendo una constante de factor de escalamiento más pequeña, se aumenta el ruido relativo, pero se reduce el riesgo de alcanzar el límite de presupuesto.

Escalar el valor agregable al presupuesto de contribución

Para calcular un factor de escala adecuado, divide el presupuesto de contribución por la suma máxima de valores agregables en todas las claves.

Consulta el Presupuesto de contribución documentación para obtener más información.

Interactúa y comparte tus comentarios

La API de Private Aggregation está en discusión activa y está sujeta a cambios en el futuro. Si pruebas esta API y tienes comentarios, nos encantaría conocerlos.