MediaClient

​

Sous-modules

• Module 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()
• Module 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

​

Contenu du module

Ce module donne accès aux endpoints média de la X API et constitue le point d’entrée principal pour toutes les fonctionnalités liées aux médias.

​

class xdk.media.MediaClient

Client pour les opérations multimédia

​

Paramètres

path.client · Client

​

__init__

​

Paramètres

path.client · Client

​

append_upload

Ajout à un téléversement de média Ajoute des données à une requête de téléversement de média.

​

Paramètres

path.id · Any

L’identifiant du média sur lequel effectuer l’opération d’ajout.

body.body · AppendUploadRequest

Corps de la requête

​

create_metadata

Créer les métadonnées d’un média Crée les métadonnées pour un fichier média. body: Corps de la requête :returns: Données de la réponse :rtype: CreateMetadataResponse

​

Paramètres

body.body · CreateMetadataRequest

​

create_subtitles

Créer des sous-titres pour un objet Media Crée des sous-titres pour un objet Media spécifique. body: Corps de la requête :returns: Données de la réponse :rtype: CreateSubtitlesResponse

​

Paramètres

body.body · CreateSubtitlesRequest

​

delete_subtitles

Supprimer les sous-titres Media Supprime les sous-titres pour un fichier Media spécifique. body: Corps de la requête :returns: Données de la réponse :rtype: DeleteSubtitlesResponse

​

Paramètres

body.body · DeleteSubtitlesRequest

​

finalize_upload

Finaliser le téléversement d’un média Finalise une requête de téléversement de média.

​

Paramètres

path.id · Any

L’id du média cible à finaliser.

​

Renvoie

FinalizeUploadResponse - Données de la réponse

​

get_analytics

Obtenir les statistiques des médias Récupère les données d’analyse pour les médias.

​

Paramètres

path.media_keys · List

Une liste séparée par des virgules de clés de média. Jusqu’à 100 sont autorisées dans une seule requête.

path.end_time · str

YYYY-MM-DDTHH:mm:ssZ. L’horodatage UTC représentant la fin de l’intervalle de temps.

path.start_time · str

YYYY-MM-DDTHH:mm:ssZ. L’horodatage UTC représentant le début de l’intervalle de temps.

path.granularity · str

La granularité pour les résultats de comptage de la recherche.

path.media_analytics_fields · List or None · défaut: "None"

Une liste séparée par des virgules de champs MediaAnalytics à afficher.

​

Valeur de retour

GetAnalyticsResponse - Données de la réponse

​

get_by_key

Obtenir un média par clé média Récupère les détails d’un fichier média spécifique à partir de sa clé média.

​

Paramètres

path.media_key · Any

Une seule clé Media.

path.media_fields · List or None · défaut: "None"

Une liste de champs Media, séparés par des virgules, à afficher.

​

Renvoie

GetByKeyResponse - Données de la réponse

​

get_by_keys

Obtenir des médias par clés média Récupère les détails des fichiers média à partir de leurs clés média.

​

Paramètres

path.media_keys · List

Une liste de Media Keys, séparées par des virgules. Jusqu’à 100 peuvent être fournies dans une seule requête.

path.media_fields · List or None · défaut: "None"

Une liste de champs média à afficher, séparés par des virgules.

​

Renvoie

GetByKeysResponse - Données de réponse

​

get_upload_status

Obtenir l’état du téléversement de média Récupère l’état d’un téléversement de média par son identifiant.

​

Paramètres

path.media_id · Any

id du média pour lequel le statut de téléversement est demandé.

path.command · str or None · défaut: "None"

Commande de la requête de téléversement de média.

​

Valeur de retour

GetUploadStatusResponse - Données de la réponse

​

initialize_upload

Initialiser le téléversement de médias Initialise un téléversement de médias. body: Corps de la requête :returns: Données de la réponse :rtype: InitializeUploadResponse

​

Paramètres

body.body · InitializeUploadRequest

​

upload

Téléverser un média Téléverse un fichier média à utiliser dans des publications ou d’autres contenus. body: Corps de la requête :returns: Données de la réponse :rtype: UploadResponse

​

Paramètres

body.body · UploadRequest