Una risorsa subscription contiene informazioni sull'abbonamento di un utente di YouTube. Un'iscrizione avvisa un utente quando vengono aggiunti nuovi video a un canale o quando un altro utente esegue una delle diverse azioni su YouTube, ad esempio caricare un video, valutare un video o commentare un video.
Metodi
L'API supporta i seguenti metodi per le risorse subscriptions:
- list
- Restituisce le risorse di abbonamento che corrispondono ai criteri della richiesta API. Prova subito.
- insert
- Aggiunge un abbonamento 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à visualizzate in questa risorsa:
| Proprietà | |
|---|---|
kind |
stringIdentifica il tipo di risorsa API. Il valore sarà youtube#subscription. |
etag |
etagL'ETag di questa risorsa. |
id |
stringL'ID utilizzato da YouTube per identificare in modo univoco l'abbonamento. |
snippet |
objectL'oggetto snippet contiene i dettagli di base dell'abbonamento, tra cui il titolo e il canale a cui l'utente si è abbonato. |
snippet.publishedAt |
datetimeLa data e l'ora in cui è stato creato l'abbonamento. Il valore è specificato nel formato ISO 8601. |
snippet.title |
stringIl titolo dell'abbonamento. |
snippet.description |
stringI dettagli dell'abbonamento. |
snippet.resourceId |
objectL'oggetto id contiene informazioni sul canale a cui l'utente si è iscritto. |
snippet.resourceId.kind |
stringIl tipo di risorsa API. |
snippet.resourceId.channelId |
stringIl valore che YouTube utilizza per identificare in modo univoco il canale a cui l'utente si è iscritto. |
snippet.channelId |
stringL'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 |
objectUna mappa di immagini in miniatura 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) |
objectI valori chiave validi sono:
|
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. |
contentDetails |
objectL'oggetto contentDetails contiene statistiche di base sull'abbonamento. |
contentDetails.totalItemCount |
unsigned integerIl numero approssimativo di elementi a cui fa riferimento l'abbonamento. |
contentDetails.newItemCount |
unsigned integerIl numero di nuovi elementi nell'abbonamento dall'ultima lettura dei contenuti. |
contentDetails.activityType |
stringIl tipo di attività a cui si riferisce questo abbonamento (solo caricamenti, tutto). I valori validi per questa proprietà sono:
|
subscriberSnippet |
objectL'oggetto subscriberSnippet contiene i dettagli di base sull'abbonato. |
subscriberSnippet.title |
stringIl titolo del canale dell'abbonato. |
subscriberSnippet.description |
stringLa descrizione del canale dell'iscritto. |
subscriberSnippet.channelId |
stringL'ID che YouTube assegna per identificare in modo univoco il canale dell'iscritto. |
subscriberSnippet.thumbnails |
objectImmagini in miniatura del canale dell'iscritto. |
subscriberSnippet.thumbnails.(key) |
objectI valori chiave validi sono:
|
subscriberSnippet.thumbnails.(key).url |
stringL'URL dell'immagine. |
subscriberSnippet.thumbnails.(key).width |
unsigned integerLa larghezza dell'immagine. |
subscriberSnippet.thumbnails.(key).height |
unsigned integerL'altezza dell'immagine. |