ניהול המרות אופליין

אתם יכולים להשתמש ב-Google Ads API כדי לייבא המרות אופליין ל-Google Ads, וכך לעקוב אחרי מודעות שהובילו למכירות אופליין, למשל בטלפון או דרך נציג מכירות.

כדי ליהנות מכל היתרונות של ייבוא נתוני המרות, מומלץ להטמיע המרות משופרות לצורך שיוך ללידים. התכונה הזו מתבססת על מספרי קליק ב-Google (GCLID) ועל הפרטים שהמשתמשים סיפקו (UPD) כדי לשפר את הביצועים לאורך זמן.

המרות משופרות

המרות משופרות עוזרות לשפר את הדיוק של מעקב ההמרות על ידי הוספת נתוני המרות מאינטראקציה ישירה (First-Party), כמו כתובת אימייל, שם, כתובת מגורים ומספר טלפון.

יש שני סוגים של המרות משופרות. פרטים נוספים זמינים במאמר מידע על המרות משופרות במרכז העזרה.

בקטע הבא נסביר איך לשפר את ההמרות אופליין, תכונה שנקראת גם המרות משופרות לצורך שיוך ללידים.

מה זה תיעוד המרות משופר לצורך שיוך ללידים?

התכונה 'המרות משופרות לצורך שיוך ללידים' היא גרסה משודרגת של 'ייבוא של נתוני המרות אופליין' והיא מבוססת על הפרטים שהמשתמשים סיפקו (UPD), כמו כתובות אימייל. היא משמשת כתוספת לנתונים המיובאים של המרות אופליין כדי לשפר את הדיוק ואת ביצועי הבידינג. כשאתם מייבאים המרות אופליין, המערכת משתמשת בפרטים המגובבים (hashed) שהלקוחות סיפקו כדי ליצור שיוך לקמפיין Google Ads. השיוך נעשה על ידי התאמה לנתונים זהים שנאספו באתר שלכם, כמו טופס להשארת פרטים, והתאמה ללקוחות שמחוברים לחשבון ויצרו אינטראקציה עם המודעה שלכם. מידע נוסף על האופן שבו המרות משופרות לצורך שיוך ללידים פועלות זמין במאמר מידע על המרות משופרות לצורך שיוך ללידים.

יש שתי דרכים להטמיע המרות משופרות לצורך שיוך ללידים, בהתאם לשיטה שבה אתם משתמשים כדי לעקוב אחרי אירועים של שליחת טפסים בדף האינטרנט: Google Tag או Google Tag Manager. כדי ליהנות מהביצועים הטובים ביותר ומהיציבות הגבוהה ביותר, מומלץ מאוד להשתמש ב-Google Tag להמרות משופרות לצורך שיוך ללידים.

  • אם אתם מתחילים מאפס, כדאי להתחיל עם הקטע דרישות מוקדמות.
  • אם כבר הגדרתם ייבוא של נתוני המרות אופליין ואתם רוצים לשדרג ל"המרות משופרות לצורך שיוך ללידים", מומלץ להתחיל עם הקטע הגדרת תיוג.
  • אם כבר הגדרתם את Google Tag או שאתם לא מתכננים להשתמש ב-Google Tag, ואתם מתחילים לעבוד על השילוב של Google Ads API, אתם יכולים לדלג אל הסעיף הטמעה של API.
  • אם אתם לא יכולים לייבא פרטים שהמשתמשים סיפקו או אם אתם מסתמכים על שיוך חיצוני להמרות, כדאי לעיין במדריך לגרסה הקודמת של ייבוא נתוני המרות אופליין.

דרישות מוקדמות

קודם כל, חשוב לוודא שהשלמתם את השלבים שמפורטים בקטע תחילת העבודה.

כדי להשתמש בהמרות משופרות לצורך שיוך ללידים, צריך להביע הסכמה לשימוש בהמרות משופרות לצורך שיוך ללידים ולאשר את התנאים בנוגע לנתונים של לקוחות. כדי לוודא שאתם עומדים בדרישות המוקדמות האלה, אתם יכולים להריץ את השאילתה הבאה ללקוח ההמרות ב-Google Ads:

SELECT
  customer.id,
  customer.conversion_tracking_setting.accepted_customer_data_terms,
  customer.conversion_tracking_setting.enhanced_conversions_for_leads_enabled
FROM customer

אם אחד מהערכים accepted_customer_data_terms או enhanced_conversions_for_leads_enabled הוא false, צריך לפעול לפי ההוראות במרכז העזרה כדי להשלים את הדרישות המוקדמות האלה.

הגדרת תיוג

כדי להגדיר את Google Tag כך שיאפשר המרות משופרות לצורך שיוך ללידים, פועלים לפי ההוראות שבמרכז העזרה. כדי להגדיר המרות משופרות לצורך שיוך ללידים באמצעות Google Tag Manager, פועלים לפי ההוראות האלה.

הטמעה של API

הנה תיאור כללי של תהליך הייבוא של המרות משופרות לצורך שיוך ללידים באמצעות Google Ads API.

  1. לנרמל ולגבב את הפרטים שהמשתמשים סיפקו, כמו כתובת אימייל, מספר טלפון וכתובת למשלוח.

  2. מאכלסים אובייקטים של ClickConversion בנתונים מנורמלים ומגובבים שהמשתמשים סיפקו.

  3. ייבוא אובייקטים של ClickConversion אל Google Ads API באמצעות ConversionUploadService.

  4. בדיקת הייבוא

נרמול וגיבוב (hash) של פרטים שהמשתמשים סיפקו

משיקולי פרטיות, צריך לבצע גיבוב של הנתונים הבאים באמצעות SHA-256 לפני שמייבאים אותם:

  • כתובת אימייל
  • מספר טלפון
  • שם פרטי
  • שם משפחה
  • רחוב

כדי לבצע סטנדרטיזציה של תוצאות הגיבוב, צריך לבצע את הפעולות הבאות לפני שמגבבים את הערכים האלה:

  • מסירים רווחים לבנים בתחילת הטקסט ובסופו.
  • ממירים את הטקסט לאותיות קטנות.
  • מזינים מספרי טלפון בפורמט שתואם לתקן E164.
  • מסירים את כל הנקודות (.) שלפני שם הדומיין בכתובות אימייל עם הסיומות gmail.com ו-googlemail.com.

אין לבצע גיבוב של הנתונים הבאים:

  • מדינה
  • מדינה (State)
  • עיר
  • מיקוד

קוד לדוגמה

בדוגמה הזו מוסבר איך לנרמל ולגבב נתונים שהמשתמשים סיפקו.

Java

private String normalizeAndHash(MessageDigest digest, String s)
    throws UnsupportedEncodingException {
  // Normalizes by first converting all characters to lowercase, then trimming spaces.
  String normalized = s.toLowerCase();
  // Removes leading, trailing, and intermediate spaces.
  normalized = normalized.replaceAll("\\s+", "");
  // 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, Google Ads
 * 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);
}
      

C#‎

/// <summary>
/// Normalizes the email address and hashes it. For this use case, Google Ads 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();
}
      

PHP

private static function normalizeAndHash(string $hashAlgorithm, string $value): string
{
    // Normalizes by first converting all characters to lowercase, then trimming spaces.
    $normalized = strtolower($value);
    // Removes leading, trailing, and intermediate spaces.
    $normalized = str_replace(' ', '', $normalized);
    return hash($hashAlgorithm, strtolower(trim($normalized)));
}

