Konversi yang Disempurnakan

API konversi offline CM360 mendukung peningkatan konversi berbasis tag situs dengan ID pengguna.

Konversi yang Disempurnakan

  • Setujui Persyaratan Layanan Konversi yang Disempurnakan untuk konfigurasi Floodlight di CM360.
  • Lengkapi situs Anda dengan ID kecocokan.
  • Mencatat konversi Floodlight yang terjadi di situs Anda. Pastikan untuk mencatat semua hal berikut karena merupakan kolom wajib diisi dalam panggilan API berikutnya:
    • matchId
    • ordinal
    • timestampMicros
    • floodlightActivityId
    • floodlightConfigurationId
    • quantity
    • value
  • Setelah 90 menit berlalu sejak tag online merekam konversi, panggil conversions.batchupdate untuk meningkatkan kualitas konversi ini dengan ID pengguna.
    • ID pengguna harus diformat dan di-hash, lalu ditambahkan ke kolom userIdentifiers pada objek Konversi.
    • Jumlah dan nilai harus ditentukan. Anda dapat menyesuaikan jumlah dan nilai konversi dalam panggilan conversions.batchupdate yang sama, atau memberikan jumlah dan nilai asli.
    • Setiap batch penyisipan dan pembaruan dapat berisi campuran keberhasilan dan kegagalan. Kegagalan NOT_FOUND harus dicoba lagi jika ada penundaan yang lebih lama dari biasanya dalam pemrosesan konversi, hingga 6 jam.
    • Konversi harus disempurnakan dengan ID pengguna dalam waktu 24 jam setelah konversi tersebut diambil oleh tag online.

Normalisasi dan hashing

Untuk membantu melindungi privasi, alamat email, nomor telepon, nama depan, nama belakang, dan alamat harus di-hash menggunakan algoritma SHA-256 sebelum diupload. Untuk menstandarkan hasil hash, sebelum melakukan hashing pada salah satu nilai berikut, Anda harus:

  • Hapus spasi kosong di awal atau di akhir.
  • Mengonversi teks menjadi huruf kecil.
  • Format nomor telepon sesuai dengan standar E164.

  • Hapus semua titik (.) yang mendahului nama domain di alamat email gmail.com dan googlemail.com.

C#

/// <summary>
/// Normalizes the email address and hashes it. For this use case, Campaign Manager 360
/// requires removal of any '.' characters preceding <code>gmail.com</code> or
/// <code>googlemail.com</code>.
/// </summary>
/// <param name="emailAddress">The email address.</param>
/// <returns>The hash code.</returns>
private string NormalizeAndHashEmailAddress(string emailAddress)
{
    string normalizedEmail = emailAddress.ToLower();
    string[] emailParts = normalizedEmail.Split('@');
    if (emailParts.Length > 1 && (emailParts[1] == "gmail.com" ||
        emailParts[1] == "googlemail.com"))
    {
        // Removes any '.' characters from the portion of the email address before
        // the domain if the domain is gmail.com or googlemail.com.
        emailParts[0] = emailParts[0].Replace(".", "");
        normalizedEmail = $"{emailParts[0]}@{emailParts[1]}";
    }
    return NormalizeAndHash(normalizedEmail);
}

/// <summary>
/// Normalizes and hashes a string value.
/// </summary>
/// <param name="value">The value to normalize and hash.</param>
/// <returns>The normalized and hashed value.</returns>
private static string NormalizeAndHash(string value)
{
    return ToSha256String(digest, ToNormalizedValue(value));
}

/// <summary>
/// Hash a string value using SHA-256 hashing algorithm.
/// </summary>
/// <param name="digest">Provides the algorithm for SHA-256.</param>
/// <param name="value">The string value (e.g. an email address) to hash.</param>
/// <returns>The hashed value.</returns>
private static string ToSha256String(SHA256 digest, string value)
{
    byte[] digestBytes = digest.ComputeHash(Encoding.UTF8.GetBytes(value));
    // Convert the byte array into an unhyphenated hexadecimal string.
    return BitConverter.ToString(digestBytes).Replace("-", string.Empty);
}

/// <summary>
/// Removes leading and trailing whitespace and converts all characters to
/// lower case.
/// </summary>
/// <param name="value">The value to normalize.</param>
/// <returns>The normalized value.</returns>
private static string ToNormalizedValue(string value)
{
    return value.Trim().ToLower();
}

Java

private String normalizeAndHash(MessageDigest digest, String s)
    throws UnsupportedEncodingException {
  // Normalizes by removing leading and trailing whitespace and converting all characters to
  // lower case.
  String normalized = s.trim().toLowerCase();
  // Hashes the normalized string using the hashing algorithm.
  byte[] hash = digest.digest(normalized.getBytes("UTF-8"));
  StringBuilder result = new StringBuilder();
  for (byte b : hash) {
    result.append(String.format("%02x", b));
  }

  return result.toString();
}

