Un risultato di ricerca contiene informazioni su un video, un canale o una playlist di YouTube che corrisponde ai parametri di ricerca specificati in una richiesta API. Anche se un risultato di ricerca rimanda a una risorsa identificabile in modo univoco, come un video, non dispone di dati permanenti propri.
Metodi
L'API supporta i seguenti metodi per la ricerca:
- list
- Restituisci una raccolta di risultati di ricerca che corrispondono ai parametri di ricerca specificati nella richiesta API. Per impostazione predefinita, un set di risultati di ricerca identifica le risorse
video
,channel
eplaylist
corrispondenti, ma puoi anche configurare le query per recuperare solo un tipo specifico di risorsa. Prova subito.
Rappresentazione delle risorse
La seguente struttura JSON mostra il formato di un risultato di ricerca:
{ "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 } }
Proprietà
La tabella seguente definisce le proprietà visualizzate in un risultato di ricerca:
Proprietà | |
---|---|
kind |
string Identifica il tipo di risorsa API. Il valore sarà youtube#searchResult . |
etag |
etag L'Etag di questa risorsa. |
id |
object L'oggetto id contiene informazioni che possono essere utilizzate per identificare in modo univoco la risorsa che corrisponde alla richiesta di ricerca. |
id.kind |
string Il tipo di risorsa API. |
id.videoId |
string Se il valore della proprietà id.type è youtube#video , questa proprietà sarà presente e il suo valore conterrà l'ID che YouTube utilizza per identificare in modo univoco un video che corrisponde alla query di ricerca. |
id.channelId |
string Se il valore della proprietà id.type è youtube#channel , questa sarà presente e il suo valore conterrà l'ID che YouTube utilizza per identificare in modo univoco un canale che corrisponde alla query di ricerca. |
id.playlistId |
string Se il valore della proprietà id.type è youtube#playlist , sarà presente questa proprietà e il suo valore conterrà l'ID che YouTube utilizza per identificare in modo univoco una playlist che corrisponde alla query di ricerca. |
snippet |
object L'oggetto snippet contiene i dettagli di base di un risultato di ricerca, come il titolo o la descrizione. Ad esempio, se il risultato di ricerca è un video, il titolo sarà il titolo del video e la descrizione sarà la descrizione del video. |
snippet.publishedAt |
datetime La data e l'ora di creazione della risorsa identificata dal risultato di ricerca. Il valore è specificato nel formato ISO 8601. |
snippet.channelId |
string Il valore utilizzato da YouTube per identificare in modo univoco il canale che ha pubblicato la risorsa identificata dal risultato di ricerca. |
snippet.title |
string Il titolo del risultato di ricerca. |
snippet.description |
string Una descrizione del risultato di ricerca. |
snippet.thumbnails |
object Una mappa di immagini in miniatura associate al risultato di ricerca. Per ogni oggetto nella mappa, la chiave corrisponde al nome dell'immagine in miniatura, mentre il valore corrisponde a un oggetto contenente altre informazioni sulla miniatura. |
snippet.thumbnails.(key) |
object Le coppie chiave-valore valide sono:
|
snippet.thumbnails.(key).url |
string L'URL dell'immagine. |
snippet.thumbnails.(key).width |
unsigned integer La larghezza dell'immagine. |
snippet.thumbnails.(key).height |
unsigned integer L'altezza dell'immagine. |
snippet.channelTitle |
string Il titolo del canale che ha pubblicato la risorsa identificata dal risultato di ricerca. |
snippet.liveBroadcastContent |
string Indica se una risorsa video o channel include contenuti trasmessi dal vivo. I valori validi della proprietà sono upcoming , live e none .Per una risorsa video , il valore upcoming indica che il video è una trasmissione dal vivo non ancora iniziata, mentre il valore live indica che è una trasmissione dal vivo attiva. Per una risorsa channel , il valore upcoming indica che il canale ha una trasmissione programmata non ancora iniziata, mentre il valore live indica che il canale ha una trasmissione dal vivo attiva. |