Method: spaces.messages.create

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

次の種類の認証をサポートしています。

  • アプリ認証。認可スコープは次のとおりです。
    • https://www.googleapis.com/auth/chat.bot
  • 次のいずれかの認可スコープを使用したユーザー認証。
    • https://www.googleapis.com/auth/chat.messages.create
    • https://www.googleapis.com/auth/chat.messages
    • https://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

string

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

形式: spaces/{space}

クエリ パラメータ

パラメータ
threadKey
(deprecated)

string

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

requestId

string

省略可。このリクエストの一意の ID。ランダムな UUID をおすすめします。リクエスト ID を指定すると、リクエストがべき等になり、同じリクエスト ID を持つ複数の同一のリクエストで作成されるメッセージが 1 つだけになります。同じリクエスト ID を持つ後続のリクエストは、リクエストされた詳細が現在の状態と異なる場合でも、既存のメッセージを返し、メッセージを更新しません。

このフィールドを効果的に使用するには:

  • 後続のリクエストが元のリクエストと同じであり、同じ認証情報を使用していることを確認します。
  • 指定されたリクエスト ID でメッセージがすでに作成されている場合、リクエストはそのメッセージを返します。返されたメッセージが完全に入力されていない場合があります。API は、システム割り当てのリソース名が入力されたリクエスト内のメッセージをエコーします。メッセージの最新のメタデータを取得するには、messages.get を呼び出します。
  • 既存のリクエスト ID を別の認証済みユーザーで再利用すると、エラーが発生します。
messageReplyOption

enum (MessageReplyOption)

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

ユーザー インタラクションに応答する場合、このフィールドは無視されます。スレッド内のやり取りの場合、返信は同じスレッド内に作成されます。それ以外の場合、返信は新しいスレッドとして作成されます。

messageId

string

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

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

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

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

createMessageNotificationOptions

object (CreateMessageNotificationOptions)

省略可。メッセージが投稿されたときの通知動作を制御します。詳細については、通知を強制する、またはサイレント メッセージを送信するをご覧ください。

リクエストの本文

リクエストの本文には 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 エラーが返されます。

CreateMessageNotificationOptions

メッセージが投稿されたときの通知動作のオプション。

JSON 表現
{
  "notificationType": enum (NotificationType)
}
フィールド
notificationType

enum (NotificationType)

メッセージの通知タイプ。

NotificationType

メッセージの通知タイプのオプション。

列挙型
NOTIFICATION_TYPE_NONE デフォルトの動作。通知の動作は、人間のユーザーが Chat UI を使用してメッセージを送信する場合と同様です。人間の送信者には通知が送信されません。
NOTIFICATION_TYPE_INCLUDE_HUMAN_CREATOR

メッセージ作成者ユーザー(メッセージの作成に使用された認証のユーザーなど)に通知(プッシュ通知、メール通知など)が送信され、メッセージは未読としてマークされます。

この設定によって、スペースの既存のユーザー通知設定がオーバーライドされることはありません。たとえば、ユーザーがスペースの通知を受け取らないように設定している場合、このオプションが設定されていても通知は届きません。

ユーザー認証が必要です。

NOTIFICATION_TYPE_FORCE_NOTIFY

受信者に強制的に通知します。この通知は、ユーザーのスペースの通知設定と Google Chat のサイレント モードの設定をバイパスします。このオプションでは、デバイスレベルのサイレント モード設定はバイパスされません。

アプリ認証が必要です。

NOTIFICATION_TYPE_SILENT

受信者に通知せず、メールを未読としてマークしません。これは、ユーザーが会話をミュートしたり、Chat のサイレント モードを有効にしたりした場合と同様に動作します。

アプリ認証が必要です。