Class VideoManager

Hierarchy (View Summary)

BaseManager
- VideoManager

Index

Constructors

Properties

Methods

deleteVideo editVideoInfo getCoverList getMetricTrend getOverviewPerformance getProdcutPerformanceList getUserDemographics getVideoDetail getVideoDetailAudienceDistribution getVideoDetailMetricTrend getVideoDetailPerformance getVideoDetailProductPerformance getVideoList getVideoPerformanceList postVideo

Constructors

constructor

new VideoManager(config: ShopeeConfig): VideoManager
Parameters
- config: ShopeeConfig
Returns VideoManager
Overrides BaseManager.constructor
- Defined in src/managers/video.manager.ts:39

Properties

`Protected`config

config: ShopeeConfig

Methods

deleteVideo

deleteVideo(params?: DeleteVideoRequest): Promise<DeleteVideoResponse>
Use this API to delete video. You can delete the video for both draft and post status.
Parameters
- Optionalparams: DeleteVideoRequest
  Request parameters
Returns Promise<DeleteVideoResponse>
Promise resolving to the response
- Defined in src/managers/video.manager.ts:48

editVideoInfo

editVideoInfo(params?: EditVideoInfoRequest): Promise<EditVideoInfoResponse>
You need to call v2.media.init_video_upload, v2.media.upload_video_part, and v2.media.complete_video_upload to upload the video, and call the v2.media.get_video_upload_result to get the video_upload_id of uploaded video first, then call this API to set video post information. After submit, the video is still draft status, you need to call v2.video.post_video to post the video to Shopee Video. You can only set and update post information before the video is post.
Parameters
- Optionalparams: EditVideoInfoRequest
  Request parameters
Returns Promise<EditVideoInfoResponse>
Promise resolving to the response
- Defined in src/managers/video.manager.ts:61

getCoverList

getCoverList(params?: GetCoverListRequest): Promise<GetCoverListResponse>
You need to call v2.media.init_video_upload, v2.media.upload_video_part, and v2.media.complete_video_upload to upload the video, and call the v2.media.get_video_upload_result to get the video_upload_id of uploaded video. After the video is uploaded, obtain the frame-by-frame results and select a specific frame as the video cover.
Parameters
- Optionalparams: GetCoverListRequest
  Request parameters
Returns Promise<GetCoverListResponse>
Promise resolving to the response
- Defined in src/managers/video.manager.ts:75

getMetricTrend

getMetricTrend(params?: GetMetricTrendRequest): Promise<GetMetricTrendResponse>
Query video data indicator trends.
Parameters
- Optionalparams: GetMetricTrendRequest
  Request parameters
Returns Promise<GetMetricTrendResponse>
Promise resolving to the response
- Defined in src/managers/video.manager.ts:88

getOverviewPerformance

getOverviewPerformance(
params?: GetOverviewPerformanceRequest,
): Promise<GetOverviewPerformanceResponse>
Get overall performance data for all post Shopee Video. There is at least a one-day delay.
Parameters
- Optionalparams: GetOverviewPerformanceRequest
  Request parameters
Returns Promise<GetOverviewPerformanceResponse>
Promise resolving to the response
- Defined in src/managers/video.manager.ts:101

getProdcutPerformanceList

getProdcutPerformanceList(
params?: GetProdcutPerformanceListRequest,
): Promise<GetProdcutPerformanceListResponse>
Get specific performance data for products linked with Shopee Video. There is at least a one-day delay.
Parameters
- Optionalparams: GetProdcutPerformanceListRequest
  Request parameters
Returns Promise<GetProdcutPerformanceListResponse>
Promise resolving to the response
- Defined in src/managers/video.manager.ts:120

getUserDemographics

getUserDemographics(
params?: GetUserDemographicsRequest,
): Promise<GetUserDemographicsResponse>
Get user demographics data to better understand the types of viewers that watch your Shopee Video.
Parameters
- Optionalparams: GetUserDemographicsRequest
  Request parameters
Returns Promise<GetUserDemographicsResponse>
Promise resolving to the response
- Defined in src/managers/video.manager.ts:139

getVideoDetail

getVideoDetail(params?: GetVideoDetailRequest): Promise<GetVideoDetailResponse>
Get the detail information of video.
Parameters
- Optionalparams: GetVideoDetailRequest
  Request parameters
Returns Promise<GetVideoDetailResponse>
Promise resolving to the response
- Defined in src/managers/video.manager.ts:158

getVideoDetailAudienceDistribution

