Search

یک نتیجه search حاوی اطلاعاتی درباره یک ویدیو، کانال یا لیست پخش YouTube است که با پارامترهای جستجوی مشخص شده در یک درخواست 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
Etag این منبع
id object
شی id حاوی اطلاعاتی است که می تواند برای شناسایی منحصر به فرد منبعی که با درخواست جستجو مطابقت دارد استفاده شود.
id. kind string
نوع منبع API.
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
مقادیر کلیدی معتبر عبارتند از:
  • default – تصویر بندانگشتی پیش‌فرض. تصویر کوچک پیش‌فرض یک ویدیو - یا منبعی که به یک ویدیو اشاره می‌کند، مانند آیتم فهرست پخش یا نتیجه جستجو - 120 پیکسل عرض و 90 پیکسل ارتفاع دارد. تصویر کوچک پیش‌فرض برای یک کانال 88 پیکسل عرض و 88 پیکسل ارتفاع است.
  • medium ​​– یک نسخه با وضوح بالاتر از تصویر کوچک. برای یک ویدیو (یا منبعی که به یک ویدیو اشاره دارد)، این تصویر 320 پیکسل عرض و 180 پیکسل ارتفاع دارد. برای یک کانال، این تصویر 240 پیکسل عرض و 240 پیکسل ارتفاع دارد.
  • high – یک نسخه با وضوح بالا از تصویر کوچک. برای یک ویدیو (یا منبعی که به یک ویدیو اشاره دارد)، این تصویر 480 پیکسل عرض و 360 پیکسل ارتفاع دارد. برای یک کانال، این تصویر 800 پیکسل عرض و 800 پیکسل ارتفاع دارد.
  • standard - حتی یک نسخه با وضوح بالاتر از تصویر کوچک نسبت به تصویر با وضوح high . این تصویر برای برخی از ویدیوها و سایر منابعی که به ویدیوها اشاره دارند، مانند موارد فهرست پخش یا نتایج جستجو، در دسترس است. این تصویر 640 پیکسل عرض و 480 پیکسل ارتفاع دارد.
  • maxres - بالاترین وضوح تصویر تصویر کوچک. این اندازه تصویر برای برخی از ویدیوها و سایر منابعی که به ویدیوها اشاره دارند، مانند موارد فهرست پخش یا نتایج جستجو، در دسترس است. این تصویر 1280 پیکسل عرض و 720 پیکسل ارتفاع دارد.
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 نشان می دهد که کانال پخش زنده فعال دارد.