PlaylistItems: update

Modifie un élément de playlist. Par exemple, vous pouvez modifier la position de l'élément dans la playlist.

Impact sur le quota : un appel à cette méthode coûte 50 unités de quota.

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 listés sont des paramètres de requête.

Paramètres
Paramètres obligatoires
part string
Le paramètre part a deux objectifs dans cette opération. Il identifie les propriétés que l'opération d'écriture définira, ainsi que celles que la réponse de l'API inclura.

Notez que cette méthode remplacera les valeurs existantes de toutes les propriétés mutables contenues dans les parties spécifiées par la valeur du paramètre. Par exemple, un élément de playlist peut spécifier une heure de début et une heure de fin, qui identifient la partie de la vidéo à lire lorsque les utilisateurs la regardent 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 seront mises à jour avec 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 seront supprimées et remplacées par les paramètres par défaut.

La liste suivante contient les part noms que vous pouvez inclure dans la valeur du paramètre :
  • contentDetails
  • id
  • snippet
  • status
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 requête correctement autorisée.

Ce paramètre est conçu pour les partenaires de contenu YouTube qui possèdent et gèrent de nombreuses chaînes YouTube différentes. Il permet aux utilisateurs affiliés au propriétaire du contenu de s'authentifier une seule fois, puis d'accéder à toutes les données de la vidéo et de la chaîne du propriétaire du contenu et de les gérer, sans avoir à fournir d'identifiants d'authentification pour chaque chaîne individuelle.

Lorsque le paramètre est présent, sa valeur identifie un propriétaire de contenu, et les identifiants d'autorisation de la requête 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 requête de mise à jour et que votre requête 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

Si la requête aboutit, cette méthode 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 à 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 requête n'est pas correctement autorisée à 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 playlist sur une valeur non valide ou non compatible. Vérifiez la valeur de la propriété position dans le 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 requête tente de définir la position de l'élément de playlist, mais la playlist n'utilise pas le tri manuel. (Par exemple, les éléments de playlist peuvent être triés par date ou par popularité.) Pour résoudre l'erreur, supprimez l'élément snippet.position de la ressource que la requête insère. Si vous souhaitez que l'élément de playlist ait une position spécifique dans la liste, vous devez d'abord modifier l'option Ordre de la playlist sur Manuel dans les paramètres de la playlist. Vous pouvez ajuster ce paramètre dans le Gestionnaire de vidéos YouTube.
notFound (404) playlistItemNotFound L'élément de playlist identifié avec la propriété id de la requête est introuvable.
notFound (404) playlistNotFound La playlist identifiée avec le paramètre playlistId de la requête est introuvable.
required (400) channelIdRequired La requête ne spécifie pas de valeur pour la propriété channelId obligatoire.
required (400) playlistIdRequired La requête ne spécifie pas de valeur pour la propriété playlistId obligatoire.
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 n'est pas compatible avec la possibilité de mettre à jour des vidéos dans la playlist spécifiée. Par exemple, vous ne pouvez pas mettre à jour une vidéo dans votre playlist de vidéos mises en ligne.

Essayer

Utilisez l'APIs Explorer pour appeler cette API et afficher la requête et la réponse de l'API.