LiveChatMessages: insert

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

一般的なユースケース

リクエスト

HTTP リクエスト

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

承認

このリクエストは、少なくとも次のうち 1 つのスコープによる承認が必要です。認証と認可の詳細については、OAuth 2.0 認証の実装をご覧ください。

範囲
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 と次の値を含めます。
    • snippet.pollDetails.metadata.options.questionText
    • snippet.pollDetails.metadata.options.optionText のリスト。2 つ以上の項目を指定する必要があります。指定できる項目は 5 つまでです。アイテムは、リストされている順序で順番に表示されます。

レスポンス

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

エラー

次の表に、このメソッドの呼び出しに対する応答として API から返される可能性のあるエラー メッセージを示します。詳細については、YouTube Live Streaming 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 ユーザーが特定の期間に投稿した Chat メッセージが多すぎる。

試してみよう:

APIs Explorer を使用してこの API を呼び出し、API リクエストとレスポンスを確認します。