Um resultado da pesquisa contém informações sobre um vídeo, um canal ou uma playlist do YouTube que correspondem aos parâmetros 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 os próprios dados permanentes.
Métodos
A API suporta os seguintes métodos de pesquisa:
- list
- Retorna uma coleção de resultados da pesquisa que correspondem aos parâmetros de consulta especificados na solicitação de API. Por padrão, um conjunto de resultados da pesquisa identifica os recursos
video
,channel
eplaylist
correspondentes. No entanto, também é possível configurar consultas para recuperar apenas um tipo específico de recurso. Faça um teste.
Representação de recurso
A estrutura JSON a seguir mostra o formato de um resultado da 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 , ela estará presente, e o valor dela conterá o ID que o YouTube usa para identificar de forma exclusiva um vídeo que corresponda à consulta de pesquisa. |
id.channelId |
string Se o valor da propriedade id.type for youtube#channel , ela estará presente, e o valor dela conterá o ID que o YouTube usa para identificar de forma exclusiva um canal que corresponda à consulta de pesquisa. |
id.playlistId |
string Se o valor da propriedade id.type for youtube#playlist , ela estará presente, e o valor dela conterá o ID que o YouTube usa para identificar de forma exclusiva uma playlist que corresponda à consulta de pesquisa. |
snippet |
object O objeto snippet contém detalhes básicos sobre um resultado da pesquisa, como o título ou a 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. |
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 As chaves-valor válidas são:
|
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 Uma indicação 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 ativa. Para um recurso channel , um valor upcoming indica que o canal tem uma transmissão programada que ainda não começou, enquanto um valor live indica que o canal tem uma transmissão ao vivo ativa. |