Channels

L'API 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é qui identifie l'état "conçu pour les enfants" de cette chaîne ou de cette vidéo. 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 les historiques des révisions du service de l'API YouTube Data et des Conditions d'utilisation des services d'API YouTube.

Une ressource channel contient des informations sur une chaîne YouTube.

Méthodes

L'API prend en charge les méthodes suivantes pour les ressources channels:

liste
Renvoie une collection de zéro ou plusieurs ressources channel correspondant aux critères de la requête. Essayez maintenant.
update
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 et invideoPromotion de la ressource channel, ainsi que leurs propriétés enfants. Essayez maintenant.

Représentation de la ressource

La structure JSON suivante montre le format d'une ressource channels:

{
  "kind": "youtube#channel",
  "etag": etag,
  "id": string,
  "snippet": {
    "title": string,
    "description": string,
    "customUrl": string,
    "publishedAt": datetime,
    "thumbnails": {
      (key): {
        "url": string,
        "width": unsigned integer,
        "height": unsigned integer
      }
    },
    "defaultLanguage": string,
    "localized": {
      "title": string,
      "description": string
    },
    "country": string
  },
  "contentDetails": {
    "relatedPlaylists": {
      "likes": string,
      "favorites": string,
      "uploads": string
    }
  },
  "statistics": {
    "viewCount": unsigned long,
    "subscriberCount": unsigned long,  // this value is rounded to three significant figures
    "hiddenSubscriberCount": boolean,
    "videoCount": unsigned long
  },
  "topicDetails": {
    "topicIds": [
      string
    ],
    "topicCategories": [
      string
    ]
  },
  "status": {
    "privacyStatus": string,
    "isLinked": boolean,
    "longUploadsStatus": string,
    "madeForKids": boolean,
    "selfDeclaredMadeForKids": boolean
  },
  "brandingSettings": {
    "channel": {
      "title": string,
      "description": string,
      "keywords": string,
      "trackingAnalyticsAccountId": string,
      "unsubscribedTrailer": string,
      "defaultLanguage": string,
      "country": string
    },
    "watch": {
      "textColor": string,
      "backgroundColor": string,
      "featuredPlaylistId": string
    }
  },
  "auditDetails": {
    "overallGoodStanding": boolean,
    "communityGuidelinesGoodStanding": boolean,
    "copyrightStrikesGoodStanding": boolean,
    "contentIdClaimsGoodStanding": boolean
  },
  "contentOwnerDetails": {
    "contentOwner": string,
    "timeLinked": datetime
  },
  "localizations": {
    (key): {
      "title": string,
      "description": string
    }
  }
}

Propriétés

Le tableau suivant définit les propriétés qui apparaissent dans cette ressource:

Propriétés
kind string
Identifie le type de la ressource API. La valeur sera youtube#channel.
etag etag
Etag de cette ressource.
id string
ID utilisé par YouTube pour identifier de manière unique la chaîne.
snippet object
L'objet snippet contient des informations de base sur la chaîne, telles que son titre, sa description et ses miniatures.
snippet.title string
Titre de la chaîne.
snippet.description string
Description de la chaîne. La valeur de la propriété ne doit pas dépasser 1 000 caractères.
snippet.customUrl string
URL personnalisée de la chaîne. Le Centre d'aide YouTube explique les critères d'éligibilité pour obtenir une URL personnalisée et comment la configurer.
snippet.publishedAt datetime
Date et heure de création de la chaîne. La valeur est spécifiée au format ISO 8601.
snippet.thumbnails object
Carte des images miniatures associées à la chaîne. Pour chaque objet de la carte, la clé correspond au nom de l'image miniature, et la valeur à un objet contenant d'autres informations sur la miniature.

Lorsque vous affichez des miniatures dans votre application, assurez-vous que votre code utilise les URL d'image exactement telles qu'elles sont renvoyées dans les réponses de l'API. Par exemple, votre application ne doit pas utiliser le domaine http au lieu du domaine https dans une URL renvoyée dans une réponse d'API.

