Channels: update

L'API permet désormais de marquer votre chaîne ou vidéos comme étant conçues pour les enfants. De plus, les ressources channel et video contiennent désormais une propriété qui identifie l'état "conçu pour les enfants" de cette chaîne ou de cette vidéo. Les Conditions d'utilisation des Services API YouTube et le Règlement pour les développeurs ont également été mis à jour le 10 janvier 2020. Pour en savoir plus, consultez les historiques des révisions du service API YouTube Data et des Conditions d'utilisation des Services API YouTube.

Met à jour les métadonnées d'une chaîne. Notez que cette méthode ne prend en charge que les mises à jour des objets brandingSettings, invideoPromotion et localizations de la ressource channel, ainsi que leurs propriétés enfants.

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/channels

Autorisation

Cette requête nécessite une autorisation avec au moins l'un des champs d'application suivants. Pour en savoir plus sur l'authentification et l'autorisation, consultez Implémenter l'autorisation OAuth 2.0.

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 va définir, ainsi que celles que la réponse de l'API inclura.

L'API n'autorise que la définition de la valeur du paramètre sur brandingSettings, invideoPromotion ou localizations. (Vous ne pouvez mettre à jour qu'une seule de ces parties avec une seule requête.)

Notez que cette méthode remplace les valeurs existantes de toutes les propriétés mutables contenues dans la partie spécifiée par la valeur de paramètre.
Paramètres facultatifs
onBehalfOfContentOwner string
Ce paramètre ne peut être utilisé que dans une requête correctement autorisée.

Le onBehalfOfContentOwner paramètre indique que l'utilisateur authentifié agit au nom du propriétaire de contenu spécifié dans la valeur du paramètre. Ce paramètre est destiné aux partenaires de contenu YouTube qui possèdent et gèrent de nombreuses chaînes YouTube différentes. Il permet aux propriétaires de contenu de s'authentifier une seule fois et d'accéder à toutes leurs données vidéo et de chaîne, sans avoir à fournir d'identifiants d'authentification pour chaque chaîne. Le compte CMS réel avec lequel l'utilisateur s'authentifie doit être associé au propriétaire de contenu YouTube spécifié.

Ce paramètre doit être fourni si la requête est authentifiée avec les identifiants d'un utilisateur propriétaire de contenu CMS agissant sur une chaîne gérée. S'il est omis, la requête s'exécute dans le contexte direct de l'utilisateur authentifié et renvoie une erreur HTTP 403 (accès refusé).

Corps de la requête

Fournissez une ressource channel dans le corps de la requête. Pour cette ressource :

  • Vous devez spécifier une valeur pour ces propriétés :

    • id

  • Vous pouvez définir des valeurs pour ces propriétés :

    • brandingSettings.channel.country
    • brandingSettings.channel.description
    • brandingSettings.channel.defaultLanguage
    • brandingSettings.channel.keywords
    • brandingSettings.channel.trackingAnalyticsAccountId
    • brandingSettings.channel.unsubscribedTrailer
    • localizations.(key)
    • localizations.(key).title
    • localizations.(key).description
    • status.selfDeclaredMadeForKids

    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 channel 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 API YouTube Data – Erreurs.

Type d'erreur Détails de l'erreur Description
badRequest (400) brandingValidationError L'une des valeurs de l'objet brandingSettings n'a pas été validée. Utilisez la méthode channels.list pour récupérer les paramètres existants de la chaîne, puis mettez à jour les valeurs des propriétés en suivant les consignes de la documentation sur la ressource channels.
badRequest (400) channelTitleUpdateForbidden Lorsque vous mettez à jour la brandingSettings part d'une chaîne, vous devez définir la valeur de la propriété brandingSettings.channel.title sur le titre actuel de la chaîne ou omettre la propriété. L'API renvoie une erreur si vous modifiez la valeur de la propriété.
badRequest (400) defaultLanguageNotSetError Vous devez définir defaultLanguage pour mettre à jour localizations.
badRequest (400) invalidBrandingOption L'un des paramètres de marque que vous avez spécifiés n'existe pas. Utilisez la méthode channels.list pour récupérer des valeurs valides et assurez-vous de les mettre à jour en suivant les consignes de la documentation sur la ressource channels.
badRequest (400) invalidCustomMessage Les métadonnées de la requête spécifient un message personnalisé non valide. Vérifiez la valeur de la propriété invideoPromotion.items[].customMessage dans la ressource envoyée par la requête.
badRequest (400) invalidDuration Les métadonnées de la requête spécifient une durée non valide dans la partie invideoPromotion.
badRequest (400) invalidDuration Les métadonnées de la requête spécifient un type de position non valide pour déterminer comment l'élément promu est positionné dans le lecteur vidéo. Vérifiez la valeur de la propriété invideoPromotion.position.type dans la ressource envoyée par la requête.
badRequest (400) invalidRecentlyUploadedBy Les métadonnées de la requête spécifient un ID de chaîne non valide. Vérifiez la valeur de la propriété invideoPromotion.items[].id.recentlyUploadedBy dans la ressource envoyée par la requête.
badRequest (400) invalidTimingOffset Les métadonnées de la requête spécifient un horodatage non valide dans la partie invideoPromotion.
badRequest (400) invalidTimingOffset Les métadonnées de la requête spécifient un horodatage non valide pour déterminer quand l'élément promu doit être affiché dans le lecteur vidéo. Vérifiez la valeur de la propriété invideoPromotion.timing.offsetMs dans la ressource envoyée par la requête.
badRequest (400) invalidTimingType Les métadonnées de la requête spécifient une méthode de synchronisation non valide pour déterminer quand l'élément promu doit être affiché dans le lecteur vidéo. Vérifiez la valeur de la propriété invideoPromotion.timing.type dans la ressource envoyée par la requête.
badRequest (400) localizationValidationError L'une des valeurs de l'objet localizations n'a pas été validée. Utilisez la méthode channels.list pour récupérer des valeurs valides et assurez-vous de les mettre à jour en suivant les consignes de la documentation sur la ressource channels.
badRequest (400) tooManyPromotedItems Le nombre d'éléments promus autorisés a été dépassé dans la partie invideoPromotion.
forbidden (403) channelForbidden La chaîne spécifiée dans le paramètre id n'est pas compatible avec la requête ou la requête n'est pas correctement autorisée.
forbidden (403) promotedVideoNotAllowed La chaîne que la requête API tente de mettre à jour est introuvable. Vérifiez la valeur de la propriété id dans la ressource channel envoyée par la requête pour vous assurer que l'ID de la chaîne est correct.
forbidden (403) websiteLinkNotAllowed L'URL du site Web spécifiée n'est pas autorisée.
notFound (404) channelNotFound La chaîne spécifiée dans le paramètre id est introuvable.
notFound (404) channelNotFound La chaîne spécifiée par le paramètre id est introuvable ou ne dispose pas d'options de branding.
notFound (404) unknownChannelId L'ID de la chaîne spécifié est introuvable.
notFound (404) unknownChannelId L'ID de la chaîne recentlyUploadedBy spécifié est introuvable.
notFound (404) unknownVideoId L'ID vidéo spécifié comme élément promu est introuvable.
required (400) requiredItemIdType Les métadonnées de la requête doivent spécifier un type d'élément dans la partie invideoPromotion.
required (400) requiredItemId Les métadonnées de la requête doivent spécifier un ID d'élément dans la partie invideoPromotion.
required (400) requiredTimingOffset Les métadonnées de la requête doivent spécifier un décalage temporel par défaut afin que YouTube puisse déterminer quand afficher l'élément promu. Définissez la valeur de la propriété invideoPromotion.defaultTiming.offsetMs dans la ressource envoyée par la requête.
required (400) requiredTimingOffset Les métadonnées de la requête doivent spécifier un décalage temporel afin que YouTube puisse déterminer quand afficher l'élément promu. Définissez la valeur de la propriété invideoPromotion.timing.offsetMs dans la ressource envoyée par la requête.
required (400) requiredTimingType Les métadonnées de la requête doivent spécifier une méthode de synchronisation afin que YouTube puisse déterminer quand afficher l'élément promu. Définissez la valeur de la propriété invideoPromotion.defaultTiming.type dans la ressource envoyée par la requête.
required (400) requiredTimingType Les métadonnées de la requête doivent spécifier une méthode de synchronisation afin que YouTube puisse déterminer quand afficher l'élément promu. Définissez la valeur de la propriété invideoPromotion.timing.type dans la ressource envoyée par la requête.
required (400) requiredTiming Les métadonnées de la requête doivent spécifier une synchronisation pour chaque élément de la partie invideoPromotion.
required (400) requiredVideoId Les métadonnées de la requête doivent spécifier un ID vidéo pour identifier l'élément promu.
required (400) requiredWebsiteUrl Les métadonnées de la requête doivent spécifier une URL de site Web dans la partie invideoPromotion. Définissez la valeur de la propriété invideoPromotion.items[].id.websiteUrl dans la ressource envoyée par la requête.

Essayer

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