YouTube Reporting API

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

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

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

التفويض

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

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

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

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

تقدّم الأقسام التالية أوصافًا عامة لموارد واجهة برمجة التطبيقات وطرقها. ترتبط جميع معرّفات الموارد المنتظمة (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
تعرض هذه السمة التقارير التي تم إنشاؤها لمهمة إعداد التقارير المحدّدة.

reportTypes

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