v2.ams.create_new_targeted_campaign
POST /api/v2/ams/create_new_targeted_campaign
Create a new campaign with custom product & affiliate selections, and basic info filling.
Đường dẫn Endpoint
URL: https://partner.shopeemobile.com/api/v2/ams/create_new_targeted_campaign
Tham số chung
| Tên | Kiểu | Mẫu | Mô tả |
|---|---|---|---|
| partner_id | int | 1 | Partner ID được gán khi đăng ký thành công. Bắt buộc cho tất cả các yêu cầu. |
| timestamp | timestamp | 1610000000 | Dùng để chỉ định thời gian của yêu cầu. Bắt buộc cho tất cả các yêu cầu. Hết hạn sau 5 phút. |
| access_token | string | c09222e3fc40ffb25fc947f738b1abf1 | Token truy cập API, dùng để xác định quyền của bạn đối với API. Có thể sử dụng nhiều lần và hết hạn sau 4 giờ. |
| shop_id | int | 600000 | Mã định danh duy nhất của Shopee cho một cửa hàng. Tham số bắt buộc cho hầu hết các API. |
| 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 |
Tham số Request
| Tên | Kiểu | Bắt buộc | Mẫu | Mô tả |
|---|---|---|---|---|
| campaign_name | string | True | CAMPAIGN_NAME | Tên của the current campaign. |
| period_start_time | timestamp | True | 1735660800 | Thời gian bắt đầu kỳ of campaign, tính bằng giây. |
| period_end_time | timestamp | True | 32503651199 | Thời gian kết thúc kỳ of campaign, tính bằng giây. Can set 32503651199 (2999-12-31 23:59:59) represent of no limit. |
| is_set_budget | boolean | False | true | Budget allocation toggle for the current campaign. Note: TH not supported |
| budget | float | False | 500000.0 | Budget value set for the current campaign. Note: TH not supported |
| seller_message | string | True | Hello, pleasant cooperation. | The message displayed to affiliates. |
| item_list | object[] | True | The danh sách items associated with the current campaign. | |
| item_id | int64 | True | 101 | ID sản phẩm. |
| rate | float | True | 1.1 | Tỷ lệ hoa hồng of current item, 1.1 means 1.1%, support two decimal places. |
| affiliate_list | object[] | True | The danh sách affiliates associated with the current campaign. | |
| affiliate_id | int64 | True | 11301234567 | The unique key for affiliate. |
Tham số Response
| Tên | Kiểu | Mẫu | Mô tả |
|---|---|---|---|
| error | string | Loại lỗi nếu có lỗi xảy ra. Trống nếu không có lỗi. | |
| message | string | Chi tiết lỗi nếu có lỗi xảy ra. Trống nếu không có lỗi. | |
| request_id | string | b937c04e554847789cbf3fe33a0ad5f1 | Mã định danh của yêu cầu API dùng để theo dõi lỗi. |
| response | object | Successful elements will not be returned. If error and message are not empty, it means that all settings have failed. If error and message are empty, but fail_xx_list has content, it means that the element in the fail_xx_list setting failed and the rest were successful. If error, message, fail_xx_list are all empty, it means that all settings are successful. | |
| campaign_id | int64 | 101 | The unique key for campaign. |
| fail_item_list | object[] | Failed Item List. | |
| item_id | int64 | 101 | ID sản phẩm. |
| fail_error | string | test_error | Fail error. |
| fail_message | string | test_message | Fail message. |
| fail_affiliate_list | object[] | Fail Affiliate List. | |
| affiliate_id | int64 | 11301234567 | ID đơn vị liên kết. |
| fail_error | string | test_error | Fail error. |
| fail_message | string | test_message | Fail message. |
Dữ liệu gửi
],
"affiliate_list": [
{
"affiliate_id": 11301234567
}
]
}Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.post("https://partner.shopeemobile.com/api/v2/ams/create\_new\_targeted\_campaign?access\_token=access\_token&partner\_id=partner\_id&shop\_id=shop\_id&sign=sign×tamp=timestamp")
.header("Content-Type","application/json")
.body("{
"affiliate_list": [
{
"affiliate_id": 11301234567
}
],
"budget": 500000,
"campaign_name": "CAMPAIGN_NAME",
"is_set_budget": true,
"item_list": [
{
"item_id": 101,
"rate": 1.1
}
],
"period_end_time": 32503651199,
"period_start_time": 1735660800,
"seller_message": "Hello, pleasant cooperation."
}")
.asString();<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/ams/create\_new\_targeted\_campaign?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 => '{
"affiliate_list": [
{
"affiliate_id": 11301234567
}
],
"budget": 500000,
"campaign_name": "CAMPAIGN_NAME",
"is_set_budget": true,
"item_list": [
{
"item_id": 101,
"rate": 1.1
}
],
"period_end_time": 32503651199,
"period_start_time": 1735660800,
"seller_message": "Hello, pleasant cooperation."
}',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
curl --location --request POST 'https://partner.shopeemobile.com/api/v2/ams/create\_new\_targeted\_campaign?access\_token=access\_token&partner\_id=partner\_id&shop\_id=shop\_id&sign=sign×tamp=timestamp'
--header 'Content-Type: application/json'
--data-raw '{
"affiliate_list": [
{
"affiliate_id": 11301234567
}
],
"budget": 500000,
"campaign_name": "CAMPAIGN_NAME",
"is_set_budget": true,
"item_list": [
{
"item_id": 101,
"rate": 1.1
}
],
"period_end_time": 32503651199,
"period_start_time": 1735660800,
"seller_message": "Hello, pleasant cooperation."
}'
import requests
import json
url = "https://partner.shopeemobile.com/api/v2/ams/create\_new\_targeted\_campaign?access\_token=access\_token&partner\_id=partner\_id&shop\_id=shop\_id&sign=sign×tamp=timestamp"
payload=json.dumps({
"affiliate_list": [
{
"affiliate_id": 11301234567
}
],
"budget": 500000,
"campaign_name": "CAMPAIGN_NAME",
"is_set_budget": True,
"item_list": [
{
"item_id": 101,
"rate": 1.1
}
],
"period_end_time": 32503651199,
"period_start_time": 1735660800,
"seller_message": "Hello, pleasant cooperation."
})
headers = {
'Content-Type': 'application/json'
}
response = requests.RPCRequest("POST",url,headers=headers, data=payload, allow_redirects=False)
print(response.text)
}
], "fail_affiliate_list": [ { "affiliate_id": 11301234567, "fail_error": "test_error", "fail_message": "test_message" } ] } }