تتيح لك "واجهة برمجة تطبيقات إحصاءات YouTube" استرداد بيانات "إحصاءات YouTube" لقناة على YouTube أو مالك محتوى. تتيح واجهة برمجة التطبيقات طلبات البحث في الوقت الفعلي وتُنشئ تقريرًا استنادًا إلى مَعلمات طلب البيانات من واجهة برمجة التطبيقات.
تتيح واجهة برمجة التطبيقات نوعَين من الدوالّ:
-
استرداد التقارير: تستردّ طريقة
reports.queryفي واجهة برمجة التطبيقات تقارير "إحصاءات YouTube". -
إدارة المجموعات في "إحصاءات YouTube": مجموعة "إحصاءات YouTube" هي مجموعة مخصّصة تضمّ ما يصل إلى 500 قناة أو فيديو أو قائمة تشغيل أو مادة عرض. تتيح واجهة برمجة التطبيقات العديد من الطرق لإنشاء مجموعات "إحصاءات YouTube" واستردادها وتعديلها. يمكن بعد ذلك لمالكي القنوات والمحتوى استخدام طريقة
reports.queryلاسترداد البيانات المجمّعة لجميع العناصر في مجموعة، ما قد يساعد في تحليل الأداء.
تقدّم هذه الصفحة نظرة عامة موجزة على موارد واجهة برمجة التطبيقات والأساليب التي تتيح استخدام هذه الدوال.
التفويض
يجب أن يتم السماح بإرسال جميع طلبات البيانات من YouTube Analytics API. يوضّح دليل التفويض كيفية استخدام بروتوكول OAuth 2.0 لاسترداد الرموز المميّزة للتفويض.
تستخدِم طلبات البيانات من "واجهة برمجة تطبيقات YouTube Analytics" نطاقات التفويض التالية:
| المستويات | |
|---|---|
| https://www.googleapis.com/auth/yt-analytics.readonly | عرض تقارير "إحصاءات YouTube" للمحتوى في YouTube يمنح هذا النطاق إمكانية الوصول إلى مقاييس نشاط المستخدمين، مثل أعداد المشاهدات وأعداد التقييمات. |
| https://www.googleapis.com/auth/yt-analytics-monetary.readonly | عرض تقارير "إحصاءات YouTube" المالية للمحتوى في YouTube يمنح هذا النطاق إمكانية الوصول إلى مقاييس نشاط المستخدِم ومقاييس الأرباح المقدَّرة وأداء الإعلانات. |
| https://www.googleapis.com/auth/youtube | إدارة حسابك على YouTube في YouTube Analytics API، يستخدم مالكو القنوات هذا النطاق لإدارة المجموعات والعناصر المجمّعة في "إحصاءات YouTube". |
| https://www.googleapis.com/auth/youtubepartner | عرض وإدارة مواد عرض YouTube والمحتوى المرتبط بها على YouTube في YouTube Analytics API، يستخدم مالكو المحتوى هذا النطاق لإدارة المجموعات والعناصر المجمّعة في "إحصاءات YouTube". |
استرداد التقارير
تتيح لك طريقة reports.query في واجهة برمجة التطبيقات استرداد العديد من تقارير "إحصاءات YouTube" المختلفة. يستخدم كل طلب مَعلمات طلب بحث لتحديد معرّف قناة أو مالك محتوى وتاريخ بدء وتاريخ انتهاء ومقياس واحد على الأقل. يمكنك أيضًا تقديم مَعلمات طلب بحث إضافية، مثل السمات والفلاتر وتعليمات الترتيب.
| الطريقة | طلب HTTP | الوصف |
|---|---|---|
معرّفات الموارد المنتظمة (URI) ذات الصلة بـ https://youtubeanalytics.googleapis.com/v2 |
||
query |
GET /reports |
استرداد تقرير في "إحصاءات YouTube" يستخدم كل طلب واجهة برمجة تطبيقات مَعلمات طلب البحث لتحديد رقم تعريف القناة أو مالك المحتوى وتاريخ البدء وتاريخ الانتهاء ومقياس واحد على الأقل. يمكنك أيضًا تقديم مَعلمات طلب بحث إضافية، مثل السمات أو الفلاتر أو تعليمات الترتيب.
|
إدارة المجموعة
توفّر واجهة برمجة التطبيقات مرجعَين لإنشاء مجموعات "إحصاءات YouTube" وإدارتها:
Groups
يمثّل مرجع group مجموعة في "إحصاءات YouTube"، وهي مجموعة مخصّصة تضمّ ما يصل إلى 500 قناة أو فيديو أو قائمة تشغيل أو مادة عرض.
يجب أن تمثّل جميع العناصر في المجموعة النوع نفسه من الموارد. على سبيل المثال، لا يمكنك إنشاء مجموعة تحتوي على 100 فيديو و100 قائمة تشغيل.
لا يمكن أن تحتوي مجموعة "إحصاءات YouTube" إلا على المراجع التي حمّلتها أو طالبت بملكيتها أو التي تم ربطها بقناة تديرها. نتيجةً لذلك، يمكن لمالكي القنوات إنشاء مجموعات من الفيديوهات وقوائم التشغيل. يمكن لمالكي المحتوى إنشاء مجموعات من الفيديوهات أو قوائم التشغيل أو القنوات أو مواد العرض.
لمزيد من المعلومات عن هذا المرجع، اطّلِع على تمثيل المرجع وقائمة السمات.
| الطريقة | طلب HTTP | الوصف |
|---|---|---|
معرّفات الموارد المنتظمة (URI) ذات الصلة بـ https://youtubeanalytics.googleapis.com/v2 |
||
list |
GET /groups |
تُرجِع قائمة بالمجموعات التي تتطابق مع مَعلمات طلب واجهة برمجة التطبيقات. على سبيل المثال، يمكنك استرداد جميع المجموعات التي يملكها المستخدم الذي تمّت مصادقة هويته، أو يمكنك استرداد مجموعة واحدة أو أكثر من خلال أرقام تعريفها الفريدة. |
insert |
POST /groups |
لإنشاء مجموعة في "إحصاءات YouTube" بعد إنشاء مجموعة، استخدِم الطريقة groupItems.insert لإضافة عناصر إلى المجموعة. |
update |
PUT /groups |
تعديل البيانات الوصفية لمجموعة في الوقت الحالي، السمة الوحيدة التي يمكن تعديلها هي عنوان المجموعة. (استخدِم groupItems.insert وgroupItems.delete لإضافة عناصر المجموعة وإزالتها). |
delete |
DELETE /groups |
حذف مجموعة |
GroupItems
يمثّل مورد groupItem عنصرًا في مجموعة "إحصاءات YouTube".
لمزيد من المعلومات عن هذا المرجع، اطّلِع على تمثيل المرجع وقائمة السمات.
| الطريقة | طلب HTTP | الوصف |
|---|---|---|
معرّفات الموارد المنتظمة (URI) ذات الصلة بـ https://youtubeanalytics.googleapis.com/v2 |
||
list |
GET /groupItems |
تعرِض هذه الدالة مجموعة من عناصر المجموعة التي تتطابق مع مَعلمات طلب البيانات من واجهة برمجة التطبيقات. |
insert |
POST /groupItems |
لإنشاء عنصر مجموعة |
delete |
DELETE /groupItems |
إزالة عنصر من مجموعة |