Esquema POST
A solicitação POST enviada ao webhook estará no formato JSON com o seguinte esquema:
Payload do Proto do webhook
// Represent user lead data for single column
message UserLeadColumnData {
// Human-readable text of the field type (e.g.: Full Name, What is your
// preferred dealership?). This field might not always be populated.
optional string column_name = 1;
// Column value based on column type
oneof column_value {
string string_value = 2;
}
// Column id. Populated for all types of fields. (e.g.: FULL_NAME)
optional string column_id = 3;
}
// Message to construct webhook JSON payload
message WebhookLead {
// Unique id to represent lead
optional string lead_id = 1;
// User inputted data per column
repeated UserLeadColumnData user_column_data = 2;
// API version
optional string api_version = 3;
// Form id to which lead belonged to.
optional int64 form_id = 4;
// Campaign id that the lead form is associated with
optional int64 campaign_id = 5;
// Key to be used by advertiser to verify the request
// is from Google.
optional string google_key = 6;
// Denotes if the lead is a test lead.
optional bool is_test = 7;
// Click ID for the lead submission.
optional string gcl_id = 8;
// Adgroup id which generated the lead.
optional int64 adgroup_id = 9;
// Creative id which generated the lead.
optional int64 creative_id = 10;
}
Descrição do campo
| Campo | Descrição | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
lead_id |
String única que identifica um determinado lead.
Gerenciamento de recomendação:use esta opção para eliminar as duplicações de leads que são recebidos. Ele será exclusivo em todos os formulários. Ao gerar relatórios problemas relacionados a um lead específico, será necessário informar esse ID. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
api_version |
Versão da API a que este esquema de lead pertence. Ela será usada quando migrar para um novo esquema e pode ser ignorada por enquanto. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
form_id |
É o ID exclusivo de cada formulário configurado no Google Ads. O produto atual permite
anexar um formulário no nível da campanha (em vez de anexar no nível do grupo de anúncios ou do anúncio)
níveis).
Implicações:os leads só podem ser divididos em Os clientes precisam usar um número inteiro de 8 bytes para fazer o processamento. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
campaign_id |
O ID da campanha do Google Ads ou do item de linha (Display &Video 360) do
formulário de lead anexado.
Os clientes precisam usar um número inteiro de 8 bytes para processar. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
adgroup_id |
O ID do grupo de anúncios do Google Ads é usado para distinguir a
grupo de anúncios da campanha. Disponível para leads de vídeo e Discovery
somente anúncios)
Os clientes precisam usar um número inteiro de 8 bytes para processar. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creative_id |
O ID do criativo do Google Ads é usado para distinguir as
criativo no grupo de anúncios. Disponível para leads de vídeo e Discovery
somente anúncios)
Os clientes precisam usar um número inteiro de 8 bytes para processar. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
gcl_id |
Clique do Google ID, um parâmetro exclusivo usado para rastrear cada clique de um anúncio. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
google_key |
Uma chave configurada pelo anunciante com cada formulário.
Tratamento da recomendação: antes de processar um lead recebido por mais de
o webhook, validar |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_test |
Este campo tem "opcional" semântico. Se o valor for verdadeiro, trate isso liderar como líder de teste. Se o valor for "false" ou se o campo não estiver presente, trate esse lead como um lead de produção válido. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
user_column_data |
Uma tupla de chave-valor repetida que transmite dados enviados pelo usuário.
|
Gestão de leads
Os gerenciadores de leads devem responder com estes códigos HTTP:
| Resposta HTTP | Corpo da resposta (JSON) | Erro que permite tentar de novo? |
|---|---|---|
200 |
{} | N/A |
4XX |
{"message: texto de erro em formato livre, descrevendo o que estava errado com a solicitação"} | Não |
5XX |
{"message: mensagem opcional de erro retraível intermitente"} | Sim |
Cópias
Não há garantia de que um único lead será entregue exatamente uma vez. Por isso, o lead o processamento do webhook precisa lidar com as duplicatas corretamente.