تتضمّن نتيجة البحث معلومات عن فيديو أو قناة أو قائمة تشغيل على YouTube تتطابق مع مَعلمات البحث المحدّدة في طلب بيانات من واجهة برمجة التطبيقات. فيما تشير نتيجة البحث إلى مورد يمكن التعرّف عليه بشكل فريد، مثل فيديو، لا تكون هناك بيانات ثابتة خاصة به.
الطُرق
تتيح واجهة برمجة التطبيقات استخدام الطرق التالية للبحث:
- list
- عرض مجموعة من نتائج البحث التي تتطابق مع معلَمات طلب البحث المحدّدة في طلب البيانات من واجهة برمجة التطبيقات. تحدِّد مجموعة نتائج البحث تلقائيًا موارد
video
وchannel
وplaylist
المطابقة، ولكن يمكنك أيضًا إعداد طلبات البحث لاسترداد نوع محدّد فقط من الموارد. التجربة الآن
تمثيل الموارد
تعرض بنية JSON التالية تنسيق نتيجة البحث:
{ "kind": "youtube#searchResult", "etag": etag, "id": { "kind": string, "videoId": string, "channelId": string, "playlistId": string }, "snippet": { "publishedAt": datetime, "channelId": string, "title": string, "description": string, "thumbnails": { (key): { "url": string, "width": unsigned integer, "height": unsigned integer } }, "channelTitle": string, "liveBroadcastContent": string } }
أماكن إقامة
يعرّف الجدول التالي السمات التي تظهر في نتيجة بحث:
أماكن إقامة | |
---|---|
kind |
string يحدّد نوع مورد واجهة برمجة التطبيقات. ستكون القيمة youtube#searchResult . |
etag |
etag علامة هذا المرجع. |
id |
object يحتوي الكائن id على معلومات يمكن استخدامها لتحديد المورد الذي يطابق طلب البحث بشكل فريد. |
id.kind |
string نوع مورد واجهة برمجة التطبيقات. |
id.videoId |
string إذا كانت قيمة السمة id.type هي youtube#video ، ستكون هذه السمة متوفّرة وستتضمّن قيمتها المعرّف الذي تستخدمه منصة YouTube لتحديد الفيديو الذي يتطابق مع طلب البحث بشكل فريد. |
id.channelId |
string إذا كانت قيمة السمة id.type هي youtube#channel ، ستكون هذه السمة متوفّرة وستتضمّن قيمتها المعرّف الذي تستخدمه منصة YouTube لتحديد قناة تتطابق مع طلب البحث بشكل فريد. |
id.playlistId |
string إذا كانت قيمة السمة id.type هي youtube#playlist ، ستكون هذه السمة متوفّرة وستتضمّن قيمتها المعرّف الذي تستخدمه منصة YouTube لتحديد قائمة تشغيل تتطابق مع طلب البحث بشكل فريد. |
snippet |
object يحتوي العنصر snippet على تفاصيل أساسية حول نتيجة بحث، مثل عنوانها أو وصفها. على سبيل المثال، إذا كانت نتيجة البحث عبارة عن فيديو، يكون العنوان هو عنوان الفيديو وسيكون الوصف هو وصف الفيديو. |
snippet.publishedAt |
datetime تاريخ ووقت إنشاء المورد الذي تحدِّده نتيجة البحث. ويتم تحديد القيمة بتنسيق ISO 8601. |
snippet.channelId |
string القيمة التي تستخدمها YouTube لتحديد القناة التي نشرت المورد المحدد في نتيجة البحث بشكل فريد. |
snippet.title |
string عنوان نتيجة البحث. |
snippet.description |
string وصف لنتيجة البحث |
snippet.thumbnails |
object خريطة للصور المصغّرة المرتبطة بنتيجة البحث بالنسبة لكل كائن في الخريطة، يكون المفتاح هو اسم الصورة المصغرة، والقيمة هي كائن يحتوي على معلومات أخرى حول الصورة المصغرة. |
snippet.thumbnails.(key) |
object في ما يلي قيم المفاتيح الصالحة:
|
snippet.thumbnails.(key).url |
string عنوان URL للصورة: |
snippet.thumbnails.(key).width |
unsigned integer عرض الصورة. |
snippet.thumbnails.(key).height |
unsigned integer ارتفاع الصورة. |
snippet.channelTitle |
string عنوان القناة التي نشرت المرجع الذي تحدّده نتيجة البحث |
snippet.liveBroadcastContent |
string إشارة إلى ما إذا كان مورد video أو channel يتضمن محتوى بث مباشر قيم السمات الصالحة هي upcoming وlive وnone .بالنسبة إلى مورد video ، تشير القيمة upcoming إلى أنّ الفيديو هو بث مباشر لم يبدأ بعد، بينما تشير القيمة live إلى أنّ الفيديو هو بث مباشر نشط. بالنسبة إلى مورد channel ، تشير القيمة upcoming إلى أنّ القناة تعرض بثًا مباشرًا مجدولاً لم يبدأ بعد، بينما تشير القيمة live إلى أنّ القناة لديها بث مباشر نشط. |