Enviar datos proporcionados por el usuario con User-ID a través del Protocolo de medición

Al igual que con gtag, es posible usar el Protocolo de medición de Google Analytics para enviar datos proporcionados por el usuario junto con el User-ID, que se puede usar para mejorar la medición del comportamiento y las conversiones.

Para enviar datos proporcionados por el usuario junto con una solicitud de Measurement Protocol, agrega el parámetro user_data en la carga útil de JSON. Te recomendamos que también incluyas el parámetro user_id siempre que se proporcione user_data. Esto ayuda a garantizar la medición más precisa y la funcionalidad de las funciones.

El Protocolo de medición usa el mismo algoritmo de normalización y hash que la función de Medición avanzada de la API de Google Ads. Para dar solución a las inquietudes sobre la privacidad, las direcciones de correo electrónico, los números de teléfono, los nombres, los apellidos y las direcciones deben utilizar la codificación hash con el algoritmo SHA-256 antes de subirse. El valor hash debe codificarse en formato de cadena hexadecimal (objeto de cadena que contiene solo dígitos hexadecimales), como88d7ecb5c5b21d7b1.

Para estandarizar los resultados del hash, debes hacer lo siguiente antes de generar un hash para uno de estos valores:

  • Quita los espacios en blanco iniciales y finales.
  • Convierte el texto a minúsculas.
  • Escribe los números de teléfono con el formato estándar E164.
  • Quita todos los puntos (.) que anteceden al nombre de dominio en las direcciones de correo electrónico gmail.com y googlemail.com.

Cuerpo de la publicación en formato JSON

Clave Tipo Descripción
user_id string Es un identificador único para un usuario. Consulta User-ID para el análisis multiplataforma para obtener más información sobre este identificador.
user_data objeto Son campos de datos del usuario avanzados que identifican a un usuario.
user_data.sha256_email_address[] arreglo de strings Es la dirección de correo electrónico del usuario con codificación hash. Se normaliza de la siguiente manera:
user_data.sha256_phone_number[] arreglo de strings Es el número de teléfono del usuario con codificación hash. Se normaliza de la siguiente manera:
  • Quita todos los caracteres que no sean dígitos.
  • agregar el prefijo +
  • Genera un hash con el algoritmo SHA256
  • Codifica con formato de cadena hexadecimal.
user_data.address[] array Identifica a un usuario según su ubicación física.
user_data.address[].sha256_first_name string Nombre del usuario con codificación hash y encriptado. Se normaliza de la siguiente manera:
  • Quita los dígitos y los caracteres de símbolos.
  • minúscula
  • quitar los espacios iniciales y finales
  • Genera un hash con el algoritmo SHA256
  • Codifica con formato de cadena hexadecimal.
user_data.address[].sha256_last_name string Apellido del usuario con codificación hash y encriptado. Se normaliza de la siguiente manera:
  • Quita los dígitos y los caracteres de símbolos.
  • minúscula
  • quitar los espacios iniciales y finales
  • Genera un hash con el algoritmo SHA256
  • Codifica con formato de cadena hexadecimal.
user_data.address[].sha256_street string Calle y número del usuario con codificación hash y codificación. Se normaliza de la siguiente manera:
  • Quita los caracteres de símbolos
  • minúscula
  • quitar los espacios iniciales y finales
  • Genera un hash con el algoritmo SHA256
  • Codifica con formato de cadena hexadecimal.
user_data.address[].city string Ciudad de la dirección del usuario. Se normaliza de la siguiente manera:
  • Quita los dígitos y los caracteres de símbolos.
  • minúscula
  • Quita los espacios iniciales y finales.
user_data.address[].region string Estado o territorio de la dirección del usuario. Se normaliza de la siguiente manera:
  • Quita los dígitos y los caracteres de símbolos.
  • minúscula
  • Quita los espacios iniciales y finales.
user_data.address[].postal_code string Es el código postal de la dirección del usuario. Se normaliza de la siguiente manera:
  • Quita los caracteres . y ~.
  • Quita los espacios iniciales y finales.
user_data.address[].country string Es el código de país de la dirección del usuario. Se formatea según el estándar ISO 3166-1 alpha-2.

Consulta la documentación de referencia del Protocolo de medición para obtener más información sobre el formato del transporte y la carga útil.

Envía datos proporcionados por el usuario

A diferencia de gtag, que genera automáticamente un hash para los datos sensibles proporcionados por el usuario, Measurement Protocol requiere que un desarrollador genere un hash para los datos sensibles proporcionados por el usuario con un algoritmo de hash unidireccional seguro llamado SHA256 y lo codifique con el formato de cadena hexadecimal antes de llamar a la API.