/**
 * Returns the result of normalizing and hashing an email address. For this use case, Google
 * Ads 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, Google Ads 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.strip().lower()
    email_parts = normalized_email.split("@")

    # Check that there are at least two segments
    if len(email_parts) > 1:
        # 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.
        if re.match(r"^(gmail|googlemail)\.com$", email_parts[1]):
            # 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 hashing.
  Digest::SHA256.hexdigest(str.strip.downcase)
end

# Returns the result of normalizing and hashing an email address. For this use
# case, Google Ads 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
      

Perl

sub normalize_and_hash {
  my $value = shift;

  # Removes leading, trailing, and intermediate spaces.
  $value =~ s/\s+//g;
  return sha256_hex(lc $value);
}

# Returns the result of normalizing and hashing an email address. For this use
# case, Google Ads requires removal of any '.' characters preceding 'gmail.com'
# or 'googlemail.com'.
sub normalize_and_hash_email_address {
  my $email_address = shift;

  my $normalized_email = lc $email_address;
  my @email_parts      = split('@', $normalized_email);
  if (scalar @email_parts > 1
    && $email_parts[1] =~ /^(gmail|googlemail)\.com\s*/)
  {
    # Remove any '.' characters from the portion of the email address before the
    # domain if the domain is 'gmail.com' or 'googlemail.com'.
    $email_parts[0] =~ s/\.//g;
    $normalized_email = sprintf '%s@%s', $email_parts[0], $email_parts[1];
  }
  return normalize_and_hash($normalized_email);
}
      

איכלוס אובייקטים מסוג ClickConversion

האוסף של אובייקטים מסוג ClickConversion ב-UploadClickConversionRequest מייצג את קבוצת ההמרות שרוצים לייבא. כשיוצרים אובייקטים של ClickConversion, חשוב לזכור את הפרטים הבאים:

gclid

מספרי הקליק ב-Google‏ (GCLID) הם מזהי קליקים שמתועדים מפרמטרים של כתובות URL כשמשתמש לוחץ על המודעה שלכם ועובר לאתר שלכם.

user_identifiers

כשמשתמשים בהמרות משופרות לצורך שיוך ללידים, חובה למלא את השדה user_identifiers בפרטים מגובבים שהמשתמשים סיפקו אחרי שהם עברו נרמול. אם יש לכם כמה מזהי משתמשים, אתם יכולים ליצור עד חמישה UserIdentifier נפרדים, אחד לכל מזהה.

conversion_date_time

התאריך והשעה של ההמרה.

צריך לציין ערך של אזור זמן, והפורמט צריך להיות yyyy-mm-dd HH:mm:ss+|-HH:mm, למשל: 2022-01-01 19:32:45-05:00 (בלי להתחשב בשעון קיץ).

אפשר להגדיר את אזור הזמן לכל ערך תקין: הוא לא חייב להיות זהה לאזור הזמן של החשבון. עם זאת, אם אתם מתכננים להשוות בין נתוני ההמרות המיובאים לבין הנתונים בממשק המשתמש של Google Ads, מומלץ להשתמש באותו אזור זמן כמו בחשבון Google Ads, כדי שמספר ההמרות יהיה זהה. פרטים נוספים ודוגמאות זמינים במרכז העזרה. אפשר גם לעיין בקודים ופורמטים כדי לראות רשימה של מזהי אזורי זמן תקינים.

conversion_action

שם המשאב של ConversionAction להמרה אופליין.

לפעולת ההמרה צריך להיות type עם הערך UPLOAD_CLICKS, והיא צריכה להיות קיימת בלקוח ההמרות של Google Ads בחשבון Google Ads שמשויך לקליק.

conversion_value

הערך של ההמרה.

currency_code

קוד המטבע של conversion_value.

consent

מומלץ מאוד למלא את השדה consent של האובייקט ClickConversion. אם לא תגדירו את התג, יכול להיות שלא תהיה אפשרות לשייך את ההמרות.

order_id

נקרא גם מזהה העסקה של ההמרה. השדה הזה הוא אופציונלי, אבל מומלץ מאוד להשתמש בו כי הוא מאפשר להתייחס בקלות להמרות שיובאו כשמבצעים התאמות. אם הגדרתם אותו במהלך הייבוא, אתם צריכים להשתמש בו לכל ההתאמות. במאמר הזה במרכז העזרה יש מידע נוסף על שימוש במזהה עסקה כדי לצמצם כפילויות בספירת ההמרות.

custom_variables

הערכים של משתני המרה מותאמים אישית.

מערכת Google Ads לא תומכת במשתני המרה מותאמים אישית בשילוב עם wbraid או gbraid.

conversion_environment

בעמודה הזו מצוינת הסביבה שבה נרשמה ההמרה הזו. לדוגמה, APP או WEB.

session_attributes_encoded וגם session_attributes_key_value_pairs

מאפייני סשן מייצגים מזהים מצטברים שמשמשים לשיוך המרות. הם פועלים בנוסף למזהי קליקים (כמו GCLID ו-GBRAID) ולפרטים שהמשתמשים סיפקו, שהם מרכזיים להמרות משופרות לצורך שיוך ללידים. יש שתי דרכים לייבא מאפיינים של סשנים: על ידי ציון הטוקן המקודד שנוצר על ידי קוד ה-JavaScript שלנו בדפדפן, או על ידי ציון זוגות של מפתח וערך לכל אחד מהמזהים.

כדי לשפר את ביצועי הקמפיין, מומלץ לייבא את מזהי הקליקים, את הנתונים שהמשתמשים סיפקו ואת מאפייני הסשן עם כל ההמרות, אם אפשר.

Java

// Sets one of the sessionAttributesEncoded or sessionAttributesKeyValuePairs if either is
// provided.
if (rawRecord.containsKey("sessionAttributesEncoded")) {
  clickConversionBuilder.setSessionAttributesEncoded(
      ByteString.copyFromUtf8(rawRecord.get("sessionAttributesEncoded")));
} else if (rawRecord.containsKey("sessionAttributesMap")) {
  List<String> pairings =
      Arrays.stream(rawRecord.get("sessionAttributesMap").split(" "))
          .map(String::trim)
          .collect(Collectors.toList());
  SessionAttributesKeyValuePairs.Builder sessionAttributePairs =
      SessionAttributesKeyValuePairs.newBuilder();
  for (String pair : pairings) {
    String[] parts = pair.split("=", 2);
    if (parts.length != 2) {
      throw new IllegalArgumentException(
          "Failed to read the sessionAttributesMap. SessionAttributesMap must use a "
              + "space-delimited list of session attribute key value pairs. Each pair should be"
              + " separated by an equal sign, for example: 'gad_campaignid=12345 gad_source=1'");
    }
    sessionAttributePairs.addKeyValuePairs(
        SessionAttributeKeyValuePair.newBuilder()
            .setSessionAttributeKey(parts[0])
            .setSessionAttributeValue(parts[1])
            .build());
  }
  clickConversionBuilder.setSessionAttributesKeyValuePairs(sessionAttributePairs.build());
}
      

C#‎

if (!string.IsNullOrEmpty(sessionAttributesEncoded))
{
    clickConversion.SessionAttributesEncoded =
        ByteString.CopyFrom(sessionAttributesEncoded, Encoding.Unicode);
}
else if (!string.IsNullOrEmpty(sessionAttributes))
{
    IEnumerable<SessionAttributeKeyValuePair> parsedSessionAttributes =
        sessionAttributes.Split(';').Select(pair => {
            string[] split = pair.Split('=');
            return new SessionAttributeKeyValuePair()
            {
                SessionAttributeKey = split[0],
                SessionAttributeValue = split[1]
            };
        });

    clickConversion.SessionAttributesKeyValuePairs =
        new SessionAttributesKeyValuePairs();
    clickConversion.SessionAttributesKeyValuePairs.KeyValuePairs
        .AddRange(parsedSessionAttributes);
}
      

