Members: list

Remarque: Ce point de terminaison ne peut être utilisé que par les créateurs individuels pour demander l'ajout d'une chaîne YouTube sur laquelle les souscriptions sont activées. Contactez votre représentant Google ou YouTube pour demander l'accès.

Liste les membres (anciennement "sponsors") d'une chaîne. La demande d'API doit être autorisée par le propriétaire de la chaîne.

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

Demande

Requête HTTP :

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

Autorisation

Cette requête nécessite une autorisation dont la portée est la suivante:

Champ d'application
https://www.googleapis.com/auth/youtube.channel-memberships.creator

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 les propriétés de ressources member que la réponse de l'API inclura. Définissez la valeur du paramètre sur snippet.
Paramètres facultatifs
mode	string Le paramètre mode indique quels membres seront inclus dans la réponse de l'API. Définissez la valeur du paramètre sur l'une des valeurs suivantes : all_current (par défaut) : répertorie les membres actuels, du plus récent au plus ancien. Lorsque cette valeur est utilisée, la fin de la liste est atteinte lorsque la réponse de l'API ne contient pas de nextPageToken. updates : ne répertorie que les membres qui ont rejoint ou mis à niveau depuis l'appel d'API précédent. Notez que le premier appel lance un nouveau flux de mises à jour, mais ne renvoie en réalité aucun membre. Pour commencer à récupérer les mises à jour des membres, vous devez interroger le point de terminaison à l'aide de nextPageToken à la fréquence souhaitée. Notez que lorsque cette valeur est utilisée, la réponse de l'API contient toujours un nextPageToken.
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 à 1000, inclus. La valeur par défaut est 5.
pageToken	string Le paramètre pageToken identifie une page spécifique de l'ensemble de résultats à renvoyer. Le jeton est spécifique au mode utilisé avec la requête API d'origine. Vous ne pouvez donc pas utiliser un jeton de page récupéré avec un mode pour passer par un autre mode.
hasAccessToLevel	string La valeur du paramètre hasAccessToLevel est un ID de niveau qui spécifie le niveau minimal que les membres de l'ensemble de résultats doivent avoir.
filterByMemberChannelId	string Le paramètre filterByMemberChannelId spécifie une liste d'ID de chaînes séparés par des virgules, qui permettent de vérifier l'état d'adhésion de certains utilisateurs. Par exemple, UC_1,UC_2,UC_3. Vous pouvez spécifier un maximum de 100 canaux par appel.

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#memberListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    member 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#memberListResponse.
etag	etag ETag de cette ressource.
nextPageToken	string Jeton qui peut être utilisé comme valeur du paramètre pageToken pour extraire la page suivante de l'ensemble de résultats. Les jetons de page peuvent expirer. Votre application doit supprimer le jeton et appeler l'API sans pageToken pour lancer une nouvelle requête.
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 membres qui correspondent 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)	channelMembershipsNotEnabled	Les souscriptions ne sont pas activées sur la chaîne du créateur qui autorise la demande.
badRequest (400)	invalidMode	La valeur du paramètre mode n'est pas valide. Cette erreur peut se produire si le paramètre pageToken spécifie un jeton récupéré à l'aide d'un mode différent de celui spécifié.
badRequest (400)	invalidPageToken	La valeur du paramètre pageToken n'est pas valide. Cette erreur peut se produire si le jeton de page utilisé dans la requête a expiré ou n'est pas reconnu.
badRequest (400)	invalidHasAccessToLevel	La valeur du paramètre hasAccessToLevel n'est pas valide. Il n'existe aucun niveau avec le id spécifié.
badRequest (400)	invalidFilterByMemberChannelId	La valeur du paramètre filterByMemberChannelId n'est pas valide. Cette erreur se produit si la valeur du paramètre filterByMemberChannelId spécifie plus de 100 canaux.