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
התג של המשאב הזה.
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 ואת התשובה.