stable本次发布有变化全部展示
来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 (coming offline soon) v2.ads.create_auto_product_ads
Use this API to create Auto Product Ads
§2 Overview
Overview
| Field | Value |
|---|---|
| Module | Ads |
| API type | Shop |
| HTTP method | POST |
| Path | /api/v2/ads/create_auto_product_ads |
| Production URL | https://partner.shopeemobile.com/api/v2/ads/create_auto_product_ads |
| Sandbox URL | https://partner.test-stable.shopeemobile.com/api/v2/ads/create_auto_product_ads |
| Permission | Seller In House System; Marketing; Ads Service; Ads Service App ; Ads Facil |
§3 Request parameters
Request parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| reference_id | string | Yes | asdf-1234-qwerty | A random string used to prevent duplicate ads. If an ads is created successfully, subsequent request using the same reference id will fail |
| budget | float | Yes | 10.50 | The budget set for the Auto Product Ads |
| start_date | string | Yes | 11-11-2023 | the start date per campaign. please kindly note that if you want to set unlimited date, you can just pass today's date as the start date |
| end_date | string | No | the end date of each campaign. please kindly note that if you want to set an unlimited campaign, you can keep empty for the end date field |
§4 Response parameters
Response parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| error | string | Error code, empty when no error returned | ||
| message | string | error description | ||
| warning | string | If some data cannot respond normally, set the warning | ||
| request_id | string | 6f235f4a343e4feb8a9ed74c439f6663 | request id is unique for each request | |
| response | object[] | response body | ||
| response.campaign_id | int64 | 123 | The unique identifier for a campaign |
§5 Common parameters
Common parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| partner_id | int | 1 | Partner ID is assigned upon registration is successful. Required for all requests. | |
| timestamp | timestamp | 1610000000 | This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes. | |
| access_token | string | c09222e3fc40ffb25fc947f738b1abf1 | The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours. | |
| shop_id | int | 600000 | Shopee's unique identifier for a shop. Required param for most APIs. | |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Signature generated by partner_id, api path, timestamp, access_token, shop_id and partner_key via HMAC-SHA256 hashing algorithm. More details: https://open.shopee.com/documents?module=87&type=2&id=58&version=2 |
§6 Request samples
Request samples
§7 Payload
Payload
{
"reference_id": "asdf-1234-qwerty",
"budget": 10.5,
"start_date": "11-11-2023",
"end_date": ""
}
§8 Java
Java
Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.post("https://partner.test.shopeemobile.com/api/v2/ads/create_auto_product_ads?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign×tamp=timestamp")
.header("Content-Type","application/json")
.body("{
\"budget\": 10.5,
\"end_date\": \"-\",
\"reference_id\": \"asdf-1234-qwerty\",
\"start_date\": \"11-11-2023\"
}")
.asString();
§9 PHP
PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://partner.test.shopeemobile.com/api/v2/ads/create_auto_product_ads?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign×tamp=timestamp',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => '{
"budget": 10.5,
"end_date": "-",
"reference_id": "asdf-1234-qwerty",
"start_date": "11-11-2023"
}',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
§10 cURL
cURL
curl --location --request POST 'https://partner.test.shopeemobile.com/api/v2/ads/create_auto_product_ads?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign×tamp=timestamp' \
--header 'Content-Type: application/json' \
--data-raw '{
"budget": 10.5,
"end_date": "-",
"reference_id": "asdf-1234-qwerty",
"start_date": "11-11-2023"
}'
§11 Python
Python
import requests
import json
url = "https://partner.test.shopeemobile.com/api/v2/ads/create_auto_product_ads?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign×tamp=timestamp"
payload=json.dumps({
"budget": 10.5,
"end_date": "-",
"reference_id": "asdf-1234-qwerty",
"start_date": "11-11-2023"
})
headers = {
'Content-Type': 'application/json'
}
response = requests.RPCRequest("POST",url,headers=headers, data=payload, allow_redirects=False)
print(response.text)
§12 Response sample
Response sample
§13 JSON
JSON
{
"error": "",
"message": "",
"warning": "",
"request_id": "6f235f4a343e4feb8a9ed74c439f6663",
"response": [
{
"campaign_id": 123
}
]
}
§14 Errors
Errors
| Error | Description | Solution |
|---|---|---|
| ads.account.status_not_normal | Account status is not normal. | |
| ads.auto_product.no_eligible_sku | No eligible SKU for auto product ads. | |
| ads.shop.campaign_not_match | Invalid campaign ID for this shop. | |
| ads.campaign.error_daily_budget_range | The budget set is invalid. | |
| ads.campaign.error_date_setting | The start/end date of campaign should be larger or equal to today. End date to be empty for unlimited duration. | |
| error_not_found | The information you queried is not found. | |
| error_param | Wrong parameters. | |
| error_server | Something wrong. Please try later. | |
| ads.auto_product.existing_ad | Auto Product Ads (campaign id) is existing, please edit the existing one. | |
| ads.api.http_method_not_allowed | Only the supported HTTP method for the API is allowed. | |
| ads.ads_account.invalid_status | Ads account status is Invalid. | |
| ads.item.invalid_status | Item status is invalid. | |
| ads.campaign.invalid_start_date | The start date has to be today for no end date (unlimited duration). | |
| ads.item.blocked_for_promotion | Item is blocked for promotion. | |
| ads.item.sold_out | Item is sold out. | |
| ads.auto_product.not_whitelisted | This shop (shop id) isn't eligible to set up auto product ads. | |
| ads.rate_limit.campaign_level | Too many requests at the moment, please try again later. | |
| ads.rate_limit.exceed_partner_api | Too many requests, please reduce the request rate and try again later. | |
| ads.rate_limit.exceed_shop_api | Too many requests for the shop at the moment, please try again later. | |
| ads.rate_limit.exceed_api | Too many requests at the moment, please try again later. | |
| ads.shop.in_holiday_mode | Shop is in holiday mode. | |
| ads.shop.status_not_normal | Shop status is not normal. | |
| error_data | parse data failed | |
| error_data | data not exist | |
| error_param | parameter invalid | |
| error_param | The information you queried is not found. | |
| error_param | Wrong parameters, detail: {msg}. | |
| error_server | Something wrong. Please try later. | |
| error_shop | shopid is invalid | |
| error_param | request not from gateway |
§15 Common errors
Common errors
| Error | Description | Solution |
|---|---|---|
| error_auth | partner_id is invalid | |
| error_auth | The App is deleted, and you'll be unable to make any API call. | |
| error_auth | App developer’s permissions for authorizations have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details. | |
| error_param | There is no partner_id in query. | |
| error_param | Invalid partner_id. | |
| error_param | no timestamp | |
| error_param | Invalid timestamp | |
| error_param | There is no sign in query. | |
| error_sign | Wrong sign. | |
| invalid_partner_id | Invalid partner_id, please have a check. | |
| error_auth | No permission to current api. | |
| error_api_call_restricted | The App permission for api call have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details. | |
| api_suspended | The API is offline. Please call v2 API instead. | |
| error_limit | The total API call number made by your APP has reached the daily API call limit, please try again after 00: 00 (UTC+08:00) | |
| error_rate_limit | Too many requests. You have reached the rate limit. Please try again later. | |
| source_ip_undeclared | Request Source IP ({ip}) is undeclared. Please declare all your IP addresses in the Shopee Open Platform Console > App list > IP Address Whitelist | |
| error_param | Permission denied. This API is currently offline or the request path is incorrect. | |
| error_param | Partner_id is invalid, should be an integer between 0 and 4294967295. | |
| error_param | no timestamp. | |
| error_param | Timestamp is invalid, should be an integer between 0 and 4294967295. | |
| error_param | Timestamp is expired. | |
| error_partner_key_expired | Your API partner key has expired, please reset the Live API Partner Key in Console to get a new valid partner key to call open api. | |
| error_api_permission | This app type has no permission to this API. | |
| error_param | There is no access_token in query. | |
| error_auth | Invalid access_token. | |
| error_auth | Invalid partner_id or shopid. | |
| shop_no_linked | Partner and shop has no linked. | |
| shop_banned | The shop account has been banned. Permissions for shop authorization and API calls have been suspended until the shop account is restored. | |
| invalid_acceess_token | Invalid access_token, please have a check. | |
| partner_shop_no_link | Invalid partner_id or shop_id, please have a check. | |
| error_ashop_api_permission | The shop is Affiliate shop has no permission to call this API. | |
| error_kyc_auth | No permission. Please inform the seller to complete the Seller Registration on Shopee Seller Center first, then this shop can call for this API. | |
| error_auth | System error, please try again later. | |
| error_param | There is no shop_id in query. | |
| error_param | shop_id is invalid, should be an integer between 0 and 4294967295. |
§16 Update log
Update log
| Date | Change |
|---|---|
| 2024-07-17 | New API |
