Channels: list

Hinweis:Der Property-Wert statistics.subscriberCount der Ressource channel wurde aktualisiert, um eine Änderung der YouTube-Richtlinien widerzuspiegeln, die sich auf die Darstellung der Abonnentenzahlen auswirkt. Weitere Informationen findest du unter Versionsverlauf oder in der YouTube-Hilfe.

Gibt eine Sammlung von null oder mehr channel-Ressourcen zurück, die den Anfragekriterien entsprechen.

Auswirkungen auf das Kontingent:Ein Aufruf dieser Methode hat Kontingentkosten in Höhe von 1 Einheit.

Gängige Anwendungsfälle

Anfrage

HTTP-Anfrage

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

Autorisierung

Eine Anfrage, bei der der auditDetails-Teil einer channel-Ressource abgerufen wird, muss ein Autorisierungstoken mit dem Bereich https://www.googleapis.com/auth/youtubepartner-channel-audit enthalten. Außerdem muss jedes Token, das diesen Umfang verwendet, widerrufen werden, wenn das MCN den Kanal akzeptiert oder ablehnt, oder innerhalb von zwei Wochen nach dem Datum, an dem das Token ausgestellt wurde.

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 kommagetrennte Liste mit einer oder mehreren channel-Ressourceneigenschaften an, die in der API-Antwort enthalten sein sollen.

Wenn der Parameter eine Property angibt, die untergeordnete Properties enthält, werden auch diese in die Antwort eingeschlossen. In einer channel-Ressource enthält die contentDetails-Property beispielsweise andere Properties, z. B. uploads-Properties. Wenn du also part=contentDetails festlegst, enthält die API-Antwort auch alle diese verschachtelten Properties.

Die folgende Liste enthält die part-Namen, die du in den Parameterwert aufnehmen kannst:
  • auditDetails
  • brandingSettings
  • contentDetails
  • contentOwnerDetails
  • id
  • localizations
  • snippet
  • statistics
  • status
  • topicDetails
Filter (genau einen der folgenden Parameter angeben)
categoryId string
Dieser Parameter wird nicht mehr unterstützt. Mit dem Parameter categoryId wurde eine YouTube-Leitfadenkategorie angegeben. Er konnte verwendet werden, um YouTube-Kanäle anzufordern, die mit dieser Kategorie verknüpft sind.
forHandle string
Mit dem Parameter forHandle wird ein YouTube-Alias angegeben, wodurch der mit diesem Alias verknüpfte Kanal angefordert wird. Dem Parameterwert kann ein @-Symbol vorangestellt werden. Wenn Sie beispielsweise die Ressource für den Kanal „Google for Developers“ abrufen möchten, legen Sie den Parameterwert forHandle auf GoogleDevelopers oder @GoogleDevelopers fest.
forUsername string
Mit dem Parameter forUsername wird ein YouTube-Nutzername angegeben, wodurch der mit diesem Nutzername verknüpfte Kanal angefordert wird.
id string
Der Parameter id gibt eine durch Kommas getrennte Liste der YouTube-Kanal-IDs für die abgerufenen Ressourcen an. In einer channel-Ressource gibt die Property id die YouTube-Kanal-ID des Kanals an.
managedByMe boolean
Dieser Parameter kann nur in einer ordnungsgemäß autorisierten Anfrage verwendet werden.

Hinweis:Dieser Parameter ist ausschließlich für YouTube-Inhaltspartner gedacht.

Lege den Wert dieses Parameters auf true fest, damit die API nur Kanäle zurückgibt, die vom Rechteinhaber verwaltet werden, der im Parameter onBehalfOfContentOwner angegeben ist. Der Nutzer muss als CMS-Konto authentifiziert sein, das mit dem angegebenen Rechteinhaber verknüpft ist. Außerdem muss onBehalfOfContentOwner angegeben werden.
mine boolean
Dieser Parameter kann nur in einer ordnungsgemäß autorisierten Anfrage verwendet werden. Lege den Wert dieses Parameters auf true fest, damit die API nur Kanäle zurückgibt, deren Inhaber der authentifizierte Nutzer ist.
Optionale Parameter
hl string
Der Parameter hl weist die API an, lokalisierte Ressourcenmetadaten für eine bestimmte Anwendungssprache abzurufen, die von der YouTube-Website unterstützt wird. Der Parameterwert muss ein Sprachcode sein, der in der Liste enthalten ist, die von der Methode i18nLanguages.list zurückgegeben wird.

