インデックス
ChatService
(インターフェース)AccessoryWidget
(メッセージ)ActionResponse
(メッセージ)ActionResponse.ResponseType
(列挙型)ActionResponse.SelectionItems
(メッセージ)ActionResponse.UpdatedWidget
(メッセージ)ActionStatus
(メッセージ)Annotation
(メッセージ)AnnotationType
(列挙型)AttachedGif
(メッセージ)Attachment
(メッセージ)Attachment.Source
(列挙型)AttachmentDataRef
(メッセージ)CardWithId
(メッセージ)ChatSpaceLinkData
(メッセージ)CompleteImportSpaceRequest
(メッセージ)CompleteImportSpaceResponse
(メッセージ)ContextualAddOnMarkup
(メッセージ)ContextualAddOnMarkup.Card
(メッセージ)ContextualAddOnMarkup.Card.CardAction
(メッセージ)ContextualAddOnMarkup.Card.CardHeader
(メッセージ)ContextualAddOnMarkup.Card.CardHeader.ImageStyle
(列挙型)ContextualAddOnMarkup.Card.Section
(メッセージ)CreateMembershipRequest
(メッセージ)CreateMessageRequest
(メッセージ)CreateMessageRequest.MessageReplyOption
(列挙型)CreateReactionRequest
(メッセージ)CreateSpaceRequest
(メッセージ)CustomEmoji
(メッセージ)DeleteMembershipRequest
(メッセージ)DeleteMessageRequest
(メッセージ)DeleteReactionRequest
(メッセージ)DeleteSpaceRequest
(メッセージ)DeletionMetadata
(メッセージ)DeletionMetadata.DeletionType
(列挙型)Dialog
(メッセージ)DialogAction
(メッセージ)DriveDataRef
(メッセージ)DriveLinkData
(メッセージ)Emoji
(メッセージ)EmojiReactionSummary
(メッセージ)FindDirectMessageRequest
(メッセージ)GetAttachmentRequest
(メッセージ)GetMembershipRequest
(メッセージ)GetMessageRequest
(メッセージ)GetSpaceEventRequest
(メッセージ)GetSpaceReadStateRequest
(メッセージ)GetSpaceRequest
(メッセージ)GetThreadReadStateRequest
(メッセージ)Group
(メッセージ)HistoryState
(列挙型)ListMembershipsRequest
(メッセージ)ListMembershipsResponse
(メッセージ)ListMessagesRequest
(メッセージ)ListMessagesResponse
(メッセージ)ListReactionsRequest
(メッセージ)ListReactionsResponse
(メッセージ)ListSpaceEventsRequest
(メッセージ)ListSpaceEventsResponse
(メッセージ)ListSpacesRequest
(メッセージ)ListSpacesResponse
(メッセージ)MatchedUrl
(メッセージ)Membership
(メッセージ)Membership.MembershipRole
(列挙型)Membership.MembershipState
(列挙型)MembershipBatchCreatedEventData
(メッセージ)MembershipBatchDeletedEventData
(メッセージ)MembershipBatchUpdatedEventData
(メッセージ)MembershipCreatedEventData
(メッセージ)MembershipDeletedEventData
(メッセージ)MembershipUpdatedEventData
(メッセージ)Message
(メッセージ)MessageBatchCreatedEventData
(メッセージ)MessageBatchDeletedEventData
(メッセージ)MessageBatchUpdatedEventData
(メッセージ)MessageCreatedEventData
(メッセージ)MessageDeletedEventData
(メッセージ)MessageUpdatedEventData
(メッセージ)QuotedMessageMetadata
(メッセージ)Reaction
(メッセージ)ReactionBatchCreatedEventData
(メッセージ)ReactionBatchDeletedEventData
(メッセージ)ReactionCreatedEventData
(メッセージ)ReactionDeletedEventData
(メッセージ)RichLinkMetadata
(メッセージ)RichLinkMetadata.RichLinkType
(列挙型)SearchSpacesRequest
(メッセージ)SearchSpacesResponse
(メッセージ)SetUpSpaceRequest
(メッセージ)SlashCommand
(メッセージ)SlashCommandMetadata
(メッセージ)SlashCommandMetadata.Type
(列挙型)Space
(メッセージ)Space.AccessSettings
(メッセージ)Space.AccessSettings.AccessState
(列挙型)Space.MembershipCount
(メッセージ)Space.PermissionSetting
(メッセージ)Space.PermissionSettings
(メッセージ)Space.PredefinedPermissionSettings
(列挙型)Space.SpaceDetails
(メッセージ)Space.SpaceThreadingState
(列挙型)Space.SpaceType
(列挙型)Space.Type
(列挙型)SpaceBatchUpdatedEventData
(メッセージ)SpaceEvent
(メッセージ)SpaceReadState
(メッセージ)SpaceUpdatedEventData
(メッセージ)Thread
(メッセージ)ThreadReadState
(メッセージ)UpdateMembershipRequest
(メッセージ)UpdateMessageRequest
(メッセージ)UpdateSpaceReadStateRequest
(メッセージ)UpdateSpaceRequest
(メッセージ)User
(メッセージ)User.Type
(列挙型)UserMentionMetadata
(メッセージ)UserMentionMetadata.Type
(列挙型)WidgetMarkup
(メッセージ)WidgetMarkup.Button
(メッセージ)WidgetMarkup.FormAction
(メッセージ)WidgetMarkup.FormAction.ActionParameter
(メッセージ)WidgetMarkup.Icon
(列挙型)WidgetMarkup.Image
(メッセージ)WidgetMarkup.ImageButton
(メッセージ)WidgetMarkup.KeyValue
(メッセージ)WidgetMarkup.OnClick
(メッセージ)WidgetMarkup.OpenLink
(メッセージ)WidgetMarkup.TextButton
(メッセージ)WidgetMarkup.TextParagraph
(メッセージ)
ChatService
デベロッパーは、Google Chat プラットフォームで Chat 用アプリを構築し、統合できます。
CompleteImportSpace |
---|
指定したスペースのインポート プロセスを完了し、ユーザーに表示します。アプリの認証とドメイン全体の委任が必要です。詳細については、Google Chat アプリにデータのインポートを許可するをご覧ください。
|
CreateMembership |
---|
呼び出し元の Chat アプリ、ユーザー、または Google グループのメンバーシップを作成します。他の Chat 用アプリのメンバーシップ作成はサポートされていません。メンバーシップを作成する際に、指定したメンバーが自動承諾ポリシーを無効にしている場合、そのメンバーは招待されます。スペースに参加するには、スペースへの招待を承諾する必要があります。それ以外の場合、メンバーシップを作成すると、指定したスペースにメンバーが直接追加されます。ユーザー認証が必要です。 使用例については、以下をご覧ください。
|
CreateMessage |
---|
Google Chat スペースでメッセージを作成する。例については、メッセージを送信するをご覧ください。
次の図は、アプリの認証を使用している場合に Chat でメッセージがどのように関連付けられるかを示しています。Chat ではメッセージの送信者として Chat アプリが表示されます。メッセージのコンテンツには、テキスト( 次の図は、ユーザー認証を使用する場合に Chat でメッセージがどのように関連付けられるかを示しています。Chat ではユーザーがメッセージの送信者として表示され、Chat 用アプリにはその名前が表示されます。メッセージのコンテンツにはテキスト( メッセージ コンテンツを含む最大メッセージ サイズは 32,000 バイトです。
|
CreateReaction |
---|
リアクションを作成してメッセージに追加します。サポートされているのは Unicode 絵文字のみです。例については、メッセージにリアクションを追加するをご覧ください。ユーザー認証が必要です。
|
CreateSpace |
---|
メンバーのいないスペースを作成します。名前付きスペースの作成に使用できます。トピック別にグループ化されたスペースはサポートされていません。例については、スペースを作成するをご覧ください。 スペースの作成時に「 デベロッパー プレビュー プログラムのメンバーになっている場合は、 ユーザー認証が必要です。
|
DeleteMembership |
---|
メンバーシップを削除します。例については、スペースからユーザーまたは Google Chat アプリを削除するをご覧ください。 ユーザー認証が必要です。
|
DeleteMessage |
---|
メッセージを削除します。例については、メッセージを削除するをご覧ください。 認証が必要です。アプリの認証とユーザー認証をサポートします。アプリの認証を使用する場合、リクエストで削除できるのは呼び出し元の Chat アプリによって作成されたメッセージのみです。
|
DeleteReaction |
---|
メッセージへのリアクションを削除します。Unicode 絵文字のみがサポートされています。例については、リアクションを削除するをご覧ください。ユーザー認証が必要です。
|
DeleteSpace |
---|
名前付きスペースを削除します。常にカスケード削除が実行されます。つまり、スペースに投稿されたメッセージやスペースのメンバーなど、スペースの子リソースも削除されます。例については、スペースを削除するをご覧ください。スペースを削除する権限を持つユーザーにユーザー認証が必要です。
|
FindDirectMessage |
---|
指定したユーザーとの既存のダイレクト メッセージを返します。ダイレクト メッセージ スペースが見つからない場合は、 ユーザー認証では、指定されたユーザーと認証済みユーザーの間のダイレクト メッセージ スペースを返します。 アプリの認証では、指定したユーザーと呼び出し元の Chat アプリ間のダイレクト メッセージ スペースを返します。
|
GetAttachment |
---|
メッセージの添付ファイルのメタデータを取得します。添付ファイルのデータは、メディア API を使用して取得されます。例については、メッセージの添付ファイルに関するメタデータの取得をご覧ください。アプリの認証が必要です。
|
GetMembership |
---|
メンバーシップに関する詳細を返します。例については、ユーザーまたは Google Chat アプリのメンバーシップに関する詳細情報を取得するをご覧ください。 認証が必要です。アプリの認証とユーザー認証をサポートします。
|
GetMessage |
---|
メッセージの詳細を返します。例については、メッセージの詳細を取得するをご覧ください。 認証が必要です。アプリの認証とユーザー認証をサポートします。 注: ブロック中のメンバーやスペースからメッセージが返されることがあります。
|
GetSpace |
---|
スペースの詳細を返します。例については、スペースの詳細を取得するをご覧ください。 認証が必要です。アプリの認証とユーザー認証をサポートします。
|
GetSpaceEvent |
---|
Google Chat スペースからイベントを返します。イベント ペイロードには、変更されたリソースの最新バージョンが含まれます。たとえば、新しいメッセージに関するイベントをリクエストし、その後メッセージが更新された場合、サーバーは更新された ユーザー認証が必要です。イベントを取得するには、認証済みのユーザーがスペースのメンバーである必要があります。 例については、Google Chat スペースからの予定の詳細を取得するをご覧ください。
|
GetSpaceReadState |
---|
スペース内でのユーザーの既読状態に関する詳細を返します。既読メッセージと未読メッセージを識別するために使用されます。例については、ユーザーのスペース読み取り状態の詳細を取得するをご覧ください。 ユーザー認証が必要です。
|
GetThreadReadState |
---|
スレッド内のユーザーの既読状態に関する詳細を返します。既読または未読のメッセージを識別するために使用されます。例については、ユーザーのスレッドの読み取りステータスの詳細を取得するをご覧ください。 ユーザー認証が必要です。
|
ListMemberships |
---|
スペースのメンバーを一覧表示します。例については、スペース内のユーザーと Google Chat アプリを一覧表示するをご覧ください。アプリの認証を使用してメンバーを一覧表示する場合、Chat アプリがアクセスできるスペースのメンバーシップが一覧表示されますが、Chat アプリのメンバーシップは除きます。[ユーザー認証] を使用して、メンバーを一覧表示する場合、認証されたユーザーがアクセスできるスペースのメンバーシップを一覧表示します。 認証が必要です。アプリの認証とユーザー認証をサポートします。
|
ListMessages |
---|
発信者がメンバーになっているスペース内のメッセージ(ブロック中のメンバーとスペースからのメッセージを含む)を一覧表示します。メッセージのないスペースのメッセージを一覧表示すると、レスポンスは空のオブジェクトになります。REST/HTTP インターフェースを使用する場合、レスポンスには空の JSON オブジェクト
|
ListReactions |
---|
メッセージに対するリアクションを一覧表示します。例については、メッセージのリアクションを一覧表示するをご覧ください。ユーザー認証が必要です。
|
ListSpaceEvents |
---|
Google Chat スペースのイベントを一覧表示します。各イベントのペイロードには、Chat リソースの最新バージョンが含まれます。たとえば、スペースの新しいメンバーに関するイベントを一覧表示すると、サーバーは最新のメンバーシップ情報を含む ユーザー認証が必要です。イベントを一覧表示するには、認証済みのユーザーがスペースのメンバーである必要があります。 例については、Google Chat スペースのイベントを一覧表示するをご覧ください。
|
ListSpaces |
---|
呼び出し元がメンバーになっているスペースを一覧表示します。グループ チャットと DM は、最初のメッセージが送信されるまで表示されません。例については、スペースを一覧表示するをご覧ください。 認証が必要です。アプリ認証とユーザー認証をサポートしています。 呼び出し元または認証されたユーザーに表示されるスペースを一覧表示します。グループ チャットと DM は、最初のメッセージが送信されるまで表示されません。 Google Workspace の組織ごとにすべての名前付きスペースを一覧表示するには、代わりに Workspace の管理者権限を使用して
|
SearchSpaces |
---|
use_admin_access を true に設定します。
|
SetUpSpace |
---|
スペースを作成し、指定したユーザーを追加します。呼び出し元のユーザーはスペースに自動的に追加されるため、リクエストでメンバーシップとして指定しないでください。例については、初期メンバーを含むスペースを設定するをご覧ください。 追加する人間のメンバーを指定するには、適切な 追加する Google グループを指定するには、適切な 名前付きスペースまたはグループ チャットの場合、発信者がブロックされている場合、発信者が一部のメンバーによってブロックされている場合、または一部のメンバーを追加する権限がない場合、それらのメンバーは作成されたスペースに追加されません。 呼び出し元のユーザーと別の人間のユーザー間のダイレクト メッセージ(DM)を作成するには、人間のユーザーを表すメンバーシップを 1 つだけ指定します。一方のユーザーが他方をブロックすると、リクエストは失敗し、DM は作成されません。 通話ユーザーと通話アプリの間の DM を作成するには、 2 人のユーザー間にすでに DM が存在する場合、リクエスト時に一方のユーザーがもう一方をブロックしても、既存の DM が返されます。 スレッド返信のスペースはサポートされていません。スペースの設定中にエラー メッセージ ユーザー認証が必要です。
|
UpdateMembership |
---|
メンバーシップを更新します。例については、スペース内のユーザーのメンバーシップを更新するをご覧ください。 ユーザー認証が必要です。
|
UpdateMessage |
---|
メッセージを更新します。 認証が必要です。アプリの認証とユーザー認証をサポートします。アプリの認証を使用する場合、リクエストで更新できるのは、呼び出し元の Chat アプリによって作成されたメッセージのみです。
|
UpdateSpace |
---|
スペースを更新します。例については、スペースを更新するをご覧ください。
ユーザー認証が必要です。
|
UpdateSpaceReadState |
---|
スペース内のユーザーの既読状態を更新します。既読メッセージと未読メッセージを識別するために使用します。例については、ユーザーのスペース読み取り状態を更新するをご覧ください。 ユーザー認証が必要です。
|
AccessoryWidget
メールの下部に表示される、1 つ以上のインタラクティブなウィジェットです。詳しくは、メールの下部にインタラクティブなウィジェットを追加するをご覧ください。
フィールド | |
---|---|
共用体フィールド action 。アクションのタイプ。action は次のいずれかになります。 |
|
button_list |
ボタンのリスト。 |
ActionResponse
Chat 用アプリが回答の投稿方法を構成するために使用できるパラメータ。
フィールド | |
---|---|
type |
入力のみのChat アプリのレスポンスのタイプ。 |
url |
入力のみのユーザーが認証または構成するための URL。( |
dialog_action |
入力のみのダイアログに関連する操作イベントに対するレスポンス。 |
updated_widget |
入力のみの更新されたウィジェットのレスポンス。 |
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 |
ウィジェットのテキストの予測入力オプションのクエリ。 |
SelectionItems
ウィジェット 予測入力の結果のリスト。
フィールド | |
---|---|
items[] |
SelectionItem オブジェクトの配列。 |
UpdatedWidget
更新されたウィジェットのレスポンス。ウィジェットの予測入力オプションを提供するために使用されます。
フィールド | |
---|---|
widget |
更新されたウィジェットの ID。この ID は、更新リクエストをトリガーしたウィジェットの ID と一致する必要があります。 |
共用体フィールド updated_widget 。ウィジェットがユーザーの操作に応じて更新される。updated_widget は次のいずれかになります。 |
|
suggestions |
ウィジェットの予測入力結果のリスト |
ActionStatus
ダイアログを呼び出すか送信するリクエストのステータスを表します。
フィールド | |
---|---|
status_code |
ステータス コード。 |
user_facing_message |
リクエストのステータスについてユーザーに送信するメッセージ。設定しない場合、 |
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"
}
}]
フィールド | |
---|---|
type |
このアノテーションの型。 |
length |
このアノテーションが対応する書式なしテキスト メッセージ本文の部分文字列の長さ。 |
start_index |
このアノテーションが対応する書式なしテキストのメッセージ本文の開始インデックス(0 から始まり、両端を含む)。 |
共用体フィールド metadata 。アノテーションに関する追加のメタデータ。metadata は次のいずれかになります。 |
|
user_mention |
ユーザーのメンションのメタデータ。 |
slash_command |
スラッシュ コマンドのメタデータ。 |
rich_link_metadata |
リッチリンクのメタデータ。 |
AnnotationType
アノテーションの型。
列挙型 | |
---|---|
ANNOTATION_TYPE_UNSPECIFIED |
列挙型のデフォルト値。使用しないでください。 |
USER_MENTION |
ユーザーが名前リンク付きでメンションされた。 |
SLASH_COMMAND |
スラッシュ コマンドが呼び出されます。 |
RICH_LINK |
リッチリンク アノテーション。 |
AttachedGif
URL で指定された GIF 画像。
フィールド | |
---|---|
uri |
出力専用。GIF 画像をホストする URL。 |
添付ファイル
Google Chat での添付ファイル。
フィールド | |
---|---|
name |
アタッチメントのリソース名( |
content_name |
出力専用。コンテンツの元のファイル名(フルパスではない)。 |
content_type |
出力専用。ファイルのコンテンツ タイプ(MIME タイプ)。 |
thumbnail_uri |
出力専用。ユーザーに添付ファイルをプレビューするために使用するサムネイル URL。Chat アプリでは、この URL を使用して添付ファイルのコンテンツをダウンロードすることはできません。 |
download_uri |
出力専用。人間のユーザーが添付ファイルをダウンロードできるようにするダウンロード URL。Chat アプリでは、この URL を使用して添付ファイルのコンテンツをダウンロードすることはできません。 |
source |
出力専用。アタッチメントのソース。 |
共用体フィールド data_ref 。添付ファイルへのデータ参照。data_ref は次のいずれかになります。 |
|
attachment_data_ref |
添付ファイル データへの参照。このフィールドは、添付ファイル データをダウンロードするために Media API で使用されます。 |
drive_data_ref |
出力専用。Google ドライブの添付ファイルへの参照。このフィールドは Google Drive API で使用されます。 |
ソース
アタッチメントのソース。
列挙型 | |
---|---|
SOURCE_UNSPECIFIED |
予約済み。 |
DRIVE_FILE |
Google ドライブ ファイルである。 |
UPLOADED_CONTENT |
ファイルが Chat にアップロードされます。 |
AttachmentDataRef
添付ファイル データへの参照。
フィールド | |
---|---|
resource_name |
添付ファイル データのリソース名。このフィールドは、添付ファイル データをダウンロードするために Media API で使用されます。 |
attachment_upload_token |
アップロードされた添付ファイルへの参照を含む不透明トークン。クライアントによって不透明な文字列として扱われ、添付ファイルを含む Chat メッセージを作成または更新するために使用されます。 |
CardWithId
Google Chat メッセージのカード。
カードを作成できるのは Chat アプリのみです。Chat アプリがユーザーとして認証されている場合、メッセージにカードを含めることはできません。
カードビルダーでカードをデザインしてプレビューする。
カードビルダーを開くフィールド | |
---|---|
card_id |
メッセージに複数のカードが含まれている場合に必須です。メッセージ内のカードの一意の識別子。 |
card |
カード最大サイズは 32 KB です。 |
ChatSpaceLinkData
Chat スペースのリンクのデータ。
フィールド | |
---|---|
space |
リンクされた Chat スペース リソースのスペース。 形式: |
thread |
リンクされた Chat スペース リソースのスレッド。 形式: |
message |
リンクされた Chat スペース リソースのメッセージ。 形式: |
CompleteImportSpaceRequest
スペースのインポート プロセスを完了するためのリクエスト メッセージ。
フィールド | |
---|---|
name |
必須。インポート モードのスペースのリソース名。 形式: |
CompleteImportSpaceResponse
スペースのインポート プロセスの完了に対するレスポンス メッセージ。
フィールド | |
---|---|
space |
インポート モードのスペース。 |
ContextualAddOnMarkup
この型にはフィールドがありません。
デベロッパーがコンテキストに応じたアドオンのコンテンツを指定するためのマークアップ。
カード
カードは、テキストや画像などの UI ウィジェットを追加できる UI 要素です。
フィールド | |
---|---|
header |
カードのヘッダー。通常、ヘッダーにはタイトルと画像を指定します。 |
sections[] |
セクションは線で区切ります。 |
card_actions[] |
このカードのアクション。 |
name |
カードの名前。 |
CardAction
カード アクションとは、カードに関連付けられているアクションです。請求書カードの場合、通常は請求書を削除するか、請求書をメールで送信するか、ブラウザで請求書を開きます。
Google Chat アプリではサポートされません。
フィールド | |
---|---|
action_label |
操作メニュー項目に表示されるために使用されるラベル。 |
on_click |
このアクション アイテムの click アクション。 |
CardHeader
フィールド | |
---|---|
title |
タイトルを指定してください。ヘッダーの高さは固定されています。タイトルとサブタイトルの両方を指定すると、それぞれが 1 行になります。タイトルのみを指定する場合は、2 行に記述します。 |
subtitle |
カードヘッダーのサブタイトル。 |
image_style |
画像の種類(正方形の枠線や円形の枠線など)。 |
image_url |
カード ヘッダーの画像の URL。 |
ImageStyle
列挙型 | |
---|---|
IMAGE_STYLE_UNSPECIFIED |
|
IMAGE |
正方形の枠線。 |
AVATAR |
円形の枠線。 |
セクション
セクションには、指定された順序で(垂直に)レンダリングされるウィジェットのコレクションが含まれます。どのプラットフォームでもカードの幅は固定されるため、現時点ではレイアウト プロパティ(float など)は必要ありません。
フィールド | |
---|---|
header |
セクションのヘッダー。書式設定されたテキストがサポートされています。テキストの書式設定について詳しくは、Google Chat アプリでのテキストの書式設定と Google Workspace アドオンでのテキストの書式設定をご覧ください。 |
widgets[] |
セクションには、少なくとも 1 つのウィジェットが含まれている必要があります。 |
CreateMembershipRequest
メンバーシップを作成するためのリクエスト メッセージ。
フィールド | |
---|---|
parent |
必須。メンバーシップを作成するスペースのリソース名。 形式: spaces/{space} |
membership |
必須。作成するメンバーシップ リレーション。 |
use_admin_access |
true の場合、メソッドはユーザーの Google Workspace 管理者権限を使用して実行されます。発信ユーザーは、「Chat とスペースの会話の管理」権限を持つ Google Workspace 管理者である必要があります。
管理者アクセスを使用して、アプリのメンバーシップを作成したり、管理者の Google Workspace 組織外のユーザーのメンバーシップを作成したりすることはできません。 |
CreateMessageRequest
メッセージを作成します。
フィールド | |
---|---|
parent |
必須。メッセージを作成するスペースのリソース名。 形式: |
message |
必須。メッセージ本文。 |
thread_key |
省略可。非推奨: 代わりに |
request_id |
省略可。このメッセージの一意のリクエスト ID。既存のリクエスト ID を指定すると、新しいメッセージを作成するのではなく、その ID で作成されたメッセージが返されます。 |
message_reply_option |
省略可。メールがスレッドを開始するか、スレッドに返信するかを指定します。名前付きスペースでのみサポートされています。 |
message_id |
省略可。メッセージのカスタム ID。システムによって割り当てられた ID をメッセージのリソース名(メッセージの このフィールドの値は、次の要件を満たす必要があります。
詳しくは、メッセージに名前を付けるをご覧ください。 |
MessageReplyOption
メッセージに返信する方法を指定します。今後、他の州が追加される可能性があります。
列挙型 | |
---|---|
MESSAGE_REPLY_OPTION_UNSPECIFIED |
デフォルト。新しいスレッドを開始します。このオプションを使用すると、含まれる thread ID または が無視されます。 |
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD |
thread ID または で指定されたスレッドへの返信としてメッセージを作成します。失敗した場合は、代わりに新しいスレッドが開始されます。 |
REPLY_MESSAGE_OR_FAIL |
thread ID または で指定されたスレッドへの返信としてメッセージを作成します。新しい thread_key を使用すると、新しいスレッドが作成されます。メッセージの作成に失敗した場合は、代わりに NOT_FOUND エラーが返されます。 |
CreateReactionRequest
メッセージへのリアクションを作成します。
フィールド | |
---|---|
parent |
必須。リアクションが作成されるメッセージ。 形式: |
reaction |
必須。作成するリアクション。 |
CreateSpaceRequest
メンバーのいないスペースを作成するためのリクエスト。
フィールド | |
---|---|
space |
必須。 「 デベロッパー プレビュー プログラムのメンバーの場合、 スペース |
request_id |
省略可。このリクエストの一意の識別子。ランダムな UUID をおすすめします。既存のリクエスト ID を指定すると、新しいスペースを作成するのではなく、その ID で作成されたスペースが返されます。同じ Chat アプリから別の認証済みユーザーを含む既存のリクエスト ID を指定すると、エラーが返されます。 |
CustomEmoji
カスタム絵文字を表します。
フィールド | |
---|---|
uid |
出力専用。カスタム絵文字リソースの一意のキー。 |
DeleteMembershipRequest
スペースのメンバーシップの削除をリクエストします。
フィールド | |
---|---|
name |
必須。削除するメンバーシップのリソース名。Chat アプリでは、ユーザーが指定した内容をまたは独自のメンバーシップが必要です。Chat アプリで他のアプリを削除することはできません。できます。 人間のメンバーシップを削除する場合、 アプリ メンバーシップを削除する場合は、 形式: |
use_admin_access |
true の場合、メソッドはユーザーの Google Workspace 管理者権限を使用して実行されます。発信ユーザーは、「Chat とスペースの会話の管理」権限を持つ Google Workspace 管理者である必要があります。
管理者権限を使用してスペース内のアプリ メンバーシップを削除することはできません。 |
DeleteMessageRequest
メッセージの削除をリクエストします。
フィールド | |
---|---|
name |
必須。メッセージのリソース名。 形式: メッセージにカスタム ID を設定している場合は、 |
force |
ユーザーとして認証している場合にのみ適用されます。Chat 用アプリとして認証する場合には影響しません。 |
DeleteReactionRequest
メッセージへのリアクションを削除します。
フィールド | |
---|---|
name |
必須。削除するリアクションの名前。 形式: |
DeleteSpaceRequest
スペースの削除をリクエストします。
フィールド | |
---|---|
name |
必須。削除するスペースのリソース名。 形式: |
use_admin_access |
true の場合、メソッドはユーザーの Google Workspace 管理者権限を使用して実行されます。発信ユーザーは、「Chat とスペースの会話の管理」権限を持つ Google Workspace 管理者である必要があります。
|
DeletionMetadata
削除されたメッセージについての情報。delete_time
が設定されている場合、メッセージは削除されます。
フィールド | |
---|---|
deletion_type |
メッセージを削除したユーザーを示します。 |
DeletionType
メッセージを削除したユーザーと、その削除方法
列挙型 | |
---|---|
DELETION_TYPE_UNSPECIFIED |
この値は使用されません。 |
CREATOR |
ユーザーが自分のメッセージを削除した。 |
SPACE_OWNER |
スペースのオーナーがメッセージを削除しました。 |
ADMIN |
Google Workspace 管理者がメッセージを削除した。 |
APP_MESSAGE_EXPIRY |
Chat アプリの期限が切れたときに独自のメッセージを削除しました。 |
CREATOR_VIA_APP |
ユーザーに代わって Chat アプリがメッセージを削除しました。 |
SPACE_OWNER_VIA_APP |
スペースのオーナーに代わって Chat アプリがメッセージを削除しました。 |
ダイアログ
ダイアログのカード本文のラッパー。
フィールド | |
---|---|
body |
入力のみのモーダルでレンダリングされるダイアログの本文。Google Chat アプリでは、 |
DialogAction
ダイアログとリクエスト ステータス コードが含まれます。
フィールド | |
---|---|
action_status |
入力のみのダイアログを呼び出すか送信するリクエストのステータス。必要に応じて、ユーザーにステータスとメッセージを表示します。たとえば、エラーや成功の場合などです。 |
共用体フィールド action 。実行するアクション。action は次のいずれかになります。 |
|
dialog |
入力のみのリクエストの Dialog。 |
DriveDataRef
ドライブのアタッチメントのデータへの参照。
フィールド | |
---|---|
drive_file_id |
ドライブ ファイルの ID。Drive API で使用する。 |
DriveLinkData
Google ドライブのリンクのデータ。
フィールド | |
---|---|
drive_data_ref |
Google ドライブ ファイルを参照する DriveDataRef。 |
mime_type |
リンクされた Google ドライブ リソースの MIME タイプ。 |
絵文字
メッセージに対するリアクションとして使用される絵文字。
フィールド | |
---|---|
共用体フィールド content 。絵文字の内容。content は次のいずれかになります。 |
|
unicode |
Unicode 文字列で表される基本的な絵文字。 |
custom_emoji |
出力専用。カスタム絵文字。 |
EmojiReactionSummary
特定の絵文字を含むメッセージにリアクションしたユーザーの数。
フィールド | |
---|---|
emoji |
リアクションに関連付けられた絵文字。 |
reaction_count |
関連付けられている絵文字を使用したリアクションの合計数。 |
FindDirectMessageRequest
ユーザー リソースに基づいてダイレクト メッセージ スペースを取得するためのリクエスト。
フィールド | |
---|---|
name |
必須。ダイレクト メッセージを検索するユーザーのリソース名。 形式: |
GetAttachmentRequest
添付ファイルの取得をリクエストします。
フィールド | |
---|---|
name |
必須。アタッチメントのリソース名( |
GetMembershipRequest
スペースのメンバーシップを取得するためのリクエスト。
フィールド | |
---|---|
name |
必須。取得するメンバーシップのリソース名。 ユーザー認証を使用してアプリのメンバーシップを取得するには、必要に応じて 形式: ユーザーとして認証されたら、そのユーザーのメールアドレスを |
use_admin_access |
true の場合、メソッドはユーザーの Google Workspace 管理者権限を使用して実行されます。発信ユーザーは、「Chat とスペースの会話の管理」権限を持つ Google Workspace 管理者である必要があります。
管理者権限を使用している場合、スペースでアプリ メンバーシップを取得することはできません。 |
GetMessageRequest
メッセージを取得するためのリクエスト。
フィールド | |
---|---|
name |
必須。メッセージのリソース名。 形式: メッセージにカスタム ID を設定している場合は、 |
GetSpaceEventRequest
スペースのイベントを取得するためのリクエスト メッセージ。
フィールド | |
---|---|
name |
必須。スペース イベントのリソース名。 形式: |
GetSpaceReadStateRequest
GetSpaceReadState API に対するリクエスト メッセージ。
フィールド | |
---|---|
name |
必須。取得するスペース読み取り状態のリソース名。 呼び出し元ユーザーの読み取り状態の取得のみをサポートします。 呼び出し元のユーザーを参照するには、次のいずれかを設定します。
形式: users/{user}/spaces/{space}/spaceReadState |
GetSpaceRequest
1 つのスペースを返すリクエスト。
フィールド | |
---|---|
name |
必須。スペースのリソース名( 形式: |
use_admin_access |
true の場合、メソッドはユーザーの Google Workspace 管理者権限を使用して実行されます。発信ユーザーは、「Chat とスペースの会話の管理」権限を持つ Google Workspace 管理者である必要があります。
|
GetThreadReadStateRequest
GetThreadReadStateRequest API に対するリクエスト メッセージ。
フィールド | |
---|---|
name |
必須。取得するスレッド読み取り状態のリソース名。 呼び出し元ユーザーの読み取り状態の取得のみをサポートします。 呼び出し元のユーザーを参照するには、次のいずれかを設定します。
形式: users/{user}/spaces/{space}/threads/{thread}/threadReadState |
グループ
Google Chat の Google グループ。
フィールド | |
---|---|
name |
Google グループのリソース名。 Cloud Identity Groups API のグループを表します。 形式: groups/{group} |
HistoryState
メッセージとスペースの履歴状態。メッセージと会話スレッドを作成後に保持する期間を指定します。
列挙型 | |
---|---|
HISTORY_STATE_UNSPECIFIED |
デフォルト値。使用しないでください。 |
HISTORY_OFF |
履歴はオフです。メッセージとスレッドは 24 時間保持されます。 |
HISTORY_ON |
履歴はオンです。メッセージとスレッドの保持期間は、組織の Vault の保持ルールで指定されています。 |
ListMembershipsRequest
メンバーシップをリスティングするためのリクエスト メッセージ。
フィールド | |
---|---|
parent |
必須。メンバーシップ リストを取得するスペースのリソース名。 形式: spaces/{space} |
page_size |
省略可。返されるメンバーシップの最大数。サービスはこの値よりも少ない値を返すことがあります。 指定しない場合、最大で 100 個のメンバーシップが返されます。 最大値は 1,000 です。1,000 を超える値を使用すると、自動的に 1,000 に変更されます。 負の値を指定すると、 |
page_token |
省略可。メンバーシップを一覧表示する前回の呼び出しから受け取ったページトークン。このパラメータを指定すると、後続のページを取得できます。 ページ分割を行う場合、指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。他のパラメータに異なる値を渡すと、予期しない結果が生じる可能性があります。 |
filter |
省略可。クエリフィルタ。 メンバーシップは、メンバーのロール( ロールでフィルタするには、 タイプでフィルタするには、 ロールとタイプの両方でフィルタするには、
たとえば、次のクエリは有効です。
次のクエリは無効です。
無効なクエリは、サーバーによって |
show_groups |
省略可。 |
show_invited |
省略可。 現在はユーザー認証が必要です。 |
use_admin_access |
true の場合、メソッドはユーザーの Google Workspace 管理者権限を使用して実行されます。発信ユーザーは、「Chat とスペースの会話の管理」権限を持つ Google Workspace 管理者である必要があります。
管理者権限を使用している場合、スペース内のアプリ メンバーシップを一覧表示することはできません。 |
ListMembershipsResponse
スペースのリスト メンバーシップに対するレスポンス。
フィールド | |
---|---|
memberships[] |
順序なしリスト。リクエストされた(または最初の)ページのメンバーシップのリスト。 |
next_page_token |
結果の次のページを取得するために |
ListMessagesRequest
ユーザーがメンバーになっている、指定されたスペース内のメッセージをリストします。
フィールド | |
---|---|
parent |
必須。メッセージを一覧表示するスペースのリソース名。 形式: |
page_size |
返されるメッセージの最大数。サービスから返されるメッセージはこの値よりも少ないことがあります。 指定しない場合は、最大で 25 個が返されます。 最大値は 1,000 です。1,000 を超える値を使用すると、自動的に 1,000 に変更されます。 負の値を指定すると、 |
page_token |
前のクエリから再開する場合は省略可。 前回の list メッセージ呼び出しから受け取ったページトークン。このパラメータを指定すると、後続のページを取得できます。 ページ分割を行う場合、指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。他のパラメータに異なる値を渡すと、予期しない結果が生じる可能性があります。 |
filter |
クエリフィルタ。 日付( 作成日でメッセージをフィルタするには、 スレッドでフィルタするには、 スレッドと日付の両方でフィルタするには、クエリで たとえば、次のクエリは有効です。
無効なクエリは、サーバーによって |
order_by |
省略可(前のクエリから再開する場合)。 メッセージのリストを並べ替える方法。順序付けオペレーションによって順序付けする値を指定します。有効な順序付けオペレーションの値は次のとおりです。
デフォルトの順序は |
show_deleted |
削除済みのメッセージを含めるかどうかを指定します。削除されたメッセージには、削除日時とその削除に関するメタデータが含まれますが、メッセージのコンテンツは利用できません。 |
ListMessagesResponse
メッセージの一覧表示に対するレスポンス メッセージ。
フィールド | |
---|---|
messages[] |
メッセージのリスト。 |
next_page_token |
トークンを |
ListReactionsRequest
メッセージに対するリアクションを一覧表示します。
フィールド | |
---|---|
parent |
必須。ユーザーがリアクションしたメッセージ。 形式: |
page_size |
省略可。返されるリアクションの最大数。サービスは、この値よりも少ないリアクションを返すことができます。指定しない場合、デフォルト値は 25 です。最大値は 200 です。200 を超える値は 200 に変更されます |
page_token |
省略可。(前のクエリから再開する場合)。 前の list reactions 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。 ページ分割を行う場合、フィルタ値はページトークンを提供した呼び出しと一致する必要があります。別の値を渡すと、予期しない結果になる可能性があります。 |
filter |
省略可。クエリフィルタ。 絵文字( 複数の絵文字やユーザーのリアクションをフィルタするには、類似のフィールドを 絵文字やユーザーでリアクションをフィルタするには、 クエリで たとえば、次のクエリは有効です。
次のクエリは無効です。
無効なクエリは、サーバーによって |
ListReactionsResponse
リアクションの一覧表示リクエストに対するレスポンス。
フィールド | |
---|---|
reactions[] |
リクエストされた(または最初の)ページのリアクションのリスト。 |
next_page_token |
結果の次のページを取得するための継続トークン。結果の最後のページは空になります。 |
ListSpaceEventsRequest
リスティング スペース イベントのリクエスト メッセージ。
フィールド | |
---|---|
parent |
必須。イベントが発生した Google Chat スペースのリソース名。 形式: |
page_size |
省略可。返される空間イベントの最大数。サービスはこの値よりも少ない値を返すことがあります。 負の値を指定すると、 |
page_token |
前回のリストスペース イベント呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。 ページ分割を行う場合、スペース イベントをリストするために指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。他のパラメータに異なる値を渡すと、予期しない結果が生じる可能性があります。 |
filter |
必須。クエリフィルタ。 has 必要に応じて、開始時間(
開始時間または終了時間を指定するには、等式 たとえば、次のクエリは有効です。
次のクエリは無効です。
無効なクエリは、サーバーによって |
ListSpaceEventsResponse
スペース イベントの一覧表示に対するレスポンス メッセージ。
フィールド | |
---|---|
space_events[] |
結果は時系列で返されます(古いイベントが先)。 |
next_page_token |
より多くのイベントを取得するために使用される継続トークン。このフィールドを省略すると、後続のページはなくなります。 |
ListSpacesRequest
呼び出し元がメンバーとなっているスペースを一覧表示するためのリクエスト。
フィールド | |
---|---|
page_size |
省略可。返されるスペースの最大数。サービスはこの値よりも少ない値を返すことがあります。 指定しない場合、最大で 100 個のスペースが返されます。 最大値は 1,000 です。1,000 を超える値を使用すると、自動的に 1,000 に変更されます。 負の値を指定すると、 |
page_token |
省略可。前の list スペース呼び出しから受け取ったページトークン。このパラメータを指定すると、後続のページを取得できます。 ページ分割を行う場合、フィルタ値はページトークンを提供した呼び出しと一致する必要があります。別の値を渡すと、予期しない結果になる可能性があります。 |
filter |
省略可。クエリフィルタ。 スペースは種類( スペースのタイプでフィルタするには、 たとえば、次のクエリは有効です。
無効なクエリは、サーバーによって |
ListSpacesResponse
スペースの一覧表示リクエストに対するレスポンス。
フィールド | |
---|---|
spaces[] |
リクエストされた(または最初の)ページのスペースのリスト。 |
next_page_token |
トークンを |
MatchedUrl
Chat メッセージ内の一致した URL。Chat アプリでは、一致した URL をプレビューできます。詳細については、プレビュー リンクをご覧ください。
フィールド | |
---|---|
url |
出力専用。一致した URL。 |
メンバーシップ
ユーザーまたは Chat アプリがスペースに招待されているか、スペースの一部であるか、参加していないかなど、Google Chat のメンバーシップ関係を表します。
フィールド | |
---|---|
name |
サーバーによって割り当てられたメンバーシップのリソース名。 形式: |
state |
出力専用。メンバーシップの状態。 |
role |
省略可。Chat スペース内のユーザーのロール。スペースで許可されるアクションが決まります。 このフィールドは |
create_time |
省略可。変更不可。メンバーシップの作成時刻(メンバーがスペースに参加した、スペースに招待されたなど)。このフィールドは出力専用です。ただし、インポート モードのスペースで過去のメンバーシップをインポートするために使用する場合は除きます。 |
delete_time |
省略可。変更不可。メンバーシップの削除日時(メンバーがスペースから退出したとき、スペースから削除されたときなど)。このフィールドは出力専用です。ただし、インポート モードのスペースで過去のメンバーシップをインポートするために使用する場合は除きます。 |
共用体フィールド memberType 。このメンバーシップに関連付けられているメンバー。他のメンバータイプは今後サポートされる可能性があります。memberType は次のいずれかになります。 |
|
member |
メンバーシップが対応する Google Chat ユーザーまたはアプリ。Chat アプリがユーザーとして認証された場合、出力はユーザーの |
group_member |
メンバーシップが対応する Google グループ。 |
MembershipRole
Chat スペースでユーザーが許可されるアクションを表します。今後、他の列挙値が追加される可能性があります。
列挙型 | |
---|---|
MEMBERSHIP_ROLE_UNSPECIFIED |
デフォルト値。users の場合: このユーザーはスペースのメンバーではありませんが、招待できます。Google Groups の場合: 常にこのロールが割り当てられます(将来、他の列挙値が使用される可能性があります)。 |
ROLE_MEMBER |
スペースのメンバー。ユーザーが、スペースへのメッセージの送信など、基本的な権限を持っていること。1 対 1 や名前のないグループ会話では、全員にこの役割が割り当てられます。 |
ROLE_MANAGER |
スペースの管理者。このユーザーには、すべての基本的な権限に加え、メンバーの追加や削除など、スペースを管理するための管理権限があります。SpaceType.SPACE でのみサポートされています。 |
MembershipState
メンバーとスペースの関係を指定します。他のメンバーシップの状態は、今後サポートされる可能性があります。
列挙型 | |
---|---|
MEMBERSHIP_STATE_UNSPECIFIED |
デフォルト値。使用しないでください。 |
JOINED |
ユーザーがスペースに追加され、スペースに参加できるようになります。 |
INVITED |
ユーザーはスペースに招待されましたが、まだ参加していません。 |
NOT_A_MEMBER |
ユーザーはスペースに所属しておらず、スペースへの招待が保留中ではありません。 |
MembershipBatchCreatedEventData
複数の新しいメンバーシップのイベント ペイロード。
イベントタイプ: google.workspace.chat.membership.v1.batchCreated
フィールド | |
---|---|
memberships[] |
新しいメンバーシップのリスト。 |
MembershipBatchDeletedEventData
複数の削除されたメンバーシップのイベント ペイロード。
イベントタイプ: google.workspace.chat.membership.v1.batchDeleted
フィールド | |
---|---|
memberships[] |
削除されたメンバーシップのリスト。 |
MembershipBatchUpdatedEventData
更新された複数のメンバーシップのイベント ペイロード。
イベントタイプ: google.workspace.chat.membership.v1.batchUpdated
フィールド | |
---|---|
memberships[] |
更新されたメンバーシップのリスト。 |
MembershipCreatedEventData
新しいメンバーシップのイベント ペイロード。
イベントタイプ: google.workspace.chat.membership.v1.created
。
フィールド | |
---|---|
membership |
新しいメンバーシップ。 |
MembershipDeletedEventData
削除されたメンバーシップのイベント ペイロード。
イベントタイプ: google.workspace.chat.membership.v1.deleted
フィールド | |
---|---|
membership |
削除されたメンバーシップ。 |
MembershipUpdatedEventData
更新されたメンバーシップのイベント ペイロード。
イベントタイプ: google.workspace.chat.membership.v1.updated
フィールド | |
---|---|
membership |
更新されたメンバーシップ。 |
メッセージ
Google Chat スペース内のメッセージ。
フィールド | |
---|---|
name |
メッセージのリソース名。 形式: ここで、 メッセージの作成時にカスタム ID を設定する場合、 |
sender |
出力専用。メッセージを作成したユーザー。Chat アプリがユーザーとして認証された場合、出力はユーザーの |
create_time |
省略可。変更不可。Chat で作成されたスペースの場合、メッセージが作成された時刻。このフィールドは出力専用です。ただし、インポート モードのスペースで使用する場合は除きます。 インポート モードのスペースの場合、元の作成時間を保持するため、このフィールドを、ソースでメッセージが作成された時点のタイムスタンプに設定します。 |
last_update_time |
出力専用。ユーザーがメッセージを最後に編集した時刻。メッセージが編集されていない場合、このフィールドは空です。 |
delete_time |
出力専用。Google Chat でメッセージが削除された時刻。メッセージが削除されない場合、このフィールドは空です。 |
text |
書式なしテキストのメッセージ本文。画像、動画、ウェブページへの最初のリンクは、プレビュー チップを生成します。Google Chat ユーザーまたはスペース内の全員に名前リンクを付けることもできます。 テキスト メッセージの作成方法については、メッセージを送信するをご覧ください。 |
formatted_text |
出力専用。書式設定を伝達するためのマークアップが追加されたメッセージ
詳しくは、メッセージで送信されたテキストの書式を表示するをご覧ください。 |
cards[] |
非推奨: 代わりに UI 要素(書式設定されたテキスト、ボタン、クリック可能な画像など)を表示するために使用できる、情報量が多く書式設定されたインタラクティブなカード。カードは通常、平文メッセージの本文の下に表示されます。 |
cards_v2[] |
cards の配列。 カードを作成できるのは Chat アプリのみです。Chat アプリがユーザーとして認証されている場合、メッセージにカードを含めることはできません。 カードを含むメッセージを作成する方法については、メッセージを送信するをご覧ください。 カードビルダーでカードをデザインしてプレビューする。 カードビルダーを開く |
annotations[] |
出力専用。このメッセージの |
thread |
メールが属するスレッド。使用例については、メッセージ スレッドを開始または返信するをご覧ください。 |
space |
|
fallback_text |
メッセージのカードに関する書式なしテキストの説明。実際のカードを表示できない場合に使用されます(モバイル通知など)。 |
action_response |
入力のみのChat 用アプリが回答の投稿方法を構成するために使用できるパラメータ。 |
argument_text |
出力専用。Chat 用アプリの名前リンクがすべて取り除かれた、書式なしテキスト形式のメッセージ。 |
slash_command |
出力専用。スラッシュ コマンドの情報(該当する場合)。 |
attachment[] |
ユーザーがアップロードした添付ファイル。 |
matched_url |
出力専用。リンク プレビュー パターンに一致する |
thread_reply |
出力専用。 スレッドでの返信がサポートされていないスペースの場合、このフィールドは常に |
client_assigned_message_id |
省略可。メッセージのカスタム ID。フィールドを使用して、メッセージの識別や、メッセージの取得、削除、更新を行うことができます。カスタム ID を設定するには、メッセージの作成時に |
emoji_reaction_summaries[] |
出力専用。メッセージ上の絵文字リアクションの概要のリスト。 |
private_message_viewer |
変更不可。メッセージを作成するための入力。それ以外の場合は出力のみ。メッセージを閲覧できるユーザー。設定すると、メッセージは非公開になり、指定したユーザーと Chat アプリにのみ表示されます。このフィールドをリクエストに含めるには、アプリの認証を使用して Chat API を呼び出し、以下を省略する必要があります。 詳しくは、非公開でメッセージを送信するをご覧ください。 |
deletion_metadata |
出力専用。削除されたメッセージについての情報。 |
quoted_message_metadata |
出力専用。スペースで Google Chat ユーザーが引用したメッセージに関する情報。Google Chat ユーザーは、メッセージを引用して返信することができます。 |
attached_gifs[] |
出力専用。メッセージに添付された GIF 画像。 |
accessory_widgets[] |
メールの下部に表示される、1 つ以上のインタラクティブなウィジェットです。テキスト、カード、またはその両方を含むメッセージにアクセサリ ウィジェットを追加できます。ダイアログを含むメッセージではサポートされていません。詳しくは、メールの下部にインタラクティブなウィジェットを追加するをご覧ください。 アクセサリ ウィジェットでメッセージを作成するには、アプリの認証が必要です。 |
MessageBatchCreatedEventData
複数の新しいメッセージのイベント ペイロード。
イベントタイプ: google.workspace.chat.message.v1.batchCreated
フィールド | |
---|---|
messages[] |
新着メッセージのリスト。 |
MessageBatchDeletedEventData
複数の削除されたメッセージのイベント ペイロード。
イベントタイプ: google.workspace.chat.message.v1.batchDeleted
フィールド | |
---|---|
messages[] |
削除されたメッセージのリスト。 |
MessageBatchUpdatedEventData
更新された複数のメッセージのイベント ペイロード。
イベントタイプ: google.workspace.chat.message.v1.batchUpdated
フィールド | |
---|---|
messages[] |
更新されたメッセージのリスト。 |
MessageCreatedEventData
新しいメッセージのイベント ペイロード。
イベントタイプ: google.workspace.chat.message.v1.created
フィールド | |
---|---|
message |
新しいメッセージ。 |
MessageDeletedEventData
削除されたメッセージのイベント ペイロード。
イベントタイプ: google.workspace.chat.message.v1.deleted
フィールド | |
---|---|
message |
削除されたメッセージ。 |
MessageUpdatedEventData
更新されたメッセージのイベント ペイロード。
イベントタイプ: google.workspace.chat.message.v1.updated
フィールド | |
---|---|
message |
更新されたメッセージ。 |
QuotedMessageMetadata
引用されたメッセージに関する情報。
フィールド | |
---|---|
name |
出力専用。引用されたメッセージのリソース名。 形式: |
last_update_time |
出力専用。引用されたメッセージが作成されたときのタイムスタンプ、または引用されたメッセージが最後に更新されたときのタイムスタンプ。 |
リアクション
メッセージに対するリアクションです。
フィールド | |
---|---|
name |
リアクションのリソース名。 形式: |
user |
出力専用。リアクションを作成したユーザー。 |
emoji |
リアクションで使用される絵文字。 |
ReactionBatchCreatedEventData
複数の新しいリアクションのイベント ペイロード。
イベントタイプ: google.workspace.chat.reaction.v1.batchCreated
フィールド | |
---|---|
reactions[] |
新しいリアクションのリスト。 |
ReactionBatchDeletedEventData
複数の削除されたリアクションのイベント ペイロード。
イベントタイプ: google.workspace.chat.reaction.v1.batchDeleted
フィールド | |
---|---|
reactions[] |
削除されたリアクションのリスト。 |
ReactionCreatedEventData
新しいリアクションのイベント ペイロード。
イベントタイプ: google.workspace.chat.reaction.v1.created
フィールド | |
---|---|
reaction |
新しいリアクション。 |
ReactionDeletedEventData
削除されたリアクションのイベント ペイロード。
タイプ: google.workspace.chat.reaction.v1.deleted
フィールド | |
---|---|
reaction |
削除されたリアクション。 |
RichLinkMetadata
リソースへのリッチリンク。
フィールド | |
---|---|
uri |
このリンクの URI。 |
rich_link_type |
リッチリンクのタイプ。 |
共用体フィールド data 。リンクされたリソースのデータ。data は次のいずれかになります。 |
|
drive_link_data |
ドライブのリンクのデータ。 |
chat_space_link_data |
Chat スペースのリンクのデータ。 |
RichLinkType
リッチリンクのタイプ。今後、他のタイプが追加される可能性があります。
列挙型 | |
---|---|
RICH_LINK_TYPE_UNSPECIFIED |
列挙型のデフォルト値。使用しないでください。 |
DRIVE_FILE |
Google ドライブのリッチリンク タイプ。 |
CHAT_SPACE |
Chat スペースのリッチリンク タイプ。(スペースのスマートチップなど)。 |
SearchSpacesRequest
クエリに基づいてスペースのリストを検索するリクエスト。
フィールド | |
---|---|
use_admin_access |
発信ユーザーは、「Chat とスペースの会話の管理」権限を持つ Google Workspace 管理者である必要があります。
このメソッドは現在、管理者アクセスのみをサポートしているため、このフィールドに使用できるのは |
page_size |
返されるスペースの最大数。サービスが返す値はこれより少ないことがあります。 指定しない場合、最大で 100 個のスペースが返されます。 最大値は 1,000 です。1,000 を超える値を使用すると、自動的に 1,000 に変更されます。 |
page_token |
前回の検索スペース呼び出しから受け取ったトークン。このパラメータを指定すると、後続のページを取得できます。 ページ分割を行う場合、指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。他のパラメータに異なる値を渡すと、予期しない結果が生じる可能性があります。 |
query |
必須。検索クエリ。 次のパラメータを使用して検索できます。
異なるフィールドでは、 同じフィールドのうち、 次のクエリは有効です。
|
order_by |
省略可。スペースのリストの順序。 並べ替え可能な属性は次のとおりです。
有効な順序付けオペレーションの値は次のとおりです。
サポートされている構文は次のとおりです。
|
SearchSpacesResponse
スペースの検索リクエストに対応するスペースのリストを含むレスポンス。
フィールド | |
---|---|
spaces[] |
リクエストされたスペースのページ。 |
next_page_token |
次のページを取得するために使用できるトークン。このフィールドが空の場合、後続のページはありません。 |
total_size |
すべてのページでのクエリに一致するスペースの合計数。結果が 10,000 スペースを超える場合、この値は推定値です。 |
SetUpSpaceRequest
スペースを作成し、指定したユーザーをスペースに追加するためのリクエスト。
フィールド | |
---|---|
space |
必須。 スペースを作成するには、 グループ チャットを作成するには、 人間との 1 対 1 の会話を作成するには、 人間と呼び出し元の Chat アプリの 1 対 1 の会話を作成するには、
|
request_id |
省略可。このリクエストの一意の識別子。ランダムな UUID を使用することをおすすめします。既存のリクエスト ID を指定すると、新しいスペースを作成するのではなく、その ID で作成されたスペースが返されます。同じ Chat アプリから別の認証済みユーザーを含む既存のリクエスト ID を指定すると、エラーが返されます。 |
memberships[] |
省略可。スペースに招待する Google Chat のユーザーまたはグループ。呼び出し元のユーザーは自動的に追加されるため、除外します。 このセットでは現在、(呼び出し元に加えて)最大 20 のメンバーシップが許可されています。 人間のメンバーシップの場合、 Google グループ メンバーシップの場合、
2 つ以上のメンバーシップとともに メンバーシップを 1 つだけ指定し、人間のユーザーが 人間と呼び出し元の Chat アプリの間で 1 対 1 の会話を作成する場合は空にする必要があります( |
SlashCommand
Google Chat でのスラッシュ コマンド。
フィールド | |
---|---|
command_id |
呼び出されたスラッシュ コマンドの ID。 |
SlashCommandMetadata
スラッシュ コマンド(/)のアノテーション メタデータ。
フィールド | |
---|---|
bot |
コマンドが呼び出された Chat アプリ。 |
type |
スラッシュ コマンドのタイプ。 |
command_name |
呼び出されたスラッシュ コマンドの名前。 |
command_id |
呼び出されたスラッシュ コマンドのコマンド ID。 |
triggers_dialog |
スラッシュ コマンドがダイアログ用かどうかを示します。 |
タイプ
列挙型 | |
---|---|
TYPE_UNSPECIFIED |
列挙型のデフォルト値。使用しないでください。 |
ADD |
スペースに Chat 用アプリを追加します。 |
INVOKE |
スペースでスラッシュ コマンドを実行します。 |
スペース
Google Chat のスペース。スペースとは、複数のユーザー間の会話、またはユーザーと Chat アプリ間の 1 対 1 のメッセージのことです。
フィールド | |
---|---|
name |
スペースのリソース名。 形式: ここで、 |
type |
出力専用。非推奨: 代わりに |
space_type |
スペースのタイプ。スペースを作成する場合やスペースのタイプを更新する場合に必須です。他の用途の場合のみ出力。 |
single_user_bot_dm |
省略可。スペースが Chat アプリと 1 人の人間間の DM であるかどうか。 |
threaded |
出力専用。非推奨: 代わりに |
display_name |
スペースの表示名。 ダイレクト メッセージの場合、このフィールドは空になることがあります。 最大 128 文字をサポートします。 |
external_user_allowed |
変更不可。このスペースで、すべての Google Chat ユーザーをメンバーとして許可するかどうかを指定します。Google Workspace 組織でスペースを作成するときに入力します。次の条件でスペースを作成する場合は、このフィールドを省略します。
既存のスペースの場合、このフィールドは出力専用です。 |
space_threading_state |
出力専用。Chat スペースのスレッド状態。 |
space_details |
説明やルールなど、スペースの詳細。 |
space_history_state |
このスペース内のメッセージとスレッドのメッセージ履歴の状態。 |
import_mode |
省略可。Google Workspace へのデータ移行の一環として |
create_time |
省略可。変更不可。Chat で作成されたスペースの場合、スペースの作成時刻。このフィールドは出力専用です。ただし、インポート モードのスペースで使用する場合は除きます。 インポート モードのスペースの場合、元の作成時間を保持するため、このフィールドを、ソースでスペースが作成された時点の過去のタイムスタンプに設定します。
|
last_active_time |
出力専用。スペース内の最後のメッセージのタイムスタンプ。 |
admin_installed |
出力専用。Chat 用アプリを含むダイレクト メッセージ(DM)スペースの場合、そのスペースの作成者が Google Workspace 管理者かどうか。管理者は、組織内のユーザーに代わって Chat 用アプリを使用したダイレクト メッセージをインストールして設定できます。 管理者によるインストールに対応するには、Chat アプリにダイレクト メッセージ機能を実装する必要があります。 |
membership_count |
出力専用。メンバータイプ別にグループ化された参加メンバーシップの数。 |
access_settings |
省略可。スペースのアクセス設定を指定します。 |
space_uri |
出力専用。ユーザーがスペースにアクセスするための URI。 |
共用体フィールド space_permission_settings 。スペースの権限の設定を表します。space_type が SPACE の場合にのみ入力されます。space_permission_settings は次のいずれかになります。 |
|
predefined_permission_settings |
省略可。入力のみのスペースの権限の設定。スペースを作成するための入力。このフィールドが設定されていない場合は、コラボレーション スペースが作成されます。スペースを作成すると、 |
permission_settings |
省略可。スペースを更新するために設定できる正確な権限の設定。スペースを更新するための入力です。それ以外の場合は、出力のみ。スペースの作成には、代わりに |
AccessSettings
スペースのアクセス設定を表します。
フィールド | |
---|---|
access_state |
出力専用。スペースのアクセス状態を示します。 |
audience |
省略可。スペースの検索、スペースへの参加、スペース内のメッセージのプレビューが可能な対象グループのリソース名。未設定のままにした場合、個別に招待されたユーザーまたはスペースに追加されたユーザーまたは Google グループのみがスペースにアクセスできます。詳しくは、対象グループがスペースを検索可能にするをご覧ください。 形式: Google Workspace 組織のデフォルトの対象グループを使用するには、 |
AccessState
スペースのアクセス状態を表します。
列挙型 | |
---|---|
ACCESS_STATE_UNSPECIFIED |
アクセス状態が不明であるか、この API ではサポートされていません。 |
PRIVATE |
他のユーザーまたは Google Workspace 管理者が個別に追加または招待したユーザーまたは Google グループのみが、スペースを見つけてアクセスできます。 |
DISCOVERABLE |
スペースの管理者が、対象グループにスペースへのアクセス権を付与しました。個別にスペースに追加または招待されたユーザーまたは Google グループも、スペースを見つけてアクセスできます。詳しくは、特定のユーザーがスペースを検索可能にするをご覧ください。 |
MembershipCount
フィールド | |
---|---|
joined_direct_human_user_count |
スペースに直接参加した人間のユーザーの数。参加グループのメンバーであるユーザーの数はカウントされません。 |
joined_group_count |
スペースに直接参加したすべてのグループの数。 |
PermissionSetting
スペースの権限の設定を表します。
フィールド | |
---|---|
managers_allowed |
スペースの管理者がこの権限を持っているかどうか。 |
members_allowed |
マネージャー以外のメンバーにこの権限が付与されているかどうか。 |
PermissionSettings
名前付きスペースの権限の設定。スペースの作成時に権限を設定するには、リクエストの PredefinedPermissionSettings
フィールドを指定します。
フィールド | |
---|---|
manage_members_and_groups |
スペースのメンバーとグループを管理するための設定。 |
modify_space_details |
スペースの名前、アバター、説明、ガイドラインを更新するための設定です。 |
toggle_history |
スペースの履歴のオンとオフを切り替えるための設定です。 |
use_at_mention_all |
スペースで @all を使用するための設定。 |
manage_apps |
スペース内のアプリを管理するための設定です。 |
manage_webhooks |
スペースで Webhook を管理するための設定です。 |
post_messages |
出力専用。スペースにメッセージを投稿するための設定です。 |
reply_messages |
スペース内のメッセージに返信するための設定です。 |
PredefinedPermissionSettings
名前付きスペースの作成時に指定できるスペースの権限の設定。今後、その他の設定が追加される可能性があります。名前付きスペースの権限の設定について詳しくは、スペースの詳細をご覧ください。
列挙型 | |
---|---|
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED |
指定なし。使用しないでください。 |
COLLABORATION_SPACE |
このスペースを、すべてのメンバーがメッセージを投稿できるコラボレーション スペースとして設定します。 |
ANNOUNCEMENT_SPACE |
このスペースをお知らせ用スペースにし、スペースの管理者のみがメッセージを投稿できるようにする設定。 |
SpaceDetails
説明やルールなど、スペースの詳細。
フィールド | |
---|---|
description |
省略可。スペースの説明。たとえば、スペースのディスカッション トピック、機能上の目的、参加者について説明してください。 最大 150 文字をサポートします。 |
guidelines |
省略可。スペースのルール、期待値、エチケット。 最大 5,000 文字までサポート。 |
SpaceThreadingState
Chat スペースのスレッド状態の種類を指定します。
列挙型 | |
---|---|
SPACE_THREADING_STATE_UNSPECIFIED |
予約済み。 |
THREADED_MESSAGES |
メッセージのスレッドをサポートする名前付きスペース。ユーザーがメッセージに返信すると、スレッド内で返信できるため、元のメッセージのコンテキストで返信できます。 |
GROUPED_MESSAGES |
会話がトピック別に整理されている名前付きスペース。トピックとその返信はグループ化されます。 |
UNTHREADED_MESSAGES |
2 人間のダイレクト メッセージ(DM)や 3 人以上間のグループ会話 |
SpaceType
スペースのタイプ。スペースを作成または更新する場合は必須です。他の用途の場合のみ出力。
列挙型 | |
---|---|
SPACE_TYPE_UNSPECIFIED |
予約済み。 |
SPACE |
メッセージの送信、ファイルの共有、共同編集を行う場所です。SPACE には Chat 用アプリを含めることができます。 |
GROUP_CHAT |
3 人以上のグループ会話GROUP_CHAT には Chat 用アプリを含めることができます。 |
DIRECT_MESSAGE |
2 人、または人間と Chat アプリの 1 対 1 のメッセージ。 |
タイプ
非推奨: 代わりに SpaceType
を使用してください。
列挙型 | |
---|---|
TYPE_UNSPECIFIED |
予約済み。 |
ROOM |
人間同士の会話。 |
DM |
人間と Chat アプリ間の 1 対 1 のダイレクト メッセージ。すべてのメッセージがフラットで処理されます。なお、これには 2 人の人間間のダイレクト メッセージは含まれません。 |
SpaceBatchUpdatedEventData
スペースに対する複数の更新のイベント ペイロード。
イベントタイプ: google.workspace.chat.space.v1.batchUpdated
フィールド | |
---|---|
spaces[] |
更新されたスペースのリスト。 |
SpaceEvent
Google Chat スペースでの変更またはアクティビティを表すイベント。詳しくは、Google Chat からの予定を管理するをご覧ください。
フィールド | |
---|---|
name |
スペース イベントのリソース名。 形式: |
event_time |
イベントが発生した時刻。 |
event_type |
スペースのイベントの種類。各イベントタイプにはバッチ バージョンがあります。これは、短期間に発生するイベントタイプの複数のインスタンスを表します。 メッセージでサポートされるイベントタイプ:
メンバーシップでサポートされているイベントタイプ:
リアクションでサポートされているアクティビティの種類:
Space についてサポートされているイベントタイプ:
|
共用体フィールド
|
|
message_created_event_data |
新しいメッセージのイベント ペイロード。 イベントタイプ: |
message_updated_event_data |
更新されたメッセージのイベント ペイロード。 イベントタイプ: |
message_deleted_event_data |
削除されたメッセージのイベント ペイロード。 イベントタイプ: |
message_batch_created_event_data |
複数の新しいメッセージのイベント ペイロード。 イベントタイプ: |
message_batch_updated_event_data |
更新された複数のメッセージのイベント ペイロード。 イベントタイプ: |
message_batch_deleted_event_data |
複数の削除されたメッセージのイベント ペイロード。 イベントタイプ: |
space_updated_event_data |
スペース更新のイベント ペイロード。 イベントタイプ: |
space_batch_updated_event_data |
スペースに対する複数の更新のイベント ペイロード。 イベントタイプ: |
membership_created_event_data |
新しいメンバーシップのイベント ペイロード。 イベントタイプ: |
membership_updated_event_data |
更新されたメンバーシップのイベント ペイロード。 イベントタイプ: |
membership_deleted_event_data |
削除されたメンバーシップのイベント ペイロード。 イベントタイプ: |
membership_batch_created_event_data |
複数の新しいメンバーシップのイベント ペイロード。 イベントタイプ: |
membership_batch_updated_event_data |
更新された複数のメンバーシップのイベント ペイロード。 イベントタイプ: |
membership_batch_deleted_event_data |
複数の削除されたメンバーシップのイベント ペイロード。 イベントタイプ: |
reaction_created_event_data |
新しいリアクションのイベント ペイロード。 イベントタイプ: |
reaction_deleted_event_data |
削除されたリアクションのイベント ペイロード。 イベントタイプ: |
reaction_batch_created_event_data |
複数の新しいリアクションのイベント ペイロード。 イベントタイプ: |
reaction_batch_deleted_event_data |
複数の削除されたリアクションのイベント ペイロード。 イベントタイプ: |
SpaceReadState
スペース内でのユーザーの既読状態。既読メッセージと未読メッセージを識別するために使用されます。
フィールド | |
---|---|
name |
スペースの読み取り状態のリソース名。 形式: |
last_read_time |
省略可。ユーザーのスペース読み取り状態が更新された時刻。通常これは、最後に読み取られたメッセージのタイムスタンプか、スペース内の最後の既読位置をマークするためにユーザーが指定したタイムスタンプのいずれかに対応します。 |
SpaceUpdatedEventData
更新されたスペースのイベント ペイロード。
イベントタイプ: google.workspace.chat.space.v1.updated
フィールド | |
---|---|
space |
更新されたスペース。 |
スレッド
Google Chat スペース内のスレッド。使用例については、メッセージ スレッドを開始または返信するをご覧ください。
メッセージの作成時にスレッドを指定した場合は、messageReplyOption
フィールドを設定して、一致するスレッドが見つからない場合の処理を指定できます。
フィールド | |
---|---|
name |
スレッドのリソース名。 例: |
thread_key |
省略可。スレッドを作成または更新するための入力。それ以外の場合は、出力のみ。スレッドの ID。最大 4,000 文字をサポートします。 この ID は、設定元の Chat アプリに固有のものです。たとえば、複数の Chat アプリが同じスレッドキーを使用して 1 つのメッセージを作成した場合、それらのメッセージは別々のスレッドに投稿されます。ユーザーまたは他の Chat アプリによって作成されたスレッドで返信するには、代わりにスレッドの |
ThreadReadState
スレッド内のユーザーの既読状態。既読メールと未読メールを区別するために使用されます。
フィールド | |
---|---|
name |
スレッド読み取り状態のリソース名。 形式: |
last_read_time |
ユーザーのスレッド読み取り状態が更新された時刻。通常、これはスレッドで最後に読まれたメッセージのタイムスタンプに対応します。 |
UpdateMembershipRequest
メンバーシップを更新するためのリクエスト メッセージ。
フィールド | |
---|---|
membership |
必須。更新するメンバーシップ。 |
update_mask |
必須。更新するフィールドパス。複数の値をカンマで区切るか、 現在サポートされているフィールドパス:
|
use_admin_access |
true の場合、メソッドはユーザーの Google Workspace 管理者権限を使用して実行されます。発信ユーザーは、「Chat とスペースの会話の管理」権限を持つ Google Workspace 管理者である必要があります。
|
UpdateMessageRequest
メッセージの更新をリクエストします。
フィールド | |
---|---|
message |
必須。フィールドを更新したメッセージ。 |
update_mask |
必須。更新するフィールドパス。複数の値をカンマで区切るか、 現在サポートされているフィールドパス: |
allow_missing |
省略可。 |
UpdateSpaceReadStateRequest
UpdateSpaceReadState API に対するリクエスト メッセージ。
フィールド | |
---|---|
space_read_state |
必須。スペースの読み取り状態と更新するフィールド。 呼び出し元ユーザーの読み取り状態の更新のみをサポートします。 呼び出し元のユーザーを参照するには、次のいずれかを設定します。
形式: users/{user}/spaces/{space}/spaceReadState |
update_mask |
必須。更新するフィールドパス。現在サポートされているフィールドパス:
スペースを既読にするには、 |
UpdateSpaceRequest
1 つのスペースを更新するためのリクエスト。
フィールド | |
---|---|
space |
必須。更新するフィールドがあるスペース。 |
update_mask |
必須。更新されたフィールドパス。複数ある場合はカンマで区切って指定します。 スペースの次のフィールドを更新できます。
|
use_admin_access |
true の場合、メソッドはユーザーの Google Workspace 管理者権限を使用して実行されます。発信ユーザーは、「Chat とスペースの会話の管理」権限を持つ Google Workspace 管理者である必要があります。
一部の |
ユーザー
Google Chat のユーザー。リクエストから出力として返されたときに、Chat アプリがユーザーとして認証されている場合、User
リソースの出力はユーザーの name
と type
にのみ入力されます。
フィールド | |
---|---|
name |
Google Chat 形式:
|
display_name |
出力専用。ユーザーの表示名。 |
domain_id |
ユーザーの Google Workspace ドメインの一意の識別子。 |
type |
ユーザータイプ。 |
is_anonymous |
出力専用。 |
タイプ
列挙型 | |
---|---|
TYPE_UNSPECIFIED |
列挙型のデフォルト値。使用しないでください。 |
HUMAN |
人間のユーザー。 |
BOT |
Chat アプリのユーザー。 |
UserMentionMetadata
ユーザーのメンション(@)のアノテーション メタデータ。
フィールド | |
---|---|
user |
お客様が言及した。 |
type |
ユーザーのメンションのタイプ。 |
タイプ
列挙型 | |
---|---|
TYPE_UNSPECIFIED |
列挙型のデフォルト値。使用しないでください。 |
ADD |
ユーザーをスペースに追加します。 |
MENTION |
スペースでユーザーにメンションします。 |
WidgetMarkup
ウィジェットは、テキストと画像を表示する UI 要素です。
フィールド | |
---|---|
buttons[] |
ボタンのリスト。ボタンも |
共用体フィールド data 。WidgetMarkup に指定できるのは、以下のアイテムのうち 1 つのみです。複数の WidgetMarkup フィールドを使用すると、より多くのアイテムを表示できます。data は次のいずれかになります。 |
|
text_paragraph |
このウィジェットに段落テキストを表示します。 |
image |
このウィジェットに画像を表示します。 |
key_value |
このウィジェットに Key-Value アイテムを表示します。 |
ボタン
ボタン。テキストボタンまたは画像ボタンです。
フィールド | |
---|---|
共用体フィールド
|
|
text_button |
テキストと |
image_button |
画像と |
FormAction
フォームのアクションは、フォームが送信されたときの動作を記述します。たとえば、Apps Script を呼び出してフォームを処理できます。
フィールド | |
---|---|
action_method_name |
メソッド名は、フォームの送信をトリガーしたフォームのどの部分かを識別するために使用されます。この情報は、カードクリック イベントの一部として Chat アプリにエコーバックされます。共通の動作をトリガーする複数の要素に同じメソッド名を使用できます。 |
parameters[] |
アクション パラメータのリスト。 |
ActionParameter
アクション メソッドが呼び出されたときに指定する文字列パラメータのリスト。例えば、今すぐスヌーズ、1 日スヌーズ、来週スヌーズの 3 つのスヌーズボタンを考えてみましょう。action method = snooze()
を使用して、文字列パラメータのリストでスヌーズの種類とスヌーズ時間を渡します。
フィールド | |
---|---|
key |
アクション スクリプトのパラメータの名前。 |
value |
パラメータの値。 |
アイコン
サポートされているアイコンのセット。
列挙型 | |
---|---|
ICON_UNSPECIFIED |
|
AIRPLANE |
|
BOOKMARK |
|
BUS |
|
CAR |
|
CLOCK |
|
CONFIRMATION_NUMBER_ICON |
|
DOLLAR |
|
DESCRIPTION |
|
EMAIL |
|
EVENT_PERFORMER |
|
EVENT_SEAT |
|
FLIGHT_ARRIVAL |
|
FLIGHT_DEPARTURE |
|
HOTEL |
|
HOTEL_ROOM_TYPE |
|
INVITE |
|
MAP_PIN |
|
MEMBERSHIP |
|
MULTIPLE_PEOPLE |
|
OFFER |
|
PERSON |
|
PHONE |
|
RESTAURANT_ICON |
|
SHOPPING_CART |
|
STAR |
|
STORE |
|
TICKET |
|
TRAIN |
|
VIDEO_CAMERA |
|
VIDEO_PLAY |
画像
URL で指定され、onclick
アクションを持つ画像。
フィールド | |
---|---|
image_url |
画像の URL です。 |
on_click |
|
aspect_ratio |
この画像のアスペクト比(幅と高さ)。このフィールドを使用すると、画像の読み込みを待っている間に画像の高さを適切に予約できます。画像に組み込まれているアスペクト比をオーバーライドするためのものではありません。未設定の場合、サーバーは画像をプリフェッチして埋めます。 |
ImageButton
onclick
アクションを含む画像ボタン。
フィールド | |
---|---|
on_click |
|
name |
ユーザー補助に使用されるこの |
共用体フィールド icons 。アイコンは、Icon enum または URL で指定できます。icons は次のいずれかになります。 |
|
icon |
|
icon_url |
URL で指定されたアイコン。 |
KeyValue
UI 要素には、キー(ラベル)と値(コンテンツ)が含まれます。この要素には、onclick
ボタンなどのアクションも含めることができます。
フィールド | |
---|---|
top_label |
上部ラベルのテキスト。書式設定されたテキストがサポートされています。テキストの書式設定について詳しくは、Google Chat アプリでのテキストの書式設定と Google Workspace アドオンでのテキストの書式設定をご覧ください。 |
content |
コンテンツのテキスト。書式設定されたテキストがサポートされており、常に必須です。テキストの書式設定について詳しくは、Google Chat アプリでのテキストの書式設定と Google Workspace アドオンでのテキストの書式設定をご覧ください。 |
content_multiline |
コンテンツが複数行になるかどうか。 |
bottom_label |
下部のラベルのテキスト。書式設定されたテキストがサポートされています。テキストの書式設定について詳しくは、Google Chat アプリでのテキストの書式設定と Google Workspace アドオンでのテキストの書式設定をご覧ください。 |
on_click |
|
共用体フィールド icons 。アイコン top_label と bottom_label のうち少なくとも 1 つを定義する必要があります。icons は次のいずれかになります。 |
|
icon |
Chat API によって対応するアイコン画像に置き換えられる列挙値。 |
icon_url |
URL で指定されたアイコン。 |
共用体フィールド control 。コントロール ウィジェット。button または switch_widget は、いずれか 1 つを設定できます。両方を設定することはできません。control は次のいずれかになります。 |
|
button |
クリックしてアクションをトリガーできるボタン。 |
OnClick
onclick
アクション(リンクを開くなど)。
フィールド | |
---|---|
共用体フィールド
|
|
action |
|
open_link |
この |
OpenLink
新しいウィンドウを開くリンク。
フィールド | |
---|---|
url |
開く URL。 |
TextButton
テキストと onclick
アクションを含むボタン。
フィールド | |
---|---|
text |
ボタンのテキスト。 |
on_click |
ボタンの |
TextParagraph
テキストの段落。書式設定されたテキストがサポートされています。テキストの書式設定について詳しくは、Google Chat アプリでのテキストの書式設定と Google Workspace アドオンでのテキストの書式設定をご覧ください。
フィールド | |
---|---|
text |
|