Channels: list

Hinweis: Der Wert der Property statistics.subscriberCount der Ressource channel wurde aktualisiert, um einer Änderung der YouTube-Richtlinien Rechnung zu tragen, die sich auf die Darstellung der Abonnentenzahlen auswirkt. Weitere Informationen findest du im Überarbeitungsverlauf oder in der YouTube-Hilfe.

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

Auswirkungen auf das Kontingent:Ein Aufruf dieser Methode kostet 1 Kontingenteinheit.

Gängige Anwendungsfälle

Anfrage

HTTP-Anfrage

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

Autorisierung

Für eine Anfrage, mit der der Teil auditDetails für eine channel-Ressource abgerufen wird, muss ein Autorisierungstoken mit dem Bereich https://www.googleapis.com/auth/youtubepartner-channel-audit angegeben werden. Außerdem muss jedes Token, das diesen Bereich verwendet, widerrufen werden, wenn das MCN beschließt, den Kanal anzunehmen oder abzulehnen, oder innerhalb von zwei Wochen nach dem Ausstellungsdatum des Tokens.

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 einer oder mehreren channel-Ressourcen-Properties angegeben, die in der API-Antwort enthalten sein sollen.

Wenn der Parameter eine Property angibt, die untergeordnete Properties enthält, werden diese untergeordneten Properties in die Antwort aufgenommen. In einer channel-Ressource enthält die Property contentDetails beispielsweise andere Properties wie die 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 wurde eingestellt. Mit dem categoryId Parameter wurde eine YouTube-Kategorie angegeben, mit der YouTube-Kanäle angefordert werden konnten, die mit dieser Kategorie verknüpft sind.
forHandle string
Mit dem Parameter forHandle wird ein YouTube-Handle angegeben, um den Kanal anzufordern, der mit diesem Handle verknüpft ist. Dem Parameterwert kann ein @ Symbol vorangestellt werden. Wenn du beispielsweise die Ressource für den Kanal „Google for Developers“ abrufen möchtest, lege den forHandle Parameterwert auf GoogleDevelopers oder @GoogleDevelopers fest.
forUsername string
Mit dem Parameter forUsername wird ein YouTube-Nutzername angegeben, um den Kanal anzufordern, der mit diesem Nutzernamen verknüpft ist.
id string
Mit dem Parameter id wird eine durch Kommas getrennte Liste der YouTube-Kanal-IDs für die abzurufenden Ressourcen angegeben. 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-Content-Partner vorgesehen.

Lege den Wert dieses Parameters auf true fest, damit die API nur Kanäle zurückgibt, die vom Content-Inhaber verwaltet werden, der mit dem Parameter onBehalfOfContentOwner angegeben wird. Der Nutzer muss als CMS-Konto authentifiziert sein, das mit dem angegebenen Content-Inhaber verknüpft ist, und onBehalfOfContentOwner muss 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, die dem authentifizierten Nutzer gehören.
Optionale Parameter
hl string
Mit dem Parameter hl wird die API angewiesen, 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 i18nLanguages.list Methode zurückgegeben wird.

Wenn lokalisierte Ressourcendetails in dieser Sprache verfügbar sind, enthält das Objekt snippet.localized der Ressource die lokalisierten Werte. Wenn keine lokalisierten Details verfügbar sind, enthält das snippet.localized Objekt Ressourcendetails in der Standardsprache der Ressource.
maxResults unsigned integer
Mit dem Parameter maxResults wird die maximale Anzahl der Elemente angegeben, die im Ergebnissatz zurückgegeben werden sollen. Zulässige Werte sind 0 bis 50 (einschließlich). 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-Content-Partner vorgesehen.

Der Parameter onBehalfOfContentOwner gibt an, dass die Autorisierungsdaten der Anfrage einen YouTube-CMS-Nutzer identifizieren, der im Namen des Content-Inhabers handelt, der im Parameterwert 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 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.
pageToken string
Mit dem Parameter pageToken wird eine bestimmte Seite im Ergebnissatz angegeben, die zurückgegeben werden soll. In einer API-Antwort geben die Properties nextPageToken und prevPageToken andere Seiten an, die abgerufen werden können.

Anfragetext

Gib beim Aufrufen 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 Attribute definiert, die in dieser Ressource angezeigt werden:

Attribute
kind string
Gibt den Typ der API-Ressource an. 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 im Ergebnissatz abzurufen.
prevPageToken string
Das Token, das als Wert des pageToken Parameters verwendet werden kann, um die vorherige Seite im Ergebnissatz abzurufen. Diese Property ist nicht in der API-Antwort enthalten, wenn für die entsprechende API-Anfrage der managedByMe Parameter auf true festgelegt wurde.
pageInfo object
Das Objekt pageInfo enthält Paging-Informationen 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 Suchkriterien 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 Fehlerdetail Beschreibung
badRequest (400) invalidCriteria Es kann maximal einer der folgenden Filter angegeben werden:id, categoryId, mine, managedByMe, forHandle, forUsername. Bei der Authentifizierung des Content-Inhabers über den Parameter onBehalfOfContentOwner können nur id oder managedByMe angegeben werden.
forbidden (403) channelForbidden Der mit dem Parameter id angegebene Kanal unterstützt die Anfrage nicht oder die Anfrage ist nicht ordnungsgemäß autorisiert.
notFound (404) categoryNotFound Die mit dem Parameter categoryId angegebene Kategorie wurde nicht gefunden. Verwende die Methode guideCategories.list, um eine Liste gültiger Werte abzurufen.
notFound (404) channelNotFound Der im Parameter id angegebene Kanal wurde nicht gefunden.

Testen!

Mit dem APIs Explorer kannst du diese API aufrufen und die API-Anfrage und -Antwort ansehen.