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,
  "clientAssignedMessageId": string,
  "emojiReactionSummaries": [
    {
      object (EmojiReactionSummary)
    }
  ],
  "privateMessageViewer": {
    object (User)
  },
  "deletionMetadata": {
    object (DeletionMetadata)
  },
  "quotedMessageMetadata": {
    object (QuotedMessageMetadata)
  },
  "attachedGifs": [
    {
      object (AttachedGif)
    }
  ],
  "accessoryWidgets": [
    {
      object (AccessoryWidget)
    }
  ]
}
フィールド
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 が入力されます。
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:）。これは、笑顔の絵文字の U+1F600 などの Unicode 絵文字には適用されません。

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

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

object (Card)

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

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

object (CardWithId)

省略可。カードの配列。

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

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

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

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

object (Annotation)

出力専用。アノテーションは、メッセージのプレーン テキストの本文、または startIndex と length が 0 の Google ドキュメントや 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)

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

boolean

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

スペースがスレッドでの返信をサポートしていない場合、このフィールドは常に false です。
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 つ以上のインタラクティブ ウィジェット。テキスト、カード、またはテキストとカードの両方を含むメッセージに、アクセサリ ウィジェットを追加できます。ダイアログを含むメッセージではサポートされていません。詳しくは、メッセージの下部にインタラクティブ ウィジェットを追加するをご覧ください。

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

CardWithId

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

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

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

カードビルダーを開く

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

string

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

object (Card)

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

メモ

出力専用。アノテーションは、メッセージのプレーン テキストの本文、または startIndex と length が 0 の Google ドキュメントや 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,

  // Union field metadata can be only one of the following:
  "userMention": {
    object (UserMentionMetadata)
  },
  "slashCommand": {
    object (SlashCommandMetadata)
  },
  "richLinkMetadata": {
    object (RichLinkMetadata)
  },
  "customEmojiMetadata": {
    object (CustomEmojiMetadata)
  }
  // End of list of possible types for union field metadata.
}
フィールド
type

enum (AnnotationType)

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

integer

このアノテーションに対応するプレーン テキスト メッセージ本文のサブ文字列の長さ。存在しない場合、長さが 0 であることを示します。
startIndex

integer

このアノテーションに対応するプレーン テキスト メッセージ本文の開始インデックス（0 ベース、両端を含む）。
共用体フィールド metadata。アノテーションに関する追加のメタデータ。metadata は次のいずれかになります。
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 スプレッドシートなどの Google Workspace リソースにリンクするチップを表すこともできます。

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

  // Union field data can be only one of the following:
  "driveLinkData": {
    object (DriveLinkData)
  },
  "chatSpaceLinkData": {
    object (ChatSpaceLinkData)
  },
  "meetSpaceLinkData": {
    object (MeetSpaceLinkData)
  },
  "calendarEventLinkData": {
    object (CalendarEventLinkData)
  }
  // End of list of possible types for union field data.
}
フィールド
uri

string

このリンクの URI。
共用体フィールド data。リンクされたリソースのデータ。data は次のいずれかになります。

RichLinkType

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

列挙型
DRIVE_FILE Google ドライブのリッチリンクのタイプ。
CHAT_SPACE Chat スペースのリッチリンク タイプ。たとえば、スペースのスマートチップなどです。
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)
  },

  // Union field action can be only one of the following:
  "dialog": {
    object (Dialog)
  }
  // End of list of possible types for union field action.
}
フィールド
actionStatus

object (ActionStatus)

入力のみのダイアログの呼び出しまたは送信のリクエストのステータス。必要に応じて、ユーザーにステータスとメッセージを表示します。たとえば、エラーや成功の場合などです。
共用体フィールド action。実行するアクション。action は次のいずれかになります。
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,

  // Union field updated_widget can be only one of the following:
  "suggestions": {
    object (SelectionItems)
  }
  // End of list of possible types for union field updated_widget.
}
フィールド
widget

string

更新されたウィジェットの ID。ID は、更新リクエストをトリガーしたウィジェットの ID と一致している必要があります。
共用体フィールド updated_widget。ユーザー アクションに応じて更新されたウィジェット。updated_widget は次のいずれかになります。
suggestions

object (SelectionItems)

ウィジェットのオートコンプリート結果のリスト

SelectionItems

ウィジェットのオートコンプリート結果のリスト。

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

object (SelectionItem)

SelectionItem オブジェクトの配列。

SlashCommand

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

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

string (int64 format)

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

MatchedUrl

Chat メッセージで一致した URL。チャットアプリは、一致した 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
}
フィールド
name

string

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

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

string (Timestamp format)

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

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

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

AttachedGif

URL で指定された GIF 画像。

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

string

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

AccessoryWidget

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

JSON 表現 
{

  // Union field action can be only one of the following:
  "buttonList": {
    object (ButtonList)
  }
  // End of list of possible types for union field action.
}
フィールド
共用体フィールド action。アクションのタイプ。action は次のいずれかになります。
buttonList

object (ButtonList)

ボタンのリスト。

メソッド

create

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

delete

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

get

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

list

 呼び出し元がメンバーになっているスペースのメッセージを一覧表示します。ブロックされたメンバーやスペースからのメッセージも含まれます。

patch

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

update

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