Search

Um resultado de pesquisa contém informações sobre um vídeo, canal ou playlist do YouTube que correspondem a parâmetros de pesquisa especificados em uma solicitação de API. Embora um resultado de pesquisa aponte para um recurso exclusivamente identificável, como um vídeo, ele não tem seus próprios dados persistentes.

Métodos

A API suporta os seguintes métodos de pesquisa:

list
Retorna um conjunto de resultados de pesquisa que correspondem a parâmetros de consulta especificados na solicitação da API. Por padrão, um conjunto de resultados de pesquisa identifica recursos de video, channel e playlist correspondentes, mas você também pode configurar consultas para recuperar somente um tipo específico de recurso. Faça um teste agora.

Representação de recurso

A estrutura JSON abaixo mostra o formato de um resultado de pesquisa:

{
  "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
  }
}

Propriedades

A tabela a seguir define as propriedades que aparecem no resultado da pesquisa:

Propriedades
kind string
O tipo do recurso da API. O valor será youtube#searchResult.
etag etag
A Etag deste recurso.
id object
O objeto id contém informações que podem ser usadas para identificar de forma exclusiva o recurso que corresponde à solicitação de pesquisa.
id.kind string
O tipo do recurso da API.
id.videoId string
Se o valor da propriedade id.type for youtube#video, essa propriedade estará presente, e seu valor conterá o ID que o YouTube usa para identificar de forma exclusiva um vídeo que corresponde à pesquisa.
id.channelId string
Se o valor da propriedade id.type for youtube#channel, essa propriedade estará presente, e seu valor conterá o ID que o YouTube usa para identificar de forma exclusiva um canal que corresponda à pesquisa.
id.playlistId string
Se o valor da propriedade id.type for youtube#playlist, essa propriedade estará presente, e seu valor conterá o ID que o YouTube usa para identificar de forma exclusiva uma lista que corresponda à pesquisa.
snippet object
O objeto snippet contém detalhes básicos sobre um resultado de pesquisa, como seu título ou sua descrição. Por exemplo, se o resultado da pesquisa for um vídeo, o título será o título do vídeo e a descrição será a descrição do vídeo.
snippet.publishedAt datetime
A data e a hora da criação do recurso que o resultado da pesquisa identifica. O valor é especificado no formato ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).
snippet.channelId string
O valor que o YouTube usa para identificar de forma exclusiva o canal que publicou o recurso identificado pelo resultado da pesquisa.
snippet.title string
O título do resultado da pesquisa.
snippet.description string
Uma descrição do resultado da pesquisa.
snippet.thumbnails object
Um mapa de imagens em miniatura associadas ao resultado da pesquisa. Para cada objeto no mapa, a chave é o nome da imagem em miniatura, e o valor é um objeto que contém outras informações sobre a miniatura.
snippet.thumbnails.(key) object
Os valores de chave válidos são:
  • default – A imagem em miniatura padrão. A miniatura padrão para um vídeo ou um recurso que se refere a um vídeo, como um item da playlist ou o resultado da pesquisa, tem 120 px de largura e 90px de altura. A miniatura padrão de um canal tem 88 px de largura e 88 px de altura.
  • medium – Uma versão de resolução mais alta da imagem em miniatura. Para um vídeo (ou um recurso que se refira a um vídeo), esta imagem tem 320 px de largura e 180 px de altura. Para um canal, esta imagem tem 240 px de largura e 240 px de altura.
  • high – Uma versão de alta resolução da imagem em miniatura. Para um vídeo (ou um recurso que se refira a um vídeo), esta imagem tem 480 px de largura e 360 px de altura. Para um canal, esta imagem tem 800 px de largura e 800 px de altura.
snippet.thumbnails.(key).url string
O URL da imagem.
snippet.thumbnails.(key).width unsigned integer
A largura da imagem.
snippet.thumbnails.(key).height unsigned integer
A altura da imagem.
snippet.channelTitle string
O título do canal que publicou o recurso identificado pelo resultado da pesquisa.