Guia para criar uma pesquisa personalizada

Pode criar uma consulta de pesquisa completamente personalizada utilizando o campo de entrada de pesquisa personalizada e os parâmetros apresentados abaixo.

Como formatar uma pesquisa personalizada
Para cada parâmetro que adicionar, comece com um "&" e depois com a chave do parâmetro (ex: "ordem"), depois um sinal de igual "=" e depois um valor aceite (ex: "data"). Não adicione nenhuma codificação de URL, pois o plug-in codificará corretamente a consulta de pesquisa final.

Exemplos
&q=Funny Cat Videos&order=viewCount
&channelId=UClwg08ECyHnm_RzY1wnZC1A&publishedAfter=2019-06-30T00:00:00Z&publishedBefore=2020-01-30T00:00:00Z
&q=Gooseberry Falls&videoDuration=short

Parâmetro Chave Valores aceites
relatedToVideoId string
O relatedToVideoId recupera uma lista de vídeos que estão relacionados com o vídeo que o valor do parâmetro identifica. O valor do parâmetro deve ser definido como um ID de vídeo do YouTube.

Nota: Se o parâmetro relatedToVideoId for definido, os únicos outros parâmetros suportados são regionCode, relevanceLanguage, safeSearche fields.

channelId string
O channelId indica que a resposta da API só deve conter recursos criados pelo canal.
eventType string
O eventType restringe uma pesquisa a eventos de difusão.
Os valores aceitáveis são:

  • completed - Incluir apenas as emissões concluídas.
  • live - Incluir apenas as transmissões activas.
  • upcoming - Incluir apenas as próximas emissões.
location string
O location em conjunto com o parâmetro locationRadius define uma área geográfica circular e também restringe uma pesquisa a vídeos que especificam, nos seus metadados, uma localização geográfica que se insere nessa área. O valor do parâmetro é uma cadeia de caracteres que especifica as coordenadas de latitude/longitude, por exemplo, (37.42307,-122.08427).

  • O location O valor do parâmetro identifica o ponto no centro da área.
  • O locationRadius especifica a distância máxima que o local associado a um vídeo pode estar daquele ponto para que o vídeo ainda seja incluído nos resultados da pesquisa.

A API devolve um erro se o pedido especificar um valor para o parâmetro location mas não especifica também um valor para o parâmetro locationRadius parâmetro.

locationRadius string
O locationRadius em conjunto com o parâmetro location define uma área geográfica circular.

O valor do parâmetro deve ser um número de vírgula flutuante seguido de uma unidade de medida. As unidades de medida válidas são m, km, fte mi. Por exemplo, os valores de parâmetros válidos incluem 1500m, 5km, 10000fte 0.75mi. A API não suporta locationRadius valores de parâmetros superiores a 1000 quilómetros.

Nota: Ver a definição de location para mais informações.

order string
O order especifica o método que será utilizado para ordenar os recursos na resposta da API. O valor predefinido é relevance.

Os valores aceitáveis são:

  • date - Os recursos são ordenados por ordem cronológica inversa com base na data em que foram criados.
  • rating - Os recursos são ordenados da classificação mais elevada para a mais baixa.
  • relevance - Os recursos são ordenados com base na sua relevância para a consulta de pesquisa. Este é o valor predefinido para este parâmetro.
  • title - Os recursos estão ordenados alfabeticamente por título.
  • viewCount - Os recursos são ordenados do maior para o menor número de visualizações. Para transmissões em direto, os vídeos são ordenados pelo número de espectadores simultâneos enquanto as transmissões estão a decorrer.
publishedAfter datetime
O publishedAfter indica que a resposta da API só deve conter recursos criados no momento ou após o momento especificado. O valor é um valor de data e hora formatado em RFC 3339 (1970-01-01T00:00:00Z).
publishedBefore datetime
O publishedBefore indica que a resposta da API só deve conter recursos criados antes ou no momento especificado. O valor é um valor de data e hora formatado em RFC 3339 (1970-01-01T00:00:00Z).
q string
O q especifica o termo de consulta a pesquisar.

