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
ה-e של המשאב הזה.
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.