Members

Nota: A partir del 31 de marzo de 2020, el extremo members reemplaza al extremo sponsors, que ahora dejó de estar disponible y ya no se admitirá a partir del 30 de septiembre de 2020. Los clientes de la API deben actualizar las llamadas al método sponsors.list para usar el método members.list en su lugar.

Solo los creadores individuales pueden usar este extremo para realizar solicitudes para sus propios canales de YouTube habilitados para membresías. Comunícate con tu representante de Google o YouTube para solicitar acceso.

Un recurso member representa a un miembro de un canal de YouTube. Un miembro proporciona asistencia monetaria recurrente a un creador y recibe beneficios especiales. Por ejemplo, los miembros pueden chatear cuando el creador activa el modo exclusivo para miembros en un chat.

Métodos

La API admite los siguientes métodos para los recursos member:

list
Muestra una lista de los miembros (antes conocidos como “patrocinadores”) de un canal. El propietario del canal debe autorizar la solicitud a la API.

Representación de recursos

En la siguiente estructura JSON, se muestra el formato de un recurso 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,
        }
      ]
    }
  }
}

Propiedades

La siguiente tabla define las propiedades que aparecen en este recurso:

Propiedades
kind string
Identifica el tipo de recurso de la API. El valor será youtube#member.
etag etag
Es la etiqueta de Etag de este recurso.
snippet object
El objeto snippet contiene detalles sobre el miembro.
snippet.creatorChannelId string
Es el ID del canal de YouTube del creador que ofrece membresías.
snippet.memberDetails object
Este objeto contiene datos de perfil sobre el canal de YouTube que paga la membresía.

Ten en cuenta que un canal puede tener miembros con datos de perfil no disponibles. Por ejemplo, esto ocurre con los miembros que borraron sus canales, pero que siguen pagando las membresías. Ten en cuenta que estos miembros aún pueden acceder a sus beneficios de membresía.

Las respuestas de la API incluyen recursos para esos miembros para garantizar recuentos precisos, aunque los detalles del perfil dentro del objeto memberDetails no estén configurados. Los membershipsDetails aún se proporcionan para esos miembros.
snippet.memberDetails.channelId string
Es el ID del canal de YouTube del canal del miembro. Si está configurado, el ID del canal también se puede tratar como un identificador único para el miembro. Si no se establece, no se puede identificar al miembro de forma única, pero el recurso aún transmite detalles de la membresía, como los niveles a los que puede acceder el miembro y la duración de su membresía.
snippet.memberDetails.channelUrl string
Es la URL del canal.
snippet.memberDetails.displayName string
Es el nombre visible del canal.
snippet.memberDetails.profileImageUrl string
Es la URL del avatar del canal.
snippet.membershipsDetails object
Este objeto contiene los detalles de la membresía del canal de miembros.
snippet.membershipsDetails.highestAccessibleLevel string
Es el ID del nivel de membresía más alto al que puede acceder actualmente el canal de miembros. El valor corresponde al valor de la propiedad id en un recurso membershipsLevel.
snippet.membershipsDetails.highestAccessibleLevelDisplayName string
Es el nombre del nivel de membresía más alto al que puede acceder actualmente el canal de miembro. El valor corresponde al valor de la propiedad displayName en un recurso membershipsLevel.
snippet.membershipsDetails.accessibleLevels[] list (of strings)
Es una lista de IDs de todos los niveles de membresía a los que el usuario puede acceder actualmente. La lista incluye el nivel activo actualmente y todos los niveles debajo de él.
snippet.membershipsDuration object
Este objeto contiene información sobre la duración general de la membresía del miembro actual sin tener en cuenta los niveles de precios. Luego, la propiedad snippet.membershipsDetails.membershipsDurationAtLevel[] contiene una lista de objetos que contienen detalles sobre un período de la membresía durante el cual el miembro tuvo acceso a un nivel de membresía en particular.

En el siguiente ejemplo, se muestra cómo funcionan estas propiedades: Un miembro compra una membresía nueva en enero en el nivel de membresía 1 y la tiene hasta marzo. En abril y mayo, el miembro no tiene una membresía. En junio, el miembro reinicia su membresía, nuevamente en el nivel 1. Luego, en agosto, el miembro actualiza su membresía al nivel 2. Por lo tanto, si se realiza una llamada a la API en octubre, el recurso member contendrá lo siguiente: 
"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
Es la fecha y la hora en que comenzó la membresía actual del miembro. En otras palabras, el miembro tiene una membresía continua desde esta fecha y hora. Ten en cuenta que es posible que los diferentes períodos de la membresía se hayan invertido en diferentes niveles.
snippet.membershipsDuration.memberTotalDurationMonths integer
Es la cantidad de meses, redondeada al número entero más cercano, que el usuario ha sido miembro. El valor refleja la cantidad de meses completos que el miembro tuvo una membresía, pero la cantidad no implica que el miembro haya tenido una membresía de forma continua durante esa cantidad de meses.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel[] list (of objects)
Es una lista de objetos, en la que cada uno contiene detalles sobre un período de la membresía durante el cual el miembro tuvo acceso a un nivel de membresía en particular. La lista incluye un objeto para cada nivel de membresía al que el miembro puede acceder actualmente.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.level string
Es el ID del nivel de membresía. El valor corresponde al valor de la propiedad id en un recurso membershipsLevel.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.memberSince datetime
Es la fecha y hora a partir de la cual el miembro tuvo acceso al nivel de membresía especificado. En otras palabras, el miembro tuvo acceso continuo al nivel desde esta fecha y hora. Ten en cuenta que es posible que diferentes períodos de la membresía se hayan invertido en niveles más altos.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.memberTotalDurationMonths integer
Es la cantidad de meses, redondeada hacia abajo al número entero más cercano, que el usuario tuvo acceso al nivel especificado. El valor refleja la cantidad de meses completos que el miembro tuvo acceso al nivel, pero la cantidad no implica que el miembro haya tenido una membresía de forma continua durante esa cantidad de meses.