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

    Interface GetProductCampaignHourlyPerformanceResponse

    Response for the get product campaign hourly performance API

    interface GetProductCampaignHourlyPerformanceResponse {
        error: string;
        message: string;
        request_id: string;
        response: {
            campaign_list: {
                ad_name: string;
                ad_type: string;
                campaign_id: number;
                campaign_placement: string;
                metrics_list: {
                    broad_cir: number;
                    broad_gmv: number;
                    broad_order: number;
                    broad_order_amount: number;
                    broad_roi: number;
                    clicks: number;
                    cpc: number;
                    cpdc: number;
                    cr: number;
                    ctr: number;
                    date: string;
                    direct_cir: number;
                    direct_cr: number;
                    direct_gmv: number;
                    direct_order: number;
                    direct_order_amount: number;
                    direct_roi: number;
                    expense: number;
                    hour: number;
                    impression: number;
                }[];
            }[];
            region: string;
            shop_id: 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_list: {
            ad_name: string;
            ad_type: string;
            campaign_id: number;
            campaign_placement: string;
            metrics_list: {
                broad_cir: number;
                broad_gmv: number;
                broad_order: number;
                broad_order_amount: number;
                broad_roi: number;
                clicks: number;
                cpc: number;
                cpdc: number;
                cr: number;
                ctr: number;
                date: string;
                direct_cir: number;
                direct_cr: number;
                direct_gmv: number;
                direct_order: number;
                direct_order_amount: number;
                direct_roi: number;
                expense: number;
                hour: number;
                impression: number;
            }[];
        }[];
        region: string;
        shop_id: number;
    }[]

    Type Declaration

    • campaign_list: {
          ad_name: string;
          ad_type: string;
          campaign_id: number;
          campaign_placement: string;
          metrics_list: {
              broad_cir: number;
              broad_gmv: number;
              broad_order: number;
              broad_order_amount: number;
              broad_roi: number;
              clicks: number;
              cpc: number;
              cpdc: number;
              cr: number;
              ctr: number;
              date: string;
              direct_cir: number;
              direct_cr: number;
              direct_gmv: number;
              direct_order: number;
              direct_order_amount: number;
              direct_roi: number;
              expense: number;
              hour: number;
              impression: number;
          }[];
      }[]

      List of campaigns and their performance data

    • region: string

      The region where the shop is located

    • shop_id: number

      The unique ID for the shop

    warning?: string

    Optional warning message if some data cannot be responded normally

    Settings

    Member Visibility

    On This Page

    Properties