Un recurso channel
contiene información sobre un canal de YouTube.
Métodos
La API admite los siguientes métodos para los recursos de channels
:
- list
- Muestra una colección de cero o más recursos
channel
que coinciden con los criterios de solicitud. Pruébalo ahora. - update
- Actualiza los metadatos de un canal. Ten en cuenta que este método actualmente solo es compatible con las actualizaciones de los objetos
brandingSettings
yinvideoPromotion
del recursochannel
y sus propiedades secundarias. Pruébalo ahora.
Representación de recursos
La estructura JSON a continuación muestra el formato de un recurso de channels
:
{ "kind": "youtube#channel", "etag": etag, "id": string, "snippet": { "title": string, "description": string, "publishedAt": datetime, "thumbnails": { (key): { "url": string, "width": unsigned integer, "height": unsigned integer } } }, "contentDetails": { "relatedPlaylists": { "likes": string, "favorites": string, "uploads": string, "watchHistory": string, "watchLater": string }, "googlePlusUserId": string }, "statistics": { "viewCount": unsigned long, "commentCount": unsigned long, "subscriberCount": unsigned long, "hiddenSubscriberCount": boolean, "videoCount": unsigned long }, "topicDetails": { "topicIds": [ string ] }, "status": { "privacyStatus": string, "isLinked": boolean }, "brandingSettings": { "channel": { "title": string, "description": string, "keywords": string, "defaultTab": string, "trackingAnalyticsAccountId": string, "moderateComments": boolean, "showRelatedChannels": boolean, "showBrowseView": boolean, "featuredChannelsTitle": string, "featuredChannelsUrls": [ string ], "unsubscribedTrailer": string, "profileColor": string }, "watch": { "textColor": string, "backgroundColor": string, "featuredPlaylistId": string }, "image": { "bannerImageUrl": string, "bannerMobileImageUrl": string, "backgroundImageUrl": { "default": string, "localized": [ { "value": string, "language": string } ] }, "largeBrandedBannerImageImapScript": { "default": string, "localized": [ { "value": string, "language": string } ] }, "largeBrandedBannerImageUrl": { "default": string, "localized": [ { "value": string, "language": string } ] }, "smallBrandedBannerImageImapScript": { "default": string, "localized": [ { "value": string, "language": string } ] }, "smallBrandedBannerImageUrl": { "default": string, "localized": [ { "value": string, "language": string } ] }, "watchIconImageUrl": string, "trackingImageUrl": string, "bannerTabletLowImageUrl": string, "bannerTabletImageUrl": string, "bannerTabletHdImageUrl": string, "bannerTabletExtraHdImageUrl": string, "bannerMobileLowImageUrl": string, "bannerMobileMediumHdImageUrl": string, "bannerMobileHdImageUrl": string, "bannerMobileExtraHdImageUrl": string, "bannerTvImageUrl": string, "bannerExternalUrl": string }, "hints": [ { "property": string, "value": string } ] }, "invideoPromotion": { "defaultTiming": { "type": string, "offsetMs": unsigned long, "durationMs": unsigned long }, "position": { "type": string, "cornerPosition": string }, "items": [ { "id": { "type": string, "videoId": string, "websiteUrl": string }, "timing": { "type": string, "offsetMs": unsigned long, "durationMs": unsigned long }, "customMessage": string } ] } }
Propiedades
La siguiente tabla define las propiedades que aparecen en este recurso:
Propiedades | |
---|---|
kind |
string Tipo de recurso de API. El valor será youtube#channel . |
etag |
etag Etag de este recurso. |
id |
string ID que YouTube utiliza para identificar de forma exclusiva el canal. |
snippet |
object El objeto snippet contiene información básica sobre el canal, como el título, la descripción y las imágenes en miniatura. |
snippet.title |
string Título del canal. |
snippet.description |
string Descripción del canal. |
snippet.publishedAt |
datetime Fecha y hora en que se creó el canal. El valor se especifica en el formato ISO 8601 ( YYYY-MM-DDThh:mm:ss.sZ ). |
snippet.thumbnails |
object Mapa de imágenes en miniatura asociadas con el canal. Para cada objeto en el mapa, la clave es el nombre de la imagen en miniatura, y el valor es un objeto que contiene otra información sobre la miniatura. |
snippet.thumbnails.(key) |
object Los valores de clave válidos son:
|
snippet.thumbnails.(key).url |
string URL de la imagen. |
snippet.thumbnails.(key).width |
unsigned integer Ancho de la imagen. |
snippet.thumbnails.(key).height |
unsigned integer Altura de la imagen. |
contentDetails |
object El objeto contentDetails contiene información sobre el contenido del canal. |
contentDetails.relatedPlaylists |
object El objeto relatedPlaylists es un mapa que identifica listas de reproducción asociadas al canal, tales como videos subidos o videos favoritos del canal. Para recuperar cualquiera de estas listas de reproducción, usa el método playlists.list . |
contentDetails.relatedPlaylists.likes |
string ID de la lista de reproducción que contiene videos del canal calificados con "Me gusta". Utiliza playlistItems.insert y playlistItems.delete para agregar o eliminar elementos de la lista. |
contentDetails.relatedPlaylists.favorites |
string ID de la lista de reproducción que contiene los videos favoritos del canal. Utiliza playlistItems.insert y playlistItems.delete para agregar o eliminar elementos de la lista. |
contentDetails.relatedPlaylists.uploads |
string ID de la lista de reproducción que contiene los videos subidos del canal. Usa el método videos.insert para subir videos nuevos y el método videos.delete para eliminar los videos subidos anteriormente. |
contentDetails.relatedPlaylists.watchHistory |
string ID del historial de reproducción del canal. Utiliza playlistItems.insert y playlistItems.delete para agregar o eliminar elementos de la lista. |
contentDetails.relatedPlaylists.watchLater |
string ID de la lista de reproducción "Ver más tarde" del canal. Utiliza playlistItems.insert y playlistItems.delete para agregar o eliminar elementos de la lista. |
contentDetails.googlePlusUserId |
string El objeto googlePlusUserId identifica el ID de perfil de Google+ asociado a este canal. |
statistics |
object El objeto statistics contiene estadísticas del canal. |
statistics.viewCount |
unsigned long Número de veces que se ha visto el canal. |
statistics.commentCount |
unsigned long Número de comentarios del canal. |
statistics.subscriberCount |
unsigned long Número de suscriptores que el canal tiene. |
statistics.videoCount |
unsigned long Número de videos subidos al canal. |
topicDetails |
object El objeto topicDetails contiene información sobre temas de Freebase relacionados con el canal. |
topicDetails.topicIds[] |
list Lista de ID de temas de Freebase que están asociados con el canal. Para obtener información sobre cada tema, usa la API de temas de Freebase. |
status |
object El objeto status contiene información sobre el estado de privacidad del canal. |
status.privacyStatus |
string Estado de privacidad del canal. Los valores válidos para esta propiedad son:
|
status.isLinked |
boolean Indica si los datos del canal identifican a un usuario que ya está vinculado a un nombre de usuario de YouTube o una cuenta de Google+. Un usuario que tenga uno de estos vínculos ya cuenta con una identidad pública de YouTube, que es un requisito para varias acciones, como subir videos. |
brandingSettings |
object El objeto brandingSettings contiene información sobre la marca del canal. |
brandingSettings.channel |
object El objeto channel contiene las propiedades de marca de la página de canales. |
brandingSettings.channel.title |
string Título del canal. El título tiene una longitud máxima de 30 caracteres. |
brandingSettings.channel.description |
string Descripción del canal, que aparece en el cuadro de información del canal en tu canal de usuario. |
brandingSettings.channel.keywords |
string Palabras clave relacionadas con tu canal. El valor es una lista separada por comas de unidades. |
brandingSettings.channel.defaultTab |
string Pestaña de contenido que los usuarios deben mostrar de manera predeterminada, cuando los espectadores llegan a tu canal de usuario. |
brandingSettings.channel.trackingAnalyticsAccountId |
string ID de una cuenta de Google Analytics que quieres utilizar para realizar un seguimiento y medir el tráfico a tu canal. |
brandingSettings.channel.moderateComments |
boolean Este ajuste determina si los comentarios que los usuarios dejan en el canal de usuario deben ser aprobados por el propietario del canal para que sean visibles al público. El valor predeterminado es false . |
brandingSettings.channel.showRelatedChannels |
boolean Este ajuste indica si YouTube debe mostrar una lista generada con algoritmos de canales relacionados en tu canal de usuario. |
brandingSettings.channel.showBrowseView |
boolean Este ajuste indica si el canal de usuario debe mostrar contenido en una vista de exploración o de feed. Por ejemplo, la vista de exploración puede mostrar secciones separadas para los videos subidos, las listas de reproducción y los videos calificados con "Me gusta". La vista de feed, por otra parte, muestra el feed de actividad del canal. |
brandingSettings.channel.featuredChannelsTitle |
string Título que se muestra arriba del módulo de canales destacados. |
brandingSettings.channel.featuredChannelsUrls[] |
list Lista de hasta 16 canales del módulo de canales destacados con los que deseas vincularte. El valor de la propiedad es una lista de valores de ID de canales de YouTube, cada uno de los cuales identifica exclusivamente un canal. |
brandingSettings.channel.unsubscribedTrailer |
string Video que se debe reproducir en el módulo de videos destacados en la vista de exploración del canal de usuario para espectadores no suscritos. Es posible que los espectadores suscritos observen una vista diferente, que destaca la actividad más reciente de los canales. |
brandingSettings.channel.profileColor |
string Color destacado que complementa el contenido del canal. |
brandingSettings.watch |
object El objeto watch contiene las propiedades de marca de las páginas de reproducción de los videos del canal. |
brandingSettings.watch.textColor |
string Color de fondo del área de marca de la página de reproducción de video. |
brandingSettings.watch.backgroundColor |
string Color del texto del área de marca de la página de reproducción de video. |
brandingSettings.watch.featuredPlaylistId |
string ID que identifica exclusivamente una lista de reproducción que aparece junto al reproductor de video en la página de reproducción de video. |
brandingSettings.image |
object El objeto image contiene información sobre las imágenes que se muestran en el canal de usuario del canal o en las páginas de reproducción de video. |
brandingSettings.image.bannerImageUrl |
string URL de la imagen del banner que se muestra en el canal de usuario en el sitio web YouTube. La imagen es de 1060 píxeles por 175 píxeles. |
brandingSettings.image.bannerMobileImageUrl |
string URL de la imagen del banner que se muestra en el canal de usuario en aplicaciones móviles. La imagen es de 640 píxeles por 175 píxeles. |
brandingSettings.image.backgroundImageUrl |
object El objeto backgroundImageUrl contiene la configuración de la imagen de fondo que se muestra en la página de reproducción de video. La imagen es de 1200 píxeles por 615 píxeles, con un tamaño de archivo máximo de 128k. |
brandingSettings.image.backgroundImageUrl.default |
string Valor predeterminado de la propiedad. |
brandingSettings.image.backgroundImageUrl.localized[] |
list Lista de objetos que indican valores específicos del idioma para la propiedad. |
brandingSettings.image.backgroundImageUrl.localized[].value |
string Valor de la propiedad para un idioma específico. |
brandingSettings.image.backgroundImageUrl.localized[].language |
string Idioma asociado con el valor. |
brandingSettings.image.largeBrandedBannerImageImapScript |
object El objeto largeBrandedBannerImageImapScript contiene información sobre la secuencia de comandos del mapa de imágenes para la imagen del banner que se muestra en el canal de usuario. |
brandingSettings.image.largeBrandedBannerImageImapScript.default |
string Valor predeterminado de la propiedad. |
brandingSettings.image.largeBrandedBannerImageImapScript.localized[] |
list Lista de objetos que indican valores específicos del idioma para la propiedad. |
brandingSettings.image.largeBrandedBannerImageImapScript.localized[].value |
string Valor de la propiedad para un idioma específico. |
brandingSettings.image.largeBrandedBannerImageImapScript.localized[].language |
string Idioma asociado con el valor. |
brandingSettings.image.largeBrandedBannerImageUrl |
object URL de la imagen de 854 píxeles por 70 píxeles que aparece debajo del reproductor de video en la vista de video ampliada de la página de reproducción de video. |
brandingSettings.image.largeBrandedBannerImageUrl.default |
string Valor predeterminado de la propiedad. |
brandingSettings.image.largeBrandedBannerImageUrl.localized[] |
list Lista de objetos que indican valores específicos del idioma para la propiedad. |
brandingSettings.image.largeBrandedBannerImageUrl.localized[].value |
string Valor de la propiedad para un idioma específico. |
brandingSettings.image.largeBrandedBannerImageUrl.localized[].language |
string Idioma asociado con el valor. |
brandingSettings.image.smallBrandedBannerImageImapScript |
object Secuencia de comandos del mapa de imágenes para la imagen de banner pequeña. El objeto largeBrandedBannerImageImapScript contiene información sobre la secuencia de comandos del mapa de imágenes para la imagen del banner que se muestra en el canal de usuario en aplicaciones móviles. |
brandingSettings.image.smallBrandedBannerImageImapScript.default |
string Valor predeterminado de la propiedad. |
brandingSettings.image.smallBrandedBannerImageImapScript.localized[] |
list Lista de objetos que indican valores específicos del idioma para la propiedad. |
brandingSettings.image.smallBrandedBannerImageImapScript.localized[].value |
string Valor de la propiedad para un idioma específico. |
brandingSettings.image.smallBrandedBannerImageImapScript.localized[].language |
string Idioma asociado con el valor. |
brandingSettings.image.smallBrandedBannerImageUrl |
object URL de la imagen de banner de 640 píxeles por 70 píxeles que aparece debajo del reproductor de video en la vista predeterminada de la página de reproducción de video. |
brandingSettings.image.smallBrandedBannerImageUrl.default |
string Valor predeterminado de la propiedad. |
brandingSettings.image.smallBrandedBannerImageUrl.localized[] |
list Lista de objetos que indican valores específicos del idioma para la propiedad. |
brandingSettings.image.smallBrandedBannerImageUrl.localized[].value |
string Valor de la propiedad para un idioma específico. |
brandingSettings.image.smallBrandedBannerImageUrl.localized[].language |
string Idioma asociado con el valor. |
brandingSettings.image.watchIconImageUrl |
string URL de la imagen que aparece sobre el reproductor de video. Esta es una imagen de 25 píxeles de altura con un ancho flexible que no puede exceder los 170 píxeles. Si no proporcionas esta imagen, aparecerá el nombre del canal en lugar de una imagen. |
brandingSettings.image.trackingImageUrl |
string URL de un píxel de seguimiento de 1 píxel por 1 píxel que se puede utilizar para recopilar estadísticas de reproducciones del canal o las páginas de videos. |
brandingSettings.image.bannerTabletLowImageUrl |
string URL de una imagen de banner de baja resolución que aparece en el canal de usuario en aplicaciones de tabletas. La imagen es de 1138 píxeles por 188 píxeles. |
brandingSettings.image.bannerTabletImageUrl |
string URL de una imagen de banner que aparece en el canal de usuario en aplicaciones de tabletas. La imagen es de 1707 píxeles por 283 píxeles. |
brandingSettings.image.bannerTabletHdImageUrl |
string URL de una imagen de banner de alta resolución que aparece en el canal de usuario en aplicaciones de tabletas. La imagen es de 2276 píxeles por 377 píxeles. |
brandingSettings.image.bannerTabletExtraHdImageUrl |
string URL de una imagen de banner de resolución extremadamente alta que aparece en el canal de usuario en aplicaciones de tabletas. La imagen es de 2560 píxeles por 424 píxeles. |
brandingSettings.image.bannerMobileLowImageUrl |
string URL de una imagen de banner de baja resolución que aparece en el canal de usuario en aplicaciones móviles. La imagen es de 320 píxeles por 88 píxeles. |
brandingSettings.image.bannerMobileMediumHdImageUrl |
string URL de una imagen de banner de resolución media que aparece en el canal de usuario en aplicaciones móviles. La imagen es de 960 píxeles por 263 píxeles. |
brandingSettings.image.bannerMobileHdImageUrl |
string URL de una imagen de banner de alta resolución que aparece en el canal de usuario en aplicaciones móviles. La imagen es de 1280 píxeles por 360 píxeles. |
brandingSettings.image.bannerMobileExtraHdImageUrl |
string URL de una imagen de banner de muy alta resolución que aparece en el canal de usuario en aplicaciones móviles. La imagen es de 1440 píxeles por 395 píxeles. |
brandingSettings.image.bannerTvImageUrl |
string URL de una imagen de banner que aparece en el canal de usuario en aplicaciones de televisión. La imagen es de 2120 píxeles por 1192 píxeles. |
brandingSettings.image.bannerExternalUrl |
string Nota: Esta propiedad solo se utiliza en solicitudes de channels.update .Esta propiedad especifica la ubicación de la imagen del banner que YouTube va a utilizar para generar los diferentes tamaños de banners para un canal. Para obtener la URL externa de la imagen del banner de URL, primero se debe cargar la imagen del banner del canal que se desea utilizar, invocando el método channelBanners.insert . |
brandingSettings.hints[] |
list El objeto hints contiene propiedades de marca adicionales. |
brandingSettings.hints[].property |
string Una propiedad. |
brandingSettings.hints[].value |
string El valor de la propiedad. |
invideoPromotion |
object El objeto invideoPromotion contiene información sobre una campaña promocional relacionada con el canal. Un canal puede utilizar una campaña promocional en video para mostrar la imagen en miniatura de un video promocionado en el reproductor de video durante la reproducción de videos del canal. |
invideoPromotion.defaultTiming |
object El objeto defaultTiming identifica la configuración de sincronización predeterminada del canal para cuando un elemento promocionado se vaya a mostrar durante la reproducción de un video. Esta configuración predeterminada se puede anular con una configuración de timing más específica de cualquier elemento promocionado. |
invideoPromotion.defaultTiming.type |
string Método de sincronización que determina cuándo se debe insertar el elemento promocionado durante la reproducción de video. Si el valor es offsetFromStart , entonces el campo offsetMs representa un desfase con respecto al inicio del video. Si el valor es offsetFromEnd , entonces el campo offsetMs representa un desfase con respecto al final del video. |
invideoPromotion.defaultTiming.offsetMs |
unsigned long Desfase de tiempo, especificado en milisegundos, que determina cuándo aparece el elemento promocionado durante las reproducciones de video. El valor de la propiedad type determina si el desfase se mide desde el principio o el final del video. |
invideoPromotion.defaultTiming.durationMs |
unsigned long Define el tiempo en milisegundos durante el que se debe mostrar la promoción. Si falta, el cliente debe utilizar el valor predeterminado. |
invideoPromotion.position |
object El objeto position contiene información sobre la posición espacial en el video donde se va a mostrar el elemento promocionado. |
invideoPromotion.position.type |
string Modo en que el elemento promocionado se ubica en el reproductor de video. Los valores válidos para esta propiedad son:
|
invideoPromotion.position.cornerPosition |
string Esquina del reproductor donde aparecerá el elemento promocionado. Los valores válidos para esta propiedad son:
|
invideoPromotion.items[] |
list Lista de elementos promocionados en el orden en que aparecerán en diferentes reproducciones para el mismo espectador. |
invideoPromotion.items[].id |
object Identifica el elemento promocionado. |
invideoPromotion.items[].id.type |
string Tipo de elemento promocionado. Los valores válidos para esta propiedad son:
|
invideoPromotion.items[].id.videoId |
string Si el elemento promocionado representa un video, este valor está presente e identifica el ID de YouTube que YouTube asigna para identificar dicho video. Este campo solo está presente si el valor de la propiedad type es video . |
invideoPromotion.items[].id.websiteUrl |
string Si el elemento promocionado representa un sitio web, este campo representa la URL que dirige al sitio web. Este campo estará presente solo si type tiene el valor website .Los vínculos pueden ser sitios web relacionados, sitios comerciales o sitios de redes sociales. Consulta las instrucciones del Centro de ayuda de YouTube para los sitios web asociados y sitios comerciales, para obtener más información sobre cómo habilitar vínculos para tu contenido. Al agregar vínculos promocionales, aceptas que dichos vínculos no se usarán para redirigir el tráfico a sitios no autorizados y que esos vínculos cumplen con las políticas de AdWords, las políticas de anuncios de YouTube, los Lineamientos de la comunidad de YouTube y las Condiciones del servicio de YouTube. |
invideoPromotion.items[].timing |
object Tiempo durante la reproducción de un video cuando se mostrará el elemento promocionado. Esta configuración de sincronización anula la configuración de sincronización predeterminada. |
invideoPromotion.items[].timing.type |
string Método de sincronización que determina cuándo se inserta el elemento promocionado durante la reproducción de video. Si el valor es offsetFromStart , entonces el campo offsetMs representa un desfase con respecto al inicio del video. Si el valor es offsetFromEnd , entonces el campo offsetMs representa un desfase con respecto al final del video. |
invideoPromotion.items[].timing.offsetMs |
unsigned long Desfase de tiempo, especificado en milisegundos, que determina cuándo aparece el elemento promocionado durante las reproducciones de video. El valor de la propiedad type determina si el desfase se mide desde el principio o el final del video. |
invideoPromotion.items[].timing.durationMs |
unsigned long Define el tiempo en milisegundos durante el que se debe mostrar la promoción. Si falta, el cliente debe utilizar el valor predeterminado. |
invideoPromotion.items[].customMessage |
string Mensaje personalizado que se muestra en esta promoción. Este campo se ignora actualmente, a menos que el elemento promocionado sea un sitio web. |