Esquema POST
La solicitud POST enviada al webhook estará en formato JSON con el siguiente esquema:
Carga útil de Webhook Proto
// 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;
}
Descripción del campo
Campo | Descripción | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
lead_id |
String única que identifica un cliente potencial determinado.
Recomendación de manejo: Úsala para anular la duplicación de los clientes potenciales que se reciben. Este será único en todos los formularios. Cuando informes problemas relacionados con un cliente potencial específico, este ID será obligatorio. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
api_version |
Es la versión de la API a la que pertenece este esquema de cliente potencial. Se usará cuando se migre a un esquema nuevo y se puede ignorar por ahora. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
form_id |
Es el ID único para cada formulario configurado en Google Ads. Con el producto actual, puedes
adjuntar un formulario a nivel de la campaña (en lugar de adjuntarlo a nivel del grupo de anuncios o
del anuncio).
Implicaciones: Los clientes potenciales se pueden segmentar solo a nivel del Los clientes deben usar un número entero de 8 bytes para el procesamiento. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
campaign_id |
El ID de la campaña de Google Ads o el ID de la línea de pedido (Display & Video 360) del
formulario de clientes potenciales adjunto.
Los clientes deben usar un número entero de 8 bytes para procesar. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
adgroup_id |
El ID del grupo de anuncios de Google Ads se utiliza para distinguir el grupo de anuncios específico de la campaña. (Disponible solo para clientes potenciales de anuncios discovery y de video)
Los clientes deben usar un número entero de 8 bytes para procesar. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creative_id |
El ID de creatividad de Google Ads se usa para distinguir la creatividad específica en el grupo de anuncios. (Disponible solo para clientes potenciales de anuncios discovery y de video)
Los clientes deben usar un número entero de 8 bytes para procesar. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
gcl_id |
El ID de clic de Google es un parámetro único que se usa para hacer un seguimiento de cada clic en un anuncio. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
google_key |
Es una clave que configura el anunciante con cada formulario.
Recomendación de manejo: Antes de procesar un cliente potencial recibido por
webhook, validar |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_test |
Este campo tiene una semántica “opcional”. Si el valor es verdadero, trata a este cliente potencial como cliente potencial de prueba. Si el valor es falso o si el campo no está presente, trata a este cliente potencial como un cliente potencial de producción válido. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
user_column_data |
Una tupla clave-valor repetida que transmite datos enviados por el usuario.
|
Manejo de clientes potenciales
Los controladores de clientes potenciales deben responder con los siguientes códigos HTTP:
Respuesta HTTP | Cuerpo de la respuesta (JSON) | ¿Es un error recuperable? |
---|---|---|
200 |
{} | No disponible |
4XX |
{"mensaje: Texto de error de formato libre que describe lo que estaba mal con la solicitud"} | No |
5XX |
{"message: Mensaje opcional de error retraible intermitente"} | Sí |
Duplicados
No se garantiza que un solo cliente potencial se entregue exactamente una vez, por lo que el webhook de control de clientes potenciales debe manejar los duplicados con facilidad.