工具 API
lead_ field_ get
Retrieves the field names collected by an Instant Form or by direct message leads using /open_api/v1.3/lead/field/get/. The source is controlled by `lead_source`: `INSTANT_FORM` returns fields for an Instant Form, and `DIRECT_MESSAGE` returns fields for leads generated from direct messages of the associated Business Account. Depending on where the leads are stored, you may need an ad account `advertiser_id` or a Business Center form library `library_id`. To look up required IDs, use /page/library/get/ for form libraries and /page/get/ with `business_type=LEAD_GEN` for Instant Form pages.
调用信息
- 工具标识
- tiktok-ads.lead_field_get
- 服务提供方
- TikTok 广告
- 平均响应
- 0 ms
- 近 7 天调用
- 0
输入参数
advertiser_idAdvertiser ID. Required when the leads are under an ad account.
lead_source必填Source of the leads. `INSTANT_FORM` means leads generated through an Instant Form; when set to `INSTANT_FORM`, `page_id` is required. `DIRECT_MESSAGE` means leads generated from direct messages of the associated Business Account; when set to `DIRECT_MESSAGE`, `page_id` is not supported.
library_idID of a form library. Required when the leads are under a form library of a Business Center. To obtain valid library IDs, use /page/library/get/.
page_idPage ID of an Instant Form. Required when `lead_source` is `INSTANT_FORM`. Not supported when `lead_source` is `DIRECT_MESSAGE`. To obtain valid Instant Form page IDs, use /page/get/ and set `business_type` to `LEAD_GEN`.