PHP

This example is not yet available in PHP; you can take a look at the other languages.
    

Python

# Set one of the session_attributes_encoded or
# session_attributes_key_value_pairs fields if either are provided.
if session_attributes_encoded:
    click_conversion.session_attributes_encoded = session_attributes_encoded
elif session_attributes_dict:
    for key, value in session_attributes_dict.items():
        pair = client.get_type("SessionAttributeKeyValuePair")
        pair.session_attribute_key = key
        pair.session_attribute_value = value
        click_conversion.session_attributes_key_value_pairs.key_value_pairs.append(
            pair
        )
      

Ruby

This example is not yet available in Ruby; you can take a look at the other languages.
    

Perl

# Set one of the session_attributes_encoded or session_attributes_key_value_pairs
# fields if either are provided.
if (defined $session_attributes_encoded) {
  $click_conversion->{sessionAttributesEncoded} = $session_attributes_encoded;
} elsif (defined $session_attributes_hash) {
  while (my ($key, $value) = each %$session_attributes_hash) {
    my $pair =
      Google::Ads::GoogleAds::V20::Services::ConversionUploadService::SessionAttributeKeyValuePair
      ->new({sessionAttributeKey => $key, sessionAttributeValue => $value});
    push @{$click_conversion->{sessionAttributesKeyValuePairs}{keyValuePairs}
    }, $pair;
  }
}
      

user_ip_address

כתובת ה-IP של הלקוח כשהוא הגיע לדף הנחיתה אחרי לחיצה על מודעה ולפני אירוע המרה. זו כתובת ה-IP של המכשיר של הלקוח, ולא של השרת של המפרסם.

השדה הזה הוא מחרוזת שמייצגת כתובת IP בפורמט IPv4 או IPv6. לדוגמה:

  • ‫IPv4: ‏"192.0.2.0"
  • ‫IPv6: ‏"2001:0DB8:1234:5678:9999:1111:0000:0001"

קוד לדוגמה

בדוגמה הזו מוצג איך להגדיר את הנתונים המנורמלים והמגובבים שהמשתמשים סיפקו באובייקט ClickConversion.

Java

// Creates an empty builder for constructing the click conversion.
ClickConversion.Builder clickConversionBuilder = ClickConversion.newBuilder();

// Extracts user email and phone from the raw data, normalizes and hashes it, then wraps it in
// UserIdentifier objects.
// Creates a separate UserIdentifier object for each. The data in this example is hardcoded, but
// in your application you might read the raw data from an input file.

// IMPORTANT: Since the identifier attribute of UserIdentifier
// (https://developers.google.com/google-ads/api/reference/rpc/latest/UserIdentifier) is a
// oneof
// (https://protobuf.dev/programming-guides/proto3/#oneof-features), you must set only ONE of
// hashedEmail, hashedPhoneNumber, mobileId, thirdPartyUserId, or addressInfo. Setting more
// than one of these attributes on the same UserIdentifier will clear all the other members
// of the oneof. For example, the following code is INCORRECT and will result in a
// UserIdentifier with ONLY a hashedPhoneNumber.
//
// UserIdentifier incorrectlyPopulatedUserIdentifier =
//     UserIdentifier.newBuilder()
//         .setHashedEmail("...")
//         .setHashedPhoneNumber("...")
//         .build();

ImmutableMap.Builder<String, String> rawRecordBuilder =
    ImmutableMap.<String, String>builder()
        .put("email", "alex.2@example.com")
        // Phone number to be converted to E.164 format, with a leading '+' as required.
        .put("phone", "+1 800 5550102")
        // This example lets you put conversion details as arguments, but in reality you might
        // store this data alongside other user data, so we include it in this sample user
        // record.
        .put("conversionActionId", Long.toString(conversionActionId))
        .put("conversionDateTime", conversionDateTime)
        .put("conversionValue", Double.toString(conversionValue))
        .put("currencyCode", "USD");

// Adds entries for the optional fields.
if (orderId != null) {
  rawRecordBuilder.put("orderId", orderId);
}
if (gclid != null) {
  rawRecordBuilder.put("gclid", gclid);
}
if (adUserDataConsent != null) {
  rawRecordBuilder.put("adUserDataConsent", adUserDataConsent.name());
}
if (sessionAttributesEncoded != null) {
  rawRecordBuilder.put("sessionAttributesEncoded", sessionAttributesEncoded);
}
if (sessionAttributesMap != null) {
  rawRecordBuilder.put("sessionAttributesMap", sessionAttributesMap);
}

// Builds the map representing the record.
Map<String, String> rawRecord = rawRecordBuilder.build();

// Creates a SHA256 message digest for hashing user identifiers in a privacy-safe way, as
// described at https://support.google.com/google-ads/answer/9888656.
MessageDigest sha256Digest = MessageDigest.getInstance("SHA-256");

// Creates a list for the user identifiers.
List<UserIdentifier> userIdentifiers = new ArrayList<>();

// Creates a user identifier using the hashed email address, using the normalize and hash method
// specifically for email addresses.
UserIdentifier emailIdentifier =
    UserIdentifier.newBuilder()
        // Optional: specify the user identifier source.
        .setUserIdentifierSource(UserIdentifierSource.FIRST_PARTY)
        // Uses the normalize and hash method specifically for email addresses.
        .setHashedEmail(normalizeAndHashEmailAddress(sha256Digest, rawRecord.get("email")))
        .build();
userIdentifiers.add(emailIdentifier);

// Creates a user identifier using normalized and hashed phone info.
UserIdentifier hashedPhoneNumberIdentifier =
    UserIdentifier.newBuilder()
        .setHashedPhoneNumber(normalizeAndHash(sha256Digest, rawRecord.get("phone")))
        .build();
// Adds the hashed phone number identifier to the UserData object's list.
userIdentifiers.add(hashedPhoneNumberIdentifier);

// Adds the user identifiers to the conversion.
clickConversionBuilder.addAllUserIdentifiers(userIdentifiers);
      

C#‎

// Adds a user identifier using the hashed email address, using the normalize
// and hash method specifically for email addresses.
clickConversion.UserIdentifiers.Add(new UserIdentifier()
{
    HashedEmail = NormalizeAndHashEmailAddress("alex.2@example.com"),
    // Optional: Specifies the user identifier source.
    UserIdentifierSource = UserIdentifierSource.FirstParty
});

// Adds a user identifier using normalized and hashed phone info.
clickConversion.UserIdentifiers.Add(new UserIdentifier()
{
    HashedPhoneNumber = NormalizeAndHash("+1 800 5550102"),
    // Optional: Specifies the user identifier source.
    UserIdentifierSource = UserIdentifierSource.FirstParty
});

// Adds a user identifier with all the required mailing address elements.
clickConversion.UserIdentifiers.Add(new UserIdentifier()
{
    AddressInfo = new OfflineUserAddressInfo()
    {
        // FirstName and LastName must be normalized and hashed.
        HashedFirstName = NormalizeAndHash("Alex"),
        HashedLastName = NormalizeAndHash("Quinn"),
        // CountryCode and PostalCode are sent in plain text.
        CountryCode = "US",
        PostalCode = "94045"
    }
});
      

PHP

// Creates a click conversion with the specified attributes.
$clickConversion = new ClickConversion();

