Modifie un élément de la playlist. Vous pouvez, par exemple, modifier la position de l'élément dans la playlist.
Impact sur les quotas:un appel à cette méthode entraîne un coût du quota de 50 unités.
Cas d'utilisation courants
Requête
Requête HTTP
PUT https://www.googleapis.com/youtube/v3/playlistItems
Autorisation
Une autorisation est requise pour cette requête. Celle-ci doit inclure au moins l'un des champs d'application suivants. En savoir plus sur le processus d'authentification et d'autorisation
Champ d'application |
---|
https://www.googleapis.com/auth/youtubepartner |
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
Paramètres
Le tableau suivant répertorie les paramètres compatibles avec cette requête. Tous les paramètres répertoriés sont des paramètres de requête.
Paramètres | ||
---|---|---|
Paramètres obligatoires | ||
part |
string Le paramètre part a deux finalités dans cette opération. Elle identifie les propriétés que l'opération d'écriture définira, ainsi que les propriétés que la réponse de l'API inclura.Notez que cette méthode remplacera les valeurs existantes pour toutes les propriétés modifiables contenues dans les parties spécifiées par la valeur du paramètre. Par exemple, un élément de playlist peut spécifier des heures de début et de fin, qui identifient les moments de la vidéo à lire lorsque les utilisateurs regardent la vidéo dans la playlist. Si votre requête met à jour un élément de playlist qui définit ces valeurs et que la valeur du paramètre part de la requête inclut la partie contentDetails , les heures de début et de fin de l'élément de playlist sont mises à jour selon la valeur spécifiée par le corps de la requête. Si le corps de la requête ne spécifie pas de valeurs, les heures de début et de fin existantes sont supprimées et remplacées par les paramètres par défaut.La liste suivante contient les noms part que vous pouvez inclure dans la valeur du paramètre:
|
|
Paramètres facultatifs | ||
onBehalfOfContentOwner |
string Remarque:Le paramètre onBehalfOfContentOwner est destiné exclusivement aux partenaires de contenu YouTube et ne peut être utilisé que dans une demande autorisée de façon appropriée.Il est conçu pour les partenaires de contenu YouTube qui possèdent et gèrent de nombreuses chaînes YouTube. Il permet aux utilisateurs affiliés au propriétaire de contenu de s'authentifier une seule fois, puis d'accéder à toutes les données vidéo et de chaîne du propriétaire et de les gérer, sans avoir à fournir d'identifiants d'authentification pour chaque chaîne. Lorsque le paramètre est présent, sa valeur identifie un propriétaire de contenu, et les identifiants d'autorisation de la demande identifient un utilisateur YouTube autorisé à agir au nom de ce propriétaire de contenu. Le compte avec lequel l'utilisateur s'authentifie doit être associé au propriétaire de contenu spécifié dans les paramètres de YouTube Creator Studio. |
Corps de la requête
Fournissez une ressource playlistItem dans le corps de la requête. Pour cette ressource:
-
Vous devez spécifier une valeur pour ces propriétés:
id
snippet.playlistId
snippet.resourceId
-
Vous pouvez définir des valeurs pour ces propriétés:
snippet.position
contentDetails.note
contentDetails.startAt
contentDetails.endAt
Si vous envoyez une demande de mise à jour et qu'elle ne spécifie pas de valeur pour une propriété qui en possède déjà une, la valeur existante de la propriété sera supprimée.
Réponse
Lorsque cette méthode fonctionne, elle renvoie une ressource playlistItem dans le corps de la réponse.
Erreurs
Le tableau suivant identifie les messages d'erreur que l'API peut renvoyer en réponse à un appel de cette méthode. Pour en savoir plus, consultez la documentation sur les messages d'erreur.
Type d'erreur | Détails de l'erreur | Description |
---|---|---|
forbidden (403) |
playlistItemsNotAccessible |
La demande n'est pas autorisée pour mettre à jour l'élément de playlist spécifié. |
invalidValue (400) |
invalidPlaylistItemPosition |
La requête tente de définir la position de l'élément de la playlist sur une valeur non valide ou non compatible. Vérifiez la valeur de la propriété position dans le fichier snippet de la ressource. |
invalidValue (400) |
invalidResourceType |
Le type spécifié pour l'ID de ressource n'est pas compatible avec cette opération. L'ID de ressource identifie l'élément ajouté à la playlist (par exemple, youtube#video ). |
invalidValue (400) |
invalidSnippet |
La requête ne spécifie pas de propriété snippet valide. |
invalidValue (400) |
manualSortRequired |
La demande tente de définir la position de l'élément de la playlist, mais celle-ci n'utilise pas le tri manuel. Par exemple, les éléments d'une playlist peuvent être triés par date ou par popularité. Vous pouvez résoudre l'erreur en supprimant l'élément snippet.position de la ressource insérée par la requête. Si vous souhaitez que l'élément de la playlist figure à une certaine position dans la liste, vous devez d'abord définir l'option Classement sur Manuel dans les paramètres de la playlist. Vous pouvez modifier ces paramètres dans le Gestionnaire de vidéos YouTube. |
notFound (404) |
playlistItemNotFound |
L'élément de playlist identifié dans la propriété id de la requête est introuvable. |
notFound (404) |
playlistNotFound |
Impossible de trouver la playlist identifiée à l'aide du paramètre playlistId de la requête. |
required (400) |
channelIdRequired |
La requête ne spécifie pas de valeur pour la propriété channelId requise. |
required (400) |
playlistIdRequired |
La requête ne spécifie pas de valeur pour la propriété playlistId requise. |
required (400) |
playlistItemIdRequired |
La ressource d'élément de playlist spécifiée dans la requête doit utiliser la propriété id pour identifier l'élément de playlist en cours de mise à jour. |
invalidValue (400) |
playlistOperationUnsupported |
L'API ne permet pas de mettre à jour des vidéos dans la playlist spécifiée. Par exemple, vous ne pouvez pas modifier une vidéo de votre playlist de vidéos mises en ligne. |
Essayer
Utilisez APIs Explorer pour appeler cette API et afficher la requête et la réponse de l'API.