VideoCategories: list

מחזירה רשימה של קטגוריות שאפשר לשייך לסרטונים ב-YouTube.

השפעה על המכסה: קריאה ל-method הזה מנצלת יחידה אחת מהמכסה.

תרחישים נפוצים לדוגמה

בקשה

בקשת 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.

גוף הבקשה

כשמפעילים את ה-method הזו, לא צריך לספק גוף בקשה.

תשובה

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

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

מאפיינים

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

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

שגיאות

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

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

רוצה לנסות?

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