Schema POST
La richiesta POST inviata al webhook sarà in formato JSON con quanto segue: schema:
Payload protocollo 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;
}
Descrizione del campo
| Campo | Descrizione | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
lead_id |
Stringa univoca che identifica un determinato lead.
Consigli per l'uso: da utilizzare per deduplicare i lead che sono ricevuto. Sarà univoco in tutti i moduli. Durante il report per problemi relativi a una richiesta specifica, questo ID sarà obbligatorio. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
api_version |
Versione dell'API a cui appartiene questo schema dei lead. Verrà utilizzata quando migrazione a un nuovo schema, e per il momento può essere ignorata. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
form_id |
ID univoco per ogni modulo configurato in Google Ads. Il prodotto corrente consente
l'aggiunta di un modulo a livello di campagna (anziché l'aggiunta di un modulo a livello di gruppo di annunci o di annuncio)
).
Implicazioni: i lead possono essere suddivisi solo in I client devono utilizzare un numero intero di 8 byte per l'elaborazione. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
campaign_id |
L'ID campagna Google Ads o l'ID elemento pubblicitario (Display &Video 360) del
modulo per i lead allegato.
Per l'elaborazione, i client devono utilizzare un numero intero a 8 byte. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
adgroup_id |
L'ID gruppo di annunci Google Ads viene utilizzato per distinguere
gruppo di annunci della campagna. (Disponibile per i lead provenienti da video e discovery)
annunci)
Per l'elaborazione, i client devono utilizzare un numero intero a 8 byte. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creative_id |
L'ID creatività di Google Ads viene utilizzato per distinguere le specifiche
creatività nel gruppo di annunci. (Disponibile per i lead provenienti da video e discovery)
annunci)
Per l'elaborazione, i client devono utilizzare un numero intero a 8 byte. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
gcl_id |
Clic Google ID, un parametro univoco utilizzato per monitorare ogni clic di un annuncio. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
google_key |
Una chiave configurata dall'inserzionista in ogni modulo.
Consiglio per la gestione: prima di elaborare un lead ricevuto più di
webhook, la convalida di |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_test |
Questo campo è "facoltativo" semantica. Se il valore è true, consideralo come lead di prova. Se il valore è false o se il campo non è presente, trattare come lead di produzione valido. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
user_column_data |
Una tupla chiave-valore ripetuta che trasmette i dati inviati dall'utente.
|
Gestione dei lead
I gestori di lead devono rispondere con i seguenti codici HTTP:
| Risposta HTTP | Corpo della risposta (JSON) | Errore recuperabile? |
|---|---|---|
200 |
{} | N/D |
4XX |
{"message: Testo di errore in formato libero, che descrive il problema nella richiesta"} | No |
5XX |
{"message: Messaggio di errore intermittente retraibile facoltativo"} | Sì |
Duplicati
Non è garantito che un singolo lead venga consegnato esattamente una volta, pertanto il webhook deve gestire i duplicati in modo controllato.