Esquema POST
A solicitação POST enviada para o webhook estará no formato JSON com o esquema a seguir:
Payload do protocolo 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.
Recomendação de processamento: use para eliminar a duplicação de leads que são recebidos. Ele será exclusivo em todos os formulários. Ao informar problemas relacionados a um lead específico, esse ID será necessário. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
api_version |
Versão da API a que este esquema de lead pertence. Ele será usado ao migrar para um novo esquema e pode ser ignorado por enquanto. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
form_id |
ID exclusivo para cada formulário configurado no Google Ads. Com o produto atual, é possível anexar um formulário ao nível da campanha, em vez de anexar ao grupo de anúncios ou ao anúncio.
Implicações:os leads podem ser divididos apenas no nível do Os clientes precisam usar um número inteiro de 8 bytes para 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 o processamento. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
adgroup_id |
O ID do grupo de anúncios do Google Ads é usado para distinguir o grupo de anúncios específico na campanha. (disponível somente para leads de anúncios Discovery e
em vídeo)
Os clientes precisam usar um número inteiro de 8 bytes para o processamento. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creative_id |
O ID do criativo do Google Ads é usado para distinguir o criativo específico no grupo de anúncios. (disponível somente para leads de anúncios Discovery e
em vídeo)
Os clientes precisam usar um número inteiro de 8 bytes para o processamento. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
gcl_id |
ID de clique do Google, um parâmetro exclusivo usado para rastrear cada clique em um anúncio. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
google_key |
Uma chave configurada pelo anunciante com cada formulário.
Processamento da recomendação:antes de processar um lead recebido por webhook, a validação de |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_test |
Esse campo tem uma semântica "opcional". Se o valor for verdadeiro, trate esse lead como lead de teste. Se o valor for falso ou se o campo não estiver presente, trate o lead como lead de produção válido. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
user_column_data |
Uma tupla repetida de chave-valor que transmite dados enviados pelo usuário.
|
Gestão de leads
Os gerenciadores de lead precisam responder com estes códigos HTTP:
| Resposta HTTP | Corpo da resposta (JSON) | Erro que pode ser tentado novamente? |
|---|---|---|
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. Portanto, o processamento do webhook do lead precisa lidar com as cópias sem problemas.