Search

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

Methods

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

הערה: אי אפשר להשתמש בתמונות הממוזערות ברזולוציה של 1080p ומעלה (fhd,‏ qhd ו-uhd) בתוצאות החיפוש. כדי לאחזר תמונות ממוזערות ברזולוציה גבוהה יותר, צריך להתקשר לנקודת הקצה הספציפית למשאב (למשל videos.list) באמצעות מזהה המשאב.
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 מציין שיש בערוץ שידור חי פעיל.