チャットにメッセージを追加します。現在、この API はテキスト メッセージのみを挿入する機能をサポートしています。
一般的なユースケース
リクエスト
HTTP リクエスト
POST https://www.googleapis.com/youtube/v3/liveChat/messages
認可
このリクエストは、少なくとも次のうち 1 つのスコープでの承認が必要です(認証と承認の詳細をご確認ください)。
範囲 |
---|
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
パラメータ
次の表に、このクエリでサポートされているパラメータを示します。このリストのパラメータはすべてクエリ パラメータです。
パラメータ | ||
---|---|---|
必須パラメータ | ||
part |
string part パラメータは 2 つの目的を果たします。書き込み操作で設定されるプロパティと、API レスポンスに含まれるプロパティを指定します。パラメータ値を snippet に設定します。 |
リクエスト本文
リクエストの本文に liveChatMessage リソースを指定します。このリソースについて:
-
以下のプロパティの値を指定する必要があります。
snippet.liveChatId
snippet.type
: 現在サポートされている値はtextMessageEvent
のみです。snippet.textMessageDetails.messageText
レスポンス
成功すると、このメソッドはレスポンスの本文で liveChatMessage リソースを返します。
エラー
次の表に、このメソッドの呼び出しに対して API から返されるエラー メッセージを示します。詳細については、エラー メッセージのドキュメントを参照してください。
エラーのタイプ | エラーの詳細 | 説明 |
---|---|---|
forbidden (403) |
forbidden |
指定したメッセージを作成するために必要な権限がありません。 |
forbidden (403) |
liveChatDisabled |
指定したチャットは所有者によって無効にされているため、チャットにメッセージを追加できません。 |
forbidden (403) |
liveChatEnded |
指定したチャットは公開されていません。 |
invalidValue (400) |
messageTextInvalid |
メッセージ テキスト(snippet.textMessageDetails.messageText )が無効です。 |
notFound (404) |
liveChatNotFound |
API リクエストで指定されたチャットが存在しません。このエラーは、オーナーがチャットを削除した場合に発生します。 |
rateLimitExceeded |
rateLimitExceeded |
ユーザーが一定期間内に投稿したチャット メッセージの数が多すぎます。 |
required (400) |
liveChatIdRequired |
liveChatMessage リソースには、snippet.liveChatId プロパティの値が含まれており、これを指定する必要があります。 |
required (400) |
messageTextRequired |
liveChatMessage リソースには、snippet.textMessageDetails.messageText プロパティの値が含まれており、これを指定する必要があります。 |
required (400) |
typeRequired |
liveChatMessage リソースには、snippet.type プロパティの値が含まれており、これを指定する必要があります。パラメータ値を text に設定します。 |
試してみよう:
APIs Explorer を使用してこの API を呼び出し、API のリクエストとレスポンスを確認します。