v2.ads.edit_manual_product_ad_keywords
POST /api/v2/ads/edit_manual_product_ad_keywords
Use this API to edit Manual Selection Product Ad Keywords
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/ads/edit_manual_product_ad_keywords
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 | 112233 | The unique identifier for a campaign |
| selected_keywords | object[] | True | selected keywords, required for manual bidding mode. | |
| edit_action | string | True | add | The update behaviours such as "add", "delete", "restore", "change_bid_price", "change_match_type" |
| keyword | string | True | apple | bid keyword for each campaign |
| match_type | string | False | exact | exact, broad; required if changing match type |
| bid_price_per_click | float | False | 11.20 | the bid price of keyword; required if changing bid price |
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 |
| failed_edits | object[] | failed edits are mentioned here | |
| keyword | string | keyword | keyword that failed to update |
| error | string | Error code | |
| message | string | error description |