v2.ads.get_product_level_campaign_setting_info

stable本次发布有变化全部展示

来自 Shopee 官方资料快照 · 2026-09-06 12:10:52

打开官方原文 ↗

当前资料结构化阅读页
固定快照已留存，可追溯
官方原文可核对

查看技术与溯源信息

平台 / profile: Shopee / profile.shopee.api_reference
语言: en-US
发布版本: cn-20260909-2
标签: zhuge/sourceplatform/shopeeaudience/developercategory/api_doctopic/apitopic/developer

资料正文

§1 v2.ads.get_product_level_campaign_setting_info

Call this API to fetch all the campaign setting info under this Shop.

§2 Overview

Overview

Field	Value
Module	Ads
API type	Shop
HTTP method	GET
Path	/api/v2/ads/get_product_level_campaign_setting_info
Production URL	https://partner.shopeemobile.com/api/v2/ads/get_product_level_campaign_setting_info
Sandbox URL	https://partner.test-stable.shopeemobile.com/api/v2/ads/get_product_level_campaign_setting_info
Permission	Seller In House System; Marketing; Ads Service; Ads Service App ; Ads Facil

§3 Request parameters

Request parameters

Name	Type	Required	Sample	Description
info_type_list	string	Yes	1,2,3,4	Info type values: 1.Common Info 2.Manual Bidding Info 3.Auto Bidding Info 4.Auto Product Ads Info
campaign_id_list	string	Yes	11111,22222,33333	list of campaign ids comma separated (max 100 campaign ids)

§4 Response parameters

Response parameters

Name	Type	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.shop_id	int64	121212	Shopee's unique identifier for a shop.
response.region	string	SG	Region the shop belongs to
response.campaign_list	object[]		-
response.campaign_list.campaign_id	int64	11111	The unique ID per campaign
response.campaign_list.common_info	object		common_info body
response.campaign_list.common_info.ad_type	string	auto	auto, manual
response.campaign_list.common_info.ad_name	string	name	the name of each ad
response.campaign_list.common_info.campaign_status	string	ongoing	ongoing, scheduled, ended, paused, deleted, closed
response.campaign_list.common_info.bidding_method	string	auto	auto, manual
response.campaign_list.common_info.campaign_placement	string	all	search, discovery, all
response.campaign_list.common_info.campaign_budget	float	12.50	The budget per campaign. Please kindly note that if the campaign budget = 0, it means the budget set for this campaign is unlimited
response.campaign_list.common_info.campaign_duration	object		the duration per campaign
response.campaign_list.common_info.campaign_duration.start_time	int64	1234567890	The start date for each campaign. please kindly note that if this campaign is no end date, please pass today's date as the start date
response.campaign_list.common_info.campaign_duration.end_time	int64	0	the end date per campaign. please kindly note that if it's no limit, so you don't need pass anything and if it's unlimited, the end time would return 0
response.campaign_list.common_info.item_id_list	int64[]		List of unique identifiers for all products under this campaign. If the campaign is using auto product selection it can have between zero and many products. If the campaign is using manual product selection, it has exactly one.
response.campaign_list.manual_bidding_info	object		manual bidding info
response.campaign_list.manual_bidding_info.enhanced_cpc	boolean	true	Enhanced CPC functionality
response.campaign_list.manual_bidding_info.selected_keywords	object[]		selected keywords
response.campaign_list.manual_bidding_info.selected_keywords.keyword	string	keyword	bid keywords for each campaign with search placement
response.campaign_list.manual_bidding_info.selected_keywords.status	string	deleted	deleted, normal, reserved, blacklist
response.campaign_list.manual_bidding_info.selected_keywords.match_type	string	exact	exact, broad
response.campaign_list.manual_bidding_info.selected_keywords.bid_price_per_click	float	10.50	the bid price
response.campaign_list.manual_bidding_info.discovery_ads_locations	object[]		the location settings
response.campaign_list.manual_bidding_info.discovery_ads_locations.location	string	daily_discover	daily_discover, you_may_also_like
response.campaign_list.manual_bidding_info.discovery_ads_locations.status	string	active	toggle on or toggle off
response.campaign_list.manual_bidding_info.discovery_ads_locations.bid_price	float	11.50	bid price
response.campaign_list.auto_bidding_info	object		bidding info
response.campaign_list.auto_bidding_info.roas_target	float	6.50	the ROAS target for each campaign with auto bidding
response.campaign_list.auto_product_ads_info	object[]		selected products info
response.campaign_list.auto_product_ads_info.product_name	string	name1	the name of product
response.campaign_list.auto_product_ads_info.status	string	learning	learning, ongoing, paused, ended, unavailable
response.campaign_list.auto_product_ads_info.item_id	int64		Unique identifier for the product.

§5 Common parameters

Common parameters

Name	Type	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 Java

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.get("https://partner.uat.shopeemobile.com/api/v2/ads/get_product_level_campaign_setting_info?access_token=access_token&campaign_id_list=11111%2C22222%2C33333&info_type_list=1%2C2%2C3%2C4&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp")
.asString();

§8 PHP

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://partner.uat.shopeemobile.com/api/v2/ads/get_product_level_campaign_setting_info?access_token=access_token&campaign_id_list=11111%2C22222%2C33333&info_type_list=1%2C2%2C3%2C4&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;

§9 cURL

cURL

curl --location --request GET 'https://partner.uat.shopeemobile.com/api/v2/ads/get_product_level_campaign_setting_info?access_token=access_token&campaign_id_list=11111%2C22222%2C33333&info_type_list=1%2C2%2C3%2C4&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp'

§10 Python

Python

import requests

url = "https://partner.uat.shopeemobile.com/api/v2/ads/get_product_level_campaign_setting_info?access_token=access_token&campaign_id_list=11111%2C22222%2C33333&info_type_list=1%2C2%2C3%2C4&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)

§11 Response sample

Response sample

§12 JSON

JSON

{
	"error": "-",
	"message": "-",
	"warning": "-",
	"request_id": "6f235f4a343e4feb8a9ed74c439f6663",
	"response": {
		"shop_id": 121212,
		"region": "SG",
		"campaign_list": [
			{
				"campaign_id": 11111,
				"common_info": {
					"ad_type": "auto",
					"ad_name": "name",
					"campaign_status": "ongoing",
					"bidding_method": "auto",
					"campaign_placement": "all",
					"campaign_budget": 12.5,
					"campaign_duration": {
						"start_time": 1234567890,
						"end_time": 0
					},
                                       "item_id_list": [1]
				},
				"manual_bidding_info": {
					"enhanced_cpc": true,
					"selected_keywords": [
						{
							"keyword": "keyword",
							"status": "deleted",
							"match_type": "exact",
							"bid_price_per_click": 10.5
						}
					],
					"discovery_ads_locations": [
						{
							"location": "daily_discover",
							"status": "active",
							"bid_price": 11.5
						}
					]
				},
				"auto_bidding_info": {
					"roas_target": 6.5
				},
				"auto_product_ads_info": [
					{
						"product_name": "name1",
						"status": "learning",
						"item_id": 1
					}
				]
			}
		]
	}
}

§13 Errors

Errors

Error	Description	Solution
ads.shop.campaign_not_match	Invalid campaign ID for this shop.
error_not_found	The information you queried is not found.
error_param	Wrong parameters.
error_server	Something wrong. Please try later.
ads.api.http_method_not_allowed	Only the supported HTTP method for the API is allowed.
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.
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

§14 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.

§15 Update log

Update log

Date	Change
2024-12-10	Add item_id
2024-07-17	New API

这条内容对你有帮助吗？