משאב report מזהה מופע ספציפי של דוח. המשאב מזהה את התקופה שבה הדוח מכיל נתונים, וגם את כתובת ה-URL שממנה אפשר להוריד את הדוח.
Methods
בטבלה הבאה מפורטות השיטות שה-API תומך בהן עבור משאבי report.
| Methods | |
|---|---|
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תחילת תקופת הזמן שהדוח מכסה. הערך כולל חותמת זמן בפורמט RFC3339 UTC 'Zulu', עם דיוק של מיקרו-שניות. לדוגמה: "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 הזו. בבקשה, מגדירים את כותרת בקשת ה-HTTP Authorization, באמצעות אסימון ההרשאה כערך הכותרת.
שימוש ב-gzip כדי לצמצם את רוחב הפס שנדרש להורדת דוחות, אפשר להפעיל דחיסת נתונים מסוג gzip בבקשות להורדה. האפליקציה תצטרך זמן CPU נוסף כדי לבטל את הדחיסה של התגובות מ-API, אבל בדרך כלל היתרון של צריכת פחות משאבי רשת עולה על העלות הזו. כדי לקבל תשובה עם קידוד gzip, צריך להגדיר את כותרת בקשת ה-HTTP Accept-Encoding: gzip |