Shopee SDK API Reference - v2.8.0
    Preparing search index...

    Interface EditManualProductAdsRequest

    Request parameters for edit_manual_product_ads

    Use this API to edit Manual Selection Product Ads

    interface EditManualProductAdsRequest {
        budget?: number;
        campaign_id: number;
        discovery_ads_locations?: EditManualProductAdsDiscoveryAdsLocation[];
        edit_action: string;
        end_date?: string;
        enhanced_cpc?: boolean;
        reference_id: string;
        roas_target?: number;
        smart_creative_setting?: string | number;
        start_date?: string;
    }
    Index

    Properties

    budget? campaign_id discovery_ads_locations? edit_action end_date? enhanced_cpc? reference_id roas_target? smart_creative_setting? start_date?

    Properties

    budget?: number

    The budget set for the Auto Product Ads

    campaign_id: number

    The unique identifier for a campaign

    discovery_ads_locations?: EditManualProductAdsDiscoveryAdsLocation[]

    the location settings for manual bidding method

    edit_action: string

    Actions supported: "start", "pause", "resume", "stop", "delete", "change_budget", "change_duration", "change_smart_creative", "change_location", "change_enhanced_cpc", "change_roas_target"

    end_date?: string

    the end date of each campaign. please kindly note that if you want to set an unlimited campaign, you can keep empty for the end date field

    enhanced_cpc?: boolean

    Enhanced CPC functionality toggle

    reference_id: string

    A random string used to prevent duplicate ads. If an ads is created successfully, subsequent request using the same reference id will fail

    roas_target?: number

    the ROAS target for each campaign with auto bidding

    smart_creative_setting?: string | number

    Whether to use default or set on/off Smart Creative for this ad. Supported Values: "", "default", "on", "off". Empty string treated as default.

    start_date?: string

    the start date per campaign. please kindly note that if you want to set unlimited date, you can just pass today's date as the start date

    Settings

    Member Visibility

    On This Page

    Properties