GuideCategories: list

Hinweis: Dies ist eine Ankündigung zur Einstellung.

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

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

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

Anfragen

HTTP-Anfrage

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

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 die Attribute der guideCategory-Ressource an, die die API-Antwort enthalten soll. Legen Sie den Parameterwert auf snippet fest.
Filter (geben Sie genau einen der folgenden Parameter an)
id string
Der Parameter id gibt eine durch Kommas getrennte Liste der YouTube-Kanalkategorie-IDs für die abgerufene Ressource an. In einer guideCategory-Ressource gibt die Eigenschaft id die Kategorie-ID des YouTube-Kanals an.
regionCode string
Mit dem Parameter regionCode wird die API angewiesen, eine Liste der im angegebenen Land verfügbaren Guide-Kategorien zurückzugeben. Der Parameterwert ist ein ISO 3166-1 alpha-2-Ländercode.
Optionale Parameter
hl string
Der Parameter hl gibt die Sprache an, 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 angezeigt werden:

Attribute
kind string
Identifiziert den Typ der API-Ressource. 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 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 Kategorien, die YouTube-Kanälen zugeordnet werden können. In dieser Zuordnung ist die Kategorie-ID der Zuordnungsschlüssel und ihr Wert ist die entsprechende guideCategory-Ressource.

Fehler

In der folgenden Tabelle sind Fehlermeldungen aufgeführt, 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
notFound (404) notFound Die durch den Parameter id angegebene Guide-Kategorie wurde nicht gefunden. Verwenden Sie die Methode guideCategories.list, um eine Liste gültiger Werte abzurufen.

Jetzt testen

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