L'API vous permet désormais de marquer votre chaîne ou
videos comme "conçues pour les enfants". De plus,
channel
et les ressources video
contiennent désormais une propriété qui identifie les contenus conçus pour les enfants
l'état de la chaîne ou de la vidéo. Conditions d'utilisation des services d'API YouTube et règlement pour les développeurs
ont également été mises à jour le 10 janvier 2020. Pour plus d'informations, reportez-vous aux historiques de révision des
l'API YouTube Data et les
Conditions d'utilisation des services d'API YouTube.
Une ressource channel
contient des informations sur une chaîne YouTube.
Méthodes
L'API accepte 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. Essayer maintenant - mise à jour
- Met à jour les métadonnées d'une chaîne. Notez que cette méthode ne prend actuellement en charge que les mises à jour des objets
brandingSettings
etinvideoPromotion
de la ressourcechannel
, ainsi que de leurs propriétés enfants. Essayer maintenant
Représentation des ressources
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 ressource d'API. La valeur sera youtube#channel . |
etag |
etag ETag de cette ressource. |
id |
string ID utilisé par YouTube pour identifier la chaîne de façon unique. |
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 comporter plus de 1 000 caractères. |
snippet.customUrl |
string URL personnalisée de la chaîne Le Centre d'aide YouTube décrit les critères d'éligibilité à l'obtention d'une URL personnalisée, ainsi que la procédure à suivre pour la configurer. |
snippet.publishedAt |
datetime La date et l'heure de création de la chaîne. La valeur est spécifiée au format ISO 8601. |
snippet.thumbnails |
object Carte de miniatures associées à la chaîne. Pour chaque objet de la carte, la clé correspond au nom de la vignette, et la valeur est un objet contenant d'autres informations sur la vignette. Lorsque vous affichez des vignettes dans votre application, assurez-vous que votre code utilise les URL des images 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 de vignettes de chaîne ne sont disponibles que dans le domaine https , qui correspond à leur affichage dans les réponses de l'API. Il est possible que des images corrompues s'affichent dans votre application si celle-ci tente de charger des images YouTube à partir du domaine http . Les miniatures des chaînes que vous venez de créer peuvent être vides et mettre jusqu'à une journée à s'afficher. |
snippet.thumbnails.(key) |
object Les valeurs des clés valides sont les suivantes:
|
snippet.thumbnails.(key).url |
string URL de l'image. Consultez la définition de la propriété snippet.thumbnails pour obtenir des consignes supplémentaires sur l'utilisation d'URL de vignettes dans votre application. |
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.
localizations pour ajouter, mettre à jour ou supprimer des métadonnées localisées. |
snippet.localized.title |
string Titre de la chaîne localisée. |
snippet.localized.description |
string Description de la chaîne localisée. |
snippet.country |
string Pays auquel la chaîne est associée. Pour définir la valeur de cette propriété, modifiez la valeur de la propriété brandingSettings.channel.country . |
contentDetails |
object L'objet contentDetails encapsule les 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 "J'aime" qu'elle a mises en ligne. 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 des éléments à cette liste ou en supprimer. |
contentDetails.relatedPlaylists.favorites |
string Cette propriété a été abandonnée. 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 des éléments à cette liste ou en supprimer.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. Pour des raisons d'historique, cette valeur de propriété peut donc contenir un ID de playlist qui fait référence à une playlist vide et ne peut donc pas être récupérée. |
contentDetails.relatedPlaylists.uploads |
string ID de la playlist contenant les vidéos mises en ligne par la chaîne. Utilisez la méthode videos.insert pour importer de nouvelles vidéos et la méthode videos.delete pour supprimer des vidéos déjà 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é vue. |
statistics.commentCount |
unsigned long Cette propriété est obsolète. Nombre de commentaires de la chaîne. |
statistics.subscriberCount |
unsigned long Nombre d'abonnés de la chaîne. Cette valeur est arrondie à trois chiffres significatifs. Consultez les Historique des révisions ou la Centre d'aide YouTube des informations sur la façon dont le nombre d'abonnés est arrondi. |
statistics.videoCount |
unsigned long Nombre de vidéos publiques mises en ligne sur la chaîne. Notez que cette valeur reflète le nombre uniquement les vidéos publiques de la chaîne, même pour les propriétaires. Ce comportement est cohérent avec les décomptes affichées sur le site Web YouTube. |
topicDetails |
object L'objet topicDetails encapsule des informations sur les thèmes associés à la chaîne.Important:Consultez la définition de la propriété topicDetails.topicIds[] et l'historique des révisions pour en savoir plus sur les modifications liées aux ID de sujet. |
topicDetails.topicIds[] |
list Liste des ID de thèmes associés à la chaîne. Cette propriété a été abandonnée le 10 novembre 2016. Il sera pris en charge jusqu'au 10 novembre 2017. Important:En raison de l'abandon de Freebase et de l'API Freebase, les ID de sujet ont commencé à fonctionner différemment depuis le 27 février 2017. À ce moment-là, YouTube a commencé à renvoyer un petit ensemble d'ID de thèmes sélectionnés. |
topicDetails.topicCategories[] |
list Liste d'URL Wikipédia décrivant le contenu de la chaîne. |
status |
object L'objet status encapsule des informations sur le niveau de confidentialité de la chaîne. |
status.privacyStatus |
string État de confidentialité de la chaîne. Les valeurs valides pour cette propriété sont: <ph type="x-smartling-placeholder">
|
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 ayant l'un de ces liens possède déjà une identité YouTube publique, ce qui est nécessaire pour effectuer plusieurs actions, comme mettre en ligne des vidéos. |
status.longUploadsStatus |
string Indique si la chaîne est autorisée à 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. Les valeurs acceptées pour cette propriété sont les suivantes:
|
status.madeForKids |
boolean Cette valeur indique si la chaîne est destinée aux enfants et si elle contient les contenus "conçus pour les enfants" l'état du critère. Par exemple, l'état peut être déterminé en fonction de la valeur de la propriété selfDeclaredMadeForKids . Pour en savoir plus sur la définition 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éfinir comme étant destinée aux enfants. La
La valeur de la propriété n'est renvoyée que si le propriétaire du canal 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 chaîne. |
brandingSettings.channel.title |
string Titre de la chaîne. Le titre ne doit pas dépasser 30 caractères. |
brandingSettings.channel.description |
string La description de la chaîne, qui apparaît dans la zone d'informations sur la page de chaîne. La valeur de la propriété ne doit pas comporter plus de 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 un espace. Chaîne Les mots clés peuvent être tronqués s'ils dépassent la longueur maximale autorisée de 500 caractères ou s'ils contenaient des guillemets non échappés ( " ). Notez que les 500 caractères
n'est pas une limite par mot clé, mais plutôt une limite concernant la longueur totale de tous les mots clés. |
brandingSettings.channel.trackingAnalyticsAccountId |
string ID du compte Google Analytics que vous souhaitez utiliser pour suivre et mesurer le trafic vers votre chaîne. |
brandingSettings.channel.unsubscribedTrailer |
string Vidéo à lire dans le module "Sélection vidéo" de l'affichage "Parcourir" de la page de chaîne pour les spectateurs non abonnés. Les abonnés peuvent voir une autre vidéo présentant l'activité récente de votre chaîne. Si elle est spécifiée, la valeur de la propriété doit correspondre à l'ID 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 auquel la chaîne est associée. Mettez à jour 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 sont obsolètes. 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 de la zone associée à la marque sur la page de lecture de la vidéo. |
brandingSettings.watch.backgroundColor |
string Remarque:Cette propriété est obsolète. Couleur d'arrière-plan de la zone de marque de la page de lecture de la vidéo. |
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 des informations sur les images qui s'affichent sur la page de chaîne ou sur les pages de lecture des vidéos de la chaîne. |
brandingSettings.image.bannerImageUrl |
string Cette propriété est obsolète. URL de l'image de bannière affichée sur la page de chaîne sur le site YouTube. L'image mesure 1 060 x 175 pixels. |
brandingSettings.image.bannerMobileImageUrl |
string Cette propriété est obsolète. URL de l'image de bannière affichée sur la page de chaîne dans les applications mobiles. L'image mesure 640 x 175 pixels. |
brandingSettings.image.watchIconImageUrl |
string Cette propriété est obsolète. URL de l'image qui s'affiche au-dessus du lecteur vidéo. Il s'agit d'une image de 25 pixels de hauteur, dont la largeur est variable et ne peut pas dépasser 170 pixels. Si vous ne fournissez pas cette image, le nom de votre chaîne s'affichera à la place d'une image. |
brandingSettings.image.trackingImageUrl |
string Cette propriété est obsolète. URL d'un pixel de suivi de 1 x 1 pixel qui peut être utilisé pour recueillir des statistiques sur les vues de la chaîne ou des pages de vidéos. |
brandingSettings.image.bannerTabletLowImageUrl |
string Cette propriété est obsolète. URL d'une image de bannière à faible résolution qui s'affiche sur la page de chaîne dans les applications pour tablette. La taille maximale de l'image est de 1 138 x 188 pixels. |
brandingSettings.image.bannerTabletImageUrl |
string Cette propriété est obsolète. URL d'une image de bannière qui s'affiche sur la page de chaîne dans les applications pour tablette. L'image mesure 1 707 x 283 pixels. |
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 chaîne dans les applications pour tablette. La taille maximale de l'image est de 2 276 x 377 pixels. |
brandingSettings.image.bannerTabletExtraHdImageUrl |
string Cette propriété est obsolète. URL d'une image de bannière très haute résolution qui s'affiche sur la page de 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 chaîne dans les applications mobiles. La taille de l'image ne doit pas dépasser 320 x 88 pixels. |
brandingSettings.image.bannerMobileMediumHdImageUrl |
string Cette propriété est obsolète. URL de l'image d'une bannière de résolution moyenne qui s'affiche sur la page de 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 chaîne dans les applications mobiles. La taille maximale de l'image est de 1 280 x 360 pixels. |
brandingSettings.image.bannerMobileExtraHdImageUrl |
string Cette propriété est obsolète. URL de l'image d'une bannière à très haute résolution qui s'affiche sur la page de chaîne dans les applications mobiles. La taille de l'image ne doit pas dépasser 1 440 x 395 pixels. |
brandingSettings.image.bannerTvImageUrl |
string Cette propriété est obsolète. URL d'une image de bannière très haute résolution qui s'affiche sur la page de chaîne dans les applications TV. 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 chaîne dans les applications TV. La taille de l'image ne doit pas dépasser 854 x 480 pixels. |
brandingSettings.image.bannerTvMediumImageUrl |
string Cette propriété est obsolète. URL de l'image d'une bannière de résolution moyenne qui s'affiche sur la page de chaîne dans les applications TV. 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 chaîne dans les applications TV. 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 utilisée par YouTube pour générer les différentes tailles d'image de bannière d'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înes qu'un réseau multichaîne évaluera pour déterminer s'il convient d'accepter ou de refuser une chaîne spécifique. 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 utilisant ce champ d'application doit être révoqué lorsque le réseau multichaîne accepte ou refuse la chaîne, ou dans les deux semaines suivant la date d'émission du jeton. |
auditDetails.overallGoodStanding |
boolean Ce champ indique si la chaîne présente des problèmes. 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 . Cependant, 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 d'être modifiée. |
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 présente des 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 de contenu associé à la chaîne. |
contentOwnerDetails.timeLinked |
datetime Date et heure auxquelles la chaîne a été associée 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 clé-valeur. La valeur est une chaîne contenant un code de langue BCP-47. |
localizations.(key).title |
string Titre de la chaîne localisée. |
localizations.(key).description |
string Description de la chaîne localisée. |