Members: list

Remarque : Ce point de terminaison ne peut être utilisé que par des créateurs individuels pour effectuer des requêtes concernant leur propre chaîne YouTube pour laquelle les souscriptions sont activées. Contactez votre représentant Google ou YouTube pour demander l'accès.

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

Impact sur le quota : un appel à cette méthode a un coût de quota de 2 unités.

Requête

Requête HTTP

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

Autorisation

Cette requête nécessite une autorisation avec le champ d'application suivant :

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

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 les propriétés de la ressource 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 les membres qui 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) : liste 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 : liste uniquement les membres qui ont rejoint la chaîne ou qui ont changé de niveau depuis l'appel d'API précédent. Notez que le premier appel lance un nouveau flux de mises à jour, mais ne renvoie aucun membre. Pour commencer à récupérer les mises à jour des souscriptions, 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 acceptables sont comprises entre 0 et 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 ensuite à 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îne séparés par une virgule qui peuvent être utilisés pour vérifier l'état de la souscription de certains utilisateurs. Par exemple, UC_1,UC_2,UC_3. Vous pouvez spécifier 100 chaînes au maximum 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
L'Etag de cette ressource.
nextPageToken string
Le jeton qui peut être utilisé comme valeur du paramètre pageToken pour récupérer 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 démarrer une nouvelle requête.
pageInfo object
L'objet pageInfo encapsule les informations de pagination de l'ensemble de résultats.
pageInfo.totalResults integer
Le nombre total de résultats dans l'ensemble de résultats.
pageInfo.resultsPerPage integer
Le nombre de résultats inclus dans la réponse de l'API.
items[] list
Liste des membres 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 documentation sur les messages d'erreur.

Type d'erreur Détails de l'erreur Description
badRequest (400) channelMembershipsNotEnabled Les souscriptions à la chaîne du créateur qui autorise la requête ne sont pas activées.
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 l'`id` spécifié id.
badRequest (400) invalidFilterByMemberChannelId La valeur du paramètre filterByMemberChannelId n'est pas valide. Cette erreur se produit si la filterByMemberChannelId valeur de paramètre spécifie plus de 100 chaînes.