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 |
必須。メッセージを作成するスペースのリソース名。 形式: |
クエリ パラメータ
パラメータ | |
---|---|
threadKey |
省略可。非推奨: 代わりに |
requestId |
省略可。このメッセージの一意のリクエスト ID。既存のリクエスト ID を指定すると、新しいメッセージを作成するのではなく、その ID で作成されたメッセージが返されます。 |
messageReplyOption |
省略可。メールがスレッドを開始するか、スレッドに返信するかを指定します。名前付きスペースでのみサポートされています。 |
messageId |
省略可。メッセージのカスタム 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 エラーが返されます。 |