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

    Interface GetGmsItemPerformanceResponse

    Response for the get GMS item performance API

    interface GetGmsItemPerformanceResponse {
        error: string;
        message: string;
        request_id: string;
        response: {
            campaign_id: number;
            has_next_page: boolean;
            result_list: {
                clicks?: number;
                ctr?: number;
                expense?: number;
                gmv?: number;
                impression?: number;
                item_id: number;
                orders?: number;
                roas?: number;
            }[];
            total: number;
        };
        warning?: 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: {
        campaign_id: number;
        has_next_page: boolean;
        result_list: {
            clicks?: number;
            ctr?: number;
            expense?: number;
            gmv?: number;
            impression?: number;
            item_id: number;
            orders?: number;
            roas?: number;
        }[];
        total: number;
    }

    Type Declaration

    • campaign_id: number

      GMS Campaign ID

    • has_next_page: boolean

      Indicates if there are more item ID reports

    • result_list: {
          clicks?: number;
          ctr?: number;
          expense?: number;
          gmv?: number;
          impression?: number;
          item_id: number;
          orders?: number;
          roas?: number;
      }[]

      List of item performance reports

    • total: number

      Total number of item ID reports

    warning?: string

    Optional warning message if some data cannot be responded normally

    Settings

    Member Visibility

    On This Page

    Properties