查询合同有效期
您可以使用本接口来获取您的品牌商务合同有效期。商务合同是具有时效性的，您可以使用本接口通过合同有效期内的一个日期，来查询商务合同的起止日期。
v1.2与v1.3版本对比
以下表格概括了 v1.2与v1.3接口的变化。
``xtable
|变化内容{30%}|v1.2{35%}|v1.3{35%}|
|---|---|---|
|接口路径|/v1.2/rf/contract/query/|/v1.3/rf/contract/query/|
|请求参数类型|advertiser_id: number|advertiser_id: string|
|新增请求参数 |/|rf_campaign_type|
|新增返回参数|/|pulse_start_date<br>pulse_end_date`|
## 请求
**地址** https://business-api.tiktok.com/open_api/v1.3/rf/contract/query/
**方法** GET
**请求 Header**
``` xtable
|字段|类型|描述|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌，可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。 |
请求参数
|字段|类型|描述|
|---|---|---|
|advertiser_id {必填}|string| 广告主ID。 |
|included_date {必填}|string| 合同有效期中的某一日期，可以是广告组排期的开始时间/结束时间。格式："2020-09-18"。 |
|rf_campaign_type |string| 使用本字段设置要查询的合同是否是TikTok Pulse合同。枚举值： `STANDARD` （查询覆盖和频次合同）， `PULSE`（查询TikTok Pulse合同）。<br><p><span style="color:darkred"><b>注意</b></span>：本字段目前为白名单功能。如需使用此功能，请联系您的TikTok销售代表。|
示例
(code curl http)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/rf/contract/query/?advertiser_id={{advertiser_id}}&adgroup_ids={{adgroup_ids}}&included_date=2020-09-18' \
--header 'Content-Type: application/json' \
--header 'Access-Token: {{Access-Token}}'
(/code)
返回
|字段|类型|描述|
|---|---|---|
|code |number|返回码。完整返回码列表及描述，可查看[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。 |
|message |string|返回信息。更多信息可查看[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。 |
|request_id |string|请求的日志ID，唯一标识一个请求。 |
|data |object|返回数据。 |
#|has_valid_contract |boolean| 是否有有效合同。枚举值：`True`，`False`。<ul><li>仅当`has_valid_contract` 为`True`时才会返回正确的合同起止时间，此时代表传入的日期`included_date`在覆盖和频次合同或TikTok Pulse的有效期内。</li><li>若请求中`rf_campaign_type` 未设置为`PULSE` ，则`has_valid_contract`的值代表传入的`included_date`是否在覆盖和频次合同的有效期（ `[start_date, end_date]`）内。`included_date`在覆盖和频次合同的有效期内时本字段返回`True`。</li><li>若请求中`rf_campaign_type` 设置为`PULSE` ，则`has_valid_contract`的值代表传入的`included_date`是否在TikTok Pulse合同的有效期（ `[pulse_start_date, pulse_end_date]`）内。`included_date`在TikTok Pulse合同的有效期内时本字段返回`True`。</li></ul> |
#| pulse_start_date | string | TikTok Pulse合同的起始时间。当请求中`rf_campaign_type` 设置为`PULSE`时返回。<br><p><span style="color:darkred"><b>注意</b></span>：若您使用[/campaign/create/](https://ads.tiktok.com/marketing_api/docs?id=1739318962329602)创建覆盖和频次推广系列时，将`rf_campaign_type` 设置为`PULSE`，则对应广告组的投放时间(`[schedule_start_time, schedule_end_time]`) 应处于本接口返回的两个时间段`[start_date, end_date]`和`[pulse_start_date, pulse_end_date]`之间重合的时间段。`schedule_start_time`和`schedule_end_time`需在使用`/adgroup/rf/create/`创建覆盖和频次广告组时传入。 |
#| pulse_end_date | string |TikTok Pulse合同的终止时间。当请求中`rf_campaign_type` 设置为`PULSE`时返回。<br><p><span style="color:darkred"><b>注意</b></span>：若您使用[/campaign/create/](https://ads.tiktok.com/marketing_api/docs?id=1739318962329602)创建覆盖和频次推广系列时，将`rf_campaign_type` 设置为`PULSE`，则对应广告组的投放时间(`[schedule_start_time, schedule_end_time]`)应处于本接口返回的两个时间段`[start_date, end_date]`和`[pulse_start_date, pulse_end_date]`之间重合的时间段。`schedule_start_time`和`schedule_end_time`需在使用`/adgroup/rf/create/`创建覆盖和频次广告组时传入。 |
#|start_date |string| 覆盖和频次合同开始时间。 |
#|end_date |string| 覆盖和频次合同结束时间。 |
示例
(code Success-Response http)
HTTPS/1.1 200 OK
{
"message": "OK",
"code": 0,
"data": {
"has_valid_contract": true,
"start_date": "2020-10-01",
"end_date": "2020-11-30"
},
"request_id": "1E044AD4"
}
(/code);