v2.ads.edit_manual_product_ads
POST /api/v2/ads/edit_manual_product_ads
Use this API to edit Manual Selection Product Ads
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/ads/edit_manual_product_ads
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 |
| campaign_id | int64 | True | 112234 | The unique identifier for a campaign |
| edit_action | string | True | start | Actions supported: "start", "pause", "resume", "stop", "delete", "change_budget", "change_duration", "change_smart_creative", "change_location", "change_enhanced_cpc", "change_roas_target" |
| budget | float | False | 10.50 | The budget set for the Auto Product Ads |
| start_date | string | False | 11-11-2023 | the start date per campaign. please kindly note that if you want to set unlimited date, you can just pass today's date as the start date |
| end_date | string | False | the end date of each campaign. please kindly note that if you want to set an unlimited campaign, you can keep empty for the end date field | |
| roas_target | float | False | 1.20 | the ROAS target for each campaign with auto bidding |
| discovery_ads_locations | object[] | False | the location settings for manual bidding method | |
| location | string | True | daily_discover | daily_discover, you_may_also_like |
| status | string | True | active | active / inactive |
| bid_price | float | True | 10.50 | bid price of the location |
| enhanced_cpc | boolean | False | true | Enhanced CPC functionality toggle |
| smart_creative_setting | string | False | default | Whether to use default or set on/off Smart Creative for this ad. Supported Values: "", "default", "on", "off". Empty string treated as default. |
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 | |
| campaign_id | int64 | 123 | The unique identifier for a campaign |