یک پخش YouTube را به یک جاری‌سازی متصل می‌کند یا اتصال موجود بین یک پخش و یک جاری‌سازی را حذف می‌کند. یک همه‌فرستی فقط می‌تواند به یک جاری‌سازی ویدیویی متصل شود، اگرچه یک جاری‌سازی ویدیویی می‌تواند به بیش از یک همه‌فرستی متصل شود.
موارد استفاده رایج
درخواست
درخواست HTTP
POST https://www.googleapis.com/youtube/v3/liveBroadcasts/bind
صدور مجوز
این درخواست به مجوز با حداقل یکی از دامنه‌های زیر نیاز دارد (درباره اصالت‌سنجی و مجوز بیشتر بخوانید).
| حوزه |
|---|
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
پارامترها
جدول زیر پارامترهایی را که این پُرسمان پشتیبانی می‌کند فهرست می‌کند. همه پارامترهای فهرست‌شده، پارامترهای پُرسمان هستند.
| پارامترها | ||
|---|---|---|
| پارامترهای الزامی | ||
id |
stringپارامتر id شناسه یکتای همه‌فرستی را که به یک جاری‌سازی ویدیو پیوند داده می‌شود مشخص می‌کند. |
|
part |
stringپارامتر part فهرستی جداشده با کاما از یک یا چند ویژگی منبع liveBroadcast را مشخص می‌کند که پاسخ میانای برنامه‌سازی کاربردی شامل آن خواهد بود. نام‌های part که می‌توانید در مقدار پارامتر بگنجانید عبارت‌اند از id، snippet، contentDetails، و status. |
|
| پارامترهای اختیاری | ||
onBehalfOfContentOwner |
stringاز این پارامتر فقط می‌توان در درخواست مجاز مناسب استفاده کرد. توجه: این پارامتر منحصراً برای شرکای محتوای YouTube درنظر گرفته شده است. پارامتر onBehalfOfContentOwner نشان می‌دهد که اطلاعات کاربری مجوز درخواست، کاربر CMS YouTube را شناسایی می‌کند که از طرف مالک محتوای مشخص‌شده در مقدار پارامتر عمل می‌کند. این پارامتر برای شرکای محتوای YouTube است که مالک و مدیر کانال‌های مختلف YouTube هستند. این ویژگی به مالکان محتوا اجازه می‌دهد یک‌بار اصالت‌سنجی کنند و به همه داده‌های ویدیو و کانال خود دسترسی پیدا کنند، بدون اینکه نیاز باشد برای هر کانال به‌طور جداگانه اعتبارنامه‌های اصالت‌سنجی ارائه دهند. حساب CMS که کاربر با آن اصالت‌سنجی می‌کند باید به مالک محتوای YouTube مشخص‌شده پیوند داده شود. |
|
onBehalfOfContentOwnerChannel |
stringاین پارامتر فقط در درخواست‌های مجاز قابل‌استفاده است. از این پارامتر فقط می‌توان در درخواست مجاز به‌درستی استفاده کرد. توجه: این پارامتر منحصراً برای شرکای محتوای YouTube درنظر گرفته شده است. پارامتر onBehalfOfContentOwnerChannel شناسه کانال YouTube را برای کانالی که ویدیو به آن اضافه می‌شود مشخص می‌کند. وقتی درخواست مقداری را برای پارامتر onBehalfOfContentOwner مشخص می‌کند، این پارامتر الزامی است و فقط می‌تواند همراه با آن پارامتر استفاده شود. علاوه‌براین، درخواست باید بااستفاده از حساب CMS که به مالک محتوایی که پارامتر onBehalfOfContentOwner مشخص می‌کند پیوند داده شده است، مجاز شود. درنهایت، کانالی که مقدار پارامتر onBehalfOfContentOwnerChannel مشخص می‌کند باید به مالک محتوایی که پارامتر onBehalfOfContentOwner مشخص می‌کند پیوند داده شود.این پارامتر برای شرکای محتوای YouTube درنظر گرفته شده است که مالک کانال‌های YouTube مختلفی هستند و آن‌ها را مدیریت می‌کنند. این ویژگی به مالکان محتوا امکان می‌دهد یک‌بار اصالت‌سنجی کنند و کنش‌ها را ازطرف کانال مشخص‌شده در مقدار پارامتر انجام دهند، بدون اینکه نیاز باشد برای هر کانال جداگانه اطلاعات اعتباری اصالت‌سنجی ارائه دهند. |
|
streamId |
stringپارامتر streamId شناسه یکتای جاری‌سازی ویدیویی را که به یک همه‌فرستی پیوند داده می‌شود مشخص می‌کند. اگر این پارامتر حذف شود، API هرگونه اتصال موجود بین همه‌فرستی و جاری‌سازی ویدیو را برمی‌دارد. |
|
متن درخواست
هنگام فراخوانی این روش، بدنه درخواست ارائه نکنید.
پاسخ
درصورت موفقیت، این روش یک منبع liveBroadcast را در بدنه پاسخ برمی‌گرداند.
خطاها
جدول زیر پیام‌های خطایی را که ممکن است API در پاسخ به فراخوانی این روش برگرداند، مشخص می‌کند. لطفاً برای جزئیات بیشتر به سند پیام خطا مراجعه کنید.
| نوع خطا | جزئیات خطا | شرح |
|---|---|---|
backendError |
internalError |
خطای داخلی درطول اتصال روی داد. |
forbidden (403) |
liveBroadcastBindingNotAllowed |
وضعیت فعلی پخش زنده اجازه نمی‌دهد که به جاری‌سازی متصل شود. |
insufficientPermissions |
insufficientLivePermissions |
درخواست برای بازیابی پخش زنده مشخص‌شده مجاز نیست. برای اطلاعات بیشتر، به پیاده‌سازی اصالت‌سنجی OAuth2 مراجعه کنید. |
insufficientPermissions |
liveStreamingNotEnabled |
کاربری که درخواست را مجاز کرده است، برای جاری‌سازی ویدیو زنده در YouTube فعال نیست. کاربر می‌تواند اطلاعات بیشتر را در https://www.youtube.com/features پیدا کند. |
notFound (404) |
liveBroadcastNotFound |
پخش زنده مشخص‌شده توسط پارامتر id وجود ندارد. |
notFound (404) |
liveStreamNotFound |
جاری‌سازی مشخص‌شده با پارامتر streamId وجود ندارد. |
rateLimitExceeded |
userRequestsExceedRateLimit |
کاربر در بازه زمانی مشخصی درخواست‌های زیادی ارسال کرده است. |
required (400) |
idRequired |
پارامتر الزامی id باید همه‌فرستی را برای اتصال شناسایی کند. |
امتحان کنید!
از APIs Explorer برای فراخوانی این API و دیدن درخواست و پاسخ API استفاده کنید.