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
Contenido del módulo
This module provides access to the media endpoints of the X API and serves as the main entry point for all media-related functionality.class xdk.media.MediaClient
Cliente para operaciones 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: Cuerpo de la solicitud
:returns: Datos de respuesta
:rtype: CreateMetadataResponse
Parámetros
CreateMetadataRequest
create_subtitles
Create Media subtitles
Creates subtitles for a specific Media file.
body: Cuerpo de la solicitud
:returns: Datos de respuesta
:rtype: CreateSubtitlesResponse
Parámetros
CreateSubtitlesRequest
delete_subtitles
Delete Media subtitles
Deletes subtitles for a specific Media file.
body: Cuerpo de la solicitud
:returns: Datos de respuesta
: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.
Devuelve
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. La marca de tiempo UTC que representa el final del rango de tiempo.
str
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC que representa el inicio del rango de tiempo.
str
La granularidad para los resultados de conteos de búsqueda.
List or None
default:"None"
A comma separated list of MediaAnalytics fields to display.
Devuelve
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"
Una lista separada por comas de campos de Media a mostrar.
Devuelve
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"
Una lista separada por comas de campos de Media a mostrar.
Devuelve
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.
Devuelve
GetUploadStatusResponse - Response data
initialize_upload
Initialize media upload
Initializes a media upload.
body: Cuerpo de la solicitud
:returns: Datos de respuesta
:rtype: InitializeUploadResponse
Parámetros
InitializeUploadRequest
upload
Upload media
Uploads a media file for use in posts or other content.
body: Cuerpo de la solicitud
:returns: Datos de respuesta
:rtype: UploadResponse
Parámetros
UploadRequest