v2.ads.get_product_level_campaign_setting_info
GET /api/v2/ads/get_product_level_campaign_setting_info
Call this API to fetch all the campaign setting info under this Shop.
Đường dẫn Endpoint
URL: https://partner.shopeemobile.com/api/v2/ads/get_product_level_campaign_setting_info
Tham số chung
| Tên | Kiểu | Mẫu | Mô tả |
|---|---|---|---|
| partner_id | int | 1 | Partner ID được cấp khi đăng ký thành công. Bắt buộc cho mọi yêu cầu. |
| timestamp | timestamp | 1610000000 | Dùng để xác định thời điểm của yêu cầu. Bắt buộc cho mọi yêu cầu. Hết hạn sau 5 phút. |
| access_token | string | c09222e3fc40ffb25fc947f738b1abf1 | Token truy cập API, dùng để xác định quyền của bạn. Có thể dùng nhiều lần và hết hạn sau 4 giờ. |
| shop_id | int | 600000 | Mã định danh duy nhất của Shopee cho cửa hàng. Tham số bắt buộc cho hầu hết các API. |
| 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 |
Tham số Request
| Tên | Kiểu | Bắt buộc | Mẫu | Mô tả |
|---|---|---|---|---|
| info_type_list | string | True | 1,2,3,4 | Info type values: 1.Common Info 2.Manual Bidding Info 3.Auto Bidding Info 4.Auto Product Ads Info |
| campaign_id_list | string | True | 11111,22222,33333 | list of campaign ids comma separated (max 100 campaign ids) |
Tham số Response
| Tên | Kiểu | Mẫu | Mô tả |
|---|---|---|---|
| error | string | Mã lỗi, để trống khi không có lỗi | |
| message | string | Mô tả lỗi | |
| warning | string | Nếu một số dữ liệu không thể phản hồi bình thường, đặt cảnh báo | |
| request_id | string | 6f235f4a343e4feb8a9ed74c439f6663 | request id là duy nhất cho mỗi yêu cầu |
| response | object | Nội dung phản hồi | |
| shop_id | int64 | 121212 | Shopee's unique identifier for a shop. |
| region | string | SG | Region the shop belongs to |
| campaign_list | object[] | - | |
| campaign_id | int64 | 11111 | The unique ID per campaign |
| common_info | object | common_info body | |
| ad_type | string | auto | auto, manual |
| ad_name | string | name | the name of each ad |
| campaign_status | string | ongoing | ongoing, scheduled, ended, paused, deleted, closed |
| bidding_method | string | auto | auto, manual |
| campaign_placement | string | all | search, discovery, all |
| campaign_budget | float | 12.50 | The budget per campaign. Please kindly note that if the campaign budget = 0, it means the budget set for this campaign is unlimited |
| campaign_duration | object | the duration per campaign | |
| start_time | int64 | 1234567890 | The start date for each campaign. please kindly note that if this campaign is no end date, please pass today's date as the start date |
| end_time | int64 | 0 | the end date per campaign. please kindly note that if it's no limit, so you don't need pass anything and if it's unlimited, the end time would return 0 |
| item_id_list | int64[] | List of unique identifiers for all products under this campaign. If the campaign is using auto product selection it can have between zero and many products. If the campaign is using manual product selection, it has exactly one. | |
| manual_bidding_info | object | manual bidding info | |
| enhanced_cpc | boolean | true | Enhanced CPC functionality |
| selected_keywords | object[] | selected keywords | |
| keyword | string | keyword | bid keywords for each campaign with search placement |
| status | string | deleted | deleted, normal, reserved, blacklist |
| match_type | string | exact | exact, broad |
| bid_price_per_click | float | 10.50 | the bid price |
| discovery_ads_locations | object[] | the location settings | |
| location | string | daily_discover | daily_discover, you_may_also_like |
| status | string | active | toggle on or toggle off |
| bid_price | float | 11.50 | bid price |
| auto_bidding_info | object | bidding info | |
| roas_target | float | 6.50 | Mục tiêu ROAS cho chiến dịch với đấu giá tự động |
| auto_product_ads_info | object[] | selected products info | |
| product_name | string | name1 | the name of product |
| status | string | learning | learning, ongoing, paused, ended, unavailable |
| item_id | int64 | Unique identifier for the product. |