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

    Interface GetTargetedCampaignSettingsResponse

    Response for get_targeted_campaign_settings API

    interface GetTargetedCampaignSettingsResponse {
        error: string;
        message: string;
        request_id: string;
        response: {
            affiliate_list?: { affiliate_id: number; affiliate_name?: string }[];
            budget?: number;
            campaign_id: number;
            campaign_name: string;
            campaign_status: string;
            is_set_budget: boolean;
            item_list?: { item_id: number; rate: number }[];
            period_end_time: number;
            period_start_time: number;
            seller_message?: string;
        };
        warning?: string
        | 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: {
        affiliate_list?: { affiliate_id: number; affiliate_name?: string }[];
        budget?: number;
        campaign_id: number;
        campaign_name: string;
        campaign_status: string;
        is_set_budget: boolean;
        item_list?: { item_id: number; rate: number }[];
        period_end_time: number;
        period_start_time: number;
        seller_message?: string;
    }

    Type Declaration

    • Optionalaffiliate_list?: { affiliate_id: number; affiliate_name?: string }[]

      List of affiliates in the campaign

    • Optionalbudget?: number

      Budget amount

    • campaign_id: number

      Campaign ID

    • campaign_name: string

      Campaign name

    • campaign_status: string

      Campaign status

    • is_set_budget: boolean

      Whether budget is set

    • Optionalitem_list?: { item_id: number; rate: number }[]

      List of items in the campaign

    • period_end_time: number

      Period end time

    • period_start_time: number

      Period start time

    • Optionalseller_message?: string

      Seller message

    warning?: string | string[]

    Warning message or list of warning messages

    Settings

    Member Visibility

    On This Page

    Properties