ChannelSections: list

Gibt eine Liste von channelSection-Ressourcen zurück, die den Kriterien der API-Anfrage 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/channelSections

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 einem oder mehreren Attributen der Ressource channelSection angegeben, die in der API-Antwort enthalten sein sollen.

Wenn der Parameter ein Attribut angibt, das untergeordnete Attribute enthält, werden diese untergeordneten Attribute in die Antwort aufgenommen. In einer channelSection-Ressource enthält das Attribut snippet beispielsweise andere Attribute wie einen Anzeigenamen für den Abschnitt. Wenn Sie part=snippet festlegen, enthält die API-Antwort auch alle diese verschachtelten Attribute.

Die folgende Liste enthält die part Namen, die Sie in den Parameterwert aufnehmen können:
  • contentDetails
  • id
  • snippet
Filter (genau einen der folgenden Parameter angeben)
channelId string
Mit dem Parameter channelId wird eine YouTube-Kanal-ID angegeben. Wenn in einer Anfrage ein Wert für diesen Parameter angegeben wird, gibt die API nur die Abschnitte des angegebenen Kanals zurück.
id string
Mit dem Parameter id wird eine durch Kommas getrennte Liste von IDs angegeben, die die abzurufenden channelSection Ressourcen eindeutig identifizieren. In einer channelSection-Ressource gibt das Attribut id die ID des Abschnitts an.
mine boolean
Dieser Parameter kann nur in einer ordnungsgemäß autorisierten Anfrage verwendet werden. Legen Sie den Wert dieses Parameters auf true fest, um einen Feed der Kanalabschnitte abzurufen, die mit dem YouTube-Kanal des authentifizierten Nutzers verknüpft sind.
Optionale Parameter
hl string
Dieser Parameter wurde eingestellt. Mit dem hl Parameter konnten lokalisierte Metadaten für einen Kanalabschnitt abgerufen werden. Diese Funktion wurde jedoch in YouTube Studio und in der YouTube App eingestellt.
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 onBehalfOfContentOwner Parameter gibt an, dass die Autorisierungsdaten der Anfrage einen YouTube-CMS-Nutzer identifizieren, der im Namen des im Parameterwert angegebenen Contentinhabers handelt. Dieser Parameter ist für YouTube-Contentpartner vorgesehen, die viele verschiedene YouTube-Kanäle besitzen und verwalten. So können sich Rechteinhaber 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-Contentinhaber verknüpft sein.

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#channelSectionListResponse",
  "etag": etag,
  "items": [
    channelSection Resource
  ]
}

Attribute

In der folgenden Tabelle werden die Attribute definiert, die in dieser Ressource angezeigt werden:

Attribute
kind string
Gibt den Typ der API-Ressource an. Der Wert ist youtube#channelSectionListResponse.
etag etag
Das ETag dieser Ressource.
items[] list
Eine Liste von ChannelSections, 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) channelSectionForbidden Der Anfragende hat keinen Zugriff auf die angeforderten Kanalabschnitte.
invalidValue (400) idInvalid Die Anfrage gibt eine ungültige Kanalabschnitts-ID an.
invalidValue (400) invalidCriteria Die Anfrage konnte nicht abgeschlossen werden, da die Filterkriterien ungültig sind.
notFound (404) channelNotFound Der mit der Anfrage verknüpfte Kanal wurde nicht gefunden.
notFound (404) channelSectionNotFound Der mit der Anfrage verknüpfte Kanalabschnitt wurde nicht gefunden.

Testen!

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