REST Resource: spaces.messages

リソース: Message

Google Chat スペース内のメッセージ。

JSON 表現 
{
  "name": string,
  "sender": {
    object (User)
  },
  "createTime": string,
  "lastUpdateTime": string,
  "deleteTime": string,
  "text": string,
  "formattedText": string,
  "cards": [
    {
      object (Card)
    }
  ],
  "cardsV2": [
    {
      object (CardWithId)
    }
  ],
  "annotations": [
    {
      object (Annotation)
    }
  ],
  "thread": {
    object (Thread)
  },
  "space": {
    object (Space)
  },
  "fallbackText": string,
  "actionResponse": {
    object (ActionResponse)
  },
  "argumentText": string,
  "slashCommand": {
    object (SlashCommand)
  },
  "attachment": [
    {
      object (Attachment)
    }
  ],
  "matchedUrl": {
    object (MatchedUrl)
  },
  "threadReply": boolean,
  "silent": boolean,
  "clientAssignedMessageId": string,
  "emojiReactionSummaries": [
    {
      object (EmojiReactionSummary)
    }
  ],
  "privateMessageViewer": {
    object (User)
  },
  "deletionMetadata": {
    object (DeletionMetadata)
  },
  "quotedMessageMetadata": {
    object (QuotedMessageMetadata)
  },
  "attachedGifs": [
    {
      object (AttachedGif)
    }
  ],
  "accessoryWidgets": [
    {
      object (AccessoryWidget)
    }
  ],
  "elements": {
    object (Elements)
  },
  "markupSyntax": enum (MarkupSyntax)
}
フィールド
name

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。詳しくは、メッセージに名前を付けるをご覧ください。
sender

object (User)

出力専用。メッセージを作成したユーザー。Chat アプリがユーザーとして認証する場合、出力には、内部ユーザーと外部ユーザーの両方の user name フィールドと type フィールドのみが入力されます。ただし、スペースのメンバーである場合や、呼び出し元ユーザーとのダイレクト メッセージ（DM）会話など、以前に親和性があった場合を除きます。
createTime

string (Timestamp format)

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

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

string (Timestamp format)

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

string (Timestamp format)

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

string

省略可。メッセージの書式なしテキスト本文。画像、動画、ウェブページへの最初のリンクでは、プレビュー チップが生成されます。Google Chat ユーザーに名前リンクを付けるか、スペース内の全員に名前リンクを付けることもできます。

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

string

出力専用。書式設定を伝えるためにマークアップが追加されたメッセージ text が含まれます。このフィールドでは、UI に表示されるすべての書式設定がキャプチャされるわけではありませんが、次のものが含まれます。

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

  • ユーザー メンション（<users/{user}> 形式）。

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

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

  • アスタリスク（*）を使用した箇条書きリストの項目（例: * item）。

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

object (Card)

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

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

object (CardWithId)

省略可。カードの配列。

Chat 用アプリは、アプリ認証を使用してカードを作成できます。デベロッパー プレビュー プログラムの一環として、Chat アプリがユーザーとして認証されると、カード メッセージを作成できます。Chat アプリがデベロッパー プレビュー プログラムに参加していない場合、ユーザー認証付きのカードを作成することはできません。

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

カードビルダーを使用してカードを設計し、プレビューする。

カードビルダーを開く
annotations[]

object (Annotation)

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

object (Thread)

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

object (Space)

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

string

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

object (ActionResponse)

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

string

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

object (SlashCommand)

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

object (Attachment)

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

object (MatchedUrl)

出力専用。Chat メッセージの text フィールドにある URL が、リンク プレビューのパターンと一致している。詳細については、リンクをプレビューするをご覧ください。
threadReply

boolean

出力専用。true の場合、メッセージは返信スレッド内の返信です。false の場合、メッセージはスペースの最上位の会話に、スレッドの最初のメッセージまたはスレッド返信のないメッセージとして表示されます。

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

boolean

出力専用。サイレント メッセージかどうか。サイレント メッセージとは、受信者へのプッシュ通知が Chat によって抑制されるメッセージです。
clientAssignedMessageId

string

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

object (EmojiReactionSummary)

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

object (User)

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

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

object (DeletionMetadata)

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

object (QuotedMessageMetadata)

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

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

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

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

object (AttachedGif)

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

object (AccessoryWidget)

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

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

object (Elements)