/**
 * Returns the result of normalizing and hashing an email address. For this use case, Campaign Manager 360
 * requires removal of any '.' characters preceding {@code gmail.com} or {@code googlemail.com}.
 *
 * @param digest the digest to use to hash the normalized string.
 * @param emailAddress the email address to normalize and hash.
 */
private String normalizeAndHashEmailAddress(MessageDigest digest, String emailAddress)
    throws UnsupportedEncodingException {
  String normalizedEmail = emailAddress.toLowerCase();
  String[] emailParts = normalizedEmail.split("@");
  if (emailParts.length > 1 && emailParts[1].matches("^(gmail|googlemail)\\.com\\s*")) {
    // Removes any '.' characters from the portion of the email address before the domain if the
    // domain is gmail.com or googlemail.com.
    emailParts[0] = emailParts[0].replaceAll("\\.", "");
    normalizedEmail = String.format("%s@%s", emailParts[0], emailParts[1]);
  }
  return normalizeAndHash(digest, normalizedEmail);
}

PHP

private static function normalizeAndHash(string $hashAlgorithm, string $value): string
{
    return hash($hashAlgorithm, strtolower(trim($value)));
}

/**
  * Returns the result of normalizing and hashing an email address. For this use case, Campaign
  * Manager 360 requires removal of any '.' characters preceding "gmail.com" or "googlemail.com".
  *
  * @param string $hashAlgorithm the hash algorithm to use
  * @param string $emailAddress the email address to normalize and hash
  * @return string the normalized and hashed email address
  */
private static function normalizeAndHashEmailAddress(
    string $hashAlgorithm,
    string $emailAddress
): string {
    $normalizedEmail = strtolower($emailAddress);
    $emailParts = explode("@", $normalizedEmail);
    if (
        count($emailParts) > 1
        && preg_match('/^(gmail|googlemail)\.com\s*/', $emailParts[1])
    ) {
        // Removes any '.' characters from the portion of the email address before the domain
        // if the domain is gmail.com or googlemail.com.
        $emailParts[0] = str_replace(".", "", $emailParts[0]);
        $normalizedEmail = sprintf('%s@%s', $emailParts[0], $emailParts[1]);
    }
    return self::normalizeAndHash($hashAlgorithm, $normalizedEmail);
}

Python

def normalize_and_hash_email_address(email_address):
    """Returns the result of normalizing and hashing an email address.

    For this use case, Campaign Manager 360 requires removal of any '.'
    characters preceding "gmail.com" or "googlemail.com"

    Args:
        email_address: An email address to normalize.

    Returns:
        A normalized (lowercase, removed whitespace) and SHA-265 hashed string.
    """
    normalized_email = email_address.lower()
    email_parts = normalized_email.split("@")
    # Checks whether the domain of the email address is either "gmail.com"
    # or "googlemail.com". If this regex does not match then this statement
    # will evaluate to None.
    is_gmail = re.match(r"^(gmail|googlemail)\.com$", email_parts[1])

    # Check that there are at least two segments and the second segment
    # matches the above regex expression validating the email domain name.
    if len(email_parts) > 1 and is_gmail:
        # Removes any '.' characters from the portion of the email address
        # before the domain if the domain is gmail.com or googlemail.com.
        email_parts[0] = email_parts[0].replace(".", "")
        normalized_email = "@".join(email_parts)

    return normalize_and_hash(normalized_email)

def normalize_and_hash(s):
    """Normalizes and hashes a string with SHA-256.

    Private customer data must be hashed during upload, as described at:
    https://support.google.com/google-ads/answer/7474263

    Args:
        s: The string to perform this operation on.

    Returns:
        A normalized (lowercase, removed whitespace) and SHA-256 hashed string.
    """
    return hashlib.sha256(s.strip().lower().encode()).hexdigest()

Ruby

# Returns the result of normalizing and then hashing the string using the
# provided digest.  Private customer data must be hashed during upload, as
# described at https://support.google.com/google-ads/answer/7474263.
def normalize_and_hash(str)
  # Remove leading and trailing whitespace and ensure all letters are lowercase
  # before hasing.
  Digest::SHA256.hexdigest(str.strip.downcase)
end

# Returns the result of normalizing and hashing an email address. For this use
# case, Campaign Manager 360 requires removal of any '.' characters preceding
# 'gmail.com' or 'googlemail.com'.
def normalize_and_hash_email(email)
  email_parts = email.downcase.split("@")
  # Removes any '.' characters from the portion of the email address before the
  # domain if the domain is gmail.com or googlemail.com.
  if email_parts.last =~ /^(gmail|googlemail)\.com\s*/
    email_parts[0] = email_parts[0].gsub('.', '')
  end
  normalize_and_hash(email_parts.join('@'))
end

Menambahkan ID pengguna ke konversi

Siapkan objek Conversion terlebih dahulu untuk mengupload atau mengedit seperti biasa, lalu lampirkan ID pengguna sebagai berikut:

