Muestra una lista de recursos channelSection
que coinciden con los criterios de solicitud a la API.
Impacto de 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/channelSections
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 channelSection que la respuesta de la API incluirá.Si el parámetro identifica una propiedad que contiene propiedades secundarias, estas se incluirán en la respuesta. Por ejemplo, en un recurso channelSection , la propiedad snippet contiene otras propiedades, como un título para mostrar para la secció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:
|
|
Filtros (especifica exactamente uno de los siguientes parámetros) | ||
channelId |
string El parámetro channelId especifica un ID de canal de YouTube. Si una solicitud especifica un valor para este parámetro, la API solo mostrará las secciones del canal especificado. |
|
id |
string El parámetro id especifica una lista de IDs separados por comas que identifican de forma única los recursos channelSection que se están recuperando. En un recurso channelSection , la propiedad id especifica el ID de la sección. |
|
mine |
boolean Este parámetro solo se puede usar en una solicitud autorizada debidamente. Establece el valor de este parámetro en true para recuperar un feed de las secciones del canal asociadas con el canal de YouTube del usuario autenticado. |
|
Parámetros opcionales | ||
hl |
string Este parámetro dejó de estar disponible. El parámetro hl proporcionó compatibilidad para recuperar metadatos localizados de una sección de canal. Sin embargo, esta función ya no está disponible en YouTube Studio y en la app de YouTube. |
|
onBehalfOfContentOwner |
string Este parámetro solo se puede usar en una solicitud autorizada debidamente. 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 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. |
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#channelSectionListResponse", "etag": etag, "items": [ channelSection 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#channelSectionListResponse . |
etag |
etag La Etag de este recurso. |
items[] |
list Lista de ChannelSections 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) |
channelSectionForbidden |
El solicitante no tiene permiso para acceder a las secciones de los canales solicitados. |
invalidValue (400) |
idInvalid |
La solicitud especifica un ID de sección de canal no válido. |
invalidValue (400) |
invalidCriteria |
No se pudo completar la solicitud porque los criterios de filtro no son válidos. |
notFound (404) |
channelNotFound |
No se puede encontrar el canal asociado con la solicitud. |
notFound (404) |
channelSectionNotFound |
No se puede encontrar la sección del canal asociada con la solicitud. |
Pruébalo
Usa APIs Explorer para llamar a esta API y ver la solicitud y la respuesta a la API.