getVideoDetailAudienceDistribution(
params?: GetVideoDetailAudienceDistributionRequest,
): Promise<GetVideoDetailAudienceDistributionResponse>
Get detailed audience distribution data for individual post Shopee Video. There is at least a one-day delay.
Parameters
- Optionalparams: GetVideoDetailAudienceDistributionRequest
  Request parameters
Returns Promise<GetVideoDetailAudienceDistributionResponse>
Promise resolving to the response
- Defined in src/managers/video.manager.ts:176

getVideoDetailMetricTrend

getVideoDetailMetricTrend(
params?: GetVideoDetailMetricTrendRequest,
): Promise<GetVideoDetailMetricTrendResponse>
Get detailed metric trend data for individual post Shopee Video. There is at least a one-day delay.
Parameters
- Optionalparams: GetVideoDetailMetricTrendRequest
  Request parameters
Returns Promise<GetVideoDetailMetricTrendResponse>
Promise resolving to the response
- Defined in src/managers/video.manager.ts:195

getVideoDetailPerformance

getVideoDetailPerformance(
params?: GetVideoDetailPerformanceRequest,
): Promise<GetVideoDetailPerformanceResponse>
Get detailed performance data for individual post Shopee Video. There is at least a one-day delay.
Parameters
- Optionalparams: GetVideoDetailPerformanceRequest
  Request parameters
Returns Promise<GetVideoDetailPerformanceResponse>
Promise resolving to the response
- Defined in src/managers/video.manager.ts:214

getVideoDetailProductPerformance

getVideoDetailProductPerformance(
params?: GetVideoDetailProductPerformanceRequest,
): Promise<GetVideoDetailProductPerformanceResponse>
Get performance data for products linked with individual post Shopee Video. There is at least a one-day delay.
Parameters
- Optionalparams: GetVideoDetailProductPerformanceRequest
  Request parameters
Returns Promise<GetVideoDetailProductPerformanceResponse>
Promise resolving to the response
- Defined in src/managers/video.manager.ts:234

getVideoList

getVideoList(params?: GetVideoListRequest): Promise<GetVideoListResponse>
Get the list of video in draft status or video already post to Shopee Video.
Parameters
- Optionalparams: GetVideoListRequest
  Request parameters
Returns Promise<GetVideoListResponse>
Promise resolving to the response
- Defined in src/managers/video.manager.ts:253

getVideoPerformanceList

getVideoPerformanceList(
params?: GetVideoPerformanceListRequest,
): Promise<GetVideoPerformanceListResponse>
Get specific performance data for individual post Shopee Video. There is at least a one-day delay.
Parameters
- Optionalparams: GetVideoPerformanceListRequest
  Request parameters
Returns Promise<GetVideoPerformanceListResponse>
Promise resolving to the response
- Defined in src/managers/video.manager.ts:271

postVideo

postVideo(params?: PostVideoRequest): Promise<PostVideoResponse>
You need to call v2.media.init_video_upload, v2.media.upload_video_part, and v2.media.complete_video_upload to upload the video, then call the v2.video.edit_video_info API to set video post information, finally call this API to post the video to Shopee Video.
Parameters
- Optionalparams: PostVideoRequest
  Request parameters
Returns Promise<PostVideoResponse>
Promise resolving to the response
- Defined in src/managers/video.manager.ts:291

Class VideoManager

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns VideoManager

Properties

Protectedconfig

Methods

deleteVideo

Parameters

Returns Promise<DeleteVideoResponse>

editVideoInfo

Parameters

Returns Promise<EditVideoInfoResponse>

getCoverList

Parameters

Returns Promise<GetCoverListResponse>

getMetricTrend

Parameters

Returns Promise<GetMetricTrendResponse>

getOverviewPerformance

Parameters

Returns Promise<GetOverviewPerformanceResponse>

getProdcutPerformanceList

Parameters

Returns Promise<GetProdcutPerformanceListResponse>

getUserDemographics

Parameters

Returns Promise<GetUserDemographicsResponse>

getVideoDetail

Parameters

Returns Promise<GetVideoDetailResponse>

getVideoDetailAudienceDistribution

Parameters

Returns Promise<GetVideoDetailAudienceDistributionResponse>

getVideoDetailMetricTrend

Parameters

Returns Promise<GetVideoDetailMetricTrendResponse>

getVideoDetailPerformance

Parameters

Returns Promise<GetVideoDetailPerformanceResponse>

getVideoDetailProductPerformance

Parameters

Returns Promise<GetVideoDetailProductPerformanceResponse>

getVideoList

Parameters

Returns Promise<GetVideoListResponse>

getVideoPerformanceList

Parameters

Returns Promise<GetVideoPerformanceListResponse>

postVideo

Parameters

Returns Promise<PostVideoResponse>

Settings

On This Page

`Protected`config