Channels: list

Nota: Se actualizó el valor de la propiedad statistics.subscriberCount del recurso channel para reflejar un cambio en la política de YouTube que afecta la forma en que se muestran los recuentos de suscriptores. Para obtener más información, consulta el Historial de revisiones o el Centro de ayuda de YouTube.

Devuelve una colección de cero o más recursos channel que coinciden con los criterios de la solicitud.

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/channels

Autorización

Una solicitud que recupera la parte auditDetails de un recurso channel debe proporcionar un token de autorización que contenga el alcance https://www.googleapis.com/auth/youtubepartner-channel-audit. Además, cualquier token que use ese alcance debe revocarse cuando la MCN decida aceptar o rechazar el canal, o dentro de las dos semanas posteriores a la fecha en que se emitió el token.

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 channel que incluirá la respuesta de la API.

Si el parámetro identifica una propiedad que contiene propiedades secundarias, estas se incluirán en la respuesta. Por ejemplo, en un recurso channel, la propiedad contentDetails contiene otras propiedades, como las propiedades uploads. Por lo tanto, si configuras part=contentDetails, 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:
  • auditDetails
  • brandingSettings
  • contentDetails
  • contentOwnerDetails
  • id
  • localizations
  • snippet
  • statistics
  • status
  • topicDetails
Filtros (especifica exactamente uno de los siguientes parámetros)
categoryId string
Este parámetro dejó de estar disponible. El parámetro categoryId especificaba una categoría de la Guía de YouTube y se podía usar para solicitar canales de YouTube asociados con esa categoría.
forHandle string
El parámetro forHandle especifica un identificador de YouTube y, por lo tanto, solicita el canal asociado con ese identificador. El valor del parámetro se puede anteponer con un símbolo @. Por ejemplo, para recuperar el recurso del canal "Google for Developers", establece el valor del parámetro forHandle en GoogleDevelopers o @GoogleDevelopers.
forUsername string
El parámetro forUsername especifica un nombre de usuario de YouTube y, de esta manera, solicita el canal asociado con ese nombre de usuario.
id string
El parámetro id especifica una lista separada por comas de los IDs de canales de YouTube de los recursos que se recuperan. En un recurso channel, la propiedad id especifica el ID del canal de YouTube.
managedByMe boolean
Este parámetro solo se puede usar en una solicitud autorizada.

Nota: Este parámetro está destinado exclusivamente a los socios de contenido de YouTube.

Establece el valor de este parámetro en true para indicarle a la API que solo muestre los canales que administra el propietario del contenido que especifica el parámetro onBehalfOfContentOwner. El usuario debe autenticarse como una cuenta de CMS vinculada al propietario del contenido especificado y se debe proporcionar onBehalfOfContentOwner.
mine boolean
Este parámetro solo se puede usar en una solicitud autorizada correctamente. Establece el valor de este parámetro en true para indicarle a la API que solo muestre los canales que pertenecen al usuario autenticado.
Parámetros opcionales
hl string
El parámetro hl le indica a la API que recupere los metadatos de recursos localizados para un idioma de la aplicación específico que admita el sitio web de YouTube. El valor del parámetro debe ser un código de idioma incluido en la lista que muestra el método i18nLanguages.list.

Si los detalles del recurso localizado están disponibles en ese idioma, el objeto snippet.localized del recurso contendrá los valores localizados. Sin embargo, si no hay detalles localizados disponibles, el objeto snippet.localized contendrá los detalles del recurso en su idioma predeterminado.
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 de 0 a 50 inclusive. El valor predeterminado es 5.
onBehalfOfContentOwner string
Este parámetro solo se puede usar en una solicitud autorizada correctamente.

Nota: Este parámetro está destinado exclusivamente a los 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 muchos 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.
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#channelListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    channel 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#channelListResponse.
etag etag
Es la etiqueta de Etag de este recurso.
nextPageToken string
Es el token que se puede usar como valor del parámetro pageToken para recuperar la siguiente página del conjunto de resultados.
prevPageToken string
Es el token que se puede usar como valor del parámetro pageToken para recuperar la página anterior del conjunto de resultados. Ten en cuenta que esta propiedad no se incluye en la respuesta de la API si la solicitud a la API correspondiente establece el parámetro managedByMe en true.
pageInfo object
El objeto pageInfo encapsula la información de paginación del conjunto de resultados.
pageInfo.totalResults integer
Es 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
Es una lista de canales que coinciden con los criterios de la solicitud.

Errores

En la siguiente tabla, se identifican los mensajes de error que podría mostrar la API en respuesta a una llamada a este método. Para obtener más detalles, consulta API de datos de YouTube: Errores.

Tipo de error Detalle del error Descripción
badRequest (400) invalidCriteria Se puede especificar un máximo de uno de los siguientes filtros:id, categoryId, mine, managedByMe, forHandle y forUsername. En el caso de la autenticación del propietario del contenido a través del parámetro onBehalfOfContentOwner, solo se puede especificar id o managedByMe.
forbidden (403) channelForbidden El canal especificado por el parámetro id no admite la solicitud o la solicitud no está autorizada correctamente.
notFound (404) categoryNotFound No se puede encontrar la categoría identificada por el parámetro categoryId. Usa el método guideCategories.list para recuperar una lista de valores válidos.
notFound (404) channelNotFound No se puede encontrar el canal especificado en el parámetro id.

Pruébalo

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