Members

Une ressource member représente un membre d'une chaîne YouTube channel. Un membre soutient financièrement un créateur de manière récurrente 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.

Les restrictions d'accès suivantes s'appliquent :

  • L'accès aux points de terminaison members et membershipsLevels est limité aux créateurs YouTube qui disposent d'un YouTube Partner Manager dédié.
  • L'accès est accordé au niveau de la chaîne. En raison de cette liste d'autorisation au niveau de la chaîne, le champ d'application OAuth youtube.channel-memberships.creator ne passe pas par la procédure de validation OAuth standard de Google Cloud.

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 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 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é leur chaîne, mais qui paient toujours des souscriptions. Notez que ces membres peuvent toujours accéder aux avantages réservés aux abonnés.

Les réponses de l'API incluent des ressources pour ces membres afin de garantir des décomptes précis, même si les informations de profil de l'objet memberDetails ne sont pas définies. Les membershipsDetails sont toujours fournies pour ces membres.
snippet.memberDetails.channelId string
ID de la chaîne YouTube du membre. S'il est défini, l'ID de la chaîne peut également être traité comme un identifiant unique pour le membre. S'il n'est pas défini, le membre ne peut pas être identifié de manière unique , mais la ressource fournit toujours des informations sur la souscription, telles 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
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 la souscription de 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. La valeur correspond à la id propriété valeur dans une membershipsLevel ressource.
snippet.membershipsDetails.highestAccessibleLevelDisplayName string
Nom du niveau de souscription le plus élevé auquel la chaîne membre peut actuellement accéder. La valeur correspond à la displayName valeur de la propriété dans une membershipsLevel ressource.
snippet.membershipsDetails.accessibleLevels[] list (of strings)
Liste des ID de tous les niveaux de souscription auxquels l'utilisateur peut actuellement accéder. La liste inclut the niveau actuellement actif et tous les niveaux inférieurs.
snippet.membershipsDuration object
Cet objet contient des informations sur la durée totale de la souscription du membre actuel, sans tenir compte des niveaux de prix. La propriétésnippet.membershipsDetails.membershipsDurationAtLevel[] contient ensuite une liste d'objets contenant des informations sur une période de la souscription pendant laquelle le membre avait accès à un niveau de souscription particulier.

L'exemple suivant montre comment ces propriétés fonctionnent : un membre achète une nouvelle souscription en janvier au niveau 1 et la conserve jusqu'en mars. En avril et mai, le membre n'a pas de souscription. En juin, le membre réactive sa souscription, à 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 la souscription actuelle du membre. En d'autres termes, le membre a une souscription continue depuis cette date et heure. Notez que différentes périodes de la souscription peuvent avoir été passées à différents niveaux de souscription.
snippet.membershipsDuration.memberTotalDurationMonths integer
Nombre de mois, arrondi à l'entier inférieur, pendant lesquels l'utilisateur a été membre. La valeur reflète le nombre de mois complets pendant lesquels le membre a eu une souscription, mais elle n'implique pas que le membre a eu une souscription continue pendant ce nombre de mois.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel[] list (of objects)
Liste d'objets, dans laquelle chaque objet contient des informations sur une période de la souscription pendant laquelle le membre avait accès à un niveau de souscription particulier. La liste inclut un objet pour chaque niveau de souscription auquel le membre peut actuellement accéder.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.level string
ID du niveau de souscription. La valeur correspond à la id valeur de la propriété dans une membershipsLevel ressource.
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 un accès continu au niveau depuis cette date et heure. Notez que différentes périodes de la souscription peuvent avoir été passées à des niveaux de souscription plus élevés.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.memberTotalDurationMonths integer
Nombre de mois, arrondi à l'entier inférieur, 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 elle n'implique pas que le membre a eu une souscription continue pendant ce nombre de mois.