stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 Path: /product/202505/images/translation_tasks
#§2 Method: [POST]
#§3 Function Description
Initiates a translation task for one or more images. This asynchronous API queues the images for processing in the specified target language. Applicable only for sellers that sell across EU. Use the Image Translation Completed webhook to monitor the translation progress, or pass the task ID to the Get Image Translation Tasks API to retrieve the status and the translated images. Note:
- Please wait 5 minutes after task creation before calling the Get endpoint, and retry at intervals over 10 seconds to avoid rate limiting.
- Each task corresponds to the translation of 1 image into 1 target language.
- You can create up to 20 tasks per call and 500 tasks per day. Any tasks beyond the daily limit will be rejected.
§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. |
§6 Request Body Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| images | []object | Y | The list of images to translate. | |
| Use the Upload Product Image API to upload the images first and obtain the corresponding image URIs. | ||||
| Note: The total number of image and target language combinations must not exceed 20. For example, you can submit 10 images with 2 target languages each, but you can't submit 10 images with 5 target languages each. | ||||
| ^image_uri | string | Y | tos-useast2a-i-tulkllf4y5-euttp/748e39ecff38453ab8396a36a53dbb92 | The URI of the image, retrieved from the Upload Product Image API |
| Recommendation: Specify up to 5 images to avoid exceeding the task limit per call. | ||||
| ^target_languages | []string | Y | ["it-IT", "fr-FR"] | The target languages to translate the image into. You can specify multiple target languages for each image. |
Possible values:
cs-CZda-DKde-ATde-BEde-DEel-GRen-GBen-IEes-ESfi-FIfr-FRfr-BEhu-HUit-ITnl-NLnl-BEpl-PLpt-PTsv-SERecommendation: Specify up to 20 languages to avoid exceeding the task limit per call. |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/product/202505/images/translation_tasks?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY
Body
{"images":[{"image_uri":"tos-useast2a-i-tulkllf4y5-euttp/748e39ecff38453ab8396a36a53dbb92","target_languages":["it-IT","fr-FR"]}]}
§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 | |
| ^translation_tasks | []object | The list of translation tasks created for the requested images. | |
| Each task corresponds to the translation of 1 image into 1 target language. So if you specified 2 target languages for an image, 2 tasks will be created. | |||
| ^^image_uri | string | tos-useast2a-i-tulkllf4y5-euttp/748e39ecff38453ab8396a36a53dbb92 | The URI of the image to translate. |
| ^^target_language | string | it-IT | The target languages to translate the image into. You can specify multiple target languages for each image. |
Possible values:
- de-DE
- en-IE
- es-ES
- fr-FR
- it-IT | ^^id |string |764c6e87eedcea90399a0dafcd572b71 |The ID to identify the image translation task. Pass this ID to the Get Image Translation Tasks API to retrieve the task status and the translated image URIs. |
§9 Response Sample
{"code":0,"data":{"translation_tasks":[{"image_uri":"tos-useast2a-i-tulkllf4y5-euttp/748e39ecff38453ab8396a36a53dbb92","target_language":"it-IT","id":"764c6e87eedcea90399a0dafcd572b71"}]},"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 |
|---|---|
| 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |
| 12038008 | The image URI is invalid. Please use the URI generated by the Upload Product Image API. |
| 12038009 | The specified target_language is invalid or unsupported. |
| 12038010 | The number of translation task IDs exceeded the limit of 20. |
| 12038012 | Exceeded the daily limit of 500 translation tasks. |
| 12038013 | This operation is not available for this shop. |
