يحدد مورد 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 على طلبات التنزيل. على الرغم من أن التطبيق سيحتاج إلى وقت إضافي في وحدة المعالجة المركزية لفك ضغط استجابات واجهة برمجة التطبيقات، تفوق عادةً الاستفادة من استهلاك موارد شبكة أقل هذه التكلفة. لتلقّي استجابة بترميز gzip، اضبط عنوان طلب HTTP Accept-Encoding: gzip |