Method: spaces.messages.create

Google Chat スペースでメッセージを作成する。例については、メッセージを作成するをご覧ください。

このメソッドを呼び出すには認証が必要で、次の認証タイプがサポートされています。

  • テキスト メッセージの場合、ユーザー認証またはアプリ認証がサポートされています。
  • カード メッセージの場合は、アプリ認証のみがサポートされます。(カード メッセージを作成できるのは Chat アプリのみです)。

HTTP リクエスト

POST https://chat.googleapis.com/v1/{parent=spaces/*}/messages

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

必須。メッセージを作成するスペースのリソース名。

形式: spaces/{space}

クエリ パラメータ

パラメータ
threadKey
(deprecated)

string

省略可。非推奨: 代わりに thread.thread_key を使用してください。スレッドの ID。4,000 文字まで使用できます。スレッドを開始する、またはスレッドに追加するには、メッセージを作成し、threadKey または thread.name を指定します。使用例については、メッセージ スレッドを開始または返信するをご覧ください。

requestId

string

省略可。このメッセージの一意のリクエスト ID。既存のリクエスト ID を指定すると、新しいメッセージは作成されず、その ID で作成されたメッセージが返されます。

messageReplyOption

enum (MessageReplyOption)

省略可。メッセージがスレッドを開始するか、スレッドに返信するかを指定します。名前付きスペースでのみサポートされます。

messageId

string

省略可。メッセージのカスタム ID。Chat アプリは、システム割り当ての ID をメッセージのリソース名(メッセージ name フィールドに表示されます)に保存することなく、メッセージを取得、更新、削除できます。

このフィールドの値は次の要件を満たす必要があります。

  • client- で始まります。たとえば、client-custom-name は有効なカスタム ID ですが、custom-name は無効です。
  • 最大 63 文字で、英小文字、数字、ハイフンのみを使用できます。
  • スペース内で一意である。Chat アプリでは、異なるメッセージに同じカスタム ID を使用することはできません。

詳しくは、メッセージに名前を付けるをご覧ください。

リクエスト本文

リクエストの本文には Message のインスタンスが含まれています。

レスポンスの本文

成功した場合、レスポンスの本文には、新しく作成された Message のインスタンスが含まれます。

承認スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.create

詳しくは、承認ガイドをご覧ください。

MessageReplyOption

メッセージへの返信方法を指定します。今後、さらに多くの州が追加される可能性があります。

列挙型
MESSAGE_REPLY_OPTION_UNSPECIFIED デフォルト。新しいスレッドを開始します。このオプションを使用すると、含まれる thread ID または threadKey がすべて無視されます。
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD thread ID または threadKey で指定されたスレッドへの返信としてメッセージを作成します。失敗した場合は、代わりに新しいスレッドが開始されます。
REPLY_MESSAGE_OR_FAIL thread ID または threadKey で指定されたスレッドへの返信としてメッセージを作成します。新しい threadKey を使用すると、新しいスレッドが作成されます。メッセージの作成に失敗した場合は、代わりに NOT_FOUND エラーが返されます。