Enumera los miembros (antes llamados "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:
|
|
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 , ambos inclusive. El valor predeterminado es 5 . |
|
pageToken |
string El parámetro pageToken identifica una página específica en el 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 a otro modo posteriormente.
|
|
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 ID 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 API. El valor será youtube#memberListResponse . |
etag |
etag Es la Etag de este recurso. |
nextPageToken |
string Es el token que se puede usar como valor del parámetro pageToken para recuperar la página siguiente en el conjunto de resultados. Los tokens de página pueden caducar, y tu aplicación debe descartarlos 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 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 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 que se especificó. |
badRequest (400) |
invalidPageToken |
El valor del parámetro pageToken no es válido. Este error puede ocurrir si el token de página de la solicitud caducó o no se reconoce. |
badRequest (400) |
invalidHasAccessToLevel |
El valor del parámetro hasAccessToLevel no es válido. No existe un nivel con el id especificado. |
badRequest (400) |
invalidFilterByMemberChannelId |
El valor del parámetro filterByMemberChannelId no es válido. Este error se produce si el valor del parámetro filterByMemberChannelId especifica más de 100 canales. |