Groups: list

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

الطلب

طلب HTTP

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

التفويض

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

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

المعلمات

يسرد الجدول التالي المَعلمات التي يتيح طلب البحث استخدامها. جميع المَعلمات المُدرَجة هي مَعلمات طلب بحث.

المعلمات
الفلاتر (حدد معلمة واحدة بالضبط من المعلمات التالية)
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 لطلب بيانات من واجهة برمجة التطبيقات هذه والاطّلاع على طلب البيانات والاستجابة.