LiveChatMessages: insert

チャットにメッセージやアンケートを追加します。

一般的なユースケース

リクエスト

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 または pollEvent のいずれかを選択します。
  • タイプが textMessageEvent の場合は、snippet.textMessageDetails.messageText を含めます。
  • 型が pollEvent の場合は、次の値を持つ snippet.pollDetails を含めます。 <ph type="x-smartling-placeholder">
      </ph>
    • snippet.pollDetails.metadata.options.questionText
    • snippet.pollDetails.metadata.options.optionText のリスト。リストの項目は 2 ～ 5 個にする必要があります。アイテムは、リストされている順に順番に表示されます。

レスポンス

成功すると、このメソッドはレスポンスの本文で liveChatMessage リソースを返します。

エラー

次の表に、このメソッドの呼び出しへのレスポンスとして API から返されるエラー メッセージを示します。詳しくは、エラー メッセージのドキュメントをご覧ください。

エラーのタイプ エラーの詳細 説明
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 のリクエストとレスポンスを確認します。