Reports

یک منبع 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 شروع دوره زمانی که نمونه گزارش پوشش می دهد. مقدار شامل یک مهر زمانی در قالب 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 آدرس اینترنتی که می توان گزارش را از آن دانلود کرد. مقدار ویژگی حداکثر 1000 کاراکتر طول دارد. برای بازیابی گزارش، یک درخواست HTTP GET به این URL ارسال کنید. در درخواست، هدر درخواست Authorization HTTP را با استفاده از نشانه مجوز خود به عنوان مقدار سرصفحه تنظیم کنید. با استفاده از gzip با فعال کردن فشرده‌سازی gzip در درخواست‌های دانلود، می‌توانید پهنای باند مورد نیاز برای دانلود گزارش‌ها را کاهش دهید. در حالی که برنامه شما برای فشرده سازی پاسخ های API به زمان CPU بیشتری نیاز دارد، مزایای مصرف کمتر منابع شبکه معمولاً بیشتر از این هزینه است. برای دریافت پاسخ کدگذاری شده با gzip، هدر درخواست HTTP Accept-Encoding همانطور که در مثال زیر نشان داده شده است، روی gzip تنظیم کنید: Accept-Encoding: gzip