Search

Un resultado search contiene información sobre un video, un canal o una playlist de YouTube que coincide con los parámetros de búsqueda especificados en una solicitud a la API. Si bien un resultado de la búsqueda apunta a un recurso que se puede identificar de forma única, como un video, no tiene sus propios datos persistentes.

Métodos

La API admite los siguientes métodos de búsqueda:

list
Devuelve una colección de resultados de la 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 la búsqueda identifica los recursos video, channel y playlist coincidentes, pero también puedes configurar consultas para que solo recuperen un tipo específico de recurso. Pruébalo ahora.

Representación de recursos

En la siguiente estructura JSON, se muestra el formato de un resultado de la 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 la API. El valor será youtube#searchResult.
etag etag
Es la etiqueta de 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
Es 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 coincida 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 coincida 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 única una playlist que coincida con la búsqueda.
snippet object
El objeto snippet contiene detalles básicos sobre un resultado de la 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
Es la fecha y hora de creación del recurso que identifica el resultado de la búsqueda. El valor se especifica en formato ISO 8601.
snippet.channelId string
Es el valor que YouTube usa 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
Es una descripción del resultado de la búsqueda.
snippet.thumbnails object
Es un 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 otra información sobre la viñeta.
snippet.thumbnails.(key) object
Los valores de clave válidos son los siguientes:
  • default: Es la imagen en miniatura predeterminada. La viñeta 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: Es una 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: Es una 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.
  • standard: Es una versión de la imagen en miniatura con una resolución aún más alta que la imagen de resolución high. Esta imagen está disponible para algunos videos y otros recursos que hacen referencia a videos, como elementos de playlists o resultados de la búsqueda. Esta imagen tiene 640 px de ancho y 480 px de alto.
  • maxres: Es la versión de resolución más alta de la imagen en miniatura. Este tamaño de imagen está disponible para algunos videos y otros recursos que hacen referencia a videos, como elementos de playlists o resultados de la búsqueda. Esta imagen tiene 1,280 px de ancho y 720 px de alto.
snippet.thumbnails.(key).url string
Es la URL de la imagen.
snippet.thumbnails.(key).width unsigned integer
Es el ancho de la imagen.
snippet.thumbnails.(key).height unsigned integer
Es la altura de la imagen.
snippet.channelTitle string
Es el 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 válidos de la propiedad son upcoming, live y none.

En el caso de un recurso video, un valor de upcoming indica que el video es una transmisión en vivo que aún no comenzó, mientras que un valor de live indica que el video es una transmisión en vivo activa. En el caso de 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.