O seu pedido também pode utilizar a expressão booleana NOT (-) e OR (|) para excluir vídeos ou para encontrar vídeos que estejam associados a um de vários termos de pesquisa. Por exemplo, para procurar vídeos que correspondam a "barco" ou "vela", defina o operador q valor do parâmetro para boating|sailing. Da mesma forma, para procurar vídeos que correspondam a "boating" ou "sailing" mas não a "fishing", defina o parâmetro q valor do parâmetro para boating|sailing -fishing.

regionCode string
O regionCode instrui a API a devolver resultados de pesquisa para vídeos que podem ser visualizados no país especificado. O valor do parâmetro é um ISO 3166-1 alfa-2 código do país.
relevanceLanguage string
O relevanceLanguage dá instruções à API para devolver os resultados da pesquisa que são mais relevantes para a língua especificada. O valor do parâmetro é tipicamente um Código linguístico de duas letras ISO 639-1. No entanto, deve utilizar os valores zh-Hans para chinês simplificado e zh-Hant para chinês tradicional. Tenha em atenção que os resultados noutras línguas continuarão a ser apresentados se forem altamente relevantes para o termo de pesquisa.
safeSearch string
O safeSearch indica se os resultados da pesquisa devem incluir conteúdo restrito, bem como conteúdo padrão.

Os valores aceitáveis são:

  • moderate - O YouTube filtrará alguns conteúdos dos resultados de pesquisa e, no mínimo, filtrará os conteúdos que são restritos na sua localidade. Com base no seu conteúdo, os resultados da pesquisa podem ser removidos dos resultados da pesquisa ou despromovidos nos resultados da pesquisa. Este é o valor de parâmetro predefinido.
  • none - O YouTube não filtrará o conjunto de resultados da pesquisa.
  • strict - O YouTube tentará excluir todos os conteúdos restritos do conjunto de resultados da pesquisa. Com base no seu conteúdo, os resultados da pesquisa poderão ser removidos dos resultados da pesquisa ou despromovidos nos resultados da pesquisa.
topicId string
O topicId indica que a resposta da API deve conter apenas recursos associados ao tópico especificado. O valor identifica um ID de tópico do Freebase.

Importante: Devido à descontinuidade do Freebase e da API do Freebase, o topicId começou a funcionar de forma diferente a partir de 27 de fevereiro de 2017. Nessa altura, o YouTube começou a suportar um pequeno conjunto de IDs de tópicos com curadoria e só pode utilizar esse conjunto mais pequeno de IDs como valores para este parâmetro.

Tópicos
Tópicos de música
/m/04rlf Música (tópico principal)
/m/02mscn Música cristã
/m/0ggq0m Música clássica
/m/01lyv País
/m/02lkt Música eletrónica
/m/0glt670 Música hip-hop
/m/05rwpb Música independente
/m/03_d0 Jazz
/m/028sqc Música da Ásia
/m/0g293 Música da América Latina
/m/064t9 Música pop
/m/06cqb Reggae
/m/06j6l Ritmo e blues
/m/06by7 Música rock
/m/0gywn Música soul
Tópicos de jogos
/m/0bzvm2 Jogos (tópico principal)
/m/025zzc Jogo de ação
/m/02ntfj Jogo de ação e aventura
/m/0b1vjn Jogo casual
/m/02hygl Jogo de vídeo musical
/m/04q1x3q Jogo de vídeo puzzle
/m/01sjng Jogo de vídeo de corridas
/m/0403l3g Jogo de vídeo de interpretação de papéis
/m/021bp2 Jogo de vídeo de simulação
/m/022dc6 Jogo de desporto
/m/03hf_rm Jogo de vídeo de estratégia
Temas desportivos
/m/06ntj Desporto (tópico dos pais)
/m/0jm_ Futebol americano
/m/018jz Basebol
/m/018w8 Basquetebol
/m/01cgz Boxe
/m/09xp_ Críquete
/m/02vx4 Futebol
/m/037hz Golfe
/m/03tmr Hóquei no gelo
/m/01h7lh Artes marciais mistas
/m/0410tth Desporto motorizado
/m/07bs0 Ténis
/m/07_53 Voleibol
Tópicos de entretenimento
/m/02jjt Entretenimento (tópico principal)
/m/09kqc Humor
/m/02vxn Filmes
/m/05qjc Artes do espetáculo
/m/066wd Luta livre profissional
/m/0f2f9 Programas de televisão
Tópicos sobre o estilo de vida
/m/019_rr Estilo de vida (tópico principal)
/m/032tl Moda
/m/027x7n Fitness
/m/02wbm Alimentação
/m/03glg Passatempo
/m/068hy Animais de estimação
/m/041xxh Atratividade física [Beleza]
/m/07c1v Tecnologia
/m/07bxq Turismo
/m/07yv9 Veículos
Tópicos sobre a sociedade
/m/098wr Sociedade (tópico principal)
/m/09s1f Negócios
/m/0kt51 Saúde
/m/01h6rj Militar
/m/05qt0 Política
/m/06bvp Religião
Outros temas
/m/01k8wb Conhecimento

 

