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 des règles de YouTube qui affecte l'affichage du nombre d'abonnés. Pour en savoir plus, consultez l'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 requête.

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

Cas d'utilisation courants

Demande

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 utilisant 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 un délai de deux semaines à compter de sa date d'émission.

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` spécifie une liste d'une ou de plusieurs propriétés de ressources `channel` qui seront incluses dans la réponse de l'API. 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 noms `part` que vous pouvez inclure dans la valeur du paramètre: `auditDetails` `brandingSettings` `contentDetails` `contentOwnerDetails` `id` `localizations` `snippet` `statistics` `status` `topicDetails`
Filtres (spécifier exactement l'un des paramètres suivants)
`categoryId`	`string` Ce paramètre est obsolète. Le paramètre `categoryId` a spécifié une catégorie de guide YouTube et pourrait être utilisée pour demander des chaînes YouTube associées à cette catégorie.
`forUsername`	`string` Le paramètre `forUsername` spécifie un nom d'utilisateur YouTube, ce qui demande la chaîne associée à ce nom d'utilisateur.
`id`	`string` Le paramètre `id` spécifie une liste d'ID de chaînes YouTube séparés par des virgules 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 réservé aux partenaires de contenu YouTube. Définissez ce paramètre sur `true` pour que l'API ne renvoie que les chaînes gérées par le propriétaire de contenu spécifié par le paramètre `onBehalfOfContentOwner`. L'utilisateur doit être authentifié en tant que compte CMS associé au propriétaire de 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 indiquer à 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 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 détails de ressource localisés sont disponibles dans cette langue, l'objet `snippet.localized` de la ressource contiendra les valeurs localisées. Toutefois, si les détails localisés ne sont pas disponibles, l'objet `snippet.localized` contient les détails 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 autorisées vont de `0` à `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 réservé aux partenaires de contenu YouTube. Le paramètre `onBehalfOfContentOwner` indique que les identifiants d'autorisation de la demande identifient un utilisateur du CMS YouTube qui 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 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 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 extraire la page suivante de l'ensemble de résultats.
`prevPageToken`	`string` Jeton qui peut ê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 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 de canaux correspondant aux critères de la demande.

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)`	`invalidCriteria`	Vous pouvez spécifier au maximum l'un des filtres suivants:`id`, `categoryId`, `mine`, `managedByMe`, `forUsername`. En cas d'authentification du propriétaire de contenu via le paramètre `onBehalfOfContentOwner`, seul `id` ou `managedByMe` peut être spécifié.
`forbidden (403)`	`channelForbidden`	Le canal spécifié par le paramètre `id` n'est pas compatible avec la requête, ou celle-ci 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 la liste des valeurs valides.
`notFound (404)`	`channelNotFound`	Le canal spécifié dans le paramètre `id` est introuvable.

Essayer

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