// Extract user email and phone from the raw data, normalize and hash it, then wrap it in
// UserIdentifier objects. Creates a separate UserIdentifier object for each.
// The data in this example is hardcoded, but in your application you might read the raw
// data from an input file.

// IMPORTANT: Since the identifier attribute of UserIdentifier
// (https://developers.google.com/google-ads/api/reference/rpc/latest/UserIdentifier) is a
// oneof
// (https://protobuf.dev/programming-guides/proto3/#oneof-features), you must set only ONE
// of hashedEmail, hashedPhoneNumber, mobileId, thirdPartyUserId, or addressInfo. Setting
// more than one of these attributes on the same UserIdentifier will clear all the other
// members of the oneof. For example, the following code is INCORRECT and will result in a
// UserIdentifier with ONLY a hashedPhoneNumber.
//
// $incorrectlyPopulatedUserIdentifier = new UserIdentifier([
//    'hashed_email' => '...',
//    'hashed_phone_number' => '...'
// ]);

$rawRecord = [
    // Email address that includes a period (.) before the Gmail domain.
    'email' => 'alex.2@example.com',
    // Phone number to be converted to E.164 format, with a leading '+' as required.
    'phone' => '+1 800 5550102',
    // This example lets you input conversion details as arguments, but in reality you might
    // store this data alongside other user data, so we include it in this sample user
    // record.
    'orderId' => $orderId,
    'gclid' => $gclid,
    'conversionActionId' => $conversionActionId,
    'conversionDateTime' => $conversionDateTime,
    'conversionValue' => $conversionValue,
    'currencyCode' => 'USD',
    'adUserDataConsent' => $adUserDataConsent,
    'sessionAttributesEncoded' => $sessionAttributesEncoded,
    'sessionAttributesDict' => $sessionAttributesDict
];

// Creates a list for the user identifiers.
$userIdentifiers = [];

// Uses the SHA-256 hash algorithm for hashing user identifiers in a privacy-safe way, as
// described at https://support.google.com/google-ads/answer/9888656.
$hashAlgorithm = "sha256";

// Creates a user identifier using the hashed email address, using the normalize and hash
// method specifically for email addresses.
$emailIdentifier = new UserIdentifier([
    // Uses the normalize and hash method specifically for email addresses.
    'hashed_email' => self::normalizeAndHashEmailAddress(
        $hashAlgorithm,
        $rawRecord['email']
    ),
    // Optional: Specifies the user identifier source.
    'user_identifier_source' => UserIdentifierSource::FIRST_PARTY
]);
$userIdentifiers[] = $emailIdentifier;

// Checks if the record has a phone number, and if so, adds a UserIdentifier for it.
if (array_key_exists('phone', $rawRecord)) {
    $hashedPhoneNumberIdentifier = new UserIdentifier([
        'hashed_phone_number' => self::normalizeAndHash(
            $hashAlgorithm,
            $rawRecord['phone'],
            true
        )
    ]);
    // Adds the hashed email identifier to the user identifiers list.
    $userIdentifiers[] = $hashedPhoneNumberIdentifier;
}

// Adds the user identifiers to the conversion.
$clickConversion->setUserIdentifiers($userIdentifiers);
      

Python

# Extract user email and phone from the raw data, normalize and hash it,
# then wrap it in UserIdentifier objects. Create a separate UserIdentifier
# object for each. The data in this example is hardcoded, but in your
# application you might read the raw data from an input file.

# IMPORTANT: Since the identifier attribute of UserIdentifier
# (https://developers.google.com/google-ads/api/reference/rpc/latest/UserIdentifier)
# is a oneof
# (https://protobuf.dev/programming-guides/proto3/#oneof-features), you must
# set only ONE of hashed_email, hashed_phone_number, mobile_id,
# third_party_user_id, or address_info. Setting more than one of these
# attributes on the same UserIdentifier will clear all the other members of
# the oneof. For example, the following code is INCORRECT and will result in
# a UserIdentifier with ONLY a hashed_phone_number:
#
# incorrectly_populated_user_identifier = client.get_type("UserIdentifier")
# incorrectly_populated_user_identifier.hashed_email = "...""
# incorrectly_populated_user_identifier.hashed_phone_number = "...""

raw_record = {
    # Email address that includes a period (.) before the Gmail domain.
    "email": "alex.2@example.com",
    # Phone number to be converted to E.164 format, with a leading '+' as
    # required.
    "phone": "+1 800 5550102",
    # This example lets you input conversion details as arguments,
    # but in reality you might store this data alongside other user data,
    # so we include it in this sample user record.
    "order_id": order_id,
    "gclid": gclid,
    "conversion_action_id": conversion_action_id,
    "conversion_date_time": conversion_date_time,
    "conversion_value": conversion_value,
    "currency_code": "USD",
    "ad_user_data_consent": ad_user_data_consent,
}

# Constructs the click conversion.
click_conversion = client.get_type("ClickConversion")
# Creates a user identifier using the hashed email address, using the
# normalize and hash method specifically for email addresses.
email_identifier = client.get_type("UserIdentifier")
# Optional: Specifies the user identifier source.
email_identifier.user_identifier_source = (
    client.enums.UserIdentifierSourceEnum.FIRST_PARTY
)
# Uses the normalize and hash method specifically for email addresses.
email_identifier.hashed_email = normalize_and_hash_email_address(
    raw_record["email"]
)
# Adds the user identifier to the conversion.
click_conversion.user_identifiers.append(email_identifier)

# Checks if the record has a phone number, and if so, adds a UserIdentifier
# for it.
if raw_record.get("phone") is not None:
    phone_identifier = client.get_type("UserIdentifier")
    phone_identifier.hashed_phone_number = normalize_and_hash(
        raw_record["phone"]
    )
    # Adds the phone identifier to the conversion adjustment.
    click_conversion.user_identifiers.append(phone_identifier)
      

Ruby

# Extract user email and phone from the raw data, normalize and hash it,
# then wrap it in UserIdentifier objects. Create a separate UserIdentifier
# object for each. The data in this example is hardcoded, but in your
# application you might read the raw data from an input file.

# IMPORTANT: Since the identifier attribute of UserIdentifier
# (https://developers.google.com/google-ads/api/reference/rpc/latest/UserIdentifier)
# is a oneof
# (https://protobuf.dev/programming-guides/proto3/#oneof-features), you must
# set only ONE of hashed_email, hashed_phone_number, mobile_id,
# third_party_user_id, or address_info. Setting more than one of these
# attributes on the same UserIdentifier will clear all the other members of
# the oneof. For example, the following code is INCORRECT and will result in
# a UserIdentifier with ONLY a hashed_phone_number:
#
# incorrectly_populated_user_identifier.hashed_email = "...""
# incorrectly_populated_user_identifier.hashed_phone_number = "...""

raw_record = {
  # Email address that includes a period (.) before the Gmail domain.
  "email" => "alex.2@example.com",
  # Phone number to be converted to E.164 format, with a leading '+' as
  # required.
  "phone" => "+1 800 5550102",
  # This example lets you input conversion details as arguments,
  # but in reality you might store this data alongside other user data,
  # so we include it in this sample user record.
  "order_id" => order_id,
  "gclid" => gclid,
  "conversion_action_id" => conversion_action_id,
  "conversion_date_time" => conversion_date_time,
  "conversion_value" => conversion_value,
  "currency_code" => "USD",
  "ad_user_data_consent" => ad_user_data_consent,
  "session_attributes_encoded" => session_attributes_encoded,
  "session_attributes_hash" => session_attributes_hash
}

