Référence des champs de la liste de lecture de l'API CMS

Il s'agit d'une référence aux champs de liste de lecture renvoyés par l'API CMS.

Champs principaux

Tableau 1: Champs principaux
Champ Type Lecture seulement Défaut Description
id chaîne Oui aucun l'identifiant de la playlist
account_id chaîne Oui aucun l'identifiant du compte
created_at Chaîne date-heure ISO 8601 Oui aucun la liste de lecture date-heure a été ajoutée au compte ; Exemple: "2014-12-09T06:07:11.877Z"
description chaîne non nul la brève description de la playlist - 248 caractères mono-octet maximum
favorite booléen non faux si la liste de lecture est incluse dans les favoris
limit numéro non 1 000 nombre de vidéos que la liste de lecture peut contenir (entier, 1 - 1000) renvoyé pour les listes de lecture intelligentes uniquement
name chaîne non aucun Titre de la liste de lecture - champ obligatoire (longueur maximale : 248 caractères à un octet)
reference_id chaîne non nul toute valeur unique dans le compte
search chaîne non nul chaîne de recherche utilisée pour définir les vidéos d'une liste de lecture Smart (exemple : "+tags:"bird","birds"")
search_syntax chaîne non v1 la syntaxe de recherche (v1) utilisée pour une chaîne de recherche intelligente de listes de lecture - voir Gestion des listes de lecture
state chaîne Oui l'état d'une liste de lecture EXPLICIT(manuelle) UPDATING signifie que la liste met à jour ses membres vidéo et READY signifie que toutes les vidéos ont été ajoutées
type chaîne Oui le type de liste de lecture Voir note[1] ci-dessous
updated_at Chaîne date-heure ISO 8601 Oui aucun La liste de lecture date-heure a été modifiée pour la dernière fois ;[1-2] exemple : "2015-01-13T17:45:21.977Z"
video_ids déployer non tableau d'identifiants pour les vidéos de la playlist Renvoyé pour les listes de lecture manuelles uniquement

Remarques

  • [ 1]

    Les type la valeur ne peut être que l'une des suivantes : EXPLICITE, ACTIVATED_OLDEST_TO_NEWEST , ACTIVATED_NEWEST_TO_OLDEST , ALPHABETICAL , PLAYS_TOTAL , PLAYS_TRAILING_WEEK , START_DATE_OLDEST_TO_NEWEST,START_DATE_NEWEST_TO_OLDEST

    EXPLICIT signifie qu'il s'agit d'une liste de lecture manuelle ; tous les autres types sont des listes de lecture intelligentes avec des noms correspondant à leur schéma de commande.