Method: spaces.messages.create

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

create() メソッドには、ユーザー認証またはアプリの認証が必要です。Chat は、リクエストで使用する認証の種類に応じて、メッセージの送信者を異なる方法で属性付けします。

次の図は、アプリの認証を使用している場合に Chat でメッセージがどのように関連付けられるかを示しています。Chat ではメッセージの送信者として Chat アプリが表示されます。メッセージのコンテンツには、テキスト(text)、カード(cardsV2)、アクセサリ ウィジェット(accessoryWidgets)を含めることができます。

アプリの認証で送信されたメッセージ

次の図は、ユーザー認証を使用する場合に Chat でメッセージがどのように関連付けられるかを示しています。Chat では、ユーザーがメッセージの送信者として表示され、Chat アプリの名前を表示することでメッセージに関連付けられます。メッセージのコンテンツにはテキスト(text)のみを含めることができます。

ユーザー認証で送信されたメッセージ

メッセージの内容を含むメッセージの最大サイズは 32,000 バイトです。

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。システムによって割り当てられた ID をメッセージのリソース名(メッセージの name フィールドに表示)に保存することなく、Chat アプリでメッセージを取得、更新、削除できます。

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

  • 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 エラーが返されます。