click_conversion = client.resource.click_conversion do |cc|
  cc.conversion_action = client.path.conversion_action(customer_id, conversion_action_id)
  cc.conversion_date_time = conversion_date_time
  cc.conversion_value = conversion_value.to_f
  cc.currency_code = 'USD'

  unless order_id.nil?
    cc.order_id = order_id
  end

  unless raw_record["gclid"].nil?
    cc.gclid = gclid
  end

  # Specifies whether user consent was obtained for the data you are
  # uploading. For more details, see:
  # https://www.google.com/about/company/user-consent-policy
  unless raw_record["ad_user_data_consent"].nil?
    cc.consent = client.resource.consent do |c|
      c.ad_user_data = ad_user_data_consent
    end
  end

  # Set one of the session_attributes_encoded or
  # session_attributes_key_value_pairs fields if either are provided.
  if session_attributes_encoded != nil
    cc.class.module_eval { attr_accessor :session_attributes_encoded}
    cc.session_attributes_encoded = session_attributes_encoded
  elsif session_attributes_hash != nil
    # Add new attribute to click conversion object
    cc.class.module_eval { attr_accessor :session_attributes_key_value_pairs}
    cc.session_attributes_key_value_pairs = ::Google::Ads::GoogleAds::V19::Services::SessionAttributesKeyValuePairs.new

    # Loop thru inputted session_attributes_hash to populate session_attributes_key_value_pairs
    session_attributes_hash.each do |key, value|
      pair = ::Google::Ads::GoogleAds::V19::Services::SessionAttributeKeyValuePair.new
      pair.session_attribute_key = key
      pair.session_attribute_value = value
      cc.session_attributes_key_value_pairs.key_value_pairs << pair
    end
  end    

  # Creates a user identifier using the hashed email address, using the
  # normalize and hash method specifically for email addresses.
  # If using a phone number, use the normalize_and_hash method instead.
  cc.user_identifiers << client.resource.user_identifier do |ui|
    ui.hashed_email = normalize_and_hash_email(raw_record["email"])
    # Optional: Specifies the user identifier source.
    ui.user_identifier_source = :FIRST_PARTY
  end

  # Checks if the record has a phone number, and if so, adds a UserIdentifier
  # for it.
  unless raw_record["phone"].nil?
    cc.user_identifiers << client.resource.user_identifier do |ui|
      ui.hashed_phone_number = normalize_and_hash(raw_record["phone"])
    end
  end
end
      

Perl

# Create an empty click conversion.
my $click_conversion =
  Google::Ads::GoogleAds::V20::Services::ConversionUploadService::ClickConversion
  ->new({});

# Extract user email and phone from the raw data, normalize and hash it,
# then wrap it in UserIdentifier objects. Create a separate UserIdentifier
# object for each.
# The data in this example is hardcoded, but in your application
# you might read the raw data from an input file.
#
# IMPORTANT: Since the identifier attribute of UserIdentifier
# (https://developers.google.com/google-ads/api/reference/rpc/latest/UserIdentifier)
# is a oneof
# (https://protobuf.dev/programming-guides/proto3/#oneof-features), you must set
# only ONE of hashed_email, hashed_phone_number, mobile_id, third_party_user_id,
# or address-info. Setting more than one of these attributes on the same UserIdentifier
# will clear all the other members of the oneof. For example, the following code is
# INCORRECT and will result in a UserIdentifier with ONLY a hashed_phone_number:
#
# my $incorrect_user_identifier = Google::Ads::GoogleAds::V20::Common::UserIdentifier->new({
#   hashedEmail => '...',
#   hashedPhoneNumber => '...',
# });
my $raw_record = {
  # Email address that includes a period (.) before the Gmail domain.
  email => 'alex.2@example.com',
  # Phone number to be converted to E.164 format, with a leading '+' as
  # required.
  phone => '+1 800 5550102',
  # This example lets you input conversion details as arguments,
  # but in reality you might store this data alongside other user data,
  # so we include it in this sample user record.
  orderId            => $order_id,
  gclid              => $gclid,
  conversionActionId => $conversion_action_id,
  conversionDateTime => $conversion_date_time,
  conversionValue    => $conversion_value,
  currencyCode       => "USD",
  adUserDataConsent  => $ad_user_data_consent
};
my $user_identifiers = [];

# Create a user identifier using the hashed email address, using the normalize
# and hash method specifically for email addresses.
my $hashed_email = normalize_and_hash_email_address($raw_record->{email});
push(
  @$user_identifiers,
  Google::Ads::GoogleAds::V20::Common::UserIdentifier->new({
      hashedEmail => $hashed_email,
      # Optional: Specify the user identifier source.
      userIdentifierSource => FIRST_PARTY
    }));

# Create a user identifier using normalized and hashed phone info.
my $hashed_phone = normalize_and_hash($raw_record->{phone});
push(
  @$user_identifiers,
  Google::Ads::GoogleAds::V20::Common::UserIdentifier->new({
      hashedPhone => $hashed_phone,
      # Optional: Specify the user identifier source.
      userIdentifierSource => FIRST_PARTY
    }));

# Add the user identifiers to the conversion.
$click_conversion->{userIdentifiers} = $user_identifiers;
      

בדוגמה הזו מוצג איך מגדירים שדות נדרשים אחרים באובייקט ClickConversion.

Java

// Adds details of the conversion.
clickConversionBuilder.setConversionAction(
    ResourceNames.conversionAction(
        customerId, Long.parseLong(rawRecord.get("conversionActionId"))));
clickConversionBuilder.setConversionDateTime(rawRecord.get("conversionDateTime"));
clickConversionBuilder.setConversionValue(Double.parseDouble(rawRecord.get("conversionValue")));
clickConversionBuilder.setCurrencyCode(rawRecord.get("currencyCode"));

// Sets the order ID if provided.
if (rawRecord.containsKey("orderId")) {
  clickConversionBuilder.setOrderId(rawRecord.get("orderId"));
}

// Sets the Google click ID (gclid) if provided.
if (rawRecord.containsKey("gclid")) {
  clickConversionBuilder.setGclid(rawRecord.get("gclid"));
}

// Sets the consent information, if provided.
if (rawRecord.containsKey("adUserDataConsent")) {
  // Specifies whether user consent was obtained for the data you are uploading. See
  // https://www.google.com/about/company/user-consent-policy for details.
  clickConversionBuilder.setConsent(
      Consent.newBuilder()
          .setAdUserData(ConsentStatus.valueOf(rawRecord.get("adUserDataConsent"))));
}

// Sets one of the sessionAttributesEncoded or sessionAttributesKeyValuePairs if either is
// provided.
if (rawRecord.containsKey("sessionAttributesEncoded")) {
  clickConversionBuilder.setSessionAttributesEncoded(
      ByteString.copyFromUtf8(rawRecord.get("sessionAttributesEncoded")));
} else if (rawRecord.containsKey("sessionAttributesMap")) {
  List<String> pairings =
      Arrays.stream(rawRecord.get("sessionAttributesMap").split(" "))
          .map(String::trim)
          .collect(Collectors.toList());
  SessionAttributesKeyValuePairs.Builder sessionAttributePairs =
      SessionAttributesKeyValuePairs.newBuilder();
  for (String pair : pairings) {
    String[] parts = pair.split("=", 2);
    if (parts.length != 2) {
      throw new IllegalArgumentException(
          "Failed to read the sessionAttributesMap. SessionAttributesMap must use a "
              + "space-delimited list of session attribute key value pairs. Each pair should be"
              + " separated by an equal sign, for example: 'gad_campaignid=12345 gad_source=1'");
    }
    sessionAttributePairs.addKeyValuePairs(
        SessionAttributeKeyValuePair.newBuilder()
            .setSessionAttributeKey(parts[0])
            .setSessionAttributeValue(parts[1])
            .build());
  }
  clickConversionBuilder.setSessionAttributesKeyValuePairs(sessionAttributePairs.build());
}

