Members

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

Se aplican las siguientes restricciones de acceso:

  • El acceso a los members y membershipsLevels extremos se limita a los creadores de YouTube que tienen un administrador de socios de YouTube exclusivo.
  • El acceso se otorga a nivel del canal. Debido a esta lista de entidades permitidas a nivel del canal, el permiso de OAuth youtube.channel-memberships.creator no pasa por el proceso de verificación estándar de OAuth de Google Cloud.

Métodos

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

list
Muestra 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 el 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 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 para garantizar recuentos precisos, incluso si no se configuran los detalles del perfil dentro del objeto memberDetails. Los membershipsDetails aún se proporcionan para esos miembros.
snippet.memberDetails.channelId string
Es el ID del 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 establece, el miembro no se puede identificar 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 detalles de la membresía para el canal miembro.
snippet.membershipsDetails.highestAccessibleLevel string
Es el ID del nivel de membresía más alto al que puede acceder actualmente el canal miembro. 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 miembro. El valor corresponde al displayName valor de la propiedad en un membershipsLevel recurso.
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 actual y todos los niveles inferiores.
snippet.membershipsDuration object
Este objeto contiene información sobre la duración general de la membresía actual del miembro sin importar los niveles de precios. La snippet.membershipsDetails.membershipsDurationAtLevel[] propiedad contiene una lista de objetos que incluyen 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 ha tenido una membresía de forma continua desde esta fecha y hora. Ten en cuenta que es posible que se hayan pasado diferentes períodos de la membresía en diferentes niveles de membresía.
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 ha tenido 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 objeto 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 id valor de la propiedad en un membershipsLevel recurso.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.memberSince datetime
Es la fecha y la hora desde las que el miembro ha tenido acceso al nivel de membresía especificado. En otras palabras, el miembro ha tenido acceso al nivel de forma continua desde esta fecha y hora. Ten en cuenta que es posible que se hayan pasado diferentes períodos de la membresía en niveles de membresía más altos.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.memberTotalDurationMonths integer
Es la cantidad de meses, redondeada al número entero más cercano, que el usuario ha tenido acceso al nivel especificado. El valor refleja la cantidad de meses completos que el miembro ha tenido acceso al nivel, pero la cantidad no implica que el miembro haya tenido una membresía de forma continua durante esa cantidad de meses.