v2.ads.get_create_product_ad_budget_suggestion
GET /api/v2/ads/get_create_product_ad_budget_suggestion
Call this API to get budget suggestion for product ads creation
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/ads/get_create_product_ad_budget_suggestion
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 request using the same reference id will fail |
| product_selection | string | True | auto | auto,manual - for Auto product ads or Manual Product Ads |
| campaign_placement | string | True | all | search, discovery, all |
| bidding_method | string | True | manual | Bidding Method of product ad: auto, manual |
| enhanced_cpc | string | False | true | Enhanced CPC functionality toggle. Values supported "true"/"false". Mandatory for product_selection=manual, bidding_method=manual |
| discovery_ads_location_names | string | False | daily_discover,you_may_also_like | List of comma separated location values from: daily_discover, you_may_also_like. Mandatory for product_selection=manual, product_placement={all |
| roas_target | float | False | 1.2 | the ROAS target for each campaign with auto bidding. If 0, GMV Max / ROI feature is not enabled |
| item_id | int64 | False | 112233 | Product ID. Mandatory for product_selection=manual |
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 | |
| budget | object | Budget data | |
| recommended_budget | float | 20.50 | Recommended Suggested Budget |
| min_budget | float | 15.20 | Minimun Suggested Budget |
| max_budget | float | 30.10 | Maximum Suggested Budget |