// Calls build to build the conversion.
ClickConversion clickConversion = clickConversionBuilder.build();
      

C#‎

// Adds details of the conversion.
clickConversion.ConversionAction =
    ResourceNames.ConversionAction(customerId, conversionActionId);
clickConversion.ConversionDateTime = conversionDateTime;
clickConversion.ConversionValue = conversionValue;
clickConversion.CurrencyCode = "USD";

// Sets the order ID if provided.
if (!string.IsNullOrEmpty(orderId))
{
    clickConversion.OrderId = orderId;
}

// Sets the Google click ID (gclid) if provided.
if (!string.IsNullOrEmpty(gclid))
{
    clickConversion.Gclid = gclid;
}

if (!string.IsNullOrEmpty(sessionAttributesEncoded))
{
    clickConversion.SessionAttributesEncoded =
        ByteString.CopyFrom(sessionAttributesEncoded, Encoding.Unicode);
}
else if (!string.IsNullOrEmpty(sessionAttributes))
{
    IEnumerable<SessionAttributeKeyValuePair> parsedSessionAttributes =
        sessionAttributes.Split(';').Select(pair => {
            string[] split = pair.Split('=');
            return new SessionAttributeKeyValuePair()
            {
                SessionAttributeKey = split[0],
                SessionAttributeValue = split[1]
            };
        });

    clickConversion.SessionAttributesKeyValuePairs =
        new SessionAttributesKeyValuePairs();
    clickConversion.SessionAttributesKeyValuePairs.KeyValuePairs
        .AddRange(parsedSessionAttributes);
}

      

PHP

// Adds details of the conversion.
$clickConversion->setConversionAction(
    ResourceNames::forConversionAction($customerId, $rawRecord['conversionActionId'])
);
$clickConversion->setConversionDateTime($rawRecord['conversionDateTime']);
$clickConversion->setConversionValue($rawRecord['conversionValue']);
$clickConversion->setCurrencyCode($rawRecord['currencyCode']);

// Sets the order ID if provided.
if (!empty($rawRecord['orderId'])) {
    $clickConversion->setOrderId($rawRecord['orderId']);
}

// Sets the Google click ID (gclid) if provided.
if (!empty($rawRecord['gclid'])) {
    $clickConversion->setGclid($rawRecord['gclid']);
}

// Sets the ad user data consent if provided.
if (!empty($rawRecord['adUserDataConsent'])) {
    // Specifies whether user consent was obtained for the data you are uploading. See
    // https://www.google.com/about/company/user-consent-policy for details.
    $clickConversion->setConsent(
        new Consent(['ad_user_data' => $rawRecord['adUserDataConsent']])
    );
}

// Set one of the sessionAttributesEncoded or
// SessionAttributeKeyValuePair fields if either are provided.
if (!empty($sessionAttributesEncoded)) {
    $clickConversion->setSessionAttributesEncoded($sessionAttributesEncoded);
} elseif (!empty($sessionAttributesDict)) {
    // Create a new container object to hold key-value pairs.
    $sessionAttributesKeyValuePairs = new SessionAttributesKeyValuePairs();
    // Initialize an array to hold individual key-value pair messages.
    $keyValuePairs = [];
    // Append each key-value pair provided to the $keyValuePairs array
    foreach ($sessionAttributesDict as $key => $value) {
        $pair = new SessionAttributeKeyValuePair();
        $pair->setSessionAttributeKey($key);
        $pair->setSessionAttributeValue($value);
        $keyValuePairs[] = $pair;
    }
    // Set the the full list of key-value pairs on the container object.
    $sessionAttributesKeyValuePairs->setKeyValuePairs($keyValuePairs);
    // Attach the container of key-value pairs to the ClickConversion object.
    $clickConversion->setSessionAttributesKeyValuePairs($sessionAttributesKeyValuePairs);
}
      

Python

# Add details of the conversion.
# Gets the conversion action resource name.
conversion_action_service = client.get_service("ConversionActionService")
click_conversion.conversion_action = (
    conversion_action_service.conversion_action_path(
        customer_id, raw_record["conversion_action_id"]
    )
)
click_conversion.conversion_date_time = raw_record["conversion_date_time"]
click_conversion.conversion_value = raw_record["conversion_value"]
click_conversion.currency_code = raw_record["currency_code"]

# Sets the order ID if provided.
if raw_record.get("order_id"):
    click_conversion.order_id = raw_record["order_id"]

# Sets the gclid if provided.
if raw_record.get("gclid"):
    click_conversion.gclid = raw_record["gclid"]

# Specifies whether user consent was obtained for the data you are
# uploading. For more details, see:
# https://www.google.com/about/company/user-consent-policy
if raw_record["ad_user_data_consent"]:
    click_conversion.consent.ad_user_data = client.enums.ConsentStatusEnum[
        raw_record["ad_user_data_consent"]
    ]

# Set one of the session_attributes_encoded or
# session_attributes_key_value_pairs fields if either are provided.
if session_attributes_encoded:
    click_conversion.session_attributes_encoded = session_attributes_encoded
elif session_attributes_dict:
    for key, value in session_attributes_dict.items():
        pair = client.get_type("SessionAttributeKeyValuePair")
        pair.session_attribute_key = key
        pair.session_attribute_value = value
        click_conversion.session_attributes_key_value_pairs.key_value_pairs.append(
            pair
        )
      

Ruby

cc.conversion_action = client.path.conversion_action(customer_id, conversion_action_id)
cc.conversion_date_time = conversion_date_time
cc.conversion_value = conversion_value.to_f
cc.currency_code = 'USD'

unless order_id.nil?
  cc.order_id = order_id
end

unless raw_record["gclid"].nil?
  cc.gclid = gclid
end

# Specifies whether user consent was obtained for the data you are
# uploading. For more details, see:
# https://www.google.com/about/company/user-consent-policy
unless raw_record["ad_user_data_consent"].nil?
  cc.consent = client.resource.consent do |c|
    c.ad_user_data = ad_user_data_consent
  end
end

# Set one of the session_attributes_encoded or
# session_attributes_key_value_pairs fields if either are provided.
if session_attributes_encoded != nil
  cc.class.module_eval { attr_accessor :session_attributes_encoded}
  cc.session_attributes_encoded = session_attributes_encoded
elsif session_attributes_hash != nil
  # Add new attribute to click conversion object
  cc.class.module_eval { attr_accessor :session_attributes_key_value_pairs}
  cc.session_attributes_key_value_pairs = ::Google::Ads::GoogleAds::V19::Services::SessionAttributesKeyValuePairs.new

  # Loop thru inputted session_attributes_hash to populate session_attributes_key_value_pairs
  session_attributes_hash.each do |key, value|
    pair = ::Google::Ads::GoogleAds::V19::Services::SessionAttributeKeyValuePair.new
    pair.session_attribute_key = key
    pair.session_attribute_value = value
    cc.session_attributes_key_value_pairs.key_value_pairs << pair
  end
end    
      

Perl

# Add details of the conversion.
$click_conversion->{conversionAction} =
  Google::Ads::GoogleAds::V20::Utils::ResourceNames::conversion_action(
  $customer_id, $raw_record->{conversionActionId});
