stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 Path: /affiliate_seller/202608/marketplace_creators/search
#§2 Method: [POST]
#§3 Function Description
This API is used by Sellers to search for Creators in the Creator Marketplace. Sellers can search based on filters such as GMV, keywords, and Creator follower demographics. All the data returned is for the last 30 days.
§4 Common Parameters
For common parameters, refer to How to call TikTok Shop APIs - Common Parameters
| Properties | Location | Type | Require | Sample | Properties description |
|---|---|---|---|---|---|
| shop_cipher | query | string | Y | GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3 | Use this property to pass shop information in requesting the API. Failure in passing the correct value when requesting the API for cross-border shops will return incorrect response. |
| Get by API Get Authorization Shop | |||||
| content-type | header | string | Y | application/json | Allowed type: application/json |
§5 Request Query Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| app_key | string | Y | 38abcd | Every single app will have a unique key. Please use the specific key assigned to your app. |
| sign | string | Y | 5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c | Signature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders. |
| timestamp | int | Y | 1623812664 | Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time. |
| page_token | string | N | b2Zmc2V0PTAK | Pagination offset determines where you begin to search for. It's empty when raise your first request |
| page_size | int | Y | 12 | The value of "page_size" must be 12 or 20 |
§6 Request Body Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| search_key | string | N | 2E+0EcXoSk2HWdEWh2nITfkBRMbwuug0mt9s3fWgV0k= | Caching search results improves api performance and ensures stable request results. |
| You don't need to pass a value on the first call. | ||||
| For the second call, please pass the value returned in the response of the first call. | ||||
| keyword | string | N | JefreeStar | Searching creators by keyword, matching based on TikTok Username and Nickname. |
| follower_demographics | object | N | Filtering creators by follower demographics | |
| ^age_ranges | []string | N | ["AGE_RANGE_18_24", "AGE_RANGE_35_44"] | Follower age filtering options, which are range intervals, include: |
| AGE_RANGE_18_24: "18-24", | ||||
| AGE_RANGE_25_34: "25-34", | ||||
| AGE_RANGE_35_44: "35-44", | ||||
| AGE_RANGE_45_54: "45-54", | ||||
| AGE_RANGE_55_AND_ABOVE: "55+" | ||||
| ^count_range | object | N | Follower count filtering | |
| ^^count_ge | int | N | 1000 | The minimum value of follower count. |
| The value passed in must be greater than or equal to 0 | ||||
| ^^count_le | int | N | 10000 | The maximum value of follower count. |
- Generally, a value greater than or equal to 0 needs to be passed. If a value less than 0 is passed, it means that the field will not be filtered. | ^gender_distribution |object |N | |Filtering creators by follower gender which includes: "male", "female" | ^^gender |string |N |MALE |A particular gender, "MALE" or "FEMALE" | ^^percentage_ge |int |N |6000 |Greater than or equal to a certain percentage, scaled up by 10,000 times. For example, 6000 stands for 0.6 or 60% | gmv_ranges |[]string |N |["GMV_RANGE_0_100", "GMV_RANGE_100_1000"] |Filtering by GMV range intervals which include: GMV_RANGE_0_100: "0-100", GMV_RANGE_100_1000: "100-1000", GMV_RANGE_1000_10000: "1000-10000", GMV_RANGE_10000_AND_ABOVE: "10000+" For example:
- If GMV_RANGE_0_100 is passed, it means filtering the creator data that is greater than or equal to 0 and less than or equal to 100.
- If GMV_RANGE_0_100 and GMV_RANGE_100_1000 are passed, it means to filter the creator data that is greater than or equal to 0 and less than or equal to 1000. | units_sold_ranges |[]string |N |["UNITS_SOLD_RANGE_0_10", "UNITS_SOLD_RANGE_100_1000","UNITS_SOLD_RANGE_1000_AND_ABOVE"] |Filtering by sales volume range intervals which include: UNITS_SOLD_RANGE_0_10: "0-10", UNITS_SOLD_RANGE_10_100: "10-100", UNITS_SOLD_RANGE_100_1000: "100-1000", UNITS_SOLD_RANGE_1000_AND_ABOVE: "1000+" For example:
- If UNITS_SOLD_RANGE_0_10 is passed, it means filtering the creator data that is greater than or equal to 0 and less than or equal to 10.
- If UNITS_SOLD_RANGE_0_10 and UNITS_SOLD_RANGE_10_100 are passed, it means to filter the creator data that is greater than or equal to 0 and less than or equal to 100. | category |[]object |N | |Object for category filters: Get Categories | ^parent_category_id |string |N |600001 |Category of the parent category. If you are only using a parent category, you do not need to pass in a child category ID. | ^child_category_id_list |[]string |N |["851848"] |If you are using the category ID for a child category, you must pass the parent category as well. A child category is only 1 level deeper than the parent category. We do not support going deeper down the category tree (some countries have 4 levels, others have 7) | content_performance |object |N | |Object containing content performance filters | ^avg_video_views |string |N |1 |Average Video Views more than You can pass in average video views anywhere between 0 and 100k Pick any whole number between 0 and 100,000, and we will return all results with average video views greater than that number. You can only pass in Average Video Views OR Average Shoppable Video Views. Using both filters will cause the API call to fail. | ^avg_shoppable_video_views |string |N |1 |You can pass in average shoppable video views anywhere between 0 and 100k Pick any whole number between 0 and 100,000, and we will return all results with average shoppable video views greater than that number. You can only pass in Average Video Views OR Average Shoppable Video Views. Using both filters will cause the API call to fail. | ^avg_engagement_rate |string |N |1 |Average engagement rate more than 0-20. You can only filter by increments of 1% point, up to 20%. | ^avg_shopable_engagement_rate |string |N |1 |Average shoppable engagement rate more than 0-20. You can only filter by increments of 1% point, up to 20%. | ^avg_live_avg_viewers_ge |string |N |1 |Average LIVE views greater than or equal to Pick any whole number between 0 and 100,000, and we will return all results with average video views greater than that number. You can only pass in average LIVE or average shoppable LIVE. Using both filters will cause the API call to fail | ^avg_shoppable_live_avg_viewers_ge |string |N |1 |Average shoppable LIVE viewers greater than or equal to Pick any whole number between 0 and 100,000, and we will return all results with average video views greater than that number. You can only pass in average LIVE or average shoppable LIVE. Using both filters will cause the API call to fail | affiliate_data |object |N | |Object which contains affiliate based data | ^avg_commission_rate |string |N |LESS_THAN_20% |- ALL
- LESS_THAN_20%
- LESS_THAN_15%
- LESS_THAN_10%
- LESS_THAN_5% Creator's average commission rate range based on showcase products, sales, and promoted products in the last 30 days. You can only pick one value. | ^post_rate |string |N |GOOD |These categories represent how often a creator posts a shoppable video or LIVE after receiving a sample.
- All
- OK
- GOOD
- BETTER Every country has its own benchmark based on what is a GOOD vs BETTER fulfillment rate. BETTER is always going to have the highest fulfillment rate, including 100% fulfillment rate. | ^creator_agency_staus |string |N |AGENCY_MANAGED |- AGENCY_MANAGED
- INDEPENDENT | ^is_fast_growing |bool |N |false |Top 10% of creators with the greatest increase in transactions, revenue, shoppable videos, live views, or followers in the last 30 days | ^not_invited_l90_days |bool |N |false |True/False Select this filter to see creators you haven't invited in the last 90 days | advanced_filters |object |N | |Advanced filters are specific to each country. We will provide a separate endpoint which allows you to query which filters are available for which country. | ^content_preference_type |[]string |N |["VIDEO"] |Content preference type. e.g. -VIDEO -LIVE | ^eligible_flat_fee |bool |N |false |Creator is eligible for flat fee invitation, only available in US local seller | ^option_list |[]object |N | |Creator Marketplace Advanced Filter Option List. Please use "Get Seller Search Creator Marketplace Advanced Filters"(https://partner.tiktokshop.com/docv2/page/get-seller-search-creator-marketplace-advanced-filters) get available options for you first | ^^options |[]object |N | |Options in this option type | ^^^id |string |N |1 |Option id | ^^^name |string |N |English |Option name | ^^^option_children |[]object |N | |Children Option | ^^^^id |string |N |2 |Option id | ^^^^name |string |N |SubTypeName |Option name, used if the option has sub-type choices. | ^^option_type |string |N |OPTION_LANGUAGE |option type | ^sorter_algorithm_id |string |N |1 |Sorter algorithm id. Please use "Get Seller Search Creator Marketplace Advanced Filters"(https://partner.tiktokshop.com/docv2/page/get-seller-search-creator-marketplace-advanced-filters) get available sorter algorithm for you first. Default is 1(default sorter) | data_groups |[]string |N |["BASIC_CREATOR_INFORMATION","SALES_AND_GMV"] |Creator's Data Group, get all group by default, which include:
- BASIC_CREATOR_INFORMATION
- CONTENT_PERFORMANCE
- FOLLOWER_INFORMATION
- COLLABORATION
- SALES_AND_GMV |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/affiliate_seller/202608/marketplace_creators/search?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&page_token=b2Zmc2V0PTAK&page_size=12
Body
{"search_key":"2E+0EcXoSk2HWdEWh2nITfkBRMbwuug0mt9s3fWgV0k=","keyword":"JefreeStar","follower_demographics":{"age_ranges":["AGE_RANGE_18_24","AGE_RANGE_35_44"],"count_range":{"count_ge":1000,"count_le":10000},"gender_distribution":{"gender":"MALE","percentage_ge":6000}},"gmv_ranges":["GMV_RANGE_0_100","GMV_RANGE_100_1000"],"units_sold_ranges":["UNITS_SOLD_RANGE_0_10","UNITS_SOLD_RANGE_100_1000","UNITS_SOLD_RANGE_1000_AND_ABOVE"],"category":[{"parent_category_id":"600001","child_category_id_list":["851848"]}],"content_performance":{"avg_video_views":"1","avg_shoppable_video_views":"1","avg_engagement_rate":"1","avg_shopable_engagement_rate":"1","avg_live_avg_viewers_ge":"1","avg_shoppable_live_avg_viewers_ge":"1"},"affiliate_data":{"avg_commission_rate":"LESS_THAN_20%","post_rate":"GOOD","creator_agency_staus":"AGENCY_MANAGED","is_fast_growing":false,"not_invited_l90_days":false},"advanced_filters":{"content_preference_type":["VIDEO"],"eligible_flat_fee":false,"option_list":[{"options":[{"id":"1","name":"English","option_children":[{"id":"2","name":"SubTypeName"}]}],"option_type":"OPTION_LANGUAGE"}],"sorter_algorithm_id":"1"},"data_groups":["BASIC_CREATOR_INFORMATION","SALES_AND_GMV"]}
§8 Response Parameters
| Properties | Type | Sample | Properties description |
|---|---|---|---|
| code | int | 0 | The success or failure status code returned in API response. |
| message | string | Success | The success or failure messages returned in API response. Reasons of failure will be described in the message. |
| request_id | string | 202203070749000101890810281E8C70B7 | Request log |
| data | object | Specific return information | |
| ^next_page_token | string | b2Zmc2V0PTEw | Next page token |
| ^search_key | string | k1ChOzI9e+j5BHHHEnt+VhItjVFEkPUCCXNsrU8/v4U= | Caching search results improves api performance and ensures stable request results |
| ^creators | []object | Creator's basic information | |
| ^^username | string | abc | Creator's TikTok Username |
| ^^nickname | string | cde | Creator's TikTok Nickname |
| ^^avatar | object | Creator's profile picture | |
| ^^^url | string | https://p16-sign-useast2a.tiktokcdn.com/tos-useast2a-avt-0068-giso/2bf6a2485ec8bf93483e4a6ed907e6fd~c5_720x720.webp?lk3s=a5d48078\u0026x-expires=1712988000\u0026x-signature=E8US22KfUCwKz0R%2FMFF6%2FMOmogs%3D | URL of creator's avatar picture |
| ^^selection_region | string | GB | Regions where the creator operates and promotes products |
| ^^category_ids | []string | ["60001"] | It indicates the main product categories when the creator posts products. |
| ^^avg_ec_live_uv | int | 1331 | Average UV for creator's e-commerce live streams |
| ^^avg_ec_video_view_count | int | 112 | Average views for creator's e-commerce videos |
| ^^follower_count | int | 23241 | Follower count |
| ^^gmv | object | Creator GMV-related information | |
| If the creator does not authorize sharing precise data, this will be omitted. | |||
| ^^^currency | string | USD | Currency symbol |
| ^^^amount | string | 1232.90 | GMV value |
| ^^live_gmv | object | Live stream GMV | |
| If the creator does not authorize sharing precise data, this will be omitted. | |||
| ^^^currency | string | USD | Currency symbol |
| ^^^amount | string | 0.34 | Live stream GMV value |
| ^^video_gmv | object | Video GMV-related information | |
| If the creator does not authorize sharing precise data, this will be omitted. | |||
| ^^^currency | string | USD | Currency symbol |
| ^^^amount | string | 23.34 | Video GMV value |
| ^^gmv_range | object | GMV range. | |
| Applicable if the target market is the US and the creator does not authorize sharing precise data. | |||
| ^^^currency | string | USD | Currency symbol |
| ^^^minimum_amount | string | 1.00 | The minimum value of GMV range |
| ^^^maximum_amount | string | 100.34 | The maximum value of GMV range |
| ^^^formatted_range | string | $0-$100 | The formatted range of GMV values associated with this creator. |
| ^^units_sold_range | object | The range of minimum number of units sold to maximum number of units sold over the lifetime of the creator account. Note that this property is included if the target market is US only. Note that if the creator has not given permission for precise data sharing, these properties will not be present. | |
| ^^^minimum_amount | int | 100 | The minimum value of sales volume range |
| ^^^maximum_amount | int | 1000 | The maximum value of sales volume range |
| ^^^formatted_range | string | $0-$100 | The formatted range of minimum number of units sold to maximum number of units sold over the lifetime of the creator account. |
| ^^top_follower_demographics | object | Top follower information of the creator | |
| ^^^age_ranges | []string | [ "AGE_RANGE_18_24", "AGE_RANGE_25_34"] | Return the top 3 age ranges of the followers. Ranges are : |
| AGE_RANGE_18_24: "18-24", | |||
| AGE_RANGE_25_34: "25-34", | |||
| AGE_RANGE_35_44: "35-44", | |||
| AGE_RANGE_45_54: "45-54", | |||
| AGE_RANGE_55_AND_ABOVE: "55+" | |||
| ^^^major_gender | object | Major gender of the followers | |
| ^^^^gender | string | FEMALE | Top follower gender category of the creator, "MALE" or "FEMALE" |
| ^^^^percentage | int | 6524 | Percentage of top follower gender, scaled up by 10,000 times. |
| For example, 6524 stands for 0.6524 or 65.24%. You can then infer that the opposite gender would be 0.3476 or 34.76%. | |||
| ^^creator_open_id | string | uACafQAAAABmUU2qon4R0vUYvUVS3QC6CICP2m5A2-wd77j8R9G0yg | Creator Open ID. More details |
| ^^creator_profile | object | Advanced creator profile infomation. If we return an empty object, it means this filter is not currently supported by your account or region. | |
| ^^^is_official_recommend | bool | false | Creator has official recommend tag or not |
| ^^^creator_bind_mcn_name | string | name | Creator bind MCN name |
| ^^^is_fast_growing | bool | false | Creator has fast growing tag or not |
| ^^^has_collaborated | bool | false | Has collaborated with this creator or not |
| ^^^user_type_tag | []int | [1] | User type tag. |
| -1 privacy creator | |||
| -2 carve out creator | |||
| ^^^has_invited_90d | bool | false | Has invited creaor before 90 days |
| ^^^is_creator_blocked | bool | false | Is this creator blocked by shop or not |
| ^^^pps_score | string | 4.3 | Creator promotion performance score(PPS).The score reflects the quality of a creator's shoppable content and product selection over the past 30 days. A high score may indicate a better shopping experience, with fewer potential refunds or negative reviews. e.g. 4.3/5.0 |
| ^^^is_eligible_flat_fee | bool | false | Is creator eligible for flat fee, only available for US local seller |
| ^^^is_rising_star | bool | false | Creator has rising star tag or not |
| ^^^creator_level | int | 2 | Creator level |
§9 Response Sample
{"code":0,"data":{"next_page_token":"b2Zmc2V0PTEw","search_key":"k1ChOzI9e+j5BHHHEnt+VhItjVFEkPUCCXNsrU8/v4U=","creators":[{"username":"abc","nickname":"cde","avatar":{"url":"https://p16-sign-useast2a.tiktokcdn.com/tos-useast2a-avt-0068-giso/2bf6a2485ec8bf93483e4a6ed907e6fd~c5_720x720.webp?lk3s=a5d48078\\u0026x-expires=1712988000\\u0026x-signature=E8US22KfUCwKz0R%2FMFF6%2FMOmogs%3D"},"selection_region":"GB","category_ids":["60001"],"avg_ec_live_uv":1331,"avg_ec_video_view_count":112,"follower_count":23241,"gmv":{"currency":"USD","amount":"1232.90"},"live_gmv":{"currency":"USD","amount":"0.34"},"video_gmv":{"currency":"USD","amount":"23.34"},"gmv_range":{"currency":"USD","minimum_amount":"1.00","maximum_amount":"100.34","formatted_range":"$0-$100"},"units_sold_range":{"minimum_amount":100,"maximum_amount":1000,"formatted_range":"$0-$100"},"top_follower_demographics":{"age_ranges":["AGE_RANGE_18_24","AGE_RANGE_25_34"],"major_gender":{"gender":"FEMALE","percentage":6524}},"creator_open_id":"uACafQAAAABmUU2qon4R0vUYvUVS3QC6CICP2m5A2-wd77j8R9G0yg","creator_profile":{"is_official_recommend":false,"creator_bind_mcn_name":"name","is_fast_growing":false,"has_collaborated":false,"user_type_tag":[1],"has_invited_90d":false,"is_creator_blocked":false,"pps_score":"4.3","is_eligible_flat_fee":false,"is_rising_star":false,"creator_level":2}}]},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}
§10 Error Code
For common error codes, refer to How to call TikTok Shop APIs - Common Error Code
| Code | Message |
|---|---|
| 45101004 | The query quota has been reached (10000 request per day). Please try again tomorrow. |
| 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |
