Submódulos
- xdk.media.client module
MediaClientMediaClient.__init__()MediaClient.append_upload()MediaClient.create_metadata()MediaClient.create_subtitles()MediaClient.delete_subtitles()MediaClient.finalize_upload()MediaClient.get_analytics()MediaClient.get_by_key()MediaClient.get_by_keys()MediaClient.get_upload_status()MediaClient.initialize_upload()MediaClient.upload()
- xdk.media.models module
AppendUploadRequestAppendUploadResponseCreateMetadataRequestCreateMetadataResponseCreateSubtitlesRequestCreateSubtitlesResponseDeleteSubtitlesRequestDeleteSubtitlesResponseFinalizeUploadResponseGetAnalyticsResponseGetByKeyResponseGetByKeysResponseGetUploadStatusResponseInitializeUploadRequestInitializeUploadResponseUploadRequestUploadResponse
Conteúdo do módulo
Este módulo fornece acesso aos endpoints media da X API e serve como o principal ponto de entrada para toda a funcionalidade relacionada a media.class xdk.media.MediaClient
Client para operações de media
Parâmetros
Client
__init__
Parâmetros
Client
append_upload
Append Media upload
Appends data to a Media upload request.
Parâmetros
Any
The media identifier for the media to perform the append operation.
AppendUploadRequest
Request body
create_metadata
Create Media metadata
Creates metadata for a Media file.
body: Request body
:returns: Response data
:rtype: CreateMetadataResponse
Parâmetros
CreateMetadataRequest
create_subtitles
Create Media subtitles
Creates subtitles for a specific Media file.
body: Request body
:returns: Response data
:rtype: CreateSubtitlesResponse
Parâmetros
CreateSubtitlesRequest
delete_subtitles
Delete Media subtitles
Deletes subtitles for a specific Media file.
body: Request body
:returns: Response data
:rtype: DeleteSubtitlesResponse
Parâmetros
DeleteSubtitlesRequest
finalize_upload
Finalize Media upload
Finalizes a Media upload request.
Parâmetros
Any
The media id of the targeted media to finalize.
Retorna
FinalizeUploadResponse - Response data
get_analytics
Get Media analytics
Retrieves analytics data for media.
Parâmetros
List
A comma separated list of Media Keys. Up to 100 are allowed in a single request.
str
YYYY-MM-DDTHH:mm:ssZ. The UTC timestamp representing the end of the time range.
str
YYYY-MM-DDTHH:mm:ssZ. The UTC timestamp representing the start of the time range.
str
The granularity for the search counts results.
List or None
default:"None"
A comma separated list of MediaAnalytics fields to display.
Retorna
GetAnalyticsResponse - Response data
get_by_key
Get Media by media key
Retrieves details of a specific Media file by its media key.
Parâmetros
Any
A single Media Key.
List or None
default:"None"
A comma separated list of Media fields to display.
Retorna
GetByKeyResponse - Response data
get_by_keys
Get Media by media keys
Retrieves details of Media files by their media keys.
Parâmetros
List
A comma separated list of Media Keys. Up to 100 are allowed in a single request.
List or None
default:"None"
A comma separated list of Media fields to display.
Retorna
GetByKeysResponse - Response data
get_upload_status
Get Media upload status
Retrieves the status of a Media upload by its ID.
Parâmetros
Any
Media id for the requested media upload status.
str or None
default:"None"
The command for the media upload request.
Retorna
GetUploadStatusResponse - Response data
initialize_upload
Initialize media upload
Initializes a media upload.
body: Request body
:returns: Response data
:rtype: InitializeUploadResponse
Parâmetros
InitializeUploadRequest
upload
Upload media
Uploads a media file for use in posts or other content.
body: Request body
:returns: Response data
:rtype: UploadResponse
Parâmetros
UploadRequest