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

    Interface CheckCreateGmsProductCampaignEligibilityResponse

    Response for the check create GMS product campaign eligibility API

    interface CheckCreateGmsProductCampaignEligibilityResponse {
        error: string;
        message: string;
        request_id: string;
        response: { is_eligible: boolean; reason?: string };
        warning?: string;
    }

    Hierarchy (View Summary)

    • BaseResponse
      • CheckCreateGmsProductCampaignEligibilityResponse
    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: { is_eligible: boolean; reason?: string }

    Type Declaration

    • is_eligible: boolean

      Indicates if the seller is eligible to create a GMS Campaign

    • Optionalreason?: string

      The reason for not being able to create a GMS Campaign. Possible values:

      • active_campaign: There is already an existing GMS Campaign that is active
      • not_whitelisted: The seller is not whitelisted to sz_shop_gmv_max_feature
      • not_have_enough_sku: The seller does not have enough valid items in the shop
      • exclusive_with_other_campaign: Seller is whitelisted to sz_ads_auto_boost
    warning?: string

    Optional warning message if some data cannot be responded normally

    Settings

    Member Visibility

    On This Page

    Properties