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

    Interface GetTargetedCampaignListRequest

    Request parameters for get_targeted_campaign_list

    Retrieve all current targeted campaigns created by the seller

    interface GetTargetedCampaignListRequest {
        campaign_id_list?: string[];
        campaign_name?: string;
        campaign_status?: string;
        item_id?: number;
        item_name?: string;
        page_no: number;
        page_size: number;
        period_end_time?: number | Date;
        period_start_time?: number | Date;
    }
    Index

    Properties

    campaign_id_list? campaign_name? campaign_status? item_id? item_name? page_no page_size period_end_time? period_start_time?

    Properties

    campaign_id_list?: string[]

    The list of campaign_id for query, different campaign id should be split by comma and at most 50 campaigns.

    campaign_name?: string

    Campaign name for query.

    campaign_status?: string

    Campaign status for query. Applicable values: UpcomingOngoingEndedCancelledDraftTerminatingTerminatedPaused

    item_id?: number

    Item id for query.

    item_name?: string

    Item name for query.

    page_no

    page_no: number

    Specifies the page number of data to return in the current call. Starting from 1. if data is more than one page, the page_no can be some entry to start next call.

    page_size

    page_size: number

    Each result set is returned as a page of entries. Use the "page_size" filters to control the maximum number of entries to retrieve per page (i.e., per call), and the "page_no" to start next call. This integer value is used to specify the maximum number of entries to return in a single "page" of data. The limit of page_size if between 1 and 100.

    period_end_time?: number | Date

    Campaign period end time for query.

    period_start_time?: number | Date

    Campaign period start time for query.

    Settings

    Member Visibility

    On This Page

    Properties