تحتوي نتيجة search على معلومات عن فيديو أو قناة أو قائمة تشغيل على 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رقم تعريف 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 إلى أنّ القناة لديها بث مباشر نشط. |