Envoyer des données fournies par l'utilisateur avec le User-ID à l'aide du protocole de mesure

Comme pour gtag, il est possible d'utiliser le protocole de mesure Google Analytics pour Google Analytics 4 afin d'envoyer les données fournies par les utilisateurs en même temps que le User-ID. Cela permet d'améliorer la mesure du comportement et des conversions.

Pour envoyer des données fournies par l'utilisateur avec une requête de protocole de mesure, ajoutez le paramètre user_data dans la charge utile JSON. Le paramètre user_id doit être présent chaque fois que user_data est fourni.

Le protocole de mesure utilise le même algorithme de normalisation et de hachage que la fonctionnalité de mesures améliorées de l'API Google Ads. Pour des raisons de confidentialité, les adresses e-mail, les numéros de téléphone, les prénoms, les noms et les adresses postales doivent être hachés à l'aide de l'algorithme SHA-256 avant d'être importés. La valeur hachée doit être encodée au format de chaîne hexadécimale (objet de chaîne ne contenant que des chiffres hexadécimaux), par exemple 88d7ecb5c5b21d7b1.

Afin de standardiser les résultats du hachage, avant de hacher l'une de ces valeurs, vous devez:

• Supprimez les espaces blancs de début et de fin.
• Convertissez le texte en minuscules.
• Mettez en forme les numéros de téléphone conformément à la norme E164.
• Supprimez tous les points (.) qui précèdent le nom de domaine dans les adresses e-mail gmail.com et googlemail.com.

Corps du post JSON

Consultez la documentation de référence du protocole de mesure pour en savoir plus sur la mise en forme du transport et de la charge utile.

Envoyer les données fournies par l'utilisateur

Contrairement à gtag, qui hache automatiquement les données sensibles fournies par l'utilisateur, le protocole de mesure exige qu'un développeur hache ces données sensibles à l'aide d'un algorithme de hachage à sens unique sécurisé, appelé SHA256, et les encode à l'aide d'un format de chaîne hexadécimale avant d'appeler l'API.

Tous les champs de données utilisateur dont le nom commence par le préfixe sha256 ne doivent contenir que des valeurs hachées et encodées en hexadécimal.

L'exemple de code suivant effectue les étapes de chiffrement et d'encodage nécessaires:

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

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

// Test the encryption function by calling it.
async function main() {
  return await populateSensitiveUserData('<value>');
}

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

Pour plus de commodité, tous les champs répétés dans l'objet user_data (tels que address, sha256_email_address, sha256_phone_number) peuvent recevoir une valeur unique au lieu d'un tableau.

L'exemple de code suivant appelle le protocole de mesure et transmet les données utilisateur avec le User-ID.

const measurement_id = 'G-XXXXXXXXXX';
const api_secret = '<secret_value>';

// 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=${measurement_id}&api_secret=${api_secret}`, {
  method: "POST",
  body: JSON.stringify({
    client_id: 'XXXXXXXXXX.YYYYYYYYYY',
    user_id: "XXX",
    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
      }
    }
  })
});

Plusieurs valeurs

Les développeurs peuvent éventuellement fournir plusieurs valeurs (jusqu'à trois pour le numéro de téléphone et l'adresse e-mail, et deux pour l'adresse) en utilisant une valeur de tableau plutôt qu'une chaîne. Si vous capturez plusieurs valeurs, elles augmentent la probabilité d'une correspondance.

const measurement_id = 'G-XXXXXXXXXX';
const api_secret = '<secret_value>';

fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurement_id}&api_secret=${api_secret}`, {
  method: "POST",
  body: JSON.stringify({
    client_id: 'XXXXXXXXXX.YYYYYYYYYY',
    user_id: "XXX",
    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
      }]
    }
  })
});