$click_conversion->{conversionDateTime} = $raw_record->{conversionDateTime};
$click_conversion->{conversionValue}    = $raw_record->{conversionValue};
$click_conversion->{currencyCode}       = $raw_record->{currencyCode};

# Set the order ID if provided.
if (defined $raw_record->{orderId}) {
  $click_conversion->{orderId} = $raw_record->{orderId};
}

# Set the Google click ID (gclid) if provided.
if (defined $raw_record->{gclid}) {
  $click_conversion->{gclid} = $raw_record->{gclid};
}

# Set the consent information, if provided.
if (defined $raw_record->{adUserDataConsent}) {
  $click_conversion->{consent} =
    Google::Ads::GoogleAds::V20::Common::Consent->new({
      adUserData => $raw_record->{adUserDataConsent}});
}

# Set one of the session_attributes_encoded or session_attributes_key_value_pairs
# fields if either are provided.
if (defined $session_attributes_encoded) {
  $click_conversion->{sessionAttributesEncoded} = $session_attributes_encoded;
} elsif (defined $session_attributes_hash) {
  while (my ($key, $value) = each %$session_attributes_hash) {
    my $pair =
      Google::Ads::GoogleAds::V20::Services::ConversionUploadService::SessionAttributeKeyValuePair
      ->new({sessionAttributeKey => $key, sessionAttributeValue => $value});
    push @{$click_conversion->{sessionAttributesKeyValuePairs}{keyValuePairs}
    }, $pair;
  }
}
      

יצירת הבקשה

אחרי שמגדירים את אובייקטי ClickConversion ומוסיפים אותם לשדה conversions של אובייקט UploadClickConversionRequest, מגדירים את השדות הבאים ומעבירים את הבקשה לשיטה UploadClickConversions באובייקט ConversionUploadService.

customer_id
מגדירים את הערך הזה ללקוח ההמרה ב-Google Ads של החשבון שממנו מגיעים הקליקים. אם אתם לא בטוחים איזה חשבון הוא הנכון, תוכלו לעיין בשדה customer.conversion_tracking_setting.google_ads_conversion_customerבדוגמה של השאילתה בקטע תחילת העבודה .
job_id

מספקת מנגנון לשיוך בקשות הייבוא למידע על כל משימה בנפרד באבחון של נתונים ממקורות אופליין.

אם לא מגדירים את השדה הזה, Google Ads API מקצה לכל בקשה ערך ייחודי בטווח של [2^31, 2^63). אם אתם מעדיפים לקבץ כמה בקשות למשימה לוגית אחת, צריך להגדיר את השדה הזה לאותו ערך בטווח [0, 2^31) בכל בקשה במשימה.

השדה job_id בתגובה מכיל את מזהה המשימה של הבקשה, בין אם ציינתם ערך ובין אם לא.

partial_failure

כשמייבאים המרות, צריך להגדיר את השדה הזה לערך true. כשמעבדים את התגובה, צריך לפעול לפי ההנחיות בנושא כשלים חלקיים.

ייבוא הבקשה

אחרי שתמלאו את האובייקטים של ClickConversion ותבנו את הבקשה, תוכלו לשלוח את הייבוא.

Java

