MediaClient

​

Submódulos

• Módulo xdk.media.client
  • MediaClient
    • MediaClient.__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()
• Módulo xdk.media.models
  • AppendUploadRequest
    • AppendUploadRequest.model_config
  • AppendUploadResponse
    • AppendUploadResponse.model_config
  • CreateMetadataRequest
    • CreateMetadataRequest.model_config
  • CreateMetadataResponse
    • CreateMetadataResponse.model_config
  • CreateSubtitlesRequest
    • CreateSubtitlesRequest.model_config
  • CreateSubtitlesResponse
    • CreateSubtitlesResponse.model_config
  • DeleteSubtitlesRequest
    • DeleteSubtitlesRequest.model_config
  • DeleteSubtitlesResponse
    • DeleteSubtitlesResponse.model_config
  • FinalizeUploadResponse
    • FinalizeUploadResponse.model_config
  • GetAnalyticsResponse
    • GetAnalyticsResponse.model_config
  • GetByKeyResponse
    • GetByKeyResponse.model_config
  • GetByKeysResponse
    • GetByKeysResponse.model_config
  • GetUploadStatusResponse
    • GetUploadStatusResponse.model_config
  • InitializeUploadRequest
    • InitializeUploadRequest.model_config
  • InitializeUploadResponse
    • InitializeUploadResponse.model_config
  • UploadRequest
    • UploadRequest.model_config
  • UploadResponse
    • UploadResponse.model_config

​

Contenido del módulo

Este módulo proporciona acceso a los endpoints de medios de la X API y sirve como punto de entrada principal para toda la funcionalidad relacionada con los medios.

​

class xdk.media.MediaClient

Client para operaciones de contenido multimedia

​

Parámetros

path.client · Client

​

__init__

​

Parámetros

path.client · Client

​

append_upload

Anexar subida de medios Agrega datos a una solicitud de subida de medios.

​

Parámetros

path.id · Any

El identificador del contenido multimedia sobre el que se va a realizar la operación de anexión.

body.body · AppendUploadRequest

Cuerpo de la solicitud

​

create_metadata

Crear metadatos de un archivo multimedia Crea metadatos para un archivo multimedia. body: Cuerpo de la solicitud :returns: Datos de la respuesta :rtype: CreateMetadataResponse

​

Parámetros

body.body · CreateMetadataRequest

​

create_subtitles

Crear subtítulos de Media Crea subtítulos para un archivo de Media específico. body: Cuerpo de la solicitud :returns: Datos de respuesta :rtype: CreateSubtitlesResponse

​

Parámetros

body.body · CreateSubtitlesRequest

​

delete_subtitles

Eliminar subtítulos de Media Elimina los subtítulos de un archivo de Media específico. body: Cuerpo de la solicitud :returns: Datos de la respuesta :rtype: DeleteSubtitlesResponse

​

Parámetros

body.body · DeleteSubtitlesRequest

​

finalize_upload

Finalizar carga de medios Finaliza una solicitud de carga de medios.

​

Parámetros

path.id · Any

El id del contenido multimedia de destino que se va a finalizar.

​

Valor devuelto

FinalizeUploadResponse - datos de la respuesta

​

get_analytics

Obtener analítica de medios Recupera datos de analítica de medios.

​

Parameters

path.media_keys · List

Una lista separada por comas de claves de medios. Se permiten hasta 100 en una sola solicitud.

path.end_time · str

YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo en UTC que representa el final del intervalo de tiempo.

path.start_time · str

YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo en UTC que representa el inicio del intervalo de tiempo.

path.granularity · str

La granularidad para los resultados de recuentos de búsqueda.

path.media_analytics_fields · List or None · predeterminado: "None"

Una lista separada por comas de campos de MediaAnalytics para mostrar.

​

Devuelve

GetAnalyticsResponse - Datos de respuesta

​

get_by_key

Obtener contenido multimedia por media key Recupera los detalles de un archivo multimedia específico mediante su media key.

​

Parámetros

path.media_key · Any

Una única Media Key.

path.media_fields · List or None · predeterminado: "None"

Una lista separada por comas de campos de Media a mostrar.

​

Valores devueltos

GetByKeyResponse - Datos de la respuesta

​

get_by_keys

Obtener objetos Media por media keys Obtiene los detalles de los archivos Media mediante sus media keys.

​

Parámetros

path.media_keys · List

Una lista de Media Keys separadas por comas. Se permiten hasta 100 en una sola solicitud.

path.media_fields · List or None · predeterminado: "None"

Una lista de campos de Media separados por comas que se van a mostrar.

​

Devuelve

GetByKeysResponse - Datos de respuesta

​

get_upload_status

Obtiene el estado de una carga de Media Obtiene el estado de una carga de Media mediante su id.

​

Parámetros

path.media_id · Any

id del contenido multimedia para el estado de la carga solicitada.

path.command · str or None · predeterminado: "None"

El comando de la solicitud de carga de contenido multimedia.

​

Devuelve

GetUploadStatusResponse - Datos de la respuesta

​

initialize_upload

Inicializar la subida de medios Inicializa una subida de medios. body: Cuerpo de la solicitud :returns: Datos de la respuesta :rtype: InitializeUploadResponse

​

Parámetros

body.body · InitializeUploadRequest

​

upload

Subir contenido multimedia Sube un archivo multimedia para usarlo en Publicaciones u otro tipo de contenido. body: Cuerpo de la solicitud :returns: Datos de la respuesta :rtype: UploadResponse

​

Parámetros

body.body · UploadRequest