GuideCategories: list

הערה: זוהי הודעה על הוצאה משימוש.

המשאב guideCategories והשיטה guideCategories.list הוצאו משימוש ב-9 בספטמבר 2020.

הפונקציה מחזירה רשימה של קטגוריות שאפשר לשייך לערוצי YouTube.

השפעה על המכסה: לכל קריאה לשיטה הזו יש עלות מכסה של יחידה אחת.

בקשה

בקשת HTTP

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

פרמטרים

בטבלה הבאה מפורטים הפרמטרים שהשאילתה הזו תומכת בהם. כל הפרמטרים שמופיעים ברשימה הם פרמטרים של שאילתה.

פרמטרים
פרמטרים נדרשים
part ‫string
הפרמטר part מציין את מאפייני המשאב guideCategory שייכללו בתגובת ה-API. מגדירים את ערך הפרמטר ל-snippet.
מסננים (צריך לציין בדיוק אחד מהפרמטרים הבאים)
id string
הפרמטר id מציין רשימה מופרדת בפסיקים של מזהי קטגוריות של ערוצי YouTube עבור המשאבים שאותם מאחזרים. במשאב guideCategory, המאפיין id מציין את מזהה הקטגוריה של ערוץ YouTube.
regionCode string
הפרמטר regionCode מורה ל-API להחזיר את רשימת הקטגוריות של המדריך שזמינות במדינה שצוינה. ערך הפרמטר הוא קוד מדינה לפי ISO 3166-1 alpha-2.
פרמטרים אופציונליים
hl ‫string
הפרמטר hl מציין את השפה שתשמש לערכי טקסט בתגובת ה-API. ערך ברירת המחדל הוא en-US.

גוף הבקשה

כשקוראים לשיטה הזו, לא צריך לספק גוף בקשה.

תשובה

אם הפעולה בוצעה ללא שגיאות, השיטה הזו מחזירה גוף תגובה עם המבנה הבא:

{
  "kind": "youtube#guideCategoryListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    guideCategory resource
  ]
}

מאפיינים

בטבלה הבאה מוגדרים המאפיינים שמופיעים במשאב הזה:

מאפיינים
kind ‫string
מזהה את סוג משאב ה-API. הערך יהיה youtube#guideCategoryListResponse.
etag etag
ה-Etag של מקור המידע הזה.
nextPageToken ‫string
האסימון שאפשר להשתמש בו כערך של הפרמטר pageToken כדי לאחזר את הדף הבא בקבוצת התוצאות.
prevPageToken ‫string
הטוקן שאפשר להשתמש בו כערך של הפרמטר pageToken כדי לאחזר את הדף הקודם בקבוצת התוצאות.
pageInfo ‫object
האובייקט pageInfo כולל מידע על חלוקת התוצאות לדפים.
pageInfo.totalResults integer
המספר הכולל של התוצאות בקבוצת התוצאות.
pageInfo.resultsPerPage integer
מספר התוצאות שכלולות בתגובת ה-API.
items[] list
רשימה של קטגוריות שאפשר לשייך לערוצי YouTube. במיפוי הזה, מזהה הקטגוריה הוא מפתח המיפוי, והערך שלו הוא משאב guideCategory התואם.

שגיאות

בטבלה הבאה מפורטות הודעות השגיאה שממשק ה-API יכול להחזיר בתגובה לקריאה לשיטה הזו. אפשר לקרוא פרטים נוספים במסמכים בנושא הודעות שגיאה.

סוג השגיאה פרטי השגיאה תיאור
notFound (404) notFound לא ניתן למצוא את קטגוריית המדריך שצוינה בפרמטר id. אפשר להשתמש בשיטה guideCategories.list כדי לאחזר רשימה של ערכים תקינים.

נסה בעצמך!

משתמשים ב-APIs Explorer כדי להפעיל את ה-API הזה ולראות את הבקשה והתגובה של ה-API.