Class AdsManager

Hierarchy (View Summary)

BaseManager
- AdsManager

Constructors

constructor

new AdsManager(config: ShopeeConfig): AdsManager
Parameters
- config: ShopeeConfig
Returns AdsManager
Overrides BaseManager.constructor
- Defined in src/managers/ads.manager.ts:59

Properties

`Protected`config

config: ShopeeConfig

Methods

checkCreateGmsProductCampaignEligibility

checkCreateGmsProductCampaignEligibility(
params?: CheckCreateGmsProductCampaignEligibilityRequest,
): Promise<CheckCreateGmsProductCampaignEligibilityResponse>
Check the seller's eligibility in creating a GMS campaign
Parameters
- Optionalparams: CheckCreateGmsProductCampaignEligibilityRequest
  Request parameters
Returns Promise<CheckCreateGmsProductCampaignEligibilityResponse>
Promise resolving to the response
- Defined in src/managers/ads.manager.ts:68

createAutoProductAds

createAutoProductAds(
params?: CreateAutoProductAdsRequest,
): Promise<CreateAutoProductAdsResponse>
Use this API to create Auto Product Ads
Parameters
- Optionalparams: CreateAutoProductAdsRequest
  Request parameters
Returns Promise<CreateAutoProductAdsResponse>
Promise resolving to the response
- Defined in src/managers/ads.manager.ts:87

createGmsProductCampaign

createGmsProductCampaign(
params?: CreateGmsProductCampaignRequest,
): Promise<CreateGmsProductCampaignResponse>
Create a GMS campaign
Parameters
- Optionalparams: CreateGmsProductCampaignRequest
  Request parameters
Returns Promise<CreateGmsProductCampaignResponse>
Promise resolving to the response
- Defined in src/managers/ads.manager.ts:106

createManualProductAds

createManualProductAds(
params?: CreateManualProductAdsRequest,
): Promise<CreateManualProductAdsResponse>
Use this API to create Manual Selection Product Ads
Parameters
- Optionalparams: CreateManualProductAdsRequest
  Request parameters
Returns Promise<CreateManualProductAdsResponse>
Promise resolving to the response
- Defined in src/managers/ads.manager.ts:125

editAutoProductAds

editAutoProductAds(
params?: EditAutoProductAdsRequest,
): Promise<EditAutoProductAdsResponse>
Use this API to edit Auto Product Ads
Parameters
- Optionalparams: EditAutoProductAdsRequest
  Request parameters
Returns Promise<EditAutoProductAdsResponse>
Promise resolving to the response
- Defined in src/managers/ads.manager.ts:144

editGmsItemProductCampaign

editGmsItemProductCampaign(
params?: EditGmsItemProductCampaignRequest,
): Promise<EditGmsItemProductCampaignResponse>
Add/remove items to/from the GMS Campaign
Parameters
- Optionalparams: EditGmsItemProductCampaignRequest
  Request parameters
Returns Promise<EditGmsItemProductCampaignResponse>
Promise resolving to the response
- Defined in src/managers/ads.manager.ts:163

editGmsProductCampaign

editGmsProductCampaign(
params?: EditGmsProductCampaignRequest,
): Promise<EditGmsProductCampaignResponse>
Edit a GMS campaign
Parameters
- Optionalparams: EditGmsProductCampaignRequest
  Request parameters
Returns Promise<EditGmsProductCampaignResponse>
Promise resolving to the response
- Defined in src/managers/ads.manager.ts:182

editManualProductAdKeywords

editManualProductAdKeywords(
params?: EditManualProductAdKeywordsRequest,
): Promise<EditManualProductAdKeywordsResponse>
Use this API to edit Manual Selection Product Ad Keywords
Parameters
- Optionalparams: EditManualProductAdKeywordsRequest
  Request parameters
Returns Promise<EditManualProductAdKeywordsResponse>
Promise resolving to the response
- Defined in src/managers/ads.manager.ts:201

editManualProductAds

editManualProductAds(
params?: EditManualProductAdsRequest,
): Promise<EditManualProductAdsResponse>
Use this API to edit Manual Selection Product Ads
Parameters
- Optionalparams: EditManualProductAdsRequest
  Request parameters
Returns Promise<EditManualProductAdsResponse>
Promise resolving to the response
- Defined in src/managers/ads.manager.ts:220

getAdsFacilShopRate

getAdsFacilShopRate(
params?: GetAdsFacilShopRateRequest,
): Promise<GetAdsFacilShopRateResponse>
Get shop rate for Ads Facil Program
Parameters
- Optionalparams: GetAdsFacilShopRateRequest
  Request parameters
Returns Promise<GetAdsFacilShopRateResponse>
Promise resolving to the response
- Defined in src/managers/ads.manager.ts:239

getAllCpcAdsDailyPerformance