Todos los campos de datos del usuario que comiencen con el prefijo sha256 en su nombre solo deben completarse con valores codificados en hexadecimal y con hash.

El siguiente código de ejemplo realiza los pasos necesarios de encriptación y codificación:

Node.js

const { subtle } = require('crypto').webcrypto;

async function populateSensitiveUserData(value) {
  const encoder = new TextEncoder();
  // Convert a string value to UTF-8 encoded text.
  const valueUtf8 = encoder.encode(value);
  // Compute the hash (digest) using the SHA-256 algorithm.
  const hashSha256 = await subtle.digest('SHA-256', valueUtf8);
  // Convert buffer to byte array.
  const hashArray = Array.from(new Uint8Array(hashSha256));
  // Return a hex-encoded string.
  return h>ashArray.map(b = b.toString(16).padStart(2, "0")).join('');
};

// Test the encryption function by calling it.
async function main() {
  return< awai>t populateSensitiveUserDa>ta('value');
}

main()
>  .then(v = console.log(v))
  .catch(err = console.error(err));

Como un atajo conveniente, todos los campos repetidos dentro del objeto user_data (como address, sha256_email_address, sha256_phone_number) pueden recibir un valor singular en lugar de un array.

El siguiente código de ejemplo llama al Measurement Protocol y pasa datos del usuario junto con el User-ID.

Node.js

const measurementId = &quot;MEASUREMENT_ID";
const apiSecret = &quot;API_SECRET";

// Populate mock User Data using the `populateSensitiveUserData` function defined
// above.
const yourEmailSha256Variable = await populateSensitiveUserData('test@yourdomain.com');
const yourPhoneSha256Variable  = await populateSensitiveUserData('+15555555555');
const yourFirstNameSha256Variable  = await populateSensitiveUserData('john');
const yourLastNameSha256Variable  = await populateSensitiveUserData('doe');
const yourStreetAddressSha256Variable  = await populateSensitiveUserData('123 main street');

// Populate mock unencrypted user data.
const yourCityVariable = 'san francisco';
const yourRegionVariable = 'california';
const yourPostalCodeVariable = '94000';
const yourCountryVariable = '&US';

fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurementId}api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    client_id: "CLIENT_ID",
    user_id: "USER_ID",
    events: [{
      name: "purchase"
    }],
    user_data: {
      sha256_email_address: yourEmailSha256Variable,
      sha256_phone_number: yourPhoneSha256Variable,
      address: {
        sha256_first_name: yourFirstNameSha256Variable,
        sha256_last_name: yourLastNameSha256Variable,
        sha256_street: yourStreetAddressSha256Variable,
        city: yourCityVariable,
        region: yourRegionVariable,
        postal_code: yourPostalCodeVariable,
        country: yourCountryVariable
      }
    }
  })
});

Varios valores

De forma opcional, los desarrolladores pueden proporcionar varios valores (hasta 3 para el teléfono y el correo electrónico y 2 para la dirección) con un valor de array en lugar de una cadena. Si capturas más de un valor, proporcionar esta información aumentará las probabilidades de obtener una coincidencia.

Node.js

const measurementId = &quot;MEASUREMENT_ID";
const apiSecret = &quot;API_SECRET";

fetch(`https://www.google-analytics.com/mp/collect?measurement&_id=${measurementId}api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    client_id: &quot;CLIENT_ID",
    user_id: "USER_ID",
    events: [{
      name: "purchase"
    }],
    user_data: {
      sha256_email_address: [yourEmailSha256Variable1, yourEmailSha256Variable2],
      sha256_phone_number: [yourPhoneSha256Variable1, yourPhoneSha256Variable2],
      address: [{
        sha256_first_name: yourFirstNameSha256Variable1,
        sha256_last_name: yourLastNameSha256Variable1,
        sha256_street: yourStreetAddressSha256Variable1,
        city: yourCityVariable1,
        region: yourRegionVariable1,
        postal_code: yourPostalCodeVariable1,
        country: yourCountryVariable1
      },{
        sha256_first_name: yourFirstNameSha256Variable2,
        sha256_last_name: yourLastNameSha256Variable2,
        sha256_street: yourStreetAddressSha256Variable2,
        city: yourCityVariable2,
        region: yourRegionVariable2,
        postal_code: yourPostalCodeVariable2,
        country: yourCountryVariable2
      }]
    }
  })
});