Shopee SDK API Reference - v1.11.0
    Preparing search index...

    Interface GetProductLevelCampaignSettingInfoResponse

    Response for the get product level campaign setting info API

    interface GetProductLevelCampaignSettingInfoResponse {
        error: string;
        message: string;
        request_id: string;
        response: {
            campaign_list: {
                auto_bidding_info?: { roas_target: number };
                auto_product_ads_info?: {
                    item_id: number;
                    product_name: string;
                    status: string;
                }[];
                campaign_id: number;
                common_info?: {
                    ad_name: string;
                    ad_type: string;
                    bidding_method: string;
                    campaign_budget: number;
                    campaign_duration: { end_time: number; start_time: number };
                    campaign_placement: string;
                    campaign_status: string;
                    item_id_list: number[];
                };
                manual_bidding_info?: {
                    discovery_ads_locations: {
                        bid_price: number;
                        location: string;
                        status: string;
                    }[];
                    enhanced_cpc: boolean;
                    selected_keywords: {
                        bid_price_per_click: number;
                        keyword: string;
                        match_type: string;
                        status: string;
                    }[];
                };
            }[];
            region: string;
            shop_id: number;
        };
        warning?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    error message request_id response warning?

    Properties

    error: string

    Error code if any error occurred

    message: string

    Error message if any error occurred

    request_id: string

    The identifier for an API request for error tracking

    response: {
        campaign_list: {
            auto_bidding_info?: { roas_target: number };
            auto_product_ads_info?: {
                item_id: number;
                product_name: string;
                status: string;
            }[];
            campaign_id: number;
            common_info?: {
                ad_name: string;
                ad_type: string;
                bidding_method: string;
                campaign_budget: number;
                campaign_duration: { end_time: number; start_time: number };
                campaign_placement: string;
                campaign_status: string;
                item_id_list: number[];
            };
            manual_bidding_info?: {
                discovery_ads_locations: {
                    bid_price: number;
                    location: string;
                    status: string;
                }[];
                enhanced_cpc: boolean;
                selected_keywords: {
                    bid_price_per_click: number;
                    keyword: string;
                    match_type: string;
                    status: string;
                }[];
            };
        }[];
        region: string;
        shop_id: number;
    }

    Type Declaration

    • campaign_list: {
          auto_bidding_info?: { roas_target: number };
          auto_product_ads_info?: {
              item_id: number;
              product_name: string;
              status: string;
          }[];
          campaign_id: number;
          common_info?: {
              ad_name: string;
              ad_type: string;
              bidding_method: string;
              campaign_budget: number;
              campaign_duration: { end_time: number; start_time: number };
              campaign_placement: string;
              campaign_status: string;
              item_id_list: number[];
          };
          manual_bidding_info?: {
              discovery_ads_locations: {
                  bid_price: number;
                  location: string;
                  status: string;
              }[];
              enhanced_cpc: boolean;
              selected_keywords: {
                  bid_price_per_click: number;
                  keyword: string;
                  match_type: string;
                  status: string;
              }[];
          };
      }[]

      List of campaigns with their settings

    • region: string

      The region where the shop is located

    • shop_id: number

      The unique ID for the shop

    warning?: string

    Optional warning message if some data cannot be responded normally

    Settings

    Member Visibility

    On This Page

    Properties