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 כדי ליצור את פיד הפעילות.

גוף הבקשה

אל תספקו גוף בקשה כשאתם קוראים ל-method הזו.

תשובה

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

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

מאפיינים

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

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

שגיאות

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

סוג השגיאה פרטי השגיאה תיאור
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 והתגובה.