یک نتیجه search حاوی اطلاعاتی درباره یک ویدیو، کانال یا لیست پخش یوتیوب است که با پارامترهای جستجوی مشخص شده در یک درخواست API مطابقت دارد. در حالی که یک نتیجه جستجو به یک منبع منحصر به فرد قابل شناسایی، مانند یک ویدیو، اشاره میکند، دادههای دائمی خود را ندارد.
روشها
این API از روشهای زیر برای جستجو پشتیبانی میکند:
- list
- مجموعهای از نتایج جستجو را که با پارامترهای پرسوجوی مشخصشده در درخواست API مطابقت دارند، برمیگرداند. بهطور پیشفرض، یک مجموعه نتیجه جستجو، منابع
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نوع منبع API را مشخص میکند. مقدار آن youtube#searchResult خواهد بود. |
etag | etagبرچسب E این منبع. |
id | objectشیء id حاوی اطلاعاتی است که میتواند برای شناسایی منحصر به فرد منبعی که با درخواست جستجو مطابقت دارد، استفاده شود. |
id. kind | stringنوع منبع API. |
id. videoId | stringاگر مقدار ویژگی id.type برابر با youtube#video باشد، این ویژگی وجود خواهد داشت و مقدار آن شامل شناسهای خواهد بود که یوتیوب برای شناسایی منحصر به فرد ویدیویی که با عبارت جستجو مطابقت دارد، استفاده میکند. |
id. channelId | stringاگر مقدار ویژگی id.type برابر با youtube#channel باشد، این ویژگی وجود خواهد داشت و مقدار آن شامل شناسهای خواهد بود که یوتیوب برای شناسایی منحصر به فرد کانالی که با عبارت جستجو مطابقت دارد، استفاده میکند. |
id. playlistId | stringاگر مقدار ویژگی id.type برابر با youtube#playlist باشد، این ویژگی وجود خواهد داشت و مقدار آن شامل شناسهای خواهد بود که یوتیوب برای شناسایی منحصر به فرد یک لیست پخش مطابق با عبارت جستجو استفاده میکند. |
snippet | objectشیء snippet شامل جزئیات اولیه در مورد نتیجه جستجو، مانند عنوان یا توضیحات آن است. برای مثال، اگر نتیجه جستجو یک ویدیو باشد، عنوان، عنوان ویدیو و توضیحات، توضیحات ویدیو خواهد بود. |
snippet. publishedAt | datetimeتاریخ و زمان ایجاد منبعی که نتیجه جستجو آن را شناسایی میکند. این مقدار با فرمت ISO 8601 مشخص شده است. |
snippet. channelId | stringمقداری که یوتیوب برای شناسایی منحصر به فرد کانالی که منبعی را که نتیجه جستجو شناسایی میکند، منتشر کرده است، استفاده میکند. |
snippet. title | stringعنوان نتیجه جستجو. |
snippet. description | stringتوضیحی در مورد نتیجه جستجو. |
snippet. thumbnails | objectنقشهای از تصاویر کوچک مرتبط با نتیجه جستجو. برای هر شیء در نقشه، کلید، نام تصویر کوچک و مقدار، شیءای است که حاوی اطلاعات دیگری در مورد تصویر کوچک است. |
snippet.thumbnails. (key) | objectمقادیر کلید معتبر عبارتند از:
توجه: تصاویر کوچک با وضوح تصویر 1080p+ ( |
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 نشان میدهد که کانال یک پخش زنده فعال دارد. |