Diese Seite wurde von der Cloud Translation API übersetzt.

Subscriptions: list

Gibt Aboressourcen zurück, die den API-Anfragekriterien entsprechen.

Kontingentauswirkung: Ein Aufruf dieser Methode hat Kontingentkosten von 1 Einheit.

Gängige Anwendungsfälle

Anfragen

HTTP-Anfrage

GET https://www.googleapis.com/youtube/v3/subscriptions

Parameter

In der folgenden Tabelle sind die Parameter aufgeführt, die von dieser Abfrage unterstützt werden. Alle aufgeführten Parameter sind Abfrageparameter.

Parameter
Erforderliche Parameter
`part`	`string` Mit dem Parameter `part` wird eine durch Kommas getrennte Liste mit einem oder mehreren `subscription`-Ressourcenattributen angegeben, die in der API-Antwort enthalten sein werden. Bezeichnet der Parameter eine Property, die untergeordnete Properties enthält, werden die untergeordneten Attribute in die Antwort aufgenommen. In einer `subscription`-Ressource enthält beispielsweise das Attribut `snippet` andere Attribute, z. B. einen Anzeigetitel für das Abo. Wenn Sie `part=snippet` festlegen, enthält die API-Antwort auch alle diese verschachtelten Properties. Die folgende Liste enthält die `part`-Namen, die Sie in den Parameterwert aufnehmen können: `contentDetails` `id` `snippet` `subscriberSnippet`
Filter (geben Sie genau einen der folgenden Parameter an)
`channelId`	`string` Der Parameter `channelId` gibt die ID eines YouTube-Kanals an. Die API gibt nur die Abos dieses Kanals zurück.
`id`	`string` Der Parameter `id` gibt eine durch Kommas getrennte Liste der YouTube-Abo-IDs für die abgerufenen Ressourcen an. In einer `subscription`-Ressource gibt die Eigenschaft `id` die YouTube-Abo-ID an.
`mine`	`boolean` Dieser Parameter kann nur in einer ordnungsgemäß autorisierten Anfrage verwendet werden. Setze den Wert dieses Parameters auf `true`, um einen Feed der Abos des authentifizierten Nutzers abzurufen.
`myRecentSubscribers`	`boolean` Dieser Parameter kann nur in einer ordnungsgemäß autorisierten Anfrage verwendet werden. Setze den Wert dieses Parameters auf `true`, um einen Feed der Abonnenten des authentifizierten Nutzers in umgekehrter chronologischer Reihenfolge (neueste zuerst) abzurufen. Hinweis: Die maximale Anzahl von Abonnenten, die über diese API zurückgegeben werden, ist möglicherweise begrenzt.
`mySubscribers`	`boolean` Dieser Parameter kann nur in einer ordnungsgemäß autorisierten Anfrage verwendet werden. Setze den Wert dieses Parameters auf `true`, um einen Feed der Abonnenten des authentifizierten Nutzers in keiner bestimmten Reihenfolge abzurufen. Die maximale Anzahl von Abonnenten, die über diese API zurückgegeben werden, ist möglicherweise begrenzt.
Optionale Parameter
`forChannelId`	`string` Der Parameter `forChannelId` gibt eine durch Kommas getrennte Liste von Kanal-IDs an. Die API-Antwort enthält dann nur Abos, die mit diesen Kanälen übereinstimmen.
`maxResults`	`unsigned integer` Der Parameter `maxResults` gibt die maximale Anzahl von Elementen an, die in der Ergebnismenge zurückgegeben werden sollen. Zulässige Werte sind `0` bis `50` (einschließlich). Der Standardwert ist `5`.
`onBehalfOfContentOwner`	`string` Hinweis:Dieser Parameter ist ausschließlich für YouTube-Contentpartner vorgesehen. Der Parameter `onBehalfOfContentOwner` gibt an, dass durch die Autorisierungsanmeldedaten der Anfrage ein YouTube CMS-Nutzer identifiziert wird, der im Namen des im Parameterwert angegebenen Rechteinhabers handelt. Dieser Parameter ist für YouTube-Content-Partner vorgesehen, die viele verschiedene YouTube-Kanäle besitzen und verwalten. Rechteinhaber können sich nur einmal authentifizieren und auf alle ihre Video- und Kanaldaten zugreifen, ohne für jeden einzelnen Kanal Authentifizierungsdaten angeben zu müssen. Das CMS-Konto, mit dem sich der Nutzer authentifiziert, muss mit dem angegebenen YouTube-Rechteinhaber verknüpft sein.
`onBehalfOfContentOwnerChannel`	`string` Dieser Parameter kann nur in einer ordnungsgemäß autorisierten Anfrage verwendet werden. Hinweis: Dieser Parameter ist ausschließlich für YouTube-Contentpartner vorgesehen. Der Parameter `onBehalfOfContentOwnerChannel` gibt die YouTube-Kanal-ID des Kanals an, zu dem ein Video hinzugefügt wird. Dieser Parameter ist erforderlich, wenn in einer Anfrage ein Wert für den Parameter `onBehalfOfContentOwner` angegeben wird, und kann nur in Verbindung mit diesem Parameter verwendet werden. Außerdem muss die Anfrage über ein CMS-Konto autorisiert werden, das mit dem Rechteinhaber verknüpft ist, der im `onBehalfOfContentOwner`-Parameter angegeben ist. Schließlich muss der Kanal, den der Parameterwert `onBehalfOfContentOwnerChannel` angibt, mit dem Rechteinhaber verknüpft sein, der durch den Parameter `onBehalfOfContentOwner` angegeben wird. Dieser Parameter ist für YouTube-Contentpartner gedacht, die viele verschiedene YouTube-Kanäle besitzen und verwalten. Damit können sich Rechteinhaber einmal authentifizieren und Aktionen für den im Parameterwert angegebenen Kanal ausführen, ohne für jeden einzelnen Kanal Anmeldedaten zur Authentifizierung angeben zu müssen.
`order`	`string` Der Parameter `order` gibt die Methode an, die zum Sortieren von Ressourcen in der API-Antwort verwendet wird. Der Standardwert ist `SUBSCRIPTION_ORDER_RELEVANCE`. Zulässige Werte sind: `alphabetical`: Alphabetisch sortieren. `relevance`: Nach Relevanz sortieren. `unread`: Nach Aktivitätsreihenfolge sortieren.
`pageToken`	`string` Der `pageToken`-Parameter gibt eine bestimmte Seite in der Ergebnismenge an, die zurückgegeben werden soll. In einer API-Antwort identifizieren die Attribute `nextPageToken` und `prevPageToken` andere Seiten, die abgerufen werden könnten.

