VideoCategories: list

מחזירה רשימה של קטגוריות שניתן לשייך לסרטוני YouTube.

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

תרחישים נפוצים

שליחת בקשה

בקשת HTTP

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

פרמטרים

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

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

גוף הבקשה

אין להזין גוף בקשה בעת הפעלת שיטה זו.

תשובה

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

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

נכסים

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

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

שגיאות

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

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

רוצה לנסות?

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