Stay organized with collections
Save and categorize content based on your preferences.
POST schema
The POST request sent to webhook will be in JSON format with the following
schema:
Webhook Proto payload
// Represent user lead data for single columnmessageUserLeadColumnData{// Human-readable text of the field type (e.g.: Full Name, What is your// preferred dealership?). This field might not always be populated.optionalstringcolumn_name=1;// Column value based on column typeoneofcolumn_value{stringstring_value=2;}// Column id. Populated for all types of fields. (e.g.: FULL_NAME)optionalstringcolumn_id=3;}// Message to construct webhook JSON payloadmessageWebhookLead{// Unique id to represent leadoptionalstringlead_id=1;// User inputted data per columnrepeatedUserLeadColumnDatauser_column_data=2;// API versionoptionalstringapi_version=3;// Form id to which lead belonged to.optionalint64form_id=4;// Campaign id that the lead form is associated withoptionalint64campaign_id=5;// Key to be used by advertiser to verify the request// is from Google.optionalstringgoogle_key=6;// Denotes if the lead is a test lead.optionalboolis_test=7;// Click ID for the lead submission.optionalstringgcl_id=8;// Adgroup id which generated the lead.optionalint64adgroup_id=9;// Creative id which generated the lead.optionalint64creative_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.int64asset_group_id=11;}
Field description
Field
Description
lead_id
Unique string which identifies a given lead.
Handling recommendation: Use this to dedupe leads which are
received. This will be unique across all forms. When reporting
issues related to a specific lead, this id will be required.
api_version
API version which this lead schema belongs to. This will be used when
migrating to a new schema, and can be ignored for now.
form_id
Unique ID for each form configured in Google Ads. Current product allows
attaching a form with a campaign level (vs. attaching at ad group or ad
levels).
Implications: Leads can be sliced only at form_id
level (i.e., at campaign level).
Clients need to use 8 bytes integer to process.
campaign_id
The Google Ads campaign ID or line item ID (Display & Video 360) of the
attached lead form.
Clients need to use an 8-byte integer to process.
adgroup_id
The Google Ads ad group ID is used to distinguish the specific
ad group in the campaign. (Available for leads from video and discovery
ads only)
Clients need to use an 8-byte integer to process.
creative_id
The Google Ads creative ID is used to distinguish the specific
creative in the ad group. (Available for leads from video and discovery
ads only)
Clients need to use an 8-byte integer to process.
gcl_id
Google click
ID, a unique parameter used to track each click of an ad.
google_key
A key configured by the advertiser with each form.
Handling recommendation: Before processing a lead received over
webhook, validating google_key is the same as configuring in
Google Ads in order to have more confidence that the lead is valid. Keep
this key confidential and update in Google Ads if there is a reason to
believe that this has leaked widely.
is_test
This field has "optional" semantic. If value is true, treat this
lead as test lead. If value is false or if field is not present, treat
this lead as valid production lead.
user_column_data
A repeated key-value tuple transmitting user submitted data.
user_column_data.column_id: Data type submitted by
the user.
User_column_data.column_value: For each data type,
there will be a value type populated depending on data type. All our
current data types have the value of
user_column_data.string_value.
user_column_data.column_name: Human-readable text of
the data type submitted by the user. This field might not always be
populated, use column_id instead.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-12-18 UTC."],[],[]]