省略可。要素は、メッセージの作成時に提供される追加のコンポーネントであり、メッセージ テキストの特定の部分に関連付けられている場合と、関連付けられていない場合があります。これはアノテーションとは異なります。アノテーションは出力専用で、メッセージ フラグメントまたはメッセージ テキスト全体に関連付けられた補足情報を提供します。
markupSyntax

enum (MarkupSyntax)

省略可。サーバーがメッセージの text フィールドの内容を解釈する方法を指定します。

CardWithId

Google Chat メッセージ内のカード。

Chat 用アプリは、アプリ認証を使用してカードを作成できます。デベロッパー プレビュー プログラムの一環として、Chat アプリがユーザーとして認証されると、カード メッセージを作成できます。Chat アプリがデベロッパー プレビュー プログラムに参加していない場合、ユーザー認証付きのカードを作成することはできません。

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

カードビルダーを使用してカードを設計し、プレビューする。

カードビルダーを開く

JSON 表現 
{
  "cardId": string,
  "card": {
    object (Card)
  },
  "ownerUser": {
    object (User)
  }
}
フィールド
cardId

string

メッセージに複数のカードが含まれている場合は必須です。メッセージ内のカードの固有識別子。
card

object (Card)

カード。最大サイズは 32 KB です。
ownerUser

object (User)

出力専用。カードを所有するアプリ。

メモ

アノテーションは、メッセージの書式なしテキスト本文に関連付けることも、startIndex と length が 0 の Google ドキュメントやスプレッドシートなどの Google Workspace リソースにリンクするチップに関連付けることもできます。テキスト メッセージに基本的な書式設定を追加するには、テキスト メッセージの書式設定をご覧ください。

書式なしテキストのメール本文の例:

Hello @FooBot how are you!"

対応するアノテーション メタデータ:

"annotations":[{
  "type":"USER_MENTION",
  "startIndex":6,
  "length":7,
  "userMention": {
    "user": {
      "name":"users/{user}",
      "displayName":"FooBot",
      "avatarUrl":"https://goo.gl/aeDtrS",
      "type":"BOT"
    },
    "type":"MENTION"
   }
}]
JSON 表現 
{
  "type": enum (AnnotationType),
  "length": integer,
  "startIndex": integer,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "userMention": {
    object (UserMentionMetadata)
  },
  "slashCommand": {
    object (SlashCommandMetadata)
  },
  "richLinkMetadata": {
    object (RichLinkMetadata)
  },
  "customEmojiMetadata": {
    object (CustomEmojiMetadata)
  }
}
フィールド
type

enum (AnnotationType)

このアノテーションのタイプ。
length

integer

このアノテーションが対応する、書式なしテキストのメール本文内の部分文字列の長さ。存在しない場合は、長さが 0 であることを示します。
startIndex

integer

このアノテーションが対応する、書式なしテキストのメッセージ本文の開始インデックス（0 ベース、両端を含む）。
アノテーションに関する追加のメタデータ。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
userMention

object (UserMentionMetadata)

ユーザー メンションのメタデータ。
slashCommand

object (SlashCommandMetadata)

スラッシュ コマンドのメタデータ。
customEmojiMetadata

object (CustomEmojiMetadata)

カスタム絵文字のメタデータ。
相互に排他的なフィールドの終了。

AnnotationType

アノテーションのタイプ。

列挙型
ANNOTATION_TYPE_UNSPECIFIED 列挙型のデフォルト値。使用しないでください。
USER_MENTION ユーザーがメンションされた。
SLASH_COMMAND スラッシュ コマンドが呼び出された。
CUSTOM_EMOJI カスタム絵文字のアノテーション。

UserMentionMetadata

ユーザー メンション（@）のアノテーション メタデータ。

JSON 表現 
{
  "user": {
    object (User)
  },
  "type": enum (Type)
}
フィールド
user

object (User)

お客様が言及した内容
type

enum (Type)

ユーザー メンションのタイプ。

タイプ

列挙型
TYPE_UNSPECIFIED 列挙型のデフォルト値。使用しないでください。
ADD スペースにユーザーを追加します。
MENTION スペースでユーザーにメンションする。

SlashCommandMetadata

スラッシュ コマンド（/）のアノテーション メタデータ。

JSON 表現 
{
  "bot": {
    object (User)
  },
  "type": enum (Type),
  "commandName": string,
  "commandId": string,
  "triggersDialog": boolean
}
フィールド
bot

object (User)

コマンドが呼び出された Chat 用アプリ。
type

enum (Type)

スラッシュ コマンドのタイプ。
commandName

string

呼び出されたスラッシュ コマンドの名前。
commandId

