Members

Nota: A partir del 31 de marzo de 2020, el extremo members reemplaza al extremo sponsors, que ahora está obsoleto y dejará de ser compatible a partir del 30 de septiembre de 2020. Los clientes de la API deben actualizar las llamadas al método sponsors.list para que usen el método members.list en su lugar.

Solo los creadores individuales pueden usar este extremo para realizar solicitudes a su propio canal de YouTube compatible con las membresías del canal. Comunícate con tu representante de Google o YouTube para solicitar acceso.

Un recurso member representa a un miembro del canal para 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 chatear.

Métodos

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

list
Enumera los miembros (anteriormente conocidos como “patrocinadores”) de un canal. El propietario del canal debe autorizar la solicitud a la API.

Representación de recursos

La siguiente estructura JSON 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 API. El valor será youtube#member.
etag etag
Es la Etag de este recurso.
snippet object
El objeto snippet contiene detalles sobre el miembro.
snippet.creatorChannelId string
ID del canal de YouTube del creador que ofrece 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. Por ejemplo, esto sucede con los miembros que borraron sus canales, pero que aún pagan las membresías. Ten en cuenta que estos miembros aún pueden acceder a los beneficios de la membresía.

Las respuestas de la API incluyen recursos para esos miembros a fin de garantizar recuentos precisos, aunque no se hayan establecido los detalles del perfil dentro del objeto memberDetails. Aún se proporcionan las membershipsDetails para esos miembros.
snippet.memberDetails.channelId string
Corresponde al ID de canal de YouTube del canal miembro. Si se establece, 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 forma única, pero el recurso sigue transmitiendo los detalles de la membresía, como los niveles a los que puede acceder y su duración.
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 miembro.
snippet.membershipsDetails.highestAccessibleLevel string
Indica el ID del nivel de membresía más alto al que puede acceder el canal miembro en ese momento. El valor corresponde al valor de la propiedad id en un recurso membershipsLevel.
snippet.membershipsDetails.highestAccessibleLevelDisplayName string
Corresponde al nombre del nivel de membresía más alto al que puede acceder el canal miembro en ese momento. El valor corresponde al valor de la propiedad displayName en un recurso membershipsLevel.
snippet.membershipsDetails.accessibleLevels[] list (of strings)
Lista de ID de todos los niveles de membresía a los que el usuario tiene acceso. La lista incluye el nivel activo actual 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 tener en cuenta los niveles de precios. 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 específico.

En el siguiente ejemplo, se muestra cómo funcionan estas propiedades: un miembro compra una membresía nueva en enero en el nivel 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 de nuevo en el nivel 1. Luego, en agosto, el miembro actualizará 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 hora en que comenzó la membresía actual del miembro. En otras palabras, el miembro ha tenido una membresía de manera continua desde esta fecha y hora. Ten en cuenta que los diferentes períodos de la membresía pueden haberse gastado en diferentes niveles de la membresía.
snippet.membershipsDuration.memberTotalDurationMonths integer
Es la cantidad de meses, redondeados hacia abajo hasta el número entero más cercano, de que el usuario haya sido miembro. El valor refleja la cantidad de meses completos en que el miembro ha tenido una membresía, pero el número no implica que el miembro haya tenido una membresía de manera continua durante esos 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 en el que 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 tiene acceso actualmente.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.level string
Corresponde al ID de 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 la hora a partir de las cuales 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 los diferentes períodos de la membresía pueden haberse gastado en niveles de la membresía más altos.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.memberTotalDurationMonths integer
Es la cantidad de meses, redondeados hacia abajo hasta el 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 eso no implica que el miembro haya tenido una membresía de manera continua por tantos meses.