YouTube Reporting API

تتيح "واجهة برمجة التطبيقات لإعداد التقارير في YouTube" لمطوّري البرامج إمكانية جدولة مهام إعداد التقارير ثم تنزيل التقارير المجمّعة التي تم إنشاؤها. تدعم واجهة برمجة التطبيقات مجموعة من التقارير المحددة مسبقًا، يحتوي كل منها على مجموعة شاملة من بيانات YouTube Analytics لقناة أو مالك محتوى.

توضح الخطوات التالية كيفية جدولة مهام إعداد التقارير واسترداد التقارير:

  1. يمكنك استدعاء الطريقة reportTypes.list() لاسترداد قائمة التقارير التي يمكن لمالك القناة أو مالك المحتوى استردادها.
  2. يُرجى استخدام طريقة jobs.create() لتحديد تقرير يجب إنشاؤه لقناة أو مالك محتوى. يمكنك فيما بعد استخدام jobs.list() وjobs.delete() لواجهة برمجة التطبيقات لاسترداد قائمة التقارير التي يتم إنشاؤها أو تغييرها.
  3. يمكنك استدعاء الطريقة jobs.reports.list() لاسترداد قائمة التقارير التي تم إنشاؤها لوظيفة معينة. يحتوي كل مورد في الاستجابة على الخاصية downloadUrl التي تحدّد عنوان URL الذي يمكن تنزيل التقرير منه.
  4. أرسِل طلب GET معتمدًا لاسترداد التقرير من عنوان URL للتنزيل.

التفويض

يجب أن يتم السماح بعرض جميع طلبات البيانات من واجهة برمجة التطبيقات لإعداد التقارير في YouTube. يوضح دليل التفويض كيفية استخدام بروتوكول OAuth 2.0 لاسترداد الرموز المميزة للتفويض.

تستخدم طلبات البيانات من YouTube Reporting API نطاقات التفويض التالية:

المناظير
https://www.googleapis.com/auth/yt-analytics.readonly عرض تقارير YouTube Analytics للمحتوى في YouTube. يوفر هذا النطاق الوصول إلى مقاييس نشاط المستخدم، مثل عدد المشاهدات وأعداد التقييمات.
https://www.googleapis.com/auth/yt-analytics-monetary.readonly عرض تقارير YouTube Analytics المالية للمحتوى في YouTube. ويوفّر هذا النطاق إمكانية الوصول إلى مقاييس نشاط المستخدم وإلى مقاييس الأرباح وأداء الإعلان المقدّرة.

أنواع الموارد

تقدم الأقسام التالية أوصافًا عامة لموارد API وأساليبها. ترتبط كل معرِّفات الموارد المنتظمة (URI) للطريقة المعروضة في الجداول بـ https://youtubereporting.googleapis.com.

الوظائف

الطُرق
create POST /v1/jobs
ينشئ مهمة إعداد تقارير. من خلال إنشاء مهمة إعداد التقارير، فإنك توجّه YouTube إلى إنشاء هذا التقرير بشكلٍ يومي. يكون التقرير متاحًا خلال 24 ساعة من وقت إنشاء الوظيفة.
delete DELETE /v1/jobs/{jobId}
لحذف مهمة إعداد تقارير.
get GET /v1/jobs/{jobId}
تسترد هذه الميزة معلومات عن مهمة معيّنة في إعداد التقارير تمت جدولتها لقناة أو مالك محتوى.
list GET /v1/jobs
يعرض قوائم بالمهام التي تمّت جدولتها لقناة أو مالك محتوى. يتضمّن كل مورد في الاستجابة خاصية id التي تحدّد المعرّف الذي يستخدمه YouTube لتعريف الوظيفة بشكل فريد. تحتاج إلى ذلك المعرّف لاسترداد قائمة التقارير التي تم إنشاؤها للوظيفة أو لحذف الوظيفة.

jobs.reports

الطُرق
get GET /v1/jobs/{jobId}/reports/{reportId}
لاسترداد البيانات الوصفية لتقرير معيّن.
list GET /v1/jobs/{jobId}/reports
يسرد التقارير التي تم إنشاؤها لوظيفة إعداد التقارير المحدَّدة.

نوع التقارير

الطُرق
list GET /v1/reportTypes
لعرض قائمة بأنواع التقارير التي يمكن للقناة أو مالك المحتوى استردادها.