Members: list

Nota: Los creadores individuales solo pueden usar este extremo para realizar solicitudes para su propio canal de YouTube que tenga habilitadas las membresías. Comunícate con tu representante de Google o YouTube para solicitar acceso.

Muestra los miembros (anteriormente conocidos como "patrocinadores") de un canal. El propietario del canal debe autorizar la solicitud a la API.

Impacto en la cuota: Una llamada a este método tiene un costo de cuota de 2 unidades.

Solicitud

Solicitud HTTP

GET https://www.googleapis.com/youtube/v3/members

Autorización

Esta solicitud requiere una autorización con el siguiente alcance:

Alcance
https://www.googleapis.com/auth/youtube.channel-memberships.creator

Parámetros

En la siguiente tabla, se enumeran los parámetros que admite esta consulta. Todos los parámetros mencionados son parámetros de consulta.

Parámetros
Parámetros obligatorios
part string
El parámetro part especifica las propiedades del recurso member que incluirá la respuesta de la API. Establece el valor del parámetro en snippet.
Parámetros opcionales
mode string
El parámetro mode indica qué miembros se incluirán en la respuesta de la API. Establece el valor del parámetro en uno de los siguientes valores:
  • all_current (predeterminado): Muestra los miembros actuales, del más reciente al más antiguo. Cuando se usa este valor, se llega al final de la lista cuando la respuesta de la API no contiene un nextPageToken.
  • updates - Muestra solo los miembros que se unieron o actualizaron desde la llamada a la API anterior. Ten en cuenta que la primera llamada inicia una nueva transmisión de actualizaciones, pero no muestra ningún miembro. Para comenzar a recuperar las actualizaciones de membresía, debes sondear el extremo con el nextPageToken en la frecuencia que desees.

    Ten en cuenta que, cuando se usa este valor, la respuesta de la API siempre contiene un nextPageToken.
maxResults unsigned integer
El parámetro maxResults especifica la cantidad máxima de elementos que se deben mostrar en el conjunto de resultados. Los valores aceptables son 0 a 1000, inclusive. El valor predeterminado es 5.
pageToken string
El parámetro pageToken identifica una página específica del conjunto de resultados que se debe mostrar. El token es específico del mode que se usa con la solicitud a la API original, por lo que no puedes usar un token de página recuperado con un modo para cambiar posteriormente a un modo diferente.
hasAccessToLevel string
El valor del parámetro hasAccessToLevel es un ID de nivel que especifica el nivel mínimo que deben tener los miembros en el conjunto de resultados.
filterByMemberChannelId string
El parámetro filterByMemberChannelId especifica una lista separada por comas de IDs de canales que se pueden usar para verificar el estado de membresía de usuarios específicos. Por ejemplo, UC_1,UC_2,UC_3. Se puede especificar un máximo de 100 canales por llamada.

Cuerpo de la solicitud

No proporciones un cuerpo de solicitud cuando invoques este método.

Respuesta

Si se aplica correctamente, este método muestra un cuerpo de respuesta con la siguiente estructura:

{
  "kind": "youtube#memberListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    member Resource
  ]
}

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#memberListResponse.
etag etag
Es el Etag de este recurso.
nextPageToken string
Es el token que se puede usar como valor del parámetro pageToken para recuperar la siguiente página del conjunto de resultados. Los tokens de página pueden vencer, y tu aplicación debe descartar el token y llamar a la API sin un pageToken para iniciar una nueva solicitud.
pageInfo object
El objeto pageInfo encapsula la información de paginación del conjunto de resultados.
pageInfo.totalResults integer
Es la cantidad total de resultados en el conjunto de resultados.
pageInfo.resultsPerPage integer
Es la cantidad de resultados incluidos en la respuesta de la API.
items[] list
Es una lista de miembros que coinciden con los criterios de la solicitud.

Errores

En la siguiente tabla, se identifican los mensajes de error que la API podría mostrar en respuesta a una llamada a este método. Consulta la documentación sobre mensajes de error para obtener más información.

Tipo de error Detalle del error Descripción
badRequest (400) channelMembershipsNotEnabled El canal del creador que autoriza la solicitud no tiene habilitadas las membresías del canal.
badRequest (400) invalidMode El valor del parámetro mode no es válido. Este error puede ocurrir si el parámetro pageToken especifica un token que se recuperó con un modo diferente al especificado.
badRequest (400) invalidPageToken El valor del parámetro pageToken no es válido. Este error puede ocurrir si el token de página que se usa en la solicitud venció o no se reconoce.
badRequest (400) invalidHasAccessToLevel El valor del parámetro hasAccessToLevel no es válido. No hay ningún nivel con el especificado id.
badRequest (400) invalidFilterByMemberChannelId El valor del parámetro filterByMemberChannelId no es válido. Este error ocurre si el filterByMemberChannelId valor del parámetro especifica más de 100 canales.