- リソース: メッセージ
- JSON 表現
- カード
- CardHeader
- ImageStyle
- セクション
- WidgetMarkup
- TextParagraph
- Image
- OnClick
- FormAction
- ActionParameter
- OpenLink
- KeyValue
- アイコン
- ボタン
- TextButton
- ImageButton
- CardAction
- CardWithId
- カード
- CardHeader
- ImageType
- セクション
- ウィジェット
- TextParagraph
- Image
- OnClick
- Action
- ActionParameter
- LoadIndicator
- 操作
- OpenLink
- OpenAs
- OnClose
- DecoratedText
- アイコン
- MaterialIcon
- ボタン
- 色
- SwitchControl
- ControlType
- ButtonList
- TextInput
- タイプ
- 候補
- SuggestionItem を
- SelectionInput
- SelectionType
- SelectionItem
- PlatformDataSource
- CommonDataSource
- HostAppDataSourceMarkup
- ChatClientDataSourceMarkup
- SpaceDataSource
- DateTimePicker
- DateTimePickerType
- Divider
- グリッド
- GridItem
- ImageComponent
- ImageCropStyle
- ImageCropType
- BorderStyle
- BorderType
- GridItemLayout
- 列
- 列
- HorizontalSizeStyle
- HorizontalAlignment
- VerticalAlignment
- ウィジェット
- DividerStyle
- CardAction
- CardFixedFooter
- DisplayStyle
- アノテーション
- AnnotationType
- UserMentionMetadata
- タイプ
- SlashCommandMetadata
- タイプ
- RichLinkMetadata
- RichLinkType
- DriveLinkData
- スレッド
- ActionResponse
- ResponseType
- DialogAction
- ダイアログ
- ActionStatus
- コード
- UpdatedWidget
- SelectionItems
- SlashCommand
- MatchedUrl
- EmojiReactionSummary
- DeletionMetadata
- DeletionType
- QuotedMessageMetadata
- AttachedGif
- AccessoryWidget
- メソッド
リソース: Message
Google Chat スペース内のメッセージ。
JSON 表現 |
---|
{ "name": string, "sender": { object ( |
フィールド | |
---|---|
name |
メッセージのリソース名。 形式: ここで、 メッセージの作成時にカスタム ID を設定した場合、この ID をリクエストでメッセージを指定するには、 |
sender |
出力専用。メッセージを作成したユーザー。Chat アプリがユーザーとして認証されると、出力にはユーザーの |
createTime |
省略可。変更不可。Chat で作成されたスペースの場合は、メッセージが作成された時刻。このフィールドは、インポート モードのスペースで使用されている場合を除き、出力のみとなります。 インポート モードのスペースの場合、元の作成時刻を保持するために、このフィールドに、ソースでメッセージが作成された時点の過去のタイムスタンプを設定します。 |
lastUpdateTime |
出力専用。ユーザーによってメッセージが最後に編集された時刻。メッセージが一度も編集されていない場合、このフィールドは空になります。 |
deleteTime |
出力専用。Google Chat でメッセージが削除された時刻。メッセージが削除されない場合、このフィールドは空になります。 |
text |
書式なしテキストの本文。画像、動画、ウェブページへの最初のリンクでは、プレビュー チップが生成されます。Google Chat ユーザーまたはスペース内の全員に名前リンクを付けることもできます。 テキスト メッセージの作成方法については、テキスト メッセージを送信するをご覧ください。 |
formattedText |
出力専用。形式を伝えるためにマークアップが追加された
詳しくは、メッセージで送信されたテキスト形式を表示するをご覧ください。 |
cards[] |
非推奨: 代わりに UI 要素(書式設定されたテキスト、ボタン、クリック可能な画像など)の表示に使用できる、リッチで書式設定されたインタラクティブなカード。カードは通常、書式なしテキストの本文の下に表示されます。 |
cardsV2[] |
cards の配列。 カードを作成できるのは Chat アプリのみです。Chat アプリがユーザーとして認証されている場合、メッセージにカードを含めることはできません。 カードとその作成方法については、カード メッセージを送信するをご覧ください。 カードビルダーでカードをデザインしてプレビューする。 カードビルダーを開く |
annotations[] |
出力専用。このメッセージの |
thread |
メッセージが属するスレッド。使用例については、メッセージ スレッドを開始または返信するをご覧ください。 |
space |
|
fallbackText |
メッセージ カードの説明。書式なしテキストで表します。モバイル通知など、実際のカードを表示できない場合に使用します。 |
actionResponse |
入力のみ。Chat アプリがレスポンスの送信方法を構成するために使用できるパラメータ。 |
argumentText |
出力専用。Chat アプリのすべてのメンションが取り除かれたメッセージの書式なしテキスト本文。 |
slashCommand |
出力専用。スラッシュ コマンドの情報(該当する場合)。 |
attachment[] |
ユーザーがアップロードした添付ファイル。 |
matchedUrl |
出力専用。リンク プレビュー パターンに一致する |
threadReply |
出力専用。 スペースがスレッドでの返信をサポートしていない場合、このフィールドは常に |
clientAssignedMessageId |
省略可。メッセージのカスタム ID。field を使用してメッセージの識別や、メッセージの取得、削除、更新を行うことができます。カスタム ID を設定するには、メッセージの作成時に |
emojiReactionSummaries[] |
出力専用。メッセージ上の絵文字のリアクションの概要のリスト。 |
privateMessageViewer |
変更不可。メッセージを作成するための入力。それ以外の場合は出力のみ。メッセージを閲覧できるユーザー。設定すると、メッセージは非公開になり、指定したユーザーと Chat アプリにのみ表示されます。プライベート メッセージではリンクのプレビューと添付ファイルはサポートされていません。 プライベート メッセージを送信できるのは Chat アプリのみです。Chat アプリがユーザーとして認証されてメッセージを送信する場合、メッセージを非公開にすることはできません。したがって、このフィールドを省略する必要があります。 詳しくは、Google Chat ユーザーにプライベート メッセージを送信するをご覧ください。 |
deletionMetadata |
出力専用。削除されたメッセージに関する情報。 |
quotedMessageMetadata |
出力専用。スペースで Google Chat ユーザーが引用したメッセージに関する情報。Google Chat のユーザーは、メッセージを引用して返信できます。 |
attachedGifs[] |
出力専用。メッセージに添付された GIF 画像。 |
accessoryWidgets[] |
メッセージの下部に表示される 1 つ以上のインタラクティブなウィジェット。テキスト、カード、またはテキストとカードの両方を含むメッセージにアクセサリ ウィジェットを追加できます。ダイアログを含むメッセージではサポートされていません。詳しくは、メッセージの下部にインタラクティブなウィジェットを追加するをご覧ください。 アクセサリ ウィジェットでメッセージを作成するには、アプリの認証が必要です。 |
CardWithId
Google Chat メッセージ内のカード。
カードを作成できるのは Chat アプリのみです。Chat アプリがユーザーとして認証されている場合、メッセージにカードを含めることはできません。
カードビルダーでカードをデザインしてプレビューする。
カードビルダーを開くJSON 表現 |
---|
{
"cardId": string,
"card": {
object ( |
フィールド | |
---|---|
cardId |
メッセージに複数のカードが含まれている場合は必須。メッセージ内のカードの一意の識別子。 |
card |
カード。最大サイズは 32 KB です。 |
Annotation
出力専用。書式なしテキストの本文に関連付けられたアノテーション。テキスト メッセージに基本的な書式設定を追加するには、テキスト メッセージの書式設定をご覧ください。
書式なしテキストのメッセージ本文の例:
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 ( |
フィールド | |
---|---|
type |
このアノテーションの型。 |
length |
このアノテーションが対応する書式なしテキスト メッセージ本文の部分文字列の長さ。 |
startIndex |
このアノテーションが対応する書式なしテキスト メッセージ本文の開始インデックス(0 ベース、両端を含む)。 |
共用体フィールド metadata 。アノテーションに関する追加のメタデータ。metadata は次のいずれかになります。 |
|
userMention |
ユーザー メンションのメタデータ。 |
slashCommand |
スラッシュ コマンドのメタデータ。 |
richLinkMetadata |
リッチリンクのメタデータ。 |
AnnotationType
アノテーションの型。
列挙型 | |
---|---|
ANNOTATION_TYPE_UNSPECIFIED |
列挙型のデフォルト値。使用しないでください。 |
USER_MENTION |
あるユーザーが言及されている。 |
SLASH_COMMAND |
スラッシュ コマンドが呼び出されます。 |
RICH_LINK |
リッチリンク アノテーション。 |
UserMentionMetadata
名前リンク付き投稿(@)のアノテーション メタデータ。
JSON 表現 |
---|
{ "user": { object ( |
フィールド | |
---|---|
user |
ユーザーがメンションした。 |
type |
ユーザーのメンションのタイプ。 |
タイプ
列挙型 | |
---|---|
TYPE_UNSPECIFIED |
列挙型のデフォルト値。使用しないでください。 |
ADD |
ユーザーをスペースに追加します。 |
MENTION |
スペース内のユーザーに名前リンクを付けます。 |
SlashCommandMetadata
スラッシュ コマンド(/)のアノテーション メタデータ。
JSON 表現 |
---|
{ "bot": { object ( |
フィールド | |
---|---|
bot |
コマンドが呼び出された Chat アプリ。 |
type |
スラッシュ コマンドのタイプ。 |
commandName |
呼び出されたスラッシュ コマンドの名前。 |
commandId |
呼び出されたスラッシュ コマンドのコマンド ID。 |
triggersDialog |
スラッシュ コマンドがダイアログ用かどうかを示します。 |
タイプ
列挙型 | |
---|---|
TYPE_UNSPECIFIED |
列挙型のデフォルト値。使用しないでください。 |
ADD |
Chat アプリをスペースに追加します。 |
INVOKE |
スペースでスラッシュ コマンドを呼び出す |
RichLinkMetadata
リソースへのリッチリンク。
JSON 表現 |
---|
{ "uri": string, "richLinkType": enum ( |
フィールド | |
---|---|
uri |
このリンクの URI。 |
richLinkType |
リッチリンクのタイプ。 |
共用体フィールド data 。リンクされたリソースのデータ。data は次のいずれかになります。 |
|
driveLinkData |
ドライブリンクのデータ。 |
RichLinkType
リッチリンクのタイプ。今後、さらに多くの種類が追加される可能性があります。
列挙型 | |
---|---|
RICH_LINK_TYPE_UNSPECIFIED |
列挙型のデフォルト値。使用しないでください。 |
DRIVE_FILE |
Google ドライブのリッチリンクの種類。 |
DriveLinkData
Google ドライブリンクのデータ。
JSON 表現 |
---|
{
"driveDataRef": {
object ( |
フィールド | |
---|---|
driveDataRef |
Google ドライブ ファイルを参照する DriveDataRef。 |
mimeType |
リンクされた Google ドライブ リソースの MIME タイプ。 |
スレッド
Google Chat スペース内のスレッド。使用例については、メッセージ スレッドを開始または返信するをご覧ください。
メッセージの作成時にスレッドを指定した場合、messageReplyOption
フィールドを設定すると、一致するスレッドが見つからない場合の処理を指定できます。
JSON 表現 |
---|
{ "name": string, "threadKey": string } |
フィールド | |
---|---|
name |
出力専用。スレッドのリソース名。 例: |
threadKey |
省略可。スレッドを作成または更新するための入力。それ以外の場合は、出力のみ。スレッドの ID。4,000 文字まで使用できます。 この ID は、その ID を設定する Chat アプリに固有のものです。たとえば、複数の Chat アプリが同じスレッドキーを使用してメッセージを作成すると、それらのメッセージは別々のスレッドに投稿されます。ユーザーまたは別の Chat アプリによって作成されたスレッド内で返信するには、代わりにスレッド |
ActionResponse
Chat アプリがレスポンスの送信方法を構成するために使用できるパラメータ。
JSON 表現 |
---|
{ "type": enum ( |
フィールド | |
---|---|
type |
入力のみ。Chat アプリのレスポンスの種類。 |
url |
入力のみ。ユーザーが認証または構成するための URL。( |
dialogAction |
入力のみ。ダイアログに関連する操作イベントに対するレスポンス。 |
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 |
入力のみ。ダイアログを起動または送信するリクエストのステータス。必要に応じて、ユーザーにステータスとメッセージを表示します。たとえば、エラーが発生した場合や成功した場合などです。 |
共用体フィールド action 。実行するアクション。action は次のいずれかになります。 |
|
dialog |
入力のみ。リクエストのダイアログ。 |
ダイアログ
ダイアログのカード本文を囲むラッパー。
JSON 表現 |
---|
{
"body": {
object ( |
フィールド | |
---|---|
body |
入力のみ。モーダルに表示されるダイアログの本文。Google Chat アプリは、次のカード エンティティをサポートしていません: |
ActionStatus
ダイアログを呼び出すか送信するリクエストのステータスを表します。
JSON 表現 |
---|
{
"statusCode": enum ( |
フィールド | |
---|---|
statusCode |
ステータス コード。 |
userFacingMessage |
リクエストのステータスについてユーザーに送信するメッセージ。設定しない場合、 |
コード
gRPC API の正規のエラーコード。
複数のエラーコードが該当する場合があります。サービスは、該当する最も具体的なエラーコードを返す必要があります。たとえば、両方のコードが該当する場合、FAILED_PRECONDITION
より OUT_OF_RANGE
を優先します。同様に、FAILED_PRECONDITION
より NOT_FOUND
または ALREADY_EXISTS
を優先します。
列挙型 | |
---|---|
OK |
エラーではありません。成功したときに返されます。 HTTP マッピング: 200 OK |
CANCELLED |
オペレーションがキャンセルされました。通常、キャンセルは呼び出し元により行われます。 HTTP マッピング: 499 クライアントのクローズ リクエスト |
UNKNOWN |
不明なエラーが発生しました。たとえば、別のアドレス空間から受信した HTTP マッピング: 500 内部サーバーエラー |
INVALID_ARGUMENT |
クライアントが無効な引数を指定しました。これは HTTP マッピング: 400 不正なリクエスト |
DEADLINE_EXCEEDED |
オペレーションが完了する前に期限が切れました。システムの状態を変更するオペレーションの場合、オペレーションが正常に終了しても、このエラーが返されることがあります。たとえば、サーバーからの正常なレスポンスが期限切れになるほど遅延する場合もあります。 HTTP マッピング: 504 ゲートウェイ タイムアウト |
NOT_FOUND |
一部のリクエストされたエンティティ(ファイルやディレクトリなど)が見つかりませんでした。 サーバー デベロッパーへの注: 段階的な機能のロールアウトや文書化されていない許可リストなど、ユーザークラス全体に対してリクエストが拒否された場合は、 HTTP マッピング: 404 見つかりません |
ALREADY_EXISTS |
クライアントが作成しようとしたエンティティ(ファイルまたはディレクトリなど)はすでに存在しています。 HTTP マッピング: 409 競合 |
PERMISSION_DENIED |
呼び出し元には、指定されたオペレーションを実行する権限がありません。 HTTP マッピング: 403 禁止です |
UNAUTHENTICATED |
リクエストにはオペレーションに有効な認証情報がありません。 HTTP マッピング: 401 権限なし |
RESOURCE_EXHAUSTED |
ユーザーごとの割り当て、またはファイル システム全体で容量が不足しているため、一部のリソースが枯渇しています。 HTTP マッピング: 429 リクエストが多すぎます |
FAILED_PRECONDITION |
システムがオペレーションの実行に必要な状態ではないため、オペレーションが拒否されました。たとえば、削除されるディレクトリが空でない、rmdir オペレーションがディレクトリ以外に適用されているなどの状態です。 サービスの実装者は、次のガイドラインを使用して、 HTTP マッピング: 400 不正なリクエスト |
ABORTED |
オペレーションは、通常、シーケンサー チェックの失敗、またはトランザクションの中止などの同時実行の問題のために中止されています。
HTTP マッピング: 409 競合 |
OUT_OF_RANGE |
オペレーションが有効な範囲を超えて試行されました。たとえば、ファイルの終わりを超えたシークまたは読み取りなどが該当します。
HTTP マッピング: 400 不正なリクエスト |
UNIMPLEMENTED |
オペレーションが実装されていないか、このサービスでサポートまたは有効にされていません。 HTTP マッピング: 501 実装されていません |
INTERNAL |
内部エラー。これは、基盤となるシステムで予期される一部の不変条件が満たされていないことを意味します。このエラーコードは深刻なエラーのために予約されています。 HTTP マッピング: 500 内部サーバーエラー |
UNAVAILABLE |
サービスは現在使用できません。これは、バックオフで再試行することで解決できる可能性が高い一時的な状態です。非べき等オペレーションの再試行が常に安全であるとは限りません。
HTTP マッピング: 503 サービスを利用できません |
DATA_LOSS |
回復不能なデータの消失や破損。 HTTP マッピング: 500 内部サーバーエラー |
UpdatedWidget
更新されたウィジェットのレスポンス。ウィジェットのオートコンプリート オプションを提供するために使用します。
JSON 表現 |
---|
{ "widget": string, // Union field |
フィールド | |
---|---|
widget |
更新されたウィジェットの ID。ID は、更新リクエストをトリガーしたウィジェットの ID と一致する必要があります。 |
共用体フィールド updated_widget 。ユーザーの操作に応じて更新されたウィジェットです。updated_widget は次のいずれかになります。 |
|
suggestions |
ウィジェットのオートコンプリートの結果のリスト |
SelectionItems
ウィジェットのオートコンプリートの結果のリスト。
JSON 表現 |
---|
{
"items": [
{
object ( |
フィールド | |
---|---|
items[] |
SelectionItem オブジェクトの配列。 |
SlashCommand
Google Chat のスラッシュ コマンド。
JSON 表現 |
---|
{ "commandId": string } |
フィールド | |
---|---|
commandId |
呼び出されたスラッシュ コマンドの ID。 |
MatchedUrl
Chat メッセージ内の一致した URL。Chat アプリでは、一致した URL をプレビューできます。詳しくは、プレビュー リンクをご覧ください。
JSON 表現 |
---|
{ "url": string } |
フィールド | |
---|---|
url |
出力専用。一致した URL。 |
EmojiReactionSummary
特定の絵文字でメッセージにリアクションしたユーザーの数。
JSON 表現 |
---|
{
"emoji": {
object ( |
フィールド | |
---|---|
emoji |
リアクションに関連付けられた絵文字。 |
reactionCount |
関連付けられた絵文字を使用したリアクションの合計数。 |
DeletionMetadata
削除されたメッセージに関する情報。deleteTime
を設定すると、メッセージは削除されます。
JSON 表現 |
---|
{
"deletionType": enum ( |
フィールド | |
---|---|
deletionType |
メッセージを削除したユーザーを示します。 |
DeletionType
メッセージを削除したユーザーとその方法。
列挙型 | |
---|---|
DELETION_TYPE_UNSPECIFIED |
この値は使用されません。 |
CREATOR |
ユーザーが自分のメッセージを削除しました。 |
SPACE_OWNER |
スペースのオーナーがメッセージを削除した。 |
ADMIN |
このメッセージは Google Workspace 管理者によって削除されました。 |
APP_MESSAGE_EXPIRY |
Chat アプリは、有効期限が切れたときにそれ自体のメッセージを削除しました。 |
CREATOR_VIA_APP |
Chat アプリがユーザーに代わってメッセージを削除しました。 |
SPACE_OWNER_VIA_APP |
Chat アプリがスペースのオーナーに代わってメッセージを削除しました。 |
QuotedMessageMetadata
引用されたメッセージに関する情報。
JSON 表現 |
---|
{ "name": string, "lastUpdateTime": string } |
フィールド | |
---|---|
name |
出力専用。引用されたメッセージのリソース名。 形式: |
lastUpdateTime |
出力専用。引用されたメッセージが作成された時点、または引用されたメッセージが最後に更新されたときのタイムスタンプ。 |
AttachedGif
URL で指定された GIF 画像。
JSON 表現 |
---|
{ "uri": string } |
フィールド | |
---|---|
uri |
出力専用。GIF 画像をホストする URL。 |
AccessoryWidget
メッセージの下部に表示される 1 つ以上のインタラクティブなウィジェット。詳しくは、メッセージの下部にインタラクティブなウィジェットを追加するをご覧ください。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド action 。アクションのタイプ。action は次のいずれかになります。 |
|
buttonList |
ボタンのリスト。 |
メソッド |
|
---|---|
|
Google Chat スペースでメッセージを作成する。 |
|
メッセージを削除します。 |
|
メッセージの詳細を返します。 |
|
発信者がメンバーであるスペースのメッセージ(ブロックされているメンバーやスペースからのメッセージを含む)が一覧表示されます。 |
|
メッセージを更新します。 |
|
メッセージを更新します。 |