Схема POST
POST-запрос, отправляемый вебхуку, будет в формате JSON со следующей схемой:
Полезная нагрузка 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;
// Asset group ID represents the container for holding assets, associated
// URLs, hints and criteria that will be used to select assets and for
// optimization. This field is only populated for Performance Max campaigns.
int64 asset_group_id = 11;
// Lead stage at the time of delivery.
string lead_stage = 12 [(datapol.semantic_type) = ST_NOT_REQUIRED];
// Lead submit time in ISO-8601 format. Ex- 2024-09-26T12:30:00Z
string lead_submit_time = 13 [(datapol.semantic_type) = ST_NOT_REQUIRED];
}
Описание поля
| Поле | Описание | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
lead_id | Уникальная строка, идентифицирующая конкретного потенциального клиента. Рекомендация по обработке: Используйте это для удаления дубликатов полученных лидов. Этот идентификатор будет уникальным во всех формах. При сообщении о проблемах, связанных с конкретным лидом, этот идентификатор будет необходим. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
api_version | Версия API, к которой относится данная схема лидов. Она будет использоваться при миграции на новую схему и пока может игнорироваться. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
form_id | Для каждой формы, настроенной в Google Ads, присваивается уникальный идентификатор. Текущая версия позволяет прикреплять форму на уровне кампании (в отличие от прикрепления на уровне группы объявлений или отдельных объявлений). Последствия: Анализ лидов возможен только на уровне Для обработки данных клиентам необходимо использовать 8-байтовое целое число. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
campaign_id | Идентификатор рекламной кампании Google Ads или идентификатор позиции (Display & Video 360) прикрепленной формы для сбора контактных данных. Для обработки данных клиентам необходимо использовать 8-байтовое целое число. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
adgroup_id | Идентификатор группы объявлений Google Ads используется для различения конкретной группы объявлений в кампании. (Доступно только для лидов, полученных из видео- и ознакомительных объявлений) Для обработки данных клиентам необходимо использовать 8-байтовое целое число. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
creative_id | Идентификатор креатива Google Ads используется для различения конкретного креатива в группе объявлений. (Доступно только для лидов, полученных из видео- и ознакомительных объявлений) Для обработки данных клиентам необходимо использовать 8-байтовое целое число. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
gcl_id | Идентификатор клика Google (Google Click ID ) — это уникальный параметр, используемый для отслеживания каждого клика по объявлению. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
google_key | Ключ, устанавливаемый рекламодателем для каждой формы. Рекомендация по обработке: Перед обработкой лида, полученного через веб-хук, проверьте | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_test | Это поле имеет "необязательную" семантику. Если значение равно true, рассматривайте этого потенциального клиента как тестового. Если значение равно false или если поле отсутствует, рассматривайте этого потенциального клиента как действующего клиента для производственной эксплуатации. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
user_column_data | Повторяющаяся пара ключ-значение, передающая данные, предоставленные пользователем.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
asset_group_id | Это поле заполняется только для кампаний Performance-Max. Оно обозначает идентификатор контейнера, содержащего форму для сбора лидов. Для обработки данных клиентам необходимо использовать 8-байтовое целое число. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
lead_stage | Это обозначает стадию развития лида на момент его предоставления. Это поле полезно для отслеживания стадии воронки продаж / статуса конверсии лида. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
lead_submit_time | Это метка времени, когда пользователь отправил форму. Она представлена в формате ISO-8601. Например: 2024-09-26T12:30:00Z |
Нераспознанные поля и обратная совместимость
Чтобы обеспечить надежную интеграцию веб-перехватчика и возможность адаптации к будущим улучшениям, рекомендуется проектировать JSON-парсер таким образом, чтобы он корректно игнорировал любые поля в полезной нагрузке веб-перехватчика, которые ваша система явно не обрабатывает или не распознает.
Ключевая рекомендация: настройте логику парсинга JSON таким образом, чтобы она обрабатывала только те поля, которые необходимы для вашего приложения. Не пишите код, который ожидает фиксированный набор полей или который завершится ошибкой, если в полезной нагрузке появятся новые, неожиданные поля.
Почему это важно:
- Обратная совместимость: В будущих обновлениях Google может добавить новые необязательные поля в полезную нагрузку веб-хука для предоставления более полных данных или новых функций. Если ваш парсер слишком строг (например, выдает ошибку при работе с неизвестными свойствами), ваша интеграция может нарушиться при внедрении Google подобных изменений, не нарушающих обратную совместимость.
- Упрощенное сопровождение: сосредоточившись только на тех точках данных, которые вы активно используете, вы делаете код интеграции проще и легче в обслуживании.
Большинство современных библиотек для анализа JSON предлагают опции, позволяющие по умолчанию игнорировать неизвестные свойства, или же их можно настроить соответствующим образом.
Обработка свинца
Специалисты по обработке лидов должны отправлять следующие HTTP-коды:
| HTTP-ответ | Тело ответа (JSON) | Повторная попытка исправления ошибки? |
|---|---|---|
200 | {} | Н/Д |
4XX | {"message: Текст ошибки в произвольной форме, описывающий, что не так с запросом"} | Нет |
5XX | {"message: Периодически повторяющаяся ошибка (необязательное сообщение)"} | Да |
Дубликаты
Нет гарантии, что один и тот же лид будет доставлен ровно один раз, поэтому веб-хук для обработки лидов должен корректно обрабатывать дубликаты.