members
محلّ نقطة النهاية
sponsors
التي تم إيقافها نهائيًا ولن تعود متاحة في 30 أيلول (سبتمبر) 2020 أو بعد هذا التاريخ. على عملاء واجهة برمجة التطبيقات تعديل طلبات البيانات إلى طريقة sponsors.list
من أجل استخدام طريقة members.list
بدلاً من ذلك.
لا يمكن لصنّاع المحتوى الفرديين استخدام نقطة النهاية هذه إلا لتقديم طلبات بشأن قناتهم على YouTube التي فعّلت ميزة "الاشتراك الداعم". يُرجى التواصل مع ممثل Google أو YouTube لطلب إذن الوصول.
يمثّل مورد member
أحد المشتركين الداعمين لقناة على YouTube. يقدّم المشترك الداعم دعمًا ماليًا متكررًا لصانع محتوى معيّن ويحصل على مزايا
خاصة. على سبيل المثال، يمكن للمشتركين الداعمين إجراء محادثة عندما يفعّل صانع المحتوى وضع المحادثة الحصرية للأعضاء في
إحدى المحادثات.
الطُرق
تتيح واجهة برمجة التطبيقات الطرق التالية لموارد member
:
- list
- تعرض هذه البطاقة المشتركين الداعمين (المعروفين سابقًا باسم "الجهات الراعية") لقناة معيّنة. يجب أن يوافق صاحب القناة على طلب البيانات من واجهة برمجة التطبيقات.
تمثيل الموارد
تعرض بنية JSON التالية تنسيق مورد member
:
{ "kind": "youtube#member", "etag": etag, "snippet": { "creatorChannelId": string, "memberDetails": { "channelId": string, "channelUrl": string, "displayName": string, "profileImageUrl": string }, "membershipsDetails": { "highestAccessibleLevel": string, "highestAccessibleLevelDisplayName": string, "accessibleLevels": [ string ], "membershipsDuration": { "memberSince": datetime, "memberTotalDurationMonths": integer, }, "membershipsDurationAtLevel": [ { "level": string, "memberSince": datetime, "memberTotalDurationMonths": integer, } ] } } }
أماكن إقامة
يحدِّد الجدول التالي السمات التي تظهر في هذا المرجع:
أماكن إقامة | |
---|---|
kind |
string لتحديد نوع مورد واجهة برمجة التطبيقات. ستكون القيمة youtube#member . |
etag |
etag رقم تعريف Etag لهذا المورد. |
snippet |
object يحتوي عنصر snippet على تفاصيل عن العضو. |
snippet.creatorChannelId |
string رقم تعريف قناة صانع المحتوى الذي يقدّم العضويات على YouTube. |
snippet.memberDetails |
object يحتوي هذا العنصر على بيانات الملف الشخصي للقناة على YouTube التي تدفع رسوم الاشتراك. يُرجى العِلم أنّه يمكن أن تتضمّن القناة مشتركين داعمين لا تتوفّر بيانات ملفاتهم التجارية. على سبيل المثال، يحدث ذلك مع المشتركين الذين حذفوا قنواتهم ولكن لا يزالون يدفعون مقابل العضويات. يُرجى العِلم أنّه سيظل بإمكان هؤلاء المشتركين الاستفادة من مزايا الاشتراك. تتضمّن ردود واجهة برمجة التطبيقات موارد لهؤلاء الأعضاء لضمان أعداد دقيقة حتى في حال عدم ضبط تفاصيل الملف التجاري داخل عنصر memberDetails . سيظل بإمكان هؤلاء الأعضاء الاستفادة من
membershipsDetails . |
snippet.memberDetails.channelId |
string معرّف القناة على YouTube التي تتضمّن ميزة "الاشتراك الداعم". وفي حال ضبطه، يمكن أيضًا التعامل مع معرّف القناة كمعرّف فريد للمشترك الداعم. وفي حال عدم ضبطه، لا يمكن تحديد هوية العضو بشكل فريد، ولكن يظلّ المرجع ينقل تفاصيل العضوية، مثل المستويات التي يمكن للعضو الوصول إليها ومدة عضويته. |
snippet.memberDetails.channelUrl |
string عنوان URL الخاص بالقناة. |
snippet.memberDetails.displayName |
string الاسم المعروض للقناة. |
snippet.memberDetails.profileImageUrl |
string عنوان URL الخاص بأفاتار القناة. |
snippet.membershipsDetails |
object يحتوي هذا العنصر على تفاصيل الاشتراك الداعم للقناة. |
snippet.membershipsDetails.highestAccessibleLevel |
string رقم تعريف أعلى مستوى اشتراك يمكن للقنوات المنتسَبة الوصول إليه حاليًا. تتوافق القيمة مع قيمة سمة id
في مورد membershipsLevel . |
snippet.membershipsDetails.highestAccessibleLevelDisplayName |
string اسم أعلى مستوى اشتراك يمكن للقناة التي تتضمّن ميزة "الاشتراك الداعم" الاستفادة منه حاليًا. تتوافق قيمة مع قيمة سمة displayName
في مورد membershipsLevel . |
snippet.membershipsDetails.accessibleLevels[] |
list (of strings) قائمة بأرقام تعريف جميع مستويات الاشتراك التي يمكن للمستخدم الوصول إليها حاليًا تتضمّن القائمة المستوى النشط حاليًا وجميع المستويات أدناه. |
snippet.membershipsDuration |
object يحتوي هذا العنصر على معلومات عن المدة الإجمالية لاشتراك العضو الحالي بدون النظر إلى مستويات الأسعار. يحتوي الحقل snippet.membershipsDetails.membershipsDurationAtLevel[]
بعد ذلك على قائمة بالعناصر التي تحتوي على تفاصيل عن فترة الاشتراك
التي تمكّن خلالها العضو من الوصول إلى مستوى اشتراك معيّن.
يوضّح المثال التالي كيفية عمل هذه السمات: يشتري أحد المشتركين اشتراكًا جديدًا في كانون الثاني (يناير) في المستوى 1 من الاشتراك ويحتفظ به حتى آذار (مارس). في شهرَي نيسان (أبريل) وأيار (مايو)، ليس لدى العميل عضوية. في حزيران (يونيو)، يعيد المشترك تفعيل اشتراكه مجددًا في المستوى 1. بعد ذلك، في آب (أغسطس)، يُجري المشترك ترقية لاشتراكه إلى المستوى 2. وبالتالي، إذا تم إجراء طلب بيانات من واجهة برمجة التطبيقات في تشرين الأول (أكتوبر)، سيحتوي المورد member على ما يلي:
"membershipsDetails": { "membershipsDuration": { "memberSince": "2020-06-01T12:00:00", "memberTotalDurationMonths": 7, }, "membershipsDurationAtLevel": [ { "level": "level_1_ID", "memberSince": "2020-06-01T12:00:00", "memberTotalDurationMonths": 7 }, { "level": "level_2_ID", "memberSince": "2020-08-01T12:00:00", "memberTotalDurationMonths": 2 }, ] } |
snippet.membershipsDuration.memberSince |
datetime تاريخ ووقت بدء اشتراك المشترك الحالي. بعبارة أخرى، أصبح للمشترك اشتراكًا مستمرًا منذ هذا التاريخ والوقت. يُرجى العِلم أنّه قد تم إنفاق فترات مختلفة من الاشتراك في مستويات عضوية مختلفة. |
snippet.membershipsDuration.memberTotalDurationMonths |
integer عدد الأشهر التي كان فيها المستخدم مشتركًا، مع التقريب إلى أقرب عدد صحيح تعكس القيمة عدد الأشهر الكاملة التي كان فيها العضو مشتركًا في القناة، ولكن لا يشير الرقم إلى أنّ العضو كان مشتركًا في القناة باستمرار لعدة أشهر. |
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel[] |
list (of objects) قائمة بالكائنات التي يحتوي كلّ منها على تفاصيل عن فترة من فترة الاشتراك التي تمكّن خلالها العضو من الوصول إلى مستوى اشتراك معيّن. تتضمّن القائمة كائنًا واحدًا لكل مستوى اشتراك يمكن للعضو الوصول إليه حاليًا. |
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.level |
string رقم تعريف مستوى العضوية. تتطابق القيمة مع قيمة سمة id في مورد
membershipsLevel . |
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.memberSince |
datetime التاريخ والوقت اللذان أصبح فيهما بإمكان المشترك الاستفادة من مستوى العضوية المحدّد. وبعبارة أخرى، كان بإمكان المشترك الاستفادة من المستوى باستمرار منذ هذا التاريخ والوقت. يُرجى العِلم أنّه قد تم إنفاق فترات مختلفة من الاشتراك في مستويات عضوية أعلى. |
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.memberTotalDurationMonths |
integer عدد الأشهر التي تمكّن فيها المستخدم من الوصول إلى المستوى المحدّد، مع التقريب إلى أقرب عدد صحيح تعكس القيمة عدد الأشهر الكاملة التي تمكّن فيها العضو من الوصول إلى المستوى، ولكنّ الرقم لا يشير إلى أنّ العضو كان لديه اشتراكًا مستمرًا طوال هذا العدد من الأشهر. |