Esquema POST
La solicitud POST enviada al webhook tendrá el formato JSON con los siguientes elementos: esquema:
Carga útil de protocolo 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;
}
Descripción del campo
| Campo | Descripción | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
lead_id |
Es una cadena única que identifica a un cliente potencial determinado.
Administración de recomendaciones: Utiliza esta opción para anular la duplicación de los clientes potenciales que realicen lo siguiente: recibidos. Este será único en todas las formas. Al momento de informar problemas relacionados con un cliente potencial específico, este ID será obligatorio. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
api_version |
Versión de la API a la que pertenece este esquema de clientes potenciales. Se usará cuando migrando a un nuevo esquema y, por el momento, puede ignorarse. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
form_id |
Es un ID único para cada formulario configurado en Google Ads. El producto actual permite adjuntar un formulario a nivel de la campaña (en lugar de hacerlo a nivel del grupo de anuncios o del anuncio).
Implicaciones: Los clientes potenciales solo se pueden dividir en 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 el procesamiento. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
adgroup_id |
El ID del grupo de anuncios de Google Ads se usa para distinguir el grupo de anuncios específico en la campaña. (Disponible para clientes potenciales de video y discovery
solo anuncios)
Los clientes deben usar un número entero de 8 bytes para el procesamiento. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creative_id |
El ID de la creatividad de Google Ads se usa
de las creatividades del grupo de anuncios. (Disponible para clientes potenciales de video y discovery
solo anuncios)
Los clientes deben usar un número entero de 8 bytes para el procesamiento. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
gcl_id |
Clic de Google ID, un parámetro único que se usa para hacer un seguimiento de cada clic en un anuncio. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
google_key |
Una clave que configura el anunciante con cada formulario.
Manejo de la recomendación: Antes de procesar un cliente potencial recibido más de
la validación de |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_test |
Este campo contiene la palabra "optional" semántica. Si el valor es verdadero, trata 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 cliente potencial de producción válido. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
user_column_data |
Una tupla de par 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) | ¿Error que se puede recuperar? |
|---|---|---|
200 |
{} | N/A |
4XX |
{"message: Free form error text, describing what was errors with request"}. | No |
5XX |
{"message: Intermittent retraible error option message"}, | Sí |
Duplicados
No se garantiza que un solo cliente potencial se publique exactamente una vez, por lo que el webhook de manejo de clientes potenciales debe controlar los duplicados de forma fluida.