Subscriptions: list

Gibt Aboressourcen zurück, die den Kriterien der API-Anfrage entsprechen.

Kontingentauswirkungen: Ein Aufruf dieser Methode kostet 1 Kontingenteinheit.

Gängige Anwendungsfälle

Anfrage

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 von einer oder mehreren Eigenschaften der Ressource subscription an, die in der API-Antwort enthalten sein sollen.

Wenn der Parameter eine Eigenschaft identifiziert, die untergeordnete Eigenschaften enthält, werden diese untergeordneten Eigenschaften in die Antwort aufgenommen. In einer subscription-Ressource enthält die Eigenschaft snippet beispielsweise andere Eigenschaften wie einen Anzeigenamen für das Abo. Wenn Sie part=snippet festlegen, enthält die API-Antwort auch alle diese verschachtelten Eigenschaften.

Die folgende Liste enthält die part Namen, die Sie in den Parameterwert aufnehmen können:
  • 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 abzurufenden 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. Setzen Sie 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. Setzen Sie den Wert dieses Parameters auf true, um einen Feed der Abonnenten des authentifizierten Nutzers in umgekehrt chronologischer Reihenfolge abzurufen (neueste zuerst).

Die maximale Anzahl der über diese API zurückgegebenen Abonnenten kann begrenzt sein.
mySubscribers boolean
Dieser Parameter kann nur in einer ordnungsgemäß autorisierten Anfrage verwendet werden. Setzen Sie den Wert dieses Parameters auf true, um einen Feed der Abonnenten des authentifizierten Nutzers in beliebiger Reihenfolge abzurufen. Die maximale Anzahl der über diese API zurückgegebenen Abonnenten kann begrenzt sein.
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 diesen Kanälen entsprechen.
maxResults unsigned integer
Der Parameter maxResults gibt die maximale Anzahl der Elemente 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-Content-Partner vorgesehen.

Der onBehalfOfContentOwner Parameter gibt an, dass die Autorisierungsanmeldedaten der Anfrage einen YouTube-CMS-Nutzer identifizieren, der im Namen des im Parameterwert angegebenen Content-Inhabers handelt. Dieser Parameter ist für YouTube-Content-Partner vorgesehen, die viele verschiedene YouTube-Kanäle besitzen und verwalten. So können sich Rechteinhaber einmal authentifizieren und auf alle 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-Content-Partner vorgesehen.

Der onBehalfOfContentOwnerChannel Parameter gibt die YouTube-Kanal-ID des Kanals an, dem ein Video hinzugefügt wird. Dieser Parameter ist erforderlich, wenn in einer Anfrage ein Wert für den Parameter onBehalfOfContentOwner angegeben wird. Er kann nur in Verbindung mit diesem Parameter verwendet werden. Außerdem muss die Anfrage mit einem CMS-Konto autorisiert werden, das mit dem Content-Inhaber verknüpft ist, der im Parameter onBehalfOfContentOwner angegeben ist. Schließlich muss der Kanal, der im Parameterwert onBehalfOfContentOwnerChannel angegeben ist, mit dem Content-Inhaber verknüpft sein, der im Parameter onBehalfOfContentOwner angegeben ist.

Dieser Parameter ist für YouTube-Content-Partner vorgesehen, die viele verschiedene YouTube-Kanäle besitzen und verwalten. So können sich Rechteinhaber einmal authentifizieren und Aktionen im Namen des im Parameterwert angegebenen Kanals ausführen, ohne für jeden einzelnen Kanal Authentifizierungsdaten 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 in der Ergebnismenge an, die zurückgegeben werden soll. In einer API-Antwort identifizieren die Eigenschaften 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 sind 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 Informationen zur Paginierung für die Ergebnismenge.
pageInfo.totalResults integer
Die Gesamtzahl der Ergebnisse in der Ergebnismenge.
pageInfo.resultsPerPage integer
Die Anzahl der Ergebnisse in der API-Antwort.
items[] list
Eine Liste der Abos, die den Kriterien der Anfrage entsprechen.

Fehler

In der folgenden Tabelle sind die Fehlermeldungen aufgeführt, die die API als Antwort auf einen Aufruf dieser Methode zurückgeben kann. 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 wurde.
forbidden (403) accountSuspended Abos konnten nicht abgerufen werden, da das Konto des Abonnenten gesperrt wurde.
forbidden (403) subscriptionForbidden Der Anfragende ist nicht berechtigt, auf die angeforderten Abos zuzugreifen.
notFound (404) subscriberNotFound Der in der Anfrage angegebene Abonnent wurde nicht gefunden.

Testen!

Mit dem APIs Explorer können Sie diese API aufrufen und sich die API-Anfrage und -Antwort ansehen.