Reports

يحدّد مورد report نسخةً معيّنة من تقرير. يحدد المورد الفترة الزمنية التي يحتوي فيها التقرير على بيانات بالإضافة إلى عنوان URL الذي يمكن تنزيل التقرير منه.

الطُرق

يعرض الجدول التالي الطرق التي تتيحها واجهة برمجة التطبيقات لموارد 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 عنوان URL الذي يمكن تنزيل التقرير منه. الحد الأقصى لطول قيمة الموقع هو 1000 حرف.

لاسترداد التقرير، أرسِل طلب HTTP GET إلى عنوان URL هذا. في الطلب، اضبط عنوان طلب HTTP Authorization باستخدام الرمز المميّز للتفويض كقيمة العنوان.

استخدام برنامج gzip

يمكنك تقليل معدل نقل البيانات اللازم لتنزيل التقارير عن طريق تمكين ضغط gzip في طلبات التنزيل. على الرغم من أنّ تطبيقك يحتاج إلى وقت إضافي لوحدة المعالجة المركزية (CPU) لفك ضغط استجابات واجهة برمجة التطبيقات، فإنّ فائدة استهلاك موارد شبكة أقل عادةً تفوق تلك التكلفة.

لتلقّي استجابة بترميز gzip، اضبط عنوان طلب HTTP Accept-Encoding على gzip كما هو موضَّح في المثال التالي:

Accept-Encoding: gzip