工具 API

page_lead_task_create

Creates an asynchronous lead download task for all leads associated with the specified `page_id` or `ad_id`. If you later call `/page/lead/task/` with `task_id`, the same endpoint polls task status until `status = SUCCEED`; once complete, use `/page/lead/task/download/` to download the leads file. Leads are regionally stored, so you must use the correct base URL and `x-lead-region` header: for EEA/CH/UK use `https://business-api.tiktok.com/open_api/` with `x-lead-region: eu`; for US use `https://business-api.tiktok.com/open_api/` with `x-lead-region: us` (recommended) or `https://ads.us.tiktok.com/open_api/` (planned to be deprecated in future versions); for other countries/regions use `https://business-api.tiktok.com/open_api/` without `x-lead-region`. To determine which regional endpoint to use, check the ad's targeted locations via `/adgroup/get/`; the relevant regions are returned in `location_ids`, `zipcode_ids`, or both. Effective from July 13th (UTC+0), 2023, if you continue using the old URL `https://ads.us.tiktok.com/open_api/`, you will only receive US leads; if you use `https://business-api.tiktok.com/open_api/` without specifying the region in the header, you will only receive leads from other countries/regions. Only ad account admins can create/query lead download tasks or download leads; ad account roles are configured in Business Center. The generated leads file expires 10 minutes after generation, after which downloading returns a `file not exist` error.