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 علامة هذا المرجع. |
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 عدد الأشهر، مع تقريب الأرقام إلى أقرب عدد صحيح، والتي تمكّن المستخدِم من الوصول إلى المستوى المحدّد فيها. تشير القيمة إلى عدد الأشهر الكاملة التي حصل فيها العضو على عضوية في هذا المستوى، ولكن هذا العدد لا يشير إلى أنّ العضو قد عضو في القناة بشكل متواصل لعدة أشهر. |