Google Chat スペースにメッセージを作成します。例については、メッセージを送信するをご覧ください。
create()
メソッドには、ユーザー認証またはアプリの認証が必要です。Chat は、リクエストで使用する認証の種類に応じて、メッセージの送信者を異なる方法で属性付けします。
次の図は、アプリ認証を使用する場合に Chat がメッセージをどのように属性付けるかを示しています。Chat には、メッセージの送信者として Chat アプリが表示されます。メッセージのコンテンツには、テキスト(text
)、カード(cardsV2
)、アクセサリ ウィジェット(accessoryWidgets
)を含めることができます。
次の図は、ユーザー認証を使用した場合に Chat がメッセージをどのように属性付けるかを示しています。Chat では、ユーザーがメッセージの送信者として表示され、Chat アプリの名前を表示することでメッセージに関連付けられます。メッセージの内容にはテキスト(text
)のみを含めることができます。
メッセージの内容を含むメッセージの最大サイズは 32,000 バイトです。
Webhook リクエストの場合、レスポンスにはメッセージ全体が含まれません。レスポンスには、リクエスト内の情報に加えて、name
フィールドと thread.name
フィールドのみが入力されます。
HTTP リクエスト
POST https://chat.googleapis.com/v1/{parent=spaces/*}/messages
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
parent |
必須。メッセージを作成するスペースのリソース名。 形式: |
クエリ パラメータ
パラメータ | |
---|---|
threadKey |
省略可。非推奨: 代わりに |
request |
省略可。このメッセージの一意のリクエスト ID。既存のリクエスト ID を指定すると、新しいメッセージが作成されるのではなく、その ID で作成されたメッセージが返されます。 |
message |
省略可。メッセージがスレッドを開始するか、スレッドに返信するかを指定します。名前付きスペースでのみサポートされます。 ユーザー操作に応答する場合、このフィールドは無視されます。スレッド内のやり取りの場合、返信は同じスレッド内で作成されます。それ以外の場合は、返信が新しいスレッドとして作成されます。 |
message |
省略可。メッセージのカスタム ID。システムが割り当てた 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 または は無視されます。 |
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD |
thread ID または で指定されたスレッドへの返信としてメッセージを作成します。失敗した場合は、代わりに新しいスレッドが開始されます。 |
REPLY_MESSAGE_OR_FAIL |
thread ID または で指定されたスレッドへの返信としてメッセージを作成します。新しい threadKey が使用された場合、新しいスレッドが作成されます。メッセージの作成に失敗した場合は、代わりに NOT_FOUND エラーが返されます。 |