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 התג של המשאב הזה.
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 – הגרסה ברזולוציה הגבוהה ביותר של התמונה הממוזערת. גודל תמונה זה זמין לסרטונים מסוימים ולמשאבים אחרים הקשורים לסרטונים, כגון פריטים בפלייליסט או תוצאות חיפוש. התמונה ברוחב 1280 פיקסלים ובגובה 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 מציין שיש לערוץ שידור חי פעיל.