根据 ID 获取素材包

您可以使用本接口通过 ID 获取一个已创建的创意素材包。您可通过/creative/portfolio/create/创建创意素材包。

v1.2与v1.3版本对比

以下表格概括了 v1.2与v1.3接口的变化。 ``xtable |变化内容{30%}|v1.2{35%}|v1.3{35%}| |---|---|---| |接口路径|/v1.2/creative/portfolio/get/|/v1.3/creative/portfolio/get/ | |请求参数类型|advertiser_id: number creative_portfolio_id: number |advertiser_id: string creative_portfolio_id: string| | 返回参数名称|advanced_show_time advanced_guide_text_bottom advanced_position advanced_image_info portfolio_type|badge_show_time call_to_action_text badge_position badge_image_info creative_portfolio_type| | 返回参数类型 |asset_ids: number[] portfolio_content: object[]|asset_ids: string[] portfolio_content: object| | 新增返回参数 |/|creative_portfolio_id sticker_param（包括该对象下的所有参数） tags layouts description category_label app_id card_show_price card_tags card_image_index title selling_points content_url pop_up_window_image_id gesture_type slide_length slide_dimension interactive_music_id| | 废弃返回参数|/|由于我们不再支持GAME_GIFT卡片类型，以下参数在v1.3中已废弃： profile_image display_name gift_card_title gift_card_detail gift_card_code thumbnail_url`|


## 请求

**地址**  https://business-api.tiktok.com/open_api/v1.3/creative/portfolio/get/

**方法** GET

**Header**

``` xtable
|字段{35%}|类型{15%}|描述{50%}|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。|

参数

