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

    Interface GetGmsCampaignPerformanceResponse

    Response for the get GMS campaign performance API

    interface GetGmsCampaignPerformanceResponse {
        error: string;
        message: string;
        request_id: string;
        response: {
            campaign_id: number;
            report: {
                clicks?: number;
                ctr?: number;
                expense?: number;
                gmv?: number;
                impression?: number;
                orders?: number;
                roas?: 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;
        report: {
            clicks?: number;
            ctr?: number;
            expense?: number;
            gmv?: number;
            impression?: number;
            orders?: number;
            roas?: number;
        };
    }

    Type Declaration

    • campaign_id: number

      GMS Campaign ID

    • report: {
          clicks?: number;
          ctr?: number;
          expense?: number;
          gmv?: number;
          impression?: number;
          orders?: number;
          roas?: number;
      }

      Performance report data

      • Optionalclicks?: number

        Total clicks

      • Optionalctr?: number

        Click-through rate

      • Optionalexpense?: number

        Total expense

      • Optionalgmv?: number

        Gross merchandise value

      • Optionalimpression?: number

        Total impressions

      • Optionalorders?: number

        Number of orders

      • Optionalroas?: number

        Return on ad spend

    warning?: string

    Optional warning message if some data cannot be responded normally

    Settings

    Member Visibility

    On This Page

    Properties