string (int64 format)

呼び出されたスラッシュ コマンドのコマンド ID。
triggersDialog

boolean

スラッシュ コマンドがダイアログ用かどうかを示します。

タイプ

列挙型
TYPE_UNSPECIFIED 列挙型のデフォルト値。使用しないでください。
ADD Chat 用アプリをスペースに追加します。
INVOKE スペースでスラッシュ コマンドを呼び出す。

RichLinkMetadata

リソースへのリッチリンク。リッチリンクは、メッセージの書式なしテキスト本文に関連付けることも、startIndex と length が 0 の Google ドキュメントやスプレッドシートなどの Google Workspace リソースにリンクするチップを表すこともできます。

JSON 表現 
{
  "uri": string,
  "richLinkType": enum (RichLinkType),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "driveLinkData": {
    object (DriveLinkData)
  },
  "chatSpaceLinkData": {
    object (ChatSpaceLinkData)
  },
  "meetSpaceLinkData": {
    object (MeetSpaceLinkData)
  },
  "calendarEventLinkData": {
    object (CalendarEventLinkData)
  }
}
フィールド
uri

string

このリンクの URI。
リンクされたリソースのデータ。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
相互に排他的なフィールドの終了。

RichLinkType

リッチリンクのタイプ。今後、さらにタイプが追加される可能性があります。

列挙型
DRIVE_FILE Google ドライブのリッチリンク タイプ。
CHAT_SPACE Chat スペースのリッチリンク タイプ。（例: スペースのスマートチップ）。
GMAIL_MESSAGE Gmail メッセージのリッチリンク タイプ。具体的には、[Chat に共有] の Gmail チップです。この API は、GMAIL_MESSAGE リンクを含むメッセージの読み取りのみをサポートしています。
MEET_SPACE Meet メッセージのリッチリンク タイプ。（例: Meet チップ）。
CALENDAR_EVENT カレンダー メッセージのリッチリンク タイプ。たとえば、カレンダー チップです。

DriveLinkData

Google ドライブのリンクのデータ。

JSON 表現 
{
  "driveDataRef": {
    object (DriveDataRef)
  },
  "mimeType": string
}
フィールド
driveDataRef

object (DriveDataRef)

Google ドライブ ファイルを参照する DriveDataRef。
mimeType

string

リンクされた Google ドライブ リソースの MIME タイプ。

ChatSpaceLinkData

Chat スペースのリンクのデータ。

JSON 表現 
{
  "space": string,
  "thread": string,
  "message": string
}
フィールド
space

string

リンクされた Chat スペース リソースのスペース。

形式: spaces/{space}
thread

string

リンクされた Chat スペース リソースのスレッド。

形式: spaces/{space}/threads/{thread}
message

string

リンクされた Chat スペース リソースのメッセージ。

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

MeetSpaceLinkData

Meet スペースのリンクのデータ。

JSON 表現 
{
  "meetingCode": string,
  "type": enum (Type),
  "huddleStatus": enum (HuddleStatus)
}
フィールド
meetingCode

string

リンクされた Meet スペースの会議コード。
type

enum (Type)

Meet スペースのタイプを示します。
huddleStatus

enum (HuddleStatus)

省略可。出力専用。Meet がハドルの場合、ハドルのステータスを示します。それ以外の場合、これは設定されません。

タイプ

Meet スペースのタイプ。

列挙型
TYPE_UNSPECIFIED 列挙型のデフォルト値。使用しないでください。
MEETING Meet のスペースは会議です。
HUDDLE Meet スペースがハドルである。

HuddleStatus

ハドルのステータス

列挙型
HUDDLE_STATUS_UNSPECIFIED 列挙型のデフォルト値。使用しないでください。
STARTED ハドルが開始されました。
ENDED ハドルが終了しました。この場合、Meet スペースの URI と ID は無効になります。
MISSED ハドルは不在着信となりました。この場合、Meet スペースの URI と ID は無効になります。

CalendarEventLinkData

カレンダーの予定リンクのデータ。

JSON 表現 
{
  "calendarId": string,
  "eventId": string
}
フィールド
calendarId

string

リンクされたカレンダーのカレンダー ID。
eventId

string

リンクされたカレンダーの予定の予定 ID。

CustomEmojiMetadata

カスタム絵文字のアノテーション メタデータ。

JSON 表現 
{
  "customEmoji": {
    object (CustomEmoji)
  }
}
フィールド
customEmoji

object (CustomEmoji)

カスタム絵文字。

