Reports

משאב report מזהה מופע ספציפי של דוח. המשאב מזהה את תקופת הזמן שבה הדוח מכיל נתונים, וכן את כתובת ה-URL שממנה ניתן להוריד את הדוח.

שיטות

בטבלה הבאה מוצגות ה-methods שבהן ה-API תומך למשאבי report.

שיטות
get אחזור של המטא-נתונים של דוח ספציפי.
list בתיבת הדו-שיח הזו מפורטים דוחות שנוצרו לצורך משימת הדיווח שצוינה.

ייצוג של משאבי JSON

במבנה ה-JSON הבא מוצג הפורמט של משאב report:

{
  "id": string,
  "jobId": string,
  "startTime": timestamp,
  "endTime": timestamp,
  "createTime": timestamp,
  "jobExpireTime": timestamp,
  "downloadUrl": string
}

מאפיינים

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

מאפיינים
id string
המזהה ש-YouTube מקצה כדי לזהות את הדוח באופן ייחודי. כל דוח משויך למשימה אחת, אבל יכול להיות שהמשימה משויכת להרבה מזהי דוחות.
jobId string
מזהה המשימה שיצרה את הדוח הזה.
startTime timestamp
תחילת תקופת הזמן שנכללת במופע של הדוח. הערך הכולל הוא חותמת זמן לפי 'Zulu' בפורמט RFC3339 UTC בפורמט מדויק למיליוניות השנייה. לדוגמה: "2015-10-02T15:01:23.045678Z".
endTime timestamp
סיום התקופה שנכללת במופע של הדוח. הערך הבלעדי הוא חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט מדויק למיליוניות השנייה. לדוגמה: "2015-10-02T15:01:23.045678Z".
createTime timestamp
התאריך והשעה שבהם המשימה נוצרה. ערך המאפיין הוא חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט מדויק למיליוניות השנייה. לדוגמה: "2015-10-02T15:01:23.045678Z".
jobExpireTime timestamp
התאריך והשעה שבהם פג התוקף של המשימה שמשויכת לדוח או שהתוקף שלה יפוג. ערך המאפיין הוא חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט מדויק למיליוניות השנייה. דוגמה: "2015-10-02T15:01:23.045678Z".

למאפיין הזה יש ערך אם סוג הדוח שמשויך למשימה של הדוח הוצא משימוש או אם דוחות שנוצרו עבור המשימה הזו לא הורדו למשך תקופה ממושכת. הערך הזה מסמן את התאריך שבו מערכת YouTube תפסיק להפיק דוחות חדשים לגבי המשימה.

אם יש לך משימה שמזהה תאריך תפוגה, עליך לעדכן את המערכת כך שתפסיק לבקש את הדוח עד לתאריך הזה. במקרים מסוימים, יכול להיות שיהיה דוח חלופי.
downloadUrl string
כתובת ה-URL שממנה ניתן להוריד את הדוח. האורך המקסימלי של ערך הנכס הוא 1,000 תווים.

כדי לאחזר את הדוח, צריך לשלוח בקשת HTTP של GET לכתובת ה-URL הזו. בבקשה, מגדירים את הכותרת Authorization של בקשת ה-HTTP, ומשתמשים באסימון ההרשאה בתור ערך הכותרת.

באמצעות gzip

כדי לצמצם את רוחב הפס הדרוש להורדת דוחות, אפשר להפעיל דחיסת נתונים מסוג gzip בבקשות הורדה. לאפליקציה שלכם נדרש זמן CPU (מעבד) נוסף כדי לבטל את הדחיסה של תגובות API, אבל היתרון של שימוש בפחות משאבי רשת בדרך כלל גדול יותר מהעלות הזו.

כדי לקבל תגובה בקידוד gzip, צריך להגדיר את כותרת בקשת ה-HTTP Accept-Encoding ל-gzip כמו בדוגמה הבאה:

Accept-Encoding: gzip