获取音乐列表
您可以使用本接口获取可用于创建视频或轮播广告的音乐列表。列表中包括广告主上传的私有音乐素材(简称用户音乐)或者音频库(Audio Library,又称商用音乐库)中提供的公用音乐素材(简称系统音乐)。音频库更新频率比较低,不需要频繁获取。建议本地缓存,一个月更新一次即可。
版权声明
受音乐版权限制,使用系统提供的音乐制作的视频仅可在TikTok投放。您不可下载视频或其中包含的音乐文件,不可在TikTok以外的任何媒介提供、传播、播放视频或其中包含的音乐文件,除非您已向音乐版权方另行获得许可。因您违反上述规则而引发的投诉、纠纷,由您承担全部法律责任并应赔偿TikTok或TikTok关联公司因此遭受的损失。
v1.2与v1.3版本对比
以下表格概括了 v1.2与v1.3接口的变化。
``xtable
|变化内容{30%}|v1.2{35%}|v1.3{35%}|
|---|---|---|
|接口路径|/v1.2/file/music/get/|/v1.3/file/music/get/|
|请求参数类型 |advertiser_id: number|advertiser_id: string|
|新增请求参数|/|music_scene<br>search_type<br>keyword<br>image_urls<br>catalog_id<br>catalog_authorized_bc_id<br>sku_ids<br>product_set_id<br>item_group_ids<br>carousel_image_index|
|废弃返回参数| / |id: string |
|新增返回参数|/|author<br>liked<br>cover_url`|
## 请求
**地址** https://business-api.tiktok.com/open_api/v1.3/file/music/get/
**方法** GET
**请求Header**
``` xtable
|字段|类型|描述|
|--- |--- |--- |
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。|
参数
|字段|类型|描述|
|-|-|-|
| advertiser_id {必填} | string | 广告主ID。 |
| music_scene | string | 音乐的使用场景。 <br>枚举值: <ul><li>`CREATIVE_ASSET`:创意工具场景。</li><li>`CAROUSEL_ADS`:非购物广告类型的轮播广告场景。 </li><li>`CATALOG_CAROUSEL` :购物广告类型的轮播广告场景。</li></ul>默认值:`CREATIVE_ASSET`。|
| search_type {+条件必填} | string | 当 `music_scene` 设置为 `CAROUSEL_ADS`或 `CATALOG_CAROUSEL`时必填。 <br>当 `music_scene` 设置为 `CREATIVE_ASSET` 或未传入时不支持本字段。 <br>音乐搜索类型。<br>枚举值: <ul><li> `SEARCH_BY_KEYWORD`:通过关键词进行模糊搜索。您需同时传入 `keyword`。 需注意不支持使用本搜索类型搜索用户自定义上传的音乐。</li><li>`SEARCH_BY_RECOMMEND`:<ul><li>`music_scene`设置为`CAROUSEL_ADS`时:根据指定的图片URL获取推荐音乐。您需同时传入 `image_urls` 。最多返回500首推荐音乐。需注意不支持使用本搜索类型搜索用户自定义上传的音乐。</li><li>`music_scene` 设置为 `CATALOG_CAROUSEL` 时:根据指定的商品获取推荐音乐。您需同时传入`catalog_id` 和 `catalog_authorized_bc_id` 。此外,您需同时选择以下三种设置之一。 需注意不支持使用本搜索类型搜索用户自定义上传的音乐。 <ul><li>若想为商品库的所有商品获取推荐音乐,不可传入 `product_set_id` , `item_group_ids` 以及 `sku_ids` 字段。</li><li>若想为商品系列中的商品获取推荐音乐,需传入 `product_set_id` 和 `item_group_ids` 其中之一。</li><li>若想为特定商品获取推荐音乐,需传入 `sku_ids` 。</li></ul></li></ul></li><li> `SEARCH_BY_LIKED`:搜索收藏列表中的音乐。最多返回1,000首推荐收藏列表中的音乐。 </li><li> `SEARCH_BY_HISTORY`:搜索历史列表中的音乐。</li><li>`SEARCH_BY_MUSIC_ID`:通过音乐ID搜索音乐。</li><li>`SEARCH_BY_SOURCE`:通过音乐来源搜索音乐。您需同时传入`sources`。需注意您只能筛选出用户自定义上传的、可用于轮播广告的音乐。</li></ul><p><span style="color:darkred"><b>注意</b></span>: 当本字段设置为 `SEARCH_BY_RECOMMEND` ,`SEARCH_BY_LIKED` 或 `SEARCH_BY_MUSIC_ID`,不支持分页,将忽略 `page` 和 `page_size` 参数。 |
| filtering | object | 筛选条件。 |
#| keyword {+条件必填} |string | 当 `search_type` 设置为 `SEARCH_BY_KEYWORD` 时必填。 <br>当 `search_type` 未设置为`SEARCH_BY_KEYWORD` 时不生效。<br>用于搜索音乐的关键词。 |
#| image_urls {+条件必填} | string[] | 当`music_scene`设置为`CAROUSEL_ADS`且`search_type` 设置为 `SEARCH_BY_RECOMMEND` 时必填。 <br> 当 `search_type` 未设置为 `SEARCH_BY_RECOMMEND` 时不生效。 <br>图片URL列表,用于获取推荐音乐。<br>列表长度范围:[2, 35]。<br>您需指定至少两个使用 [/file/image/ad/upload/](https://ads.tiktok.com/marketing_api/docs?id=1739067433456642) 或 [/file/image/ad/search/](https://ads.tiktok.com/marketing_api/docs?id=1740052016789506)接口获取的图片URL。<br>所指定的图片还需<strong>同时</strong>满足:<ul><li>规格要求:<ul><li>文件类型: JPG,JPEG,或PNG </li><li>图片分辨率:最大为1242*2340 px 或 2340*1242 px </li><li>图片宽高比:最大为 9:20 或 20:9 </li><li>文件大小:小于 50 MB </li></ul></li><li>[/file/image/ad/search/](https://ads.tiktok.com/marketing_api/docs?id=1740052016789506)返回的图片对应 `is_carousel_usable` 的值为`true`。</li></ul> 若您在创建非视频购物类型的轮播广告时使用了推荐音乐,您需在该广告中使用用于生成推荐音乐的图片。 |
#| music_ids {+条件必填} | string[] | 当 `search_type` 设置为 `SEARCH_BY_MUSIC_ID` 时必填。 <br>音乐ID列表。<br>最大数量:100。|
#| catalog_id {+条件必填} | string | `music_scene` 设置为 `CATALOG_CAROUSEL` 且 `search_type` 设置为 `SEARCH_BY_RECOMMEND` 时必填。 <br><br>商品库 ID。 |
#| catalog_authorized_bc_id {+条件必填} | string | `music_scene` 设置为 `CATALOG_CAROUSEL` 且 `search_type` 设置为 `SEARCH_BY_RECOMMEND` 时必填。 <br><br>拥有商品库权限的商务中心的ID。 <br> 对于商务中心中的商品库,您必须传入商品库所属商务中心的ID。 |
#| item_group_ids {+条件必填} | string[] | 当 `music_scene` 设置为 `CATALOG_CAROUSEL` ,`search_type` 设置为 `SEARCH_BY_RECOMMEND`,且您希望为从商品系列中动态选取商品的视频购物类型轮播广告获取推荐音乐时,您需传入 `product_set_id` 和 `item_group_ids` 其中之一。 <br>若您想为从整个商品库中动态选取商品的视频购物类型轮播广告获取推荐音乐,无需传入本字段。 <br><br>商品的SPU(标准化产品单元) ID列表。 <br>最大数量:20。 |
#| product_set_id {+条件必填} | string | 当 `music_scene` 设置为 `CATALOG_CAROUSEL`, `search_type` 设置为`SEARCH_BY_RECOMMEND`,且您希望为从商品系列中动态选取商品的视频购物类型轮播广告获取推荐音乐时,您需传入 `product_set_id` 和 `item_group_ids` 其中之一。<br>若您想为从整个商品库中动态选取商品的视频购物类型轮播广告获取推荐音乐,无需传入本字段。 <br><br>商品系列ID。 |
#| sku_ids {+条件必填} | string[] | 当 `music_scene` 设置为 `CATALOG_CAROUSEL` , `search_type` 设置为 `SEARCH_BY_RECOMMEND` ,且您希望为使用商品库中指定商品的视频购物类型轮播广告获取推荐音乐时,本字段必填。 <br>若您想为从整个商品库中动态选取商品的视频购物类型轮播广告获取推荐音乐,无需传入本字段。<br><br>SKU(库存量单位)ID列表。<br><br>最大数量:20。 <br>最小数量:2。 |
#| carousel_image_index | integer | 仅当 `music_scene` 设置为 `CATALOG_CAROUSEL` , `search_type` 设置为`SEARCH_BY_RECOMMEND`,且所指定的商品已设置对应的附加图片列表时生效。 <br><br>用于指定视频购物类型的轮播广告中要使用的附加图片的索引。<br>若未传入本字段,将在视频购物类型的轮播广告中使用商品库商品的主图。 <br><br>取值范围:[0, 9]。<ul><li>您通过本字段传入的数值代表每个商品库商品的附加图片列表( `additional_image_urls` ) 中要使用的附加图片的位置。例如,若 `carousel_image_index` 设置为<strong>1</strong>,代表您将使用每个 `additional_image_urls` 的值中的<strong>第二个</strong>图片作为轮播广告中使用的图片。您可通过[/catalog/product/get/](https://ads.tiktok.com/marketing_api/docs?id=1740564136678402)返回的 `additional_image_urls` 字段获取商品对应的附加图片列表。</li><li>若您指定的数值超过了商品对应的附加图片列表中附加图片 URL 的数量,将忽略本字段,使用商品的主图(`image_url`)。您可通过[/catalog/product/get/](https://ads.tiktok.com/marketing_api/docs?id=1740564136678402)返回的 `image_url` 字段获取商品对应的主图。</li></ul>|
#| material_ids | string[] | 当 `music_scene` 设置为 `CAROUSEL_ADS` 或 `CATALOG_CAROUSEL`时,不支持使用本字段。<br><br>素材 ID列表。 <br><br>最大数量:100。 |
#| styles | string[] | 当 `music_scene` 设置为 `CAROUSEL_ADS`或 `CATALOG_CAROUSEL`时,不支持使用本字段。 <br><br>音乐风格。<br><br>最大数量:1。 |
#| sources{+条件必填} | string[] |当 `music_scene` 设置为 `CREATIVE_ASSET` 或未传入时,本字段选填。<br>当 `music_scene` 设置为 `CAROUSEL_ADS`或 `CATALOG_CAROUSEL`,且`search_type`设置为`SEARCH_BY_SOURCE`时,本字段必填,且仅支持设置为`USER`,从而用于筛选用户自定义上传的、可用于轮播广告的音乐。 <br><br>音乐来源。 <br><br>`USER` 表示用户上传的音乐,`SYSTEM` 表示系统音乐。 <br><br>最大数量:1。 |
| page | number | 当前页数。<br><br>默认值: 1。<br>取值范围: ≥ 1。<br> `page` 和 `page_size` 的乘积不可超过 100,000。<br><br><p><span style="color:darkred"><b>注意</b></span>:当 `search_type`设置为 `SEARCH_BY_RECOMMEND` ,`SEARCH_BY_LIKED` 或 `SEARCH_BY_MUSIC_ID`,不支持分页,将忽略 `page` 和 `page_size` 参数。 |
| page_size| number | 分页大小。<br><br>默认值: 1,000。<br>取值范围: 1-1,000。 <br> `page` 和 `page_size` 的乘积不可超过 100,000。<br><br><p><span style="color:darkred"><b>注意</b></span>:<ul><li>当 `search_type` 设置为 `SEARCH_BY_RECOMMEND` ,`SEARCH_BY_LIKED` 或 `SEARCH_BY_MUSIC_ID` 时,不支持分页,将忽略 `page` 和 `page_size` 参数。 </li><li>当 `search_type` 设置为 `SEARCH_BY_KEYWORD` 或 `SEARCH_BY_HISTORY` 时,默认值为200,取值范围[1, 200]。 </li></ul>|
示例
(code curl http)
curl --get -H "Access-Token:xxx" \
--data-urlencode "advertiser_id=ADVERTISER_ID" \
https://ads.tiktok.com/open_api/v1.3/file/music/get/
(/code)
返回
|字段|类型|描述|
|-|-|-|
|code |number|返回码。完整返回码列表及描述,可查看[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。|
|message |string|返回信息。更多信息可查看[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。|
|data |object|返回数据。|
#|musics |list|音乐数据。|
##| music_id | string | 音乐 ID。 |
##| material_id | string | 素材 ID。 |
##| sources | string[] | 音乐来源。`USER`表示用户上传的音乐,`SYSTEM`表示系统音乐。 |
##| author | string |仅为可用于轮播广告中的音乐返回此字段。 <br>音乐作者。 |
##| liked | boolean |仅为可用于轮播广告中的音乐返回此字段。 <br>此音乐是否已添加至收藏列表中。 |
##| cover_url | string |仅为可用于轮播广告中的音乐返回此字段。 <br>音乐的封面图片的URL。 |
##| url | string | 音乐试听链接。有效时长:12h |
##| style{+ 条件返回} | string | 音乐风格。仅系统音乐返回该字段。 |
##| duration{+ 条件返回} | float | 视频时长,单位秒。仅系统音乐返回该字段。 |
##| signature | string | 音乐文件MD5。 |
##| name | string | 音乐名称。 |
##| file_name | string | 文件名称。 |
##| copyright | string | 版权信息。枚举值:`MUSIC_FORBID_VIDEO_ALLOW`(音乐不允许下载,但是生成的视频允许下载) ,`MUSIC_FORBID_VIDEO_FORBID`(音乐不允许下载,且生成的视频不允许下载)。|
##| create_time{+ 条件返回} | string | 创建时间。自定义音乐会返回该字段,系统音乐不返回该字段。UTC 时间,格式:2020-06-10T07:39:14Z |
##| modify_time{+ 条件返回} | string | 修改时间。自定义音乐会返回该字段,系统音乐不返回该字段。UTC 时间,格式:2020-06-10T07:39:14Z |
#|page_info |object|分页信息。|
##|page |number|当前页数。|
##|page_size |number|分页大小。|
##|total_number |number|结果总数。|
##|total_page |number|总页数。|
|request_id |string|请求的日志 ID,唯一标识一个请求。 |
示例
(code 返回示例 python)
HTTPS/1.1 200 OK
{
"message": "OK",
"code": 0,
"data": {
"page_info": {
"total_number": 1,
"page": 1,
"page_size": 1000,
"total_page": 1
},
"musics": [
{
"style": "Teen",
"name": "Her World",
"copyright": "MUSIC_FORBID_VIDEO_ALLOW",
"url": "http://sf-tk-sg.ibytedtos.com/obj/cc-music-sg/6650280667860962050",
"file_name": "Her World",
"music_id": "6707429901383565318",
"material_id": "6707429901383565318",
"sources": [
"SYSTEM"
],
"signature": "bdb2ff10fb44bb38151c98bfee94de89",
"duration": 127.5,
}
]
},
"request_id": "2020120606494801011517615607983119"
}
(/code)