videoCaption string
O videoCaption indica se a API deve filtrar os resultados da pesquisa de vídeo com base no facto de terem ou não legendas.

Os valores aceitáveis são:

  • any - Não filtrar os resultados com base na disponibilidade da legenda.
  • closedCaption - Inclua apenas vídeos que tenham legendas.
  • none - Inclua apenas vídeos que não tenham legendas.
videoCategoryId string
O videoCategoryId filtra os resultados da pesquisa de vídeo com base nos seus categoria.
videoDefinition string
O videoDefinition permite-lhe restringir uma pesquisa para incluir apenas vídeos de alta definição (HD) ou de definição padrão (SD). Os vídeos HD estão disponíveis para reprodução em, pelo menos, 720p, embora resoluções mais elevadas, como 1080p, também possam estar disponíveis.

Os valores aceitáveis são:

  • any - Devolver todos os vídeos, independentemente da sua resolução.
  • high - Recuperar apenas vídeos HD.
  • standard - Recuperar apenas vídeos em definição padrão.
videoDimension string
O videoDimension permite-lhe restringir uma pesquisa para obter apenas vídeos 2D ou 3D.

Os valores aceitáveis são:

  • 2d - Restringir os resultados da pesquisa para excluir vídeos 3D.
  • 3d - Restringir os resultados da pesquisa para incluir apenas vídeos 3D.
  • any - Incluir vídeos 3D e não 3D nos resultados retornados. Este é o valor predefinido.
videoDuration string
O videoDuration filtra os resultados da pesquisa de vídeo com base na sua duração.

Os valores aceitáveis são:

  • any - Não filtrar os resultados da pesquisa de vídeo com base na sua duração. Este é o valor predefinido.
  • long - Inclua apenas vídeos com mais de 20 minutos.
  • medium - Incluir apenas vídeos com uma duração entre quatro e 20 minutos (inclusive).
  • short - Inclua apenas vídeos com menos de quatro minutos de duração.
videoEmbeddable string
O videoEmbeddable permite-lhe restringir uma pesquisa apenas a vídeos que podem ser incorporados numa página Web.

Os valores aceitáveis são:

  • any - Devolver todos os vídeos, incorporáveis ou não.
  • true - Recuperar apenas vídeos incorporáveis.
videoLicense string
O videoLicense filtra os resultados da pesquisa para incluir apenas vídeos com uma determinada licença. O YouTube permite que os carregadores de vídeos optem por anexar a licença Creative Commons ou a licença padrão do YouTube a cada um dos seus vídeos.

Os valores aceitáveis são:

  • any - Devolve todos os vídeos, independentemente da licença que tenham, que correspondam aos parâmetros de consulta.
  • creativeCommon - Apenas devolve vídeos que tenham uma licença Creative Commons. Os utilizadores podem reutilizar vídeos com esta licença noutros vídeos que criem. Saiba mais.
  • youtube - Devolver apenas vídeos que tenham a licença padrão do YouTube.
videoSyndicated string
O videoSyndicated permite-lhe restringir uma pesquisa apenas a vídeos que podem ser reproduzidos fora do youtube.com.

Os valores aceitáveis são:

  • any - Mostrar todos os vídeos, sindicalizados ou não.
  • true - Recuperar apenas vídeos sindicados.
videoType string
O videoType permite-lhe restringir uma pesquisa a um determinado tipo de vídeos.

Os valores aceitáveis são:

  • any - Regressar a todos os vídeos.
  • episode - Recuperar apenas episódios de programas.
  • movie - Apenas recupera filmes.