Gibt eine Liste von channelSection
-Ressourcen zurück, die den API-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/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 Der Parameter part gibt eine durch Kommas getrennte Liste mit einer oder mehreren channelSection -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 channelSection -Ressource enthält die Property snippet beispielsweise andere Attribute, z. B. einen Anzeigetitel für den Abschnitt. Wenn du part=snippet festlegst, enthält die API-Antwort auch alle diese verschachtelten Attribute.Die folgende Liste enthält die part -Namen, die du in den Parameterwert aufnehmen kannst:
|
|
Filter (genau einen der folgenden Parameter angeben) | ||
channelId |
string Der Parameter channelId gibt eine YouTube-Kanal-ID an. Wenn eine Anfrage einen Wert für diesen Parameter angibt, gibt die API nur die Abschnitte des angegebenen Kanals zurück. |
|
id |
string Der Parameter id gibt eine durch Kommas getrennte Liste von IDs an, die die abgerufenen channelSection -Ressourcen eindeutig identifizieren. In einer channelSection -Ressource gibt die Property id die ID des Bereichs an. |
|
mine |
boolean Dieser Parameter kann nur in einer ordnungsgemäß autorisierten Anfrage verwendet werden. Setze den Wert dieses Parameters auf true , 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. Der Parameter hl unterstützt das Abrufen lokalisierter Metadaten für einen Kanalabschnitt. Diese Funktion wurde 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-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. |
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 Identifiziert den Typ der API-Ressource. Der Wert ist youtube#channelSectionListResponse . |
etag |
etag Das ETag dieser Ressource. |
items[] |
list Eine Liste der ChannelSection-Bereiche, 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 |
---|---|---|
forbidden (403) |
channelSectionForbidden |
Der Antragsteller hat keinen Zugriff auf die angeforderten Kanalabschnitte. |
invalidValue (400) |
idInvalid |
In der Anfrage ist eine ungültige Kanalabschnitts-ID angegeben. |
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!
Verwenden Sie APIs Explorer, um diese API aufzurufen und die API-Anfrage und -Antwort anzusehen.