Members

Nota: A partir del 31 de marzo de 2020, el extremo members reemplaza al extremo sponsors, que 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 solicitar su propio canal de YouTube habilitado para las membresías del canal. Comunícate con tu representante de Google o YouTube para solicitar acceso.

Un recurso member representa a un miembro de un canal de YouTube. Este proporciona apoyo monetario 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
Enumera 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
La Etag de este recurso.
snippet object
El objeto snippet contiene detalles sobre el miembro.
snippet.creatorChannelId string
El ID del canal de YouTube del creador que ofrece las membresías.
snippet.memberDetails object
Este objeto contiene datos de perfil del canal de YouTube que paga la membresía.

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

Las respuestas de la API incluyen recursos para esos miembros a fin de garantizar que los recuentos sean precisos, aunque no estén configurados los detalles de perfil dentro del objeto memberDetails. Todavía se proporcionan los membershipsDetails para esos miembros.
snippet.memberDetails.channelId string
El ID del canal de YouTube del canal miembro. Si se configura, el ID del canal también se puede tratar como un identificador único para el miembro. Si no se configura, el miembro no se puede identificar de manera única, pero el recurso igualmente 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
La URL del canal.
snippet.memberDetails.displayName string
El nombre visible del canal
snippet.memberDetails.profileImageUrl string
La URL del avatar del canal.
snippet.membershipsDetails object
Este objeto contiene detalles de la membresía del canal miembro.
snippet.membershipsDetails.highestAccessibleLevel string
El ID del nivel de membresía más alto al que el canal de miembro puede acceder actualmente. Corresponde al valor de la propiedad id en un recurso membershipsLevel.
snippet.membershipsDetails.highestAccessibleLevelDisplayName string
El nombre del nivel de membresía más alto al que el canal miembro puede acceder actualmente. Corresponde al valor de la propiedad displayName en un recurso membershipsLevel.
snippet.membershipsDetails.accessibleLevels[] list (of strings)
Una lista de los IDs de todos los niveles de membresía a los que el usuario tiene acceso actualmente. La lista incluye el nivel activo actualmente y todos los niveles inferiores.
snippet.membershipsDuration object
Este objeto contiene información sobre la duración general de la membresía del miembro actual, sin importar los niveles de precios. Luego, la propiedad snippet.membershipsDetails.membershipsDurationAtLevel[] contiene una lista de objetos con detalles sobre un período de la membresía durante el cual el miembro tuvo acceso a un nivel de membresía particular.

En el siguiente ejemplo, se muestra cómo funcionan estas propiedades: un miembro compra una membresía nueva en enero en el nivel 1 de membresía y tiene esa membresía 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
Fecha y hora en que comenzó la membresía actual del miembro. En otras palabras, el miembro tuvo una membresía de forma continua desde esta fecha y hora. Ten en cuenta que es posible que los diferentes períodos de la membresía se hayan usado en diferentes niveles de membresía.
snippet.membershipsDuration.memberTotalDurationMonths integer
La cantidad de meses en los que el usuario fue miembro (redondeada hacia abajo al número entero más cercano). El valor refleja la cantidad de meses completos en los que el miembro tuvo una membresía, pero el número no implica que el miembro tuvo una membresía de forma continua durante esa cantidad de meses.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel[] list (of objects)
Una lista de objetos, en la que cada objeto contiene detalles sobre un período de la membresía durante el cual el miembro tuvo acceso a un nivel de membresía particular. La lista incluye un objeto por cada nivel de membresía al que el miembro puede acceder actualmente.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.level string
El ID del nivel de membresía. Corresponde al valor de la propiedad id en un recurso membershipsLevel.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.memberSince datetime
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 los diferentes períodos de la membresía se hayan usado en niveles más altos de membresía.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.memberTotalDurationMonths integer
Indica la cantidad de meses, redondeada hacia abajo al número entero más cercano, en los que el usuario tuvo acceso al nivel especificado. El valor refleja la cantidad de meses completos en los que el miembro tuvo acceso al nivel, pero el número no implica que el miembro haya tenido continuamente una membresía durante esos meses.