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

    Interface GetProductCampaignDailyPerformanceMetrics

    GetProductCampaignDailyPerformanceMetrics sub-interface for GetProductCampaignDailyPerformanceCampaign

    interface GetProductCampaignDailyPerformanceMetrics {
        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;
        impression?: number;
    }
    Index

    Properties

    broad_cir?: number

    The advertising cost of sales (ACOS) measures how much your ad costs relative to the revenue the ad generates. It is the amount spent on your ad divided by the amount of sales revenue attributed to the ad. ACOS = expense ÷ GMV × 100%.

    broad_gmv?: number

    The amount of sales revenue generated from shoppers purchasing products within 7 days of them clicking on your ad.

    broad_order?: number

    The number of times shoppers purchased any product from your shop within 7 days of them clicking on your ad.

    broad_order_amount?: number

    The total quantity of products purchased by shoppers within 7 days of them clicking on your ad.

    broad_roi?: number

    Return on ad spend (ROAS) measures how much revenue is generated by your ad relative to the cost of the ad. It is the amount of sales revenue attributed to your ad divided by the amount spent on the ad. ROAS = GMV ÷ expense. (Note: We recommend monitoring ROAS trends on a weekly basis.)

    clicks?: number

    The number of times shoppers click on your ad. (Note: Shopee filters out repeated clicks from the same shopper that occur within a short time frame.)

    cpc?: number

    The cost per conversion is how much each conversion costs, on average. It is the amount spent on your ad divided by the number of conversions attributed to the ad. Cost per conversion = expense ÷ conversions.

    cpdc?: number

    The cost per direct conversion is how much each direct conversion costs, on average. It is the amount spent on your ad divided by the number of direct conversions attributed to the ad. Cost per direct conversion = expense ÷ direct conversions.

    cr?: number

    The conversion rate measures how often shoppers end up purchasing something from your shop after clicking on your ad. It is the number of conversions attributed to your ad divided by the number of clicks on the ad. Conversion rate = conversions ÷ clicks × 100%.

    ctr?: number

    The click-through rate (CTR) measures how often shoppers end up clicking on your ad after seeing it. It is the number of clicks on your ad divided by the number of times your ad is seen. CTR = clicks ÷ impressions × 100%.

    date?: string

    the given date for the performance

    direct_cir?: number

    The direct advertising cost of sales, or direct ACOS, measures how much your ad costs relative to the revenue generated from sales of the advertised product. It is the amount spent on the ad divided by the amount of sales revenue for the advertised product that is attributed to the ad. Direct ACOS = expense ÷ direct GMV × 100%.

    direct_cr?: number

    The direct conversion rate measures how often shoppers end up purchasing the advertised product after clicking on the ad. Direct conversion rate is the number of direct conversions divided by the number of clicks. Direct conversion rate = direct conversions ÷ clicks × 100%.

    direct_gmv?: number

    The amount of sales revenue generated from shoppers purchasing the advertised product within 7 days of them clicking on the ad.

    direct_order?: number

    The number of times shoppers purchased the advertised product within 7 days of them clicking on the ad.

    direct_order_amount?: number

    The total quantity of the advertised product purchased by shoppers within 7 days of them clicking on the ad.

    direct_roi?: number

    The direct return on ad spend, or direct ROAS, measures how much revenue is generated from sales of the advertised product, relative to the cost of the ad. It is the amount of sales revenue for the advertised product attributed to the ad, divided by the amount spent on the ad. Direct ROAS = direct GMV ÷ expense.

    expense?: number

    The amount spent on your ad.

    impression?: number

    The number of times shoppers see your ad.