Channels: update

L'API vous permet désormais de marquer votre chaîne ou vos vidéos comme "conçues pour les enfants". De plus, les ressources channel et video contiennent désormais une propriété indiquant l'état "Conçue pour les enfants" de la chaîne ou de la vidéo concernée. Les conditions d'utilisation des services d'API YouTube et le règlement pour les développeurs ont également été mis à jour le 10 janvier 2020. Pour en savoir plus, consultez l'historique des révisions du service d'API YouTube Data et les Conditions d'utilisation des services d'API YouTube.

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

Impact du quota:un appel à cette méthode a un coût de quota de 50 unités.

Cas d'utilisation courants

Demande

Requête HTTP :

PUT https://www.googleapis.com/youtube/v3/channels

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

Portée
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
Réglages obligatoires
part string
Le paramètre part a une double finalité. Il identifie les propriétés que l'opération d'écriture définira, ainsi que les propriétés qui seront incluses dans la réponse de l'API.

Actuellement, l'API ne permet de définir la valeur du paramètre que 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 pour toutes les propriétés modifiables contenues dans la partie spécifiée par la valeur du paramètre.
Paramètres facultatifs
onBehalfOfContentOwner string
Ce paramètre ne peut être utilisé que dans une requête correctement autorisée. Le paramètre onBehalfOfContentOwner 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 différentes. Elle permet aux propriétaires de contenu de s'authentifier une seule fois et d'accéder à toutes les données de leurs vidéos et de leur chaîne, sans avoir à fournir d'identifiants 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é.

Corps de la requête

Indiquez une ressource de canal 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 les propriétés suivantes:

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

    Si vous envoyez une demande de mise à jour et que vous ne spécifiez pas de valeur pour une propriété qui en possède déjà une, la valeur existante sera supprimée.

Réponse

Lorsque cette méthode fonctionne, elle renvoie une ressource de canal dans le corps de la réponse.

Erreurs

Le tableau suivant identifie les messages d'erreur que l'API pourrait renvoyer en réponse à un appel à cette méthode. Veuillez consulter la documentation sur les messages d'erreur pour en savoir plus.

Type d'erreur Détails de l'erreur Description
badRequest (400) brandingValidationError Échec de la validation de l'une des valeurs de l'objet brandingSettings. Utilisez la méthode channels.list pour récupérer les paramètres existants du canal et mettez à jour les valeurs de propriété en suivant les instructions de la documentation sur les ressources channels.
badRequest (400) channelTitleUpdateForbidden Lorsque vous mettez à jour le 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 defaultLanguage doit être défini 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 les valeurs valides et veillez à les mettre à jour en suivant les consignes de la documentation de 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 demande indiquent un type de position non valide pour déterminer la position de l'élément en promotion 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 indiquent un décalage incorrect dans la partie invideoPromotion.
badRequest (400) invalidTimingOffset Les métadonnées de la demande indiquent un décalage incorrect pour déterminer le moment auquel l'élément à promouvoir doit s'afficher 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 demande indiquent une méthode de synchronisation incorrecte pour déterminer le moment auquel l'élément à promouvoir doit s'afficher 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 Échec de la validation de l'une des valeurs de l'objet de localisation. Utilisez la méthode channels.list pour récupérer les valeurs valides et assurez-vous de les mettre à jour en suivant les consignes de la documentation sur les ressources des canaux.
badRequest (400) tooManyPromotedItems Nombre d'éléments sponsorisés autorisé dans la partie invideoPromotion.
forbidden (403) channelForbidden Le canal spécifié dans le paramètre id n'est pas compatible avec la requête, ou celle-ci n'est pas correctement autorisée.
forbidden (403) promotedVideoNotAllowed Le canal 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 du canal est correct.
forbidden (403) websiteLinkNotAllowed L'URL du site Web spécifiée n'est pas autorisée.
notFound (404) channelNotFound Le canal spécifié 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 critère spécifié est introuvable.
notFound (404) unknownChannelId L'ID de chaîne récemment importé est introuvable.
notFound (404) unknownVideoId Impossible de trouver l'identifiant de la vidéo spécifié comme article sponsorisé.
required (400) requiredItemIdType Les métadonnées de la demande doivent spécifier un type d'article dans la partie invideoPromotion.
required (400) requiredItemId Les métadonnées de la demande doivent spécifier un identifiant d'article dans la partie invideoPromotion.
required (400) requiredTimingOffset Les métadonnées de la demande doivent spécifier un décalage temporel par défaut pour que YouTube puisse déterminer quand afficher l'élément sponsorisé. 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 demande doivent spécifier un décalage temporel afin que YouTube puisse déterminer le moment auquel l'élément sponsorisé doit s'afficher. 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 demande doivent spécifier une méthode de synchronisation afin que YouTube puisse déterminer quand afficher l'article en question. 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 demande doivent spécifier une méthode de synchronisation afin que YouTube puisse déterminer quand afficher l'article en question. 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 un minutage pour chaque élément de la partie invideoPromotion.
required (400) requiredVideoId Les métadonnées de la demande doivent spécifier un ID vidéo pour identifier l'article sponsorisé.
required (400) requiredWebsiteUrl Les métadonnées de la requête doivent spécifier l'URL d'un 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 APIs Explorer pour appeler cette API et afficher la requête API et la réponse.