スレッド

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

メッセージの作成時にスレッドを指定する場合は、messageReplyOption フィールドを設定して、一致するスレッドが見つからない場合の処理を決定できます。

JSON 表現 
{
  "name": string,
  "threadKey": string
}
フィールド
name

string

ID。スレッドのリソース名。

例: spaces/{space}/threads/{thread}
threadKey

string

省略可。スレッドの作成または更新のための入力。それ以外の場合は出力専用です。スレッドの ID。最大 4,000 文字に対応します。

この ID は、設定した Chat 用アプリに固有のものです。たとえば、複数の Chat 用アプリが同じスレッドキーを使用してメッセージを作成すると、メッセージは異なるスレッドに投稿されます。ユーザーまたは別の Chat 用アプリによって作成されたスレッドに返信するには、代わりにスレッドの name フィールドを指定します。

ActionResponse

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

JSON 表現 
{
  "type": enum (ResponseType),
  "url": string,
  "dialogAction": {
    object (DialogAction)
  },
  "updatedWidget": {
    object (UpdatedWidget)
  }
}
フィールド
type

enum (ResponseType)

入力専用。Chat 用アプリのレスポンスのタイプ。
url

string

入力専用。ユーザーが認証または構成するための URL。（REQUEST_CONFIG レスポンス タイプのみ）。
dialogAction

object (DialogAction)

入力専用。ダイアログに関連するインタラクション イベントへのレスポンス。ResponseType.Dialog と併用する必要があります。
updatedWidget

object (UpdatedWidget)

入力専用。更新されたウィジェットのレスポンス。

ResponseType

Chat 用アプリのレスポンスのタイプ。

列挙型
TYPE_UNSPECIFIED NEW_MESSAGE として処理されるデフォルトのタイプ。
NEW_MESSAGE トピックに新しいメッセージとして投稿する。
UPDATE_MESSAGE Chat 用アプリのメッセージを更新します。これは、メッセージ送信者のタイプが BOT である CARD_CLICKED イベントでのみ許可されます。
UPDATE_USER_MESSAGE_CARDS ユーザーのメッセージのカードを更新します。これは、一致する URL を含む MESSAGE イベント、またはメッセージ送信者のタイプが HUMAN である CARD_CLICKED イベントへのレスポンスとしてのみ許可されます。テキストは無視されます。
REQUEST_CONFIG ユーザーに追加の認証または構成を非公開でリクエストします。
DIALOG ダイアログを表示します。
UPDATE_WIDGET ウィジェットのテキスト予測入力オプションのクエリ。

DialogAction

ダイアログとリクエスト ステータス コードが含まれます。

