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

    Interface GetProductRecommendedRoiTargetResponse

    Response for the get product recommended ROI target API

    interface GetProductRecommendedRoiTargetResponse {
        error: string;
        message: string;
        request_id: string;
        response: {
            exact: { percentile: number; value: number };
            lower_bound: { percentile: number; value: number };
            upper_bound: { percentile: number; value: 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: {
        exact: { percentile: number; value: number };
        lower_bound: { percentile: number; value: number };
        upper_bound: { percentile: number; value: number };
    }

    Type Declaration

    • exact: { percentile: number; value: number }

      Mid-level recommendation. e.g., value=5.9 and percentile=50 mean that setting an ROI target of 5.9 makes the ads more competitive than 50% of similar ads.

      • percentile: number

        Competitiveness over similar ads

      • value: number

        The ROI target value

    • lower_bound: { percentile: number; value: number }

      Lower bound recommendation. e.g., value=3.5 and percentile=80 mean that setting an ROI target of 3.5 makes the ads more competitive than 80% of similar ads.

      • percentile: number

        Competitiveness over similar ads

      • value: number

        The ROI target value

    • upper_bound: { percentile: number; value: number }

      Higher bound recommendation. e.g., value=10.8 and percentile=20 mean that setting an ROI target of 10.8 makes the ads more competitive than 20% of similar ads.

      • percentile: number

        Competitiveness over similar ads

      • value: number

        The ROI target value

    warning?: string

    Optional warning message if some data cannot be responded normally

    Settings

    Member Visibility

    On This Page

    Properties