Una risorsa subscription
contiene informazioni su un'iscrizione degli utenti di YouTube. Le iscrizioni vengono avvisate quando un nuovo utente viene aggiunto a un canale o quando un altro utente intraprende una delle varie azioni su YouTube, ad esempio carica un video, valuta un video o commenta un video.
Metodi
L'API supporta i seguenti metodi per le risorse di subscriptions
:
- list
- Restituisce le risorse di abbonamento che soddisfano i criteri della richiesta API. Prova subito.
- inserire
- Aggiunge una sottoscrizione al canale dell'utente autenticato. Prova subito.
- elimina
- Elimina un abbonamento. Prova subito.
Rappresentazione delle risorse
La seguente struttura JSON mostra il formato di una risorsa subscriptions
:
{ "kind": "youtube#subscription", "etag": etag, "id": string, "snippet": { "publishedAt": datetime, "channelTitle": string, "title": string, "description": string, "resourceId": { "kind": string, "channelId": string, }, "channelId": string, "thumbnails": { (key): { "url": string, "width": unsigned integer, "height": unsigned integer } } }, "contentDetails": { "totalItemCount": unsigned integer, "newItemCount": unsigned integer, "activityType": string }, "subscriberSnippet": { "title": string, "description": string, "channelId": string, "thumbnails": { (key): { "url": string, "width": unsigned integer, "height": unsigned integer } } } }
Proprietà
La tabella seguente definisce le proprietà che vengono visualizzate in questa risorsa:
Proprietà | |
---|---|
kind |
string Identifica il tipo di risorsa API. Il valore sarà youtube#subscription . |
etag |
etag L'Etag di questa risorsa. |
id |
string L'ID utilizzato da YouTube per identificare in modo univoco l'abbonamento. |
snippet |
object L'oggetto snippet contiene dettagli di base sull'abbonamento, tra cui il titolo e il canale a cui l'utente ha sottoscritto l'abbonamento. |
snippet.publishedAt |
datetime La data e l'ora in cui è stata creata la sottoscrizione. Il valore è specificato nel formato ISO 8601. |
snippet.channelTitle |
string Il titolo del canale a cui appartiene l'iscrizione. |
snippet.title |
string Il titolo dell'abbonamento. |
snippet.description |
string I dettagli dell'abbonamento. |
snippet.resourceId |
object L'oggetto id contiene informazioni sul canale a cui l'utente è iscritto. |
snippet.resourceId.kind |
string Il tipo della risorsa API. |
snippet.resourceId.channelId |
string Il valore utilizzato da YouTube per identificare in modo univoco il canale a cui l'utente si è iscritto. |
snippet.channelId |
string L'ID utilizzato da YouTube per identificare in modo univoco il canale dell'abbonato. L'oggetto resource_id identifica il canale a cui l'utente si è iscritto. |
snippet.thumbnails |
object Una mappa di miniature associate all'abbonamento. 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) |
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. |
contentDetails |
object L'oggetto contentDetails contiene statistiche di base sulla sottoscrizione. |
contentDetails.totalItemCount |
unsigned integer Il numero approssimativo di elementi a cui rimanda l'abbonamento. |
contentDetails.newItemCount |
unsigned integer Il numero di nuovi elementi nell'abbonamento dall'ultima lettura dei relativi contenuti. |
contentDetails.activityType |
string Il tipo di attività per cui è attiva questa sottoscrizione (solo i caricamenti di tutti i contenuti). I valori validi per questa proprietà sono:
|
subscriberSnippet |
object L'oggetto subscriberSnippet contiene dettagli di base sull'abbonato. |
subscriberSnippet.title |
string Il titolo del canale dell'abbonato. |
subscriberSnippet.description |
string La descrizione del canale dell'abbonato. |
subscriberSnippet.channelId |
string L'ID assegnato da YouTube per identificare in modo univoco il canale dell'abbonato. |
subscriberSnippet.thumbnails |
object Immagini in miniatura del canale dell'abbonato. |
subscriberSnippet.thumbnails.(key) |
object Le coppie chiave-valore valide sono:
|
subscriberSnippet.thumbnails.(key).url |
string L'URL dell'immagine. |
subscriberSnippet.thumbnails.(key).width |
unsigned integer La larghezza dell'immagine. |
subscriberSnippet.thumbnails.(key).height |
unsigned integer L'altezza dell'immagine. |