JSON 表現 
{
  "actionStatus": {
    object (ActionStatus)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "dialog": {
    object (Dialog)
  }
}
フィールド
actionStatus

object (ActionStatus)

入力専用。ダイアログを呼び出すか送信するリクエストのステータス。必要に応じて、ステータスとメッセージをユーザーに表示します。たとえば、エラーが発生した場合や成功した場合などです。
実行するアクション。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
dialog

object (Dialog)

入力専用。リクエストのダイアログ。
相互に排他的なフィールドの終了。

ダイアログ

ダイアログのカード本文のラッパー。

JSON 表現 
{
  "body": {
    object (Card)
  }
}
フィールド
body

object (Card)

入力専用。ダイアログの本文。モーダルでレンダリングされます。Google Chat アプリは、カード エンティティ DateTimePicker、OnChangeAction をサポートしていません。

ActionStatus

ダイアログを呼び出すか送信するリクエストのステータスを表します。

JSON 表現 
{
  "statusCode": enum (Code),
  "userFacingMessage": string
}
フィールド
statusCode

enum (Code)

ステータス コード。
userFacingMessage

string

リクエストのステータスについてユーザーに送信するメッセージ。設定されていない場合は、statusCode に基づく一般的なメッセージが送信されます。

コード

gRPC API の正規のエラーコード。

複数のエラーコードが該当する場合があります。サービスは、該当する最も具体的なエラーコードを返す必要があります。たとえば、両方のコードが該当する場合、FAILED_PRECONDITION より OUT_OF_RANGE を優先します。同様に、FAILED_PRECONDITION より NOT_FOUND または ALREADY_EXISTS を優先します。

列挙型
OK

エラーではありません。成功したときに返されます。

HTTP マッピング: 200 OK
CANCELLED

オペレーションがキャンセルされました。通常、キャンセルは呼び出し元により行われます。

HTTP マッピング: 499 クライアントのクローズ リクエスト
UNKNOWN

不明なエラーです。たとえば、別のアドレス空間から受信した Status 値がこのアドレス空間で不明なエラー空間に属している場合に、このエラーが返される可能性があります。また、十分なエラー情報を返さない API によって発生したエラーは、このエラーに変換できます。

HTTP マッピング: 500 内部サーバーエラー
INVALID_ARGUMENT

クライアントが無効な引数を指定しました。これは FAILED_PRECONDITION とは異なることに注意してください。INVALID_ARGUMENT は、システムの状態を問わず問題（ファイル名の形式が不適切であるなど）があった引数を示します。

HTTP マッピング: 400 不正なリクエスト
DEADLINE_EXCEEDED

オペレーションが完了する前に期限が切れました。システムの状態を変更するオペレーションの場合、オペレーションが正常に終了しても、このエラーが返されることがあります。たとえば、サーバーからの正常なレスポンスが期限切れになるほど遅延する場合もあります。

HTTP マッピング: 504 ゲートウェイ タイムアウト
NOT_FOUND

一部のリクエストされたエンティティ（ファイルやディレクトリなど）が見つかりませんでした。

サーバー デベロッパーへの注: 段階的な機能のロールアウトや文書化されていない許可リストなど、ユーザークラス全体に対してリクエストが拒否された場合は、NOT_FOUND を使用できます。ユーザー単位のアクセス制御など、あるユーザークラス内の一部のユーザーに対してリクエストが拒否された場合は、PERMISSION_DENIED を使用する必要があります。

HTTP マッピング: 404 見つかりません
ALREADY_EXISTS

クライアントが作成しようとしたエンティティ（ファイルまたはディレクトリなど）はすでに存在しています。

HTTP マッピング: 409 競合
PERMISSION_DENIED

呼び出し元には、指定されたオペレーションを実行する権限がありません。PERMISSION_DENIED は一部のリソースが枯渇し拒否されたため使用できません（このようなエラーには代わりに RESOURCE_EXHAUSTED を使用します）。呼び出し元が特定できない場合は、PERMISSION_DENIED を使用しないでください（このようなエラーには代わりに UNAUTHENTICATED を使用します）。このエラーコードは、リクエストが有効であること、リクエストされたエンティティが存在すること、および他の事前条件が満たされていることを意味するものではありません。

HTTP マッピング: 403 禁止です
UNAUTHENTICATED

リクエストにはオペレーションに有効な認証情報がありません。

HTTP マッピング: 401 権限なし
RESOURCE_EXHAUSTED

ユーザーごとの割り当て、またはファイル システム全体で容量が不足しているため、一部のリソースが枯渇しています。

HTTP マッピング: 429 リクエストが多すぎます
FAILED_PRECONDITION

システムがオペレーションの実行に必要な状態ではないため、オペレーションが拒否されました。たとえば、削除されるディレクトリが空でない、rmdir オペレーションがディレクトリ以外に適用されているなどの状態です。

サービスの実装者は、次のガイドラインを使用して、FAILED_PRECONDITION、ABORTED、UNAVAILABLE のいずれかに決定できます。（a）クライアントが失敗した呼び出しのみを再試行できる場合は、UNAVAILABLE を使用します。（b）クライアントがより高いレベルで再試行する必要がある場合は、ABORTED を使用します。たとえば、クライアント指定のテストと設定が失敗し、クライアントが読み取り、変更、書き込みのシーケンスをやり直す必要がある場合です。（c）システムの状態が明示的に修正されるまでクライアントが再試行すべきでない場合は、FAILED_PRECONDITION を使用します。たとえば、ディレクトリが空でないため「rmdir」が失敗した場合は、ディレクトリからファイルが削除されない限りクライアントは再試行すべきではないため、FAILED_PRECONDITION を返します。

HTTP マッピング: 400 不正なリクエスト
ABORTED

オペレーションは、通常、シーケンサー チェックの失敗、またはトランザクションの中止などの同時実行の問題のために中止されています。

FAILED_PRECONDITION、ABORTED、UNAVAILABLE の決定については、上記のガイドラインをご覧ください。

HTTP マッピング: 409 競合
OUT_OF_RANGE

オペレーションが有効な範囲を超えて試行されました。たとえば、ファイルの終わりを超えたシークまたは読み取りなどが該当します。

INVALID_ARGUMENT とは異なり、このエラーは、システムの状態が変化すれば修正できる可能性のある問題を示しています。たとえば、32 ビット ファイルシステムは [0,2^32-1] の範囲にないオフセットでの読み取りを要求されると、INVALID_ARGUMENT を生成しますが、現在のファイルサイズを超えるオフセットからの読み取りを要求されると、OUT_OF_RANGE を生成します。

FAILED_PRECONDITION と OUT_OF_RANGE は重複しています。空間を経由して反復している呼び出し元が、完了時に OUT_OF_RANGE エラーを簡単に探せるようにするために、可能な限り OUT_OF_RANGE（より具体的なエラー）の使用をおすすめします。

HTTP マッピング: 400 不正なリクエスト
UNIMPLEMENTED

オペレーションが実装されていないか、このサービスでサポートまたは有効にされていません。

HTTP マッピング: 501 実装されていません
INTERNAL

内部エラー。これは、基盤となるシステムで予期される一部の不変条件が満たされていないことを意味します。このエラーコードは深刻なエラーのために予約されています。

HTTP マッピング: 500 内部サーバーエラー
UNAVAILABLE

サービスは現在使用できません。これは、バックオフで再試行することで解決できる可能性が高い一時的な状態です。非べき等オペレーションの再試行が常に安全であるとは限りません。

FAILED_PRECONDITION、ABORTED、UNAVAILABLE の決定については、上記のガイドラインをご覧ください。

HTTP マッピング: 503 サービスを利用できません
DATA_LOSS

回復不能なデータの消失や破損。

HTTP マッピング: 500 内部サーバーエラー

UpdatedWidget

selectionInput ウィジェットの場合、複数選択メニューの予測入力の候補を返します。

JSON 表現 
{
  "widget": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "suggestions": {
    object (SelectionItems)
  }
}
フィールド
widget

string

更新されたウィジェットの ID。この ID は、更新リクエストをトリガーしたウィジェットの ID と一致する必要があります。
ユーザーの操作に応じてウィジェットが更新されました。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
suggestions

object (SelectionItems)

ウィジェットの予測入力結果のリスト
相互に排他的なフィールドの終了。

SelectionItems

ウィジェットの予測入力結果のリスト。

JSON 表現 
{
  "items": [
    {
      object (SelectionItem)
    }
  ]
}
フィールド
items[]

object (SelectionItem)

SelectionItem オブジェクトの配列。

SlashCommand

Google Chat のスラッシュ コマンドに関するメタデータ。

JSON 表現 
{
  "commandId": string
}
フィールド
commandId

string (int64 format)

スラッシュ コマンドの ID。

MatchedUrl

チャット メッセージ内の一致した URL。Chat 用アプリは、一致する URL をプレビューできます。詳しくは、リンクをプレビューするをご覧ください。

JSON 表現 
{
  "url": string
}
フィールド
url

string

出力専用。一致した URL。

EmojiReactionSummary

特定の絵文字でメッセージにリアクションしたユーザーの数。

JSON 表現 
{
  "emoji": {
    object (Emoji)
  },
  "reactionCount": integer
}
フィールド
emoji

object (Emoji)

出力専用。リアクションに関連付けられた絵文字。
reactionCount

integer

出力専用。関連付けられた絵文字を使用したリアクションの合計数。

DeletionMetadata

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

JSON 表現 
{
  "deletionType": enum (DeletionType)
}
フィールド
deletionType

enum (DeletionType)

メッセージを削除したユーザーを示します。

DeletionType

メッセージを削除したユーザーと削除方法。今後、値が追加される可能性があります。メッセージを削除できるタイミングについて詳しくは、Google Chat でメッセージを編集、削除するをご覧ください。

列挙型
DELETION_TYPE_UNSPECIFIED この値は使用されません。
CREATOR ユーザーが自分のメッセージを削除した。
SPACE_OWNER オーナーまたは管理者がメッセージを削除しました。
ADMIN Google Workspace 管理者がメッセージを削除しました。管理者は、スペース内のどのメッセージでも削除できます。これには、スペースのメンバーや Chat 用アプリによって送信されたメッセージも含まれます。
APP_MESSAGE_EXPIRY Chat 用アプリが、有効期限が切れたときに自身のメッセージを削除しました。
CREATOR_VIA_APP Chat 用アプリが作成者に代わってメッセージを削除した（ユーザー認証を使用）。
SPACE_OWNER_VIA_APP Chat 用アプリがスペースの管理者に代わって（ユーザー認証を使用して）メッセージを削除しました。
SPACE_MEMBER スペースのメンバーがメッセージを削除しました。ユーザーは、アプリから送信されたメッセージを削除できます。

QuotedMessageMetadata

別のメッセージが引用するメッセージに関する情報。

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

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

JSON 表現 
{
  "name": string,
  "lastUpdateTime": string,
  "quoteType": enum (QuoteType),
  "quotedMessageSnapshot": {
    object (QuotedMessageSnapshot)
  },
  "forwardedMetadata": {
    object (ForwardedMetadata)
  }
}
フィールド
name

string

必須。引用されたメッセージのリソース名。

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

string (Timestamp format)

必須。引用されたメッセージが作成されたとき、または引用されたメッセージが最後に更新されたときのタイムスタンプ。

メッセージが編集された場合は、このフィールド lastUpdateTime を使用します。メッセージが編集されていない場合は、createTime を使用します。

lastUpdateTime が引用メッセージの最新バージョンと一致しない場合、リクエストは失敗します。
quoteType

enum (QuoteType)

省略可。見積もりの種類を指定します。設定されていない場合、下位互換性のために、メッセージの読み取り/書き込みパスでデフォルトの REPLY になります。
quotedMessageSnapshot

object (QuotedMessageSnapshot)

出力専用。引用されたメッセージの内容のスナップショット。
forwardedMetadata

object (ForwardedMetadata)

出力専用。引用されたメッセージのソーススペースに関するメタデータ。FORWARD 見積もりタイプの場合にのみ入力されます。

QuoteType

引用されたメッセージの引用タイプ。

列挙型
QUOTE_TYPE_UNSPECIFIED Reserved. この値は使用されません。
REPLY

quoteType が REPLY の場合、次の操作を行うことができます。

  • スレッド内で返信する場合は、そのスレッド内の別のメッセージを引用できます。

  • ルート メッセージを作成する場合は、そのスペース内の別のルート メッセージを引用できます。
FORWARD

quoteType が FORWARD の場合、以下を引用できます。

  • 別のスペースからのメッセージ。

  • 同じスペース内の別のスレッドからのメッセージ返信。

QuotedMessageSnapshot

引用または転送時の引用メッセージの内容のスナップショットを提供します。

JSON 表現 
{
  "sender": string,
  "text": string,
  "formattedText": string,
  "annotations": [
    {
      object (Annotation)
    }
  ],
  "attachments": [
    {
      object (Attachment)
    }
  ]
}
フィールド
sender

string

出力専用。引用されたメッセージの作成者の名前。REPLY と FORWARD の両方の引用タイプに入力されます。
text

string

出力専用。引用されたメッセージのテキスト コンテンツのスナップショット。
formattedText

string

出力専用。引用メッセージ text が含まれます。ハイパーリンク、カスタム絵文字、マークアップなどのリッチ フォーマットをサポートするためにマークアップが追加されています。FORWARD 引用タイプの場合にのみ入力されます。
annotations[]

object (Annotation)

出力専用。引用メッセージのテキスト本文から解析されたアノテーション。FORWARD 見積もりタイプの場合にのみ入力されます。
attachments[]

object (Attachment)

出力専用。引用されたメッセージに含まれていた添付ファイル。これらは、引用されたメッセージの添付ファイルのメタデータのコピーです。FORWARD 引用タイプに対してのみ入力されます。

ForwardedMetadata

メッセージの転送元のスペースに関するメタデータ。

JSON 表現 
{
  "space": string,
  "spaceDisplayName": string
}
フィールド
space

string

出力専用。ソーススペースのリソース名。形式: spaces/{space}
spaceDisplayName

string

出力専用。転送時の転送元スペースまたは DM の表示名。SPACE の場合、これはスペース名です。DIRECT_MESSAGE の場合、これは他の参加者の名前（「ユーザー A」など）です。GROUP_CHAT の場合、これはメンバーの名前を基に生成された名前で、作成者を含めて 5 人までに制限されます（例: 「ユーザー A、ユーザー B」）。

AttachedGif

URL で指定された GIF 画像。

JSON 表現 
{
  "uri": string
}
フィールド
uri

string

出力専用。GIF 画像をホストする URL。

AccessoryWidget

メッセージの下部に表示される 1 つ以上のインタラクティブ ウィジェット。詳しくは、メッセージの下部にインタラクティブ ウィジェットを追加するをご覧ください。

JSON 表現 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "buttonList": {
    object (ButtonList)
  }
}
フィールド
アクションの種類。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
buttonList

