Subscriptions: list

Muestra los recursos de suscripción que coinciden con los criterios de solicitud de la API. Pruébalo ahora.

Solicitud

Solicitud HTTP

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

Parámetros

La tabla a continuación muestra los parámetros compatibles con 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 API va a incluir. Los nombres de `part` que se pueden incluir en el valor del parámetro son `id`, `snippet` y `contentDetails`. Si el parámetro identifica una propiedad que contiene propiedades secundarias, estas se incluirán en la respuesta. Por ejemplo, en un recurso `subscription`, la propiedad `snippet` contiene otras propiedades, tales como un título para mostrar para la suscripción. Si estableces `part=snippet`, la respuesta de la API también contendrá todas esas propiedades anidadas.
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 suscripción 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.
`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.
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 el número máximo 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 de CMS de YouTube que actúa en nombre del propietario de contenido especificado en el valor del parámetro. 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 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 agregó un video. Este parámetro es necesario cuando una solicitud especifica un valor para el parámetro `onBehalfOfContentOwner`, y solo se puede utilizar junto con ese parámetro. Además, la solicitud se debe autorizar mediante una cuenta de CMS que esté relacionada con el propietario del contenido que especifica el parámetro `onBehalfOfContentOwner`. Por último, el canal que especifica el valor del parámetro `onBehalfOfContentOwnerChannel` debe estar relacionado con el 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: `alphabetical`: Ordenar alfabéticamente `relevance`: Ordenar por relevancia `unread`: Ordenar por orden de 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` Tipo de recurso de la API. El valor será `youtube#subscriptionListResponse`.
`etag`	`etag` Etag de este recurso.
`nextPageToken`	`string` Token que se puede utilizar como valor del parámetro `pageToken` para recuperar la página siguiente en el conjunto de resultados.
`prevPageToken`	`string` Token que se puede utilizar como valor del parámetro `pageToken` para recuperar la página anterior en el conjunto de resultados.
`pageInfo`	`object` El objeto `pageInfo` contiene información de paginación para el conjunto de resultados de búsqueda.
`pageInfo.totalResults`	`integer` Número total de resultados en el conjunto de resultados.
`pageInfo.resultsPerPage`	`integer` Número de resultados incluidos en la respuesta de la API.
`items[]`	`list` Lista de suscripciones que coinciden con los criterios de la solicitud.

Errores

En la tabla a continuación se identifican los mensajes de error que la API podría mostrar en respuesta a una invocación 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`	`accountClosed`	Las suscripciones no se pudieron recuperar porque la cuenta del suscriptor está cerrada.
`forbidden`	`accountSuspended`	Las suscripciones no se pudieron recuperar porque la cuenta del suscriptor está suspendida.
`forbidden`	`subscriptionForbidden`	El solicitante no está autorizado a acceder a las suscripciones solicitadas.
`notFound`	`subscriberNotFound`	No se puede encontrar el suscriptor identificado con la solicitud.

¡Pruébalo!

Utiliza el Explorador de la API para invocar este método con datos en directo y ver la solicitud y la respuesta de la API.