LiveChatMessages: insert

پیام یا نظرسنجی‌ای را به گپ مستقیم اضافه می‌کند.

تأثیر سهمیه: تماس با این روش هزینه سهمیه ۲۰ واحدی دارد.

موارد استفاده رایج

درخواست

درخواست HTTP

POST https://www.googleapis.com/youtube/v3/liveChat/messages

صدور مجوز

این درخواست به مجوز با حداقل یکی از دامنه‌های زیر نیاز دارد. برای خواندن بیشتر درباره اصالت‌سنجی و صدور مجوز، پیاده‌سازی اصالت‌سنجی OAuth 2.0 را ببینید.

حوزه
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

پارامترها

جدول زیر پارامترهایی را که این پُرسمان پشتیبانی می‌کند فهرست می‌کند. همه پارامترهای فهرست‌شده پارامترهای پُرسمان هستند.

پارامترها
پارامترهای الزامی
part string
پارامتر part دو هدف را دنبال می‌کند. این منبع ویژگی‌هایی را که عملیات نوشتن تنظیم می‌کند و همچنین ویژگی‌هایی را که پاسخ میانای برنامه‌سازی کاربردی دربرمی‌گیرد شناسایی می‌کند. مقدار پارامتر را روی snippet تنظیم کنید.

متن درخواست

یک منبع liveChatMessage در بدنه درخواست ارائه دهید. برای آن منبع، باید مقادیر این ویژگی‌ها را مشخص کنید

  • snippet.liveChatId
  • snippet.type - یکی از گزینه‌های زیر را انتخاب کنید: textMessageEvent یا pollEvent
  • اگر نوع textMessageEvent است، snippet.textMessageDetails.messageText را اضافه کنید
  • اگر نوع pollEvent است، شیء snippet.pollDetails را با ساختار زیر اضافه کنید:
    • ‫snippet.pollDetails.metadata.questionText (رشته): سؤال اصلی نظرسنجی.
    • snippet.pollDetails.metadata.options (آرایه): فهرستی از اشیای گزینه.
    • الزامات: باید حداقل ۲ و حداکثر ۴ مورد اضافه کنید.
    • ترتیب: موارد به‌صورت متوالی و دقیقاً به همان ترتیبی که فهرست شده‌اند نمایش داده می‌شوند.
    • هر شیء در آرایه باید شامل موارد زیر باشد:
      • optionText (رشته): نوشتار نمایش‌داده‌شده برای آن گزینه نظرسنجی خاص.

پاسخ

اگر موفقیت‌آمیز باشد، این روش یک منبع liveChatMessage را در بدنه پاسخ برمی‌گرداند.

خطاها

جدول زیر پیام‌های خطایی را که ممکن است API در پاسخ به فراخوانی این روش برگرداند، مشخص می‌کند. برای جزئیات بیشتر، به YouTube Live Streaming API - Errors مراجعه کنید.

نوع خطا جزئیات خطا شرح
forbidden (403) forbidden اجازه‌های لازم برای ایجاد پیام مشخص‌شده را ندارید.
forbidden (403) liveChatDisabled گپ مستقیم مشخص‌شده توسط مالک غیرفعال شده است، به این معنی که نمی‌توان پیام‌ها را به گپ اضافه کرد.
forbidden (403) liveChatEnded گپ مستقیم مشخص‌شده دیگر زنده نیست.
invalidValue (400) messageTextInvalid نوشتار پیام (snippet.textMessageDetails.messageText) معتبر نیست.
notFound (404) liveChatNotFound گپ مستقیمی که در درخواست API مشخص شده است وجود ندارد. این خطا زمانی رخ می‌دهد که گپ توسط مالک حذف شده باشد.
required (400) liveChatIdRequired منبع liveChatMessage باید شامل و مشخص‌کننده مقدار برای دارایی snippet.liveChatId باشد.
required (400) messageTextRequired منبع liveChatMessage باید شامل یک مقدار برای ویژگی snippet.textMessageDetails.messageText باشد و آن را مشخص کند.
required (400) typeRequired منبع liveChatMessage باید شامل یک مقدار برای ویژگی snippet.type باشد و آن را مشخص کند. مقدار پارامتر را روی text تنظیم کنید
required (400) preconditionCheckFailed نظرسنجی فعال سنجاق‌شده‌ای ازقبل وجود دارد.
rateLimitExceeded rateLimitExceeded کاربر در بازه زمانی مشخصی تعداد زیادی پیام گپ پست کرده است.

امتحان کنید!

از APIs Explorer برای فراخوانی این API و دیدن درخواست و پاسخ API استفاده کنید.