Les URL des miniatures de chaîne ne sont disponibles que dans le domaine https, ce qui est la façon dont elles apparaissent dans les réponses de l'API. Des images défectueuses peuvent s'afficher dans votre application si elle tente de charger des images YouTube à partir du domaine http. Les miniatures peuvent être vides pour les chaînes nouvellement créées, et leur remplissage peut prendre jusqu'à une journée.
snippet.thumbnails.(key) object
Les valeurs de clé valides sont les suivantes:
  • default : image miniature par défaut. La vignette par défaut d'une vidéo (ou d'une ressource qui y fait référence, comme un élément de playlist ou un résultat de recherche) mesure 120 x 90 pixels. La miniature par défaut d'une chaîne mesure 88 x 88 pixels.
  • medium : version de la vignette en haute résolution. Pour une vidéo (ou une ressource qui y fait référence), cette image mesure 320 x 180 pixels. Pour une chaîne, cette image mesure 240 x 240 pixels.
  • high : version haute résolution de l'image miniature. Pour une vidéo (ou une ressource qui y fait référence), cette image mesure 480 x 360 pixels. Pour une chaîne, cette image mesure 800 x 800 pixels.
snippet.thumbnails.(key).url string
URL de l'image. Pour obtenir des conseils supplémentaires sur l'utilisation des URL de miniatures dans votre application, consultez la définition de la propriété snippet.thumbnails.
snippet.thumbnails.(key).width unsigned integer
Largeur de l'image.
snippet.thumbnails.(key).height unsigned integer
Hauteur de l'image.
snippet.defaultLanguage string
Langue du texte dans les propriétés snippet.title et snippet.description de la ressource channel.
snippet.localized object
L'objet snippet.localized contient un titre et une description localisés pour la chaîne ou le titre et la description de la chaîne dans la langue par défaut des métadonnées de la chaîne.
  • Le texte localisé est renvoyé dans l'extrait de ressource si la requête channels.list a utilisé le paramètre hl pour spécifier une langue pour laquelle le texte localisé doit être renvoyé, que la valeur du paramètre hl identifie une langue de l'application YouTube et que le texte localisé est disponible dans cette langue.
  • Les métadonnées pour la langue par défaut sont renvoyées si aucune valeur de paramètre hl n'est spécifiée ou si une valeur est spécifiée, mais que les métadonnées localisées ne sont pas disponibles pour la langue spécifiée.
La propriété contient une valeur en lecture seule. Utilisez l'objet localizations pour ajouter, mettre à jour ou supprimer des métadonnées localisées.
snippet.localized.title string
Titre de la chaîne localisé.
snippet.localized.description string
Description localisée de la chaîne.
snippet.country string
Pays auquel la chaîne est associée. Pour définir la valeur de cette propriété, mettez à jour la valeur de la propriété brandingSettings.channel.country.
contentDetails object
L'objet contentDetails encapsule des informations sur le contenu de la chaîne.
contentDetails.relatedPlaylists object
L'objet relatedPlaylists est une carte qui identifie les playlists associées à la chaîne, comme les vidéos mises en ligne ou les vidéos aimées de la chaîne. Vous pouvez récupérer n'importe laquelle de ces playlists à l'aide de la méthode playlists.list.
contentDetails.relatedPlaylists.likes string
ID de la playlist contenant les vidéos "J'aime" de la chaîne. Utilisez les méthodes playlistItems.insert et playlistItems.delete pour ajouter ou supprimer des éléments de cette liste.
contentDetails.relatedPlaylists.favorites string
Cette propriété est obsolète.

ID de la playlist contenant les vidéos préférées de la chaîne. Utilisez les méthodes playlistItems.insert et playlistItems.delete pour ajouter ou supprimer des éléments de cette liste.

Notez que YouTube a abandonné la fonctionnalité de vidéos favorites. Par exemple, la propriété statistics.favoriteCount de la ressource video a été abandonnée le 28 août 2015. Par conséquent, pour des raisons historiques, cette valeur de propriété peut contenir un ID de playlist qui fait référence à une playlist vide et qui ne peut donc pas être extrait.
contentDetails.relatedPlaylists.uploads string
ID de la playlist contenant les vidéos mises en ligne de la chaîne. Utilisez la méthode videos.insert pour mettre en ligne de nouvelles vidéos et la méthode videos.delete pour supprimer des vidéos précédemment mises en ligne.
statistics object
L'objet statistics encapsule les statistiques de la chaîne.
statistics.viewCount unsigned long
Nombre de fois où la chaîne a été consultée.
statistics.commentCount unsigned long
Cette propriété est obsolète.

Nombre de commentaires sur la chaîne.
statistics.subscriberCount unsigned long
Nombre d'abonnés de la chaîne. Cette valeur est arrondie à trois chiffres significatifs. Pour en savoir plus sur l'arrondi du nombre d'abonnés, consultez la section Historique des révisions ou le Centre d'aide YouTube.
statistics.hiddenSubscriberCount boolean
Indique si le nombre d'abonnés de la chaîne est visible par tous les internautes.
statistics.videoCount unsigned long
Nombre de vidéos publiques mises en ligne sur la chaîne. Notez que cette valeur ne reflète que le nombre de vidéos publiques de la chaîne, même pour les propriétaires. Ce comportement est cohérent avec les totaux affichés sur le site Web de YouTube.
topicDetails object
L'objet topicDetails encapsule les informations sur les thèmes associés à la chaîne.

