v2.ads.get_product_recommended_roi_target

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

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

打开官方原文 ↗

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

查看技术与溯源信息

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

资料正文

§1 v2.ads.get_product_recommended_roi_target

Get Product Recommended ROI Target

§2 Overview

Overview

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

§3 Request parameters

Request parameters

Name	Type	Required	Sample	Description
reference_id	string	Yes	asdf-1234-qwerty	A random string used to prevent duplicate ads. If an ads is created successfully, subsequent requests using the same reference id will fail - in this case, a new one must be generated. Use the same string for calling suggestion/recommendation API before the actual request to create an ads.
item_id	int32	Yes	112233	Unique identifier for a product.

§4 Response parameters

Response parameters

Name	Type	Sample	Description
error	string		Error code, empty when no error returned
message	string		Error description.
warning	string		This field is set if some data cannot respond normally.
request_id	string	6f235f4a343e4feb8a9ed74c439f6663	Unique identifier for each request.
response	object		Response body.
response.lower_bound	object		Lower bound recommendation.; e.g., value=3.5 and percentile=80 mean that setting an ROI target of 3.5; makes the ads more competitive than 80% of similar ads.
response.lower_bound.value	float	3.5	The ROI target value.
response.lower_bound.percentile	int32	80	Competitiveness over similar ads.
response.exact	object		Mid-level recommendation; e.g., value=5.9 and percentile=50 mean that setting an ROI target of 5.9 makes the ads more competitive than 50% of similar ads.
response.exact.value	float	5.9	The ROI target value.
response.exact.percentile	int32	50	Competitiveness over similar ads.
response.upper_bound	object		Higher bound recommendation.; e.g., value=10.8 and percentile=20 mean that setting an ROI target of 10.8 makes the ads more competitive than 20% of similar ads.
response.upper_bound.value	float	10.8	The ROI target value.
response.upper_bound.percentile	int32	20	Competitiveness over similar ads.

§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.test.shopeemobile.com/api/v2/ads/get_product_recommended_roi_target?access_token=access_token&item_id=112233&partner_id=partner_id&reference_id=asdf-1234-qwerty&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.test.shopeemobile.com/api/v2/ads/get_product_recommended_roi_target?access_token=access_token&item_id=112233&partner_id=partner_id&reference_id=asdf-1234-qwerty&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.test.shopeemobile.com/api/v2/ads/get_product_recommended_roi_target?access_token=access_token&item_id=112233&partner_id=partner_id&reference_id=asdf-1234-qwerty&shop_id=shop_id&sign=sign&timestamp=timestamp'

§10 Python

Python

import requests

url = "https://partner.test.shopeemobile.com/api/v2/ads/get_product_recommended_roi_target?access_token=access_token&item_id=112233&partner_id=partner_id&reference_id=asdf-1234-qwerty&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": "",
    "request_id": "e3e3e7f327774e57cc0b80c5b9288d01",
    "response": {
        "exact": {
            "percentile": 50,
            "value": 8.7
        },
        "lower_bound": {
            "percentile": 80,
            "value": 5.9
        },
        "upper_bound": {
            "percentile": 20,
            "value": 10.6
        }
    },
    "warning": ""
}

§13 Error example

Error example

§14 JSON

JSON

{
    "error": "error_server",
    "message": "Something wrong. Please try later. Details: item does not belong to the shop, err: get item info 304458374 fail, err: load data fail, err: item not found 304458374",
    "request_id": "e3e3e7f32777a8019f172f934eca0b01",
    "response": null,
    "warning": ""
}

§15 Errors

Errors

Error	Description	Solution
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

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

§17 Update log

Update log

Date	Change
2024-12-06	New API

这条内容对你有帮助吗？