v2.ads.get_gms_campaign_performance

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

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

打开官方原文 ↗

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

查看技术与溯源信息

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

资料正文

§1 v2.ads.get_gms_campaign_performance

Get GMS Campaign performance

§2 Overview

Overview

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

§3 Request parameters

Request parameters

Name	Type	Required	Sample	Description
campaign_id	int64	No	13251251	The GMS Campaign ID. Provide if available.
start_date	string	Yes	11-11-2025	Start date of Campaign e.g. "11-11-2025". Maximum duration of 3 months between start_date & end_date. Earliest start_date is 6 months before today.
end_date	string	Yes	11-11-2025	End date of Campaign e.g. "11-11-2025". Maximum duration of 3 months between start_date & end_date.

§4 Response parameters

Response parameters

Name	Type	Sample	Description
error	string		Indicate error type if hit error. Empty if no error happened.
message	string		Indicate error details if hit error. Empty if no error happened.
warning	string		Indicate warning details if hit warning. Empty if no warning happened.
request_id	string		The identifier for an API request for error tracking.
response	object
response.campaign_id	int64	12412421	GMS Campaign ID
response.report	object
response.report.broad_cir	float	100.12	The direct advertising cost of sales, or direct ACOS, measures how much your ad costs relative to the revenue generated from sales of the advertised product. It is the amount spent on the ad divided by the amount of sales revenue for the advertised product that is attributed to the ad. Direct ACOS = expense ÷ direct GMV × 100%.
response.report.broad_gmv	float	100.12	The amount of sales revenue generated from shoppers purchasing products within 7 days of them clicking on your ad.
response.report.broad_order	int64	123	The number of times shoppers purchased any product from your shop within 7 days of them clicking on your ad.
response.report.broad_order_amount	int64	123	The total quantity of products purchased by shoppers within 7 days of them clicking on your ad.
response.report.broad_roi	float	123.12	Return on ad spend (ROAS) measures how much revenue is generated by your ad relative to the cost of the ad. It is the amount of sales revenue attributed to your ad divided by the amount spent on the ad. ROAS = GMV ÷ expense. (Note: We recommend monitoring ROAS trends on a weekly basis.)
response.report.clicks	int64	123	The number of times shoppers click on your ad. (Note: Shopee filters out repeated clicks from the same shopper that occur within a short time frame.)
response.report.expense	float	123.12	The amount spent on your ad.
response.report.cpc	float	123.12	The cost per conversion is how much each conversion costs, on average. It is the amount spent on your ad divided by the number of conversions attributed to the ad. Cost per conversion = expense ÷ conversions.
response.report.cpdc	float	123.12	The cost per direct conversion is how much each direct conversion costs, on average. It is the amount spent on your ad divided by the number of direct conversions attributed to the ad. Cost per direct conversion = expense ÷ direct conversions.
response.report.cr	float	123.12	The conversion rate measures how often shoppers end up purchasing something from your shop after clicking on your ad. It is the number of conversions attributed to your ad divided by the number of clicks on the ad. Conversion rate = conversions ÷ clicks × 100%.
response.report.direct_cr	float	123.12	The direct conversion rate measures how often shoppers end up purchasing the advertised product after clicking on the ad. Direct conversion rate is the number of direct conversions divided by the number of clicks. Direct conversion rate = direct conversions ÷ clicks × 100%.
response.report.direct_cir	float	123.12	The direct advertising cost of sales, or direct ACOS, measures how much your ad costs relative to the revenue generated from sales of the advertised product. It is the amount spent on the ad divided by the amount of sales revenue for the advertised product that is attributed to the ad. Direct ACOS = expense ÷ direct GMV × 100%.
response.report.direct_order	int64	123	The number of times shoppers purchased the advertised product within 7 days of them clicking on the ad.
response.report.direct_order_amount	int64	123	The total quantity of the advertised product purchased by shoppers within 7 days of them clicking on the ad.
response.report.direct_roi	float	123.12	The direct return on ad spend, or direct ROAS, measures how much revenue is generated from sales of the advertised product, relative to the cost of the ad. It is the amount of sales revenue for the advertised product attributed to the ad, divided by the amount spent on the ad. Direct ROAS = direct GMV ÷ expense.
response.report.impression	float	123.12	The number of times shoppers see your ad.

§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 Payload

Payload

{
	"campaign_id": 13251251,
	"start_date": "11-11-2025",
	"end_date": "11-11-2025"
}

§8 Java

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.post("https://partner.shopeemobile.com/api/v2/ads/get_gms_campaign_performance?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp")
.header("Content-Type","application/json")
.body("{
   \"campaign_id\": 13251251,
   \"end_date\": \"11-11-2025\",
   \"start_date\": \"11-11-2025\"
}")
.asString();

§9 PHP

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/ads/get_gms_campaign_performance?access_token=access_token&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 => 'POST',
  CURLOPT_POSTFIELDS => '{
    "campaign_id": 13251251,
    "end_date": "11-11-2025",
    "start_date": "11-11-2025"
}',
  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.shopeemobile.com/api/v2/ads/get_gms_campaign_performance?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp' \
--header 'Content-Type: application/json' \
--data-raw '{
   "campaign_id": 13251251,
   "end_date": "11-11-2025",
   "start_date": "11-11-2025"
}'

§11 Python

Python

import requests
import json

url = "https://partner.shopeemobile.com/api/v2/ads/get_gms_campaign_performance?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp"

payload=json.dumps({
  "campaign_id": 13251251,
  "end_date": "11-11-2025",
  "start_date": "11-11-2025"
})
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": "-",
	"response": {
		"campaign_id": 12412421,
		"report": {
			"broad_cir": 100.12,
			"broad_gmv": 100.12,
			"broad_order": 123,
			"broad_order_amount": 123,
			"broad_roi": 123.12,
			"clicks": 123,
			"expense": 123.12,
			"cpc": 123.12,
			"cpdc": 123.12,
			"cr": 123.12,
			"direct_cr": 123.12,
			"direct_cir": 123.12,
			"direct_order": 123,
			"direct_order_amount": 123,
			"direct_roi": 123.12,
			"impression": 123.12
		}
	}
}

§14 Errors

Errors

Error	Description	Solution
ads_error_not_whitelisted_for_product_gms	This shop is not whitelisted for Product GMS.
error_param	Wrong parameters.
ads_error_product_gms_campaign_not_found	Product GMS Campaign cannot be found.
error_server	Something wrong. Please try later.
ads.ads_account.invalid_status	Ads account status is Invalid.
ads_invalid_roas_target	ROAS Target should be greater than equal to zero.
ads.campaign.invalid_start_date	The start date has to be today for no end date (unlimited duration).
ads.performance.error_date_in_future	The date must be today or earlier than today up to 6 months ago.
ads.performance.error_date_range_too_long	Date range can't be longer than 1 month.
ads.performance.error_date_too_old	The date can't be earlier than 6 months ago.
ads.performance.error_same_start_end_dates	Start date can't be equal to end date. For single date's hourly performance data, please query hourly api.
ads.performance.error_start_later_than_end	The start date can't be later than the end date.
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.

§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
2025-08-26	New API

这条内容对你有帮助吗？