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