getAllCpcAdsDailyPerformance(
params?: GetAllCpcAdsDailyPerformanceRequest,
): Promise<GetAllCpcAdsDailyPerformanceResponse>
Use this API to get Shop level CPC ads multiple-days daily performance.
Parameters
- Optionalparams: GetAllCpcAdsDailyPerformanceRequest
  Request parameters
Returns Promise<GetAllCpcAdsDailyPerformanceResponse>
Promise resolving to the response
- Defined in src/managers/ads.manager.ts:258

getAllCpcAdsHourlyPerformance

getAllCpcAdsHourlyPerformance(
params?: GetAllCpcAdsHourlyPerformanceRequest,
): Promise<GetAllCpcAdsHourlyPerformanceResponse>
Use this API to get Shop level CPC ads single-date hourly performance.
Parameters
- Optionalparams: GetAllCpcAdsHourlyPerformanceRequest
  Request parameters
Returns Promise<GetAllCpcAdsHourlyPerformanceResponse>
Promise resolving to the response
- Defined in src/managers/ads.manager.ts:277

getCreateProductAdBudgetSuggestion

getCreateProductAdBudgetSuggestion(
params?: GetCreateProductAdBudgetSuggestionRequest,
): Promise<GetCreateProductAdBudgetSuggestionResponse>
Call this API to get budget suggestion for product ads creation
Parameters
- Optionalparams: GetCreateProductAdBudgetSuggestionRequest
  Request parameters
Returns Promise<GetCreateProductAdBudgetSuggestionResponse>
Promise resolving to the response
- Defined in src/managers/ads.manager.ts:296

getGmsCampaignPerformance

getGmsCampaignPerformance(
params?: GetGmsCampaignPerformanceRequest,
): Promise<GetGmsCampaignPerformanceResponse>
Get GMS Campaign performance
Parameters
- Optionalparams: GetGmsCampaignPerformanceRequest
  Request parameters
Returns Promise<GetGmsCampaignPerformanceResponse>
Promise resolving to the response
- Defined in src/managers/ads.manager.ts:315

getGmsItemPerformance

getGmsItemPerformance(
params?: GetGmsItemPerformanceRequest,
): Promise<GetGmsItemPerformanceResponse>
Get GMS Item performance
1. The response returned is sorted by item_id
2. Only items with performance will be returned
Parameters
- Optionalparams: GetGmsItemPerformanceRequest
  Request parameters
Returns Promise<GetGmsItemPerformanceResponse>
Promise resolving to the response
- Defined in src/managers/ads.manager.ts:336

getProductCampaignDailyPerformance

getProductCampaignDailyPerformance(
params?: GetProductCampaignDailyPerformanceRequest,
): Promise<GetProductCampaignDailyPerformanceResponse>
Use this API to get Product level ads multiple-days daily performance.
Parameters
- Optionalparams: GetProductCampaignDailyPerformanceRequest
  Request parameters
Returns Promise<GetProductCampaignDailyPerformanceResponse>
Promise resolving to the response
- Defined in src/managers/ads.manager.ts:355

getProductCampaignHourlyPerformance

getProductCampaignHourlyPerformance(
params?: GetProductCampaignHourlyPerformanceRequest,
): Promise<GetProductCampaignHourlyPerformanceResponse>
Use this API to get Product level ads single-day hourly performance.
Parameters
- Optionalparams: GetProductCampaignHourlyPerformanceRequest
  Request parameters
Returns Promise<GetProductCampaignHourlyPerformanceResponse>
Promise resolving to the response
- Defined in src/managers/ads.manager.ts:374

getProductLevelCampaignIdList

getProductLevelCampaignIdList(
params?: GetProductLevelCampaignIdListRequest,
): Promise<GetProductLevelCampaignIdListResponse>
Call this API to fetch all the product campaign ids displayed on advertiser platform under a specific Shop
Parameters
- Optionalparams: GetProductLevelCampaignIdListRequest
  Request parameters
Returns Promise<GetProductLevelCampaignIdListResponse>
Promise resolving to the response
- Defined in src/managers/ads.manager.ts:393

getProductLevelCampaignSettingInfo

getProductLevelCampaignSettingInfo(
params?: GetProductLevelCampaignSettingInfoRequest,
): Promise<GetProductLevelCampaignSettingInfoResponse>
Call this API to fetch all the campaign setting info under this Shop.
Parameters
- Optionalparams: GetProductLevelCampaignSettingInfoRequest
  Request parameters
Returns Promise<GetProductLevelCampaignSettingInfoResponse>
Promise resolving to the response
- Defined in src/managers/ads.manager.ts:412

getProductRecommendedRoiTarget

getProductRecommendedRoiTarget(
params?: GetProductRecommendedRoiTargetRequest,
): Promise<GetProductRecommendedRoiTargetResponse>
Get Product Recommended ROI Target
Parameters
- Optionalparams: GetProductRecommendedRoiTargetRequest
  Request parameters
Returns Promise<GetProductRecommendedRoiTargetResponse>
Promise resolving to the response
- Defined in src/managers/ads.manager.ts:431

