Wysyłaj dane przekazywane przez użytkowników za pomocą funkcji User-ID za pomocą Measurement Protocol

Podobnie jak w przypadku gtag można używać platformy Measurement Protocol Google Analytics do wysyłania danych przekazywanych przez użytkowników razem z identyfikatorem User-ID, co może służyć do polepszania pomiarów działań i konwersji.

Aby wysłać dane przekazywane przez użytkowników wraz z żądaniem Measurement Protocol, dodaj parametr user_data do ładunku JSON. Zalecamy też dodawanie parametru user_id zawsze, gdy podany jest parametr user_data. Zapewnia to najdokładniejsze pomiary i działanie funkcji.

Platforma Measurement Protocol korzysta z tego samego algorytmu normalizacji i haszowania co funkcja pomiaru rozszerzonego w interfejsie Google Ads API. Ze względu na ochronę prywatności przed przesłaniem adresów e-mail, numerów telefonów, imion, nazwisk i adresów pocztowych należy je zaszyfrować przy użyciu algorytmu SHA-256. Zahaszowana wartość powinna być zakodowana w formacie ciągu szesnastkowego (ciąg obiekt zawierający tylko cyfry szesnastkowe), np.88d7ecb5c5b21d7b1.

Aby ustandaryzować wyniki szyfrowania, przed zaszyfrowaniem tych wartości musisz:

  • usuń spacje na początku i na końcu ciągu,
  • zmienić pisownię tekstu na małe litery,
  • Sformatuj numery telefonów zgodnie ze standardem E.164.
  • Usuń wszystkie kropki (.) poprzedzające nazwę domeny w adresach e-mail gmail.comgooglemail.com.

Treść żądania POST w formacie JSON

Klucz Typ Opis
user_id ciąg znaków unikalny identyfikator użytkownika. Więcej informacji o tym identyfikatorze znajdziesz w artykule Używanie funkcji User-ID do analizy obejmującej wiele platform.
user_data obiekt Ulepszone pola danych użytkownika identyfikujące użytkownika.
user_data.sha256_email_address[] tablica tekstowa Zaszyfrowany i zakodowany adres e-mail użytkownika. Znormalizowany w ten sposób:
user_data.sha256_phone_number[] tablica tekstowa Zaszyfrowany i zakodowany numer telefonu użytkownika. Znormalizowany w ten sposób:
  • usuń wszystkie znaki inne niż cyfry
  • dodaj prefiks +
  • zaszyfrować za pomocą algorytmu SHA256,
  • kodować w formacie ciągu szesnastkowego.
user_data.address[] tablica Identyfikuje użytkownika na podstawie fizycznej lokalizacji.
user_data.address[].sha256_first_name ciąg znaków Zahaszowane i zakodowane imię użytkownika. Znormalizowany w ten sposób:
  • usuwać cyfry i symbole,
  • lowercase
  • usuwanie spacji na początku i na końcu,
  • zaszyfrować za pomocą algorytmu SHA256,
  • kodować w formacie ciągu szesnastkowego.
user_data.address[].sha256_last_name ciąg znaków Zahaszowane i zakodowane nazwisko użytkownika. Znormalizowany w ten sposób:
  • usuwać cyfry i symbole,
  • lowercase
  • usuwanie spacji na początku i na końcu,
  • zaszyfrować za pomocą algorytmu SHA256,
  • kodować w formacie ciągu szesnastkowego.
user_data.address[].sha256_street ciąg znaków Zaszyfrowana i zakodowana ulica oraz numer użytkownika. Znormalizowany w ten sposób:
  • usuwanie znaków symboli,
  • lowercase
  • usuwanie spacji na początku i na końcu,
  • zaszyfrować za pomocą algorytmu SHA256,
  • kodować w formacie ciągu szesnastkowego.
user_data.address[].city ciąg znaków Miasto w adresie użytkownika. Znormalizowany w ten sposób:
  • usuwać cyfry i symbole,
  • lowercase
  • usuń spacje na początku i na końcu ciągu,
user_data.address[].region ciąg znaków Stan lub terytorium adresu użytkownika. Znormalizowany w ten sposób:
  • usuwać cyfry i symbole,
  • lowercase
  • usuń spacje na początku i na końcu ciągu,
user_data.address[].postal_code ciąg znaków Kod pocztowy adresu użytkownika. Znormalizowany w ten sposób:
  • usuwać znaki .~;
  • usuń spacje na początku i na końcu ciągu,
user_data.address[].country ciąg znaków Kod kraju adresu użytkownika. Sformatowany zgodnie ze standardem ISO 3166-1 alpha-2.

Więcej informacji o formatowaniu transportu i ładunku znajdziesz w dokumentacji referencyjnej Measurement Protocol.

Wysyłanie danych przekazywanych przez użytkowników

W przeciwieństwie do gtag, który automatycznie szyfruje poufne dane przekazywane przez użytkowników, Measurement Protocol wymaga od dewelopera zaszyfrowania poufnych danych przekazywanych przez użytkowników za pomocą bezpiecznego jednokierunkowego algorytmu szyfrowania o nazwie SHA256 i zakodowania ich w formacie ciągu szesnastkowego przed wywołaniem interfejsu API.

Wszystkie pola danych użytkownika, których nazwy zaczynają się od prefiksu sha256, powinny zawierać tylko wartości zaszyfrowane i zakodowane w systemie szesnastkowym.

Poniższy przykładowy kod wykonuje niezbędne czynności związane z szyfrowaniem i kodowaniem:

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 hashArray.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));

Wygodnym skrótem jest to, że wszystkie powtórzone pola w obiekcie user_data (np. address, sha256_email_address, sha256_phone_number) mogą przyjmować pojedynczą wartość zamiast tablicy.

Poniższy przykładowy kod wywołuje Measurement Protocol i przekazuje dane użytkownika wraz z identyfikatorem User-ID.

Node.js

const measurementId = "MEASUREMENT_ID";
const apiSecret = "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
      }
    }
  })
});

Wiele wartości

Programiści mogą opcjonalnie podawać kilka wartości (maksymalnie 3 dla numeru telefonu i adresu e-mail oraz 2 dla adresu pocztowego), używając wartości w postaci tablicy zamiast ciągu. Jeśli zbierasz co najmniej 2 wartości danej zmiennej, podawanie ich zwiększy prawdopodobieństwo dopasowania.

Node.js

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

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: [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
      }]
    }
  })
});