object (ButtonList)

ボタンのリスト。
相互に排他的なフィールドの終了。

要素

要素は、メッセージの作成時に指定されたメッセージ テキストに関連付けられる場合と関連付けられない場合がある追加のコンポーネントです。

JSON 表現 
{
  "citedSources": [
    {
      object (CitedSource)
    }
  ],
  "citations": [
    {
      object (Citation)
    }
  ]
}
フィールド
citedSources[]

object (CitedSource)

メッセージの下にフッターリンクとして表示されるソースのリスト。これらはインラインで参照されません。インライン参照には citations を使用します。
citations[]

object (Citation)

メッセージ テキスト内で（<chat-citation> タグを介して）参照されるインライン引用のリスト。インタラクティブなポップアップ カードとしてレンダリングされます。

CitedSource

情報源への参照。

JSON 表現 
{
  "title": string,
  "uri": string,
  "snippet": {
    object (Snippet)
  },
  "footer": {
    object (Footer)
  }
}
フィールド
title

string

必須。CitedSource の書式なしテキストのタイトル。このフィールドは書式設定をサポートしていません。
uri

string

必須。この CitedSource によって参照されるリソースを指す URI。
snippet

object (Snippet)

省略可。ソースから直接取得した情報を含むスニペット。
footer

object (Footer)

