Activities: list

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

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

ההשפעה של המכסה: לקריאה לשיטה הזו יש עלות מכסה של יחידה אחת.

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

בקשה

בקשת HTTP

GET https://www.googleapis.com/youtube/v3/activities

פרמטרים

בטבלה הבאה מפורטים הפרמטרים שהשאילתה הזו תומכת בהם. כל הפרמטרים המפורטים הם פרמטרים של שאילתות.

פרמטרים
הפרמטרים הנדרשים
part string
הפרמטר part מציין רשימה מופרדת בפסיקים של מאפייני משאב activity אחד או יותר שייכללו בתגובה של ה-API.

אם הפרמטר מזהה נכס שמכיל נכסי צאצא, מאפייני הצאצאים ייכללו בתגובה. לדוגמה, במשאב activity, המאפיין snippet מכיל מאפיינים אחרים שמזהים את סוג הפעילות, כותרת לתצוגה של הפעילות וכן הלאה. אם מגדירים את part=snippet, תגובת ה-API תכלול גם את כל המאפיינים המקוננים.

הרשימה הבאה מכילה את השמות מסוג part שניתן לכלול בערך הפרמטר:
  • contentDetails
  • id
  • snippet
מסננים (יש לציין בדיוק אחד מהפרמטרים הבאים)
channelId string
הפרמטר channelId מציין מזהה ייחודי של ערוץ YouTube. לאחר מכן, ממשק ה-API יחזיר רשימה של הפעילויות של אותו ערוץ.
home boolean
הערה: הפרמטר הזה הוצא משימוש.
בבקשות שמגדירות את הפרמטר הזה, תגובת ה-API מכילה פריטים שדומים לאלה שמוצגים בדף הבית של YouTube כשמשתמש לא מחובר. חשוב לזכור שאפשר להשתמש בפרמטר הזה רק במסגרת בקשה מורשית כראוי.
mine boolean
ניתן להשתמש בפרמטר הזה רק במסגרת בקשה מורשית תקינה. מגדירים את ערך הפרמטר הזה ל-true כדי לאחזר פיד של פעילויות המשתמש המאומת.
פרמטרים אופציונליים
maxResults unsigned integer
הפרמטר maxResults מציין את מספר הפריטים המקסימלי שצריך להחזיר בקבוצת התוצאות. הערכים הקבילים הם 0 עד 50, כולל. ערך ברירת המחדל הוא 5.
pageToken string
הפרמטר pageToken מזהה דף ספציפי בקבוצת התוצאות שצריך להחזיר. בתגובת ה-API, המאפיינים nextPageToken ו-prevPageToken מזהים דפים אחרים שניתן לאחזר.
publishedAfter datetime
הפרמטר publishedAfter מציין את התאריך והשעה המוקדמים ביותר שבהם יכולה להתרחש פעילות כדי שהפעילות הזו תיכלל בתגובת ה-API. אם ערך הפרמטר מציין יום אבל לא שעה, כל הפעילויות שהתרחשו באותו יום ייכללו בקבוצת התוצאות. הערך מצוין בפורמט ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).
publishedBefore datetime
הפרמטר publishedBefore מציין את התאריך והשעה שבהם צריכה להתרחש פעילות כדי שהפעילות תיכלל בתגובת ה-API. אם ערך הפרמטר מציין יום אבל לא שעה, הפעילויות שהתרחשו באותו יום לא ייכללו בקבוצת התוצאות. הערך מצוין בפורמט ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).
regionCode string
הפרמטר regionCode מורה ל-API להחזיר תוצאות למדינה שצוינה. ערך הפרמטר הוא קוד מדינה לפי תקן ISO 3166-1 alpha-2. המערכת של YouTube משתמשת בערך הזה כשהפעילות הקודמת של המשתמש המורשה ב-YouTube לא מספקת מספיק מידע כדי ליצור את פיד הפעילות.

גוף הבקשה

אין לציין את גוף הבקשה בקריאה לשיטה הזו.

תשובה

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

{
  "kind": "youtube#activityListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    activity Resource
  ]
}

תכונות

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

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

שגיאות

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

סוג השגיאה פרטי השגיאה תיאור
forbidden (403) forbidden הבקשה לא מורשית כראוי.
forbidden (403) homeParameterDeprecated נתוני הפעילות בדף הבית של המשתמש לא זמינים דרך ה-API הזה. השגיאה הזו יכולה להתרחש אם מגדירים את הפרמטר home לערך true במסגרת בקשה לא מורשית.
notFound (404) channelNotFound לא ניתן למצוא את מזהה הערוץ שזוהה על ידי הפרמטר channelId של הבקשה.
notFound (404) homeChannelNotFound לא ניתן למצוא פיד של דף בית ב-YouTube למשתמש המאומת הנוכחי.
unauthorized (401) authorizationRequired הבקשה משתמשת בפרמטר home אבל אין לה הרשאה כראוי.

רוצה לנסות?

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