v2.ams.get_targeted_campaign_list

GET /api/v2/ams/get_targeted_campaign_list

Retrieve all current chiến dịch mục tiêus created by the seller

Đường dẫn Endpoint

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

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ả
page_size	int32	True	20	Each result set is returned as a page of entries. Use the "page_size" filters to control the tối đa number of entries to retrieve per page (i.e., per call), and the "page_no" to start next call. This integer value is used to specify the tối đa number of entries to return in a single "page" of data. The limit of page_size if between 1 and 100.
page_no	int32	True	1	Chỉ định số trang dữ liệu cần trả về in the current call. Starting from 1. if data is more than one page, the page_no can be some entry to start next call.
campaign_id_list	string	False	101,102,103	The danh sách campaign_id for query, different ID chiến dịch should be split by comma and at most 50 campaigns.
campaign_name	string	False	campaign a	Tên chiến dịch for query.
campaign_status	string	False	Upcoming	Trạng thái chiến dịch for query. Các giá trị áp dụng: Upcoming Ongoing Ended Cancelled Draft Terminating Terminated Paused
period_start_time	timestamp	False	1735660800	Campaign thời gian bắt đầu kỳ for query.
period_end_time	timestamp	False	32503651199	Campaign thời gian kết thúc kỳ for query.
item_id	int64	False	101	ID sản phẩm for query.
item_name	string	False	product a	Tên sản phẩm for query.

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.
total_count	int32	30	Tổng số chiến dịch mục tiêus that meet the query criteria.
commission_list	object[]		Chiến dịch mục tiêu list.
campaign_id	int64	101	The unique key for the current campaign.
campaign_name	string	campaign a	Tên của the current campaign.
campaign_status	string	Ongoing	Campaign Status: Upcoming Ongoing Ended Cancelled Draft Terminating Terminated Paused
campaign_source	string	Seller	Source of campaign setup. Các giá trị áp dụng:  - ShopeeManaged (Note: You cannot view the details or edit this campaign. If you try to do so, an 'invalid campaign_id' error will occur.) - Seller - Unknown
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
last_editor	string	example@example.com	The last editor of the current campaign.
last_edit_time	timestamp	1735660800	The last edit time of the current campaign.
affiliate_count	int32	20	Tổng số affiliates associated with the current campaign.
item_count	int32	20	Tổng số items associated with the current campaign.
min_rate	float	10.0	The min tỷ lệ hoa hồng of the current campaign.
max_rate	float	25.0	The max tỷ lệ hoa hồng of the current campaign.

Unirest.setTimeouts(0, 0); HttpResponse<String> response = Unirest.get("https://partner.shopeemobile.com/api/v2/ams/get\_targeted\_campaign\_list?access\_token=access\_token&campaign\_id\_list=101%2C102%2C103&campaign\_name=campaign+a&campaign\_status=Upcoming&item\_id=101&item\_name=product+a&page\_no=1&page\_size=20&partner\_id=partner\_id&period\_end\_time=32503651199&period\_start\_time=1735660800&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\_list?access\_token=access\_token&campaign\_id\_list=101%2C102%2C103&campaign\_name=campaign+a&campaign\_status=Upcoming&item\_id=101&item\_name=product+a&page\_no=1&page\_size=20&partner\_id=partner\_id&period\_end\_time=32503651199&period\_start\_time=1735660800&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\_list?access\_token=access\_token&campaign\_id\_list=101%2C102%2C103&campaign\_name=campaign+a&campaign\_status=Upcoming&item\_id=101&item\_name=product+a&page\_no=1&page\_size=20&partner\_id=partner\_id&period\_end\_time=32503651199&period\_start\_time=1735660800&shop\_id=shop\_id&sign=sign&timestamp=timestamp' import requests url = "https://partner.shopeemobile.com/api/v2/ams/get\_targeted\_campaign\_list?access\_token=access\_token&campaign\_id\_list=101%2C102%2C103&campaign\_name=campaign+a&campaign\_status=Upcoming&item\_id=101&item\_name=product+a&page\_no=1&page\_size=20&partner\_id=partner\_id&period\_end\_time=32503651199&period\_start\_time=1735660800&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)

] } }