获取更新源
您可以使用本接口获取商品库的单个更新源或所有更新源的信息。
v1.2与v1.3版本对比
以下表格概括了 v1.2与v1.3接口的变化。
``xtable
|变化内容{30%}|v1.2{35%}|v1.3{35%}|
|---|---|---|
|接口路径| /v1.2/catalog/feed/get/| /v1.3/catalog/feed/get/|
|请求参数类型|bc_id: number <br>catalog_id: number <br>feed_id: number|bc_id: string <br>catalog_id: string <br>feed_id`: string|
## 请求
**地址**: https://business-api.tiktok.com/open_api/v1.3/catalog/feed/get/
**方法** GET
**Header**
```xtable
|字段|类型|描述|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。|
参数
|字段|类型|描述|
|---|---|---|
|bc_id {必填}|string| 商务中心 ID。 |
|catalog_id {必填}|string| 商品库 ID。|
|feed_id|string|您想获取的商品库更新源 ID。如果不传入，则返回商品库的所有更新源。|
示例
(code)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/catalog/feed/get/?bc_id={{bc_id}}&catalog_id={{catalog_id}}'\
--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|返回数据。 |
#|feed_list|object[]|更新源列表。|
##|feed_id|string|更新源 ID。|
##|feed_name|string| 更新源名称。|
##|status |string | 更新源的定时更新的状态。<br><br>枚举值： <ul><li>`ON`: 更新源有开启（"ON"）状态的定时更新。</li><li>`OFF`: 更新源无开启状态的定时更新。此时可能更新源未设置定时更新，或更新源的定时更新处于关闭（"OFF"）状态。</li></ul>|
##|last_update_param|object| 最后一次更新信息。|
###|uri|string|更新源地址，即更新源文件所在的 URL。|
###|update_mode|string|更新模式。<br><br>枚举值: <ul><li>`OVERWRITE`：覆盖数据源。若历史商品在新的商品库中不存在，则历史商品将被删除。若存在新商品，将在商品库中添加新商品；若商品已存在，则会用上传的商品信息更新原有的商品信息。</li><li>`INCREMENTAL`：增量式更新。若历史商品在新的商品库中不存在，历史商品不会被删除。若存在新商品，将在商品库中添加新商品；若商品已存在，则会用上传的商品信息更新原有的商品信息。</li></ul>|
###|timzeone|string|更新计划使用的时区。<br><br>示例：`Africa/Accra`。<br><br>时区列表可见 [附录-时区信息](https://ads.tiktok.com/marketing_api/docs?id=1737586324313089)。|
###|interval_type|string| 定时更新间隔单位。<br><br>枚举值: `HOURLY`（小时），`DAILY`（日），`MONTHLY`（月）。|
###|interval_count |number| 两次相邻的更新之间的间隔。 <ul><li>若 `interval_type` 为 `HOURLY`，取值范围为 1-23。</li><li>若 `interval_type` 为 `DAILY`，取值范围为 1-30。</li><li>若 `interval_type` 为 `MONTHLY`，取值范围是 1-12。</li></ul>|
###|day_of_month |number| 对于按月执行的定时更新，执行更新的月份的第几日。|
###|hour|number|获取更新的小时时间。<br><br><ul><li>若定时更新是按小时执行，本字段代表首次执行更新的小时时间。</li><li>若定时更新是按日或月执行，本字段代表执行定时更新的小时时间。</li></ul>|
###|minute|number|获取更新的分钟时间。<br><br><ul><li>若定时更新是按小时执行，本字段代表首次更新的分钟时间。</li><li>若定时更新是按日或月执行，本字段代表执行定时更新的分钟时间。</li></ul>|
##|next_update_time|string|下次更新的日期和时间（UTC + 0 时间）。示例："2021-05-23 16:33:23"。|
##|number_of_products|number|更新源中的商品数量。|
示例
(code Success JSON)
{
"code": 0,
"message": "OK",
"request_id": "20210708164329010115004015033AF205",
"data": {
"feed_list": [
{
"feed_id": 8665,
"feed_name": "feed_test_1",
"last_update_param": {
"day_of_month": 20,
"hour": 12,
"interval_count": 2,
"interval_type": "MONTHLY",
"minute": 30,
"timezone": "Africa/Accra",
"update_mode": "INCREMENTAL",
"uri": "ads.tiktok.com"
},
"next_update_time": "2021-07-20 12:30:00",
"number_of_products": 0
},
{
"feed_id": 1521,
"feed_name": "default",
"last_update_param": {
"day_of_month": null,
"hour": null,
"interval_count": null,
"interval_type": null,
"minute": null,
"timezone": null,
"update_mode": "INCREMENTAL",
"uri": null
},
"next_update_time": null,
"number_of_products": 0
}
]
}
}
(/code)