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

    Type Alias CreateManualProductAdsParams

    Parameters for the create manual product ads API

    type CreateManualProductAdsParams = {
        bidding_method: string;
        budget: number;
        discovery_ads_locations?: { bid_price: number; location: string }[];
        end_date?: string;
        enhanced_cpc?: boolean;
        item_id: number;
        reference_id: string;
        roas_target?: number;
        selected_keywords?: {
            bid_price_per_click: number;
            keyword: string;
            match_type: string;
        }[];
        smart_creative_setting?: string;
        start_date: string;
    }
    Index

    Properties

    bidding_method budget discovery_ads_locations? end_date? enhanced_cpc? item_id reference_id roas_target? selected_keywords? smart_creative_setting? start_date

    Properties

    bidding_method: string

    Bidding method: "auto" or "manual"

    budget: number

    The budget set for the Manual Product Ads

    discovery_ads_locations?: { bid_price: number; location: string }[]

    Location settings for manual bidding method

    Type Declaration

    • bid_price: number

      Bid price

    • location: string

      Location: "daily_discover" or "you_may_also_like"

    end_date?: string

    End date of the campaign (DD-MM-YYYY format). Leave empty for unlimited duration

    enhanced_cpc?: boolean

    Enhanced CPC functionality toggle

    item_id: number

    Product ID

    reference_id: string

    A random string used to prevent duplicate ads

    roas_target?: number

    ROAS target for campaigns with auto bidding. If 0, GMV Max / ROI feature is not enabled

    selected_keywords?: {
        bid_price_per_click: number;
        keyword: string;
        match_type: string;
    }[]

    Selected keywords, required for manual bidding mode

    Type Declaration

    • bid_price_per_click: number

      Bid price per click

    • keyword: string

      Keyword text

    • match_type: string

      Match type: "exact" or "broad"

    smart_creative_setting?: string

    Smart Creative setting: "", "default", "on", or "off"

    start_date: string

    Start date of the campaign (DD-MM-YYYY format)

    Settings

    Member Visibility

    On This Page

    Properties