Search

Um resultado search contém informações sobre um vídeo, canal ou playlist do YouTube que corresponde aos parâmetros de pesquisa especificados em uma solicitação de API. Embora um resultado de pesquisa aponte para um recurso identificador exclusivo, como um vídeo, ele não tem dados persistentes.

Métodos

A API suporta os seguintes métodos de pesquisa:

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

Representação de recurso

A estrutura JSON a seguir 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,
    "liveBroadcastContent": string
  }
}

Propriedades

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

Propriedades
kind string
Identifica 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 exclusivamente 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 vai estar presente e o valor dela vai conter o ID que o YouTube usa para identificar um vídeo que corresponde à consulta de pesquisa.
id.channelId string
Se o valor da propriedade id.type for youtube#channel, essa propriedade vai estar presente e o valor dela vai conter o ID que o YouTube usa para identificar um canal que corresponde à consulta de pesquisa.
id.playlistId string
Se o valor da propriedade id.type for youtube#playlist, essa propriedade vai estar presente e o valor dela vai conter o ID que o YouTube usa para identificar de forma exclusiva uma playlist que corresponde à consulta de pesquisa.
snippet object
O objeto snippet contém detalhes básicos sobre um resultado da pesquisa, como título ou 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 de criação do recurso identificado pelo resultado da pesquisa. O valor é especificado no formato ISO 8601.
snippet.channelId string
O valor que o YouTube usa para identificar exclusivamente 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 de 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 da imagem em miniatura com resolução mais alta. 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 em alta resolução da imagem da 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.
  • standard: uma versão da miniatura com resolução ainda maior do que a imagem high. Essa imagem está disponível para alguns vídeos e outros recursos que se referem a vídeos, como itens de playlist ou resultados de pesquisa. Esta imagem tem 640 px de largura e 480 px de altura.
  • maxres: a versão de maior resolução da imagem em miniatura. Esse tamanho de imagem está disponível para alguns vídeos e outros recursos relacionados a vídeos, como itens de playlist ou resultados de pesquisa. Essa imagem tem 1.280 px de largura e 720 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.
snippet.liveBroadcastContent string
Indica se um recurso video ou channel tem conteúdo de transmissão ao vivo. Os valores de propriedade válidos são upcoming, live e none.

Para um recurso video, um valor de upcoming indica que o vídeo é uma transmissão ao vivo que ainda não começou, enquanto um valor de live indica que o vídeo é uma transmissão ao vivo ativa. Para um recurso channel, um valor de upcoming indica que o canal tem uma transmissão programada que ainda não começou, enquanto um valor de live indica que o canal tem uma transmissão ao vivo ativa.