جاریسازی ویدیو ایجاد میکند. جاریسازی به شما امکان میدهد ویدیو خود را به YouTube ارسال کنید، که سپس میتواند ویدیو را برای مخاطبان شما پخش کند.
موارد استفاده رایج
درخواست
درخواست HTTP
POST https://www.googleapis.com/youtube/v3/liveStreams
صدور مجوز
این درخواست به مجوز با حداقل یکی از دامنههای زیر نیاز دارد (درباره اصالتسنجی و مجوز بیشتر بخوانید).
| حوزه |
|---|
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
پارامترها
جدول زیر پارامترهایی را که این پُرسمان پشتیبانی میکند فهرست میکند. همه پارامترهای فهرستشده پارامترهای پُرسمان هستند.
| پارامترها | ||
|---|---|---|
| پارامترهای الزامی | ||
part |
stringپارامتر part در این عملیات دو هدف را دنبال میکند. این پارامتر مشخصههایی را که عملیات نوشتن تنظیم میکند و همچنین مشخصههایی را که پاسخ میانای برنامهسازی کاربردی دربرمیگیرد مشخص میکند.مشخصههای part که میتوانید در مقدار پارامتر بگنجانید عبارتاند از id، snippet، cdn، contentDetails، و status. |
|
| پارامترهای اختیاری | ||
onBehalfOfContentOwner |
stringاین پارامتر فقط در درخواستهای مجاز قابلاستفاده است. توجه: این پارامتر منحصراً برای شرکای محتوای YouTube درنظر گرفته شده است. پارامتر onBehalfOfContentOwner نشان میدهد که اطلاعات اعتباری مجوز درخواست، کاربر «سیستم مدیریت محتوای YouTube» را که ازطرف مالک محتوای مشخصشده در مقدار پارامتر عمل میکند شناسایی میکند. این پارامتر برای شرکای محتوای YouTube است که مالک و مدیر کانالهای مختلف YouTube هستند. این ویژگی به مالکان محتوا امکان میدهد یکبار اصالتسنجی کنند و به تمام دادههای ویدیو و کانال خود دسترسی پیدا کنند، بدون اینکه نیاز باشد برای هر کانال جداگانه اطلاعات اصالتسنجی ارائه دهند. حساب CMS که کاربر با آن اصالتسنجی میکند باید به مالک محتوای YouTube مشخصشده پیوند داده شده باشد. |
|
onBehalfOfContentOwnerChannel |
stringاین پارامتر فقط در درخواستهای مجاز قابلاستفاده است. از این پارامتر فقط میتوان در درخواست مجاز بهدرستی استفاده کرد. توجه: این پارامتر منحصراً برای شرکای محتوای YouTube درنظر گرفته شده است. پارامتر onBehalfOfContentOwnerChannel شناسه کانال YouTube را برای کانالی که ویدیو به آن اضافه میشود مشخص میکند. این پارامتر زمانی لازم است که درخواستی مقداری را برای پارامتر onBehalfOfContentOwner مشخص کند و فقط میتواند همراه با آن پارامتر استفاده شود. علاوهبراین، درخواست باید بااستفاده از حساب CMS که به مالک محتوایی که پارامتر onBehalfOfContentOwner مشخص میکند پیوند داده شده است، مجاز شود. درنهایت، کانالی که مقدار پارامتر onBehalfOfContentOwnerChannel مشخص میکند باید به مالک محتوایی که پارامتر onBehalfOfContentOwner مشخص میکند پیوند داده شود.این پارامتر برای شرکای محتوای YouTube درنظر گرفته شده است که مالک کانالهای YouTube مختلفی هستند و آنها را مدیریت میکنند. این پارامتر به مالکان محتوا اجازه میدهد یکبار اصالتسنجی کنند و ازطرف کانال مشخصشده در مقدار پارامتر اقداماتی را انجام دهند، بدون اینکه نیاز باشد برای هر کانال جداگانه اعتبارنامههای اصالتسنجی ارائه دهند. |
|
متن درخواست
یک منبع liveStream در بدنه درخواست ارائه دهید. برای آن منبع:
-
باید مقداری برای این ویژگیها مشخص کنید:
snippet.titlecdn.frameRatecdn.ingestionTypecdn.resolution
-
میتوانید مقادیر این داراییها را تنظیم کنید:
snippet.titlesnippet.descriptioncdn.frameRatecdn.ingestionTypecdn.resolutioncontentDetails.isReusable
پاسخ
اگر موفقیتآمیز باشد، این روش یک منبع جاریسازی زنده را در بدنه پاسخ برمیگرداند.
خطاها
جدول زیر پیامهای خطایی را که ممکن است «میانای برنامهسازی کاربردی» در پاسخ به فراخوانی این روش برگرداند مشخص میکند. لطفاً برای جزئیات بیشتر به سند پیام خطا مراجعه کنید.
| نوع خطا | جزئیات خطا | شرح |
|---|---|---|
insufficientPermissions |
insufficientLivePermissions |
درخواست برای ایجاد جاریسازی زنده مشخصشده مجاز نیست. |
insufficientPermissions |
livePermissionBlocked |
کاربری که درخواست را مجاز کرده است درحالحاضر نمیتواند ویدیو زنده در YouTube جاریسازی کند. جزئیات توضیحدهنده اینکه چرا کاربر نمیتواند ویدیو زنده جاریسازی کند ممکن است در تنظیمات کانال کاربر در https://www.youtube.com/features دردسترس باشد. |
insufficientPermissions |
liveStreamingNotEnabled |
کاربری که درخواست را مجاز کرده است، برای جاریسازی ویدیو زنده در YouTube فعال نیست. کاربر میتواند اطلاعات بیشتر را در https://www.youtube.com/features پیدا کند. |
invalidValue (400) |
invalidDescription |
مقدار ویژگی snippet.description در منبع liveStream میتواند حداکثر ۱۰۰۰۰ نویسه داشته باشد. |
invalidValue (400) |
invalidFormat |
مقدار خصوصیت cdn.format در منبع liveStream نامعتبر است. |
invalidValue (400) |
invalidFrameRate |
مقدار ویژگی cdn.frameRate در منبع liveStream نامعتبر است. |
invalidValue (400) |
invalidIngestionType |
مقدار دارایی cdn.ingestionType در منبع liveStream نامعتبر است. |
invalidValue (400) |
invalidResolution |
مقدار ویژگی cdn.resolution در منبع liveStream نامعتبر است. |
invalidValue (400) |
invalidTitle |
مقدار دارایی snippet.title در منبع liveStream باید بین ۱ تا ۱۲۸ نویسه باشد. |
rateLimitExceeded |
userRequestsExceedRateLimit |
کاربر در بازه زمانی مشخصی درخواستهای زیادی ارسال کرده است. |
required (400) |
cdnRequired |
منبع liveStream باید حاوی شیء cdn باشد. |
required (400) |
frameRateRequired |
اگر برای دارایی cdn.resolution مقداری مشخص کنید اما برای دارایی cdn.frameRate مقداری مشخص نکنید، این API این خطا را برمیگرداند. |
required (400) |
ingestionTypeRequired |
منبع liveStream باید مقداری را برای دارایی cdn.ingestionType مشخص کند>. |
required (400) |
resolutionRequired |
اگر مقداری برای ویژگی cdn.frameRate مشخص کنید اما برای ویژگی cdn.resolution مشخص نکنید، API این خطا را برمیگرداند. |
required (400) |
titleRequired |
منبع liveStream باید مقداری برای دارایی snippet.title مشخص کند. |
امتحان کنید!
از APIs Explorer برای فراخوانی این API و دیدن درخواست و پاسخ API استفاده کنید.