Channels: list

Remarque : La valeur de la propriété statistics.subscriberCount de la ressource channel a été mise à jour pour refléter une modification des règles YouTube qui affecte la façon dont le nombre d'abonnés est affiché. Pour en savoir plus, consultez l'historique des révisions ou le Centre d'aide YouTube.

Renvoie une collection de zéro ressource channel ou plus correspondant aux critères de la requête.

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

Cas d'utilisation courants

Requête

Requête HTTP

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

Autorisation

Une requête qui récupère la partie auditDetails d'une ressource channel 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 ce champ d'application doit être révoqué lorsque le réseau multichaîne décide d'accepter ou de refuser la chaîne, ou dans les deux semaines suivant la date d'émission du jeton.

Paramètres

Le tableau suivant répertorie les paramètres acceptés par 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 spécifie une liste de une ou plusieurs propriétés de ressource channel séparées par une virgule que la réponse de l'API inclura.

Si le paramètre identifie une propriété contenant des propriétés enfants, celles-ci seront incluses dans la réponse. Par exemple, dans une ressource channel, la propriété contentDetails contient d'autres propriétés, telles que les propriétés uploads. Par conséquent, si vous définissez part=contentDetails, la réponse de l'API contiendra également toutes ces propriétés imbriquées.

La liste suivante contient les part noms que vous pouvez inclure dans la valeur du paramètre:
  • auditDetails
  • brandingSettings
  • contentDetails
  • contentOwnerDetails
  • id
  • localizations
  • snippet
  • statistics
  • status
  • topicDetails
Filtres (spécifiez exactement l'un des paramètres suivants)
categoryId string
Ce paramètre est obsolète. Le paramètre categoryId spécifiait une catégorie du guide YouTube et pouvait être utilisé pour demander des chaînes YouTube associées à cette catégorie.
forHandle string
Le paramètre forHandle spécifie un identifiant YouTube, demandant ainsi la chaîne associée à cet identifiant. La valeur du paramètre peut être précédée du symbole @. Par exemple, pour récupérer la ressource de la chaîne "Google for Developers", définissez la valeur du paramètre forHandle sur GoogleDevelopers ou @GoogleDevelopers.
forUsername string
Le paramètre forUsername spécifie un nom d'utilisateur YouTube, demandant ainsi la chaîne associée à ce nom d'utilisateur.
id string
Le paramètre id spécifie une liste d'ID de chaîne YouTube séparés par une virgule pour les ressources récupérées. Dans une ressource channel, la propriété id spécifie l'ID de la chaîne YouTube.
managedByMe boolean
Ce paramètre ne peut être utilisé que dans une requête correctement autorisée.

Remarque : Ce paramètre est destiné exclusivement aux partenaires de contenu YouTube.

Définissez la valeur de ce paramètre sur true pour demander à l'API de ne renvoyer que les chaînes gérées par le propriétaire du contenu spécifié par le paramètre onBehalfOfContentOwner. L'utilisateur doit être authentifié en tant que compte CMS associé au propriétaire du contenu spécifié, et onBehalfOfContentOwner doit être fourni.
mine boolean
Ce paramètre ne peut être utilisé que dans une requête correctement autorisée. Définissez la valeur de ce paramètre sur true pour demander à l'API de ne renvoyer que les chaînes appartenant à l'utilisateur authentifié.
Paramètres facultatifs
hl string
Le paramètre hl demande à l'API de récupérer les métadonnées de ressources localisées pour une langue d'application spécifique compatible avec le site Web YouTube. La valeur du paramètre doit être un code de langue inclus dans la liste renvoyée par la méthode i18nLanguages.list.

Si des informations de ressources localisées sont disponibles dans cette langue, l'objet snippet.localized de la ressource contiendra les valeurs localisées. Toutefois, si aucune information localisée n'est disponible, l'objet snippet.localized contiendra des informations sur la ressource dans la langue par défaut de la ressource.
maxResults unsigned integer
Le paramètre maxResults spécifie le nombre maximal d'éléments à renvoyer dans l'ensemble de résultats. Les valeurs acceptables sont comprises entre 0 et 50 inclus. La valeur par défaut est 5.
onBehalfOfContentOwner string
Ce paramètre ne peut être utilisé que dans une requête correctement autorisée.

Remarque : Ce paramètre est destiné exclusivement aux partenaires de contenu YouTube.

Le paramètre onBehalfOfContentOwner indique que les identifiants d'autorisation de la requête identifient un utilisateur YouTube CMS qui agit au nom du propriétaire du 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 avec lequel l'utilisateur s'authentifie doit être associé au propriétaire du contenu YouTube spécifié.
pageToken string
Le paramètre pageToken identifie une page spécifique de l'ensemble de résultats à renvoyer. Dans une réponse de l'API, les propriétés nextPageToken et prevPageToken identifient d'autres pages qui pourraient être récupérées.

Corps de la requête

Ne fournissez pas de corps de requête lorsque vous appelez cette méthode.

Réponse

Si la requête aboutit, cette méthode renvoie un corps de réponse présentant la structure suivante :

{
  "kind": "youtube#channelListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    channel Resource
  ]
}

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 de l'API. La valeur sera youtube#channelListResponse.
etag etag
Etag de cette ressource.
nextPageToken string
Jeton pouvant être utilisé comme valeur du paramètre pageToken pour récupérer la page suivante dans l'ensemble de résultats.
prevPageToken string
Jeton pouvant être utilisé comme valeur du paramètre pageToken pour récupérer la page précédente dans l'ensemble de résultats. Notez que cette propriété n'est pas incluse dans la réponse de l'API si la requête d'API correspondante a défini le paramètre managedByMe sur true.
pageInfo object
L'objet pageInfo encapsule les informations de pagination pour l'ensemble de résultats.
pageInfo.totalResults integer
Nombre total de résultats dans l'ensemble de résultats.
pageInfo.resultsPerPage integer
Nombre de résultats inclus dans la réponse de l'API.
items[] list
Liste des chaînes correspondant aux critères de la requête.

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 section Erreurs de l'API YouTube Data.

Type d'erreur Détails de l'erreur Description
badRequest (400) invalidCriteria Vous ne pouvez spécifier qu'un seul des filtres suivants : id, categoryId, mine, managedByMe, forHandle ou forUsername. En cas d'authentification du propriétaire du contenu via le paramètre onBehalfOfContentOwner, seuls id ou managedByMe peuvent être spécifiés.
forbidden (403) channelForbidden La chaîne spécifiée par le paramètre id n'est pas compatible avec la requête ou la requête n'est pas correctement autorisée.
notFound (404) categoryNotFound La catégorie identifiée par le paramètre categoryId est introuvable. Utilisez la méthode guideCategories.list pour récupérer une liste de valeurs valides.
notFound (404) channelNotFound La chaîne spécifiée dans le paramètre id est introuvable.

Essayer

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