Groups: list

لعرض قائمة بالمجموعات التي تطابق معلمات طلب واجهة برمجة التطبيقات. مثلاً، يمكنك استرداد جميع المجموعات التي يملكها المستخدم الذي تمت المصادقة عليه، أو يمكنك استرداد مجموعة واحدة أو أكثر من خلال أرقام التعريف الفريدة.

طلب

طلب HTTP

GET https://youtubeanalytics.googleapis.com/v2/groups

التفويض

ويتطلب هذا الطلب تفويضًا باستخدام نطاق واحد على الأقل من النطاقات التالية (اقرأ المزيد عن المصادقة والتفويض).

المناظير
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 وعناصر المجموعات.

المعلَمات

يسرد الجدول أدناه المعلمات التي يدعمها طلب البحث هذا. جميع المعلمات المدرجة هي معلمات طلب بحث.

المعلَمات
الفلاتر (حدد معلمة واحدة من المعلمات التالية)
id string
تحدّد المعلمة id قائمة بمعرّفات مجموعات YouTube مفصولة بفواصل للموارد التي يتم استردادها. يجب أن تكون كل مجموعة مملوكة للمستخدم الذي تمت مصادقته. في المورد group، تحدّد السمة id رقم تعريف مجموعة YouTube للمجموعة.

ملاحظة: في حال عدم تحديد قيمة للمعلّمة id، عليك ضبط المَعلمة mine على true.
mine boolean
لا يمكن استخدام هذه المعلّمة إلا في طلب مفوَّض بشكلٍ سليم. يمكنك ضبط قيمة هذه المعلمة على true لاسترداد جميع المجموعات التي يملكها المستخدم الذي تمت مصادقته.
المعلّمات الاختيارية
onBehalfOfContentOwner string
لا يمكن استخدام هذه المعلّمة إلا في طلب مفوَّض بشكلٍ سليم. ملاحظة: إنّ هذه المعلّمة مخصّصة حصريًا لشركاء المحتوى في YouTube الذين يملكون ويديرون العديد من قنوات YouTube المختلفة.

تشير المعلمة onBehalfOfContentOwner إلى أنّ بيانات اعتماد تفويض الطلب تحدد مستخدم YouTube الذي يتصرّف نيابةً عن مالك المحتوى المحدّد في قيمة المعلّمة. تتيح هذه الميزة لمالكي المحتوى المصادقة مرة واحدة والوصول إلى كل بيانات الفيديو والقناة بدون الحاجة إلى تقديم بيانات اعتماد المصادقة لكل قناة على حدة. ويجب أن يكون الحساب الذي يجري المستخدم المصادقة عليه مرتبطًا بمالك المحتوى المحدد على YouTube.
pageToken string
تحدّد المعلمة pageToken صفحة محدّدة في مجموعة النتائج التي يجب عرضها. في استجابة واجهة برمجة التطبيقات، تحدد الخاصية nextPageToken الصفحة التالية التي يمكن استردادها.

نص الطلب

لا تقدِّم نص طلب عند طلب هذه الطريقة.

الإجابة

إذا نجحت هذه الطريقة، فإنها تعرض نص الاستجابة بالبنية التالية:

{
  "kind": "youtube#groupListResponse",
  "etag": etag,
  "items": [
    group Resource
  ],
  "nextPageToken": string
}

أماكن إقامة

يحدد الجدول التالي الخصائص التي تظهر في هذا المورد:

أماكن إقامة
kind string
تحدد نوع مورد واجهة برمجة التطبيقات. ستكون القيمة youtube#groupListResponse.
etag etag
Etag لهذا المورد.
items[] list
قائمة بالمجموعات التي تطابق معلمات طلب واجهة برمجة التطبيقات. يمثل كل عنصر في القائمة موردًا واحدًا (group).
nextPageToken string
الرمز المميّز الذي يمكن استخدامه كقيمة للمعلَمة pageToken لاسترداد الصفحة التالية في مجموعة النتائج

الأخطاء

لا تحدّد واجهة برمجة التطبيقات أي رسائل خطأ فريدة لطريقة واجهة برمجة التطبيقات هذه. ومع ذلك، قد تعرض هذه الطريقة أخطاء عامة في واجهة برمجة التطبيقات المُدرجة في وثائق رسالة الخطأ.

جرِّب هذه الميزة الآن.

يمكنك استخدام APIs Explorer لاستدعاء واجهة برمجة التطبيقات هذه والاطّلاع على طلب واجهة برمجة التطبيقات والاستجابة له.