Un resultado de la búsqueda contiene información sobre un video, un canal o una lista de reproducción de YouTube que coincide con los parámetros de búsqueda especificados en una solicitud de la API. Si bien un resultado de la búsqueda apunta a un recurso único de identificación, como un video, no tiene sus propios datos persistentes.
Métodos
La API admite los siguientes métodos de búsqueda:
- list
- Muestra una colección de resultados de búsqueda que coinciden con los parámetros de consulta especificados en la solicitud a la API. De forma predeterminada, un conjunto de resultados de búsqueda identifica los recursos
video
,channel
yplaylist
que coinciden, pero también puedes configurar las consultas para que solo recuperen un tipo específico de recurso. Pruébelo ahora.
Representación de recursos
La siguiente estructura JSON muestra el formato de un resultado de búsqueda:
{ "kind": "youtube#searchResult", "etag": etag, "id": { "kind": string, "videoId": string, "channelId": string, "playlistId": string }, "snippet": { "publishedAt": datetime, "channelId": string, "title": string, "description": string, "thumbnails": { (key): { "url": string, "width": unsigned integer, "height": unsigned integer } }, "channelTitle": string, "liveBroadcastContent": string } }
Propiedades
La siguiente tabla define las propiedades que aparecen en el resultado de una búsqueda:
Propiedades | |
---|---|
kind |
string Identifica el tipo de recurso de API. El valor será youtube#searchResult . |
etag |
etag Es la Etag de este recurso. |
id |
object El objeto id contiene información que se puede usar para identificar de forma exclusiva el recurso que coincide con la solicitud de búsqueda. |
id.kind |
string El tipo de recurso de la API. |
id.videoId |
string Si el valor de la propiedad id.type es youtube#video , esta propiedad estará presente y su valor contendrá el ID que YouTube usa para identificar de forma exclusiva un video que coincide con la búsqueda. |
id.channelId |
string Si el valor de la propiedad id.type es youtube#channel , esta propiedad estará presente y su valor contendrá el ID que YouTube usa para identificar de forma exclusiva un canal que coincide con la búsqueda. |
id.playlistId |
string Si el valor de la propiedad id.type es youtube#playlist , esta propiedad estará presente y su valor contendrá el ID que YouTube usa para identificar de forma exclusiva una lista de reproducción que coincide con la búsqueda. |
snippet |
object El objeto snippet contiene detalles básicos sobre un resultado de búsqueda, como el título o la descripción. Por ejemplo, si el resultado de la búsqueda es un video, entonces el título será el título del video y la descripción será la descripción del video. |
snippet.publishedAt |
datetime La fecha y hora de creación del recurso que identifica el resultado de la búsqueda. El valor se especifica en el formato ISO 8601. |
snippet.channelId |
string Es el valor que usa YouTube para identificar de forma exclusiva el canal que publicó el recurso que identifica el resultado de la búsqueda. |
snippet.title |
string Es el título del resultado de la búsqueda. |
snippet.description |
string Una descripción del resultado de la búsqueda. |
snippet.thumbnails |
object Mapa de imágenes en miniatura asociadas con el resultado de la búsqueda. Para cada objeto en el mapa, la clave es el nombre de la imagen en miniatura, y el valor es un objeto que contiene información adicional sobre la viñeta. |
snippet.thumbnails.(key) |
object Estos son los valores clave válidos:
|
snippet.thumbnails.(key).url |
string Es la URL de la imagen. |
snippet.thumbnails.(key).width |
unsigned integer Ancho de la imagen |
snippet.thumbnails.(key).height |
unsigned integer Es la altura de la imagen. |
snippet.channelTitle |
string Título del canal que publicó el recurso que identifica el resultado de la búsqueda. |
snippet.liveBroadcastContent |
string Indica si un recurso video o channel tiene contenido de transmisión en vivo. Los valores de propiedad válidos son upcoming , live y none .Para un recurso video , el valor upcoming indica que el video es una transmisión en vivo que aún no comenzó, mientras que el valor live indica que es una transmisión en vivo activa. Para un recurso channel , un valor de upcoming indica que el canal tiene una transmisión programada que aún no comenzó, mientras que un valor de live indica que el canal tiene una transmisión en vivo activa. |