Search

Un resultado de búsqueda contiene información acerca de 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 un conjunto de resultados de búsqueda que coinciden con los parámetros de consulta especificados en la solicitud de la API. Con la configuración predeterminada, un conjunto de resultados de búsqueda identifica los recursos coincidentes video, channel y playlist. Por otro lado, puedes configurar consultas para recuperar únicamente un tipo específico de recurso. Pruébalo ahora.

Representación de recursos

La estructura JSON a continuación 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
  }
}

Propiedades

La siguiente tabla define las propiedades que aparecen en el resultado de una búsqueda:

Propiedades
kind string
Tipo de recurso de la API. El valor será youtube#searchResult.
etag etag
Etag de este recurso.
id object
El objeto id contiene información que se puede usar para i­dentificar de forma exclusiva el recurso que coinci­de con la solicitud de búsqueda.
id.kind string
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 utiliza para identificar de forma exclusiva un video que coincide con la consulta de 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 utiliza para identificar de forma exclusiva un canal que coincide con la consulta de 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 utiliza para identificar de forma exclusiva una lista de reproducción que coincide con la consulta de búsqueda.
snippet object
El objeto snippet contiene información básica 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
Fecha y hora de creación del recurso que identifica el resultado de búsqueda. El valor se especifica en el formato ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).
snippet.channelId string
Valor que YouTube utiliza para identificar de forma exclusiva el canal que publicó el recurso que el resultado de búsqueda identifica.
snippet.title string
Título del resultado de búsqueda.
snippet.description string
Descripción del resultado de búsqueda.
snippet.thumbnails object
Mapa de imágenes en miniatura asociadas con el resultado de 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 otra información sobre la viñeta.
snippet.thumbnails.(key) object
Los valores de clave válidos son:
  • default: Imagen en miniatura predeterminada. La miniatura predeterminada de un video, o de un recurso que se refiere a un video, como un elemento de una lista de reproducción o el resultado de una búsqueda, es de 120 píxeles de ancho y 90 píxeles de alto. La viñeta predeterminada para un canal es de 88 píxeles de ancho y 88 píxeles de alto.
  • medium: Versión de mayor resolución de la imagen en miniatura. Para un video (o un recurso que hace referencia a un video), esta imagen es de 320 píxeles de ancho y 180 píxeles de alto. Para un canal, esta imagen es de 240 píxeles de ancho y 240 píxeles de alto.
  • high: Versión de alta resolución de la imagen en miniatura. Para un video (o un recurso que hace referencia a un video), esta imagen es de 480 píxeles de ancho y 360 píxeles de alto. Para un canal, esta imagen es de 800 píxeles de ancho y 800 píxeles de alto.
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.
snippet.channelTitle string
Título del canal que publicó el recurso que identifica el resultado de búsqueda.