省略可。スニペットとともにフッターの形式で表示される追加情報。

スニペット

より大きなコーパスからの抜粋を表すスニペット オブジェクト。

JSON 表現 
{
  "text": string,
  "imagePreview": {
    object (ElementsImage)
  }
}
フィールド
text

string

省略可。コーパスから直接取得された短いプレーンテキストの抜粋。Chat でレンダリングされる可能性があります。マークダウン形式はサポートされていません。
imagePreview

object (ElementsImage)

省略可。引用の作成時に入力として提供されたスニペットの画像プレビュー。

ElementsImage

画像を表すさまざまな方法をカプセル化するオブジェクト。現在サポートされている表現: - URI から取得された画像。今後、他の表現もサポートされる可能性があります。

JSON 表現 
{

  "imageUri": string
}
フィールド
必須。サポートされている画像表現のいずれか。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
imageUri

string

必須。画像の一般公開 URI。
相互に排他的なフィールドの終了。

ソースのフッター。アトリビューションに使用されます。

JSON 表現 
{
  "text": string
}
フィールド
text

string

省略可。フッターに表示するテキスト。

引用

引用は、インライン参照に関する詳細情報をユーザーに提供できるインライン参照です。対応するインライン引用は、<chat-citation data-id="{id}">{text}</chat-citation> のマークアップ形式でメッセージ テキストに含める必要があります。引用は、メッセージの markupSyntax が MARKDOWN に設定されている場合にのみサポートされます。

