Diese Seite wurde von der Cloud Translation API übersetzt.

Subscriptions: list

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

Auswirkungen auf Kontingente: Bei einem Aufruf dieser Methode fallen Kontingentkosten von 1 Einheit an.

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` Der Parameter `part` gibt eine durch Kommas getrennte Liste mit einer oder mehreren `subscription`-Ressourceneigenschaften an, die in der API-Antwort enthalten sein werden. Wenn der Parameter eine Property mit untergeordneten Properties angibt, werden die untergeordneten Properties in die Antwort aufgenommen. In einer `subscription`-Ressource enthält die Property `snippet` beispielsweise andere Properties, z. B. einen Anzeigetitel für das Abo. Wenn du `part=snippet` festlegst, enthält die API-Antwort auch alle diese verschachtelten Attribute. Die folgende Liste enthält die `part`-Namen, die du in den Parameterwert aufnehmen kannst: `contentDetails` `id` `snippet` `subscriberSnippet`
Filter (genau einen der folgenden Parameter angeben)
`channelId`	`string` Der Parameter `channelId` gibt eine YouTube-Kanal-ID 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 Property `id` die YouTube-Abo-ID an.
`mine`	`boolean` Dieser Parameter kann nur in einer ordnungsgemäß autorisierten Anfrage verwendet werden. Legen Sie den Wert dieses Parameters auf `true` fest, 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 abzurufen (neueste zuerst). Die maximale Anzahl von Abonnenten, die über diese API zurückgegeben wird, ist möglicherweise begrenzt.
`mySubscribers`	`boolean` Dieser Parameter kann nur in einer ordnungsgemäß autorisierten Anfrage verwendet werden. Legen Sie den Wert dieses Parameters auf `true` fest, um einen Feed der Abonnenten des authentifizierten Nutzers in keiner bestimmten Reihenfolge abzurufen. Die maximale Anzahl von Abonnenten, die über diese API zurückgegeben wird, 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`. Der Standardwert ist `5`.
`onBehalfOfContentOwner`	`string` Hinweis: Dieser Parameter ist ausschließlich für Content-Partner von YouTube bestimmt. Der Parameter `onBehalfOfContentOwner` gibt an, dass mit den Anmeldedaten 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 einmalig authentifizieren und auf alle ihre Video- und Kanaldaten zugreifen, ohne für jeden einzelnen Kanal Anmeldedaten zur Authentifizierung 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 nur für YouTube-Content-Partner 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 ist. Er kann nur in Verbindung mit diesem Parameter verwendet werden. Außerdem muss die Anfrage über ein CMS-Konto autorisiert werden, das mit dem im `onBehalfOfContentOwner`-Parameter angegebenen Rechteinhaber verknüpft ist. Schließlich muss der Kanalwert, den der Parameterwert `onBehalfOfContentOwnerChannel` angibt, mit dem Rechteinhaber verknüpft sein, den der Parameter `onBehalfOfContentOwner` angibt. Dieser Parameter ist für YouTube-Content-Partner vorgesehen, die zahlreiche verschiedene YouTube-Kanäle besitzen und verwalten. Rechteinhaber können sich einmalig 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ät sortieren.
`pageToken`	`string` Der Parameter `pageToken` gibt eine bestimmte Seite im Ergebnissatz an, die zurückgegeben werden soll. In einer API-Antwort identifizieren die Attribute `nextPageToken` und `prevPageToken` andere Seiten, die abgerufen werden können.

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 im Ergebnissatz abzurufen.
`prevPageToken`	`string` Das Token, das als Wert des Parameters `pageToken` verwendet werden kann, um die vorherige Seite im Ergebnissatz abzurufen.
`pageInfo`	`object` Das `pageInfo`-Objekt enthält Seiteninformationen für die Ergebnismenge.
`pageInfo.totalResults`	`integer` Die Gesamtzahl der Ergebnisse in der Ergebnismenge.
`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 sind Fehlermeldungen aufgeführt, die von der API möglicherweise als Antwort auf einen Aufruf dieser Methode zurückgegeben werden. Weitere Informationen finden Sie in der Dokumentation zu Fehlermeldungen.

Fehlertyp	Fehlerdetails	Beschreibung
`forbidden (403)`	`accountClosed`	Abos konnten nicht abgerufen werden, weil 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 Antragsteller hat keinen Zugriff auf die angeforderten Abos.
`notFound (404)`	`subscriberNotFound`	Der in der Anfrage angegebene Abonnent wurde nicht gefunden.

Testen!

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