インデックス
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
(メッセージ)CreateCustomEmojiRequest
(メッセージ)CreateMembershipRequest
(メッセージ)CreateMessageRequest
(メッセージ)CreateMessageRequest.MessageReplyOption
(列挙型)CreateReactionRequest
(メッセージ)CreateSpaceRequest
(メッセージ)CustomEmoji
(メッセージ)CustomEmoji.CustomEmojiPayload
(メッセージ)DeleteCustomEmojiRequest
(メッセージ)DeleteMembershipRequest
(メッセージ)DeleteMessageRequest
(メッセージ)DeleteReactionRequest
(メッセージ)DeleteSpaceRequest
(メッセージ)DeletionMetadata
(メッセージ)DeletionMetadata.DeletionType
(列挙型)Dialog
(メッセージ)DialogAction
(メッセージ)DriveDataRef
(メッセージ)DriveLinkData
(メッセージ)Emoji
(メッセージ)EmojiReactionSummary
(メッセージ)FindDirectMessageRequest
(メッセージ)GetAttachmentRequest
(メッセージ)GetCustomEmojiRequest
(メッセージ)GetMembershipRequest
(メッセージ)GetMessageRequest
(メッセージ)GetSpaceEventRequest
(メッセージ)GetSpaceNotificationSettingRequest
(メッセージ)GetSpaceReadStateRequest
(メッセージ)GetSpaceRequest
(メッセージ)GetThreadReadStateRequest
(メッセージ)Group
(メッセージ)HistoryState
(列挙型)ListCustomEmojisRequest
(メッセージ)ListCustomEmojisResponse
(メッセージ)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
(メッセージ)SpaceNotificationSetting
(メッセージ)SpaceNotificationSetting.MuteSetting
(列挙型)SpaceNotificationSetting.NotificationSetting
(列挙型)SpaceReadState
(メッセージ)SpaceUpdatedEventData
(メッセージ)Thread
(メッセージ)ThreadReadState
(メッセージ)UpdateMembershipRequest
(メッセージ)UpdateMessageRequest
(メッセージ)UpdateSpaceNotificationSettingRequest
(メッセージ)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 Platform で Chat アプリと統合を構築できるようにします。
CompleteImportSpace |
---|
指定したスペースのインポート プロセスが完了し、ユーザーに表示されます。 アプリ認証とドメイン全体の委任が必要です。詳細については、Google Chat アプリにデータのインポートを許可するをご覧ください。
|
CreateCustomEmoji |
---|
ユーザー認証が必要です。
|
CreateMembership |
---|
呼び出し元の Chat アプリ、ユーザー、Google グループのメンバーシップを作成します。他の Chat アプリのメンバーシップの作成はサポートされていません。メンバーシップを作成するときに、指定したメンバーの自動承認ポリシーがオフになっている場合、そのメンバーは招待された後、スペースへの招待を承諾してから参加する必要があります。それ以外の場合は、メンバーシップを作成すると、指定したスペースにメンバーが直接追加されます。 次のタイプの認証をサポートしています。
使用例については、以下をご覧ください。
|
CreateMessage |
---|
Google Chat スペースにメッセージを作成します。例については、メッセージを送信するをご覧ください。
次の図は、アプリ認証を使用する場合に Chat がメッセージをどのように属性付けるかを示しています。Chat には、メッセージの送信者として Chat アプリが表示されます。メッセージのコンテンツには、テキスト( 次の図は、ユーザー認証を使用した場合に Chat がメッセージをどのように属性付けるかを示しています。Chat では、ユーザーがメッセージの送信者として表示され、Chat アプリの名前を表示することでメッセージに関連付けられます。メッセージの内容にはテキスト( メッセージの内容を含むメッセージの最大サイズは 32,000 バイトです。
|
CreateReaction |
---|
リアクションを作成してメッセージに追加します。サポートされているのは Unicode 絵文字のみです。例については、メッセージにリアクションを追加するをご覧ください。 ユーザー認証が必要です。
|
CreateSpace |
---|
スペースを作成します。 次のタイプの認証をサポートしています。 アプリとして認証する場合は、リクエストで 作成時のスペースの参加資格は、スペースが
スペースの作成時にエラー メッセージ
|
DeleteCustomEmoji |
---|
ユーザー認証が必要です。
|
DeleteMembership |
---|
メンバーシップを削除します。例については、スペースからユーザーまたは Google Chat アプリを削除するをご覧ください。 次のタイプの認証をサポートしています。
|
DeleteMessage |
---|
メッセージを削除します。例については、メッセージを削除するをご覧ください。 次のタイプの認証をサポートしています。 アプリ認証を使用する場合、リクエストで削除できるのは、呼び出し元の Chat アプリによって作成されたメッセージのみです。
|
DeleteReaction |
---|
メッセージに対するリアクションを削除します。サポートされているのは Unicode 絵文字のみです。例については、リアクションを削除するをご覧ください。 ユーザー認証が必要です。
|
DeleteSpace |
---|
名前付きスペースを削除します。常にカスケード削除を実行します。つまり、スペースの子リソース(スペースに投稿されたメッセージやスペースのメンバーシップなど)も削除されます。例については、Space を削除するをご覧ください。 次のタイプの認証をサポートしています。
|
FindDirectMessage |
---|
指定されたユーザーとの既存のダイレクト メッセージを返します。直接メッセージ スペースが見つからない場合、 アプリ認証では、指定したユーザーと呼び出し元の Chat アプリ間のダイレクト メッセージ スペースを返します。 ユーザー認証では、指定したユーザーと認証されたユーザー間の直接メッセージ空間を返します。 // 次のタイプの認証をサポートしています。
|
GetAttachment |
---|
メッセージの添付ファイルのメタデータを取得します。添付ファイルのデータは media API を使用して取得されます。例については、メッセージの添付ファイルに関するメタデータを取得するをご覧ください。アプリ認証が必要です。
|
GetCustomEmoji |
---|
ユーザー認証が必要です。
|
GetMembership |
---|
メンバーシップの詳細を返します。例については、ユーザーまたは Google Chat アプリのメンバーシップの詳細を取得するをご覧ください。 次のタイプの認証をサポートしています。
|
GetMessage |
---|
メッセージの詳細を返します。例については、メッセージの詳細を取得するをご覧ください。 次のタイプの認証をサポートしています。 注: ブロックしたメンバーまたはスペースからのメッセージが返されることがあります。
|
GetSpace |
---|
スペースの詳細を返します。例については、スペースの詳細を取得するをご覧ください。 次のタイプの認証をサポートしています。
|
GetSpaceEvent |
---|
Google Chat スペースのイベントを返します。イベント ペイロードには、変更されたリソースの最新バージョンが含まれています。たとえば、新しいメッセージに関するイベントをリクエストした後でメッセージが更新された場合、サーバーはイベント ペイロードで更新された 注: このリクエストの Space イベントデータの Space オブジェクトには、 ユーザー認証が必要です。イベントを取得するには、認証されたユーザーがスペースのメンバーである必要があります。 例については、Google Chat スペースからイベントの詳細を取得するをご覧ください。
|
GetSpaceNotificationSetting |
---|
ユーザー認証が必要です。
|
GetSpaceReadState |
---|
スペース内のユーザーの既読ステータスの詳細を返します。未読と既読のメッセージを識別するために使用されます。例については、ユーザーのスペースの読み取り状態の詳細を取得するをご覧ください。 ユーザー認証が必要です。
|
GetThreadReadState |
---|
スレッド内のユーザーの未読ステータスの詳細を返します。未読と既読のメッセージを識別するために使用されます。例については、ユーザーのスレッドの読み取りステータスの詳細を取得するをご覧ください。 ユーザー認証が必要です。
|
ListCustomEmojis |
---|
ユーザー認証が必要です。
|
ListMemberships |
---|
スペース内のメンバーシップを一覧表示します。例については、スペース内のユーザーと Google Chat アプリを一覧表示するをご覧ください。アプリ認証でメンバーシップを一覧表示すると、Chat アプリがアクセスできるスペースのメンバーシップが一覧表示されます。ただし、Chat アプリのメンバーシップ(自身を含む)は除外されます。[ユーザー認証] でメンバーシップを一覧表示すると、認証されたユーザーがアクセスできるスペースのメンバーシップが一覧表示されます。 次のタイプの認証をサポートしています。
|
ListMessages |
---|
呼び出し元がメンバーであるスペース内のメッセージ(ブロックされたメンバーやスペースからのメッセージを含む)を一覧表示します。メッセージのないスペースのメッセージを一覧表示すると、レスポンスは空のオブジェクトになります。REST/HTTP インターフェースを使用している場合、レスポンスには空の JSON オブジェクト ユーザー認証が必要です。
|
ListReactions |
---|
メッセージに対するリアクションを一覧表示します。例については、メッセージのリアクションを一覧表示するをご覧ください。 ユーザー認証が必要です。
|
ListSpaceEvents |
---|
Google Chat スペースのイベントを一覧表示します。イベントごとに、ペイロードには最新バージョンの Chat リソースが含まれます。たとえば、新しいスペース メンバーに関するイベントをリストすると、最新のメンバーの詳細を含む ユーザー認証が必要です。イベントを一覧表示するには、認証済みユーザーがスペースのメンバーである必要があります。 例については、Google Chat スペースのイベントを一覧表示するをご覧ください。
|
ListSpaces |
---|
呼び出し元がメンバーになっているスペースを一覧表示します。グループ チャットと DM は、最初のメッセージが送信されるまで一覧に表示されません。例については、スペースを一覧表示するをご覧ください。 次のタイプの認証をサポートしています。 Google Workspace 組織のすべての名前付きスペースを一覧表示するには、代わりに Workspace 管理者権限を使用して
|
SearchSpaces |
---|
管理者の検索に基づいて、Google Workspace 組織内のスペースのリストを返します。 管理者権限を持つユーザー認証が必要です。リクエストでは、
|
SetUpSpace |
---|
スペースを作成し、指定したユーザーを追加します。呼び出し元のユーザーはスペースに自動的に追加されるため、リクエストでメンバーシップとして指定する必要はありません。例については、初期メンバーを含むスペースを設定するをご覧ください。 追加するユーザー メンバーを指定する場合は、適切な 追加する Google グループを指定するには、適切な 名前付きスペースまたはグループ チャットの場合、呼び出し元が一部のメンバーをブロックしている、または一部のメンバーからブロックされている、または一部のメンバーを追加する権限がない場合は、それらのメンバーは作成されたスペースに追加されません。 呼び出し元のユーザーと別の人間ユーザーとの間でダイレクト メッセージ(DM)を作成するには、人間ユーザーを表すメンバーシップを 1 つだけ指定します。一方のユーザーがもう一方のユーザーをブロックしている場合、リクエストは失敗し、DM は作成されません。 呼び出し元のユーザーと呼び出し元のアプリの間に DM を作成するには、 2 人のユーザー間にすでに DM が存在する場合、リクエスト時に一方のユーザーがもう一方をブロックしても、既存の DM が返されます。 スレッド形式の返信を含むスペースはサポートされていません。スペースの設定時にエラー メッセージ ユーザー認証が必要です。
|
UpdateMembership |
---|
メンバーシップを更新します。例については、スペース内のユーザーのメンバーシップを更新するをご覧ください。 次のタイプの認証をサポートしています。
|
UpdateMessage |
---|
メッセージを更新します。 次のタイプの認証をサポートしています。 アプリ認証を使用する場合、リクエストで更新できるのは、呼び出し元の Chat アプリによって作成されたメッセージのみです。
|
UpdateSpace |
---|
スペースを更新します。例については、スペースを更新するをご覧ください。
次のタイプの認証をサポートしています。
|
UpdateSpaceNotificationSetting |
---|
ユーザー認証が必要です。
|
UpdateSpaceReadState |
---|
スペース内のユーザーの既読ステータスを更新します。これは、既読と未読のメッセージを識別するために使用されます。例については、ユーザーのスペースの読み取り状態を更新するをご覧ください。 ユーザー認証が必要です。
|
AccessoryWidget
メッセージの下部に表示される 1 つ以上のインタラクティブ ウィジェット。詳しくは、メッセージの下部にインタラクティブなウィジェットを追加するをご覧ください。
フィールド | |
---|---|
共用体フィールド action 。アクションの種類。action は次のいずれかになります。 |
|
button_ |
ボタンのリスト。 |
ActionResponse
Chat アプリがレスポンスの投稿方法を構成するために使用できるパラメータ。
フィールド | |
---|---|
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 |
ウィジェットのテキスト オートコンプリート オプションのクエリ。 |
SelectionItems
ウィジェットの予測入力結果のリスト。
フィールド | |
---|---|
items[] |
SelectionItem オブジェクトの配列。 |
UpdatedWidget
更新されたウィジェットのレスポンス。ウィジェットの予測入力オプションを提供するために使用されます。
フィールド | |
---|---|
widget |
更新されたウィジェットの ID。ID は、更新リクエストをトリガーしたウィジェットの ID と一致している必要があります。 |
共用体フィールド updated_widget 。ユーザーの操作に応じて更新されたウィジェット。updated_widget は次のいずれかになります。 |
|
suggestions |
ウィジェット オートコンプリートの結果のリスト |
ActionStatus
ダイアログを呼び出すか送信するリクエストのステータスを表します。
フィールド | |
---|---|
status_ |
ステータス コード。 |
user_ |
リクエストのステータスに関するメッセージをユーザーに送信します。設定されていない場合、 |
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_ |
このアノテーションが対応するプレーンテキスト メッセージ本文の開始インデックス(0 から始まる番号、両端を含む)。 |
共用体フィールド metadata 。アノテーションに関する追加のメタデータ。metadata は次のいずれかになります。 |
|
user_ |
ユーザーのメンションのメタデータ。 |
slash_ |
スラッシュ コマンドのメタデータ。 |
rich_ |
リッチリンクのメタデータ。 |
AnnotationType
アノテーションの型。
列挙型 | |
---|---|
ANNOTATION_TYPE_UNSPECIFIED |
列挙型のデフォルト値。使用しないでください。 |
USER_MENTION |
ユーザーがメンションされている。 |
SLASH_COMMAND |
スラッシュ コマンドが呼び出されます。 |
RICH_LINK |
リッチリンク アノテーション。 |
AttachedGif
URL で指定された GIF 画像。
フィールド | |
---|---|
uri |
出力専用。GIF 画像をホストする URL。 |
添付ファイル
Google Chat の添付ファイル。
フィールド | |
---|---|
name |
省略可。アタッチメントのリソース名( |
content_ |
出力専用。コンテンツの元のファイル名(フルパスではない)。 |
content_ |
出力専用。ファイルのコンテンツ タイプ(MIME タイプ)。 |
thumbnail_ |
出力専用。人間のユーザーに添付ファイルをプレビューするために使用するサムネイル URL。チャットアプリでは、この URL を使用して添付コンテンツをダウンロードしないでください。 |
download_ |
出力専用。人間のユーザーが添付ファイルをダウンロードできるようにするために使用するダウンロード URL。チャットアプリでは、この URL を使用して添付コンテンツをダウンロードしないでください。 |
source |
出力専用。添付ファイルのソース。 |
共用体フィールド data_ref 。添付ファイルを参照するデータ。data_ref は次のいずれかになります。 |
|
attachment_ |
省略可。添付データへの参照。このフィールドは、添付ファイルを含むメッセージを作成または更新する場合、または media API を使用して添付ファイルのデータをダウンロードする場合に使用します。 |
drive_ |
出力専用。Google ドライブの添付ファイルへの参照。このフィールドは Google Drive API で使用されます。 |
ソース
添付ファイルのソース。
列挙型 | |
---|---|
SOURCE_UNSPECIFIED |
予約済み。 |
DRIVE_FILE |
ファイルが Google ドライブ ファイルである。 |
UPLOADED_CONTENT |
ファイルが Chat にアップロードされます。 |
AttachmentDataRef
添付データへの参照。
フィールド | |
---|---|
resource_ |
省略可。添付データのリソース名。このフィールドは、media API で添付データのダウンロードに使用されます。 |
attachment_ |
省略可。アップロードされた添付ファイルへの参照を含む不透明なトークン。クライアントでは不透明な文字列として扱われ、添付ファイルを含む Chat メッセージの作成または更新に使用されます。 |
CardWithId
Google Chat メッセージのカード。
カードを作成できるのは Chat アプリのみです。チャットアプリがユーザーとして認証されている場合、メッセージにカードを含めることはできません。
カードビルダーを使用してカードをデザインし、プレビューします。
カードビルダーを開くフィールド | |
---|---|
card_ |
メッセージに複数のカードが含まれている場合は必須です。メッセージ内のカードの一意の識別子。 |
card |
カード。最大サイズは 32 KB です。 |
ChatSpaceLinkData
Chat スペースのリンクのデータ。
フィールド | |
---|---|
space |
リンクされた Chat スペース リソースのスペース。 形式: |
thread |
リンクされた Chat スペース リソースのスレッド。 形式: |
message |
リンクされた Chat スペース リソースのメッセージ。 形式: |
CompleteImportSpaceRequest
スペースのインポート プロセスを完了するためのリクエスト メッセージ。
フィールド | |
---|---|
name |
必須。インポート モードのスペースのリソース名。 形式: |
CompleteImportSpaceResponse
スペースのインポート プロセスが完了したことを示すレスポンス メッセージ。
フィールド | |
---|---|
space |
インポート モードのスペース。 |
ContextualAddOnMarkup
この型にはフィールドがありません。
コンテキスト アドオンのコンテンツを指定するデベロッパー向けのマークアップ。
カード
カードは、テキストや画像などの UI ウィジェットを含めることができる UI 要素です。
フィールド | |
---|---|
header |
カードのヘッダー。ヘッダーには通常、タイトルと画像が含まれます。 |
sections[] |
セクションは線で区切ります。 |
card_ |
このカードのアクション。 |
name |
カードの名前。 |
CardAction
カードアクションは、カードに関連付けられたアクションです。請求書カードの場合、一般的なアクションは、請求書の削除、請求書のメール送信、ブラウザでの請求書の開くなどです。
Google Chat アプリではサポートされていません。
フィールド | |
---|---|
action_ |
アクション メニュー項目に表示されていたラベル。 |
on_ |
このアクション アイテムの onclick アクション。 |
CardHeader
フィールド | |
---|---|
title |
タイトルを指定する必要があります。ヘッダーの高さは固定です。タイトルとサブタイトルの両方が指定されている場合、それぞれ 1 行を占有します。タイトルのみを指定した場合、タイトルは両方の行に表示されます。 |
subtitle |
カード ヘッダーのサブタイトル。 |
image_ |
画像の種類(正方形の枠線、円形の枠線など)。 |
image_ |
カード ヘッダーの画像の URL。 |
ImageStyle
列挙型 | |
---|---|
IMAGE_STYLE_UNSPECIFIED |
|
IMAGE |
正方形の枠線。 |
AVATAR |
円形の枠線。 |
セクション
セクションには、指定された順序で(垂直方向に)レンダリングされるウィジェットのコレクションが含まれています。すべてのプラットフォームでカードの幅は狭く固定されているため、現在のところ、レイアウト プロパティ(float など)は必要ありません。
フィールド | |
---|---|
header |
セクションのヘッダー。書式設定されたテキストがサポートされています。テキストの書式設定の詳細については、Google Chat アプリでのテキストの書式設定と Google Workspace アドオンでのテキストの書式設定をご覧ください。 |
widgets[] |
セクションには、少なくとも 1 つのウィジェットを含める必要があります。 |
CreateCustomEmojiRequest
カスタム絵文字を作成するリクエスト。
フィールド | |
---|---|
custom_ |
必須。作成するカスタム絵文字。 |
CreateMembershipRequest
メンバーシップの作成リクエスト メッセージ。
フィールド | |
---|---|
parent |
必須。メンバーシップを作成する Space のリソース名。 形式: spaces/{space} |
membership |
必須。作成するメンバーシップ リレーション。
Chat アプリが人間のユーザーのメンバーシップ関係を作成する場合は、特定の認可スコープを使用し、特定のフィールドに特定の値を設定する必要があります。
スペースを所有する Workspace 組織外のユーザーを招待するには、ユーザー認証が必要です。 Chat アプリが自身のメンバーシップ関係を作成する場合は、ユーザーとして認証し、 |
use_ |
省略可。 呼び出し元のユーザーは、Chat とスペースの会話の管理権限を持つ Google Workspace 管理者である必要があります。
管理者の Google Workspace 組織外のユーザーのアプリ メンバーシップやメンバーシップの作成は、管理者権限を使用してサポートされていません。 |
CreateMessageRequest
メッセージを作成します。
フィールド | |
---|---|
parent |
必須。メッセージを作成するスペースのリソース名。 形式: |
message |
必須。メッセージ本文。 |
thread_key |
省略可。非推奨: 代わりに |
request_ |
省略可。このメッセージの一意のリクエスト ID。既存のリクエスト ID を指定すると、新しいメッセージが作成されるのではなく、その ID で作成されたメッセージが返されます。 |
message_ |
省略可。メッセージがスレッドを開始するか、スレッドに返信するかを指定します。名前付きスペースでのみサポートされます。 ユーザー操作に応答する場合、このフィールドは無視されます。スレッド内のやり取りの場合、返信は同じスレッド内に作成されます。それ以外の場合は、返信が新しいスレッドとして作成されます。 |
message_ |
省略可。メッセージのカスタム 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_ |
省略可。このリクエストの一意の識別子。ランダムな UUID を使用することをおすすめします。既存のリクエスト ID を指定すると、新しいスペースが作成されるのではなく、その ID で作成されたスペースが返されます。同じ Chat アプリの既存のリクエスト ID を指定して、認証済みのユーザーが異なると、エラーが返されます。 |
CustomEmoji
カスタム絵文字を表します。
フィールド | |
---|---|
name |
ID。サーバーが割り当てたカスタム絵文字のリソース名。 形式: |
uid |
出力専用。カスタム絵文字リソースの一意のキー。 |
emoji_ |
省略可。変更不可。カスタム絵文字にユーザーが指定した名前。組織内で一意にする必要があります。 カスタム絵文字を作成する場合は必須ですが、それ以外の場合は出力専用です。 絵文字名は先頭と末尾にコロンを配置し、小文字で入力する必要があります。また、英数字、ハイフン、アンダースコアのみを使用できます。なお、ハイフンとアンダースコアは単語を区切る目的にのみ使用してください。これらを連続して使用することはできません。 例: |
temporary_ |
出力専用。カスタム 絵文字の画像 URL(有効期間は 10 分以上)。カスタム絵文字の作成時にレスポンスに入力されないことに注意してください。 |
payload |
省略可。入力のみのペイロード データ。カスタム絵文字を作成する場合に必要です。 |
CustomEmojiPayload
カスタム絵文字のペイロード データ。
フィールド | |
---|---|
file_ |
必須。入力のみのカスタム絵文字に使用する画像。 ペイロードは 256 KB 未満で、画像のサイズは 64 ~ 500 ピクセルの範囲で指定する必要があります。制限は変更される可能性があります。 |
filename |
必須。入力のみの画像ファイル名。 サポートされているファイル拡張子: |
DeleteCustomEmojiRequest
カスタム絵文字の削除リクエスト。
フィールド | |
---|---|
name |
必須。削除するカスタム絵文字のリソース名。 形式: 絵文字名は |
DeleteMembershipRequest
スペースのメンバーシップを削除するリクエスト。
フィールド | |
---|---|
name |
必須。削除するメンバーシップのリソース名。チャットアプリは、人間のユーザーまたは自身のメンバーシップを削除できます。チャットアプリは、他のアプリのメンバーシップを削除できません。 人間のメンバーシップを削除する場合は、 アプリ メンバーシップを削除する場合は、 形式: |
use_ |
省略可。 呼び出し元のユーザーは、Chat とスペースの会話の管理権限を持つ Google Workspace 管理者である必要があります。
管理者権限を使用してスペース内のアプリ メンバーシップを削除することはできません。 |
DeleteMessageRequest
メッセージを削除するリクエスト。
フィールド | |
---|---|
name |
必須。メッセージのリソース名。 形式: メッセージにカスタム ID を設定している場合は、 |
force |
省略可。 ユーザーとして認証する場合にのみ適用されます。Chat アプリとして認証する場合は効果がありません。 |
DeleteReactionRequest
メッセージに対するリアクションを削除します。
フィールド | |
---|---|
name |
必須。削除するリアクションの名前。 形式: |
DeleteSpaceRequest
スペースの削除リクエスト。
フィールド | |
---|---|
name |
必須。削除するスペースのリソース名。 形式: |
use_ |
省略可。 呼び出し元のユーザーは、Chat とスペースの会話の管理権限を持つ Google Workspace 管理者である必要があります。
|
DeletionMetadata
削除されたメッセージに関する情報。delete_time
が設定されていると、メッセージは削除されます。
フィールド | |
---|---|
deletion_ |
メッセージを削除したユーザーを示します。 |
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_ |
入力のみのダイアログを呼び出すか送信するリクエストのステータス。必要に応じて、ステータスとメッセージをユーザーに表示します。たとえば、エラーや成功の場合などです。 |
共用体フィールド action 。実行するアクション。action は次のいずれかになります。 |
|
dialog |
入力のみのリクエストのダイアログ。 |
DriveDataRef
ドライブ アタッチメントのデータへの参照。
フィールド | |
---|---|
drive_ |
ドライブ ファイルの ID。Drive API で使用します。 |
DriveLinkData
Google ドライブのリンクのデータ。
フィールド | |
---|---|
drive_ |
Google ドライブ ファイルを参照する DriveDataRef。 |
mime_ |
リンクされた Google ドライブ リソースの MIME タイプ。 |
絵文字
メッセージに対するリアクションとして使用される絵文字。
フィールド | |
---|---|
共用体フィールド content 。必須。絵文字の内容。content は次のいずれかになります。 |
|
unicode |
省略可。Unicode 文字列で表される基本的な絵文字。 |
custom_ |
出力専用。カスタム絵文字。 |
EmojiReactionSummary
特定の絵文字でメッセージにリアクションしたユーザーの数。
フィールド | |
---|---|
emoji |
出力専用。リアクションに関連付けられた絵文字。 |
reaction_ |
出力専用。関連付けられた絵文字を使用したリアクションの合計数。 |
FindDirectMessageRequest
ユーザー リソースに基づいてダイレクト メッセージ スペースを取得するためのリクエスト。
フィールド | |
---|---|
name |
必須。ダイレクト メッセージを検索するユーザーのリソース名。 形式: |
GetAttachmentRequest
添付ファイルを取得するリクエスト。
フィールド | |
---|---|
name |
必須。アタッチメントのリソース名( |
GetCustomEmojiRequest
1 つのカスタム絵文字を返すリクエスト。
フィールド | |
---|---|
name |
必須。カスタム絵文字のリソース名。 形式: 絵文字名は |
GetMembershipRequest
スペースのメンバーシップを取得するリクエスト。
フィールド | |
---|---|
name |
必須。取得するメンバーシップのリソース名。 ユーザー認証を使用してアプリ独自のメンバーシップを取得するには、必要に応じて 形式: ユーザーのメールアドレスを |
use_ |
省略可。 呼び出し元のユーザーは、Chat とスペースの会話の管理権限を持つ Google Workspace 管理者である必要があります。
管理者権限を使用している場合、スペース内のアプリ メンバーシップの取得はサポートされていません。 |
GetMessageRequest
メッセージを取得するためのリクエスト。
フィールド | |
---|---|
name |
必須。メッセージのリソース名。 形式: メッセージにカスタム ID を設定している場合は、 |
GetSpaceEventRequest
スペース イベントを取得するリクエスト メッセージ。
フィールド | |
---|---|
name |
必須。スペース イベントのリソース名。 形式: |
GetSpaceNotificationSettingRequest
スペースの通知設定を取得するリクエスト メッセージ。通話発信側のユーザーの通知設定の取得のみをサポートします。
フィールド | |
---|---|
name |
必須。形式: users/{user}/spaces/{space}/spaceNotificationSetting
|
GetSpaceReadStateRequest
GetSpaceReadState API のリクエスト メッセージ。
フィールド | |
---|---|
name |
必須。取得するスペースの読み取り状態のリソース名。 呼び出し元のユーザーの読み取りステータスの取得のみをサポートします。 呼び出し元のユーザーを参照するには、次のいずれかを設定します。
形式: users/{user}/spaces/{space}/spaceReadState |
GetSpaceRequest
1 つのスペースを返すリクエスト。
フィールド | |
---|---|
name |
必須。スペースのリソース名( 形式: |
use_ |
省略可。 呼び出し元のユーザーは、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 の保持ルールで、メッセージとスレッドを保持する期間を指定します。 |
ListCustomEmojisRequest
カスタム絵文字のリストを返すリクエスト。
フィールド | |
---|---|
page_ |
省略可。返されるカスタム絵文字の最大数。サービスが返すカスタム 絵文字は、この値より少ない場合があります。指定しない場合、デフォルト値は 25 です。最大値は 200 です。200 を超える値は 200 に変更されます。 |
page_ |
省略可。(前のクエリから再開する場合)。 前回の list custom emoji 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。 ページネーションを行う場合、フィルタ値はページトークンを受け取った呼び出しと一致している必要があります。別の値を渡すと、予期しない結果になる可能性があります。 |
filter |
省略可。クエリフィルタ。 クリエイターによるフィルタリングがサポートされています。 クリエイター別にフィルタするには、有効な値を指定する必要があります。現在、呼び出し元のユーザーによって作成されたかどうかでカスタム絵文字をフィルタするには、 たとえば、次のクエリは、呼び出し元によって作成されたカスタム絵文字を返します。
無効なクエリは、 |
ListCustomEmojisResponse
カスタム絵文字のリストに対するレスポンス。
フィールド | |
---|---|
custom_ |
順序なしリスト。リクエストされた(または最初の)ページのカスタム絵文字のリスト。 |
next_ |
結果の次のページを取得するために |
ListMembershipsRequest
メンバーシップのリスティングのリクエスト メッセージ。
フィールド | |
---|---|
parent |
必須。メンバーシップ リストを取得するスペースのリソース名。 形式: spaces/{space} |
page_ |
省略可。返されるメンバーシップの最大数。サービスが返す値はこれよりも少ないことがあります。 指定されていない場合は、最大で 100 件のメンバーシップが返されます。 最大値は 1,000 です。1,000 を超える値を使用すると、自動的に 1,000 に変更されます。 負の値を指定すると、 |
page_ |
省略可。メンバーシップの一覧を取得する前に呼び出しで受け取ったページトークン。後続のページを取得するには、このパラメータを指定します。 ページネーションを行う場合、指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致している必要があります。他のパラメータに異なる値を渡すと、予期しない結果になる可能性があります。 |
filter |
省略可。クエリフィルタ。 メンバーシップは、メンバーのロール( ロールでフィルタするには、 タイプ別にフィルタするには、 ロールとタイプの両方でフィルタするには、
たとえば、次のクエリは有効です。
次のクエリは無効です。
無効なクエリは、 |
show_ |
省略可。 |
show_ |
省略可。 現在、ユーザー認証が必要です。 |
use_ |
省略可。 呼び出し元のユーザーは、Chat とスペースの会話の管理権限を持つ Google Workspace 管理者である必要があります。
管理者権限を使用している場合、スペースにアプリのメンバーシップを表示することはできません。 |
ListMembershipsResponse
スペースのメンバーシップを一覧表示するレスポンス。
フィールド | |
---|---|
memberships[] |
順序なしリスト。リクエストされた(または最初の)ページのメンバーシップのリスト。 |
next_ |
結果の次のページを取得するために |
ListMessagesRequest
ユーザーがメンバーになっている、指定したスペース内のメッセージを一覧表示します。
フィールド | |
---|---|
parent |
必須。メッセージを一覧表示するスペースのリソース名。 形式: |
page_ |
省略可。返されるメッセージの最大数。サービスが返すメッセージはこれよりも少ないことがあります。 指定されていない場合は、最大 25 件が返されます。 最大値は 1,000 です。1,000 を超える値を使用すると、自動的に 1,000 に変更されます。 負の値を指定すると、 |
page_ |
省略可。前回の list messages 呼び出しから受け取ったページトークン。後続のページを取得するには、このパラメータを指定します。 ページネーションを行う場合、指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致している必要があります。他のパラメータに異なる値を渡すと、予期しない結果になる可能性があります。 |
filter |
省略可。クエリフィルタ。 メッセージは日付( 作成日でメッセージをフィルタするには、RFC-3339 形式のタイムスタンプと二重引用符を使用して スレッドでフィルタするには、 スレッドと日付の両方でフィルタするには、クエリで たとえば、次のクエリは有効です。
無効なクエリは、 |
order_ |
省略可。メッセージのリストの並べ替え順序。並べ替えオペレーションで並べ替える値を指定します。有効な並べ替えオペレーションの値は次のとおりです。
デフォルトの順序は |
show_ |
省略可。削除されたメールを含めるかどうか。削除されたメールには、削除日時と削除に関するメタデータが含まれますが、メールの内容は利用できません。 |
ListMessagesResponse
メッセージのリストに対するレスポンス メッセージ。
フィールド | |
---|---|
messages[] |
メッセージのリスト。 |
next_ |
トークンを |
ListReactionsRequest
メッセージに対するリアクションを一覧表示します。
フィールド | |
---|---|
parent |
必須。ユーザーがリアクションしたメッセージ。 形式: |
page_ |
省略可。返されるリアクションの最大数。サービスが返すリアクションは、この値より少ない場合があります。指定しない場合、デフォルト値は 25 です。最大値は 200 です。200 を超える値は 200 に変更されます。 |
page_ |
省略可。(前のクエリから再開する場合)。 前回の list reactions 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。 ページネーションを行う場合、フィルタ値はページトークンを受け取った呼び出しと一致している必要があります。別の値を渡すと、予期しない結果になる可能性があります。 |
filter |
省略可。クエリフィルタ。 リアクションは、絵文字( 複数の絵文字またはユーザーのリアクションをフィルタするには、類似のフィールドを 絵文字とユーザーでリアクションをフィルタするには、 クエリで たとえば、次のクエリは有効です。
次のクエリは無効です。
無効なクエリは、 |
ListReactionsResponse
リアクションのリクエストに対するレスポンス。
フィールド | |
---|---|
reactions[] |
リクエストされた(または最初の)ページのリアクションのリスト。 |
next_ |
結果の次のページを取得するための継続トークン。結果の最後のページの場合は空になります。 |
ListSpaceEventsRequest
リスティング スペース イベントのリクエスト メッセージ。
フィールド | |
---|---|
parent |
必須。イベントが発生した Google Chat スペースのリソース名。 形式: |
page_ |
省略可。返されるスペース イベントの最大数。サービスが返す値はこれよりも少ないことがあります。 負の値を指定すると、 |
page_ |
省略可。前回の list space events 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。 ページネーションを行う場合、list space events に指定する他のすべてのパラメータは、ページトークンを受け取った呼び出しと一致している必要があります。他のパラメータに異なる値を渡すと、予期しない結果になる可能性があります。 |
filter |
必須。クエリフィルタ。 has 必要に応じて、開始時間(
開始時間または終了時間を指定するには、等号 たとえば、次のクエリは有効です。
次のクエリは無効です。
無効なクエリは、 |
ListSpaceEventsResponse
スペース イベントを一覧表示するためのレスポンス メッセージ。
フィールド | |
---|---|
space_ |
結果は時系列順(最も古いイベントから)に返されます。注: リスト リクエストの Space オブジェクトには |
next_ |
追加のイベントの取得に使用される連続トークン。このフィールドを省略すると、後続のページはなくなります。 |
ListSpacesRequest
呼び出し元がメンバーであるスペースを一覧表示するリクエスト。
フィールド | |
---|---|
page_ |
省略可。返されるスペースの最大数。サービスが返す値はこれよりも少ないことがあります。 指定されていない場合は、最大で 100 個のスペースが返されます。 最大値は 1,000 です。1,000 を超える値を使用すると、自動的に 1,000 に変更されます。 負の値を指定すると、 |
page_ |
省略可。前回の list spaces 呼び出しから受け取ったページトークン。後続のページを取得するには、このパラメータを指定します。 ページネーションを行う場合、フィルタ値はページトークンを受け取った呼び出しと一致している必要があります。別の値を渡すと、予期しない結果になる可能性があります。 |
filter |
省略可。クエリフィルタ。 スペースはスペースの種類( スペースタイプでフィルタするには、 たとえば、次のクエリは有効です。
無効なクエリは、 |
ListSpacesResponse
リスト スペース リクエストのレスポンス。
フィールド | |
---|---|
spaces[] |
リクエストされた(または最初の)ページのスペースのリスト。注: リスト リクエストの Space オブジェクトには |
next_ |
トークンを |
MatchedUrl
Chat メッセージ内の一致した URL。チャットアプリでは、一致した URL をプレビューできます。詳しくは、リンクをプレビューするをご覧ください。
フィールド | |
---|---|
url |
出力専用。一致した URL。 |
メンバーシップ
Google Chat のメンバーシップ関係を表します。たとえば、ユーザーまたは Chat アプリがスペースに招待されているかどうか、スペースに参加しているかどうか、スペースに含まれていないかどうかなどです。
フィールド | |
---|---|
name |
ID。サーバーによって割り当てられたメンバーシップのリソース名。 形式: |
state |
出力専用。メンバーシップの状態。 |
role |
省略可。Chat スペース内のユーザーのロール。スペースで許可されるアクションが決まります。 このフィールドは、 |
create_ |
省略可。変更不可。メンバーシップの作成日時(メンバーがスペースに参加した日時や、スペースへの参加を招待された日時など)。このフィールドは、インポート モードのスペースで過去のメンバーシップをインポートする場合を除き、出力専用です。 |
delete_ |
省略可。変更不可。メンバーシップの削除日時(メンバーがスペースから退出または削除された日時など)。このフィールドは、インポート モードのスペースで過去のメンバーシップをインポートする場合を除き、出力専用です。 |
共用体フィールド memberType 。このメンバーシップに関連付けられているメンバー。今後、他のメンバータイプもサポートされる可能性があります。memberType は次のいずれかになります。 |
|
member |
省略可。メンバーシップが対応する Google Chat ユーザーまたはアプリ。Chat アプリがユーザーとして認証されると、出力にユーザー |
group_ |
省略可。メンバーシップが対応する Google グループ。 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。メッセージのリソース名。 形式: ここで、 メッセージを作成するときにカスタム 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 つ以上のインタラクティブ ウィジェット。アクセサリ ウィジェットは、テキスト、カード、またはテキストとカードの両方を含むメッセージに追加できます。ダイアログを含むメッセージには対応していません。詳しくは、メッセージの下部にインタラクティブなウィジェットを追加するをご覧ください。 アクセサリ ウィジェットを含むメッセージを作成するには、アプリの認証が必要です。 |
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_ |
出力専用。引用されたメッセージが作成されたとき、または引用されたメッセージが最後に更新されたときのタイムスタンプ。 |
リアクション
メッセージに対するリアクション。
フィールド | |
---|---|
name |
ID。リアクションのリソース名。 形式: |
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_ |
リッチリンクのタイプ。 |
共用体フィールド data 。リンクされたリソースのデータ。data は次のいずれかになります。 |
|
drive_ |
ドライブリンクのデータ。 |
chat_ |
Chat スペースのリンクのデータ。 |
RichLinkType
リッチリンクのタイプ。今後、他の種類も追加される可能性があります。
列挙型 | |
---|---|
RICH_LINK_TYPE_UNSPECIFIED |
列挙型のデフォルト値。使用しないでください。 |
DRIVE_FILE |
Google ドライブのリッチリンク タイプ。 |
CHAT_SPACE |
Chat スペースのリッチリンク タイプ。たとえば、スペースのスマートチップなどです。 |
SearchSpacesRequest
クエリに基づいてスペースのリストを検索するリクエスト。
フィールド | |
---|---|
use_ |
呼び出し元のユーザーは、Chat とスペースの会話の管理権限を持つ Google Workspace 管理者である必要があります。
現在、この方法は管理者アクセスのみをサポートしているため、このフィールドには |
page_ |
返されるスペースの最大数。サービスが返す値はこれよりも少ないことがあります。 指定されていない場合は、最大で 100 個のスペースが返されます。 最大値は 1,000 です。1,000 を超える値を使用すると、自動的に 1,000 に変更されます。 |
page_ |
前回の search spaces 呼び出しから受け取ったトークン。後続のページを取得するには、このパラメータを指定します。 ページネーションを行う場合、指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致している必要があります。他のパラメータに異なる値を渡すと、予期しない結果になる可能性があります。 |
query |
必須。検索クエリ。 次のパラメータを使用して検索できます。
異なるフィールドでは、 同じフィールド内で、 次のクエリの例は有効です。
|
order_ |
省略可。スペースのリストの並べ替え順序。 並べ替えに使用できる属性は次のとおりです。
有効な並べ替えオペレーションの値は次のとおりです。
サポートされている構文は次のとおりです。
|
SearchSpacesResponse
検索スペース リクエストに対応するスペースのリストを含むレスポンス。
フィールド | |
---|---|
spaces[] |
リクエストされたスペースのページ。 |
next_ |
次のページを取得するために使用できるトークン。このフィールドが空の場合、後続のページはありません。 |
total_ |
クエリに一致するスペースの総数(すべてのページにわたる)。結果が 10,000 スペースを超える場合、この値は推定値です。 |
SetUpSpaceRequest
スペースを作成して、指定したユーザーを追加するようリクエストします。
フィールド | |
---|---|
space |
必須。 スペースを作成するには、 グループ チャットを作成するには、 人間間の 1 対 1 の会話を作成するには、 人間と呼び出し元の Chat アプリとの 1 対 1 の会話を作成するには、
|
request_ |
省略可。このリクエストの一意の識別子。ランダムな UUID を使用することをおすすめします。既存のリクエスト ID を指定すると、新しいスペースが作成されるのではなく、その ID で作成されたスペースが返されます。同じ Chat アプリの既存のリクエスト ID を指定して、認証済みのユーザーが異なると、エラーが返されます。 |
memberships[] |
省略可。スペースに参加するよう招待する Google Chat ユーザーまたはグループ。呼び出し元のユーザーは自動的に追加されるため、省略します。 現在、このセットでは(呼び出し元に加えて)最大 20 個のメンバーシップが許可されています。 人間のメンバーシップの場合、 Google グループのメンバーシップの場合、
人間のユーザーで 人間と呼び出し元の Chat アプリとの 1 対 1 の会話を作成する場合は空にする必要があります( |
SlashCommand
Google Chat のスラッシュ コマンド。
フィールド | |
---|---|
command_ |
呼び出されたスラッシュ コマンドの ID。 |
SlashCommandMetadata
スラッシュ コマンド(/)のアノテーション メタデータ。
フィールド | |
---|---|
bot |
コマンドが呼び出された Chat アプリ。 |
type |
スラッシュ コマンドのタイプ。 |
command_ |
呼び出されたスラッシュ コマンドの名前。 |
command_ |
呼び出されたスラッシュ コマンドのコマンド ID。 |
triggers_ |
スラッシュ コマンドがダイアログ用かどうかを示します。 |
タイプ
列挙型 | |
---|---|
TYPE_UNSPECIFIED |
列挙型のデフォルト値。使用しないでください。 |
ADD |
スペースに Chat アプリを追加する。 |
INVOKE |
スペースでスラッシュ コマンドを呼び出す。 |
スペース
Google Chat のスペース。スペースは、複数のユーザー間の会話や、ユーザーと Chat アプリ間の 1 対 1 のメッセージです。
フィールド | |
---|---|
name |
ID。Space のリソース名。 形式: ここで、 |
type |
出力専用。非推奨: 代わりに |
space_ |
省略可。スペースのタイプ。スペースを作成するとき、またはスペースのスペースタイプを更新するときに必要です。他の用途の場合は出力のみ。 |
single_ |
省略可。スペースが Chat アプリと 1 人のユーザーとの DM かどうか。 |
threaded |
出力専用。非推奨: 代わりに |
display_ |
省略可。スペースの表示名。 ダイレクト メッセージの場合、このフィールドは空になることがあります。 最大 128 文字をサポートします。 |
external_ |
省略可。変更不可。このスペースで Google Chat のすべてのユーザーをメンバーとして許可するかどうか。Google Workspace 組織でスペースを作成するときに入力します。次の条件でスペースを作成する場合は、このフィールドを省略します。
既存のスペースの場合、このフィールドは出力専用です。 |
space_ |
出力専用。Chat スペースのスレッド状態。 |
space_ |
省略可。スペースの詳細(説明やルールなど)。 |
space_ |
省略可。このスペース内のメッセージとスレッドのメッセージ履歴の状態。 |
import_ |
省略可。このスペースが、Google Workspace へのデータ移行の一環として
|
create_ |
省略可。変更不可。Chat で作成されたスペースの場合は、スペースが作成された時刻。このフィールドは、インポートモードのスペースで使用する場合を除き、出力専用です。 インポート モードのスペースの場合は、元の作成時間を保持するために、このフィールドをソースでスペースが作成された過去のタイムスタンプに設定します。
|
last_ |
出力専用。スペース内の最後のメッセージのタイムスタンプ。 |
admin_ |
出力専用。Chat アプリを使用したダイレクト メッセージ(DM)スペースの場合、そのスペースが Google Workspace 管理者によって作成されたかどうか。管理者は、組織内のユーザーに代わって Chat アプリをインストールしてダイレクト メッセージを設定できます。 管理者によるインストールをサポートするには、Chat アプリにダイレクト メッセージ機能が必要です。 |
membership_ |
出力専用。メンバータイプ別にグループ化された、参加しているメンバーシップの数。 |
access_ |
省略可。スペースのアクセス設定を指定します。 |
space_ |
出力専用。ユーザーがスペースにアクセスするための URI。 |
import_ |
出力専用。インポート モードのままの場合に、スペースがシステムによって自動的に削除される日時。 インポート モードで作成された各スペースは、この有効期限の前に このフィールドは、インポート モードで作成されたスペースにのみ入力されます。 |
customer |
省略可。変更不可。スペースのドメインのお客様 ID。アプリ認証でスペースを作成し、
DM の場合、このフィールドは入力されません。 |
共用体フィールド ユーザー認証が必要です。 |
|
predefined_ |
省略可。入力のみのスペースの権限の事前設定。スペースを作成するときにのみ入力します。このフィールドが設定されていない場合、コラボレーション スペースが作成されます。スペースを作成すると、設定が |
permission_ |
省略可。既存のスペースのスペース権限の設定。スペースの権限設定を正確に更新するための入力。既存の権限設定が置き換えられます。出力には、現在の権限設定が一覧表示されます。 |
AccessSettings
スペースのアクセス設定を表します。
フィールド | |
---|---|
access_ |
出力専用。スペースのアクセス状態を示します。 |
audience |
省略可。スペースを検索、参加、プレビューできる対象グループのリソース名。設定されていない場合、スペースに個別に招待または追加されたユーザーまたは Google グループのみがスペースにアクセスできます。詳しくは、スペースを対象グループに見つけやすくするをご覧ください。 形式: Google Workspace 組織のデフォルトの対象グループを使用するには、 対象ユーザーの読み取りは、次の機能をサポートしています。 アプリ認証で 対象グループを設定するには、ユーザー認証が必要です。 |
AccessState
スペースのアクセス状態を表します。
列挙型 | |
---|---|
ACCESS_STATE_UNSPECIFIED |
アクセス権の状態が不明であるか、この API でサポートされていません。 |
PRIVATE |
スペースを検出してアクセスできるのは、他のユーザーまたは Google Workspace 管理者によって個別に追加または招待されたユーザーまたは Google グループのみです。 |
DISCOVERABLE |
スペースの管理者が、対象ユーザーにスペースへのアクセス権を付与している。スペースに個別に追加または招待されたユーザーや Google グループも、スペースを見つけてアクセスできます。詳しくは、特定のユーザーがスペースを見つけられるようにするをご覧ください。 検出可能なスペースを作成するには、ユーザー認証が必要です。 |
MembershipCount
スペースのメンバーシップ数をカテゴリ別に表します。
フィールド | |
---|---|
joined_ |
出力専用。スペースに直接参加した人間のユーザーの数。参加しているグループのメンバーシップによって参加したユーザーはカウントされません。 |
joined_ |
出力専用。スペースに直接参加したすべてのグループの数。 |
PermissionSetting
スペースの権限設定を表します。
フィールド | |
---|---|
managers_ |
省略可。スペースの管理者にこの権限があるかどうか。 |
members_ |
省略可。管理者以外のメンバーにこの権限があるかどうか。 |
PermissionSettings
既存の名前付きスペースを更新するときに指定できる権限設定。
スペースの作成時に権限設定を設定するには、リクエストで PredefinedPermissionSettings
フィールドを指定します。
フィールド | |
---|---|
manage_ |
省略可。スペースのメンバーとグループを管理するための設定。 |
modify_ |
省略可。スペースの名前、アバター、説明、ガイドラインを更新するための設定。 |
toggle_ |
省略可。スペースの履歴のオンとオフを切り替える設定。 |
use_ |
省略可。スペースで @all を使用する設定。 |
manage_ |
省略可。スペース内のアプリを管理するための設定。 |
manage_ |
省略可。スペース内の Webhook を管理するための設定。 |
post_ |
出力専用。スペースにメッセージを投稿するための設定。 |
reply_ |
省略可。スペース内のメッセージに返信するための設定。 |
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 |
2 人以上の人間との会話。 |
DM |
人間と Chat アプリ間の 1 対 1 のダイレクト メッセージ。すべてのメッセージがフラットです。ただし、人間同士のダイレクト メッセージは対象外です。 |
SpaceBatchUpdatedEventData
スペースの複数の更新に関するイベント ペイロード。
イベントタイプ: google.workspace.chat.space.v1.batchUpdated
フィールド | |
---|---|
spaces[] |
更新されたスペースのリスト。 |
SpaceEvent
Google Chat スペースでの変更やアクティビティを表すイベント。詳しくは、Google Chat のイベントを操作するをご覧ください。
フィールド | |
---|---|
name |
スペース イベントのリソース名。 形式: |
event_ |
イベントが発生した時刻。 |
event_ |
スペース イベントのタイプ。各イベントタイプにはバッチ バージョンがあります。これは、短時間に発生したイベントタイプの複数のインスタンスのことです。 メッセージでサポートされているイベントタイプ:
メンバーシップでサポートされているイベントタイプ:
リアクションでサポートされているイベントタイプ:
スペースに関するサポートされているイベントタイプ:
|
共用体フィールド
|
|
message_ |
新しいメッセージのイベント ペイロード。 イベントタイプ: |
message_ |
更新されたメッセージのイベント ペイロード。 イベントタイプ: |
message_ |
削除されたメッセージのイベント ペイロード。 イベントタイプ: |
message_ |
複数の新しいメッセージのイベント ペイロード。 イベントタイプ: |
message_ |
複数の更新されたメッセージのイベント ペイロード。 イベントタイプ: |
message_ |
複数の削除されたメッセージのイベント ペイロード。 イベントタイプ: |
space_ |
スペースの更新イベント ペイロード。 イベントタイプ: |
space_ |
スペースの複数の更新に関するイベント ペイロード。 イベントタイプ: |
membership_ |
新しいメンバーシップのイベント ペイロード。 イベントタイプ: |
membership_ |
更新されたメンバーシップのイベント ペイロード。 イベントタイプ: |
membership_ |
削除されたメンバーシップのイベント ペイロード。 イベントタイプ: |
membership_ |
複数の新しいメンバーシップのイベント ペイロード。 イベントタイプ: |
membership_ |
複数の更新されたメンバーシップのイベント ペイロード。 イベントタイプ: |
membership_ |
複数の削除済みメンバーシップのイベント ペイロード。 イベントタイプ: |
reaction_ |
新しいリアクションのイベント ペイロード。 イベントタイプ: |
reaction_ |
削除されたリアクションのイベント ペイロード。 イベントタイプ: |
reaction_ |
複数の新しいリアクションのイベント ペイロード。 イベントタイプ: |
reaction_ |
複数の削除されたリアクションのイベント ペイロード。 イベントタイプ: |
SpaceNotificationSetting
スペース内のユーザーの通知設定。
フィールド | |
---|---|
name |
ID。スペースの通知設定のリソース名。形式: |
notification_ |
通知設定。 |
mute_ |
スペースの通知のミュート設定。 |
MuteSetting
スペースの通知ミュート設定の種類。
列挙型 | |
---|---|
MUTE_SETTING_UNSPECIFIED |
予約済み。 |
UNMUTED |
ユーザーには、通知設定に基づいてそのスペースに関する通知が届きます。 |
MUTED |
通知設定に関係なく、ユーザーはスペースに関する通知を受け取ることはありません。 |
NotificationSetting
通知設定の種類。
列挙型 | |
---|---|
NOTIFICATION_SETTING_UNSPECIFIED |
予約済み。 |
ALL |
通知は、名前リンク、フォロー中のスレッド、新しいスレッドの最初のメッセージによってトリガーされます。ユーザーが手動でフォローを解除しない限り、新しいスレッドはすべて自動的にフォローされます。 |
MAIN_CONVERSATIONS |
通知は、名前リンク付きメッセージ、フォロー中のスレッド、新しいスレッドの最初のメッセージによってトリガーされます。1 対 1 のダイレクト メッセージには使用できません。 |
FOR_YOU |
通知は、名前リンクとフォロー中のスレッドによってトリガーされます。1 対 1 のダイレクト メッセージには使用できません。 |
OFF |
通知がオフになっている。 |
SpaceReadState
スペース内のユーザーの既読ステータス。既読と未読のメッセージを識別するために使用されます。
フィールド | |
---|---|
name |
Space の読み取り状態のリソース名。 形式: |
last_ |
省略可。ユーザーのスペースの読み取りステータスが更新された時刻。通常、これは最後に読まれたメッセージのタイムスタンプか、スペース内の最後に読まれた位置をマークするためにユーザーが指定したタイムスタンプに対応しています。 |
SpaceUpdatedEventData
更新されたスペースのイベント ペイロード。
イベントタイプ: google.workspace.chat.space.v1.updated
フィールド | |
---|---|
space |
更新されたスペース。 |
スレッド
Google Chat スペース内のスレッド。使用例については、メッセージ スレッドを開始または返信するをご覧ください。
メッセージを作成するときにスレッドを指定する場合は、messageReplyOption
フィールドを設定して、一致するスレッドが見つからない場合の処理を決定できます。
フィールド | |
---|---|
name |
ID。スレッドのリソース名。 例: |
thread_ |
省略可。スレッドの作成または更新用の入力。それ以外の場合は、出力のみ。スレッドの ID。最大 4,000 文字をサポートします。 この ID は、設定した Chat アプリに固有のものです。たとえば、複数の Chat アプリが同じスレッドキーを使用してメッセージを作成した場合、メッセージは異なるスレッドに投稿されます。ユーザーまたは別の Chat アプリによって作成されたスレッドに返信するには、代わりにスレッドの |
ThreadReadState
スレッド内のユーザーの読み取りステータス。未読と既読のメッセージを識別するために使用されます。
フィールド | |
---|---|
name |
スレッドの読み取り状態のリソース名。 形式: |
last_ |
ユーザーのスレッドの読み取りステータスが更新された時刻。通常、これはスレッド内で最後に読み取られたメッセージのタイムスタンプに対応しています。 |
UpdateMembershipRequest
メンバーシップの更新リクエスト メッセージ。
フィールド | |
---|---|
membership |
必須。更新するメンバーシップ。 |
update_ |
必須。更新するフィールドパス。複数の値をカンマで区切るか、 現在サポートされているフィールドパスは次のとおりです。
|
use_ |
省略可。 呼び出し元のユーザーは、Chat とスペースの会話の管理権限を持つ Google Workspace 管理者である必要があります。
|
UpdateMessageRequest
メッセージを更新するリクエスト。
フィールド | |
---|---|
message |
必須。フィールドが更新されたメッセージ。 |
update_ |
必須。更新するフィールドパス。複数の値をカンマで区切るか、 現在サポートされているフィールドパスは次のとおりです。 |
allow_ |
省略可。 |
UpdateSpaceNotificationSettingRequest
スペースの通知設定を更新するリクエスト。呼び出し元のユーザーの通知設定の更新のみをサポートします。
フィールド | |
---|---|
space_ |
必須。スペースの通知設定のリソース名は、 |
update_ |
必須。サポートされているフィールドパス: - |
UpdateSpaceReadStateRequest
UpdateSpaceReadState API のリクエスト メッセージ。
フィールド | |
---|---|
space_ |
必須。スペースの読み取り状態と更新するフィールド。 呼び出し元のユーザーの読み取りステータスの更新のみをサポートします。 呼び出し元のユーザーを参照するには、次のいずれかを設定します。
形式: users/{user}/spaces/{space}/spaceReadState |
update_ |
必須。更新するフィールドパス。現在サポートされているフィールドパスは次のとおりです。
スペースを既読としてマークするには、 |
UpdateSpaceRequest
1 つのスペースを更新するリクエスト。
フィールド | |
---|---|
space |
必須。更新するフィールドを含む Space。 |
update_ |
必須。更新するフィールドパス(複数ある場合はカンマで区切ります)。 スペースの次のフィールドを更新できます。
|
use_ |
省略可。 呼び出し元のユーザーは、Chat とスペースの会話の管理権限を持つ Google Workspace 管理者である必要があります。
一部の |
ユーザー
Google Chat のユーザー。リクエストからの出力として返される場合、Chat アプリがユーザーとして認証すると、User
リソースの出力にはユーザーの name
と type
のみが入力されます。
フィールド | |
---|---|
name |
Google Chat 形式:
|
display_ |
出力専用。ユーザーの表示名。 |
domain_ |
ユーザーの Google Workspace ドメインの一意の識別子。 |
type |
ユーザータイプ。 |
is_ |
出力専用。 |
タイプ
列挙型 | |
---|---|
TYPE_UNSPECIFIED |
列挙型のデフォルト値。使用しないでください。 |
HUMAN |
人間のユーザー。 |
BOT |
Chat アプリのユーザー。 |
UserMentionMetadata
ユーザーのメンション(@)のアノテーション メタデータ。
フィールド | |
---|---|
user |
お客様が言及した内容。 |
type |
ユーザーのメンションのタイプ。 |
タイプ
列挙型 | |
---|---|
TYPE_UNSPECIFIED |
列挙型のデフォルト値。使用しないでください。 |
ADD |
スペースにユーザーを追加します。 |
MENTION |
スペース内でユーザーをメンションする。 |
WidgetMarkup
ウィジェットは、テキストと画像を表示する UI 要素です。
フィールド | |
---|---|
buttons[] |
ボタンのリスト。Buttons も |
共用体フィールド data 。WidgetMarkup には次のいずれかの項目のみを含めることができます。複数の WidgetMarkup フィールドを使用して、より多くのアイテムを表示できます。data は次のいずれかになります。 |
|
text_ |
このウィジェットにテキストの段落を表示します。 |
image |
このウィジェットに画像を表示します。 |
key_ |
このウィジェットに Key-Value アイテムを表示します。 |
ボタン
ボタン。テキスト ボタンまたは画像ボタンを使用できます。
フィールド | |
---|---|
共用体フィールド
|
|
text_ |
テキストと |
image_ |
画像と |
FormAction
フォーム アクションは、フォームが送信されたときの動作を記述します。たとえば、Apps Script を呼び出してフォームを処理できます。
フィールド | |
---|---|
action_ |
メソッド名は、フォームのどの部分がフォーム送信をトリガーしたかを特定するために使用されます。この情報は、カードのクリック イベントの一部として Chat アプリにエコーバックされます。共通の動作をトリガーする複数の要素に同じメソッド名を使用できます。 |
parameters[] |
アクション パラメータのリスト。 |
ActionParameter
アクション メソッドが呼び出されるときに指定する文字列パラメータのリスト。たとえば、3 つのスヌーズ ボタン(今すぐスヌーズ、1 日スヌーズ、来週スヌーズ)があるとします。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 です。 |
on_ |
|
aspect_ |
この画像のアスペクト比(幅と高さ)。このフィールドを使用すると、画像の読み込みを待機している間に、画像に適切な高さを予約できます。画像の組み込みのアスペクト比をオーバーライドするものではありません。設定されていない場合、サーバーはイメージをプリフェッチして埋めます。 |
ImageButton
onclick
アクションを含む画像ボタン。
フィールド | |
---|---|
on_ |
|
name |
ユーザー補助に使用されるこの |
共用体フィールド icons 。アイコンは、Icon enum または URL で指定できます。icons は次のいずれかになります。 |
|
icon |
Chat API から提供されたアイコンをインデックスする |
icon_ |
URL で指定されたアイコン。 |
KeyValue
UI 要素には、キー(ラベル)と値(コンテンツ)が含まれています。この要素には、onclick
ボタンなどのアクションも含めることができます。
フィールド | |
---|---|
top_ |
上部ラベルのテキスト。書式設定されたテキストがサポートされています。テキストの書式設定の詳細については、Google Chat アプリでのテキストの書式設定と Google Workspace アドオンでのテキストの書式設定をご覧ください。 |
content |
コンテンツのテキスト。書式設定されたテキストがサポートされており、常に必須です。テキストの書式設定の詳細については、Google Chat アプリでのテキストの書式設定と Google Workspace アドオンでのテキストの書式設定をご覧ください。 |
content_ |
コンテンツを複数行にするかどうか。 |
bottom_ |
下部ラベルのテキスト。書式設定されたテキストがサポートされています。テキストの書式設定の詳細については、Google Chat アプリでのテキストの書式設定と Google Workspace アドオンでのテキストの書式設定をご覧ください。 |
on_ |
|
共用体フィールド icons 。アイコン top_label と bottom_label の少なくとも 1 つを定義する必要があります。icons は次のいずれかになります。 |
|
icon |
Chat API によって対応するアイコン画像に置き換えられる列挙型の値。 |
icon_ |
URL で指定されたアイコン。 |
共用体フィールド control 。コントロール ウィジェット。button または switch_widget を設定できますが、両方は設定できません。control は次のいずれかになります。 |
|
button |
クリックしてアクションをトリガーできるボタン。 |
OnClick
onclick
アクション(リンクを開くなど)。
フィールド | |
---|---|
共用体フィールド
|
|
action |
フォーム アクションは、この |
open_ |
この |
OpenLink
新しいウィンドウを開くリンク。
フィールド | |
---|---|
url |
開く URL。 |
TextButton
テキストと onclick
アクションを含むボタン。
フィールド | |
---|---|
text |
ボタンのテキスト。 |
on_ |
ボタンの |
TextParagraph
段落のテキスト。書式設定されたテキストがサポートされています。テキストの書式設定の詳細については、Google Chat アプリでのテキストの書式設定と Google Workspace アドオンでのテキストの書式設定をご覧ください。
フィールド | |
---|---|
text |
|