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

    Interface EditGmsProductCampaignRequest

    Request parameters for edit_gms_product_campaign

    Edit a GMS campaign

    interface EditGmsProductCampaignRequest {
        campaign_id?: number;
        daily_budget?: number;
        edit_action: string;
        end_date?: string;
        reference_id?: string;
        roas_target?: number;
        start_date?: string;
    }
    Index

    Properties

    campaign_id? daily_budget? edit_action end_date? reference_id? roas_target? start_date?

    Properties

    campaign_id?: number

    The GMS Campaign ID. Provide if available.

    daily_budget?: number

    Daily budget for Campaign.

    edit_action: string

    The following is the list of possible actions and their required fields:1.change_budgetdaily_budget2.change_durationstart_date3.end_date4.pause5.resume6.start7.change_roas_targetroas_target: when edit_action = change_roas_target, you must provide:roas_target (float) Value rules follow the same logic as in the create endpoint

    end_date?: string

    End date of Campaign e.g. "11-11-2025". Do not fill if no end date.

    reference_id?: string

    Generated by developers, used to prevent duplicate requestsSubmitting the same reference_id more than once will fail; a new reference_id must be generated to retry.Example: 086a16bf-49e9-4103-b7fe-c0125beb9278

    roas_target?: number

    No input will be GMV Max Auto Bidding (Shop).Input 0 for GMV Max Auto Bidding (Shop).Input greater than 0 for GMV Max Custom ROAS (Shop).If value = 10.123456, it will be taken as 10.1If value = 10.199999, it will be taken as 10.1

    start_date?: string

    Start date of Campaign e.g. "11-11-2025". Cannot be earlier than today.

    Settings

    Member Visibility

    On This Page

    Properties