getRecommendedItemList

getRecommendedItemList(
params?: GetRecommendedItemListRequest,
): Promise<GetRecommendedItemListResponse>
Use this API to get the list of recommended SKU (Shop level) with the corresponding tag, i.e top search/best selling/best ROI tag.
Parameters
- Optionalparams: GetRecommendedItemListRequest
  Request parameters
Returns Promise<GetRecommendedItemListResponse>
Promise resolving to the response
- Defined in src/managers/ads.manager.ts:450

getRecommendedKeywordList

getRecommendedKeywordList(
params?: GetRecommendedKeywordListRequest,
): Promise<GetRecommendedKeywordListResponse>
Use this API to get the list of Recommended keywords by item and optionally a search keyword
Parameters
- Optionalparams: GetRecommendedKeywordListRequest
  Request parameters
Returns Promise<GetRecommendedKeywordListResponse>
Promise resolving to the response
- Defined in src/managers/ads.manager.ts:469

getShopToggleInfo

getShopToggleInfo(
params?: GetShopToggleInfoRequest,
): Promise<GetShopToggleInfoResponse>
Use this API to get Shop level info - i.e. seller's toggle status is on/off
Parameters
- Optionalparams: GetShopToggleInfoRequest
  Request parameters
Returns Promise<GetShopToggleInfoResponse>
Promise resolving to the response
- Defined in src/managers/ads.manager.ts:488

getTotalBalance

getTotalBalance(
params?: GetTotalBalanceRequest,
): Promise<GetTotalBalanceResponse>
Use this API to return the seller's Real-time total balance of their ads credit including the paid credits and free credits.
Parameters
- Optionalparams: GetTotalBalanceRequest
  Request parameters
Returns Promise<GetTotalBalanceResponse>
Promise resolving to the response
- Defined in src/managers/ads.manager.ts:504

listGmsUserDeletedItem

listGmsUserDeletedItem(
params?: ListGmsUserDeletedItemRequest,
): Promise<ListGmsUserDeletedItemResponse>
List GMS items that have been removed from the Campaign by seller
Parameters
- Optionalparams: ListGmsUserDeletedItemRequest
  Request parameters
Returns Promise<ListGmsUserDeletedItemResponse>
Promise resolving to the response
- Defined in src/managers/ads.manager.ts:518

Class AdsManager

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns AdsManager

Properties

Protectedconfig

Methods

checkCreateGmsProductCampaignEligibility

Parameters

Returns Promise<CheckCreateGmsProductCampaignEligibilityResponse>

createAutoProductAds

Parameters

Returns Promise<CreateAutoProductAdsResponse>

createGmsProductCampaign

Parameters

Returns Promise<CreateGmsProductCampaignResponse>

createManualProductAds

Parameters

Returns Promise<CreateManualProductAdsResponse>

editAutoProductAds

Parameters

Returns Promise<EditAutoProductAdsResponse>

editGmsItemProductCampaign

Parameters

Returns Promise<EditGmsItemProductCampaignResponse>

editGmsProductCampaign

Parameters

Returns Promise<EditGmsProductCampaignResponse>

editManualProductAdKeywords

Parameters

Returns Promise<EditManualProductAdKeywordsResponse>

editManualProductAds

Parameters

Returns Promise<EditManualProductAdsResponse>

getAdsFacilShopRate

Parameters

Returns Promise<GetAdsFacilShopRateResponse>

getAllCpcAdsDailyPerformance

Parameters

Returns Promise<GetAllCpcAdsDailyPerformanceResponse>

getAllCpcAdsHourlyPerformance

Parameters

Returns Promise<GetAllCpcAdsHourlyPerformanceResponse>

getCreateProductAdBudgetSuggestion

Parameters

Returns Promise<GetCreateProductAdBudgetSuggestionResponse>

getGmsCampaignPerformance

Parameters

Returns Promise<GetGmsCampaignPerformanceResponse>

getGmsItemPerformance

Parameters

Returns Promise<GetGmsItemPerformanceResponse>

getProductCampaignDailyPerformance

Parameters

Returns Promise<GetProductCampaignDailyPerformanceResponse>

getProductCampaignHourlyPerformance

Parameters

Returns Promise<GetProductCampaignHourlyPerformanceResponse>

getProductLevelCampaignIdList

Parameters

Returns Promise<GetProductLevelCampaignIdListResponse>

getProductLevelCampaignSettingInfo

Parameters

Returns Promise<GetProductLevelCampaignSettingInfoResponse>

getProductRecommendedRoiTarget

Parameters

Returns Promise<GetProductRecommendedRoiTargetResponse>

getRecommendedItemList

Parameters

Returns Promise<GetRecommendedItemListResponse>

getRecommendedKeywordList

Parameters

Returns Promise<GetRecommendedKeywordListResponse>

getShopToggleInfo

`Protected`config