Channels: list

Hinweis: Der Attributwert statistics.subscriberCount der channel-Ressource wurde aktualisiert, um eine Änderung der YouTube-Richtlinien widerzuspiegeln, die sich auf die Anzeige der Abonnentenzahlen auswirkt. Weitere Informationen finden Sie im Überarbeitungsverlauf oder in der YouTube-Hilfe.

Gibt eine Sammlung von null oder mehr channel-Ressourcen zurück, die den 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/channels

Autorisierung

Eine Anfrage, die den auditDetails-Teil für eine channel-Ressource abruft, muss ein Autorisierungstoken mit dem Bereich https://www.googleapis.com/auth/youtubepartner-channel-audit bereitstellen. Darüber hinaus muss jedes Token, das diesen Geltungsbereich verwendet, widerrufen werden, wenn das MCN den Kanal akzeptiert oder ablehnt oder innerhalb von zwei Wochen nach Ausstellung des Tokens.

Parameters

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

Parameters
Erforderliche Parameter
part string
Mit dem Parameter part wird eine durch Kommas getrennte Liste mit einem oder mehreren channel-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 channel-Ressource enthält beispielsweise das Attribut contentDetails andere Attribute, z. B. die Attribute uploads. Wenn Sie also part=contentDetails festlegen, enthält die API-Antwort auch alle verschachtelten Properties.

Die folgende Liste enthält die part-Namen, die Sie in den Parameterwert aufnehmen können:
  • auditDetails
  • brandingSettings
  • contentDetails
  • contentOwnerDetails
  • id
  • localizations
  • snippet
  • statistics
  • status
  • topicDetails
Filter (geben Sie genau einen der folgenden Parameter an)
categoryId string
Dieser Parameter wurde eingestellt. Mit dem Parameter categoryId wurde eine Kategorie der YouTube-Übersicht 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 das Symbol @ vorangestellt werden. Wenn du beispielsweise die Ressource für den Kanal „Google for Developers“ abrufen möchtest, musst du den Parameterwert forHandle auf GoogleDevelopers oder @GoogleDevelopers setzen.
forUsername string
Der Parameter forUsername gibt einen YouTube-Nutzernamen an, wodurch der mit diesem Nutzernamen verknüpfte Kanal angefordert wird.
id string
Der Parameter id gibt eine durch Kommas getrennte Liste der YouTube-Kanal-IDs für die abgerufene Ressource(n) an. In einer channel-Ressource gibt die Eigenschaft 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-Contentpartner vorgesehen.

Setze den Wert dieses Parameters auf true, um die API anzuweisen, nur vom Rechteinhaber verwaltete Kanäle zurückzugeben, die mit dem Parameter onBehalfOfContentOwner angegeben wurden. Der Nutzer muss als CMS-Konto authentifiziert sein, das mit dem angegebenen Rechteinhaber verknüpft ist, und onBehalfOfContentOwner muss angegeben werden.
mine boolean
Dieser Parameter kann nur in einer ordnungsgemäß autorisierten Anfrage verwendet werden. Setze den Wert dieses Parameters auf true, um die API anzuweisen, nur Kanäle zurückzugeben, 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 in dieser Sprache lokalisierte Ressourcendetails 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 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
Dieser Parameter kann nur in einer ordnungsgemäß autorisierten Anfrage verwendet werden. 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.
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#channelListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    channel 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#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 im Ergebnissatz abzurufen. Dieses Attribut ist nicht in der API-Antwort enthalten, wenn der Parameter managedByMe in der entsprechenden API-Anfrage auf true gesetzt wurde.
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 Kanäle, 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
badRequest (400) invalidCriteria Es kann maximal einer der folgenden Filter angegeben werden:id, categoryId, mine, managedByMe, forHandle, forUsername. Bei der Authentifizierung des Rechteinhabers über den Parameter onBehalfOfContentOwner darf nur id oder managedByMe angegeben werden.
forbidden (403) channelForbidden Der durch den Parameter id angegebene Kanal unterstützt die Anfrage nicht oder die Anfrage ist nicht ordnungsgemäß autorisiert.
notFound (404) categoryNotFound Die durch den Parameter categoryId angegebene Kategorie wurde nicht gefunden. Verwenden Sie die Methode guideCategories.list, um eine Liste gültiger Werte abzurufen.
notFound (404) channelNotFound Der im id-Parameter angegebene Kanal wurde nicht gefunden.

Jetzt testen

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