Class PrincipalManager

Hierarchy (View Summary)

BaseManager
- PrincipalManager

Index

Constructors

Properties

Methods

getClipVideoPerformance getContentAffiliatePerformance getPrincipalAffiliatePerformance getPrincipalLivestreamPerformance getPrincipalSalesPerformanceDetail getPrincipalVideoPerformance getSessionLivestreamPerformance getShopAffiliatePerformance getShopLivestreamPerformance getShopSalesPerformanceDetail getShopVideoPerformance

Constructors

constructor

new PrincipalManager(config: ShopeeConfig): PrincipalManager
Parameters
- config: ShopeeConfig
Returns PrincipalManager
Overrides BaseManager.constructor
- Defined in src/managers/principal.manager.ts:31

Properties

`Protected`config

config: ShopeeConfig

Methods

getClipVideoPerformance

getClipVideoPerformance(
params?: GetClipVideoPerformanceRequest,
): Promise<GetClipVideoPerformanceResponse>
Queries video clip performance data for the specified videos within the selected time range. Supports request granularity by day, week, month, quarter, year, or customize, and returns both overall summary metrics and video-level detailed metrics.
Parameters
- Optionalparams: GetClipVideoPerformanceRequest
  Request parameters
Returns Promise<GetClipVideoPerformanceResponse>
Promise resolving to the response
- Defined in src/managers/principal.manager.ts:40

getContentAffiliatePerformance

getContentAffiliatePerformance(
params?: GetContentAffiliatePerformanceRequest,
): Promise<GetContentAffiliatePerformanceResponse>
Queries affiliate performance data for the specified content items within the selected time range. Supports request granularity by day, week, month, quarter, year, or customize, and returns both overall summary metrics and content-level detailed metrics with placed-order and confirmed-order views.
Parameters
- Optionalparams: GetContentAffiliatePerformanceRequest
  Request parameters
Returns Promise<GetContentAffiliatePerformanceResponse>
Promise resolving to the response
- Defined in src/managers/principal.manager.ts:59

getPrincipalAffiliatePerformance

getPrincipalAffiliatePerformance(
params?: GetPrincipalAffiliatePerformanceRequest,
): Promise<GetPrincipalAffiliatePerformanceResponse>
Queries affiliate performance data for the specified principal within the selected time range. Supports request granularity by day, week, month, quarter, year, or customize, and returns both overall summary metrics and region-level detailed metrics with placed-order and confirmed-order views.
Parameters
- Optionalparams: GetPrincipalAffiliatePerformanceRequest
  Request parameters
Returns Promise<GetPrincipalAffiliatePerformanceResponse>
Promise resolving to the response
- Defined in src/managers/principal.manager.ts:78

getPrincipalLivestreamPerformance

getPrincipalLivestreamPerformance(
params?: GetPrincipalLivestreamPerformanceRequest,
): Promise<GetPrincipalLivestreamPerformanceResponse>
Queries livestream performance data for the specified principal within the selected time range. Supports request granularity by day, week, month, quarter, year, or customize, and returns both overall summary metrics and region-level detailed metrics.
Parameters
- Optionalparams: GetPrincipalLivestreamPerformanceRequest
  Request parameters
Returns Promise<GetPrincipalLivestreamPerformanceResponse>
Promise resolving to the response
- Defined in src/managers/principal.manager.ts:97

getPrincipalSalesPerformanceDetail

getPrincipalSalesPerformanceDetail(
params?: GetPrincipalSalesPerformanceDetailRequest,
): Promise<GetPrincipalSalesPerformanceDetailResponse>
Queries the business performance data aggregated at principal level for the specified regions within the selected time range. Supports request granularity by day, week, month, quarter, year, or customize, and returns both overall summary metrics and region-level detailed metrics.
Parameters
- Optionalparams: GetPrincipalSalesPerformanceDetailRequest
  Request parameters
Returns Promise<GetPrincipalSalesPerformanceDetailResponse>
Promise resolving to the response
- Defined in src/managers/principal.manager.ts:116

getPrincipalVideoPerformance

getPrincipalVideoPerformance(
params?: GetPrincipalVideoPerformanceRequest,
): Promise<GetPrincipalVideoPerformanceResponse>
Queries video performance data for the specified principal within the selected time range. Supports request granularity by day, week, month, quarter, year, or customize, and returns both overall summary metrics and region-level detailed metrics.
Parameters
- Optionalparams: GetPrincipalVideoPerformanceRequest
  Request parameters
