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 دو هدف را دنبال می کند. ویژگی هایی را که عملیات نوشتن تنظیم می کند و همچنین ویژگی هایی را که پاسخ API شامل می شود شناسایی می کند. مقدار پارامتر را روی snippet تنظیم کنید. |
درخواست بدن
یک منبع liveChatMessage در بدنه درخواست ارائه دهید. برای آن منبع، باید مقادیری را برای این ویژگی ها مشخص کنید
-
snippet.liveChatId
-
snippet.type
- یکی از گزینه های زیر را انتخاب کنید: textMessageEvent
یا pollEvent
- اگر نوع
textMessageEvent
است، snippet.textMessageDetails.messageText
را وارد کنید - اگر نوع
pollEvent
است، snippet.pollDetails
با مقادیر زیر وارد کنید:-
snippet.pollDetails.metadata.options.questionText
- فهرست
snippet.pollDetails.metadata.options.optionText
. شما باید حداقل دو مورد و حداکثر پنج مورد را لیست کنید. موارد به ترتیبی که فهرست شده اند به ترتیب نمایش داده می شوند.
خطاها
جدول زیر پیام های خطایی را مشخص می کند که 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 استفاده کنید.
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-01-02 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-01-02 بهوقت ساعت هماهنگ جهانی."],[],[],null,["# LiveChatMessages: insert\n\nAdds a message or a poll to a live chat.\n\nCommon use cases\n----------------\n\nThe list below shows common use cases for this method. Hover over a use case to see its description, or click on a use case to load sample parameter values in the APIs Explorer. You can open the [fullscreen APIs Explorer](#) to see code samples that dynamically update to reflect the parameter values entered in the Explorer.\n\nThe table below shows common use cases for this method. You can click on a use case name to load sample parameter values in the APIs Explorer. Or you can see code samples for a use case in the fullscreen APIs Explorer by clicking on the code icon below a use case name. In the fullscreen UI, you can update parameter and property values and the code samples will dynamically update to reflect the values you enter. \nThis method has one common use case, which is described below. The buttons below the description populate the APIs Explorer with sample values or open the fullscreen APIs Explorer to show code samples that use those values. The code samples also dynamically update if you change the values.\n\n\u003cbr /\u003e\n\nRequest\n-------\n\n### HTTP request\n\n```\nPOST https://www.googleapis.com/youtube/v3/liveChat/messages\n```\n\n### Authorization\n\nThis request requires authorization with at least one of the following scopes. To read more about authentication and authorization, see [Implementing OAuth 2.0 authentication](/youtube/v3/live/authentication).\n\n| Scope |\n|-----------------------------------------------------|\n| `https://www.googleapis.com/auth/youtube` |\n| `https://www.googleapis.com/auth/youtube.force-ssl` |\n\n### Parameters\n\nThe following table lists the parameters that this query supports. All of the parameters listed are query parameters.\n\n| Parameters ||\n|--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| **Required parameters** |||\n| `part` | `string` The **part** parameter serves two purposes. It identifies the properties that the write operation will set as well as the properties that the API response will include. Set the parameter value to `snippet`. |\n\n### Request body\n\nProvide a [liveChatMessage resource](/youtube/v3/live/docs/liveChatMessages#resource) in the request body.\nFor that resource, you must specify values for these properties\n\n- `snippet.liveChatId`\n- `snippet.type` - choose one of the following options: `textMessageEvent` or `pollEvent`\n- If type is `textMessageEvent`, include `snippet.textMessageDetails.messageText`\n- If type is `pollEvent`, include `snippet.pollDetails` with the following values:\n - `snippet.pollDetails.metadata.options.questionText`\n - List of `snippet.pollDetails.metadata.options.optionText`. You must list at least two items and no more than four items. Items are displayed sequentially in the order they're listed.\n\nResponse\n--------\n\nIf successful, this method returns a [liveChatMessage resource](/youtube/v3/live/docs/liveChatMessages#resource) in the response body.\n\nErrors\n------\n\nThe following table identifies error messages that the API could return in response to a call to this method. For more details, see [YouTube Live Streaming API - Errors](/youtube/v3/live/docs/errors).\n\n| Error type | Error detail | Description |\n|----------------------|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `forbidden (403)` | `forbidden` | You don't have the permissions required to create the specified message. |\n| `forbidden (403)` | `liveChatDisabled` | The specified live chat has been disabled by the owner, which means messages cannot be added to the chat. |\n| `forbidden (403)` | `liveChatEnded` | The specified live chat is no longer live. |\n| `invalidValue (400)` | `messageTextInvalid` | The message text (`snippet.textMessageDetails.messageText`) is not valid. |\n| `notFound (404)` | `liveChatNotFound` | The live chat identified in the API request does not exist. This error occurs if the chat has been deleted by the owner. |\n| `required (400)` | `liveChatIdRequired` | The [liveChatMessage resource](/youtube/v3/live/docs/liveChatMessages#resource) must include and specify a value for the `snippet.liveChatId` property. |\n| `required (400)` | `messageTextRequired` | The [liveChatMessage resource](/youtube/v3/live/docs/liveChatMessages#resource) must include and specify a value for the `snippet.textMessageDetails.messageText` property. |\n| `required (400)` | `typeRequired` | The [liveChatMessage resource](/youtube/v3/live/docs/liveChatMessages#resource) must include and specify a value for the `snippet.type` property. Set the parameter value to `text` |\n| `required (400)` | `preconditionCheckFailed` | A pinned active poll already exists. |\n| `rateLimitExceeded` | `rateLimitExceeded` | The user has posted too many chat messages in a given timeframe. |\n\nTry it!\n-------\n\nUse the APIs Explorer to call this API and see the API request and response."]]