Subscriptions: list

Muestra los recursos de suscripción que coinciden con los criterios de solicitud de la API.

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

Casos de uso habituales

Solicitud

Solicitud HTTP

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

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 una lista separada por comas de una o más propiedades de recursos de subscription que la respuesta de la API va a incluir.

Si el parámetro identifica una propiedad que contiene propiedades secundarias, las propiedades secundarias se incluirán en la respuesta. Por ejemplo, en un recurso subscription, la propiedad snippet contiene otras propiedades, como un título visible para la suscripción. Si configuras part=snippet, la respuesta de la API también contendrá todas esas propiedades anidadas.

La siguiente lista contiene los nombres de part que puedes incluir en el valor del parámetro:
  • contentDetails
  • id
  • snippet
  • subscriberSnippet
Filtros (especifica exactamente uno de los siguientes parámetros)
channelId string
El parámetro channelId especifica un ID de canal de YouTube. La API solo mostrará las suscripciones de ese canal.
id string
El parámetro id especifica una lista separada por comas de ID de suscripciones de YouTube para los recursos que se están recuperando. En un recurso subscription, la propiedad id especifica el ID de suscripción de YouTube.
mine boolean
Este parámetro solo se puede utilizar en una solicitud autorizada debidamente. Establece el valor de este parámetro en true para recuperar un feed de suscripciones del usuario autenticado.
myRecentSubscribers boolean
Este parámetro solo se puede utilizar en una solicitud autorizada debidamente. Establece el valor de este parámetro en true para recuperar un feed de los suscriptores del usuario autenticado en orden cronológico inverso (más recientes primero).

Ten en cuenta que la cantidad máxima de suscriptores que se muestran a través de esta API podría ser limitada.
mySubscribers boolean
Este parámetro solo se puede utilizar en una solicitud autorizada debidamente. Establece el valor de este parámetro en true para recuperar un feed de los suscriptores del usuario autenticado sin un orden en particular. Ten en cuenta que la cantidad máxima de suscriptores que se muestran a través de esta API puede ser limitada.
Parámetros opcionales
forChannelId string
El parámetro forChannelId especifica una lista separada por comas de ID de canales. La respuesta de la API contendrá solo suscripciones que coincidan con esos canales.
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.
onBehalfOfContentOwner string
Nota: Este parámetro está dirigido exclusivamente a socios de contenido de YouTube.

El parámetro onBehalfOfContentOwner indica que las credenciales de autorización de la solicitud identifican a un usuario del CMS de YouTube que actúa en nombre del propietario del contenido especificado en el valor del parámetro. Este parámetro está dirigido a socios de contenido de YouTube que poseen y administran varios canales de YouTube diferentes. Permite a los propietarios del contenido autenticarse una vez y tener acceso a todos los datos de sus videos y canales, sin tener que proporcionar credenciales de autenticación para cada canal. La cuenta de CMS con la que se autentica el usuario debe estar relacionada con el propietario del contenido de YouTube especificado.
onBehalfOfContentOwnerChannel string
Este parámetro solo se puede utilizar en una solicitud autorizada debidamente. Nota: Este parámetro está dirigido exclusivamente a socios de contenido de YouTube.

El parámetro onBehalfOfContentOwnerChannel especifica el ID del canal de YouTube al que se agrega un video. Este parámetro es obligatorio cuando una solicitud especifica un valor para el parámetro onBehalfOfContentOwner y solo se puede usar junto con ese parámetro. Además, la solicitud se debe autorizar mediante una cuenta de CMS que esté vinculada al propietario del contenido que se especifica en el parámetro onBehalfOfContentOwner. Por último, el canal que especifica el valor del parámetro onBehalfOfContentOwnerChannel debe estar vinculado al propietario del contenido que especifica el parámetro onBehalfOfContentOwner.

Este parámetro está dirigido a socios de contenido de YouTube que poseen y administran muchos canales de YouTube diferentes. Permite a los propietarios de contenido autenticarse una vez y llevar a cabo acciones en nombre del canal especificado en el valor del parámetro, sin tener que proporcionar credenciales de autenticación para cada canal por separado.
order string
El parámetro order especifica el método que se usará para ordenar los recursos en la respuesta de la API. El valor predeterminado es SUBSCRIPTION_ORDER_RELEVANCE.

Los valores aceptables son los siguientes:
  • alphabetical: orden alfabético.
  • relevance: ordena por relevancia.
  • unread: Ordena por actividad.
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#subscriptionListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    subscription 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#subscriptionListResponse.
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.
prevPageToken string
Es el token que se puede usar como valor del parámetro pageToken para recuperar la página anterior en el conjunto de resultados.
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 suscripciones 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) accountClosed Las suscripciones no se pudieron recuperar porque la cuenta del suscriptor está cerrada.
forbidden (403) accountSuspended Las suscripciones no se pudieron recuperar porque la cuenta del suscriptor está suspendida.
forbidden (403) subscriptionForbidden El solicitante no está autorizado a acceder a las suscripciones solicitadas.
notFound (404) subscriberNotFound No se puede encontrar el suscriptor identificado con la solicitud.

Pruébela.

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