Skip to content

Fix email/phone normalization and typos in enhanced conversions examples #1104

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pattersonlois wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix email/phone normalization and typos in enhanced conversions examples #1104

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 19 additions & 16 deletions examples/remarketing/upload_enhanced_conversions_for_leads.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,11 +99,11 @@ def main(
# 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 = "...""
# incorrectly_populated_user_identifier.hashed_email = "..."
# incorrectly_populated_user_identifier.hashed_phone_number = "..."

raw_record: Dict[str, Union[str, float]] = {
# Email address that includes a period (.) before the Gmail domain.
# Email address that includes a period (.) before the email domain.
"email": "alex.2@example.com",
# Phone number to be converted to E.164 format, with a leading '+' as
# required.
Expand Down Expand Up @@ -143,7 +143,7 @@ def main(
phone_identifier.hashed_phone_number = normalize_and_hash(
raw_record["phone"]
)
# Adds the phone identifier to the conversion adjustment.
# Adds the phone identifier to the conversion.
click_conversion.user_identifiers.append(phone_identifier)
# [END add_user_identifiers]

Expand Down Expand Up @@ -242,25 +242,28 @@ def normalize_and_hash_email_address(email_address: str) -> str:
"""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"
and '+' suffixes 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.
A normalized (lowercase, removed whitespace) and SHA-256 hashed string.
"""
normalized_email: str = email_address.strip().lower()
email_parts: list[str] = normalized_email.split("@")

# Check that there are at least two segments
if len(email_parts) > 1:
# Removes any '.' and '+' characters from the portion of the email address
# before the domain
chars_to_remove = ".+"
translation_table = str.maketrans("", "", chars_to_remove)
email_parts[0] = email_parts[0].translate(translation_table)
normalized_email = "@".join(email_parts)
# 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 and any '+' suffix from the portion of
# the email address before the domain.
email_parts[0] = email_parts[0].replace(".", "")
email_parts[0] = re.sub(r"\+.*$", "", email_parts[0])
normalized_email = "@".join(email_parts)

return normalize_and_hash(normalized_email)

Expand All @@ -277,7 +280,7 @@ def normalize_and_hash(s: str) -> str:
Returns:
A normalized (lowercase, removed whitespace) and SHA-256 hashed string.
"""
return hashlib.sha256(s.strip().lower().encode()).hexdigest()
return hashlib.sha256(re.sub(r"\s+", "", s).lower().encode()).hexdigest()
# [END normalize_and_hash]


Expand All @@ -289,8 +292,8 @@ def normalize_and_hash(s: str) -> str:
)

parser: argparse.ArgumentParser = argparse.ArgumentParser(
description="Imports offline call conversion values for calls related "
"to your ads."
description="Uploads an enhanced conversion for leads by uploading a "
"ClickConversion."
)
# The following argument(s) should be provided to run the example.
parser.add_argument(
Expand Down Expand Up @@ -398,7 +401,7 @@ def normalize_and_hash(s: str) -> str:
)
except GoogleAdsException as ex:
print(
f"Request with ID '{ex.request_id}'' failed with status "
f"Request with ID '{ex.request_id}' failed with status "
f"'{ex.error.code().name}' and includes the following errors:"
)
for error in ex.failure.errors:
Expand Down
37 changes: 20 additions & 17 deletions examples/remarketing/upload_enhanced_conversions_for_web.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,11 +61,11 @@ def main(
# 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 = "...""
# 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 address that includes a period (.) before the email domain.
"email": "alex.2@example.com",
# Address that includes all four required elements: first name, last
# name, country code, and postal code.
Expand Down Expand Up @@ -129,7 +129,7 @@ def main(
]
if len(missing_keys) > 0:
print(
"Skipping addition of mailing address information because the"
"Skipping addition of mailing address information because the "
f"following required keys are missing: {missing_keys}"
)
else:
Expand Down Expand Up @@ -210,7 +210,7 @@ def main(
result = response.results[0]
print(
f"Uploaded conversion adjustment of {result.conversion_action} for "
f"order ID {result,order_id}."
f"order ID {result.order_id}."
)


Expand All @@ -219,25 +219,28 @@ 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"
and '+' suffixes 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.
A normalized (lowercase, removed whitespace) and SHA-256 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:
# Removes any '.' and '+' characters from the portion of the email address
# before the domain
chars_to_remove = ".+"
translation_table = str.maketrans("", "", chars_to_remove)
email_parts[0] = email_parts[0].translate(translation_table)
normalized_email = "@".join(email_parts)
# 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 and any '+' suffix from the portion of
# the email address before the domain.
email_parts[0] = email_parts[0].replace(".", "")
email_parts[0] = re.sub(r"\+.*$", "", email_parts[0])
normalized_email = "@".join(email_parts)

return normalize_and_hash(normalized_email)

Expand All @@ -254,14 +257,14 @@ def normalize_and_hash(s):
Returns:
A normalized (lowercase, removed whitespace) and SHA-256 hashed string.
"""
return hashlib.sha256(s.strip().lower().encode()).hexdigest()
return hashlib.sha256(re.sub(r"\s+", "", s).lower().encode()).hexdigest()
# [END normalize_and_hash]


if __name__ == "__main__":
parser = argparse.ArgumentParser(
description="Imports offline call conversion values for calls related "
"to your ads."
description="Enhances a web conversion by uploading a "
"ConversionAdjustment."
)
# The following argument(s) should be provided to run the example.
parser.add_argument(
Expand Down Expand Up @@ -318,7 +321,7 @@ def normalize_and_hash(s):
)
except GoogleAdsException as ex:
print(
f"Request with ID '{ex.request_id}'' failed with status "
f"Request with ID '{ex.request_id}' failed with status "
f"'{ex.error.code().name}' and includes the following errors:"
)
for error in ex.failure.errors:
Expand Down
Loading