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

    Module schemas/ads

    Enumerations

    AdType
    ReferenceId
    SmartCreativeSetting

    Interfaces

    CheckCreateGmsProductCampaignEligibilityResponseData
    CreateAutoProductAdsRequest
    CreateAutoProductAdsResponseDataItem
    CreateGmsProductCampaignRequest
    CreateGmsProductCampaignResponseData
    CreateManualProductAdsDiscoveryAdsLocation
    CreateManualProductAdsRequest
    CreateManualProductAdsResponseDataItem
    CreateManualProductAdsSelectedKeyword
    EditAutoProductAdsRequest
    EditAutoProductAdsResponseDataItem
    EditGmsItemProductCampaignRequest
    EditGmsItemProductCampaignResponseData
    EditGmsProductCampaignRequest
    EditGmsProductCampaignResponseData
    EditManualProductAdKeywordsFailedEdit
    EditManualProductAdKeywordsRequest
    EditManualProductAdKeywordsResponseDataItem
    EditManualProductAdKeywordsSelectedKeyword
    EditManualProductAdsDiscoveryAdsLocation
    EditManualProductAdsRequest
    EditManualProductAdsResponseDataItem
    GetAdsFacilShopRateResponseData
    GetAllCpcAdsDailyPerformanceRequest
    GetAllCpcAdsDailyPerformanceResponseDataItem
    GetAllCpcAdsHourlyPerformanceRequest
    GetAllCpcAdsHourlyPerformanceResponseDataItem
    GetCreateProductAdBudgetSuggestionBudget
    GetCreateProductAdBudgetSuggestionRequest
    GetCreateProductAdBudgetSuggestionResponseData
    GetGmsCampaignPerformanceReport
    GetGmsCampaignPerformanceRequest
    GetGmsCampaignPerformanceResponseData
    GetGmsItemPerformanceReport
    GetGmsItemPerformanceRequest
    GetGmsItemPerformanceResponseData
    GetGmsItemPerformanceResult
    GetProductCampaignDailyPerformanceCampaign
    GetProductCampaignDailyPerformanceMetrics
    GetProductCampaignDailyPerformanceRequest
    GetProductCampaignDailyPerformanceResponseDataItem
    GetProductCampaignHourlyPerformanceCampaign
    GetProductCampaignHourlyPerformanceMetrics
    GetProductCampaignHourlyPerformanceRequest
    GetProductCampaignHourlyPerformanceResponseDataItem
    GetProductLevelCampaignIdListCampaign
    GetProductLevelCampaignIdListRequest
    GetProductLevelCampaignIdListResponseData
    GetProductLevelCampaignSettingInfoAutoBiddingInfo
    GetProductLevelCampaignSettingInfoAutoProductAdsInfo
    GetProductLevelCampaignSettingInfoCampaign
    GetProductLevelCampaignSettingInfoCampaignDuration
    GetProductLevelCampaignSettingInfoCommonInfo
    GetProductLevelCampaignSettingInfoDiscoveryAdsLocation
    GetProductLevelCampaignSettingInfoManualBiddingInfo
    GetProductLevelCampaignSettingInfoRequest
    GetProductLevelCampaignSettingInfoResponseData
    GetProductLevelCampaignSettingInfoSelectedKeyword
    GetProductRecommendedRoiTargetExact
    GetProductRecommendedRoiTargetLowerBound
    GetProductRecommendedRoiTargetRequest
    GetProductRecommendedRoiTargetResponseData
    GetProductRecommendedRoiTargetUpperBound
    GetRecommendedItemListResponseDataItem
    GetRecommendedKeywordListRequest
    GetRecommendedKeywordListResponseData
    GetRecommendedKeywordListSuggestedKeyword
    GetShopToggleInfoResponseData
    GetTotalBalanceResponseData
    ListGmsUserDeletedItemRequest
    ListGmsUserDeletedItemResponseData

    Type Aliases

    CheckCreateGmsProductCampaignEligibilityRequest
    CheckCreateGmsProductCampaignEligibilityResponse
    CreateAutoProductAdsResponse
    CreateAutoProductAdsResponseData
    CreateGmsProductCampaignResponse
    CreateManualProductAdsResponse
    CreateManualProductAdsResponseData
    EditAutoProductAdsResponse
    EditAutoProductAdsResponseData
    EditGmsItemProductCampaignResponse
    EditGmsProductCampaignResponse
    EditManualProductAdKeywordsResponse
    EditManualProductAdKeywordsResponseData
    EditManualProductAdsResponse
    EditManualProductAdsResponseData
    GetAdsFacilShopRateRequest
    GetAdsFacilShopRateResponse
    GetAllCpcAdsDailyPerformanceResponse
    GetAllCpcAdsDailyPerformanceResponseData
    GetAllCpcAdsHourlyPerformanceResponse
    GetAllCpcAdsHourlyPerformanceResponseData
    GetCreateProductAdBudgetSuggestionResponse
    GetGmsCampaignPerformanceResponse
    GetGmsItemPerformanceResponse
    GetProductCampaignDailyPerformanceResponse
    GetProductCampaignDailyPerformanceResponseData
    GetProductCampaignHourlyPerformanceResponse
    GetProductCampaignHourlyPerformanceResponseData
    GetProductLevelCampaignIdListResponse
    GetProductLevelCampaignSettingInfoResponse
    GetProductRecommendedRoiTargetResponse
    GetRecommendedItemListRequest
    GetRecommendedItemListResponse
    GetRecommendedItemListResponseData
    GetRecommendedKeywordListResponse
    GetShopToggleInfoRequest
    GetShopToggleInfoResponse
    GetTotalBalanceRequest
    GetTotalBalanceResponse
    ListGmsUserDeletedItemResponse

    Settings

    Member Visibility

    On This Page

    Enumerations
    Interfaces
    CheckCreateGmsProductCampaignEligibilityResponseDataCreateAutoProductAdsRequestCreateAutoProductAdsResponseDataItemCreateGmsProductCampaignRequestCreateGmsProductCampaignResponseDataCreateManualProductAdsDiscoveryAdsLocationCreateManualProductAdsRequestCreateManualProductAdsResponseDataItemCreateManualProductAdsSelectedKeywordEditAutoProductAdsRequestEditAutoProductAdsResponseDataItemEditGmsItemProductCampaignRequestEditGmsItemProductCampaignResponseDataEditGmsProductCampaignRequestEditGmsProductCampaignResponseDataEditManualProductAdKeywordsFailedEditEditManualProductAdKeywordsRequestEditManualProductAdKeywordsResponseDataItemEditManualProductAdKeywordsSelectedKeywordEditManualProductAdsDiscoveryAdsLocationEditManualProductAdsRequestEditManualProductAdsResponseDataItemGetAdsFacilShopRateResponseDataGetAllCpcAdsDailyPerformanceRequestGetAllCpcAdsDailyPerformanceResponseDataItemGetAllCpcAdsHourlyPerformanceRequestGetAllCpcAdsHourlyPerformanceResponseDataItemGetCreateProductAdBudgetSuggestionBudgetGetCreateProductAdBudgetSuggestionRequestGetCreateProductAdBudgetSuggestionResponseDataGetGmsCampaignPerformanceReportGetGmsCampaignPerformanceRequestGetGmsCampaignPerformanceResponseDataGetGmsItemPerformanceReportGetGmsItemPerformanceRequestGetGmsItemPerformanceResponseDataGetGmsItemPerformanceResultGetProductCampaignDailyPerformanceCampaignGetProductCampaignDailyPerformanceMetricsGetProductCampaignDailyPerformanceRequestGetProductCampaignDailyPerformanceResponseDataItemGetProductCampaignHourlyPerformanceCampaignGetProductCampaignHourlyPerformanceMetricsGetProductCampaignHourlyPerformanceRequestGetProductCampaignHourlyPerformanceResponseDataItemGetProductLevelCampaignIdListCampaignGetProductLevelCampaignIdListRequestGetProductLevelCampaignIdListResponseDataGetProductLevelCampaignSettingInfoAutoBiddingInfoGetProductLevelCampaignSettingInfoAutoProductAdsInfoGetProductLevelCampaignSettingInfoCampaignGetProductLevelCampaignSettingInfoCampaignDurationGetProductLevelCampaignSettingInfoCommonInfoGetProductLevelCampaignSettingInfoDiscoveryAdsLocationGetProductLevelCampaignSettingInfoManualBiddingInfoGetProductLevelCampaignSettingInfoRequestGetProductLevelCampaignSettingInfoResponseDataGetProductLevelCampaignSettingInfoSelectedKeywordGetProductRecommendedRoiTargetExactGetProductRecommendedRoiTargetLowerBoundGetProductRecommendedRoiTargetRequestGetProductRecommendedRoiTargetResponseDataGetProductRecommendedRoiTargetUpperBoundGetRecommendedItemListResponseDataItemGetRecommendedKeywordListRequestGetRecommendedKeywordListResponseDataGetRecommendedKeywordListSuggestedKeywordGetShopToggleInfoResponseDataGetTotalBalanceResponseDataListGmsUserDeletedItemRequestListGmsUserDeletedItemResponseData
    Type Aliases
    CheckCreateGmsProductCampaignEligibilityRequestCheckCreateGmsProductCampaignEligibilityResponseCreateAutoProductAdsResponseCreateAutoProductAdsResponseDataCreateGmsProductCampaignResponseCreateManualProductAdsResponseCreateManualProductAdsResponseDataEditAutoProductAdsResponseEditAutoProductAdsResponseDataEditGmsItemProductCampaignResponseEditGmsProductCampaignResponseEditManualProductAdKeywordsResponseEditManualProductAdKeywordsResponseDataEditManualProductAdsResponseEditManualProductAdsResponseDataGetAdsFacilShopRateRequestGetAdsFacilShopRateResponseGetAllCpcAdsDailyPerformanceResponseGetAllCpcAdsDailyPerformanceResponseDataGetAllCpcAdsHourlyPerformanceResponseGetAllCpcAdsHourlyPerformanceResponseDataGetCreateProductAdBudgetSuggestionResponseGetGmsCampaignPerformanceResponseGetGmsItemPerformanceResponseGetProductCampaignDailyPerformanceResponseGetProductCampaignDailyPerformanceResponseDataGetProductCampaignHourlyPerformanceResponseGetProductCampaignHourlyPerformanceResponseDataGetProductLevelCampaignIdListResponseGetProductLevelCampaignSettingInfoResponseGetProductRecommendedRoiTargetResponseGetRecommendedItemListRequestGetRecommendedItemListResponseGetRecommendedItemListResponseDataGetRecommendedKeywordListResponseGetShopToggleInfoRequestGetShopToggleInfoResponseGetTotalBalanceRequestGetTotalBalanceResponseListGmsUserDeletedItemResponse