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 פיקסלים.
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 מציין שלערוץ יש שידור חי פעיל.