|字段{35%}|类型{15%}|描述{50%}|
|--- |--- |--- |
|advertiser_id {必填}|string|广告主ID。|
|creative_portfolio_id {必填}|string|创意素材包ID。<br>您可从[/creative/portfolio/create/](https://ads.tiktok.com/marketing_api/docs?id=1739091950439426)的返回中获取创意素材包ID（`creative_portfolio_id`）。|

示例

(code curl http)
curl --location --request GET https://business-api.tiktok.com/open_api/v1.3/creative/portfolio/get/?advertiser_id={{advertiser_id}}&creative_portfolio_id={{creative_portfolio_id}}
--header 'Access-Token: {{Access-Token}}'
--header 'Content-Type: application/json'
(/code)

|字段{35%}|类型{15%}|描述{50%}|
|-|-|-|
|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|返回数据。|
#|creative_portfolio_id|string|创意素材包 ID。|
#|creative_portfolio_type|string|创意素材包类型。<br><br> 枚举值： <ul><li>`CTA`：行动引导文案。</li><li>`CARD`：卡片（展示卡片）。</li><li>`WEB_INFO_CARD`：网站信息卡片。</li><li> `DOWNLOAD_CARD`：下载卡。</li><li>`INVENTORY_CARD`: 库存卡片。</li><li>`PRODUCT_CARD`：商品卡片。</li><li> `PRODUCT_TILE`： 商品磁贴。</li><li>`STICKER`：倒计时贴纸或礼品码贴纸。</li><li>`PREMIUM_BADGE`：弹出展示（又称福袋）。</li><li>`GESTURE`：交互手势。</li><li>`SUPER_LIKE`：点赞彩蛋。点赞彩蛋能够在受众为视频广告点赞后，为受众提供令人惊喜的视觉元素。有了点赞彩蛋，当受众点赞或点按两次广告时，屏幕上会飘过心形图标和自定义图标。</li></ul><br><p><span style="color:darkred"><b>注意</b></span>：<ul><li>网站信息卡片可用于`objective_type`为`WEB_CONVERSIONS` 或 `TRAFFIC`（`promotion_type` 需设置为 `WEBSITE` ）的竞价广告。</li><li>库存卡片仅支持在汽车广告中使用。</li><li>商品卡片目前仅支持在视频购物广告中使用。</li><li>商品磁贴目前仅支持在商品来源为商品库的视频购物广告中使用。</li><li>使用商品磁贴素材包创建广告目前为白名单功能。如需使用此功能，请联系您的TikTok销售代表。</li><li> 倒计时贴纸可用于以覆盖人数（ `REACH` ）、访问量 （ `TRAFFIC` ）、视频播放量（ `VIDEO_VIEW` ）、应用推广 （ `APP_PROMOTION`）、线索收集（ `LEAD_GENERATION` ）、网站转化量 （ `WEB_CONVERSIONS` ）或商品销量（ `PRODUCT_SALES` ） 为推广目标（ `objective_type` ）的竞价广告，以及以覆盖人数（ `RF_REACH` ）为推广目标（ `objective_type` ）的覆盖和频次广告。 <ul><li>在推广目标为访问量 （ `TRAFFIC` ）、应用推广（ `APP_PROMOTION` ）和网站转化量 （ `WEB_CONVERSIONS` ）的广告中使用含非直播活动或直播活动提醒的倒计时贴纸（即 `sticker_type` 为 `REMINDER_COUNTDOWN` 或 `LIVE_REMINDER_COUNTDOWN` ）目前为白名单功能。如需使用此功能，请联系您的 TikTok 销售代表。</li></ul></li><li>礼品码贴纸仅可用于以覆盖人数（`REACH`），访问量 （`TRAFFIC`）， 视频播放量（`VIDEO_VIEW`），应用推广 （`APP_PROMOTION`），线索收集（`LEAD_GENERATION`），网站转化量 （`WEB_CONVERSIONS`）或商品销量（`PRODUCT_SALES`） 为推广目标（`objective_type`）的竞价广告，以及以覆盖人数（`RF_REACH`）为推广目标（`objective_type`）的覆盖和频次广告。</li> <li>交互手势仅可用于以覆盖人数（`REACH`）、访问量（`TRAFFIC`）、视频播放量（`VIDEO_VIEW`）（`optimization_goal` 需设置为 `ENGAGED_VIEW`）、应用推广（`APP_PROMOTION`）或网站转化量（`WEB_CONVERSIONS`）为推广目标（`objective_type`）的竞价广告，以及以覆盖人数（`RF_REACH`）为推广目标（`objective_type`）的覆盖和频次广告。 <ul><li> 在推广目标为应用推广（`APP_PROMOTION`）、访问量（`TRAFFIC`）或网站转化量（`WEB_CONVERSIONS`）的推广系列广告中使用交互手势目前为白名单功能。如需使用此功能，请联系您的 TikTok 销售代表。</li></ul></li><li>点赞彩蛋仅可用于以覆盖人数（`REACH`）、访问量（`TRAFFIC`）、视频播放量（`VIDEO_VIEW`）（`optimization_goal` 需设置为 `ENGAGED_VIEW`）、社区互动（`ENGAGEMENT`）（`optimization_goal` 需设置为 `PAGE_VISIT`）、应用推广（`APP_PROMOTION`）或网站转化量（`WEB_CONVERSIONS`）为推广目标（`objective_type`）的竞价广告，以及以覆盖人数（`RF_REACH`）为推广目标（`objective_type`）的覆盖和频次广告。<ul><li>在推广目标为访问量（`TRAFFIC`）或应用推广（`APP_PROMOTION`）的推广系列告中使用点赞彩蛋目前为白名单功能。如需使用此功能，请联系您的 TikTok 销售代表。</li></ul></li></ul>|
#|portfolio_content|object[]|素材包内容。|
##|asset_content|string|行动引导文案。<br><br>示例：`"Learn More"`。|
##|asset_ids|string[]|行动引导文案 ID 列表。<br><br>示例：`[201781, 201535]`。|
##|card_type|string| 卡片类型。<br><br>枚举值：`IMAGE`（展示卡片）。|
##| gesture_type  | string | `creative_portfolio_type` 为 `GESTURE` 时返回本字段。<br><br> 交互手势类型。 <br><br> 枚举值：<ul><li>`CLICK`：点击型。</li><li>`STRAIGHT_SLIDE`：直线滑动型。</li><li>`CURVED_SLIDE`：曲线滑动型。 </li></ul> |
##|image_id|string|仅当 `creative_portfolio_type` 为 `CARD` 、`WEB_INFO_CARD`、`INVENTORY_CARD`或 `SUPER_LIKE` 时返回本字段。<br><br>图片 ID。|
##| pop_up_window_image_id | string | 仅在以下任一场景下返回：<ul><li>`creative_portfolio_type` 为 `GESTURE`。</li><li>`creative_portfolio_type` 为 `SUPER_LIKE` 且创建素材包时传入了 `pop_up_window_image_id`。</li></ul><br>交互手势中跳转图的图片 ID 或点赞彩蛋中弹出窗口的图片 ID。 <ul><li> `creative_portfolio_type` 为 `GESTURE` 时，本字段代表受众跟随手势后将出现的跳转图。</li><li>`creative_portfolio_type` 为 `SUPER_LIKE` 时，本字段代表在点赞彩蛋播放结束后出现的弹出窗口，当受众点击弹窗，就会跳转到您的广告落地页。</li></ul> |
##|title|string|仅当 `creative_portfolio_type` 为 `WEB_INFO_CARD` 时返回本字段。<br><br>卡片标题。|
##|selling_points |string[]|仅当 `creative_portfolio_type` 为 `WEB_INFO_CARD` 时返回本字段。<br><br>卖点，即用户应该购买您的商品的理由。|
##|content_url|string|仅当 `creative_portfolio_type` 为 `WEB_INFO_CARD` 时返回本字段。<br><br>落地页的网站 URL。<br><br><p><span style="color:darkred"><b>注意</b></span>：<ul><li>目前不支持通过 API 手动指定网站信息卡片中的 `content_url`，您仅可获取通过 TikTok 广告管理平台创建的网站信息卡片的 `content_url`。</li><li>对于通过 API 创建的网站信息卡片，本字段值将为空字符串（`""`）。</li></ul>|
##|thumbnail_id|string|仅当 `creative_portfolio_type`为`DOWNLOAD_CARD`，`PRODUCT_CARD`，`PRODUCT_TILE` 或  `PREMIUM_BADGE`  时返回本字段。<br><br>预览图 ID。|
##|call_to_action_text|string|`creative_portfolio_type` 为 `GESTURE` 或 `PREMIUM_BADGE` 时返回本字段。<br><br>交互手势或弹出展示中的交互引导语。|
##|badge_show_time|integer| `creative_portfolio_type` 为 `GESTURE` 或 `PREMIUM_BADGE` 时返回本字段。 <br><br>交互手势中手势图标或弹出展示中福袋的出现时机，单位为秒。|
##|badge_position|object| `creative_portfolio_type` 为 `GESTURE` 或 `PREMIUM_BADGE` 时返回本字段。 <br><br> 交互手势中手势图标或弹出展示中福袋的位置信息。|
###|position_x| float|  交互手势中手势图标或弹出展示中福袋左上角的相对横坐标，以左上角横坐标除以 720 表示。 |
###|position_y| float| 交互手势中手势图标或弹出展示中福袋左上角的相对纵坐标，以左上角横坐标除以 1280 表示。|
###|angle|number|满足以下任一条件时返回本字段。<ul><li>`creative_portfolio_type` 为 `GESTURE` 且 `gesture_type` 为 `STRAIGHT_SLIDE` 或 `CURVED_SLIDE`。</li><li>`creative_portfolio_type` 为 `PREMIUM_BADGE`。</li></ul><br> 交互手势中直线滑动型或曲线滑动型手势图标的手势角度或弹出展示中福袋的弹出角度。|
##|badge_image_info|object| `creative_portfolio_type` 为 `PREMIUM_BADGE` 时返回本字段。<br> <br> 弹出展示中福袋图片信息。 |
###|image_id|string| 弹出展示中福袋的图片 ID。 |
##| slide_length | number | `creative_portfolio_type` 为 `GESTURE` 且 `gesture_type` 为 `STRAIGHT_SLIDE` 时返回本字段。  <br> <br> 直线滑动型手势的长度。 |
##| slide_dimension  | object |`creative_portfolio_type` 为 `GESTURE` 且`gesture_type`为 `CURVED_SLIDE` 时返回本字段。<br> <br> 曲线滑动型手势的尺寸。 |
###| dimension_width  | number  | 曲线滑动型手势的宽度。 |
###| dimension_height| number |曲线滑动型手势的高度。 |
##| interactive_music_id | string | `creative_portfolio_type` 为 `GESTURE` 时返回本字段。 <br> <br> 交互手势中手势音效的 URL。|
##| layouts | string[] | 仅当`creative_portfolio_type`为 `DOWNLOAD_CARD`时返回本字段。<br> 下载卡的布局类型。枚举值：<ul><li> `TYPE_1`：在下载卡中展示应用描述。</li><li>`TYPE_2`：在下载卡中不展示应用描述。</li></ul><br>您可传入一种或两种类型，当您同时传入 `TYPE_1` 和 `TYPE_2`时，将同时创建一个类型1和一个类型2的下载卡。 |
##| description | string | 在以下任一场景中返回：<ul><li>`creative_portfolio_type` 为 `DOWNLOAD_CARD` 且 `layouts` 包含 `TYPE_1`。</li><li>`creative_portfolio_type`为 `INVENTORY_CARD`。</li></ul><br>您想在下载卡中推广的应用的描述或库存卡片的文本。|
##| tags | string[] | 当`creative_portfolio_type`为 `DOWNLOAD_CARD`时返回本字段。<br> 下载卡中的标签。枚举值：<ul><li> `CATEGORIES`：在下载卡中展示您想推广的应用的分类。</li><li> `FILESIZE`：在下载卡中展示您想推广的应用的文件大小。</li><li> `RATING`：在下载卡中展示您想推广的应用的评分。</li><li> `RANKING`：在下载卡中展示您想推广的应用的排行。 </li><li>`COMMENT_VOLUME`：在下载卡中展示您想推广的应用的评论数。</li></ul> |
##| category_label | string | 仅当`creative_portfolio_type`为 `DOWNLOAD_CARD`且创建卡片时指定了`category_label`时返回本字段。<br><br>  下载卡中展示的您想推广的应用的分类名称。 |
##| app_id | string | 仅当`creative_portfolio_type`为 `DOWNLOAD_CARD`时返回本字段。 <br>下载卡中您想推广的应用的 ID。该 ID 为事件管理平台中显示的应用ID。 |
##| sticker_param | object | 想要创建的倒计时贴纸和礼品码贴纸详情。倒计时贴纸和礼品码贴纸示例可查看[倒计时贴纸](https://ads.tiktok.com/help/article?aid=10007423)和[礼品码贴纸](https://ads.tiktok.com/help/article/tiktok-interactive-add-on-gift-code-sticker?lang=zh)。<br><br>仅当`creative_portfolio_type`为`STICKER `时返回本字段。 <br><p><span style="color:darkred"><b>注意</b></span>：单次仅可创建一个倒计时贴纸或礼品码贴纸。 |
###| sticker_type | string | 贴纸类型。 <br><br>枚举值：<ul><li> `COUNTDOWN`：无提醒的倒计时贴纸。</li><li> `REMINDER_COUNTDOWN`： 含非直播活动提醒的倒计时贴纸。</li><li> `LIVE_REMINDER_COUNTDOWN`：含直播活动提醒的倒计时贴纸。</li><li>`GIFTCODE`：礼品码贴纸，用于通过提供虚拟礼品或优惠券兑换码来吸引新客户和促进现有客户。</li></ul> |
###| title | string | 贴纸标题。<br><ul><li>对于倒计时贴纸，最大长度为54个UTF-8字节 ，且不支持话题标签符号 (#)。</li><li>对于礼品码贴纸，最大长度为20个UTF-8字节。</li><ul> |
###| giftcode | string | 礼品码。<br>本字段仅适用于礼品码贴纸。最大长度为10个UTF-8字节（10个英文字母和数字）。|
###| cutoff_time | string | 贴纸对应的倒计时截止日期(`sticker_type`为 `COUNTDOWN`或`REMINDER_COUNTDOWN`时)或直播开始时间 (`sticker_type`为`LIVE_REMINDER_COUNTDOWN`时)，格式为"2022-10-30 00:00:00" (UTC+0 时间)。 <br><p><span style="color:darkred"><b>注意</b></span>：您在此字段传入的时间将默认为UTC+0时间，且该默认时区无法更改。 |
###| color | string | 贴纸的背景色。<br><ul><li>对于倒计时贴纸，支持的枚举值：`ORANGE`(橘色)、`BLACK`(黑色)、`RED`(红色)、`BLUE`(蓝色)。</li><li>对于通过API创建的礼品码贴纸，只会返回`BLACK`和`BLUE`。而由于某些礼品码贴纸通过TTAM创建，创建时仍支持设置橘色和红色，这些礼品码贴纸可能会返回`ORANGE`和`RED`。 |
###| display_angle | integer | 贴纸的显示角度。取值范围： `[-180, +180]`。 `+90` 表示将贴纸顺时针旋转90度。<br><p><span style="color:darkred"><b>注意</b></span>：对于通过API创建的礼品码贴纸，不会返回本字段。而由于某些礼品码贴纸通过TTAM创建，创建时仍支持设置显示角度，这些礼品码贴纸可能会返回`display_angle`。|
###| predefined_placement | string | <ul><li>若素材包为礼品码贴纸，且贴纸的位置对应[预定义位置](https://business-api.tiktok.com/portal/docs?id=1739091950439426#item-link-Predefined%20placements)中的一个枚举值，本字段将返回横坐标和纵坐标。 </li><li>若素材包为倒计时贴纸，且贴纸的位置对应[预定义位置](https://business-api.tiktok.com/portal/docs?id=1739091950439426#item-link-Predefined%20placements)中的一个枚举值，本字段将返回横坐标，纵坐标和大小。 </li></ul><br>例如：<br>若一个倒计时贴纸的横坐标，纵坐标和大小分别为196,148和0.8，对应[预定义位置](https://business-api.tiktok.com/portal/docs?id=1739091950439426#item-link-Predefined%20placements)中的枚举值`196x148x0.8`，则本字段将返回`196x148x0.8`。<br><br><p><span style="color:darkred"><b>注意</b></span>：若贴纸不对应[预定义位置](https://business-api.tiktok.com/portal/docs?id=1739091950439426#item-link-Predefined%20placements)中任何的枚举值，本字段将返回`null` |
###| position_x | integer | 贴纸左上角相对于屏幕左上角的横坐标。|
###| position_y | integer | 贴纸左上角相对于屏幕左上角的纵坐标。|
###| size | string | 以百分比表示的贴纸大小。枚举值： `0.6`(60%), `0.7`(70%), `0.8`(80%), `0.9`(90%), `1`(100%), `1.1`(110%)。<br><p><span style="color:darkred"><b>注意</b></span>：当创建礼品码贴纸时不适用。您仍可以获取已有礼品码贴纸的`size`。 |
###| opacity | string | 贴纸的不透明度。枚举值：`0.7`, `0.8`, `0.9`, `1`。值越小，表示倒计时贴纸的透明度越高。<br><p><span style="color:darkred"><b>注意</b></span>：对于通过API创建的礼品码贴纸，不会返回本字段。而由于某些礼品码贴纸通过TTAM创建，创建时仍支持设置不透明度，这些礼品码贴纸可能会返回`opacity`。|
###| reminder_time | string | 设置的提醒时间。 仅当`sticker_type`为`REMINDER_COUNTDOWN`或`LIVE_REMINDER_COUNTDOWN`时返回值。<br> 对于非直播倒计时贴纸 (即`sticker_type`为 `REMINDER_COUNTDOWN`)，枚举值为：<ul><li> `ONE_MINUTE_EARLIER`: 在非直播活动前一分钟发送提醒。</li><li> `ONE_HOUR_EARLIER `: 在非直播活动前一小时发送提醒。</li><li> `ONE_DAY_EARLIER`: 在非直播活动前一天发送提醒。</li></ul> 对于非直播倒计时贴纸 (即`sticker_type`为 `LIVE_REMINDER_COUNTDOWN`), 枚举值为：<ul><li> `ONE_MINUTE_AFTER`: 在直播活动开始一分钟后发送提醒。</li><li> `FIVE_MINUTES_AFTER`: 在直播活动开始五分钟后发送提醒。</li><li> `TEN_MINUTES_AFTER`: 在直播活动开始十分钟后发送提醒。</li></ul> |
###| landing_page_url | string | 落地页URL，在非直播活动的倒计时结束后，点击提醒时会跳转至此URL。 仅当`sticker_type`为`REMINDER_COUNTDOWN`时返回值。 |
###| live_tiktok_user_id  | string | 直播活动主播的TikTok用户ID 。传入本字段后，当您点击直播活动的提醒时，会自动跳转至主播的直播间。 <br>仅当 `sticker_type`为`LIVE_REMINDER_COUNTDOWN`时返回值。 |
##| card_show_price | boolean | 是否在商品卡片中显示商品价格。 |
##| card_tags | string[] | 在商品卡片中显示的商品标签。 <br>枚举值：`BRAND` （品牌名称）， `DESC`（说明）。 |
##| card_image_index | integer | 本字段用于指定在商品卡片或商品磁贴中使用的图片。<br>通过本字段设置的数字将作为索引，查询您调用[/catalog/product/upload/](https://ads.tiktok.com/marketing_api/docs?id=1740497429681153)时通过`additional_image_urls`字段传入的图片URL。<br> 例如，`card_image_index` 为1代表您将使用`additional_image_urls`的值中的第二个图片URL对应的图片。 |

示例

(code JSON python)
HTTPS/1.1 200 OK
{
    "message": "OK",
    "code": 0,
    "data": {
        "portfolio_content": [
            {
                "asset_ids": [
                    "201781",
                    "201535"
                ],
                "asset_content": "learn_more"
            },
            {
                "asset_ids": [
                    "201902",
                    "201404"
                ],
                "asset_content": "download_now"
            }
        ]
    },
    "request_id": "2020123008315601023125104010685"
}
(/code)