video.md

Video Client Usage

• Check Upload Permission of Client
• Upload Video
• Get Video
• Update Video Parameters
• Partially Update Video Parameters
• Delete Video

Check Upload Permission of Client

To Check if client has permission to upload video.

>>> api_client.video.has_permission()
VideoPermissionResponse(result=True, at_userid='example_at_userid', region='tw', userid='example_userid')

Upload Video

Upload video from local file.

>>> api_client.video.upload(file='FILENAME')
VideoUploadResponse(result=True, video_id='example_video_id')

Get Video

Get the Video by its id.

>>> get_video_resp = api_client.video.get(video_id='example_video_id')
>>> get_video_resp.video
[BigGoVideo(...)]

Update Video Parameters

Parameters include video_id, access, description, product list, thumbnail_time and title.
Video parameters would be filled into the VideoParams object.
All parameters are required.
(See available Access type here)

>>> from biggo_api.enum import Access
>>> from biggo_api.data_models import VideoParams
>>> video_params = VideoParams(
...     video_id='example_video_id',
...     access=Access.PUBLIC,
...     description='DESCRIPTION',
...     title='TITLE',
... )
>>> api_client.video.update(video_params=video_params)
VideoUpdateResponse(result=True)

Partially Update Video Parameters

Update partial parameters of the video.
Video parameters would be filled into the VideoParams object.
At least one parameter except video_id is required.
(See available Access type here)

>>> from biggo_api.data_models import VideoParams
>>> video_params = VideoParams(
...     video_id='example_video_id',
...     access=Access.UNLISTED,
... )
>>> api_client.video.partial_update(video_params=video_params)
VideoUpdateResponse(result=True)

Delete Video

Delete the video by its id.

>>> api_client.video.delete(video_id='example_video_id')
VideoDeleteResponse(result=True)

---

⬆️ Back to top
↩️ Back to docs