Important:Pour en savoir plus sur les modifications liées aux ID de sujet, consultez la définition de la propriété topicDetails.topicIds[] et l'historique des révisions.
topicDetails.topicIds[] list
Liste des ID de sujet associés à la chaîne.

Cette propriété est obsolète depuis le 10 novembre 2016. Ils seront acceptés jusqu'au 10 novembre 2017.

Important:Depuis l'abandon de Freebase et de l'API Freebase, les ID de sujet fonctionnent différemment depuis le 27 février 2017. À l'époque, YouTube a commencé à renvoyer un petit ensemble d'ID de sujets sélectionnés.
topicDetails.topicCategories[] list
Liste des URL Wikipédia qui décrivent le contenu de la chaîne.
status object
L'objet status encapsule des informations sur l'état de confidentialité de la chaîne.
status.privacyStatus string
État de confidentialité de la chaîne.

Les valeurs valides pour cette propriété sont les suivantes :
  • private
  • public
  • unlisted
status.isLinked boolean
Indique si les données de la chaîne identifient un utilisateur déjà associé à un nom d'utilisateur YouTube ou à un compte Google+. Un utilisateur qui dispose de l'un de ces liens dispose déjà d'une identité YouTube publique, ce qui est une condition préalable à plusieurs actions, comme la mise en ligne de vidéos.
status.longUploadsStatus string
Indique si la chaîne peut mettre en ligne des vidéos de plus de 15 minutes. Cette propriété n'est renvoyée que si le propriétaire de la chaîne a autorisé la requête API. Pour en savoir plus sur cette fonctionnalité, consultez le Centre d'aide YouTube.

Valeurs valides pour cette propriété :
  • allowed : cette chaîne peut mettre en ligne des vidéos de plus de 15 minutes.
  • disallowed : cette chaîne ne peut pas mettre en ligne de vidéos de plus de 15 minutes. Une chaîne ne peut mettre en ligne des vidéos plus longues que si elle est en règle, conformément au Règlement de la communauté YouTube, et si son contenu ne fait l'objet d'aucun blocage Content ID dans le monde entier.

    Une fois que le propriétaire de la chaîne aura résolu les problèmes qui l'empêchent de mettre en ligne des vidéos plus longues, la chaîne reviendra à l'état allowed ou eligible.
  • eligible : cette chaîne peut mettre en ligne des vidéos de plus de 15 minutes. Toutefois, le propriétaire de la chaîne doit d'abord activer la possibilité de mettre en ligne des vidéos plus longues en validant son numéro de téléphone. Pour en savoir plus sur cette fonctionnalité, consultez le Centre d'aide YouTube.
