Search

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

שיטות

ה-API תומך בשיטות החיפוש הבאות:

list

מחזיר אוסף של תוצאות חיפוש שתואמות לפרמטרים של השאילתה שצוינו בבקשת ה-API. כברירת מחדל, קבוצת תוצאות חיפוש מזהה התאמה של משאבים video, channel ו-playlist, אבל ניתן גם להגדיר שאילתות כך שיאחזרו רק סוג ספציפי של משאב. רוצים לנסות עכשיו?

ייצוג משאבים

מבנה ה-JSON הבא מציג את הפורמט של תוצאת חיפוש:

{
  "kind": "youtube#searchResult",
  "etag": etag,
  "id": {
    "kind": string,
    "videoId": string,
    "channelId": string,
    "playlistId": string
  },
  "snippet": {
    "publishedAt": datetime,
    "channelId": string,
    "title": string,
    "description": string,
    "thumbnails": {
      (key): {
        "url": string,
        "width": unsigned integer,
        "height": unsigned integer
      }
    },
    "channelTitle": string,
    "liveBroadcastContent": string
  }
}

תכונות

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

תכונות
kind	string מזהה את הסוג של משאב ה-API. הערך יהיה youtube#searchResult.
etag	etag ה-e של המשאב הזה.
id	object האובייקט id מכיל מידע שיכול לשמש לזיהוי ייחודי של המשאב שתואם לבקשת החיפוש.
id.kind	string הסוג של משאב ה-API.
id.videoId	string אם ערך הנכס ב-id.type הוא youtube#video, הנכס הזה יוצג והערך שלו יכיל את המזהה שמשמש את YouTube לזיהוי ייחודי של סרטון שתואם לשאילתת החיפוש.
id.channelId	string אם ערך הנכס ב-id.type הוא youtube#channel, הנכס הזה יוצג והערך שלו יכיל את המזהה שמשמש את YouTube לזיהוי ייחודי של ערוץ שתואם לשאילתת החיפוש.
id.playlistId	string אם הערך של הנכס ב-id.type הוא youtube#playlist, הנכס הזה יוצג והערך שלו יכיל את המזהה שמשמש את YouTube לזיהוי ייחודי של פלייליסט שתואם לשאילתת החיפוש.
snippet	object האובייקט snippet מכיל פרטים בסיסיים על תוצאת חיפוש, כמו הכותרת או התיאור שלה. לדוגמה, אם תוצאת החיפוש היא סרטון, הכותרת תהיה שם הסרטון והתיאור יהיה התיאור של הסרטון.
snippet.publishedAt	datetime התאריך והשעה של יצירת המשאב שתוצאת החיפוש מזהה. הערך מצוין בפורמט ISO 8601.
snippet.channelId	string הערך שמשמש את YouTube לזיהוי ייחודי של הערוץ שפרסם את המשאב שזוהה בתוצאת החיפוש.
snippet.title	string הכותרת של תוצאת החיפוש.
snippet.description	string תיאור של תוצאת החיפוש.
snippet.thumbnails	object מפה של תמונות ממוזערות שמשויכות לתוצאת החיפוש. עבור כל אובייקט במפה, המפתח הוא השם של התמונה הממוזערת והערך הוא אובייקט שמכיל מידע נוסף על התמונה הממוזערת.
snippet.thumbnails.(key)	object ערכי המפתח החוקיים הם: default – התמונה הממוזערת המוגדרת כברירת מחדל. התמונה הממוזערת המוגדרת כברירת מחדל של סרטון – או משאב שמפנה לסרטון, כמו פריט בפלייליסט או תוצאת חיפוש – היא ברוחב של 120 פיקסלים ובגובה של 90 פיקסלים. התמונה הממוזערת שמוגדרת כברירת מחדל לערוץ היא ברוחב 88 פיקסלים וגובה של 88 פיקסלים. medium – גרסה של התמונה הממוזערת ברזולוציה גבוהה יותר. לסרטון (או למקור מידע שמפנה לסרטון), רוחב התמונה הוא 320 פיקסלים וגובהה הוא 180 פיקסלים. כשמדובר בערוץ, התמונה הזו היא ברוחב של 240 פיקסלים ובגובה של 240 פיקסלים. high – גרסה של התמונה הממוזערת ברזולוציה גבוהה. לסרטון (או משאב שמפנה לסרטון), רוחב התמונה הוא 480 פיקסלים וגובהה הוא 360 פיקסלים. כשמדובר בערוץ, התמונה הזו היא ברוחב של 800 פיקסלים ובגובה של 800 פיקסלים. standard – גרסה ברזולוציה גבוהה עוד יותר של התמונה הממוזערת מזו של התמונה ברזולוציה של high. התמונה הזו זמינה לסרטונים מסוימים ולמקורות מידע אחרים שקשורים לסרטונים, כמו פריטים בפלייליסט או תוצאות חיפוש. רוחב התמונה הוא 640 פיקסלים וגובהה הוא 480 פיקסלים. maxres – הגרסה ברזולוציה הגבוהה ביותר של התמונה הממוזערת. גודל התמונה הזה זמין לסרטונים מסוימים ולמשאבים אחרים שמתייחסים לסרטונים, כמו פריטים בפלייליסט או תוצאות חיפוש. הרוחב של התמונה הזו הוא 1,280 פיקסלים וגובה של 720 פיקסלים.
snippet.thumbnails.(key).url	string כתובת ה-URL של התמונה.
snippet.thumbnails.(key).width	unsigned integer רוחב התמונה.
snippet.thumbnails.(key).height	unsigned integer גובה התמונה.
snippet.channelTitle	string שם הערוץ שפרסם את המשאב שזוהה בתוצאות החיפוש.
snippet.liveBroadcastContent	string אינדיקציה אם למשאב video או למשאב channel יש תוכן שמשודר בשידור חי. ערכי הנכס החוקיים הם upcoming, live ו-none. למשאב video, הערך upcoming מציין שהסרטון הוא שידור חי שעדיין לא התחיל, ואילו ערך של live מציין שהסרטון הוא שידור חי פעיל. למשאב channel, הערך upcoming מציין שלערוץ יש שידור מתוזמן שעדיין לא התחיל, ואילו ערך של live מציין שלערוץ יש שידור חי פעיל.