Wenn lokalisierte Ressourcendetails in dieser Sprache verfügbar sind, enthält das snippet.localized-Objekt der Ressource die lokalisierten Werte. Wenn jedoch keine lokalisierten Details verfügbar sind, enthält das snippet.localized-Objekt Ressourcendetails in der Standardsprache der Ressource.
maxResults unsigned integer
Der Parameter maxResults gibt die maximale Anzahl der Elemente an, die im Ergebnissatz zurückgegeben werden sollen. Zulässige Werte sind 0 bis 50. Der Standardwert ist 5.
onBehalfOfContentOwner string
Dieser Parameter kann nur in einer ordnungsgemäß autorisierten Anfrage verwendet werden.

Hinweis:Dieser Parameter ist ausschließlich für YouTube-Inhaltspartner gedacht.

Der Parameter onBehalfOfContentOwner gibt an, dass die Autorisierungsdaten der Anfrage einen YouTube CMS-Nutzer identifizieren, der im Namen des im Parameterwert angegebenen Rechteinhabers handelt. Dieser Parameter richtet sich an YouTube-Contentpartner, die viele verschiedene YouTube-Kanäle haben und verwalten. So können Rechteinhaber sich einmal authentifizieren und auf alle ihre Video- und Kanaldaten zugreifen, ohne für jeden einzelnen Kanal Anmeldedaten angeben zu müssen. Das CMS-Konto, mit dem sich der Nutzer authentifiziert, muss mit dem angegebenen YouTube-Rechteinhaber verknüpft sein.
pageToken string
Der Parameter pageToken gibt eine bestimmte Seite im Ergebnissatz an, die zurückgegeben werden soll. In einer API-Antwort werden mit den Eigenschaften nextPageToken und prevPageToken andere Seiten angegeben, die abgerufen werden könnten.

Anfragetext

Geben Sie beim Aufruf dieser Methode keinen Anfragetext an.

Antwort

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

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

Attribute

In der folgenden Tabelle sind die Eigenschaften aufgeführt, die in dieser Ressource angezeigt werden:

Attribute
kind string
Identifiziert den Typ der API-Ressource. Der Wert ist youtube#channelListResponse.
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. Hinweis: Diese Eigenschaft ist nicht in der API-Antwort enthalten, wenn in der entsprechenden API-Anfrage der Parameter managedByMe auf true festgelegt wurde.
pageInfo object
Das pageInfo-Objekt enthält Informationen zur Paginierung für den Ergebnissatz.
pageInfo.totalResults integer
Die Gesamtzahl der Ergebnisse im Ergebnissatz.
pageInfo.resultsPerPage integer
Die Anzahl der Ergebnisse in der API-Antwort.
items[] list
Eine Liste der Kanäle, die den Anfragekriterien 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 findest du unter YouTube Data API – Fehler.

Fehlertyp Fehlerdetails Beschreibung
badRequest (400) invalidCriteria Es kann maximal einer der folgenden Filter angegeben werden:id, categoryId, mine, managedByMe, forHandle, forUsername. Bei der Authentifizierung von Rechteinhabern über den Parameter onBehalfOfContentOwner darf nur id oder managedByMe angegeben werden.
forbidden (403) channelForbidden Der vom Parameter id angegebene Channel unterstützt die Anfrage nicht oder die Anfrage ist nicht ordnungsgemäß autorisiert.
notFound (404) categoryNotFound Die Kategorie, die mit dem Parameter categoryId angegeben wurde, kann nicht gefunden werden. Mit der Methode guideCategories.list können Sie eine Liste der gültigen Werte abrufen.
notFound (404) channelNotFound Der im Parameter id angegebene Kanal kann nicht gefunden werden.

Testen!

Verwenden Sie die APIs Explorer, um diese API aufzurufen und die API-Anfrage und ‑Antwort zu sehen.