Subscriptions

Eine subscription-Ressource enthält Informationen zu einem YouTube-Abo. Ein Abo benachrichtigt einen Nutzer, wenn einem Kanal neue Videos hinzugefügt werden oder 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 API-Anfragekriterien entsprechen. Hier kannst du die Funktion ausprobieren.
Einfügen
Fügt ein Abo für den Kanal des authentifizierten Nutzers hinzu. Hier kannst du die Funktion ausprobieren.
Delete
Abo wird gelöscht. 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, die YouTube verwendet, um das Abo eindeutig zu identifizieren.
snippet object
Das snippet-Objekt enthält grundlegende Details zum Abo, einschließlich Titel und Kanal, den der Nutzer abonniert hat.
snippet.publishedAt datetime
Datum und Uhrzeit der Erstellung des Abos. 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, den der Nutzer abonniert hat, eindeutig zu identifizieren.
snippet.channelId string
Die ID, mit der YouTube den Kanal des Abonnenten eindeutig identifiziert. Das Objekt resource_id gibt den Kanal an, den der Nutzer abonniert hat.
snippet.thumbnails object
Eine Karte mit Miniaturansichten, die mit dem Abo verknüpft sind. Für jedes Objekt auf der Karte ist der Schlüssel der Name der Miniaturansicht und der Wert ein Objekt, das weitere Informationen zur Miniaturansicht enthält.
snippet.thumbnails.(key) object
Gültige Schlüssel/Wert-Paare sind:
  • default: Das 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 der Miniaturansicht mit einer höheren Auflösung. Bei einem Video (oder einer Ressource, die sich auf ein Video bezieht) ist dieses Bild 320 Pixel breit und 180 Pixel hoch. Bei einem Kanal ist dieses Bild 240 Pixel breit und 240 Pixel hoch.
  • high: Eine hochauflösende Version der Miniaturansicht. Bei einem Video (oder einer Ressource, die sich auf ein Video bezieht) ist dieses Bild 480 Pixel breit und 360 Pixel hoch. Bei einem Kanal ist dieses Bild 800 Pixel breit und 800 Pixel hoch.
snippet.thumbnails.(key).url string
Die Bild-URL.
snippet.thumbnails.(key).width unsigned integer
Die Breite des Bildes.
snippet.thumbnails.(key).height unsigned integer
Die Höhe des Bildes.
contentDetails object
Das Objekt contentDetails 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 Elemente im Abo seit dem letzten Lesen des Inhalts.
contentDetails.activityType string
Die Art der Aktivität, für die dieses Abo gilt (nur Uploads, alles).

Gültige Werte für diese Property sind:
  • all
  • uploads
subscriberSnippet object
Das Objekt subscriberSnippet 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
Miniaturansichten für den Kanal des Abonnenten.
subscriberSnippet.thumbnails.(key) object
Gültige Schlüssel/Wert-Paare sind:
  • default: Das 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 der Miniaturansicht mit einer höheren Auflösung. Bei einem Video (oder einer Ressource, die sich auf ein Video bezieht) ist dieses Bild 320 Pixel breit und 180 Pixel hoch. Bei einem Kanal ist dieses Bild 240 Pixel breit und 240 Pixel hoch.
  • high: Eine hochauflösende Version der Miniaturansicht. Bei einem Video (oder einer Ressource, die sich auf ein Video bezieht) ist dieses Bild 480 Pixel breit und 360 Pixel hoch. Bei einem Kanal ist dieses Bild 800 Pixel breit und 800 Pixel hoch.
subscriberSnippet.thumbnails.(key).url string
Die Bild-URL.
subscriberSnippet.thumbnails.(key).width unsigned integer
Die Breite des Bildes.
subscriberSnippet.thumbnails.(key).height unsigned integer
Die Höhe des Bildes.