GuideCategories: list

Hinweis: Dies ist eine Einstellungsankündigung.

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

Gibt eine Liste der Kategorien zurück, die mit YouTube-Kanälen verknüpft werden können.

Auswirkungen auf Kontingente: Bei einem Aufruf dieser Methode fallen Kontingentkosten von 1 Einheit an.

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 guideCategory-Ressourcenattribute an, die die API-Antwort enthalten soll. Legen Sie den Parameterwert auf snippet fest.
Filter (genau einen der folgenden Parameter angeben)
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 die Property id die ID der YouTube-Kanalkategorie an.
regionCode	string Mit dem Parameter regionCode wird die API angewiesen, die Liste der im angegebenen Land verfügbaren Übersichtskategorien 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 im Ergebnissatz abzurufen.
prevPageToken	string Das Token, das als Wert des Parameters pageToken verwendet werden kann, um die vorherige Seite im Ergebnissatz abzurufen.
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 Kategorien, die mit YouTube-Kanälen verknüpft werden können. In dieser Zuordnung ist die Kategorie-ID der Kartenschlüssel und ihr Wert die entsprechende guideCategory-Ressource.

Fehler

Die folgende Tabelle enthält Fehlermeldungen, 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
notFound (404)	notFound	Die vom Parameter id angegebene Guide-Kategorie wurde nicht gefunden. Mit der Methode guideCategories.list rufen Sie eine Liste gültiger Werte ab.

Testen!

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