Elements.citations 内の参照されていない引用（メッセージ テキストに一致する <chat-citation> タグがない引用）は無視され、メッセージが拒否される原因にはなりません。

JSON 表現 
{
  "id": string,
  "citedSources": [
    {
      object (CitedSource)
    }
  ]
}
フィールド
id

string

必須。アプリで定義された ID。ASCII 文字と数字のみを使用し、63 文字未満にする必要があります。
citedSources[]

object (CitedSource)

省略可。引用に関連するソースのリスト。ソースは引用のポップアップ カードに表示されます。

MarkupSyntax

チャット メッセージ テキストの書式設定に使用するマークアップ構文を指定します。Message リソースの text フィールドに適用されます。

列挙型
MARKUP_SYNTAX_UNSPECIFIED 未指定の値を表します。
MARKUP_SYNTAX_CHAT Google Chat のマークアップ構文を使用します。詳しくは、https://developers.google.com/workspace/chat/format-messages#format-texts をご覧ください。
MARKUP_SYNTAX_MARKDOWN Markdown 構文を使用します。この構文は CommonMark 仕様に基づいており、追加の拡張機能が用意されています。詳しくは、https://developers.google.com/workspace/chat/format-messages#format-texts をご覧ください。

メソッド

create

 Google Chat スペースにメッセージを作成します。

delete

 メッセージを削除します。

get

 メッセージの詳細を返します。

list

 呼び出し元がメンバーであるスペース内のメッセージ（ブロックされたメンバーやスペースからのメッセージを含む）を一覧表示します。

patch

 メッセージを更新します。

replaceCards

 メッセージに含まれるカードを置き換えます。
呼び出し元のユーザーがアクセスできる Google Chat のメッセージを検索します。

update

 メッセージを更新します。