REST Resource: spaces.messages

string

ID。メッセージのリソース名。

形式: spaces/{space}/messages/{message}

ここで、{space} はメッセージが投稿されたスペースの ID、{message} はシステムによって割り当てられたメッセージの ID です。例: spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB

メッセージの作成時にカスタム ID を設定した場合は、この ID を使用してリクエストでメッセージを指定できます。その際は、{message} を clientAssignedMessageId フィールドの値に置き換えます。例: spaces/AAAAAAAAAAA/messages/client-custom-name。詳しくは、メッセージに名前を付けるをご覧ください。

object (User)

出力専用。メッセージを作成したユーザー。Chat 用アプリがユーザーとして認証されると、出力には user の name と type が入力されます。

string (Timestamp format)

省略可。変更不可。Chat で作成されたスペースの場合、メッセージが作成された時刻。このフィールドは、インポート モードのスペースで使用される場合を除き、出力専用です。

インポート モードのスペースの場合、元の作成時間を保持するために、このフィールドをメッセージがソースで作成されたときの過去のタイムスタンプに設定します。

string (Timestamp format)

出力専用。ユーザーがメッセージを最後に編集した日時。メッセージが編集されたことがない場合、このフィールドは空になります。

string (Timestamp format)

出力専用。Google Chat でメッセージが削除された時刻。メッセージが削除されない場合、このフィールドは空です。

string

省略可。メッセージのプレーン テキストの本文。画像、動画、ウェブページへの最初のリンクは、プレビュー チップを生成します。Google Chat ユーザーまたはスペース内の全員を@メンションすることもできます。

テキスト メッセージの作成については、メッセージを送信するをご覧ください。

string

出力専用。フォーマットを伝えるためのマークアップが追加されたメッセージ text が含まれます。このフィールドには、UI に表示されるすべての書式設定が反映されない場合がありますが、次のものが含まれます。

• 太字、斜体、取り消し線、等幅、等幅ブロック、箇条書きのマークアップ構文。

• ユーザーメンション。形式は <users/{user}> です。

• <{url}|{rendered_text}> 形式のカスタム ハイパーリンク。最初の文字列は URL、2 番目の文字列はレンダリングされたテキストです（例: <http://example.com|custom text>）。

• :{emojiName}: 形式のカスタム絵文字（例: :smile:）。これは、笑顔の絵文字の U+1F600 などの Unicode 絵文字には適用されません。

• アスタリスク（*）を使用して箇条書きの項目を作成します（例: * item）。

詳しくは、メッセージで送信されたテキストの書式設定を表示するをご覧ください。

object (Card)

非推奨: 代わりに、cardsV2 を使用してください。

書式設定されたテキスト、ボタン、クリック可能な画像などの UI 要素を表示するために使用できる、書式設定されたインタラクティブなリッチカード。通常、カードはメッセージのプレーン テキスト本文の下に表示されます。cards と cardsV2 の最大サイズは 32 KB です。

object (CardWithId)

省略可。カードの配列。

カードを作成できるのは Chat 用アプリのみです。Chat 用アプリがユーザーとして認証される場合、メッセージにカードを含めることはできません。

カードを含むメッセージを作成する方法については、メッセージを送信するをご覧ください。

カードビルダーでカードを設計してプレビューします。

object (Annotation)

出力専用。アノテーションは、メッセージのプレーン テキストの本文、または startIndex と length が 0 の Google ドキュメントや Google スプレッドシートなどの Google Workspace リソースにリンクするチップに関連付けることができます。

object (Thread)

メッセージが属するスレッド。使用例については、メッセージ スレッドを開始する、または返信するをご覧ください。

object (Space)

出力専用。Chat 用アプリがユーザーとして認証される場合、出力には space name のみが入力されます。

string

省略可。メッセージのカードのプレーン テキストの説明。実際のカードを表示できない場合（モバイル通知など）に使用されます。

object (ActionResponse)

入力のみのChat 用アプリがレスポンスの投稿方法を構成するために使用できるパラメータ。

string

出力専用。すべての Chat 用アプリのメンションが削除されたメッセージの書式なしテキストの本文。

object (SlashCommand)

出力専用。スラッシュ コマンド情報（該当する場合）。

object (Attachment)

省略可。ユーザーがアップロードした添付ファイル。

object (MatchedUrl)

出力専用。リンク プレビュー パターンに一致する spaces.messages.text の URL。詳細については、リンクをプレビューするをご覧ください。

boolean

出力専用。true の場合、メッセージは返信スレッドの返信です。false の場合、メッセージはスペースのトップレベルの会話で、スレッドの最初のメッセージまたはスレッド形式の返信がないメッセージとして表示されます。

スペースがスレッドでの返信をサポートしていない場合、このフィールドは常に false です。

string

省略可。メッセージのカスタム ID。フィールドを使用して、メッセージを識別したり、メッセージの取得、削除、更新を行ったりできます。カスタム ID を設定するには、メッセージの作成時に messageId フィールドを指定します。詳しくは、メッセージに名前を付けるをご覧ください。

object (EmojiReactionSummary)

出力専用。メッセージに対する絵文字のリアクションの概要のリスト。

object (User)

省略可。変更不可。メッセージを作成するための入力。それ以外の場合は出力のみ。メッセージを閲覧できるユーザー。設定すると、メッセージは非公開になり、指定されたユーザーと Chat 用アプリにのみ表示されます。このフィールドをリクエストに含めるには、アプリ認証を使用して Chat API を呼び出し、次の項目を省略する必要があります。

• 添付ファイル
• アクセサリー ウィジェット

詳しくは、非公開でメッセージを送信するをご覧ください。

object (DeletionMetadata)

出力専用。削除されたメッセージに関する情報。deleteTime が設定されている場合、メッセージは削除されます。

object (QuotedMessageMetadata)

省略可。別のメッセージが引用しているメッセージに関する情報。

メッセージを作成する際に、同じスレッド内のメッセージを引用したり、ルート メッセージを引用して新しいルート メッセージを作成したりできます。ただし、別のスレッドのメッセージの返信を引用することはできません。

メッセージを更新するときに、quotedMessageMetadata フィールドを追加または置換することはできませんが、削除することはできます。

使用例については、別のメッセージを引用するをご覧ください。

object (AttachedGif)

出力専用。メッセージに添付された GIF 画像。

object (AccessoryWidget)

省略可。メッセージの下部に表示される 1 つ以上のインタラクティブ ウィジェット。テキスト、カード、またはテキストとカードの両方を含むメッセージに、アクセサリ ウィジェットを追加できます。ダイアログを含むメッセージではサポートされていません。詳しくは、メッセージの下部にインタラクティブ ウィジェットを追加するをご覧ください。

アクセサリ ウィジェットを含むメッセージを作成するには、アプリの認証が必要です。