// Creates the conversion upload service client.
try (ConversionUploadServiceClient conversionUploadServiceClient =
    googleAdsClient.getLatestVersion().createConversionUploadServiceClient()) {
  // Uploads the click conversion. Partial failure should always be set to true.

  // NOTE: This request contains a single conversion as a demonstration.  However, if you have
  // multiple conversions to upload, it's best to upload multiple conversions per request
  // instead of sending a separate request per conversion. See the following for per-request
  // limits:
  // https://developers.google.com/google-ads/api/docs/best-practices/quotas#conversion_upload_service
  UploadClickConversionsResponse response =
      conversionUploadServiceClient.uploadClickConversions(
          UploadClickConversionsRequest.newBuilder()
              .setCustomerId(Long.toString(customerId))
              .addConversions(clickConversion)
              // Enables partial failure (must be true).
              .setPartialFailure(true)
              .build());
      

C#‎

// Uploads the click conversion. Partial failure should always be set to true.
// NOTE: This request contains a single conversion as a demonstration.
// However, if you have multiple conversions to upload, it's best to upload multiple
// conversions per request instead of sending a separate request per conversion.
// See the following for per-request limits:
// https://developers.google.com/google-ads/api/docs/best-practices/quotas#conversion_upload
UploadClickConversionsResponse response =
    conversionUploadService.UploadClickConversions(
        new UploadClickConversionsRequest()
        {
            CustomerId = customerId.ToString(),
            Conversions = { clickConversion },
            // Enables partial failure (must be true).
            PartialFailure = true
        });

      

PHP

// Issues a request to upload the click conversion.
$conversionUploadServiceClient = $googleAdsClient->getConversionUploadServiceClient();
// NOTE: This request contains a single conversion as a demonstration.  However, if you have
// multiple conversions to upload, it's best to upload multiple conversions per request
// instead of sending a separate request per conversion. See the following for per-request
// limits:
// https://developers.google.com/google-ads/api/docs/best-practices/quotas#conversion_upload_service
$response = $conversionUploadServiceClient->uploadClickConversions(
    // Enables partial failure (must be true).
    UploadClickConversionsRequest::build($customerId, [$clickConversion], true)
);
      

Python

# Creates the conversion upload service client.
conversion_upload_service = client.get_service("ConversionUploadService")
# Uploads the click conversion. Partial failure should always be set to
# True.
# NOTE: This request only uploads a single conversion, but if you have
# multiple conversions to upload, it's most efficient to upload them in a
# single request. See the following for per-request limits for reference:
# https://developers.google.com/google-ads/api/docs/best-practices/quotas#conversion_upload_service
response = conversion_upload_service.upload_click_conversions(
    customer_id=customer_id,
    conversions=[click_conversion],
    # Enables partial failure (must be true).
    partial_failure=True,
)
      

Ruby

response = client.service.conversion_upload.upload_click_conversions(
  customer_id: customer_id,
  conversions: [click_conversion],
  # Partial failure must be true.
  partial_failure: true,
)

if response.partial_failure_error
  puts "Partial failure encountered: #{response.partial_failure_error.message}"
else
  result = response.results.first
  puts "Uploaded click conversion that happened at #{result.conversion_date_time} " \
    "to #{result.conversion_action}."
end
      

Perl

# Upload the click conversion. Partial failure should always be set to true.
#
# NOTE: This request contains a single conversion as a demonstration.
# However, if you have multiple conversions to upload, it's best to
# upload multiple conversions per request instead of sending a separate
# request per conversion. See the following for per-request limits:
# https://developers.google.com/google-ads/api/docs/best-practices/quotas#conversion_upload_service
my $response =
  $api_client->ConversionUploadService()->upload_click_conversions({
    customerId  => $customer_id,
    conversions => [$click_conversion],
    # Enable partial failure (must be true).
    partialFailure => "true"
  });
      

בדיקת הייבוא

מומלץ להשתמש בדוח האבחון של המרות משופרות לצורך שיוך ללידים כדי לבדוק את התקינות הכוללת של הייבוא האחרון.

ההמרות המיובאות משתקפות בדוחות לפי תאריך החשיפה שלהקליק המקורי, ולא לפי תאריך בקשת הייבוא או תאריך conversion_date_time של ClickConversion.

יכול להיות שיעברו עד שלוש שעות עד שהנתונים הסטטיסטיים של ההמרות המיובאות יופיעו בחשבון Google Ads שלכם כשמדובר בשיוך (Attribution) של המרות לפי קליק אחרון. במודלים אחרים של שיוך בחיפוש, יכול להיות שיעברו יותר משלוש שעות. מידע נוסף זמין במדריך בנושא עדכניות הנתונים.

כשמדווחים על מדדי המרות בקמפיינים, כדאי לעיין במאמר מיפוי מדדים בממשק המשתמש כדי להשוות בין מדדים בממשק המשתמש של Google Ads לבין שדות דיווח ב-Google Ads API. אפשר גם לשלוח שאילתה למשאב conversion_action כדי לראות את המספר הכולל של ההמרות ואת ערך ההמרה הכולל של פעולת המרה נתונה.

שיטות מומלצות

ריכזנו כאן כמה שיטות מומלצות להטמעה של המרות משופרות ללידים.

שליחת כל נתוני ההמרות, בלי קשר לשלמות שלהם

כדי שהדוחות על ההמרות יהיו מלאים ומדויקים, חשוב לייבא את כל אירועי ההמרות אופליין, כולל אלה שלא בהכרח הגיעו מ-Google Ads. המרות שכוללות רק פרטים שהמשתמשים סיפקו עדיין שימושיות ויכולות לתרום באופן חיובי לאופטימיזציה של קמפיינים ב-Google Ads.

אם אתם מקצים order_id להמרה, מומלץ לכלול אותו. אם יש לכם GCLID של המרה, מומלץ לשלוח אותו בנוסף לuser_identifiers כדי לשפר את הביצועים. בנוסף, אם יש לכם יותר מ-UserIdentifier להמרה, כדאי לכלול את כולם באובייקט ClickConversion כדי להגדיל את הסיכוי להתאמה.

צירוף של כמה המרות לבקשה אחת

אם יש לכם כמה המרות לייבא, כדאי לאגד את ההמרות בקובץ UploadClickConversionsRequest אחד, במקום לשלוח בקשת ייבוא לכל המרה.

במדריך המכסות אפשר לראות את המגבלות על מספר ההמרות לכל בקשה.

אם רוצים שכלי האבחון של נתונים אופליין יקבץ קבוצה של בקשות תחת אותה משימה לוגית, צריך להגדיר את job_id של כל הבקשות לאותו ערך. האפשרות הזו יכולה להיות שימושית אם יש לכם עבודה או תהליך יחידים שמייבאים מספר גדול של המרות באמצעות כמה בקשות. אם מגדירים את job_id בכל אחת מהבקשות האלה לאותו ערך, אפשר לאחזר רשומה אחת של העבודה מ-job_summaries. לעומת זאת, אם תאפשרו ל-Google Ads API להקצות ערך שנוצר על ידי המערכת ל-job_id של כל בקשה, job_summaries יכיל רשומה נפרדת לכל בקשה, מה שיקשה על ניתוח המצב הכללי של העבודה.

לא להשתמש בנתוני שיוך (Attribution) חיצוניים

כשמשתמשים בהמרות משופרות לצורך שיוך ללידים, לא מגדירים את external_attribution_data ב-ClickConversion ולא מציינים conversion_action שמשתמש במודל שיוך חיצוני. מערכת Google Ads לא תומכת בהמרות שמשויכות למקורות חיצוניים כשמייבאים נתונים שהמשתמשים סיפקו.

לא לכלול משתנים מותאמים אישית

כשמשתמשים בהמרות משופרות לצורך שיוך ללידים, לא כוללים custom_variables. מערכת Google Ads לא תומכת בשימוש במשתנים מותאמים אישית עם פרטים שהמשתמשים סיפקו בייבוא המרות. אם משתנים מותאמים אישית נכללים בהמרות שמכילות פרטים שהמשתמשים סיפקו, ההמרות האלה ייחשבו כלא תקפות והמערכת תבטל אותן.

פתרון בעיות

אבחון של נתונים ממקורות אופליין מספק מקור יחיד לבדיקה שוטפת של תקינות הייבוא. עם זאת, במהלך ההטמעה אפשר להשתמש במידע שבקטע הזה כדי לחקור שגיאות שדווחו בשדה partial_failure_error של התשובה.

כמה מהשגיאות הנפוצות ביותר בייבוא פעולות המרה הן שגיאות הרשאה, כמו USER_PERMISSION_DENIED. חשוב לוודא שמזהה הלקוח בבקשה מוגדר ללקוח ההמרה ב-Google Ads שמשויך לפעולת ההמרה. פרטים נוספים זמינים במדריך ההרשאה, ובמדריך השגיאות הנפוצות מופיעים טיפים לניפוי באגים של השגיאות השונות.

ניפוי באגים בשגיאות נפוצות

שגיאה
NO_CONVERSION_ACTION_FOUND

פעולת ההמרה שצוינה לא מופעלת, או שאין לחשבון הלקוח שצוין בשדה client_id בבקשה גישה אליה. חשוב לוודא שפעולת ההמרה בהעלאה מופעלת ושייכת ללקוח ששולח את בקשת ההעלאה.

השגיאה הזו יכולה להופיע גם אם ערך ה-GCLID בבקשה שייך לחשבון לקוח שאין לו גישה לפעולת ההמרה שצוינה בבקשה. כדי לבדוק אם GCLID שייך לחשבון לקוח, אפשר להשתמש במשאב click_view. לשם כך, שולחים שאילתה עם מסננים לפי click_view.gclid ו-segments.date, כאשר התאריך הוא התאריך שבו התרחש הקליק.

INVALID_CONVERSION_ACTION_TYPE סוג פעולת ההמרה שצוין לא תקין להמרות משופרות לצורך שיוך ללידים. חשוב לוודא שהסוג של ConversionAction שצוין בבקשת ההעלאה הוא UPLOAD_CLICKS.
CUSTOMER_NOT_ENABLED_ENHANCED_CONVERSIONS_FOR_LEADS צריך לוודא שהפעלתם המרות משופרות לצורך שיוך ללידים בהגדרות ההמרה. הוראות בנושא מופיעות במדריך דרישות מוקדמות.
DUPLICATE_ORDER_ID האירועים שיובאו כוללים מספר המרות עם אותו מזהה הזמנה, ולא עובדו. צריך לוודא שמזהי ההזמנות ייחודיים ולנסות שוב.
CLICK_NOT_FOUND לא נמצא קליק שתואם למזהי המשתמש שסופקו. ‫Google Ads API מחזיר את השגיאה הזו רק אם הערך של debug_enabled הוא true בUploadClickConversionsRequest.

אם המרה מסוימת מעוררת את האזהרה הזו, היא תיכלל ב-successful_event_count של אבחון נתוני האופליין ב-Google Ads API. ‫Google Ads API כולל רשומה של CLICK_NOT_FOUND באוסף alerts, כך שאפשר לעקוב אחרי התדירות של האזהרה הזו.

השגיאה הזו צפויה אם הקליק לא הגיע מקמפיין של Google Ads. לדוגמה, יכול להיות שהערך הגיע מ-SA360 או מ-DV360. סיבות אפשריות נוספות:

במקרים נדירים שבהם הלקוח המעלה שונה מהלקוח שהמיר ב-Google Ads, השגיאה הזו יכולה להצביע על כך שהלקוח המעלה אישר את התנאים בנוגע לנתוני לקוחות, אבל הלקוח שהמיר לא אישר אותם.

כדי לבדוק אם בחשבון מסוים אושרו התנאים בנוגע לנתוני לקוחות, שולחים שאילתה למשאב customer ובודקים את השדה customer.offline_conversion_tracking_info.accepted_customer_data_terms.