- リソース: Message
- 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
- OverflowMenu
- OverflowMenuItem
- アイコン
- MaterialIcon
- DecoratedText
- ボタン
- 色
- 型
- SwitchControl
- ControlType
- ButtonList
- TextInput
- 型
- 候補
- SuggestionItem
- 検証
- InputType
- SelectionInput
- SelectionType
- SelectionItem
- PlatformDataSource
- CommonDataSource
- HostAppDataSourceMarkup
- ChatClientDataSourceMarkup
- SpaceDataSource
- DateTimePicker
- DateTimePickerType
- Divider
- グリッド
- GridItem
- ImageComponent
- ImageCropStyle
- ImageCropType
- BorderStyle
- BorderType
- GridItemLayout
- 列
- 列
- HorizontalSizeStyle
- HorizontalAlignment
- VerticalAlignment
- ウィジェット
- ChipList
- レイアウト
- チップ
- カルーセル
- CarouselCard
- NestedWidget
- CollapseControl
- DividerStyle
- CardAction
- CardFixedFooter
- DisplayStyle
- アノテーション
- AnnotationType
- UserMentionMetadata
- 型
- SlashCommandMetadata
- 型
- RichLinkMetadata
- RichLinkType
- DriveLinkData
- ChatSpaceLinkData
- スレッド
- 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 アプリがユーザーとして認証されると、出力にユーザー |
create |
省略可。変更不可。Chat で作成されたスペースの場合は、メッセージが作成された時刻。このフィールドは、インポートモードのスペースで使用する場合を除き、出力専用です。 インポート モードのスペースの場合は、元の作成時間を保持するために、このフィールドをソースでメッセージが作成された過去のタイムスタンプに設定します。 |
last |
出力専用。ユーザーが最後にメッセージを編集した日時。メッセージが編集されていない場合、このフィールドは空白です。 |
delete |
出力専用。Google Chat でメッセージが削除された時刻。メッセージが削除されない場合は、このフィールドは空です。 |
text |
省略可。メッセージのプレーン テキスト本文。画像、動画、ウェブページへの最初のリンクでプレビュー チップが生成されます。Google Chat ユーザーの名前リンクや、スペース内の全ユーザーの名前リンクを指定することもできます。 テキスト メッセージの作成については、メッセージを送信するをご覧ください。 |
formatted |
出力専用。書式を指定するためにマークアップが追加されたメッセージ
詳しくは、メッセージで送信されたテキストの書式設定を表示するをご覧ください。 |
cards[] |
非推奨: 代わりに、 書式設定されたリッチなインタラクティブ カード。書式設定されたテキスト、ボタン、クリック可能な画像などの UI 要素を表示できます。カードは通常、メッセージのプレーンテキストの本文の下に表示されます。 |
cards |
省略可。カードの配列。 カードを作成できるのは Chat アプリのみです。チャットアプリがユーザーとして認証されている場合、メッセージにカードを含めることはできません。 カードを含むメッセージを作成する方法については、メッセージを送信するをご覧ください。 カードビルダーを使用してカードをデザインし、プレビューします。 カードビルダーを開く |
annotations[] |
出力専用。このメッセージの |
thread |
メッセージが属するスレッド。使用例については、メッセージ スレッドを開始または返信するをご覧ください。 |
space |
|
fallback |
省略可。メッセージのカードに関するプレーンテキストの説明。実際のカード(モバイル通知など)を表示できない場合に使用されます。 |
action |
入力のみのChat アプリがレスポンスの投稿方法を構成するために使用できるパラメータ。 |
argument |
出力専用。Chat アプリの記述がすべて削除された、メッセージの本文の書式なしテキスト。 |
slash |
出力専用。スラッシュ コマンドに関する情報(該当する場合)。 |
attachment[] |
省略可。ユーザーがアップロードした添付ファイル。 |
matched |
出力専用。リンク プレビュー パターンと一致する |
thread |
出力専用。 スレッドでの返信がサポートされていないスペースの場合、このフィールドは常に |
client |
省略可。メッセージのカスタム ID。フィールドを使用して、メッセージを識別したり、メッセージを取得、削除、更新したりできます。カスタム ID を設定するには、メッセージを作成するときに |
emoji |
出力専用。メッセージに対する絵文字のリアクションの概要のリスト。 |
private |
省略可。変更不可。メッセージを作成する場合は入力、それ以外の場合は出力のみ。メッセージを表示できるユーザー。設定すると、メッセージは非公開になり、指定したユーザーと Chat アプリにのみ表示されます。このフィールドをリクエストに含めるには、アプリ認証を使用して Chat API を呼び出し、次の項目を省略する必要があります。 詳しくは、メッセージを非公開で送信するをご覧ください。 |
deletion |
出力専用。削除されたメッセージに関する情報。 |
quoted |
出力専用。スペース内の Google Chat ユーザーが引用したメッセージに関する情報。Google Chat のユーザーは、メッセージを引用して返信できます。 |
attached |
出力専用。メッセージに添付された GIF 画像。 |
accessory |
省略可。メッセージの下部に表示される 1 つ以上のインタラクティブ ウィジェット。アクセサリ ウィジェットは、テキスト、カード、またはテキストとカードの両方を含むメッセージに追加できます。ダイアログを含むメッセージには対応していません。詳しくは、メッセージの下部にインタラクティブなウィジェットを追加するをご覧ください。 アクセサリ ウィジェットを含むメッセージを作成するには、アプリの認証が必要です。 |
CardWithId
Google Chat メッセージのカード。
カードを作成できるのは Chat アプリのみです。チャットアプリがユーザーとして認証されている場合、メッセージにカードを含めることはできません。
カードビルダーを使用してカードをデザインし、プレビューします。
カードビルダーを開くJSON 表現 |
---|
{
"cardId": string,
"card": {
object ( |
フィールド | |
---|---|
card |
メッセージに複数のカードが含まれている場合は必須です。メッセージ内のカードの一意の識別子。 |
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 |
このアノテーションが対応する、プレーンテキスト メッセージ本文のサブ文字列の長さ。 |
start |
このアノテーションが対応するプレーンテキスト メッセージ本文の開始インデックス(0 ベース、両端を含む)。 |
共用体フィールド metadata 。アノテーションに関する追加のメタデータ。metadata は次のいずれかになります。 |
|
user |
ユーザーのメンションのメタデータ。 |
slash |
スラッシュ コマンドのメタデータ。 |
rich |
リッチリンクのメタデータ。 |
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 |
スラッシュ コマンドのタイプ。 |
command |
呼び出されたスラッシュ コマンドの名前。 |
command |
呼び出されたスラッシュ コマンドのコマンド ID。 |
triggers |
スラッシュ コマンドがダイアログ用かどうかを示します。 |
タイプ
列挙型 | |
---|---|
TYPE_UNSPECIFIED |
列挙型のデフォルト値。使用しないでください。 |
ADD |
スペースに Chat アプリを追加する。 |
INVOKE |
スペースでスラッシュ コマンドを呼び出す。 |
RichLinkMetadata
リソースへのリッチリンク。
JSON 表現 |
---|
{ "uri": string, "richLinkType": enum ( |
フィールド | |
---|---|
uri |
このリンクの URI。 |
rich |
リッチリンクのタイプ。 |
共用体フィールド data 。リンクされたリソースのデータ。data は次のいずれかになります。 |
|
drive |
ドライブリンクのデータ。 |
chat |
Chat スペースのリンクのデータ。 |
RichLinkType
リッチリンクのタイプ。今後、他の種類も追加される可能性があります。
列挙型 | |
---|---|
RICH_LINK_TYPE_UNSPECIFIED |
列挙型のデフォルト値。使用しないでください。 |
DRIVE_FILE |
Google ドライブのリッチリンク タイプ。 |
CHAT_SPACE |
Chat スペースのリッチリンク タイプ。たとえば、スペースのスマートチップなどです。 |
DriveLinkData
Google ドライブのリンクのデータ。
JSON 表現 |
---|
{
"driveDataRef": {
object ( |
フィールド | |
---|---|
drive |
Google ドライブ ファイルを参照する DriveDataRef。 |
mime |
リンクされた Google ドライブ リソースの MIME タイプ。 |
ChatSpaceLinkData
Chat スペースのリンクのデータ。
JSON 表現 |
---|
{ "space": string, "thread": string, "message": string } |
フィールド | |
---|---|
space |
リンクされた Chat スペース リソースのスペース。 形式: |
thread |
リンクされた Chat スペース リソースのスレッド。 形式: |
message |
リンクされた Chat スペース リソースのメッセージ。 形式: |
スレッド
Google Chat スペース内のスレッド。使用例については、メッセージ スレッドを開始または返信するをご覧ください。
メッセージを作成するときにスレッドを指定する場合は、messageReplyOption
フィールドを設定して、一致するスレッドが見つからない場合の処理を決定できます。
JSON 表現 |
---|
{ "name": string, "threadKey": string } |
フィールド | |
---|---|
name |
ID。スレッドのリソース名。 例: |
thread |
省略可。スレッドの作成または更新用の入力。それ以外の場合は、出力のみ。スレッドの ID。最大 4,000 文字をサポートします。 この ID は、設定した Chat アプリに固有のものです。たとえば、複数の Chat アプリが同じスレッドキーを使用してメッセージを作成した場合、メッセージは異なるスレッドに投稿されます。ユーザーまたは別の Chat アプリによって作成されたスレッドに返信するには、代わりにスレッドの |
ActionResponse
Chat アプリがレスポンスの投稿方法を構成するために使用できるパラメータ。
JSON 表現 |
---|
{ "type": enum ( |
フィールド | |
---|---|
type |
入力のみのChat アプリのレスポンスのタイプ。 |
url |
入力のみのユーザーが認証または構成するための URL。( |
dialog |
入力のみのダイアログに関連するインタラクション イベントへのレスポンス。 |
updated |
入力のみの更新されたウィジェットのレスポンス。 |
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 ( |
フィールド | |
---|---|
action |
入力のみのダイアログを呼び出すか送信するリクエストのステータス。必要に応じて、ステータスとメッセージをユーザーに表示します。たとえば、エラーや成功の場合などです。 |
共用体フィールド action 。実行するアクション。action は次のいずれかになります。 |
|
dialog |
入力のみのリクエストのダイアログ。 |
ダイアログ
ダイアログのカード本文をラップします。
JSON 表現 |
---|
{
"body": {
object ( |
フィールド | |
---|---|
body |
入力のみのダイアログの本文。モーダルでレンダリングされます。Google Chat アプリは、 |
ActionStatus
ダイアログを呼び出すか送信するリクエストのステータスを表します。
JSON 表現 |
---|
{
"statusCode": enum ( |
フィールド | |
---|---|
status |
ステータス コード。 |
user |
リクエストのステータスに関するメッセージをユーザーに送信します。設定されていない場合、 |
コード
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
selectionInput
ウィジェットの場合、複数選択メニューの予測入力候補を返します。
JSON 表現 |
---|
{ "widget": string, // Union field |
フィールド | |
---|---|
widget |
更新されたウィジェットの ID。ID は、更新リクエストをトリガーしたウィジェットの ID と一致している必要があります。 |
共用体フィールド updated_widget 。ユーザーの操作に応じて更新されたウィジェット。updated_widget は次のいずれかになります。 |
|
suggestions |
ウィジェットの Autocomplete の結果のリスト |
SelectionItems
ウィジェットの予測入力結果のリスト。
JSON 表現 |
---|
{
"items": [
{
object ( |
フィールド | |
---|---|
items[] |
SelectionItem オブジェクトの配列。 |
SlashCommand
Google Chat のスラッシュ コマンド。
JSON 表現 |
---|
{ "commandId": string } |
フィールド | |
---|---|
command |
呼び出されたスラッシュ コマンドの ID。 |
MatchedUrl
Chat メッセージ内の一致した URL。チャットアプリでは、一致した URL をプレビューできます。詳しくは、リンクをプレビューするをご覧ください。
JSON 表現 |
---|
{ "url": string } |
フィールド | |
---|---|
url |
出力専用。一致した URL。 |
EmojiReactionSummary
特定の絵文字でメッセージにリアクションしたユーザーの数。
JSON 表現 |
---|
{
"emoji": {
object ( |
フィールド | |
---|---|
emoji |
出力専用。リアクションに関連付けられた絵文字。 |
reaction |
出力専用。関連付けられた絵文字を使用したリアクションの合計数。 |
DeletionMetadata
削除されたメッセージに関する情報。deleteTime
が設定されていると、メッセージは削除されます。
JSON 表現 |
---|
{
"deletionType": enum ( |
フィールド | |
---|---|
deletion |
メッセージを削除したユーザーを示します。 |
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 |
出力専用。引用されたメッセージのリソース名。 形式: |
last |
出力専用。引用されたメッセージが作成されたとき、または引用されたメッセージが最後に更新されたときのタイムスタンプ。 |
AttachedGif
URL で指定された GIF 画像。
JSON 表現 |
---|
{ "uri": string } |
フィールド | |
---|---|
uri |
出力専用。GIF 画像をホストする URL。 |
AccessoryWidget
メッセージの下部に表示される 1 つ以上のインタラクティブ ウィジェット。詳しくは、メッセージの下部にインタラクティブなウィジェットを追加するをご覧ください。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド action 。アクションの種類。action は次のいずれかになります。 |
|
button |
ボタンのリスト。 |
メソッド |
|
---|---|
|
Google Chat スペースにメッセージを作成します。 |
|
メッセージを削除します。 |
|
メッセージの詳細を返します。 |
|
呼び出し元がメンバーであるスペース内のメッセージ(ブロックされたメンバーやスペースからのメッセージを含む)を一覧表示します。 |
|
メッセージを更新します。 |
|
メッセージを更新します。 |