Eine subscription-Ressource enthält Informationen zu einem YouTube-Nutzerabo. Ein Abo benachrichtigt einen Nutzer, wenn einem Kanal neue Videos hinzugefügt werden oder wenn ein anderer Nutzer eine von mehreren Aktionen auf YouTube ausführt, z. B. ein Video hochlädt, ein Video bewertet oder ein Video kommentiert.
Methoden
Die API unterstützt die folgenden Methoden für subscriptions-Ressourcen:
- list
- Gibt Aboressourcen zurück, die den Kriterien der API-Anfrage entsprechen. Hier kannst du die Funktion ausprobieren.
- insert
- Fügt dem Kanal des authentifizierten Nutzers ein Abo hinzu. Hier kannst du die Funktion ausprobieren.
- Delete
- Löscht ein Abo. Hier kannst du die Funktion ausprobieren.
Ressourcendarstellung
Die folgende JSON-Struktur zeigt das Format einer subscriptions-Ressource:
{
"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
}
}
}
}Attribute
In der folgenden Tabelle werden die Attribute definiert, die in dieser Ressource enthalten sind:
| Attribute | |
|---|---|
kind |
stringGibt den Typ der API-Ressource an. Der Wert ist youtube#subscription. |
etag |
etagDas ETag dieser Ressource. |
id |
stringDie ID, die YouTube zur eindeutigen Identifizierung des Abos verwendet. |
snippet |
objectDas snippet-Objekt enthält grundlegende Details zum Abo, einschließlich des Titels und des Kanals, den der Nutzer abonniert hat. |
snippet.publishedAt |
datetimeDatum und Uhrzeit der Erstellung des Abos. Der Wert wird im ISO 8601-Format angegeben. |
snippet.title |
stringDer Titel des Abos. |
snippet.description |
stringDetails zum Abo. |
snippet.resourceId |
objectDas id-Objekt enthält Informationen zum Kanal, den der Nutzer abonniert hat. |
snippet.resourceId.kind |
stringDer Typ der API-Ressource. |
snippet.resourceId.channelId |
stringDer Wert, den YouTube verwendet, um den Kanal, den der Nutzer abonniert hat, eindeutig zu identifizieren. |
snippet.channelId |
stringDie ID, die YouTube verwendet, um den Kanal des Abonnenten eindeutig zu identifizieren. Das resource_id-Objekt identifiziert den Channel, den der Nutzer abonniert hat. |
snippet.thumbnails |
objectEine Karte mit Miniaturansichten, die dem Abo zugeordnet sind. Für jedes Objekt auf der Karte ist der Schlüssel der Name des Vorschaubilds und der Wert ein Objekt, das weitere Informationen zum Vorschaubild enthält. |
snippet.thumbnails.(key) |
objectGültige Schlüsselwerte sind:
|
snippet.thumbnails.(key).url |
stringDie URL des Bildes. |
snippet.thumbnails.(key).width |
unsigned integerDie Breite des Bildes. |
snippet.thumbnails.(key).height |
unsigned integerDie Höhe des Bildes. |
contentDetails |
objectDas contentDetails-Objekt enthält grundlegende Statistiken zum Abo. |
contentDetails.totalItemCount |
unsigned integerDie ungefähre Anzahl der Elemente, auf die das Abo verweist. |
contentDetails.newItemCount |
unsigned integerDie Anzahl der neuen Elemente im Abo seit dem letzten Lesen der Inhalte. |
contentDetails.activityType |
stringDer Aktivitätstyp, für den dieses Abo gilt (nur Uploads, alles). Gültige Werte für diese Eigenschaft sind:
|
subscriberSnippet |
objectDas subscriberSnippet-Objekt enthält grundlegende Details zum Abonnenten. |
subscriberSnippet.title |
stringDer Titel des Kanals des Abonnenten. |
subscriberSnippet.description |
stringDie Beschreibung des Kanals des Abonnenten. |
subscriberSnippet.channelId |
stringDie ID, die YouTube dem Kanal des Abonnenten zuweist, um ihn eindeutig zu identifizieren. |
subscriberSnippet.thumbnails |
objectMiniaturansichten für den Kanal des Abonnenten. |
subscriberSnippet.thumbnails.(key) |
objectGültige Schlüsselwerte sind:
|
subscriberSnippet.thumbnails.(key).url |
stringDie URL des Bildes. |
subscriberSnippet.thumbnails.(key).width |
unsigned integerDie Breite des Bildes. |
subscriberSnippet.thumbnails.(key).height |
unsigned integerDie Höhe des Bildes. |