v2.ads.get_recommended_keyword_list
GET /api/v2/ads/get_recommended_keyword_list
Use this API to get the list of Recommended keywords by item and optionally a search keyword
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/ads/get_recommended_keyword_list
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 |
|---|---|---|---|---|
| item_id | int32 | True | 1111 | Shopee's unique identifier for an item. |
| input_keyword | string | False | keyword | The keyword seller typed in the manually add keyword window. |
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 | |
| item_id | int32 | 1111 | Shopee's unique identifier for an item. |
| input_keyword | string | keyword | The keyword seller typed in the manually add keyword window. |
| suggested_keywords | object[] | Suggested keywords recommended from product. | |
| keyword | string | keyword | Keyword value (Only return the highly recommended keywords, will be sightly different from Seller Center) |
| quality_score | int32 | 8 | This is a measure of how attractive your ad is and its relevance to the keyword. The higher the quality score, the higher your ad rank. Ad rank is based on this score and your bid price. |
| search_volume | int32 | 1234 | The number of times the keyword has been searched on Shopee in the last 30 days. The larger the search volume, the more impressions your ad will receive. |
| suggested_bid | float | 12.34 | This is bid price suggested by Shopee algorithm for the keyword in local currency. |