Sponsors: list

Nota: Este método dejó de estar disponible el 31 de marzo de 2020. Se reemplazó por el método members.list. Puedes encontrar información sobre este método en la documentación de la API de datos de YouTube.

Se dejará de admitir el método sponsors.list 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.

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

Casos de uso habituales

Solicitud

Solicitud HTTP

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

Autorización

Esta solicitud requiere autorización con al menos uno de los siguientes alcances (obtén más información acerca de la autenticación y autorización).

Alcance
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl
https://www.googleapis.com/auth/youtube.readonly

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 partes de los recursos sponsor que incluirá la respuesta de la API. Los valores admitidos son id y snippet.
Parámetros opcionales
filter string
El parámetro filter especifica qué patrocinadores de canal deben regresar. El valor predeterminado es newest.

Los valores aceptables son los siguientes:
  • all: Muestra todos los patrocinadores, del más reciente al más antiguo.
  • newest: muestra una página de los patrocinadores más recientes. Las solicitudes posteriores que usan nextPageToken recuperan suscriptores más nuevos a medida que se registran.
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 50, 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. En una respuesta de la API, las propiedades nextPageToken y prevPageToken identifican otras páginas que se podrían recuperar.

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#sponsorListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    sponsor 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#sponsorListResponse.
etag etag
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.
pageInfo object
El objeto pageInfo contiene información de paginación para el conjunto de resultados.
pageInfo.totalResults integer
Es la cantidad total de resultados en el conjunto de resultados.
pageInfo.resultsPerPage integer
Cantidad de resultados incluidos en la respuesta de la API.
items[] list
Lista de patrocinadores 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
forbidden (403) insufficientPermissions No tienes los permisos necesarios para ver los patrocinadores del canal.
invalidValue (400) invalidValueInRequest La solicitud contiene un valor no válido.
invalidValue (400) sponsorshipNotEnabledForChannelId El canal no tiene habilitados los patrocinios.

Pruébalo

Usa APIs Explorer para llamar a esta API y ver la solicitud y la respuesta a la API.