LiveChatMessages: insert

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

割り当てへの影響: このメソッドの呼び出しには、20 ユニットの割り当て費用が発生します。

一般的なユースケース

リクエスト

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 パラメータには 2 つの目的があります。書き込みオペレーションによって設定されるプロパティと、API レスポンスに含まれるプロパティを識別します。パラメータ値を snippet に設定します。

リクエストの本文

リクエストの本文に liveChatMessage リソースを指定します。 そのリソースに対して、これらのプロパティの値を指定する必要があります。

  • snippet.liveChatId
  • snippet.type - 次のいずれかのオプションを選択します: textMessageEvent または pollEvent
  • type が textMessageEvent の場合は、snippet.textMessageDetails.messageText を含めます。
  • type が pollEvent の場合は、次のように構造化された snippet.pollDetails オブジェクトを含めます。
    • snippet.pollDetails.metadata.questionText（文字列）: アンケートのメインの質問。
    • snippet.pollDetails.metadata.options（配列）: オプション オブジェクトのリスト。
    • 要件: 2 ～ 4 個のアイテムを含める必要があります。
    • 順序: アイテムは、リストに記載されている順序で表示されます。
    • 配列内の各オブジェクトには、次の要素を含める必要があります。
      • optionText（文字列）: その特定のアンケートの選択肢に表示されるテキスト。

レスポンス

成功すると、このメソッドはレスポンスの本文で 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 ユーザーが特定の期間に投稿したチャット メッセージが多すぎます。

試してみよう:

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