A API de conversão off-line do CM360 é compatível com o aprimoramento de conversões baseadas em tag do site com identificadores de usuário.
Configuração recomendada
- Aceite os Termos de Serviço das conversões otimizadas referentes à sua configuração do Floodlight no CM360.
- Instrua seus sites com um ID de correspondência.
- Registre as conversões do Floodlight que ocorrem no seu site. Registre
todas as informações a seguir, porque elas são campos obrigatórios nas próximas chamadas de API:
matchId
ordinal
timestampMicros
floodlightActivityId
floodlightConfigurationId
quantity
value
- Depois de 90 minutos desde que a tag on-line capturou a conversão, chame
conversions.batchupdate
para aprimorar essas conversões com identificadores de usuário.- Os identificadores de usuários precisam ser formatados e criptografados com hash e adicionados ao campo
userIdentifiers
nos objetos de conversão. - A quantidade e o valor precisam ser especificados.
Também é possível ajustar a quantidade e o valor da conversão na
mesma chamada
conversions.batchupdate
ou fornecer a quantidade e o valor originais. - Cada lote de inserções e atualizações pode conter uma mistura de sucessos e
falhas. As falhas de
NOT_FOUND
precisam ser repetidas caso haja um atraso maior que o normal no processamento de conversão, de até seis horas. - As conversões precisam ser otimizadas com identificadores de usuários até 24 horas após serem capturadas pelas tags on-line.
- Os identificadores de usuários precisam ser formatados e criptografados com hash e adicionados ao campo
Normalização e hash
Para proteger a privacidade, endereços de e-mail, números de telefone, nomes, sobrenomes e endereços precisam ser criptografados com hash usando o algoritmo SHA-256 antes do upload. Para padronizar os resultados do hash, antes de aplicar hash a um desses valores, você precisa:
- Remover os espaços em branco à esquerda ou à direita.
- Converter o texto em letras minúsculas.
- Formate números de telefone de acordo com o padrão E.164.
Remova todos os pontos (.) que precedem o nome de domínio nos endereços de e-mail
gmail.com
egooglemail.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
Adicionar identificadores de usuários às conversões
Primeiro, prepare o objeto Conversion
para fazer upload ou
editar normalmente e, em seguida, anexe o identificador de usuário da seguinte maneira:
{
"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"
}
}
]
}
Uma resposta bem-sucedida deve ser semelhante a esta:
{
"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"
}
]
}
Erros comuns
Veja alguns erros que você pode encontrar ao melhorar uma conversão com identificadores de usuário:
- O campo hashed_X não é um hash SHA-256 válido
- Todos os campos com hash só aceitam hashes SHA-256 codificados em hexadecimais.
- O campo "country_code" tem o comprimento incorreto
country_code
precisa ter exatamente duas letras.- A configuração do Floodlight não assinou os Termos de Serviço das conversões otimizadas
- Os Termos de Serviço das conversões otimizadas não foram aceitos para o ID de configuração do Floodlight da solicitação.
- Mais de cinco user_identifiers especificados
- Uma conversão só pode ter até cinco identificadores de usuário.
Perguntas frequentes
- Por que o ID de correspondência é recomendado?
- As edições com base no ID de clique excluem as conversões não precedidas por um clique e limitam o valor da integração das conversões otimizadas.
- Por que a quantidade e o valor devem ser registrados?
- A API off-line de conversões do CM360 exige que a quantidade e o valor sejam especificados.
- Preciso ter o carimbo de data/hora exato de microssegundos registrado pelo Google para editar uma conversão on-line com base em tag?
- Para edições baseadas em ID de correspondência, a API agora aceita uma edição, desde que o carimbo de data/hora fornecido na solicitação esteja dentro de um minuto do carimbo de data/hora registrado pelo Google.
- Por que preciso esperar 90 minutos depois que uma conversão é capturada por uma tag on-line antes de fazer melhorias?
- Pode levar até 90 minutos para a conversão on-line ser indexada pela API e ficar disponível para edições.
- O que devo prestar atenção na resposta da API?
- Mesmo quando a API Conversion do CM360 retorna uma resposta bem-sucedida, pode ter falhado no upload ou na atualização de algumas
conversões individuais. Inspecione os
campos
ConversionStatus
individuais em busca de falhas:- As falhas de
NOT_FOUND
podem e precisam ser repetidas em até seis horas, caso haja um atraso maior que o normal no processamento da conversão. Consulte também as Perguntas frequentes sobre por que os errosNOT_FOUND
podem persistir por mais de seis horas. - Os erros
INVALID_ARGUMENT
ePERMISSION_DENIED
não devem ser repetidos.
- As falhas de