Anfragetext

Geben Sie beim Aufrufen dieser Methode keinen Anfragetext an.

Antwort

Bei Erfolg gibt diese Methode einen Antworttext mit der folgenden Struktur zurück:

{
  "kind": "youtube#subscriptionListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    subscription Resource
  ]
}

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#subscriptionListResponse`.
`etag`	`etag` Das ETag dieser Ressource.
`nextPageToken`	`string` Das Token, das als Wert des Parameters `pageToken` verwendet werden kann, um die nächste Seite in der Ergebnismenge abzurufen.
`prevPageToken`	`string` Das Token, das als Wert des Parameters `pageToken` verwendet werden kann, um die vorherige Seite in der Ergebnismenge abzurufen.
`pageInfo`	`object` Das Objekt `pageInfo` enthält Seiteninformationen für den Ergebnissatz.
`pageInfo.totalResults`	`integer` Die Gesamtzahl der Ergebnisse im Ergebnissatz.
`pageInfo.resultsPerPage`	`integer` Die Anzahl der Ergebnisse, die in der API-Antwort enthalten sind.
`items[]`	`list` Eine Liste der Abos, die den Anfragekriterien entsprechen.

Fehler

In der folgenden Tabelle finden Sie Fehlermeldungen, die die API als Antwort auf einen Aufruf dieser Methode zurückgeben könnte. Weitere Informationen finden Sie in der Dokumentation zu Fehlermeldungen.

Fehlertyp	Fehlerdetails	Beschreibung
`forbidden (403)`	`accountClosed`	Abos konnten nicht abgerufen werden, da das Konto des Abonnenten geschlossen ist.
`forbidden (403)`	`accountSuspended`	Abos konnten nicht abgerufen werden, da das Konto des Abonnenten gesperrt ist.
`forbidden (403)`	`subscriptionForbidden`	Der Anforderer ist nicht berechtigt, auf die angeforderten Abos zuzugreifen.
`notFound (404)`	`subscriberNotFound`	Der mit der Anfrage angegebene Abonnent wurde nicht gefunden.

Jetzt testen

Verwenden Sie APIs Explorer, um diese API aufzurufen und die API-Anfrage und -Antwort anzusehen.