GuideCategories: list

Hinweis:Dies ist eine Ankündigung zur Einstellung.

Die guideCategories-Ressource und die guideCategories.list-Methode wurden am 9. September 2020 eingestellt.

Gibt eine Liste von Kategorien zurück, die YouTube-Kanälen zugewiesen werden können.

Kontingentbelastung:Ein Aufruf dieser Methode hat Kontingentkosten von 1 Einheit.

Anfrage

HTTP-Anfrage

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

Parameter

In der Tabelle unten 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 werden die Attribute der guideCategory-Ressource angegeben, die in der API-Antwort enthalten sein sollen. Legen Sie den Parameterwert auf snippet fest.
Filter (genau einer der folgenden Parameter muss angegeben werden)
id string
Der Parameter id gibt eine durch Kommas getrennte Liste der YouTube-Kanalkategorie-IDs für die abgerufenen Ressourcen an. In einer guideCategory-Ressource gibt das Attribut id die ID der YouTube-Kanal-Kategorie an.
regionCode string
Mit dem Parameter regionCode wird die API angewiesen, die Liste der im angegebenen Land verfügbaren Guide-Kategorien zurückzugeben. Der Parameterwert ist ein Ländercode gemäß ISO 3166-1 alpha-2.
Optionale Parameter
hl string
Mit dem Parameter hl wird die Sprache angegeben, die für Textwerte in der API-Antwort verwendet wird. Der Standardwert ist en-US.

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#guideCategoryListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    guideCategory resource
  ]
}

Attribute

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

Attribute
kind string
Gibt den Typ der API-Ressource an. Der Wert ist youtube#guideCategoryListResponse.
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 in der Ergebnismenge abzurufen.
pageInfo object
Das pageInfo-Objekt enthält Paging-Informationen für das Ergebnis-Set.
pageInfo.totalResults integer
Die Gesamtzahl der Ergebnisse im Ergebnissatz.
pageInfo.resultsPerPage integer
Die Anzahl der in der API-Antwort enthaltenen Ergebnisse.
items[] list
Eine Liste von Kategorien, die YouTube-Kanälen zugeordnet werden können. In dieser Zuordnung ist die Kategorie-ID der Zuordnungsschlüssel und der Wert die entsprechende guideCategory-Ressource.

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 zur Fehlermeldung.

Fehlertyp Fehlerdetails Beschreibung
notFound (404) notFound Die mit dem Parameter id angegebene Kategorie für die Anleitung wurde nicht gefunden. Mit der Methode guideCategories.list können Sie eine Liste der gültigen Werte abrufen.

Testen!

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