{
  "matchId": "my-match-id-846513278",
  "ordinal": "my-ordinal-12345678512",
  "quantity": 1,
  "value": 104.23,
  "timestampMicros": 1656950400000000,
  "floodlightConfigurationId": 99999,
  "floodlightActivityId": 8888,
  "userIdentifiers": [
    { "hashedEmail": "0c7e6a405862e402eb76a70f8a26fc732d07c32931e9fae9ab1582911d2e8a3b" },
    { "hashedPhoneNumber": "1fb1f420856780a29719b994c8764b81770d79f97e2e1861ba938a7a5a15dfb9" },
    {
      "addressInfo": {
        "hashedFirstName": "81f8f6dde88365f3928796ec7aa53f72820b06db8664f5fe76a7eb13e24546a2",
        "hashedLastName": "799ef92a11af918e3fb741df42934f3b568ed2d93ac1df74f1b8d41a27932a6f",
        "hashedStreetAddress": "22b7e2d69b91e0ef4a88e81a73d897b92fd9c93ccfbe0a860f77db16c26f662e",
        "city": "seattle",
        "state": "washington",
        "countryCode": "US",
        "postalCode": "98101"
      }
    }
  ]
}

Respons yang berhasil akan terlihat seperti ini:

{
  "hasFailures": false,
  "status": [
    {
      "conversion": {
        "floodlightConfigurationId": 99999,
        "floodlightActivityId": 8888,
        "timestampMicros": 1656950400000000,
        "value": 104.23,
        "quantity": 1,
        "ordinal": "my-ordinal-12345678512",
        "matchId": "my-match-id-846513278",
        "userIdentifiers": [
          { "hashedEmail": "0c7e6a405862e402eb76a70f8a26fc732d07c32931e9fae9ab1582911d2e8a3b" },
          { "hashedPhoneNumber": "1fb1f420856780a29719b994c8764b81770d79f97e2e1861ba938a7a5a15dfb9" },
          {
            "addressInfo": {
              "hashedFirstName": "81f8f6dde88365f3928796ec7aa53f72820b06db8664f5fe76a7eb13e24546a2",
              "hashedLastName": "799ef92a11af918e3fb741df42934f3b568ed2d93ac1df74f1b8d41a27932a6f",
              "hashedStreetAddress": "22b7e2d69b91e0ef4a88e81a73d897b92fd9c93ccfbe0a860f77db16c26f662e",
              "city": "seattle",
              "state": "washington",
              "countryCode": "US",
              "postalCode": "98101"
            }
          }
        ],
        "kind": "dfareporting#conversion"
      },
      "kind": "dfareporting#conversionStatus"
    }
  ]
}

Error yang biasa terjadi

Berikut beberapa error yang mungkin Anda lihat saat menyempurnakan konversi dengan ID pengguna:

Kolom hashed_X bukan hash SHA-256 yang valid
Semua kolom yang diawali dengan hashed hanya menerima hash SHA-256 yang dienkode dalam heksadesimal.
Kolom country_code memiliki panjang yang salah
country_code harus tepat 2 huruf.
Konfigurasi Floodlight belum menandatangani persyaratan layanan konversi yang disempurnakan
Persyaratan Layanan Konversi yang Disempurnakan belum disetujui untuk ID konfigurasi Floodlight permintaan.
Lebih dari lima user_identifier yang ditentukan
Konversi hanya dapat memiliki hingga 5 ID pengguna.

Pertanyaan umum (FAQ)

Mengapa ID kecocokan direkomendasikan?
Pengeditan berbasis ID klik mengecualikan konversi yang tidak didahului oleh klik dan membatasi nilai integrasi konversi yang disempurnakan.
Mengapa jumlah dan nilai harus dicatat?
CM360 Offline Conversions API mengharuskan jumlah dan nilai ditentukan.
Apakah saya perlu mendapatkan stempel waktu mikrodetik persis yang dicatat oleh Google untuk mengedit konversi berbasis tag online?
Untuk pengeditan berbasis ID kecocokan, API kini menerima pengeditan selama stempel waktu yang diberikan dalam permintaan berada dalam waktu 1 menit dari stempel waktu yang dicatat Google.
Mengapa saya harus menunggu 90 menit setelah konversi dicatat oleh tag online sebelum meningkatkan kualitasnya?
Diperlukan waktu hingga 90 menit agar konversi online diindeks oleh API dan tersedia untuk diedit.
Apa yang harus saya perhatikan dalam respons API?
Meskipun CM360 Conversion API menampilkan respons yang berhasil, beberapa konversi individual mungkin gagal diupload atau diperbarui. Periksa kolom ConversionStatus satu per satu untuk mengetahui kegagalan:
  • Kegagalan NOT_FOUND dapat dan harus dicoba lagi, hingga 6 jam, jika terjadi keterlambatan yang lebih lama dari biasanya dalam pemrosesan konversi. Lihat juga FAQ tentang alasan error NOT_FOUND dapat berlanjut lebih dari 6 jam.
  • Error INVALID_ARGUMENT dan PERMISSION_DENIED tidak boleh dicoba lagi.