v2.ams.get_targeted_campaign_settings

GET /api/v2/ams/get_targeted_campaign_settings

For each campaign, return: campaign basic info (name, status, promotion period, message), selected product list (with tên sản phẩm & ID), selected danh sách đơn vị liên kết (with tên đơn vị liên kếts)

Đường dẫn Endpoint

URL: https://partner.shopeemobile.com/api/v2/ams/get_targeted_campaign_settings

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_id	int64	True	101	Campaign id for query. Note: For campaigns with campaign_source = ShopeeManaged, cannot be queried for details through this API.

Tham số Response

Tên	Kiểu	Mẫu	Mô tả
error	string	error_business	Loại lỗi nếu có lỗi xảy ra. Trống nếu không có lỗi.
message	string	Please agree to the AMS T&C in Seller Center - Affiliate Marketing Solutions first before using Open API.	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		Detail informations you are querying.
campaign_name	string	campaign name	Tên của the current campaign.
commission_status	string	Ongoing	Campaign Status: Upcoming Ongoing Ended Cancelled Draft Terminating Terminated Paused
period_start_time	timestamp	1735660800	The start time of the current campaign.
period_end_time	timestamp	32503651199	The end time of the current campaign, if get 32503651199 (2999-12-31 23:59:59), it means no limit.
is_set_budget	boolean	true	Has the current campaign set a budget. Note: TH not supported
budget	float	10000.0	The budget of the current campaign. Note: TH not supported
budget_cost	float	500.5	The budget already spent on the current campaign. Note: TH not supported
seller_message	string	Hello, pleasant cooperation.	The message displayed to affiliates.
pending_terminated_time	timestamp	1735660800	Pending Terminated Time.
affiliate_list	object[]		The danh sách affiliates associated with the current campaign.
affiliate_id	int64	11301234567	The unique key for affiliate, can call v2.ams.query_affiliate_list to get affiliate details.
item_list	object[]		The danh sách items associated with the current campaign.
item_id	int64	101	ID sản phẩm.
item_name	string	item a	Tên sản phẩm.
rate	float	1.1	Tỷ lệ hoa hồng of current item, 1.1 means 1.1%, support two decimal places.
max_commission_rate_current_day	float	1.1	Max Commission Rate Current Day, 1.1 means 1.1%, support two decimal places.
commission_protection_list	object[]		Commission Protection List.
commission_rate	float	1.1	Commission Rate, 1.1 means 1.1%, support two decimal places.
protection_period_end_time	timestamp	1735660800	Protection Period End Time.

Unirest.setTimeouts(0, 0); HttpResponse<String> response = Unirest.get("https://partner.shopeemobile.com/api/v2/ams/get\_targeted\_campaign\_settings?access\_token=access\_token&campaign\_id=101&partner\_id=partner\_id&shop\_id=shop\_id&sign=sign&timestamp=timestamp") .asString();<?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/ams/get\_targeted\_campaign\_settings?access\_token=access\_token&campaign\_id=101&partner\_id=partner\_id&shop\_id=shop\_id&sign=sign&timestamp=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 => 'GET', CURLOPT_HTTPHEADER => array( 'Content-Type: application/json' ), )); $response = curl_exec($curl); curl_close($curl); echo $response; curl --location --request GET 'https://partner.shopeemobile.com/api/v2/ams/get\_targeted\_campaign\_settings?access\_token=access\_token&campaign\_id=101&partner\_id=partner\_id&shop\_id=shop\_id&sign=sign&timestamp=timestamp' import requests url = "https://partner.shopeemobile.com/api/v2/ams/get\_targeted\_campaign\_settings?access\_token=access\_token&campaign\_id=101&partner\_id=partner\_id&shop\_id=shop\_id&sign=sign&timestamp=timestamp" payload={} headers = { } response = requests.RPCRequest("GET",url,headers=headers, data=payload, allow_redirects=False) print(response.text)

], "item_list": [ { "item_id": 101, "item_name": "item a", "rate": 1.1, "max_commission_rate_current_day": 1.1, "commission_protection_list": [ { "commission_rate": 1.1, "protection_period_end_time": 1735660800 } ] } ] } }