来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 Significant OpenAPI Updates for Shopee Video
Dear Developer,
To further enhance sellers’ operational efficiency and system integration capabilities in Shopee Video, Shopee is officially launching the Shopee Video Open API.
The Shopee Video Open API allows developers to integrate video content creation, management, and analytics into their systems. Sellers and affiliates can showcase products through engaging short videos, interact with viewers, and drive higher engagement and conversions.
§2 1. Key API Capabilities
1. Key API Capabilities
-
Video Upload: Upload videos via public video upload APIs and receive asynchronous notifications when uploads complete.
-
Video Management: Select video covers, set or edit video information, publish draft videos, query video details, and delete videos.
-
Performance Analytics: Retrieve overall video performance, metric trends, user demographics, individual video metrics, and product performance linked to videos.
§3 2. Integration Highlights
2. Integration Highlights
Integration consists of two parts:
- Public Video Upload APIs – for uploading videos and obtaining a video_upload_id:
- v2.media.init_video_upload: Initialize upload task.
- v2.media.upload_video_part: Upload video in parts.
- v2.media.complete_video_upload: Complete upload.
- v2.media.get_video_upload_result: Query upload result.
- v2.media.cancel_video_upload: Cancel upload.
- video_upload_result_push: Receive final status asynchronously.
- Shopee Video APIs – for managing and publishing videos, and tracking performance:
- v2.video.get_cover_list: Get video frame screenshots and select cover.
- v2.video.edit_video_info: Set or edit draft video info.
- v2.video.post_video: Publish draft video.
- v2.video.get_video_list: Retrieve video list.
- v2.video.get_video_detail: Retrieve video details.
- v2.video.delete_video: Delete draft or published videos.
- v2.video.get_overview_performance: Retrieve overall performance for all published videos.
- v2.video.get_metric_trend: Query trend data for core metrics over time.
- v2.video.get_user_demographics: Retrieve audience demographics.
- v2.video.get_video_performance_list: Get performance for individual videos.
- v2.video.get_product_performance_list: Retrieve performance data for products linked with videos.
For detailed instructions, please refer to the Shopee Video API Integration Guide.
§4 3. Access and Usage Guidelines
3. Access and Usage Guidelines
-
Application type requirement: Ensure your application type is “Shopee Video Management”, otherwise Video APIs cannot be called.
-
Authorization and Authentication: Shopee Video APIs are User-type APIs. All calls require user_id and access_token.
-
Seller agreement requirement: Confirm that sellers have signed the Shopee Video’s Terms & Conditions in Seller Center before API usage, or Video functionalities will not work properly.
For any technical issues during integration, please contact us via the Open Platform Ticket System.
Thank you for your continued trust and collaboration. Shopee looks forward to working with you to help sellers leverage video content to drive engagement and sales.
尊敬的开发者,
为进一步提升卖家在 Shopee Video 方面的运营效率与系统集成能力,Shopee 现正式推出 Shopee Video Open API。
Shopee Video Open API 允许开发者将视频上传、管理与数据分析功能集成到自身系统中。卖家与达人可通过生动的短视频展示商品、与观众互动,从而有效提升用户互动与转化率。
§5 1. API 核心能力
1. API 核心能力
1)视频上传:通过公共视频上传API上传视频,并可在上传完成后接收异步通知。
2)视频管理:选择视频封面,设置或编辑视频信息,发布草稿视频,查询视频详情以及删除视频。
3)数据分析:获取整体视频表现、指标趋势、用户画像、单个视频数据以及与视频关联的商品表现数据。
§6 2. 对接重点
2. 对接重点
对接分为两部分:
- 公共视频上传接口 – 用于上传视频并获取 video_upload_id:
- v2.media.init_video_upload:初始化上传任务。
- v2.media.upload_video_part:分片上传视频。
- v2.media.complete_video_upload:完成上传。
- v2.media.get_video_upload_result:查询上传结果。
- v2.media.cancel_video_upload:取消上传。
- video_upload_result_push:异步接收最终状态通知。
- Shopee Video APIs – 用于视频管理和表现分析:
- v2.video.get_cover_list:获取视频帧截图并选择封面。
- v2.video.edit_video_info:设置或编辑草稿视频信息。
- v2.video.post_video:发布草稿视频。
- v2.video.get_video_list:获取视频列表。
- v2.video.get_video_detail:获取视频详情。
- v2.video.delete_video:删除草稿或已发布视频。
- v2.video.get_overview_performance:获取所有已发布视频的整体表现。
- v2.video.get_metric_trend:查询核心指标趋势。
- v2.video.get_user_demographics:获取观众画像。
- v2.video.get_video_performance_list:获取单条视频表现。
- v2.video.get_product_performance_list:获取关联视频的商品表现。
详细内容请参考 Shopee Video API 对接指南。
§7 3. 接入及使用须知
3. 接入及使用须知
-
应用类型:请确保您的应用类型为 “Shopee Video Management”,否则无法调用 Video API。
-
授权与鉴权:Shopee Video API 为 User 类型接口,所有调用必须携带 user_id 和 access_token。
-
卖家签署要求:调用前请确保卖家已在 Seller Center 完成 Shopee Video 服务条款签署,否则无法正常使用 Video 功能。
在对接过程中如遇任何技术问题,请通过 Open Platform 工单系统 联系我们。
感谢您一如既往的信任与合作。Shopee 期待与您共同助力卖家利用 Shopee Video 提升用户参与和销售转化。
