statistics.subscriberCount
de la ressource channel
a été mise à jour pour refléter une modification du règlement 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, une ou plusieurs ressources channel
correspondant aux critères de la requête.
Impact sur les quotas:un appel à cette méthode entraîne un coût du 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 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 sa date d'émission.
Paramètres
Le tableau suivant répertorie les paramètres compatibles avec cette requête. Tous les paramètres répertoriés sont des paramètres de requête.
Paramètres | ||
---|---|---|
Paramètres obligatoires | ||
part |
string Le paramètre part spécifie une liste d'une ou de plusieurs propriétés de ressources channel séparées par une virgule 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 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:
|
|
Filtres (spécifiez exactement un des paramètres suivants) | ||
categoryId |
string Ce paramètre est obsolète. Le paramètre categoryId spécifiait une catégorie de 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 et demande ainsi la chaîne associée à cet identifiant. La valeur du paramètre peut être précédée d'un 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 et demande ainsi 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 une virgule pour la ou les ressources en cours de récupération. 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 demande autorisée correctement. Remarque:Ce paramètre est destiné exclusivement aux partenaires de contenu YouTube. Définissez la valeur de ce paramètre sur true pour indiquer à l'API de ne renvoyer que les chaînes gérées par le propriétaire de contenu spécifiées par le paramètre onBehalfOfContentOwner . L'utilisateur doit s'authentifier en tant que compte CMS associé au propriétaire de contenu spécifié, et le onBehalfOfContentOwner doit être fourni. |
|
mine |
boolean Ce paramètre ne peut être utilisé que dans une demande autorisée correctement. 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 localisées de ressources 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 sur la ressource localisée 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 contiendra 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 demande autorisée correctement. Remarque:Ce paramètre est destiné exclusivement 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 un grand nombre de chaînes YouTube. Il 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 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 de l'API, les propriétés nextPageToken et prevPageToken identifient d'autres pages qui peuvent ê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 d'API. La valeur est 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 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 chaînes correspondant aux critères de la demande. |
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 la documentation sur les messages d'erreur.
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 , forHandle , forUsername . En cas d'authentification du propriétaire de contenu via le paramètre onBehalfOfContentOwner , seul l'élément 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 autorisée correctement. |
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 |
Impossible de trouver la version 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.