Schéma POST
La requête POST envoyée au webhook est au format JSON avec les valeurs suivantes : schéma:
Charge utile proto de 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;
}
Description du champ
| Champ | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
lead_id |
Chaîne unique identifiant un prospect donné.
Recommandation de gestion:utilisez cette option pour dédupliquer les prospects qui sont reçues. Il sera unique pour tous les formulaires. Lors du signalement liés à un prospect spécifique, cet identifiant est obligatoire. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
api_version |
Version de l'API à laquelle ce schéma de prospect appartient. Il sera utilisé lorsque vers un nouveau schéma, et peuvent être ignorées pour le moment. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
form_id |
ID unique pour chaque formulaire configuré dans Google Ads. Le produit actuel permet
l'association d'un formulaire au niveau de la campagne (et non au niveau d'un groupe d'annonces ou d'une annonce,
niveaux).
Conséquences:les prospects ne peuvent être répartis qu'au niveau de Les clients doivent utiliser un entier de 8 octets pour traiter la requête. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
campaign_id |
ID de la campagne Google Ads ou de l'élément de campagne (Display &Video 360) de la
formulaire pour prospects joint.
Les clients doivent utiliser un entier de 8 octets pour traiter la requête. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
adgroup_id |
L'ID du groupe d'annonces Google Ads permet de distinguer les groupes d'annonces
le groupe d'annonces de la campagne. (Disponible pour les prospects des campagnes vidéo et Discovery
annonces uniquement)
Les clients doivent utiliser un entier de 8 octets pour traiter la requête. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creative_id |
L'ID de création Google Ads permet de distinguer les
dans le groupe d'annonces. (Disponible pour les prospects des campagnes vidéo et Discovery
annonces uniquement)
Les clients doivent utiliser un entier de 8 octets pour traiter la requête. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
gcl_id |
Clic Google ID, un paramètre unique utilisé pour suivre chaque clic sur une annonce. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
google_key |
Une clé configurée par l'annonceur avec chaque formulaire.
Recommandation de traitement:Avant de traiter un prospect reçu plus de
webhook, valider |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_test |
Ce champ indique "facultatif" sémantique. Si la valeur est "true", traiter cette en tant que prospect test. Si la valeur est "false" ou si le champ n'est pas présent, traiter ce prospect en tant que responsable de production valide. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
user_column_data |
Nuptial clé-valeur répété transmettant des données soumises par l'utilisateur.
|
Gestion des prospects
Les gestionnaires de prospects doivent répondre avec les codes HTTP suivants:
| Réponse HTTP | Corps de la réponse (JSON) | Erreur récupérable ? |
|---|---|---|
200 |
{} | N/A |
4XX |
{"message: Texte d'erreur au format libre, décrivant le problème avec la demande"} | Non |
5XX |
{"message: Message d'erreur facultatif retraible intermittente"} | Oui |
Doublons
Il n'est pas garanti qu'un seul prospect soit généré exactement une fois, d'où il le webhook doit gérer correctement les doublons.