- HTTP リクエスト
- パスパラメータ
- クエリ パラメータ
- リクエストの本文
- レスポンスの本文
- 認可スコープ
- MessageReplyOption
- CreateMessageNotificationOptions
- NotificationType
- 試してみる
Google Chat スペースにメッセージを作成します。例については、メッセージを送信するをご覧ください。
次の種類の認証をサポートしています。
- アプリ認証。認可スコープは次のとおりです。
https://www.googleapis.com/auth/chat.bot
- 次のいずれかの認可スコープを使用したユーザー認証。
https://www.googleapis.com/auth/chat.messages.createhttps://www.googleapis.com/auth/chat.messageshttps://www.googleapis.com/auth/chat.import(インポート モードのスペースのみ)
Chat では、リクエストで使用する認証の種類に応じて、メッセージの送信者の属性が異なります。
次の図は、アプリ認証を使用した場合に Chat がメッセージをどのように属性付けするかを示しています。Chat には、メッセージの送信者として Chat 用アプリが表示されます。メッセージの内容には、テキスト(text)、カード(cardsV2)、アクセサリー ウィジェット(accessoryWidgets)を含めることができます。
次の図は、ユーザー認証を使用した場合に Chat がメッセージをどのように属性付けするかを示しています。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 |
省略可。非推奨: 代わりに、 |
requestId |
省略可。このリクエストの一意の ID。ランダムな UUID をおすすめします。リクエスト ID を指定すると、リクエストがべき等になり、同じリクエスト ID を持つ複数の同一のリクエストで作成されるメッセージが 1 つだけになります。同じリクエスト ID を持つ後続のリクエストは、リクエストされた詳細が現在の状態と異なる場合でも、既存のメッセージを返し、メッセージを更新しません。 このフィールドを効果的に使用するには:
|
messageReplyOption |
省略可。メッセージがスレッドを開始するか、スレッドに返信するかを指定します。名前付きスペースでのみサポートされます。 ユーザー インタラクションに応答する場合、このフィールドは無視されます。スレッド内のやり取りの場合、返信は同じスレッド内に作成されます。それ以外の場合、返信は新しいスレッドとして作成されます。 |
messageId |
省略可。メッセージのカスタム ID。Chat 用アプリは、メッセージのリソース名(メッセージの このフィールドの値は、次の要件を満たす必要があります。
詳しくは、メッセージに名前を付けるをご覧ください。 |
createMessageNotificationOptions |
省略可。メッセージが投稿されたときの通知動作を制御します。詳細については、通知を強制する、またはサイレント メッセージを送信するをご覧ください。 |
リクエストの本文
リクエストの本文には Message のインスタンスが含まれます。
レスポンスの本文
成功した場合、レスポンスの本文には、新しく作成された Message のインスタンスが含まれます。
認可スコープ
次の OAuth スコープのいずれかが必要です。
https://www.googleapis.com/auth/chat.bothttps://www.googleapis.com/auth/chat.importhttps://www.googleapis.com/auth/chat.messageshttps://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 エラーが返されます。 |
CreateMessageNotificationOptions
メッセージが投稿されたときの通知動作のオプション。
| JSON 表現 |
|---|
{
"notificationType": enum ( |
| フィールド | |
|---|---|
notificationType |
メッセージの通知タイプ。 |
NotificationType
メッセージの通知タイプのオプション。
| 列挙型 | |
|---|---|
NOTIFICATION_TYPE_NONE |
デフォルトの動作。通知の動作は、人間のユーザーが Chat UI を使用してメッセージを送信する場合と同様です。人間の送信者には通知が送信されません。 |
NOTIFICATION_TYPE_INCLUDE_HUMAN_CREATOR |
メッセージ作成者ユーザー(メッセージの作成に使用された認証のユーザーなど)に通知(プッシュ通知、メール通知など)が送信され、メッセージは未読としてマークされます。 この設定によって、スペースの既存のユーザー通知設定がオーバーライドされることはありません。たとえば、ユーザーがスペースの通知を受け取らないように設定している場合、このオプションが設定されていても通知は届きません。 ユーザー認証が必要です。 |
NOTIFICATION_TYPE_FORCE_NOTIFY |
受信者に強制的に通知します。この通知は、ユーザーのスペースの通知設定と Google Chat のサイレント モードの設定をバイパスします。このオプションでは、デバイスレベルのサイレント モード設定はバイパスされません。 アプリ認証が必要です。 |
NOTIFICATION_TYPE_SILENT |
受信者に通知せず、メールを未読としてマークしません。これは、ユーザーが会話をミュートしたり、Chat のサイレント モードを有効にしたりした場合と同様に動作します。 アプリ認証が必要です。 |