Members

Remarque: Depuis le 31 mars 2020, le point de terminaison members remplace le point de terminaison sponsors, qui est désormais obsolète et ne sera plus pris en charge à partir du 30 septembre 2020 ou après cette date. Les clients de l'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éatrices et créateurs individuels pour envoyer des requêtes concernant leur propre chaîne YouTube avec des souscriptions. Contactez votre représentant Google ou YouTube pour demander l'accès.

Une ressource member représente un membre d'une chaîne YouTube. Un membre apporte un soutien financier récurrent à un créateur et bénéficie d'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 prend en charge 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 de la ressource

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 la ressource de l'API. La valeur sera 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 des données de profil sur la chaîne YouTube qui paie la souscription.

Notez qu'une chaîne peut avoir des membres dont les données de profil ne sont pas disponibles. Par exemple, cela se produit avec les membres qui ont supprimé leurs chaînes, mais qui paient toujours leurs souscriptions. Notez que ces membres peuvent toujours accéder à leurs avantages.

Les réponses de l'API incluent des ressources pour ces membres afin de garantir des comptages précis, même si les informations de profil dans l'objet memberDetails ne sont pas définies. Les membershipsDetails sont toujours fournis pour 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 canal peut également être considéré comme un identifiant unique pour le membre. Si elle n'est pas définie, le membre ne peut pas être identifié de manière unique, mais la ressource transmet toujours des informations sur l'appartenance, telles que les niveaux auxquels le membre peut accéder et la durée de son appartenance.
snippet.memberDetails.channelUrl string
URL de la chaîne.
snippet.memberDetails.displayName string
Nom à afficher de la chaîne.
snippet.memberDetails.profileImageUrl string
URL de l'avatar de la chaîne.
snippet.membershipsDetails object
Cet objet contient des informations sur l'abonnement à la chaîne réservée aux membres.
snippet.membershipsDetails.highestAccessibleLevel string
ID du niveau de souscription le plus élevé auquel la chaîne de membres peut actuellement accéder. La valeur correspond à la valeur de la propriété id dans une ressource membershipsLevel.
snippet.membershipsDetails.highestAccessibleLevelDisplayName string
Nom du niveau de souscription le plus élevé auquel la chaîne du membre peut actuellement accéder. La valeur correspond à la valeur de la propriété displayName dans une ressource membershipsLevel.
snippet.membershipsDetails.accessibleLevels[] list (of strings)
Liste des ID de tous les niveaux d'abonnement auxquels l'utilisateur peut actuellement accéder. La liste inclut le niveau actuellement actif et tous les niveaux en dessous.
snippet.membershipsDuration object
Cet objet contient des informations sur la durée totale de l'abonnement actuel du membre, sans tenir compte des niveaux de tarification. La propriété snippet.membershipsDetails.membershipsDurationAtLevel[] contient ensuite une liste d'objets contenant des informations sur une période d'adhésion au cours de laquelle le membre avait accès à un niveau d'adhésion particulier.

L'exemple suivant montre comment ces propriétés fonctionnent: un membre achète une nouvelle adhésion en janvier au niveau d'adhésion 1 et la conserve jusqu'en mars. En avril et en mai, le membre n'est pas abonné. En juin, le membre réactive son abonnement, à nouveau au niveau 1. En août, le membre passe au niveau 2. Par conséquent, si un appel d'API est effectué en octobre, la ressource member contient 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 est membre depuis cette date et cette heure. Notez que différentes périodes de l'abonnement peuvent avoir été passées à différents niveaux d'abonnement.
snippet.membershipsDuration.memberTotalDurationMonths integer
Nombre de mois (arrondi à l'entier le plus proche) pendant lesquels l'utilisateur a été membre. Cette valeur reflète le nombre de mois complets pendant lesquels le membre a été abonné, mais ce nombre n'implique pas que le membre a été abonné pendant autant de mois.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel[] list (of objects)
Liste d'objets, dans lesquels chaque objet contient des informations sur une période d'abonnement au cours de laquelle le membre avait accès à un niveau d'abonnement particulier. La liste comprend un objet pour chaque niveau d'abonnement auquel le membre peut actuellement accéder.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.level string
ID du niveau d'abonnement. La valeur correspond à la valeur de la propriété id dans une ressource membershipsLevel.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.memberSince datetime
Date et heure à partir desquelles le membre a accès au niveau d'abonnement spécifié. En d'autres termes, le membre a eu accès au niveau en continu depuis cette date et cette heure. Notez que différentes périodes de l'abonnement peuvent avoir été passées à des niveaux d'abonnement plus élevés.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.memberTotalDurationMonths integer
Nombre de mois, arrondi à l'entier le plus proche, pendant lesquels l'utilisateur a eu accès au niveau spécifié. Cette valeur reflète le nombre de mois complets pendant lesquels le membre a eu accès au niveau, mais ce nombre n'implique pas que le membre ait eu un abonnement continu pendant autant de mois.