status.madeForKids boolean
Cette valeur indique si la chaîne est destinée aux enfants et contient l'état actuel de la chaîne "conçu pour les enfants". Par exemple, l'état peut être déterminé en fonction de la valeur de la propriété selfDeclaredMadeForKids. Pour en savoir plus sur la sélection de l'audience de votre chaîne, de vos vidéos ou de vos diffusions, consultez le Centre d'aide YouTube .
status.selfDeclaredMadeForKids boolean
Dans une requête channels.update, cette propriété permet au propriétaire de la chaîne de la désigner comme destinée aux enfants. La valeur de la propriété n'est renvoyée que si le propriétaire de la chaîne a autorisé la requête API.
brandingSettings object
L'objet brandingSettings encapsule des informations sur le branding de la chaîne.
brandingSettings.channel object
L'objet channel encapsule les propriétés de branding de la page de la chaîne.
brandingSettings.channel.title string
Titre de la chaîne. Le titre peut comporter jusqu'à 30 caractères.
brandingSettings.channel.description string
La description de la chaîne, qui s'affiche dans la zone d'informations de la chaîne sur sa page. La valeur de la propriété ne doit pas dépasser 1 000 caractères.
brandingSettings.channel.keywords string
Mots clés associés à votre chaîne. La valeur est une liste de chaînes séparées par des espaces. Les mots clés de chaîne peuvent être tronqués s'ils dépassent la longueur maximale autorisée de 500 caractères ou s'ils contiennent des guillemets non échappés ("). Notez que la limite de 500 caractères ne s'applique pas à chaque mot clé, mais à la longueur totale de tous les mots clés.
brandingSettings.channel.trackingAnalyticsAccountId string
ID d'un compte Google Analytics que vous souhaitez utiliser pour suivre et mesurer le trafic vers votre chaîne.
brandingSettings.channel.unsubscribedTrailer string
Vidéo qui doit être lue dans le module de vidéo sélectionné dans la vue "Parcourir" de la page de la chaîne pour les spectateurs non abonnés. Les spectateurs abonnés peuvent voir une autre vidéo qui met en avant l'activité plus récente de la chaîne.

Si elle est spécifiée, la valeur de la propriété doit être l'ID de la vidéo YouTube d'une vidéo publique ou non répertoriée appartenant au propriétaire de la chaîne.
brandingSettings.channel.defaultLanguage string
Langue du texte dans les propriétés snippet.title et snippet.description de la ressource channel.
brandingSettings.channel.country string
Pays associé à la chaîne. Modifiez cette propriété pour définir la valeur de la propriété snippet.country.
brandingSettings.watch object
Remarque:Cet objet et toutes ses propriétés enfants ont été abandonnés.

L'objet watch encapsule les propriétés de branding des pages de lecture des vidéos de la chaîne.
brandingSettings.watch.textColor string
Remarque:Cette propriété est obsolète.

Couleur du texte pour la zone de la page de lecture de la vidéo associée à la marque.
brandingSettings.watch.backgroundColor string
Remarque:Cette propriété est obsolète.

Couleur d'arrière-plan de la zone de la page de lecture de la vidéo associée à la marque.
brandingSettings.watch.featuredPlaylistId string
Remarque:Cette propriété est obsolète. L'API renvoie une erreur si vous tentez de définir sa valeur.
brandingSettings.image object
Cette propriété et toutes ses propriétés enfants sont obsolètes.

L'objet image encapsule les informations sur les images qui s'affichent sur la page de la chaîne ou sur les pages de lecture des vidéos.
brandingSettings.image.bannerImageUrl string
Cette propriété est obsolète.

L'URL de l'image de la bannière affichée sur la page de la chaîne sur le site Web de YouTube. L'image mesure 1 060 x 175 px.
brandingSettings.image.bannerMobileImageUrl string
Cette propriété est obsolète.

URL de l'image de la bannière affichée sur la page de la chaîne dans les applications mobiles. L'image mesure 640 x 175 px.
brandingSettings.image.watchIconImageUrl string
Cette propriété est obsolète.

L'URL de l'image qui s'affiche au-dessus du lecteur vidéo. Il s'agit d'une image de 25 pixels de haut, avec une largeur flexible qui ne peut pas dépasser 170 pixels. Si vous ne fournissez pas d'image, le nom de votre chaîne s'affichera à la place.
brandingSettings.image.trackingImageUrl string
Cette propriété est obsolète.

URL d'un pixel de suivi de 1 x 1 px qui peut être utilisé pour collecter des statistiques sur les vues des pages de la chaîne ou des vidéos.
brandingSettings.image.bannerTabletLowImageUrl string
Cette propriété est obsolète.

URL d'une image de bannière basse résolution qui s'affiche sur la page de la chaîne dans les applications pour tablette. La taille maximale de l'image est de 1 138 x 188 px.
brandingSettings.image.bannerTabletImageUrl string
Cette propriété est obsolète.

URL d'une image de bannière qui s'affiche sur la page de la chaîne dans les applications pour tablette. L'image mesure 1 707 x 283 px.
brandingSettings.image.bannerTabletHdImageUrl string
Cette propriété est obsolète.

URL d'une image de bannière haute résolution qui s'affiche sur la page de la chaîne dans les applications pour tablette. La taille maximale de l'image est de 2 276 x 377 px.
brandingSettings.image.bannerTabletExtraHdImageUrl string
Cette propriété est obsolète.

URL d'une image de bannière en très haute résolution qui s'affiche sur la page de la chaîne dans les applications pour tablette. La taille maximale de l'image est de 2 560 x 424 pixels.
brandingSettings.image.bannerMobileLowImageUrl string
Cette propriété est obsolète.

URL d'une image de bannière basse résolution qui s'affiche sur la page de la chaîne dans les applications mobiles. La taille maximale de l'image est de 320 x 88 pixels.
brandingSettings.image.bannerMobileMediumHdImageUrl string
Cette propriété est obsolète.

URL d'une image de bannière de résolution moyenne qui s'affiche sur la page de la chaîne dans les applications mobiles. La taille maximale de l'image est de 960 x 263 pixels.
brandingSettings.image.bannerMobileHdImageUrl string
Cette propriété est obsolète.

URL d'une image de bannière haute résolution qui s'affiche sur la page de la chaîne dans les applications mobiles. La taille maximale de l'image est de 1 280 x 360 px.
brandingSettings.image.bannerMobileExtraHdImageUrl string
Cette propriété est obsolète.

URL d'une image de bannière haute résolution qui s'affiche sur la page de la chaîne dans les applications mobiles. La taille maximale de l'image est de 1 440 x 395 pixels.
brandingSettings.image.bannerTvImageUrl string
Cette propriété est obsolète.

URL d'une image de bannière en très haute résolution qui s'affiche sur la page de la chaîne dans les applications pour téléviseur. La taille maximale de l'image est de 2 120 x 1 192 pixels.
brandingSettings.image.bannerTvLowImageUrl string
Cette propriété est obsolète.

URL d'une image de bannière basse résolution qui s'affiche sur la page de la chaîne dans les applications pour téléviseur. La taille maximale de l'image est de 854 x 480 pixels.
brandingSettings.image.bannerTvMediumImageUrl string
Cette propriété est obsolète.

URL d'une image de bannière de résolution moyenne qui s'affiche sur la page de la chaîne dans les applications pour téléviseur. La taille maximale de l'image est de 1 280 x 720 pixels.
brandingSettings.image.bannerTvHighImageUrl string
Cette propriété est obsolète.

URL d'une image de bannière haute résolution qui s'affiche sur la page de la chaîne dans les applications pour téléviseur. La taille maximale de l'image est de 1 920 x 1 080 pixels.
brandingSettings.image.bannerExternalUrl string
Cette propriété spécifie l'emplacement de l'image de bannière que YouTube utilise pour générer les différentes tailles d'images de bannière pour une chaîne.
brandingSettings.hints[] list
Cette propriété et toutes ses propriétés enfants sont obsolètes.

L'objet hints encapsule des propriétés de branding supplémentaires.
brandingSettings.hints[].property string
Cette propriété est obsolète.

Une propriété.
brandingSettings.hints[].value string
Cette propriété est obsolète.

Valeur de la propriété.
auditDetails object
L'objet auditDetails encapsule les données de chaîne qu'un réseau multichaîne évaluerait pour déterminer s'il doit accepter ou refuser une chaîne particulière. Notez que toute requête API qui récupère cette partie de ressource doit fournir un jeton d'autorisation contenant le champ d'application https://www.googleapis.com/auth/youtubepartner-channel-audit. De plus, tout jeton qui utilise cette portée doit être révoqué lorsque la chaîne de médias multiréseaux décide d'accepter ou de refuser le canal, ou dans les deux semaines suivant la date d'émission du jeton.
auditDetails.overallGoodStanding boolean
Ce champ indique si la chaîne pose problème. Actuellement, ce champ représente le résultat de l'opération logique AND sur les propriétés communityGuidelinesGoodStanding, copyrightStrikesGoodStanding et contentIdClaimsGoodStanding, ce qui signifie que cette propriété a la valeur true si toutes ces autres propriétés ont également la valeur true. Toutefois, cette propriété aura une valeur de false si l'une de ces propriétés a une valeur de false. Notez toutefois que la méthodologie utilisée pour définir la valeur de cette propriété est susceptible de changer.
auditDetails.communityGuidelinesGoodStanding boolean
Indique si la chaîne respecte le règlement de la communauté YouTube.
auditDetails.copyrightStrikesGoodStanding boolean
Indique si la chaîne a reçu des avertissements pour atteinte aux droits d'auteur.
auditDetails.contentIdClaimsGoodStanding boolean
Indique si la chaîne fait l'objet de revendications non résolues.
contentOwnerDetails object
L'objet contentOwnerDetails encapsule les données de la chaîne qui ne sont visibles que par le partenaire YouTube qui a associé la chaîne à son Gestionnaire de contenu.
contentOwnerDetails.contentOwner string
ID du propriétaire du contenu associé à la chaîne.
contentOwnerDetails.timeLinked datetime
Date et heure d'association de la chaîne au propriétaire de contenu. La valeur est spécifiée au format ISO 8601.
localizations object
L'objet localizations encapsule les traductions des métadonnées de la chaîne.
localizations.(key) object
Langue des métadonnées localisées associées à la valeur de clé. La valeur est une chaîne contenant un code de langue BCP-47.
localizations.(key).title string
Titre de la chaîne localisé.
localizations.(key).description string
Description localisée de la chaîne.