Schéma POST
La requête POST envoyée au webhook sera au format JSON et présentera le schéma suivant:
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é.
Gestion des recommandations:utilisez cette option pour dédupliquer les prospects reçus. Il est unique dans tous les formulaires. Lorsque vous signalez des problèmes liés à un prospect spécifique, vous devez indiquer cet ID. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
api_version |
Version de l'API à laquelle appartient ce schéma de prospect. Il sera utilisé lors de la migration vers un nouveau schéma et peut être ignoré pour le moment. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
form_id |
ID unique de chaque formulaire configuré dans Google Ads. Le produit actuel permet d'associer un formulaire au niveau de la campagne (plutôt que de l'associer au niveau du groupe d'annonces ou de l'annonce).
Conséquences:les prospects ne peuvent être segmentés qu'au niveau de Les clients doivent utiliser un nombre entier de 8 octets pour traiter le traitement. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
campaign_id |
ID de la campagne Google Ads ou de l'élément de campagne (Display & Video 360) du formulaire pour prospects joint.
Les clients doivent utiliser un nombre entier de 8 octets pour le traitement. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
adgroup_id |
L'ID du groupe d'annonces Google Ads permet de distinguer un groupe d'annonces spécifique dans la campagne. (Uniquement disponible pour les prospects générés à partir d'annonces vidéo et Discovery)
Les clients doivent utiliser un nombre entier de 8 octets pour le traitement. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creative_id |
L'ID de la création Google Ads permet de distinguer une création spécifique dans le groupe d'annonces. (Uniquement disponible pour les prospects générés à partir d'annonces vidéo et Discovery)
Les clients doivent utiliser un nombre entier de 8 octets pour le traitement. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
gcl_id |
ID de clic Google : paramètre unique permettant d'effectuer le suivi de chaque clic sur une annonce. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
google_key |
Une clé configurée par l'annonceur pour chaque formulaire.
Gérer la recommandation:Avant de traiter un prospect reçu via un webhook, valider |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_test |
Ce champ présente une sémantique "facultative". Si la valeur est "true", traitez ce prospect comme un prospect de test. Si la valeur est "false" ou si le champ est absent, traitez ce prospect comme un prospect de production valide. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
user_column_data |
tuple de clé-valeur répété transmettant des données envoyées 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: Free form error text, describe what was failed with request"} | Non |
5XX |
{"message: Erreur retraçable intermittente message facultatif"} | Oui |
Doublons
Il n'est pas garanti qu'un seul prospect soit livré exactement une fois. Par conséquent, le webhook de gestion des prospects doit gérer les doublons de manière optimale.