Cette page a été traduite par l'API Cloud Translation.

Channels: list

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

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

Impact sur les quotas:un appel à cette méthode a un coût de quota de 1 unité.

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 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.

Paramètres

Le tableau suivant présente 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` spécifie une liste séparée par une virgule d'une ou de plusieurs propriétés de ressources `channel` que la réponse de l'API inclura. Si le paramètre identifie une propriété contenant des propriétés enfants, les propriétés enfants 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 noms `part` 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 de guides YouTube et pouvait être utilisé pour demander les chaînes YouTube associées à cette catégorie.
`forHandle`	`string` Le paramètre `forHandle` spécifie un identifiant YouTube, ce qui permet de demander la chaîne associée à cet identifiant. Un symbole `@` peut être ajouté au début de la valeur du paramètre. Par exemple, pour récupérer la ressource pour la chaîne "Google pour les développeurs", 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, ce qui permet de demander 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 la ou les ressources récupérées. Dans une ressource `channel`, la propriété `id` spécifie l'ID de chaîne YouTube de la chaîne.
`managedByMe`	`boolean` Ce paramètre ne peut être utilisé que dans une requête autorisée appropriée. Remarque:Ce paramètre est destiné exclusivement aux partenaires de contenus 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 titulaire de contenu spécifié, et `onBehalfOfContentOwner` doit être fourni.
`mine`	`boolean` Ce paramètre ne peut être utilisé que dans une requête autorisée. Définissez la valeur de ce paramètre sur `true` pour demander à l'API de ne renvoyer que les canaux appartenant à l'utilisateur authentifié.
Paramètres facultatifs
`hl`	`string` Le paramètre `hl` indique à l'API de récupérer les métadonnées de ressources localisées pour une langue d'application spécifique prise en charge par 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 contient les valeurs localisées. Toutefois, si des informations localisées ne sont pas disponibles, l'objet `snippet.localized` contient les informations de 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 acceptées 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 autorisée appropriée. Remarque:Ce paramètre est destiné exclusivement aux partenaires de contenus YouTube. Le paramètre `onBehalfOfContentOwner` indique que les identifiants d'autorisation de la requête identifient un utilisateur du CMS YouTube agissant au nom du propriétaire du contenu spécifié dans la valeur du paramètre. Ce paramètre est destiné aux partenaires de contenus YouTube qui possèdent et gèrent de nombreuses chaînes YouTube différentes. Il permet aux propriétaires de contenus 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 de 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 d'API, les propriétés `nextPageToken` et `prevPageToken` identifient d'autres pages pouvant ê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 la ressource 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 de 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 de 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 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 canaux 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 de cette méthode. Pour en savoir plus, consultez API YouTube Data - Erreurs.

Type d'erreur	Détail 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 de contenu via le paramètre `onBehalfOfContentOwner`, vous ne pouvez spécifier que `id` ou `managedByMe`.
`forbidden (403)`	`channelForbidden`	Le canal spécifié 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`	Impossible de trouver la catégorie identifiée par le paramètre `categoryId`. Utilisez la méthode guideCategories.list pour récupérer la liste des valeurs valides.
`notFound (404)`	`channelNotFound`	Impossible de trouver la chaîne spécifiée dans le paramètre `id`.

Essayer

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