Members

Remarque: À compter du 31 mars 2020, le point de terminaison members remplace le point de terminaison sponsors, qui est désormais obsolète et ne sera plus accepté à compter du 30 septembre 2020. Les clients API doivent mettre à jour les appels à la méthode sponsors.list pour utiliser la méthode members.list à la place.

Ce point de terminaison ne peut être utilisé que par des créateurs individuels pour envoyer une demande 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.

Une ressource member représente le membre d'une chaîne YouTube. Un membre offre un soutien financier récurrent à un créateur et reçoit des avantages spéciaux. Par exemple, les membres peuvent discuter lorsque le créateur active le mode réservé aux membres pour un chat.

Méthodes

L'API est compatible avec les méthodes suivantes pour les ressources member:

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

Représentation des ressources

La structure JSON suivante montre le format d'une ressource member:

{
  "kind": "youtube#member",
  "etag": etag,
  "snippet": {
    "creatorChannelId": string,
    "memberDetails": {
      "channelId": string,
      "channelUrl": string,
      "displayName": string,
      "profileImageUrl": string
    },
    "membershipsDetails": {
      "highestAccessibleLevel": string,
      "highestAccessibleLevelDisplayName": string,
      "accessibleLevels": [
        string
      ],
      "membershipsDuration": {
        "memberSince": datetime,
        "memberTotalDurationMonths": integer,
      },
      "membershipsDurationAtLevel": [
        {
          "level": string,
          "memberSince": datetime,
          "memberTotalDurationMonths": integer,
        }
      ]
    }
  }
}

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#member.
etag etag
Etag de cette ressource.
snippet object
L'objet snippet contient des informations sur le membre.
snippet.creatorChannelId string
ID de la chaîne YouTube du créateur qui propose des souscriptions.
snippet.memberDetails object
Cet objet contient les données de profil de la chaîne YouTube qui paie la souscription.

Sachez qu'une chaîne peut comporter des membres dont les données de profil ne sont pas disponibles. C'est par exemple le cas des membres qui ont supprimé leur chaîne, mais qui paient toujours une souscription. Notez que ces membres peuvent toujours accéder aux avantages de leur abonnement.

Les réponses de l'API incluent des ressources pour ces membres afin de garantir des décomptes précis, même si les détails du profil dans l'objet memberDetails ne sont pas définis. Les membershipsDetails sont toujours fournis à ces membres.
snippet.memberDetails.channelId string
ID de la chaîne YouTube de la chaîne membre. S'il est défini, l'ID de la chaîne peut également être considéré comme un identifiant unique pour le membre. Si cette valeur n'est pas définie, le membre ne peut pas être identifié de manière unique, mais la ressource transmet tout de même des détails sur l'adhésion, tels que les niveaux auxquels le membre peut accéder et la durée de sa souscription.
snippet.memberDetails.channelUrl string
URL de la chaîne.
snippet.memberDetails.displayName string
Le nom à afficher de la chaîne.
snippet.memberDetails.profileImageUrl string
URL de l'avatar de la chaîne.
snippet.membershipsDetails object
Cet objet contient les informations sur l'abonnement à la chaîne membre.
snippet.membershipsDetails.highestAccessibleLevel string
ID du niveau de souscription le plus élevé auquel la chaîne membre peut actuellement accéder. Cette valeur correspond à la valeur de la propriété id d'une ressource membershipsLevel.
snippet.membershipsDetails.highestAccessibleLevelDisplayName string
Nom du niveau de souscription le plus élevé auquel la chaîne de membre peut actuellement accéder. Cette valeur correspond à la valeur de la propriété displayName d'une ressource membershipsLevel.
snippet.membershipsDetails.accessibleLevels[] list (of strings)
Liste des ID de tous les niveaux de souscription auxquels l'utilisateur a actuellement accès. La liste comprend le niveau actuellement actif et tous les niveaux inférieurs.
snippet.membershipsDuration object
Cet objet contient des informations sur la durée totale de l'abonnement du membre actuel sans tenir compte des niveaux de tarification. La propriété snippet.membershipsDetails.membershipsDurationAtLevel[] contient ensuite une liste d'objets comportant des informations sur la période de validité pendant laquelle le membre a eu accès à un niveau de souscription particulier.

L'exemple suivant montre comment fonctionnent ces propriétés: un membre achète une nouvelle souscription en janvier au niveau 1, et cette souscription se termine en mars. En avril et en mai, le membre n'a pas de souscription. En juin, le membre réactive sa souscription, de nouveau au niveau 1. Puis, en août, il passe au niveau 2. Ainsi, si un appel d'API est effectué en octobre, la ressource member contiendra les éléments suivants : 
"membershipsDetails": {
  "membershipsDuration": {
    "memberSince": "2020-06-01T12:00:00",
    "memberTotalDurationMonths": 7,
  },
  "membershipsDurationAtLevel": [
    {
      "level": "level_1_ID",
      "memberSince": "2020-06-01T12:00:00",
      "memberTotalDurationMonths": 7
    },
    {
      "level": "level_2_ID",
      "memberSince": "2020-08-01T12:00:00",
      "memberTotalDurationMonths": 2
    },
  ]
}
snippet.membershipsDuration.memberSince datetime
Date et heure de début de l'abonnement actuel du membre. En d'autres termes, le membre a toujours été membre depuis cette date et cette heure. Notez que différentes périodes de souscription peuvent avoir été dépensées à différents niveaux.
snippet.membershipsDuration.memberTotalDurationMonths integer
Nombre de mois pendant lesquels l'utilisateur est membre, arrondi au nombre entier inférieur le plus proche. La valeur reflète le nombre de mois complets pendant lesquels le membre a souscrit à la chaîne, mais ce nombre ne signifie pas que le membre a souscrit sans cesse depuis autant de mois.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel[] list (of objects)
Liste d'objets, dans laquelle chaque objet contient des informations sur la période de validité pendant laquelle le membre a eu accès à un niveau de souscription particulier. La liste comprend un objet pour chaque niveau de souscription auquel le membre a actuellement accès.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.level string
ID du niveau de souscription. Cette valeur correspond à la valeur de la propriété id d'une ressource membershipsLevel.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.memberSince datetime
Date et heure à partir desquelles le membre a eu accès au niveau de souscription spécifié. En d'autres termes, le membre a eu accès au niveau de façon continue depuis cette date et cette heure. Notez que différentes périodes de souscription peuvent avoir été passées à des niveaux de souscription plus élevés.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.memberTotalDurationMonths integer
Nombre de mois, arrondi au nombre entier inférieur le plus proche, pendant lesquels l'utilisateur a eu accès au niveau spécifié. La valeur reflète le nombre de mois complets pendant lesquels le membre a eu accès au niveau, mais ce nombre ne signifie pas que le membre a souscrit sans cesse depuis autant de mois.