Returns Promise<GetPrincipalVideoPerformanceResponse>
Promise resolving to the response
- Defined in src/managers/principal.manager.ts:135

getSessionLivestreamPerformance

getSessionLivestreamPerformance(
params?: GetSessionLivestreamPerformanceRequest,
): Promise<GetSessionLivestreamPerformanceResponse>
Queries livestream session performance data for the specified sessions within the selected time range. Supports request granularity by day, week, month, quarter, year, or customize, and returns both overall summary metrics and session-level detailed metrics.
Parameters
- Optionalparams: GetSessionLivestreamPerformanceRequest
  Request parameters
Returns Promise<GetSessionLivestreamPerformanceResponse>
Promise resolving to the response
- Defined in src/managers/principal.manager.ts:154

getShopAffiliatePerformance

getShopAffiliatePerformance(
params?: GetShopAffiliatePerformanceRequest,
): Promise<GetShopAffiliatePerformanceResponse>
Queries affiliate performance data for the specified shops within the selected time range. Supports request granularity by day, week, month, quarter, year, or customize, and returns both overall summary metrics and shop-level detailed metrics with placed-order and confirmed-order views.
Parameters
- Optionalparams: GetShopAffiliatePerformanceRequest
  Request parameters
Returns Promise<GetShopAffiliatePerformanceResponse>
Promise resolving to the response
- Defined in src/managers/principal.manager.ts:173

getShopLivestreamPerformance

getShopLivestreamPerformance(
params?: GetShopLivestreamPerformanceRequest,
): Promise<GetShopLivestreamPerformanceResponse>
Queries livestream performance data for the specified shops within the selected time range. Supports request granularity by day, week, month, quarter, year, or customize, and returns both overall summary metrics and shop-level detailed metrics.
Parameters
- Optionalparams: GetShopLivestreamPerformanceRequest
  Request parameters
Returns Promise<GetShopLivestreamPerformanceResponse>
Promise resolving to the response
- Defined in src/managers/principal.manager.ts:192

getShopSalesPerformanceDetail

getShopSalesPerformanceDetail(
params?: GetShopSalesPerformanceDetailRequest,
): Promise<GetShopSalesPerformanceDetailResponse>
Queries the business performance data of stores under the specified entity within the selected time range. Supports request granularity by day, week, month, quarter, year, or customize, and returns both overall summary metrics and store-level detailed metrics.
Parameters
- Optionalparams: GetShopSalesPerformanceDetailRequest
  Request parameters
Returns Promise<GetShopSalesPerformanceDetailResponse>
Promise resolving to the response
- Defined in src/managers/principal.manager.ts:211

getShopVideoPerformance

getShopVideoPerformance(
params?: GetShopVideoPerformanceRequest,
): Promise<GetShopVideoPerformanceResponse>
Queries video performance data for the specified shops within the selected time range. Supports request granularity by day, week, month, quarter, year, or customize, and returns both overall summary metrics and shop-level detailed metrics.
Parameters
- Optionalparams: GetShopVideoPerformanceRequest
  Request parameters
Returns Promise<GetShopVideoPerformanceResponse>
Promise resolving to the response
- Defined in src/managers/principal.manager.ts:230

Class PrincipalManager

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PrincipalManager

Properties

Protectedconfig

Methods

getClipVideoPerformance

Parameters

Returns Promise<GetClipVideoPerformanceResponse>

getContentAffiliatePerformance

Parameters

Returns Promise<GetContentAffiliatePerformanceResponse>

getPrincipalAffiliatePerformance

Parameters

Returns Promise<GetPrincipalAffiliatePerformanceResponse>

getPrincipalLivestreamPerformance

Parameters

Returns Promise<GetPrincipalLivestreamPerformanceResponse>

getPrincipalSalesPerformanceDetail

Parameters

Returns Promise<GetPrincipalSalesPerformanceDetailResponse>

getPrincipalVideoPerformance

Parameters

Returns Promise<GetPrincipalVideoPerformanceResponse>

getSessionLivestreamPerformance

Parameters

Returns Promise<GetSessionLivestreamPerformanceResponse>

getShopAffiliatePerformance

Parameters

Returns Promise<GetShopAffiliatePerformanceResponse>

getShopLivestreamPerformance

Parameters

Returns Promise<GetShopLivestreamPerformanceResponse>

getShopSalesPerformanceDetail

Parameters

Returns Promise<GetShopSalesPerformanceDetailResponse>

getShopVideoPerformance

Parameters

Returns Promise<GetShopVideoPerformanceResponse>

Settings

On This Page

`Protected`config