v2.ads.get_product_level_campaign_id_list
GET /api/v2/ads/get_product_level_campaign_id_list
Call this API to fetch all the product campaign ids displayed on advertiser platform under a specific Shop
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/ads/get_product_level_campaign_id_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 |
|---|---|---|---|---|
| ad_type | string | False | all | Any of ["","all","auto","manual"] |
| offset | int64 | False | 0 | offset |
| limit | int64 | False | 5000 | limit |
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 | |
| shop_id | int64 | 121212 | Shopee's unique identifier for a shop. |
| region | string | SG | Region the shop belongs to |
| has_next_page | boolean | true | there are more campaigns on next page |
| campaign_list | object[] | the list of campaigns | |
| ad_type | string | auto | auto/manual |
| campaign_id | int64 | 111111 | the unique id per campaign |