v2.ads.get_product_recommended_roi_target
GET /api/v2/ads/get_product_recommended_roi_target
Get Product Recommended ROI Target
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/ads/get_product_recommended_roi_target
Common Request 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 |
Request Parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| reference_id | string | True | 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 | True | 112233 | Unique identifier for a product. |
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. | |
| 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. | |
| value | float | 3.5 | The ROI target value. |
| percentile | int32 | 80 | Competitiveness over similar ads. |
| 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. | |
| value | float | 5.9 | The ROI target value. |
| percentile | int32 | 50 | Competitiveness over similar ads. |
| 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. | |
| value | float | 10.8 | The ROI target value. |
| percentile | int32 | 20 | Competitiveness over similar ads. |