Channels: list

Hinweis: Der Attributwert statistics.subscriberCount der Ressource channel wurde aktualisiert und spiegelt eine YouTube-Richtlinienänderung wider, die sich auf die Anzeige der Abonnentenzahl 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.

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/channels

Autorisierung

Eine Anfrage, die den auditDetails-Teil für eine channel-Ressource abruft, muss ein Autorisierungstoken angeben, das den https://www.googleapis.com/auth/youtubepartner-channel-audit-Bereich enthält. Außerdem muss jedes Token, das diesen Bereich verwendet, widerrufen werden, wenn das MCN den Kanal akzeptiert oder ablehnt oder innerhalb von zwei Wochen nach der Ausstellung 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 Der Parameter part gibt eine durch Kommas getrennte Liste mit einer oder mehreren channel-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 channel-Ressource enthält die Property contentDetails beispielsweise andere Properties, z. B. die uploads-Property. Wenn Sie part=contentDetails festlegen, enthält die API-Antwort daher auch alle diese verschachtelten Attribute. 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 (genau einen der folgenden Parameter angeben)
categoryId	string Dieser Parameter wurde eingestellt. Der Parameter categoryId hat eine YouTube-Guide-Kategorie angegeben und kann verwendet werden, um YouTube-Kanäle anzufordern, die mit dieser Kategorie verknüpft sind.
forUsername	string Der Parameter forUsername gibt einen YouTube-Nutzernamen an und fordert somit den Kanal an, der mit diesem Nutzernamen verknüpft ist.
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 id-Property 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. Setzen Sie den Wert dieses Parameters auf true, um die API anzuweisen, nur vom Rechteinhaber verwaltete Kanäle zurückzugeben, die der Parameter onBehalfOfContentOwner angibt. Der Nutzer muss als CMS-Konto authentifiziert werden, 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. Legen Sie den Wert dieses Parameters auf true fest, um die API anzuweisen, nur Kanäle zurückzugeben, die dem authentifizierten Nutzer gehören.
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 in der Liste sein, 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 Objekt snippet.localized 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. 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 Autorisierungsanmeldedaten der Anfrage einen YouTube CMS-Nutzer identifizieren, 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.
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#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 im Ergebnissatz abzurufen.
prevPageToken	string Das Token, das als Wert des Parameters pageToken verwendet werden kann, um die vorherige Seite im Ergebnissatz abzurufen. Beachten Sie, dass dieses Attribut nicht in der API-Antwort enthalten ist, wenn der zugehörige API-Request den Parameter managedByMe auf true setzt.
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 Kanäle, 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
badRequest (400)	invalidCriteria	Es kann maximal einer der folgenden Filter angegeben werden:id, categoryId, mine, managedByMe, forUsername. Bei der Authentifizierung des Rechteinhabers über den Parameter onBehalfOfContentOwner darf nur id oder managedByMe angegeben werden.
forbidden (403)	channelForbidden	Der im Parameter id angegebene Kanal unterstützt die Anfrage nicht oder sie ist nicht ordnungsgemäß autorisiert.
notFound (404)	categoryNotFound	Die durch den Parameter categoryId identifizierte Kategorie wurde nicht gefunden. Mit der Methode guideCategories.list rufen Sie eine Liste gültiger Werte ab.
notFound (404)	channelNotFound	Der im Parameter id angegebene Kanal wurde nicht gefunden.

Testen!

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