stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /affiliate_partner/202405/campaigns
#§2 Method: [GET]
#§3 Function Description
This API offers the ability to list campaigns created by the Affiliate Partner.
§4 Common Parameters
For common parameters, refer to How to call TikTok Shop APIs - Common Parameters
| Properties | Location | Type | Require | Sample | Properties description |
|---|---|---|---|---|---|
| content-type | header | string | Y | application/json | Allowed type: application/json |
| category_asset_cipher | query | string | Y | GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3 | The partner identifier used in API requests. Retrieve this value by using the Get Authorized Category Assets API. |
§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. |
| category_asset_cipher | string | Y | GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3 | The partner identifier used in API requests. Retrieve this value by using the Get Authorized Category Assets API. |
| page_size | int | Y | 10 | The number of results to be returned per page. Default: 10. Valid range: [1-100]. |
| page_token | string | N | b2Zmc2V0PTAK | An opaque token used to retrieve the next page of a paginated result set. Retrieve this value from the result of the next_page_token from a previous response. It is not needed for the first page. Maximum page size is 100 items. |
| status | string | N | READY | This parameter is required. |
| The campaign status. The status is an enumerated type with values: |
READYUPCOMINGONGOINGCLOSEDUNSPECIFIED| type |string |N |MY_CAMPAIGNS |The campaign type. This is an enumerated type with values:- MY_CAMPAIGNS
- GS_SELLING_CAMPAIGNS
- SELLER_CAMPAIGNS
- EXCLUSIVE_TIKTOK_SHOP Default value is MY_CAMPAIGNS. | query_type_filter |string |N |DEFAULT |An extended filter to be used when the campaign type property type is set to SELLER_CAMPAIGNS or EXCLUSIVE_TIKTOK_SHOP. If the type property is set to SELLER_CAMPAIGNS, the valid values for this property are:
- MARKETPLACE: the response includes campaigns that the partner did not join.
- JOINED : the response includes campaigns the partner has joined only. If the type property is set to EXCLUSIVE_TIKTOK_SHOP, the valid values for this property are:
- AVAILABLE: the response includes campaigns the partner is permitted to join.
- JOINED: the response includes campaigns the partner has joined only. Other types can either not pass a value or pass in Default. |
§6 Request Sample
Query
https://open-api.tiktokglobalshop.com/affiliate_partner/202405/campaigns?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&category_asset_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&page_size=10&page_token=b2Zmc2V0PTAK&status=READY&type=MY_CAMPAIGNS&query_type_filter=DEFAULT
§7 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 | |
| ^campaigns | []object | A list of campaigns. | |
| ^^id | string | 7360590375814268715 | The campaign identifier. |
| ^^name | string | test | The campaign name. |
| ^^status | string | READY | The campaign status. The status is an enumerated type with values: |
- READY
- UPCOMING
- ONGOING
- CLOSED | ^^registration_start_time |int |1712941200 |The scheduled start time in Unix epoch format for seller product registration. Note that this field can be updated when the campaign status is set to
READYorUPCOMINGonly. | ^^registration_end_time |int |1713891599 |The scheduled end time in Unix epoch time format for seller product registration. This field is no longer editable when the campaign status is set toCLOSED. | ^^campaign_start_time |int |1712941200 |The scheduled start time in Unix epoch time format for the campaign. Note that this field can be updated when the campaign status is set toREADYorUPCOMINGonly. | ^^campaign_end_time |int |1715878799 |The scheduled end time in Unix epoch time format for the campaign. Note that the end time must be less than 360 days from the start date. This field is no longer editable when the campaign status is set toCLOSED. | ^next_page_token |string |absdfV231as2V0PTAK |An opaque token used to retrieve the next page of a paginated result set. | ^total_count |int |1570 |The total number of campaigns in the list. |
§8 Response Sample
{"code":0,"data":{"campaigns":[{"id":"7360590375814268715","name":"test","status":"READY","registration_start_time":1712941200,"registration_end_time":1713891599,"campaign_start_time":1712941200,"campaign_end_time":1715878799}],"next_page_token":"absdfV231as2V0PTAK","total_count":1570},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}
§9 Error Code
For common error codes, refer to How to call TikTok Shop APIs - Common Error Code
| Code | Message |
|---|---|
| 16032001 | nvalid parameter Creator and Seller, please ensure Region mismatch. |
| 16032007 | Permission denied |
| 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |