TOOL API
rf_
Queries Reach & Frequency contracts for an advertiser and checks whether a specified date falls within a valid contract period. Provide `included_date` to verify the contract validity window covering that date and return the relevant start and end dates. In v1.3, `advertiser_id` changed from number to string and `rf_campaign_type` was added. If `rf_campaign_type` is used to query TikTok Pulse contracts, this is an allowlist-only feature and requires access from your TikTok representative. The response is also used with `/campaign/create/`: when creating an R&F campaign with `rf_campaign_type=PULSE`, the ad group schedule window (`schedule_start_time`, `schedule_end_time`) must fall within the intersection of the returned `[start_date, end_date]` and `[pulse_start_date, pulse_end_date]`.
Call information
- Tool slug
- tiktok-ads.rf_contract_query_get
- Provider
- TikTok for Business
- Average response
- 0 ms
- Calls in 7 days
- 0
Input parameters
advertiser_idrequiredAdvertiser ID.
included_daterequiredA date that must fall within the contract validity window, or the start/end date corresponding to an ad group's delivery period. Format: `YYYY-MM-DD`, for example `2020-09-18`.
rf_campaign_typeSpecifies which contract type to query. `STANDARD` queries Reach & Frequency contracts; `PULSE` queries TikTok Pulse contracts. If omitted, contract validity is evaluated against the Reach & Frequency contract period (`start_date` to `end_date`). This field is allowlist-only for TikTok Pulse access; contact your TikTok representative to enable it.