Un risultato search contiene informazioni su un video di YouTube, un canale o una playlist che corrispondono 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 persistenti propri.
Metodi
L'API supporta i seguenti metodi di ricerca:
- list
- Restituisce una raccolta di risultati di ricerca che corrispondono ai parametri di query specificati nella richiesta API. Per impostazione predefinita, un insieme di risultati di ricerca identifica le risorse
video,channeleplaylistcorrispondenti, ma puoi anche configurare le query in modo da 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 |
stringIdentifica il tipo di risorsa API. Il valore sarà youtube#searchResult. |
etag |
etagL'ETag di questa risorsa. |
id |
objectL'oggetto id contiene informazioni che possono essere utilizzate per identificare in modo univoco la risorsa che corrisponde alla richiesta di ricerca. |
id.kind |
stringIl tipo di risorsa API. |
id.videoId |
stringSe il valore della proprietà id.type è youtube#video, questa proprietà sarà presente e il suo valore conterrà l'ID utilizzato da YouTube per identificare in modo univoco un video che corrisponde alla query di ricerca. |
id.channelId |
stringSe il valore della proprietà id.type è youtube#channel, questa proprietà sarà presente e il suo valore conterrà l'ID utilizzato da YouTube per identificare in modo univoco un canale che corrisponde alla query di ricerca. |
id.playlistId |
stringSe il valore della proprietà id.type è youtube#playlist, questa proprietà sarà presente e il suo valore conterrà l'ID utilizzato da YouTube per identificare in modo univoco una playlist che corrisponde alla query di ricerca. |
snippet |
objectL'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 |
datetimeLa data e l'ora di creazione della risorsa identificata dal risultato di ricerca. Il valore è specificato nel formato ISO 8601. |
snippet.channelId |
stringIl valore che YouTube utilizza per identificare in modo univoco il canale che ha pubblicato la risorsa identificata dal risultato di ricerca. |
snippet.title |
stringIl titolo del risultato di ricerca. |
snippet.description |
stringUna descrizione del risultato di ricerca. |
snippet.thumbnails |
objectUna mappa delle miniature associate al risultato di ricerca. Per ogni oggetto nella mappa, la chiave è il nome dell'immagine in miniatura e il valore è un oggetto che contiene altre informazioni sulla miniatura. |
snippet.thumbnails.(key) |
objectI valori chiave validi sono:
Nota:le miniature a 1080p+ ( |
snippet.thumbnails.(key).url |
stringL'URL dell'immagine. |
snippet.thumbnails.(key).width |
unsigned integerLa larghezza dell'immagine. |
snippet.thumbnails.(key).height |
unsigned integerL'altezza dell'immagine. |
snippet.channelTitle |
stringIl titolo del canale che ha pubblicato la risorsa identificata dal risultato di ricerca. |
snippet.liveBroadcastContent |
stringUn'indicazione che specifica se una risorsa video o channel contiene contenuti di trasmissioni live. I valori validi della proprietà sono upcoming, live e none.Per una risorsa video, un valore di upcoming indica che il video è una trasmissione live che non è ancora iniziata, mentre un valore di live indica che il video è una trasmissione live attiva. Per una risorsa channel, un valore pari a upcoming indica che il canale ha una trasmissione programmata che non è ancora iniziata, mentre un valore pari a live indica che il canale ha una trasmissione live attiva. |