Subscriptions

Eine subscription-Ressource enthält Informationen zu einem Abo eines YouTube-Nutzers. Ein Abo benachrichtigt einen Nutzer, wenn einem Kanal neue Videos hinzugefügt werden oder wenn ein anderer Nutzer auf YouTube eine von mehreren Aktionen 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 ein Abo für den Kanal des authentifizierten Nutzers 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 angezeigt werden:

Attribute
kind string
Identifiziert den Typ der API-Ressource. Der Wert ist youtube#subscription.
etag etag
Das ETag dieser Ressource.
id string
Die ID, mit der YouTube das Abo eindeutig identifiziert.
snippet object
Das snippet-Objekt enthält grundlegende Details zum Abo, einschließlich des Titels und des Kanals, den der Nutzer abonniert hat.
snippet.publishedAt datetime
Datum und Uhrzeit der Aboerstellung. Der Wert wird im ISO 8601-Format angegeben.
snippet.channelTitle string
Der Titel des Kanals, zu dem das Abo gehört.
snippet.title string
Der Titel des Abos.
snippet.description string
Details zum Abo.
snippet.resourceId object
Das id-Objekt enthält Informationen zu dem Kanal, den der Nutzer abonniert hat.
snippet.resourceId.kind string
Der Typ der API-Ressource.
snippet.resourceId.channelId string
Der Wert, den YouTube verwendet, um den Kanal eindeutig zu identifizieren, den der Nutzer abonniert hat.
snippet.channelId string
Die ID, mit der YouTube den Kanal des Abonnenten eindeutig identifiziert. Das resource_id-Objekt gibt den Kanal an, den der Nutzer abonniert hat.
snippet.thumbnails object
Eine Karte mit Thumbnail-Bildern, die mit dem Abo verknüpft sind. Bei jedem Objekt auf der Karte ist der Schlüssel der Name der Miniaturansicht. Der Wert ist ein Objekt, das weitere Informationen zur Miniaturansicht enthält.
snippet.thumbnails.(key) object
Gültige Schlüssel/Wert-Paare sind:
  • default: Die Standard-Miniaturansicht für diese Ressource. Das Standard-Thumbnail für ein Video – oder eine Ressource, die auf ein Video verweist, z. B. ein Playlist-Element oder ein Suchergebnis – ist 120 Pixel breit und 90 Pixel hoch. Das Standard-Thumbnail für einen Kanal ist 88 Pixel breit und 88 Pixel hoch.
  • medium: Eine Version des Thumbnails mit höherer Auflösung. Bei einem Video (oder einer Ressource, die sich auf ein Video bezieht) ist dieses Bild 320 Pixel breit und 180 Pixel hoch. Dieses Bild eines Kanals ist 240 Pixel breit und 240 Pixel hoch.
  • high: Eine Version des Thumbnails mit hoher Auflösung. Bei einem Video (oder einer Ressource, die sich auf ein Video bezieht) ist dieses Bild 480 Pixel breit und 360 Pixel hoch. Dieses Bild eines Kanals ist 800 Pixel breit und 800 Pixel hoch.
snippet.thumbnails.(key).url string
Die URL des Bildes.
snippet.thumbnails.(key).width unsigned integer
Die Breite des Bildes.
snippet.thumbnails.(key).height unsigned integer
Die Höhe des Bildes.
contentDetails object
Das contentDetails-Objekt enthält grundlegende Statistiken zum Abo.
contentDetails.totalItemCount unsigned integer
Die ungefähre Anzahl der Elemente, auf die das Abo verweist.
contentDetails.newItemCount unsigned integer
Die Anzahl der neuen Artikel im Abo, seit die Inhalte zuletzt gelesen wurden.
contentDetails.activityType string
Die Art der Aktivität, für die dieses Abo bestimmt ist (nur Uploads, alles).

Gültige Werte für diese Property sind:
  • all
  • uploads
subscriberSnippet object
Das subscriberSnippet-Objekt enthält grundlegende Details zum Abonnenten.
subscriberSnippet.title string
Der Titel des Kanals des Abonnenten.
subscriberSnippet.description string
Die Beschreibung des Kanals des Abonnenten.
subscriberSnippet.channelId string
Die ID, die YouTube zur eindeutigen Identifizierung des Kanals des Abonnenten zuweist.
subscriberSnippet.thumbnails object
Thumbnail-Bilder für den Kanal des Abonnenten.
subscriberSnippet.thumbnails.(key) object
Gültige Schlüssel/Wert-Paare sind:
  • default: Die Standard-Miniaturansicht für diese Ressource. Das Standard-Thumbnail für ein Video – oder eine Ressource, die auf ein Video verweist, z. B. ein Playlist-Element oder ein Suchergebnis – ist 120 Pixel breit und 90 Pixel hoch. Das Standard-Thumbnail für einen Kanal ist 88 Pixel breit und 88 Pixel hoch.
  • medium: Eine Version des Thumbnails mit höherer Auflösung. Bei einem Video (oder einer Ressource, die sich auf ein Video bezieht) ist dieses Bild 320 Pixel breit und 180 Pixel hoch. Dieses Bild eines Kanals ist 240 Pixel breit und 240 Pixel hoch.
  • high: Eine Version des Thumbnails mit hoher Auflösung. Bei einem Video (oder einer Ressource, die sich auf ein Video bezieht) ist dieses Bild 480 Pixel breit und 360 Pixel hoch. Dieses Bild eines Kanals ist 800 Pixel breit und 800 Pixel hoch.
subscriberSnippet.thumbnails.(key).url string
Die URL des Bildes.
subscriberSnippet.thumbnails.(key).width unsigned integer
Die Breite des Bildes.
subscriberSnippet.thumbnails.(key).height unsigned integer
Die Höhe des Bildes.