משאב report
מזהה מופע ספציפי של דוח. המשאב מזהה את פרק הזמן שבמהלכו הדוח מכיל נתונים, וכן את כתובת האתר שממנה ניתן להוריד את הדוח.
שיטות
הטבלה הבאה מציגה את השיטות הנתמכות על ידי ה-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 סוף תקופת הזמן שנכללת במופע של הדוח. הערך הבלעדי הוא חותמת זמן בפורמט "RFC' 3339 UTC", בהתאמה מדויקת למיקרו-שניות. דוגמה: "2015-10-02T15:01:23.045678Z" |
createTime |
timestamp התאריך והשעה שבהם נוצרה המשרה. ערך המאפיין הוא חותמת זמן בפורמט "Zulu" של RFC3339 UTC, והוא מדויק במיליוניות השנייה. דוגמה: "2015-10-02T15:01:23.045678Z" |
jobExpireTime |
timestamp התאריך והשעה שבהם פג התוקף של המשרה שמשויכת לדוח, או שהתוקף שלה יפוג. ערך המאפיין הוא חותמת זמן בפורמט "Zulu" של RFC3339 UTC, והוא מדויק במיליוניות השנייה. דוגמה: "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 |