Package google.chat.v1

インデックス

• ChatService（インターフェース）
• AccessoryWidget（メッセージ）
• ActionResponse（メッセージ）
• ActionResponse.ResponseType（列挙型）
• ActionResponse.SelectionItems（メッセージ）
• ActionResponse.UpdatedWidget（メッセージ）
• ActionStatus（メッセージ）
• Annotation（メッセージ）
• AnnotationType（列挙型）
• AppCommandMetadata（メッセージ）
• AppCommandMetadata.AppCommandType（列挙型）
• 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（メッセージ）
• CustomEmojiMetadata（メッセージ）
• 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 プラットフォームで Chat 用アプリや統合を構築できるようにします。

CompleteImportSpace
rpc CompleteImportSpace(CompleteImportSpaceRequest) returns (CompleteImportSpaceResponse) 指定されたスペースのインポート プロセスを完了し、ユーザーに表示できるようにします。 ユーザー認証と、認可スコープを使用したドメイン全体の委任が必要です。 https://www.googleapis.com/auth/chat.import 詳細については、Google Chat アプリにデータのインポートを許可するをご覧ください。 認可スコープ 次の OAuth スコープが必要です。 https://www.googleapis.com/auth/chat.import 詳しくは、承認ガイドをご覧ください。

CreateCustomEmoji
rpc CreateCustomEmoji(CreateCustomEmojiRequest) returns (CustomEmoji) カスタム絵文字を作成します。 カスタム絵文字は Google Workspace アカウントでのみ使用でき、管理者が組織でカスタム絵文字を有効にする必要があります。詳しくは、Google Chat のカスタム絵文字についてとカスタム絵文字の権限を管理するをご覧ください。 認可スコープを使用したユーザー認証が必要です。 https://www.googleapis.com/auth/chat.customemojis 認可スコープ 次の OAuth スコープが必要です。 https://www.googleapis.com/auth/chat.customemojis 詳しくは、承認ガイドをご覧ください。

CreateMembership

rpc CreateMembership(CreateMembershipRequest) returns (Membership) 呼び出し元の Chat 用アプリ、ユーザー、Google グループのメンバーシップを作成します。他の Chat 用アプリのメンバーシップを作成することはできません。メンバーシップを作成する際に、指定したメンバーの自動承認ポリシーがオフになっている場合は、そのメンバーは招待され、参加する前にスペースへの招待を承諾する必要があります。それ以外の場合、メンバーシップを作成すると、指定されたスペースにメンバーが直接追加されます。 次のタイプの認証をサポートしています。 デベロッパー プレビューの管理者による承認を使用したアプリ認証と、承認スコープ: https://www.googleapis.com/auth/chat.app.memberships 次のいずれかの認可スコープを使用したユーザー認証: https://www.googleapis.com/auth/chat.memberships https://www.googleapis.com/auth/chat.memberships.app（呼び出し元のアプリをスペースに追加するため） https://www.googleapis.com/auth/chat.import（インポート モードのスペースのみ） ユーザー認証では、管理者アカウントが認証され、use_admin_access が true で、次の認可スコープが使用されている場合に、管理者権限が付与されます。 https://www.googleapis.com/auth/chat.admin.memberships アプリ認証は、次のユースケースではサポートされていません。 スペースを所有する Workspace 組織外のユーザーを招待する。 スペースに Google グループを追加する。 スペースに Chat 用アプリを追加する。 使用例については、以下をご覧ください。 ユーザーをスペースに招待または追加する。 Google グループをスペースに招待または追加する。 Chat アプリをスペースに追加する。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/chat.app.memberships https://www.googleapis.com/auth/chat.admin.memberships https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.memberships https://www.googleapis.com/auth/chat.memberships.app 詳しくは、承認ガイドをご覧ください。

CreateMessage

rpc CreateMessage(CreateMessageRequest) returns (Message) Google Chat スペースにメッセージを作成します。例については、メッセージを送信するをご覧ください。 次のタイプの認証をサポートしています。 認可スコープを使用したアプリ認証: https://www.googleapis.com/auth/chat.bot 次のいずれかの認可スコープを使用したユーザー認証: https://www.googleapis.com/auth/chat.messages.create https://www.googleapis.com/auth/chat.messages https://www.googleapis.com/auth/chat.import（インポート モードのスペースのみ） Chat は、リクエストで使用する認証のタイプに応じて、メッセージの送信者を異なる方法で特定します。 次の図は、アプリ認証を使用する場合に Chat がメッセージを帰属させる方法を示しています。Chat では、メッセージの送信者として Chat 用アプリが表示されます。メッセージのコンテンツには、テキスト（text）、カード（cardsV2）、アクセサリ ウィジェット（accessoryWidgets）を含めることができます。 次の図は、ユーザー認証を使用した場合に Chat がメッセージを帰属させる方法を示しています。Chat では、ユーザーがメッセージの送信者として表示され、Chat アプリの名前が表示されることで、Chat アプリがメッセージに関連付けられます。メッセージの内容にはテキスト（text）のみを含めることができます。 メッセージの最大サイズ（メッセージの内容を含む）は 32,000 バイトです。 Webhook リクエストの場合、レスポンスにメッセージ全体が含まれていません。レスポンスには、リクエストに含まれていた情報に加えて、name フィールドと thread.name フィールドのみが入力されます。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/chat.bot https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.messages https://www.googleapis.com/auth/chat.messages.create 詳しくは、承認ガイドをご覧ください。

CreateReaction

rpc CreateReaction(CreateReactionRequest) returns (Reaction) リアクションを作成してメッセージに追加します。例については、メッセージにリアクションを追加するをご覧ください。 次のいずれかの認可スコープによるユーザー認証が必要です。 https://www.googleapis.com/auth/chat.messages.reactions.create https://www.googleapis.com/auth/chat.messages.reactions https://www.googleapis.com/auth/chat.messages https://www.googleapis.com/auth/chat.import（インポート モードのスペースのみ） 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.messages https://www.googleapis.com/auth/chat.messages.reactions https://www.googleapis.com/auth/chat.messages.reactions.create 詳しくは、承認ガイドをご覧ください。

CreateSpace

rpc CreateSpace(CreateSpaceRequest) returns (Space) スペースを作成します。Import mode で名前付きスペースまたはグループ チャットを作成するために使用できます。例については、スペースを作成するをご覧ください。 次のタイプの認証をサポートしています。 デベロッパー プレビューで管理者による承認を伴うアプリ認証と、次のいずれかの認可スコープ: https://www.googleapis.com/auth/chat.app.spaces.create https://www.googleapis.com/auth/chat.app.spaces 次のいずれかの認可スコープを使用したユーザー認証: https://www.googleapis.com/auth/chat.spaces.create https://www.googleapis.com/auth/chat.spaces https://www.googleapis.com/auth/chat.import（インポート モードのスペースのみ） アプリとして認証する場合は、リクエストで space.customer フィールドを設定する必要があります。 アプリとして認証すると、Chat 用アプリがスペースのメンバーとして追加されます。ただし、ユーザー認証とは異なり、Chat 用アプリはスペース管理者として追加されません。デフォルトでは、スペースのすべてのメンバーが Chat 用アプリをスペースから削除できます。スペース管理者のみがスペースからアプリを削除できるようにするには、space.permission_settings.manage_apps を managers_allowed に設定します。 作成時のスペース メンバーシップは、スペースが Import mode で作成されたかどうかによって異なります。 インポート モード: メンバーは作成されません。 その他のすべてのモード: 通話中のユーザーがメンバーとして追加されます。これは次のようになります。 アプリ認証を使用している場合はアプリ自体。 ユーザー認証を使用する場合のユーザー。 スペースの作成時にエラー メッセージ ALREADY_EXISTS が表示された場合は、別の displayName を試してください。Google Workspace 組織内の既存のスペースで、この表示名がすでに使用されている可能性があります。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/chat.app.spaces.create https://www.googleapis.com/auth/chat.app.spaces https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.spaces https://www.googleapis.com/auth/chat.spaces.create 詳しくは、承認ガイドをご覧ください。

DeleteCustomEmoji

rpc DeleteCustomEmoji(DeleteCustomEmojiRequest) returns (Empty) カスタム絵文字を削除します。デフォルトでは、ユーザーは自分が作成したカスタム絵文字のみを削除できます。管理者が割り当てた絵文字管理者は、組織内のカスタム絵文字を削除できます。Google Chat のカスタム絵文字についてをご覧ください。 カスタム絵文字は Google Workspace アカウントでのみ使用でき、管理者が組織でカスタム絵文字を有効にする必要があります。詳しくは、Google Chat のカスタム絵文字についてとカスタム絵文字の権限を管理するをご覧ください。 認可スコープを使用したユーザー認証が必要です。 https://www.googleapis.com/auth/chat.customemojis 認可スコープ 次の OAuth スコープが必要です。 https://www.googleapis.com/auth/chat.customemojis 詳しくは、承認ガイドをご覧ください。

DeleteMembership

rpc DeleteMembership(DeleteMembershipRequest) returns (Membership) メンバーシップを削除します。例については、スペースからユーザーまたは Google Chat 用アプリを削除するをご覧ください。 次のタイプの認証をサポートしています。 デベロッパー プレビューの管理者による承認を使用したアプリ認証と、承認スコープ: https://www.googleapis.com/auth/chat.app.memberships 次のいずれかの認可スコープを使用したユーザー認証: https://www.googleapis.com/auth/chat.memberships https://www.googleapis.com/auth/chat.memberships.app（スペースから通話アプリを削除するため） https://www.googleapis.com/auth/chat.import（インポート モードのスペースのみ） ユーザー認証では、管理者アカウントが認証され、use_admin_access が true で、次の認可スコープが使用されている場合に、管理者権限が付与されます。 https://www.googleapis.com/auth/chat.admin.memberships アプリ認証は、次のユースケースではサポートされていません。 スペースから Google グループを削除する。 スペースから Chat 用アプリを削除する。 スペースの管理者のメンバーシップを削除するには、リクエストを行うユーザーがスペースの管理者である必要があります。アプリ認証を使用している場合、Chat 用アプリはスペースの作成者である必要があります。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/chat.app.memberships https://www.googleapis.com/auth/chat.admin.memberships https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.memberships https://www.googleapis.com/auth/chat.memberships.app 詳しくは、承認ガイドをご覧ください。

DeleteMessage

rpc DeleteMessage(DeleteMessageRequest) returns (Empty) メッセージを削除します。例については、メッセージを削除するをご覧ください。 次のタイプの認証をサポートしています。 認可スコープを使用したアプリ認証: https://www.googleapis.com/auth/chat.bot 次のいずれかの認可スコープを使用したユーザー認証: https://www.googleapis.com/auth/chat.messages https://www.googleapis.com/auth/chat.import（インポート モードのスペースのみ） アプリ認証を使用する場合、リクエストで削除できるのは、呼び出し元の Chat 用アプリによって作成されたメッセージのみです。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/chat.bot https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.messages 詳しくは、承認ガイドをご覧ください。

DeleteReaction

rpc DeleteReaction(DeleteReactionRequest) returns (Empty) メッセージに対するリアクションを削除します。例については、リアクションを削除するをご覧ください。 次のいずれかの認可スコープによるユーザー認証が必要です。 https://www.googleapis.com/auth/chat.messages.reactions https://www.googleapis.com/auth/chat.messages https://www.googleapis.com/auth/chat.import（インポート モードのスペースのみ） 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.messages https://www.googleapis.com/auth/chat.messages.reactions 詳しくは、承認ガイドをご覧ください。

DeleteSpace

rpc DeleteSpace(DeleteSpaceRequest) returns (Empty) 名前付きスペースを削除します。常にカスケード削除を実行します。つまり、スペースに投稿されたメッセージやスペースのメンバーシップなど、スペースの子リソースも削除されます。例については、Space を削除するをご覧ください。 次のタイプの認証をサポートしています。 デベロッパー プレビューの管理者による承認を使用したアプリ認証と、承認スコープ: https://www.googleapis.com/auth/chat.app.delete（アプリが作成したスペースのみ） 次のいずれかの認可スコープを使用したユーザー認証: https://www.googleapis.com/auth/chat.delete https://www.googleapis.com/auth/chat.import（インポート モードのスペースのみ） ユーザー認証では、管理者アカウントが認証され、use_admin_access が true で、次の認可スコープが使用されている場合に、管理者権限が付与されます。 https://www.googleapis.com/auth/chat.admin.delete 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/chat.app.delete https://www.googleapis.com/auth/chat.admin.delete https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.delete 詳しくは、承認ガイドをご覧ください。

FindDirectMessage

rpc FindDirectMessage(FindDirectMessageRequest) returns (Space) 指定されたユーザーとの既存のダイレクト メッセージを返します。ダイレクト メッセージ スペースが見つからない場合は、404 NOT_FOUND エラーを返します。例については、ダイレクト メッセージを探すをご覧ください。 アプリ認証では、指定されたユーザーと呼び出し元の Chat 用アプリ間のダイレクト メッセージ スペースを返します。 ユーザー認証では、指定されたユーザーと認証済みユーザー間のダイレクト メッセージ スペースを返します。 次のタイプの認証をサポートしています。 認可スコープを使用したアプリ認証: https://www.googleapis.com/auth/chat.bot 次のいずれかの認可スコープを使用したユーザー認証: https://www.googleapis.com/auth/chat.spaces.readonly https://www.googleapis.com/auth/chat.spaces 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/chat.spaces https://www.googleapis.com/auth/chat.spaces.readonly https://www.googleapis.com/auth/chat.bot 詳しくは、承認ガイドをご覧ください。

GetAttachment
rpc GetAttachment(GetAttachmentRequest) returns (Attachment) メッセージの添付ファイルのメタデータを取得します。添付ファイル データは、メディア API を使用して取得されます。例については、メッセージの添付ファイルに関するメタデータを取得するをご覧ください。 認可スコープによるアプリ認証が必要です。 https://www.googleapis.com/auth/chat.bot 認可スコープ 次の OAuth スコープが必要です。 https://www.googleapis.com/auth/chat.bot 詳しくは、承認ガイドをご覧ください。

GetCustomEmoji

rpc GetCustomEmoji(GetCustomEmojiRequest) returns (CustomEmoji) カスタム絵文字の詳細を返します。 カスタム絵文字は Google Workspace アカウントでのみ使用でき、管理者が組織でカスタム絵文字を有効にする必要があります。詳しくは、Google Chat のカスタム絵文字についてとカスタム絵文字の権限を管理するをご覧ください。 次のいずれかの認可スコープによるユーザー認証が必要です。 https://www.googleapis.com/auth/chat.customemojis.readonly https://www.googleapis.com/auth/chat.customemojis 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/chat.customemojis https://www.googleapis.com/auth/chat.customemojis.readonly 詳しくは、承認ガイドをご覧ください。

GetMembership

rpc GetMembership(GetMembershipRequest) returns (Membership) メンバーシップに関する詳細を返します。例については、ユーザーまたは Google Chat アプリのメンバーシップの詳細を取得するをご覧ください。 次のタイプの認証をサポートしています。 次のいずれかの認可スコープを使用したアプリ認証: https://www.googleapis.com/auth/chat.bot https://www.googleapis.com/auth/chat.app.memberships（管理者の承認が必要） 次のいずれかの認可スコープを使用したユーザー認証: https://www.googleapis.com/auth/chat.memberships.readonly https://www.googleapis.com/auth/chat.memberships ユーザー認証では、管理者アカウントが認証され、use_admin_access が true で、次のいずれかの認可スコープが使用されている場合に、管理者権限が付与されます。 https://www.googleapis.com/auth/chat.admin.memberships.readonly https://www.googleapis.com/auth/chat.admin.memberships 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/chat.admin.memberships https://www.googleapis.com/auth/chat.admin.memberships.readonly https://www.googleapis.com/auth/chat.app.memberships https://www.googleapis.com/auth/chat.bot https://www.googleapis.com/auth/chat.memberships https://www.googleapis.com/auth/chat.memberships.readonly 詳しくは、承認ガイドをご覧ください。

GetMessage

rpc GetMessage(GetMessageRequest) returns (Message) メッセージの詳細を返します。例については、メッセージの詳細を取得するをご覧ください。 次のタイプの認証をサポートしています。 認可スコープを使用したアプリ認証: https://www.googleapis.com/auth/chat.bot 次のいずれかの認可スコープを使用したユーザー認証: https://www.googleapis.com/auth/chat.messages.readonly https://www.googleapis.com/auth/chat.messages 注: ブロックされたメンバーまたはスペースからのメッセージが返されることがあります。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/chat.bot https://www.googleapis.com/auth/chat.messages https://www.googleapis.com/auth/chat.messages.readonly 詳しくは、承認ガイドをご覧ください。

GetSpace

rpc GetSpace(GetSpaceRequest) returns (Space) スペースに関する詳細情報を返します。例については、Space の詳細を取得するをご覧ください。 次のタイプの認証をサポートしています。 次のいずれかの認可スコープを使用したアプリ認証: https://www.googleapis.com/auth/chat.bot https://www.googleapis.com/auth/chat.app.spaces（管理者による承認あり） 次のいずれかの認可スコープを使用したユーザー認証: https://www.googleapis.com/auth/chat.spaces.readonly https://www.googleapis.com/auth/chat.spaces ユーザー認証では、管理者アカウントが認証され、use_admin_access が true で、次のいずれかの認可スコープが使用されている場合に、管理者権限が付与されます。 https://www.googleapis.com/auth/chat.admin.spaces.readonly https://www.googleapis.com/auth/chat.admin.spaces アプリ認証には次の制限があります。 space.access_settings は、chat.app.spaces スコープを使用している場合にのみ入力されます。 space.predefind_permission_settings と space.permission_settings は、chat.app.spaces スコープを使用する場合にのみ、アプリが作成したスペースに対してのみ入力されます。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/chat.admin.spaces https://www.googleapis.com/auth/chat.admin.spaces.readonly https://www.googleapis.com/auth/chat.spaces https://www.googleapis.com/auth/chat.spaces.readonly https://www.googleapis.com/auth/chat.bot https://www.googleapis.com/auth/chat.app.spaces 詳しくは、承認ガイドをご覧ください。

GetSpaceEvent

rpc GetSpaceEvent(GetSpaceEventRequest) returns (SpaceEvent) Google Chat スペースからイベントを返します。イベント ペイロードには、変更されたリソースの最新バージョンが含まれています。たとえば、新しいメッセージに関するイベントをリクエストした後にメッセージが更新された場合、サーバーは更新された Message リソースをイベント ペイロードで返します。 注: このリクエストの Space イベントデータの Space オブジェクトでは、permissionSettings フィールドは返されません。 リクエストされたデータの読み取りに適した認可スコープを使用したユーザー認証が必要です。 https://www.googleapis.com/auth/chat.spaces.readonly https://www.googleapis.com/auth/chat.spaces https://www.googleapis.com/auth/chat.messages.readonly https://www.googleapis.com/auth/chat.messages https://www.googleapis.com/auth/chat.messages.reactions.readonly https://www.googleapis.com/auth/chat.messages.reactions https://www.googleapis.com/auth/chat.memberships.readonly https://www.googleapis.com/auth/chat.memberships イベントを取得するには、認証されたユーザーがスペースのメンバーである必要があります。 例については、Google Chat スペースからイベントの詳細を取得するをご覧ください。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/chat.spaces https://www.googleapis.com/auth/chat.spaces.readonly https://www.googleapis.com/auth/chat.messages https://www.googleapis.com/auth/chat.messages.readonly https://www.googleapis.com/auth/chat.memberships https://www.googleapis.com/auth/chat.memberships.readonly https://www.googleapis.com/auth/chat.messages.reactions https://www.googleapis.com/auth/chat.messages.reactions.readonly 詳しくは、承認ガイドをご覧ください。

GetSpaceNotificationSetting
rpc GetSpaceNotificationSetting(GetSpaceNotificationSettingRequest) returns (SpaceNotificationSetting) スペースの通知設定を取得します。例については、通話者のスペース通知設定を取得するをご覧ください。 認可スコープを使用したユーザー認証が必要です。 https://www.googleapis.com/auth/chat.users.spacesettings 認可スコープ 次の OAuth スコープが必要です。 https://www.googleapis.com/auth/chat.users.spacesettings 詳しくは、承認ガイドをご覧ください。

GetSpaceReadState

rpc GetSpaceReadState(GetSpaceReadStateRequest) returns (SpaceReadState) スペース内のユーザーの既読状態に関する詳細を返します。既読メッセージと未読メッセージの識別に使用されます。例については、ユーザーのスペースの読み取り状態に関する詳細を取得するをご覧ください。 次のいずれかの認可スコープによるユーザー認証が必要です。 https://www.googleapis.com/auth/chat.users.readstate.readonly https://www.googleapis.com/auth/chat.users.readstate 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/chat.users.readstate https://www.googleapis.com/auth/chat.users.readstate.readonly 詳しくは、承認ガイドをご覧ください。

GetThreadReadState

rpc GetThreadReadState(GetThreadReadStateRequest) returns (ThreadReadState) スレッド内のユーザーの既読状態に関する詳細を返します。既読メッセージと未読メッセージの識別に使用されます。例については、ユーザーのスレッドの既読状態の詳細を取得するをご覧ください。 次のいずれかの認可スコープによるユーザー認証が必要です。 https://www.googleapis.com/auth/chat.users.readstate.readonly https://www.googleapis.com/auth/chat.users.readstate 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/chat.users.readstate https://www.googleapis.com/auth/chat.users.readstate.readonly 詳しくは、承認ガイドをご覧ください。

ListCustomEmojis

rpc ListCustomEmojis(ListCustomEmojisRequest) returns (ListCustomEmojisResponse) 認証済みユーザーに表示されるカスタム絵文字のリストを取得します。 カスタム絵文字は Google Workspace アカウントでのみ使用でき、管理者が組織でカスタム絵文字を有効にする必要があります。詳しくは、Google Chat のカスタム絵文字についてとカスタム絵文字の権限を管理するをご覧ください。 次のいずれかの認可スコープによるユーザー認証が必要です。 https://www.googleapis.com/auth/chat.customemojis.readonly https://www.googleapis.com/auth/chat.customemojis 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/chat.customemojis https://www.googleapis.com/auth/chat.customemojis.readonly 詳しくは、承認ガイドをご覧ください。

ListMemberships

rpc ListMemberships(ListMembershipsRequest) returns (ListMembershipsResponse) スペースのメンバーシップを一覧表示します。例については、スペース内のユーザーと Google Chat アプリを一覧表示するをご覧ください。アプリ認証でメンバーシップを一覧表示すると、Chat 用アプリがアクセスできるスペースのメンバーシップが一覧表示されますが、Chat 用アプリのメンバーシップ（アプリ自身のメンバーシップを含む）は除外されます。ユーザー認証を使用してメンバーシップを一覧表示すると、認証されたユーザーがアクセスできるスペースのメンバーシップが一覧表示されます。 次のタイプの認証をサポートしています。 次のいずれかの認可スコープを使用したアプリ認証: https://www.googleapis.com/auth/chat.bot https://www.googleapis.com/auth/chat.app.memberships（管理者の承認が必要） 次のいずれかの認可スコープを使用したユーザー認証: https://www.googleapis.com/auth/chat.memberships.readonly https://www.googleapis.com/auth/chat.memberships https://www.googleapis.com/auth/chat.import（インポート モードのスペースのみ） ユーザー認証では、管理者アカウントが認証され、use_admin_access が true で、次のいずれかの認可スコープが使用されている場合に、管理者権限が付与されます。 https://www.googleapis.com/auth/chat.admin.memberships.readonly https://www.googleapis.com/auth/chat.admin.memberships 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/chat.admin.memberships https://www.googleapis.com/auth/chat.admin.memberships.readonly https://www.googleapis.com/auth/chat.app.memberships https://www.googleapis.com/auth/chat.bot https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.memberships https://www.googleapis.com/auth/chat.memberships.readonly 詳しくは、承認ガイドをご覧ください。

ListMessages

rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse) 呼び出し元がメンバーになっているスペースのメッセージを一覧表示します。これには、ブロックされたメンバーやスペースからのメッセージも含まれます。メッセージのないスペースのメッセージを一覧表示すると、レスポンスは空のオブジェクトになります。REST/HTTP インターフェースを使用する場合、レスポンスには空の JSON オブジェクト {} が含まれます。例については、メッセージを一覧表示するをご覧ください。 次のいずれかの認可スコープによるユーザー認証が必要です。 https://www.googleapis.com/auth/chat.messages.readonly https://www.googleapis.com/auth/chat.messages https://www.googleapis.com/auth/chat.import（インポート モードのスペースのみ） 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.messages https://www.googleapis.com/auth/chat.messages.readonly 詳しくは、承認ガイドをご覧ください。

ListReactions

rpc ListReactions(ListReactionsRequest) returns (ListReactionsResponse) メッセージに対するリアクションを一覧表示します。例については、メッセージのリアクションを一覧表示するをご覧ください。 次のいずれかの認可スコープによるユーザー認証が必要です。 https://www.googleapis.com/auth/chat.messages.reactions.readonly https://www.googleapis.com/auth/chat.messages.reactions https://www.googleapis.com/auth/chat.messages.readonly https://www.googleapis.com/auth/chat.messages 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/chat.messages https://www.googleapis.com/auth/chat.messages.readonly https://www.googleapis.com/auth/chat.messages.reactions https://www.googleapis.com/auth/chat.messages.reactions.readonly 詳しくは、承認ガイドをご覧ください。

ListSpaceEvents

rpc ListSpaceEvents(ListSpaceEventsRequest) returns (ListSpaceEventsResponse) Google Chat スペースのイベントを一覧表示します。各イベントのペイロードには、Chat リソースの最新バージョンが含まれています。たとえば、新しいスペース メンバーに関するイベントを一覧表示すると、サーバーは最新のメンバーシップの詳細を含む Membership リソースを返します。リクエストされた期間中に新しいメンバーが削除された場合、イベント ペイロードには空の Membership リソースが含まれます。 リクエストされたデータの読み取りに適した認可スコープを使用したユーザー認証が必要です。 https://www.googleapis.com/auth/chat.spaces.readonly https://www.googleapis.com/auth/chat.spaces https://www.googleapis.com/auth/chat.messages.readonly https://www.googleapis.com/auth/chat.messages https://www.googleapis.com/auth/chat.messages.reactions.readonly https://www.googleapis.com/auth/chat.messages.reactions https://www.googleapis.com/auth/chat.memberships.readonly https://www.googleapis.com/auth/chat.memberships イベントを一覧表示するには、認証済みユーザーがスペースのメンバーである必要があります。 例については、Google Chat スペースのイベントを一覧表示するをご覧ください。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/chat.spaces https://www.googleapis.com/auth/chat.spaces.readonly https://www.googleapis.com/auth/chat.messages https://www.googleapis.com/auth/chat.messages.readonly https://www.googleapis.com/auth/chat.memberships https://www.googleapis.com/auth/chat.memberships.readonly https://www.googleapis.com/auth/chat.messages.reactions https://www.googleapis.com/auth/chat.messages.reactions.readonly 詳しくは、承認ガイドをご覧ください。

ListSpaces

rpc ListSpaces(ListSpacesRequest) returns (ListSpacesResponse) 呼び出し元がメンバーになっているスペースを一覧表示します。グループ チャットと DM は、最初のメッセージが送信されるまで表示されません。例については、スペースを一覧表示するをご覧ください。 次のタイプの認証をサポートしています。 認可スコープを使用したアプリ認証: https://www.googleapis.com/auth/chat.bot 次のいずれかの認可スコープを使用したユーザー認証: https://www.googleapis.com/auth/chat.spaces.readonly https://www.googleapis.com/auth/chat.spaces Google Workspace 組織別にすべての名前付きスペースを一覧表示するには、代わりに Workspace 管理者権限を使用して spaces.search() メソッドを使用します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/chat.spaces https://www.googleapis.com/auth/chat.spaces.readonly https://www.googleapis.com/auth/chat.bot 詳しくは、承認ガイドをご覧ください。

SearchSpaces

rpc SearchSpaces(SearchSpacesRequest) returns (SearchSpacesResponse) 管理者の検索に基づいて、Google Workspace 組織内のスペースのリストを返します。 管理者権限を持つユーザー認証と、次のいずれかの承認スコープが必要です。 https://www.googleapis.com/auth/chat.admin.spaces.readonly https://www.googleapis.com/auth/chat.admin.spaces リクエストでは、use_admin_access を true に設定します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/chat.admin.spaces https://www.googleapis.com/auth/chat.admin.spaces.readonly 詳しくは、承認ガイドをご覧ください。

SetUpSpace

rpc SetUpSpace(SetUpSpaceRequest) returns (Space) スペースを作成し、指定したユーザーを追加します。呼び出し元のユーザーは自動的にスペースに追加されるため、リクエストでメンバーシップとして指定しないでください。例については、初期メンバーを含むスペースを設定するをご覧ください。 追加するユーザー メンバーを指定するには、適切な membership.member.name を使用してメンバーシップを追加します。人間のユーザーを追加するには、users/{user} を使用します。ここで、{user} はユーザーのメールアドレスにできます。同じ Workspace 組織内のユーザーの場合、{user} は People API の人物の id、または Directory API のユーザーの id にすることもできます。たとえば、[e-mail] の People API の人物プロファイル ID が 123456789 の場合、membership.member.name を users/[e-mail] または users/123456789 に設定することで、ユーザーをスペースに追加できます。 追加する Google グループを指定するには、適切な membership.group_member.name を使用してメンバーシップを追加します。Google グループを追加または招待するには、groups/{group} を使用します。ここで、{group} は Cloud Identity Groups API のグループの id です。たとえば、Cloud Identity Groups lookup API を使用してグループ メール [e-mail] の ID 123456789 を取得し、membership.group_member.name を groups/123456789 に設定してグループをスペースに追加できます。グループ メールはサポートされていません。Google グループは、名前付きスペースのメンバーとしてのみ追加できます。 名前付きスペースまたはグループ チャットの場合、発信者が一部のメンバーをブロックしている、または一部のメンバーにブロックされている、または一部のメンバーを追加する権限がない場合、それらのメンバーは作成されたスペースに追加されません。 通話中のユーザーと別のユーザー間のダイレクト メッセージ（DM）を作成するには、ユーザーを表すメンバーシップを 1 つだけ指定します。一方のユーザーが他方のユーザーをブロックしている場合、リクエストは失敗し、DM は作成されません。 通話中のユーザーと通話中のアプリの間に DM を作成するには、Space.singleUserBotDm を true に設定し、メンバーシップを指定しないでください。このメソッドを使用して設定できるのは、通話アプリとの DM のみです。通話アプリをスペースのメンバーとして追加したり、2 人のユーザー間の既存の DM に追加したりするには、スペースにユーザーまたはアプリを招待または追加するをご覧ください。 2 人のユーザー間に DM がすでに存在する場合、リクエストの作成時に一方のユーザーが他方のユーザーをブロックしていても、既存の DM が返されます。 スレッド返信のあるスペースはサポートされていません。スペースの設定時に ALREADY_EXISTS というエラー メッセージが表示された場合は、別の displayName を試してください。Google Workspace 組織内の既存のスペースで、この表示名がすでに使用されている可能性があります。 次のいずれかの認可スコープによるユーザー認証が必要です。 https://www.googleapis.com/auth/chat.spaces.create https://www.googleapis.com/auth/chat.spaces 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/chat.spaces https://www.googleapis.com/auth/chat.spaces.create 詳しくは、承認ガイドをご覧ください。

UpdateMembership

rpc UpdateMembership(UpdateMembershipRequest) returns (Membership) メンバーシップを更新します。例については、スペース内のユーザーのメンバーシップを更新するをご覧ください。 次のタイプの認証をサポートしています。 デベロッパー プレビューの管理者による承認を使用したアプリ認証と、承認スコープ: https://www.googleapis.com/auth/chat.app.memberships（アプリが作成したスペースのみ） 次のいずれかの認可スコープを使用したユーザー認証: https://www.googleapis.com/auth/chat.memberships https://www.googleapis.com/auth/chat.import（インポート モードのスペースのみ） ユーザー認証では、管理者アカウントが認証され、use_admin_access が true で、次の認可スコープが使用されている場合に、管理者権限が付与されます。 https://www.googleapis.com/auth/chat.admin.memberships 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/chat.app.memberships https://www.googleapis.com/auth/chat.admin.memberships https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.memberships 詳しくは、承認ガイドをご覧ください。

UpdateMessage

rpc UpdateMessage(UpdateMessageRequest) returns (Message) メッセージを更新します。patch メソッドと update メソッドには違いがあります。patch メソッドは patch リクエストを使用し、update メソッドは put リクエストを使用します。patch メソッドを使用することをおすすめします。例については、メッセージを更新するをご覧ください。 次のタイプの認証をサポートしています。 認可スコープを使用したアプリ認証: https://www.googleapis.com/auth/chat.bot 次のいずれかの認可スコープを使用したユーザー認証: https://www.googleapis.com/auth/chat.messages https://www.googleapis.com/auth/chat.import（インポート モードのスペースのみ） アプリ認証を使用する場合、リクエストで更新できるのは、呼び出し元の Chat 用アプリによって作成されたメッセージのみです。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/chat.bot https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.messages 詳しくは、承認ガイドをご覧ください。

UpdateSpace

rpc UpdateSpace(UpdateSpaceRequest) returns (Space) スペースを更新します。例については、スペースを更新するをご覧ください。 displayName フィールドを更新して ALREADY_EXISTS というエラー メッセージが表示された場合は、別の表示名を試してください。Google Workspace 組織内の既存のスペースで、この表示名がすでに使用されている可能性があります。 次のタイプの認証をサポートしています。 デベロッパー プレビューで管理者による承認を伴うアプリ認証と、次のいずれかの認可スコープ: https://www.googleapis.com/auth/chat.app.spaces 次のいずれかの認可スコープを使用したユーザー認証: https://www.googleapis.com/auth/chat.spaces https://www.googleapis.com/auth/chat.import（インポート モードのスペースのみ） ユーザー認証では、管理者アカウントが認証され、use_admin_access が true で、次の認可スコープが使用されている場合に、管理者権限が付与されます。 https://www.googleapis.com/auth/chat.admin.spaces アプリ認証には次の制限があります。 space.predefined_permission_settings または space.permission_settings を更新するには、アプリがスペースの作成者である必要があります。 アプリ認証では space.access_settings.audience の更新はサポートされていません。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/chat.app.spaces https://www.googleapis.com/auth/chat.admin.spaces https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.spaces 詳しくは、承認ガイドをご覧ください。

UpdateSpaceNotificationSetting
rpc UpdateSpaceNotificationSetting(UpdateSpaceNotificationSettingRequest) returns (SpaceNotificationSetting) スペースの通知設定を更新します。例については、呼び出し元のスペース通知設定を更新するをご覧ください。 認可スコープを使用したユーザー認証が必要です。 https://www.googleapis.com/auth/chat.users.spacesettings 認可スコープ 次の OAuth スコープが必要です。 https://www.googleapis.com/auth/chat.users.spacesettings 詳しくは、承認ガイドをご覧ください。

UpdateSpaceReadState
rpc UpdateSpaceReadState(UpdateSpaceReadStateRequest) returns (SpaceReadState) スペース内のユーザーの既読状態を更新します。既読メッセージと未読メッセージを識別するために使用されます。例については、ユーザーのスペースの読み取り状態を更新するをご覧ください。 認可スコープを使用したユーザー認証が必要です。 https://www.googleapis.com/auth/chat.users.readstate 認可スコープ 次の OAuth スコープが必要です。 https://www.googleapis.com/auth/chat.users.readstate 詳しくは、承認ガイドをご覧ください。

AccessoryWidget

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

フィールド
共用体フィールド action。アクションのタイプ。action は次のいずれかになります。
button_list	ButtonList ボタンのリスト。

ActionResponse

Chat 用アプリがレスポンスの投稿方法を構成するために使用できるパラメータ。

フィールド
type	ResponseType 入力のみのChat 用アプリのレスポンスのタイプ。
url	string 入力のみのユーザーが認証または構成を行うための URL。（REQUEST_CONFIG レスポンス タイプの場合のみ）。
dialog_action	DialogAction 入力のみのダイアログに関連するインタラクション イベントへのレスポンス。ResponseType.Dialog を伴う必要があります。
updated_widget	UpdatedWidget 入力のみの更新されたウィジェットのレスポンス。

ResponseType

Chat 用アプリのレスポンスのタイプ。

列挙型
TYPE_UNSPECIFIED	NEW_MESSAGE として処理されるデフォルトの型。
NEW_MESSAGE	トピックに新しいメッセージとして投稿します。
UPDATE_MESSAGE	Chat 用アプリのメッセージを更新します。これは、メッセージ送信者のタイプが BOT である CARD_CLICKED イベントでのみ許可されます。
UPDATE_USER_MESSAGE_CARDS	ユーザーのメッセージのカードを更新します。これは、一致する URL を含む MESSAGE イベント、またはメッセージ送信者のタイプが HUMAN の CARD_CLICKED イベントに対するレスポンスとしてのみ許可されます。テキストは無視されます。
REQUEST_CONFIG	ユーザーに追加の認証や構成を非公開で求めます。
DIALOG	ダイアログを表示します。
UPDATE_WIDGET	ウィジェット テキストの予測入力オプションのクエリ。

SelectionItems

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

フィールド
items[]	SelectionItem SelectionItem オブジェクトの配列。

UpdatedWidget

selectionInput ウィジェットの場合、マルチセレクト メニューの予測入力候補を返します。

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

ActionStatus

ダイアログの呼び出しまたは送信のリクエストのステータスを表します。

フィールド
status_code	Code ステータス コード。
user_facing_message	string リクエストのステータスについてユーザーに送信するメッセージ。設定されていない場合は、status_code に基づく一般的なメッセージが送信されます。

メモ

出力専用。メッセージのプレーン テキストの本文に関連付けられたアノテーション。テキスト メッセージに基本的な書式を追加するには、テキスト メッセージの書式を設定するをご覧ください。

プレーン テキストのメッセージ本文の例:

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	AnnotationType このアノテーションのタイプ。
length	int32 このアノテーションに対応するプレーン テキスト メッセージ本文のサブ文字列の長さ。
start_index	int32 このアノテーションに対応するプレーン テキスト メッセージ本文の開始インデックス（0 ベース、両端を含む）。
共用体フィールド metadata。アノテーションに関する追加のメタデータ。metadata は次のいずれかになります。
user_mention	UserMentionMetadata ユーザーメンションのメタデータ。
slash_command	SlashCommandMetadata スラッシュ コマンドのメタデータ。
rich_link_metadata	RichLinkMetadata リッチリンクのメタデータ。
custom_emoji_metadata	CustomEmojiMetadata カスタム絵文字のメタデータ。

AnnotationType

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

列挙型
ANNOTATION_TYPE_UNSPECIFIED	列挙型のデフォルト値。使用しないでください。
USER_MENTION	ユーザーがメンションされている。
SLASH_COMMAND	スラッシュ コマンドが呼び出されます。
RICH_LINK	リッチリンク アノテーション。
CUSTOM_EMOJI	カスタム絵文字のアノテーション。

AppCommandMetadata

Chat 用アプリのコマンドに関するメタデータ。

フィールド
app_command_id	int32 Chat API 構成で指定されたコマンドの ID。
app_command_type	AppCommandType Chat 用アプリのコマンドのタイプ。

AppCommandType

Chat 用アプリのコマンドのタイプ。詳しくは、Chat 用アプリのコマンドの種類をご覧ください。

列挙型
APP_COMMAND_TYPE_UNSPECIFIED	デフォルト値。（指定なし）
SLASH_COMMAND	スラッシュ コマンド。ユーザーが Chat メッセージでコマンドを送信します。
QUICK_COMMAND	クイック コマンド。ユーザーがメッセージの返信欄の Chat メニューからコマンドを選択します。

AttachedGif

URL で指定された GIF 画像。

フィールド
uri	string 出力専用。GIF 画像をホストする URL。

添付ファイル

Google Chat の添付ファイル。

フィールド
name	string 省略可。添付ファイルのリソース名（spaces/{space}/messages/{message}/attachments/{attachment} 形式）。
content_name	string 出力専用。コンテンツの元のファイル名（フルパスではない）。
content_type	string 出力専用。ファイルのコンテンツ タイプ（MIME タイプ）。
thumbnail_uri	string 出力専用。添付ファイルをユーザーにプレビューするために使用するサムネイルの URL。チャットアプリは、この URL を使用して添付ファイルのコンテンツをダウンロードしないでください。
download_uri	string 出力専用。人間が添付ファイルをダウンロードできるようにするために使用する必要があるダウンロード URL。チャットアプリは、この URL を使用して添付ファイルのコンテンツをダウンロードしないでください。
source	Source 出力専用。添付ファイルのソース。
共用体フィールド data_ref。添付ファイルへのデータ参照。data_ref は次のいずれかになります。
attachment_data_ref	AttachmentDataRef 省略可。添付ファイル データへの参照。このフィールドは、添付ファイル付きのメッセージを作成または更新する場合、またはメディア API を使用して添付ファイル データをダウンロードする場合に使用されます。
drive_data_ref	DriveDataRef 出力専用。Google ドライブの添付ファイルへの参照。このフィールドは Google Drive API で使用されます。

ソース

添付ファイルのソース。

列挙型
SOURCE_UNSPECIFIED	予約済み。
DRIVE_FILE	ファイルが Google ドライブのファイルである。
UPLOADED_CONTENT	ファイルが Chat にアップロードされます。

AttachmentDataRef

添付ファイル データへの参照。

フィールド
resource_name	string 省略可。添付ファイルデータのリソース名。このフィールドは、メディア API で添付ファイル データをダウンロードするために使用されます。
attachment_upload_token	string 省略可。アップロードされた添付ファイルへの参照を含む不透明なトークン。クライアントによって不透明な文字列として扱われ、添付ファイル付きの Chat メッセージの作成または更新に使用されます。

CardWithId

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

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

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

カードビルダーを開く

フィールド
card_id	string メッセージに複数のカードが含まれている場合は必須です。メッセージ内のカードの一意の識別子。
card	Card カード。最大サイズは 32 KB です。

ChatSpaceLinkData

Chat スペースのリンクのデータ。

フィールド
space	string リンクされた Chat スペース リソースのスペース。 形式: spaces/{space}
thread	string リンクされた Chat スペース リソースのスレッド。 形式: spaces/{space}/threads/{thread}
message	string リンクされた Chat スペース リソースのメッセージ。 形式: spaces/{space}/messages/{message}

CompleteImportSpaceRequest

スペースのインポート プロセスを完了するためのリクエスト メッセージ。

フィールド
name	string 必須。インポート モードのスペースのリソース名。 形式: spaces/{space}

CompleteImportSpaceResponse

スペースのインポート プロセスを完了するためのレスポンス メッセージ。

フィールド
space	Space インポート モードのスペース。

ContextualAddOnMarkup

この型にはフィールドがありません。

コンテキスト アドオンのコンテンツを指定するためのデベロッパー向けのマークアップ。

カード

カードは、テキストや画像などの UI ウィジェットを含むことができる UI 要素です。

フィールド
header	CardHeader カードのヘッダー。ヘッダーには通常、タイトルと画像が含まれます。
sections[]	Section セクションは分割線で区切ります。
card_actions[]	CardAction このカードのアクション。
name	string カードの名前。

CardAction

カード アクションは、カードに関連付けられたアクションです。請求書カードの場合、一般的なアクションは、請求書の削除、請求書のメール送信、ブラウザでの請求書のオープンなどです。

Google Chat アプリではサポートされていません。

フィールド
action_label	string ラベルはアクション メニュー項目に表示されていました。
on_click	OnClick このアクション アイテムの onclick アクション。

CardHeader

フィールド
title	string タイトルを指定する必要があります。ヘッダーの高さは固定されています。タイトルとサブタイトルの両方が指定されている場合、それぞれ 1 行を占有します。タイトルのみが指定されている場合は、両方の行が使用されます。
subtitle	string カード ヘッダーのサブタイトル。
image_style	ImageStyle 画像のタイプ（正方形の枠線や円形の枠線など）。
image_url	string カードのヘッダーにある画像の URL。

ImageStyle

列挙型
IMAGE_STYLE_UNSPECIFIED
IMAGE	正方形の枠線。
AVATAR	円形の枠線。

セクション

セクションには、指定された順序で（縦方向に）レンダリングされるウィジェットのコレクションが含まれています。すべてのプラットフォームで、カードの幅は固定されています。そのため、現時点ではレイアウト プロパティ（float など）は必要ありません。

フィールド
header	string セクションのヘッダー。書式設定されたテキストがサポートされています。テキストの書式設定について詳しくは、Google Chat アプリでテキストの書式を設定すると Google Workspace アドオンでテキストの書式を設定するをご覧ください。
widgets[]	WidgetMarkup セクションには少なくとも 1 つのウィジェットを含める必要があります。

CreateCustomEmojiRequest

カスタム絵文字を作成するリクエスト。

フィールド
custom_emoji	CustomEmoji 必須。作成するカスタム絵文字。

CreateMembershipRequest

メンバーシップの作成リクエスト メッセージ。

フィールド
parent	string 必須。メンバーシップを作成する Space のリソース名。 形式: spaces/{space}
membership	Membership 必須。作成するメンバーシップ リレーション。 memberType フィールドには、user.name フィールドと user.type フィールドが入力されたユーザーを含める必要があります。サーバーはリソース名を割り当て、指定されたものをすべて上書きします。 Chat 用アプリが人間のユーザーのメンバーシップ関係を作成する場合は、特定の認証スコープを使用し、特定のフィールドに特定の値が設定されている必要があります。 ユーザーとして認証する場合は、chat.memberships 承認スコープが必要です。 アプリとして認証する場合は、chat.app.memberships 認可スコープが必要です。アプリとしての認証は、 デベロッパー プレビュー: Google Workspace デベロッパー プレビュー プログラムの一部として利用できます。このプログラムでは、特定の機能にいち早くアクセスできます。 user.type を HUMAN に設定し、user.name を users/{user} 形式で設定します。ここで、{user} はユーザーのメールアドレスにできます。同じ Workspace 組織内のユーザーの場合、{user} は People API の person の id、または Directory API のユーザーの id にすることもできます。たとえば、[e-mail] の People API の人物プロファイル ID が 123456789 の場合、membership.member.name を users/[e-mail] または users/123456789 に設定することで、ユーザーをスペースに追加できます。 スペースを所有する Workspace 組織外のユーザーを招待するには、ユーザー認証が必要です。 Chat 用アプリがメンバーシップ関係を自身のために作成する場合は、ユーザーとして認証し、chat.memberships.app スコープを使用し、user.type を BOT に設定し、user.name を users/app に設定する必要があります。
use_admin_access	bool 省略可。true の場合、メソッドはユーザーの Google Workspace 管理者権限を使用して実行されます。 呼び出しユーザーは、Chat とスペースの会話を管理する権限を持つ Google Workspace 管理者である必要があります。 chat.admin.memberships OAuth 2.0 スコープが必要です。 管理者権限を使用して、アプリのメンバーシップを作成したり、管理者の Google Workspace 組織外のユーザーのメンバーシップを作成したりすることはできません。

CreateMessageRequest

メッセージを作成します。

フィールド
parent	string 必須。メッセージを作成するスペースのリソース名。 形式: spaces/{space}
message	Message 必須。メッセージの本文。
thread_key (deprecated)	string この項目は非推奨です。 省略可。非推奨: 代わりに、thread.thread_key を使用してください。スレッドの ID。最大 4,000 文字までサポートします。スレッドを開始または追加するには、メッセージを作成して threadKey または thread.name を指定します。使用例については、メッセージ スレッドを開始する、または返信するをご覧ください。
request_id	string 省略可。このメッセージの一意のリクエスト ID。既存のリクエスト ID を指定すると、新しいメッセージが作成されるのではなく、その ID で作成されたメッセージが返されます。
message_reply_option	MessageReplyOption 省略可。メッセージがスレッドを開始するか、スレッドに返信するかを指定します。名前付きスペースでのみサポートされます。 ユーザー インタラクションに応答する場合、このフィールドは無視されます。スレッド内のやり取りの場合、返信は同じスレッドに作成されます。それ以外の場合は、返信は新しいスレッドとして作成されます。
message_id	string 省略可。メッセージのカスタム ID。Chat 用アプリが、メッセージのリソース名（メッセージの name フィールドで表される）にシステム割り当て ID を保存することなく、メッセージを取得、更新、削除できるようにします。 このフィールドの値は、次の要件を満たす必要があります。 client- で始まります。たとえば、client-custom-name は有効なカスタム ID ですが、custom-name は無効です。 63 文字以下で、小文字、数字、ハイフンのみが含まれます。 スペース内で一意である。Chat 用アプリで、異なるメッセージに同じカスタム ID を使用することはできません。 詳しくは、メッセージに名前を付けるをご覧ください。

MessageReplyOption

メッセージに返信する方法を指定します。今後、さらに多くの状態が追加される可能性があります。

列挙型
MESSAGE_REPLY_OPTION_UNSPECIFIED	デフォルト。新しいスレッドを開始します。このオプションを使用すると、含まれている thread ID または thread_key は無視されます。
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD	thread ID または thread_key で指定されたスレッドへの返信としてメッセージを作成します。失敗した場合は、代わりに新しいスレッドが開始されます。
REPLY_MESSAGE_OR_FAIL	thread ID または thread_key で指定されたスレッドへの返信としてメッセージを作成します。新しい thread_key が使用されると、新しいスレッドが作成されます。メッセージの作成に失敗すると、代わりに NOT_FOUND エラーが返されます。

CreateReactionRequest

メッセージに対するリアクションを作成します。

フィールド
parent	string 必須。リアクションが作成されたメッセージ。 形式: spaces/{space}/messages/{message}
reaction	Reaction 必須。作成するリアクション。

CreateSpaceRequest

メンバーのいない名前空間を作成するリクエスト。

フィールド
space	Space 必須。displayName フィールドと spaceType フィールドに値を設定する必要があります。SpaceType.SPACE と SpaceType.GROUP_CHAT のみがサポートされています。SpaceType.GROUP_CHAT は、importMode が true に設定されている場合にのみ使用できます。 エラー メッセージ ALREADY_EXISTS が表示された場合は、別の displayName を試してください。Google Workspace 組織内の既存のスペースで、この表示名がすでに使用されている可能性があります。 スペース name はサーバーで割り当てられるため、このフィールドで指定された内容はすべて無視されます。
request_id	string 省略可。このリクエストの一意の識別子。ランダムな UUID をおすすめします。既存のリクエスト ID を指定すると、新しいスペースが作成されるのではなく、その ID で作成されたスペースが返されます。同じ Chat 用アプリの既存のリクエスト ID を別の認証済みユーザーで指定すると、エラーが返されます。

CustomEmoji

カスタム絵文字を表します。

フィールド
name	string ID。サーバーによって割り当てられたカスタム絵文字のリソース名。 形式: customEmojis/{customEmoji}
uid	string 出力専用。カスタム絵文字リソースの一意のキー。
emoji_name	string 省略可。変更不可。ユーザーが指定したカスタム絵文字の名前。組織内で一意です。 カスタム絵文字の作成時に必須。それ以外の場合は出力専用。 絵文字の名前はコロンで始まり、コロンで終わる必要があります。また、小文字で、英数字、ハイフン、アンダースコアのみを使用できます。なお、ハイフンとアンダースコアは単語を区切る目的にのみ使用してください。これらを連続して使用することはできません。 例: :valid-emoji-name:
temporary_image_uri	string 出力専用。カスタム絵文字の一時的な画像 URL。有効期間は 10 分以上です。カスタム絵文字の作成時に、この値はレスポンスに設定されません。
payload	CustomEmojiPayload 省略可。入力のみのペイロード データ。カスタム絵文字の作成時に必要です。

CustomEmojiPayload

カスタム絵文字のペイロード データ。

フィールド
file_content	bytes 必須。入力のみのカスタム絵文字に使用される画像。 ペイロードは 256 KB 未満、画像のサイズは正方形で 64 ～ 500 ピクセルにする必要があります。制限は変更される可能性があります。
filename	string 必須。入力のみの画像ファイル名。 サポートされているファイル拡張子: .png、.jpg、.gif。

CustomEmojiMetadata

カスタム絵文字のアノテーション メタデータ。

フィールド
custom_emoji	CustomEmoji カスタム絵文字。

DeleteCustomEmojiRequest

カスタム絵文字の削除リクエスト。

フィールド
name	string 必須。削除するカスタム絵文字のリソース名。 形式: customEmojis/{customEmoji} 絵文字の名前を {customEmoji} のエイリアスとして使用できます。たとえば、customEmojis/:example-emoji:（ここで、:example-emoji: はカスタム絵文字の絵文字名）。

DeleteMembershipRequest

スペースのメンバーシップを削除するリクエスト。

フィールド
name	string 必須。削除するメンバーシップのリソース名。Chat 用アプリは、人間のユーザーのメンバーシップまたは自身のメンバーシップを削除できます。Chat 用アプリは、他のアプリのメンバーシップを削除できません。 ユーザー メンバーシップを削除する場合は、ユーザー認証の chat.memberships スコープ、またはアプリ認証の chat.memberships.app スコープと spaces/{space}/members/{member} 形式が必要です。このメールアドレスを {member} のエイリアスとして使用できます。たとえば、spaces/{space}/members/[e-mail]（[e-mail] は Google Chat ユーザーのメールアドレス）。 アプリ メンバーシップを削除する場合は、chat.memberships.app スコープと spaces/{space}/members/app 形式が必要です。 形式: spaces/{space}/members/{member} または spaces/{space}/members/app。
use_admin_access	bool 省略可。true の場合、メソッドはユーザーの Google Workspace 管理者権限を使用して実行されます。 呼び出しユーザーは、Chat とスペースの会話を管理する権限を持つ Google Workspace 管理者である必要があります。 chat.admin.memberships OAuth 2.0 スコープが必要です。 管理アクセスを使用してスペース内のアプリ メンバーシップを削除することはできません。

DeleteMessageRequest

メッセージの削除リクエスト。

フィールド
name	string 必須。メッセージのリソース名。 形式: spaces/{space}/messages/{message} メッセージにカスタム ID を設定している場合は、{message} に clientAssignedMessageId フィールドの値を使用できます。詳しくは、メッセージに名前を付けるをご覧ください。
force	bool 省略可。true の場合、メッセージを削除すると、そのスレッドの返信も削除されます。false の場合、メッセージにスレッド化された返信があると、削除は失敗します。 ユーザーとして認証する場合にのみ適用されます。Chat 用アプリとして認証する場合は無効です。

DeleteReactionRequest

メッセージに対するリアクションを削除します。

フィールド
name	string 必須。削除するリアクションの名前。 形式: spaces/{space}/messages/{message}/reactions/{reaction}

DeleteSpaceRequest

スペースの削除リクエスト。

フィールド
name	string 必須。削除するスペースのリソース名。 形式: spaces/{space}
use_admin_access	bool 省略可。true の場合、メソッドはユーザーの Google Workspace 管理者権限を使用して実行されます。 呼び出しユーザーは、Chat とスペースの会話を管理する権限を持つ Google Workspace 管理者である必要があります。 chat.admin.delete OAuth 2.0 スコープが必要です。

DeletionMetadata

削除されたメッセージに関する情報。delete_time が設定されている場合、メッセージは削除されます。

フィールド
deletion_type	DeletionType メッセージを削除したユーザーを示します。

DeletionType

メッセージを削除したユーザーと削除方法。今後、値が追加される可能性があります。メッセージを削除できるタイミングについて詳しくは、Google Chat でメッセージを編集、削除するをご覧ください。

列挙型
DELETION_TYPE_UNSPECIFIED	この値は使用されません。
CREATOR	ユーザーが自分のメッセージを削除した。
SPACE_OWNER	スペースの管理者がメッセージを削除しました。
ADMIN	Google Workspace 管理者がメッセージを削除しました。管理者は、スペース内のすべてのメッセージ（スペースのメンバーや Chat 用アプリが送信したメッセージを含む）を削除できます。
APP_MESSAGE_EXPIRY	Chat 用アプリが有効期限切れのメッセージを削除しました。
CREATOR_VIA_APP	Chat 用アプリが作成者に代わって（ユーザー認証を使用して）メッセージを削除しました。
SPACE_OWNER_VIA_APP	Chat 用アプリがスペースの管理者に代わってメッセージを削除しました（ユーザー認証を使用）。
SPACE_MEMBER	スペースのメンバーがメッセージを削除しました。ユーザーはアプリから送信されたメッセージを削除できます。

ダイアログ

ダイアログのカード本文のラッパー。

フィールド
body	Card 入力のみのダイアログの本文。モーダルでレンダリングされます。Google Chat アプリは、DateTimePicker、OnChangeAction のカード エンティティをサポートしていません。

DialogAction

ダイアログとリクエスト ステータス コードが含まれます。

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

DriveDataRef

ドライブの添付ファイルのデータへの参照。

フィールド
drive_file_id	string ドライブ ファイルの ID。Drive API とともに使用します。

DriveLinkData

Google ドライブのリンクのデータ。

フィールド
drive_data_ref	DriveDataRef Google ドライブ ファイルを参照する DriveDataRef。
mime_type	string リンクされた Google ドライブ リソースの MIME タイプ。

絵文字

メッセージへのリアクションとして使用される絵文字。

フィールド
共用体フィールド content。必須。絵文字の内容。content は次のいずれかになります。
unicode	string 省略可。Unicode 文字列で表される基本的な絵文字。
custom_emoji	CustomEmoji カスタム絵文字。

EmojiReactionSummary

特定の絵文字でメッセージにリアクションしたユーザーの数。

フィールド
emoji	Emoji 出力専用。リアクションに関連付けられた絵文字。
reaction_count	int32 出力専用。関連付けられた絵文字を使用したリアクションの合計数。

FindDirectMessageRequest

ユーザー リソースに基づいてダイレクト メッセージ スペースを取得するリクエスト。

フィールド
name	string 必須。ダイレクト メッセージを検索するユーザーのリソース名。 形式: users/{user}。ここで、{user} は People API の person の id、または Directory API の user の id のいずれかです。たとえば、People API のプロフィール ID が 123456789 の場合、name として users/123456789 を使用して、そのユーザーとのダイレクト メッセージを見つけることができます。ユーザーとして認証されると、メールアドレスを {user} のエイリアスとして使用できます。たとえば、users/[e-mail]（[e-mail] は Google Chat ユーザーのメールアドレス）。

GetAttachmentRequest

添付ファイルを取得するリクエスト。

フィールド
name	string 必須。添付ファイルのリソース名（spaces/{space}/messages/{message}/attachments/{attachment} 形式）。

GetCustomEmojiRequest

単一のカスタム絵文字を返すリクエスト。

フィールド
name	string 必須。カスタム絵文字のリソース名。 形式: customEmojis/{customEmoji} 絵文字の名前を {customEmoji} のエイリアスとして使用できます。たとえば、customEmojis/:example-emoji:（ここで、:example-emoji: はカスタム絵文字の絵文字名）。

GetMembershipRequest

スペースのメンバーシップを取得するリクエスト。

フィールド
name	string 必須。取得するメンバーシップのリソース名。 ユーザー認証を使用してアプリ独自のメンバーシップを取得するには、必要に応じて spaces/{space}/members/app を使用できます。 形式: spaces/{space}/members/{member} または spaces/{space}/members/app ユーザーのメールアドレスを {member} のエイリアスとして使用できます。たとえば、spaces/{space}/members/[e-mail]（[e-mail] は Google Chat ユーザーのメールアドレス）。
use_admin_access	bool 省略可。true の場合、メソッドはユーザーの Google Workspace 管理者権限を使用して実行されます。 呼び出しユーザーは、Chat とスペースの会話を管理する権限を持つ Google Workspace 管理者である必要があります。 chat.admin.memberships または chat.admin.memberships.readonly OAuth 2.0 スコープが必要です。 管理者アクセスを使用している場合、スペース内のアプリ メンバーシップの取得はサポートされていません。

GetMessageRequest

メッセージを取得するリクエスト。

フィールド
name	string 必須。メッセージのリソース名。 形式: spaces/{space}/messages/{message} メッセージにカスタム ID を設定している場合は、{message} に clientAssignedMessageId フィールドの値を使用できます。詳しくは、メッセージに名前を付けるをご覧ください。

GetSpaceEventRequest

スペース イベントを取得するためのリクエスト メッセージ。

フィールド
name	string 必須。スペース イベントのリソース名。 形式: spaces/{space}/spaceEvents/{spaceEvent}

GetSpaceNotificationSettingRequest

スペースの通知設定を取得するリクエスト メッセージ。呼び出しユーザーの通知設定の取得のみをサポートします。

フィールド
name	string 必須。形式: users/{user}/spaces/{space}/spaceNotificationSetting users/me/spaces/{space}/spaceNotificationSetting、または users/[e-mail]/spaces/{space}/spaceNotificationSetting、または users/123456789/spaces/{space}/spaceNotificationSetting。注: パスには呼び出し元のユーザー ID またはメールアドレスのみを指定できます。

GetSpaceReadStateRequest

GetSpaceReadState API のリクエスト メッセージ。

フィールド
name	string 必須。取得するスペースの読み取り状態のリソース名。 呼び出し元ユーザーの読み取り状態の取得のみをサポートします。 呼び出し元ユーザーを参照するには、次のいずれかを設定します。 me エイリアス。例: users/me/spaces/{space}/spaceReadState Workspace のメールアドレス。例: users/[e-mail]/spaces/{space}/spaceReadState ユーザー ID。例: users/123456789/spaces/{space}/spaceReadState 形式: users/{user}/spaces/{space}/spaceReadState

GetSpaceRequest

単一のスペースを返すリクエスト。

フィールド
name	string 必須。スペースのリソース名（spaces/{space} 形式）。 形式: spaces/{space}
use_admin_access	bool 省略可。true の場合、メソッドはユーザーの Google Workspace 管理者権限を使用して実行されます。 呼び出しユーザーは、Chat とスペースの会話を管理する権限を持つ Google Workspace 管理者である必要があります。 chat.admin.spaces または chat.admin.spaces.readonly OAuth 2.0 スコープが必要です。

GetThreadReadStateRequest

GetThreadReadStateRequest API のリクエスト メッセージ。

フィールド
name	string 必須。取得するスレッドの読み取り状態のリソース名。 呼び出し元ユーザーの読み取り状態の取得のみをサポートします。 呼び出し元ユーザーを参照するには、次のいずれかを設定します。 me エイリアス。例: users/me/spaces/{space}/threads/{thread}/threadReadState Workspace のメールアドレス。例: users/[e-mail]/spaces/{space}/threads/{thread}/threadReadState ユーザー ID。例: users/123456789/spaces/{space}/threads/{thread}/threadReadState 形式: users/{user}/spaces/{space}/threads/{thread}/threadReadState

グループ

Google Chat の Google グループ。

フィールド
name	string Google グループのリソース名。 Cloud Identity Groups API のグループを表します。 形式: groups/{group}

HistoryState

メッセージとスペースの履歴の状態。メッセージと会話スレッドが作成後に保持される期間を指定します。

列挙型
HISTORY_STATE_UNSPECIFIED	デフォルト値。使用しないでください。
HISTORY_OFF	履歴がオフになっています。メッセージとスレッドは 24 時間保持されます。
HISTORY_ON	履歴がオンになっています。組織の Vault の保持ルールで、メッセージとスレッドの保持期間を指定します。

ListCustomEmojisRequest

カスタム絵文字のリストを返すリクエスト。

フィールド
page_size	int32 省略可。返されるカスタム絵文字の最大数。サービスが返すカスタム絵文字の数は、この値よりも少ないことがあります。指定しない場合、デフォルト値は 25 です。最大値は 200 です。200 を超える値は 200 に変更されます。
page_token	string 省略可。（前のクエリから再開する場合）。 前回のカスタム絵文字のリスト呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。 ページ分割を行う場合、フィルタ値はページトークンを提供した呼び出しと一致する必要があります。別の値を渡すと、予期しない結果が生じる可能性があります。
filter	string 省略可。クエリフィルタ。 クリエイターによるフィルタリングをサポートします。 作成者でフィルタするには、有効な値を指定する必要があります。現在、カスタム絵文字をフィルタして、通話中のユーザーが作成したかどうかを確認できるのは、creator("users/me") と NOT creator("users/me") のみです。 たとえば、次のクエリは、呼び出し元が作成したカスタム絵文字を返します。 creator("users/me") 無効なクエリは INVALID_ARGUMENT エラーで拒否されます。

ListCustomEmojisResponse

カスタム絵文字のリストに対するレスポンス。

フィールド
custom_emojis[]	CustomEmoji 順序なしリスト。カスタム絵文字のリスト。
next_page_token	string 結果の次のページを取得するために pageToken として送信できるトークン。空の場合、後続のページはありません。

ListMembershipsRequest

メンバーシップのリストを取得するためのリクエスト メッセージ。

フィールド
parent	string 必須。メンバーシップ リストを取得するスペースのリソース名。 形式: spaces/{space}
page_size	int32 省略可。返すメンバーシップの最大数。サービスが返す値はこれよりも少ないことがあります。 指定されていない場合は、最大で 100 件のメンバーシップが返されます。 最大値は 1000 です。1000 を超える値を使用すると、自動的に 1000 に変更されます。 負の値は INVALID_ARGUMENT エラーを返します。
page_token	string 省略可。メンバーシップの一覧を取得する前の呼び出しで受け取ったページトークン。後続のページを取得するには、このパラメータを指定します。 ページネーションを行う場合、指定する他のすべてのパラメータは、ページトークンを受け取った呼び出しと一致している必要があります。他のパラメータに異なる値を渡すと、予期しない結果が生じる可能性があります。
filter	string 省略可。クエリフィルタ。 メンバーシップは、メンバーのロール（role）とタイプ（member.type）でフィルタできます。 ロールでフィルタするには、role を ROLE_MEMBER または ROLE_MANAGER に設定します。 タイプでフィルタするには、member.type を HUMAN または BOT に設定します。!= 演算子を使用して member.type をフィルタすることもできます。 ロールとタイプの両方でフィルタするには、AND 演算子を使用します。ロールまたはタイプでフィルタするには、OR 演算子を使用します。 use_admin_access が true に設定されている場合は、member.type = "HUMAN" または member.type != "BOT" が必要です。他のメンバー タイプのフィルタは拒否されます。 たとえば、次のクエリは有効です。 role = "ROLE_MANAGER" OR role = "ROLE_MEMBER" member.type = "HUMAN" AND role = "ROLE_MANAGER" member.type != "BOT" 次のクエリは無効です。 member.type = "HUMAN" AND member.type = "BOT" role = "ROLE_MANAGER" AND role = "ROLE_MEMBER" 無効なクエリは、サーバーによって INVALID_ARGUMENT エラーで拒否されます。
show_groups	bool 省略可。true の場合、他のタイプのメンバーシップに加えて、Google Group に関連付けられたメンバーシップも返します。filter が設定されている場合、フィルタ条件に一致しない Google Group メンバーシップは返されません。
show_invited	bool 省略可。true の場合、他のタイプのメンバーシップに加えて、invited メンバーに関連付けられたメンバーシップも返します。フィルタが設定されている場合、フィルタ条件に一致しない invited メンバーシップは返されません。 現在、ユーザー認証が必要です。
use_admin_access	bool 省略可。true の場合、メソッドはユーザーの Google Workspace 管理者権限を使用して実行されます。 呼び出しユーザーは、Chat とスペースの会話を管理する権限を持つ Google Workspace 管理者である必要があります。 chat.admin.memberships.readonly または chat.admin.memberships OAuth 2.0 スコープが必要です。 管理者アクセスを使用している場合、スペース内のアプリ メンバーシップのリスト表示はサポートされていません。

ListMembershipsResponse

スペースのメンバーシップを一覧表示するレスポンス。

フィールド
memberships[]	Membership 順序なしリスト。リクエストされた（または最初の）ページのメンバーシップのリスト。
next_page_token	string 結果の次のページを取得するために pageToken として送信できるトークン。空の場合、後続のページはありません。

ListMessagesRequest

ユーザーがメンバーになっている指定されたスペース内のメッセージを一覧表示します。

フィールド
parent	string 必須。メッセージを一覧表示するスペースのリソース名。 形式: spaces/{space}
page_size	int32 省略可。返されるメッセージの最大数。サービスが返すメッセージの数は、この値よりも少ないことがあります。 指定されていない場合は、最大 25 個が返されます。 最大値は 1000 です。1000 を超える値を使用すると、自動的に 1000 に変更されます。 負の値は INVALID_ARGUMENT エラーを返します。
page_token	string 省略可。前のメッセージ一覧呼び出しから受け取ったページトークン。後続のページを取得するには、このパラメータを指定します。 ページネーションを行う場合、指定する他のすべてのパラメータは、ページトークンを受け取った呼び出しと一致している必要があります。他のパラメータに異なる値を渡すと、予期しない結果が生じる可能性があります。
filter	string 省略可。クエリフィルタ。 メッセージは、日付（create_time）とスレッド（thread.name）でフィルタできます。 作成日でメッセージをフィルタするには、RFC-3339 形式のタイムスタンプと二重引用符を使用して create_time を指定します。例: "2023-04-21T11:30:00-04:00"。大なり演算子 > を使用すると、タイムスタンプの後に作成されたメッセージを一覧表示できます。また、小なり演算子 < を使用すると、タイムスタンプの前に作成されたメッセージを一覧表示できます。時間間隔内のメッセージをフィルタするには、2 つのタイムスタンプの間に AND 演算子を使用します。 スレッドでフィルタするには、spaces/{space}/threads/{thread} 形式の thread.name を指定します。クエリごとに指定できる thread.name は 1 つだけです。 スレッドと日付の両方でフィルタするには、クエリで AND 演算子を使用します。 たとえば、次のクエリは有効です。 create_time > "2012-04-21T11:30:00-04:00" create_time > "2012-04-21T11:30:00-04:00" AND thread.name = spaces/AAAAAAAAAAA/threads/123 create_time > "2012-04-21T11:30:00+00:00" AND create_time < "2013-01-01T00:00:00+00:00" AND thread.name = spaces/AAAAAAAAAAA/threads/123 thread.name = spaces/AAAAAAAAAAA/threads/123 無効なクエリは、サーバーによって INVALID_ARGUMENT エラーで拒否されます。
order_by	string 省略可。メッセージのリストの順序。並べ替えオペレーションで並べ替える値を指定します。有効な順序付けオペレーションの値は次のとおりです。 昇順の場合は ASC。 降順の場合は DESC。 デフォルトの順序は create_time ASC です。
show_deleted	bool 省略可。削除されたメッセージを含めるかどうか。削除されたメッセージには、削除された日時と削除に関するメタデータが含まれますが、メッセージの内容は利用できません。

ListMessagesResponse

メッセージを一覧表示するためのレスポンス メッセージ。

フィールド
messages[]	Message メッセージのリスト。
next_page_token	string トークンを pageToken として送信すると、結果の次のページを取得できます。空の場合、後続のページはありません。

ListReactionsRequest

メッセージに対するリアクションを一覧表示します。

フィールド
parent	string 必須。ユーザーがリアクションしたメッセージ。 形式: spaces/{space}/messages/{message}
page_size	int32 省略可。返されるリアクションの最大数。サービスが返すリアクションの数は、この値よりも少ないことがあります。指定しない場合、デフォルト値は 25 です。最大値は 200 です。200 を超える値は 200 に変更されます。
page_token	string 省略可。（前のクエリから再開する場合）。 前回の list reactions 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。 ページ分割を行う場合、フィルタ値はページトークンを提供した呼び出しと一致する必要があります。別の値を渡すと、予期しない結果が生じる可能性があります。
filter	string 省略可。クエリフィルタ。 リアクションは、絵文字（emoji.unicode または emoji.custom_emoji.uid）とユーザー（user.name）でフィルタできます。 複数の絵文字またはユーザーのリアクションをフィルタするには、emoji.unicode = "🙂" OR emoji.unicode = "👍" や user.name = "users/AAAAAA" OR user.name = "users/BBBBBB" などの類似したフィールドを OR 演算子で結合します。 絵文字とユーザーでリアクションをフィルタするには、emoji.unicode = "🙂" AND user.name = "users/AAAAAA" などの AND 演算子を使用します。 クエリで AND と OR の両方を使用する場合は、括弧でグループ化します。 たとえば、次のクエリは有効です。 user.name = "users/{user}" emoji.unicode = "🙂" emoji.custom_emoji.uid = "{uid}" emoji.unicode = "🙂" OR emoji.unicode = "👍" emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" emoji.unicode = "🙂" AND user.name = "users/{user}" (emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}") AND user.name = "users/{user}" 次のクエリは無効です。 emoji.unicode = "🙂" AND emoji.unicode = "👍" emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "{uid}" emoji.unicode = "🙂" OR user.name = "users/{user}" emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" OR user.name = "users/{user}" emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" AND user.name = "users/{user}" 無効なクエリは INVALID_ARGUMENT エラーで拒否されます。

ListReactionsResponse

リアクションのリスト リクエストに対するレスポンス。

フィールド
reactions[]	Reaction リクエストされた（または最初の）ページにあるリアクションのリスト。
next_page_token	string 結果の次のページを取得するための継続トークン。結果の最後のページでは空になります。

ListSpaceEventsRequest

リスティング スペース イベントのリクエスト メッセージ。

フィールド
parent	string 必須。イベントが発生した Google Chat スペースのリソース名。 形式: spaces/{space}。
page_size	int32 省略可。返されるスペース イベントの最大数。サービスが返す値はこれよりも少ないことがあります。 負の値は INVALID_ARGUMENT エラーを返します。
page_token	string 省略可。前回の list space events 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。 ページネーションを行う場合、スペース イベントのリストに指定する他のすべてのパラメータは、ページトークンを受け取った呼び出しと一致している必要があります。他のパラメータに異なる値を渡すと、予期しない結果が生じる可能性があります。
filter	string 必須。クエリフィルタ。 has : 演算子を使用して、少なくとも 1 つのイベントタイプ（event_type）を指定する必要があります。複数のイベントタイプでフィルタするには、OR 演算子を使用します。フィルタでバッチ イベントタイプを省略します。リクエストは、関連するバッチイベントを自動的に返します。たとえば、新しいリアクション（google.workspace.chat.reaction.v1.created）でフィルタすると、サーバーは新しいリアクション イベントのバッチ（google.workspace.chat.reaction.v1.batchCreated）も返します。サポートされているイベントタイプのリストについては、SpaceEvents リファレンス ドキュメントをご覧ください。 必要に応じて、開始時間（start_time）と終了時間（end_time）でフィルタすることもできます。 start_time: スペース イベントのリストを開始する排他的タイムスタンプ。最大 28 日前までのイベントを一覧表示できます。指定しない場合は、過去 28 日間のスペース イベントが一覧表示されます。 end_time: スペース イベントが一覧表示されるまでの包括的なタイムスタンプ。指定しない場合、リクエストの時点までのイベントが一覧表示されます。 開始時刻または終了時刻を指定するには、等号 = 演算子を使用し、RFC-3339 形式で指定します。start_time と end_time の両方でフィルタするには、AND 演算子を使用します。 たとえば、次のクエリは有効です。 start_time="2023-08-23T19:20:33+00:00" AND end_time="2023-08-23T19:21:54+00:00" start_time="2023-08-23T19:20:33+00:00" AND (event_types:"google.workspace.chat.space.v1.updated" OR event_types:"google.workspace.chat.message.v1.created") 次のクエリは無効です。 start_time="2023-08-23T19:20:33+00:00" OR end_time="2023-08-23T19:21:54+00:00" event_types:"google.workspace.chat.space.v1.updated" AND event_types:"google.workspace.chat.message.v1.created" 無効なクエリは、サーバーによって INVALID_ARGUMENT エラーで拒否されます。

ListSpaceEventsResponse

スペース イベントを一覧表示するためのレスポンス メッセージ。

フィールド
space_events[]	SpaceEvent 結果は時系列順（最も古いイベントが最初）で返されます。注: permissionSettings フィールドは、リスト リクエストの Space オブジェクトでは返されません。
next_page_token	string より多くのイベントを取得するために使用される継続トークン。このフィールドを省略すると、後続のページはなくなります。

ListSpacesRequest

呼び出し元がメンバーになっているスペースを一覧表示するリクエスト。

フィールド
page_size	int32 省略可。返すスペースの最大数。サービスが返す値はこれよりも少ないことがあります。 指定されていない場合は、最大で 100 個のスペースが返されます。 最大値は 1000 です。1000 を超える値を使用すると、自動的に 1000 に変更されます。 負の値は INVALID_ARGUMENT エラーを返します。
page_token	string 省略可。前回のスペースの一覧取得呼び出しから受け取ったページトークン。後続のページを取得するには、このパラメータを指定します。 ページネーションを行う場合、フィルタ値はページトークンを受け取った呼び出しと一致している必要があります。別の値を渡すと、予期しない結果になる可能性があります。
filter	string 省略可。クエリフィルタ。 スペースはスペースタイプ（space_type）でフィルタできます。 スペースタイプでフィルタするには、SPACE や GROUP_CHAT などの有効な列挙型値を指定する必要があります（space_type は SPACE_TYPE_UNSPECIFIED にできません）。複数のスペースタイプをクエリするには、OR 演算子を使用します。 たとえば、次のクエリは有効です。 space_type = "SPACE" spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE" 無効なクエリは、サーバーによって INVALID_ARGUMENT エラーで拒否されます。

ListSpacesResponse

スペースのリスト リクエストに対するレスポンス。

フィールド
spaces[]	Space リクエストされた（または最初の）ページのスペースのリスト。注: permissionSettings フィールドは、リスト リクエストの Space オブジェクトでは返されません。
next_page_token	string トークンを pageToken として送信すると、結果の次のページを取得できます。空の場合、後続のページはありません。

MatchedUrl

Chat メッセージで一致した URL。チャットアプリは、一致した URL をプレビューできます。詳しくは、リンクをプレビューするをご覧ください。

フィールド
url	string 出力専用。一致した URL。

メンバーシップ

ユーザーまたは Chat 用アプリがスペースに招待されているか、スペースに参加しているか、スペースから退出しているかなど、Google Chat のメンバーシップ関係を表します。

フィールド
name	string ID。サーバーによって割り当てられたメンバーシップのリソース名。 形式: spaces/{space}/members/{member}
state	MembershipState 出力専用。メンバーシップの状態。
role	MembershipRole 省略可。Chat スペース内のユーザーのロール。スペースで許可されるアクションを決定します。 このフィールドは、UpdateMembership の入力としてのみ使用できます。
create_time	Timestamp 省略可。変更不可。メンバーシップの作成時間（メンバーがスペースに参加したときや、スペースへの参加を招待されたときなど）。このフィールドは、インポート モードのスペースで過去のメンバーシップをインポートする場合を除き、出力専用です。
delete_time	Timestamp 省略可。変更不可。メンバーシップの削除時間（メンバーがスペースから退出した、または削除された日時など）。このフィールドは、インポート モードのスペースで過去のメンバーシップをインポートする場合を除き、出力専用です。
共用体フィールド memberType。このメンバーシップに関連付けられているメンバー。今後、他のメンバー タイプがサポートされる可能性があります。memberType は次のいずれかになります。
member	User 省略可。メンバーシップに対応する Google Chat ユーザーまたはアプリ。Chat 用アプリがユーザーとして認証される場合、出力には user の name と type が入力されます。
group_member	Group 省略可。メンバーシップが対応する Google グループ。 Google グループのメンバーシップの読み取りまたは変更には、ユーザー認証が必要です。

MembershipRole

Chat スペースでユーザーに許可されているアクションを表します。今後、列挙値が追加される可能性があります。

列挙型
MEMBERSHIP_ROLE_UNSPECIFIED	デフォルト値。users の場合: スペースのメンバーではありませんが、招待できます。Google Groups の場合: 常にこのロールが割り当てられます（他の列挙値が今後使用される可能性があります）。
ROLE_MEMBER	スペースのメンバー。ユーザーには、スペースにメッセージを送信するなどの基本的な権限があります。1 対 1 の会話と名前のないグループの会話では、全員にこの役割が割り当てられます。
ROLE_MANAGER	スペースの管理者。ユーザーは、すべての基本権限に加えて、メンバーの追加や削除など、スペースを管理できる管理者権限を持っています。SpaceType.SPACE でのみサポートされています。

MembershipState

メンバーと Space の関係を指定します。今後、他のメンバーシップの状態もサポートされる可能性があります。

列挙型
MEMBERSHIP_STATE_UNSPECIFIED	デフォルト値。使用しないでください。
JOINED	ユーザーがスペースに追加され、スペースに参加できるようになります。
INVITED	ユーザーはスペースへの参加を招待されていますが、まだ参加していません。
NOT_A_MEMBER	ユーザーがスペースのメンバーではなく、スペースへの参加招待が保留中になっていない。

MembershipBatchCreatedEventData

複数の新しいメンバーシップのイベント ペイロード。

イベントタイプ: google.workspace.chat.membership.v1.batchCreated

フィールド
memberships[]	MembershipCreatedEventData 新しいメンバーシップのリスト。

MembershipBatchDeletedEventData

複数の削除されたメンバーシップのイベント ペイロード。

イベントタイプ: google.workspace.chat.membership.v1.batchDeleted

フィールド
memberships[]	MembershipDeletedEventData 削除されたメンバーシップのリスト。

MembershipBatchUpdatedEventData

複数の更新されたメンバーシップのイベント ペイロード。

イベントタイプ: google.workspace.chat.membership.v1.batchUpdated

フィールド
memberships[]	MembershipUpdatedEventData 更新されたメンバーシップのリスト。

MembershipCreatedEventData

新しいメンバーシップのイベント ペイロード。

イベントタイプ: google.workspace.chat.membership.v1.created。

フィールド
membership	Membership 新しいメンバーシップ。

MembershipDeletedEventData

削除されたメンバーシップのイベント ペイロード。

イベントタイプ: google.workspace.chat.membership.v1.deleted

フィールド
membership	Membership 削除されたメンバーシップ。name フィールドと state フィールドのみが入力されます。

MembershipUpdatedEventData

更新されたメンバーシップのイベント ペイロード。

イベントタイプ: google.workspace.chat.membership.v1.updated

フィールド
membership	Membership 更新されたメンバーシップ。

メッセージ

Google Chat スペースのメッセージ。

フィールド
name	string ID。メッセージのリソース名。 形式: spaces/{space}/messages/{message} ここで、{space} はメッセージが投稿されたスペースの ID、{message} はシステムによって割り当てられたメッセージの ID です。例: spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB メッセージの作成時にカスタム ID を設定した場合は、この ID を使用してリクエストでメッセージを指定できます。その際は、{message} を clientAssignedMessageId フィールドの値に置き換えます。例: spaces/AAAAAAAAAAA/messages/client-custom-name。詳しくは、メッセージに名前を付けるをご覧ください。
sender	User 出力専用。メッセージを作成したユーザー。Chat 用アプリがユーザーとして認証される場合、出力には user の name と type が入力されます。
create_time	Timestamp 省略可。変更不可。Chat で作成されたスペースの場合、メッセージが作成された時刻。このフィールドは、インポート モードのスペースで使用される場合を除き、出力専用です。 インポート モードのスペースでは、元の作成時間を保持するために、このフィールドをメッセージがソースで作成されたときの過去のタイムスタンプに設定します。
last_update_time	Timestamp 出力専用。ユーザーがメッセージを最後に編集した日時。メッセージが編集されたことがない場合、このフィールドは空になります。
delete_time	Timestamp 出力専用。Google Chat でメッセージが削除された時刻。メッセージが削除されない場合、このフィールドは空です。
text	string 省略可。メッセージのプレーン テキストの本文。画像、動画、ウェブページへの最初のリンクは、プレビュー チップを生成します。Google Chat ユーザーまたはスペース内の全員をメンションすることもできます。 テキスト メッセージの作成については、メッセージを送信するをご覧ください。
formatted_text	string 出力専用。フォーマットを伝えるためのマークアップが追加されたメッセージ text が含まれます。このフィールドには、UI に表示されるすべての書式設定が反映されない場合がありますが、次のものが含まれます。 太字、斜体、取り消し線、等幅、等幅ブロック、箇条書きのマークアップ構文。 ユーザーメンション: <users/{user}> 形式を使用します。 <{url}|{rendered_text}> 形式のカスタム ハイパーリンク。最初の文字列は URL、2 番目の文字列はレンダリングされたテキストです（例: <http://example.com|custom text>）。 :{emoji_name}: 形式のカスタム絵文字（例: :smile:）。これは、笑顔の絵文字の U+1F600 などの Unicode 絵文字には適用されません。 詳しくは、メッセージで送信されたテキストの書式設定を表示するをご覧ください。
cards[] (deprecated)	Card この項目は非推奨です。 非推奨: 代わりに、cards_v2 を使用してください。 リッチでフォーマットされたインタラクティブなカード。フォーマットされたテキスト、ボタン、クリック可能な画像などの UI 要素を表示するために使用できます。通常、カードはメッセージのプレーン テキスト本文の下に表示されます。cards と cards_v2 の最大サイズは 32 KB です。
cards_v2[]	CardWithId 省略可。カードの配列。 カードを作成できるのは Chat 用アプリのみです。Chat 用アプリがユーザーとして認証される場合、メッセージにカードを含めることはできません。 カードを含むメッセージを作成する方法については、メッセージを送信するをご覧ください。 カードビルダーでカードを設計してプレビューします。 カードビルダーを開く
annotations[]	Annotation 出力専用。このメッセージの text に関連付けられているアノテーション。
thread	Thread メッセージが属するスレッド。使用例については、メッセージ スレッドを開始する、または返信するをご覧ください。
space	Space 出力専用。Chat 用アプリがユーザーとして認証される場合、出力には space name のみが入力されます。
fallback_text	string 省略可。メッセージのカードのプレーン テキストの説明。実際のカードを表示できない場合（モバイル通知など）に使用されます。
action_response	ActionResponse 入力のみのChat 用アプリがレスポンスの投稿方法を構成するために使用できるパラメータ。
argument_text	string 出力専用。Chat 用アプリのメンションがすべて削除されたメッセージの書式なしテキストの本文。
slash_command	SlashCommand 出力専用。スラッシュ コマンドの情報（該当する場合）。
attachment[]	Attachment 省略可。ユーザーがアップロードした添付ファイル。
matched_url	MatchedUrl 出力専用。リンク プレビュー パターンに一致する spaces.messages.text 内の URL。詳しくは、リンクのプレビューをご覧ください。
thread_reply	bool 出力専用。true の場合、メッセージは返信スレッドの返信です。false の場合、メッセージはスペースのトップレベルの会話で、スレッドの最初のメッセージまたはスレッド化された返信のないメッセージとして表示されます。 スペースがスレッドでの返信をサポートしていない場合、このフィールドは常に false です。
client_assigned_message_id	string 省略可。メッセージのカスタム ID。フィールドを使用して、メッセージを識別したり、メッセージの取得、削除、更新を行ったりできます。カスタム ID を設定するには、メッセージの作成時に messageId フィールドを指定します。詳しくは、メッセージに名前を付けるをご覧ください。
emoji_reaction_summaries[]	EmojiReactionSummary 出力専用。メッセージに対する絵文字のリアクションの概要のリスト。
private_message_viewer	User 省略可。変更不可。メッセージ作成の入力。それ以外の場合は出力のみ。メッセージを表示できるユーザー。設定すると、メッセージは非公開になり、指定されたユーザーと Chat 用アプリにのみ表示されます。このフィールドをリクエストに含めるには、アプリ認証を使用して Chat API を呼び出し、次の項目を省略する必要があります。 添付ファイル アクセサリー ウィジェット 詳しくは、非公開でメッセージを送信するをご覧ください。
deletion_metadata	DeletionMetadata 出力専用。削除されたメッセージに関する情報。delete_time が設定されている場合、メッセージは削除されます。
quoted_message_metadata	QuotedMessageMetadata 出力専用。Google Chat ユーザーがスペースで引用したメッセージに関する情報。Google Chat では、メッセージを引用して返信できます。
attached_gifs[]	AttachedGif 出力専用。メッセージに添付された GIF 画像。
accessory_widgets[]	AccessoryWidget 省略可。メッセージの下部に表示される 1 つ以上のインタラクティブ ウィジェット。テキスト、カード、またはテキストとカードの両方を含むメッセージに、アクセサリ ウィジェットを追加できます。ダイアログを含むメッセージではサポートされていません。詳しくは、メッセージの下部にインタラクティブ ウィジェットを追加するをご覧ください。 アクセサリ ウィジェットを含むメッセージを作成するには、アプリの認証が必要です。

MessageBatchCreatedEventData

複数の新しいメッセージのイベント ペイロード。

イベントタイプ: google.workspace.chat.message.v1.batchCreated

フィールド
messages[]	MessageCreatedEventData 新着メッセージの一覧。

MessageBatchDeletedEventData

複数の削除済みメッセージのイベント ペイロード。

イベントタイプ: google.workspace.chat.message.v1.batchDeleted

フィールド
messages[]	MessageDeletedEventData 削除されたメッセージのリスト。

MessageBatchUpdatedEventData

複数の更新されたメッセージのイベント ペイロード。

イベントタイプ: google.workspace.chat.message.v1.batchUpdated

フィールド
messages[]	MessageUpdatedEventData 更新されたメッセージのリスト。

MessageCreatedEventData

新しいメッセージのイベント ペイロード。

イベントタイプ: google.workspace.chat.message.v1.created

フィールド
message	Message 新しいメッセージ。

MessageDeletedEventData

削除されたメッセージのイベント ペイロード。

イベントタイプ: google.workspace.chat.message.v1.deleted

フィールド
message	Message 削除されたメッセージ。name、createTime、deleteTime、deletionMetadata フィールドのみが入力されます。

MessageUpdatedEventData

更新されたメッセージのイベント ペイロード。

イベントタイプ: google.workspace.chat.message.v1.updated

フィールド
message	Message 更新されたメッセージ。

QuotedMessageMetadata

引用されたメッセージに関する情報。

フィールド
name	string 出力専用。引用されたメッセージのリソース名。 形式: spaces/{space}/messages/{message}
last_update_time	Timestamp 出力専用。引用されたメッセージが作成されたとき、または引用されたメッセージが最後に更新されたときのタイムスタンプ。

リアクション

メッセージに対するリアクション。

フィールド
name	string ID。リアクションのリソース名。 形式: spaces/{space}/messages/{message}/reactions/{reaction}
user	User 出力専用。リアクションを作成したユーザー。
emoji	Emoji 必須。リアクションで使用される絵文字。

ReactionBatchCreatedEventData

複数の新しいリアクションのイベント ペイロード。

イベントタイプ: google.workspace.chat.reaction.v1.batchCreated

フィールド
reactions[]	ReactionCreatedEventData 新しいリアクションのリスト。

ReactionBatchDeletedEventData

複数の削除されたリアクションのイベント ペイロード。

イベントタイプ: google.workspace.chat.reaction.v1.batchDeleted

フィールド
reactions[]	ReactionDeletedEventData 削除されたリアクションのリスト。

ReactionCreatedEventData

新しいリアクションのイベント ペイロード。

イベントタイプ: google.workspace.chat.reaction.v1.created

フィールド
reaction	Reaction 新しいリアクション。

ReactionDeletedEventData

削除されたリアクションのイベント ペイロード。

タイプ: google.workspace.chat.reaction.v1.deleted

フィールド
reaction	Reaction 削除されたリアクション。

RichLinkMetadata

リソースへのリッチリンク。

フィールド
uri	string このリンクの URI。
rich_link_type	RichLinkType リッチリンクのタイプ。
共用体フィールド data。リンクされたリソースのデータ。data は次のいずれかになります。
drive_link_data	DriveLinkData ドライブ リンクのデータ。
chat_space_link_data	ChatSpaceLinkData チャット スペースのリンクのデータ。

RichLinkType

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

列挙型
RICH_LINK_TYPE_UNSPECIFIED	列挙型のデフォルト値。使用しないでください。
DRIVE_FILE	Google ドライブのリッチリンクのタイプ。
CHAT_SPACE	Chat スペースのリッチリンク タイプ。たとえば、スペースのスマートチップなどです。

SearchSpacesRequest

クエリに基づいてスペースのリストを検索するリクエスト。

フィールド
use_admin_access	bool true の場合、メソッドはユーザーの Google Workspace 管理者権限を使用して実行されます。 呼び出しユーザーは、Chat とスペースの会話を管理する権限を持つ Google Workspace 管理者である必要があります。 chat.admin.spaces.readonly または chat.admin.spaces OAuth 2.0 スコープが必要です。 このメソッドは現在、管理者アクセスのみをサポートしているため、このフィールドでは true のみが受け入れられます。
page_size	int32 返すスペースの最大数。サービスが返す値はこれよりも少ないことがあります。 指定されていない場合は、最大で 100 個のスペースが返されます。 最大値は 1000 です。1000 を超える値を使用すると、自動的に 1000 に変更されます。
page_token	string 前の検索スペース呼び出しから受け取ったトークン。後続のページを取得するには、このパラメータを指定します。 ページネーションを行う場合、指定する他のすべてのパラメータは、ページトークンを受け取った呼び出しと一致している必要があります。他のパラメータに異なる値を渡すと、予期しない結果が生じる可能性があります。
query	string 必須。検索クエリ。 次のパラメータを使用して検索できます。 create_time customer display_name external_user_allowed last_active_time space_history_state space_type create_time と last_active_time は RFC-3339 形式のタイムスタンプを受け入れます。サポートされている比較演算子は、=、<、>、<=、>= です。 customer は必須で、スペースを取得する顧客を示すために使用されます。サポートされる値は customers/my_customer のみです。 display_name は HAS（:）演算子のみを受け入れます。照合するテキストは、まずトークンにトークン化され、各トークンはスペースの display_name 内の任意の場所にある部分文字列として、大文字と小文字を区別せずに独立してプレフィックス照合されます。たとえば、Fun Eve は Fun event または The evening was fun と一致しますが、notFun event または even とは一致しません。 external_user_allowed は、true または false のいずれかを受け入れます。 space_history_state は、space リソースの historyState フィールドの値のみを受け入れます。 space_type は必須で、有効な値は SPACE のみです。 異なるフィールドでは、AND 演算子のみがサポートされています。有効な例は space_type = "SPACE" AND display_name:"Hello" で、無効な例は space_type = "SPACE" OR display_name:"Hello" です。 同じフィールド内で、space_type は AND 演算子または OR 演算子をサポートしていません。display_name、space_history_state、external_user_allowed は OR 演算子のみをサポートします。last_active_time と create_time は、AND 演算子と OR 演算子の両方をサポートしています。AND は、last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00" などの間隔を表すためにのみ使用できます。 次のクエリの例は有効です。 customer = "customers/my_customer" AND space_type = "SPACE" customer = "customers/my_customer" AND space_type = "SPACE" AND display_name:"Hello World" customer = "customers/my_customer" AND space_type = "SPACE" AND (last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time > "2022-01-01T00:00:00+00:00") customer = "customers/my_customer" AND space_type = "SPACE" AND (display_name:"Hello World" OR display_name:"Fun event") AND (last_active_time > "2020-01-01T00:00:00+00:00" AND last_active_time < "2022-01-01T00:00:00+00:00") customer = "customers/my_customer" AND space_type = "SPACE" AND (create_time > "2019-01-01T00:00:00+00:00" AND create_time < "2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND (space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF")
order_by	string 省略可。スペースのリストの並べ替え方法。 並べ替えに使用できる属性は次のとおりです。 membership_count.joined_direct_human_user_count - スペースに直接参加した人間のユーザーの数を表します。 last_active_time - このスペースのトピックに最後に適格なアイテムが追加された日時を示します。 create_time - スペースの作成時刻を示します。 有効な順序付けオペレーションの値は次のとおりです。 昇順の場合は ASC を指定します。デフォルト値。 降順の場合は DESC。 サポートされている構文は次のとおりです。 membership_count.joined_direct_human_user_count DESC membership_count.joined_direct_human_user_count ASC last_active_time DESC last_active_time ASC create_time DESC create_time ASC

SearchSpacesResponse

検索スペース リクエストに対応するスペースのリストを含むレスポンス。

フィールド
spaces[]	Space リクエストされたスペースのページ。
next_page_token	string 次のページを取得するために使用できるトークン。このフィールドが空の場合、後続のページはありません。
total_size	int32 すべてのページにわたってクエリに一致するスペースの総数。結果が 10,000 スペースを超える場合、この値は推定値です。

SetUpSpaceRequest

スペースを作成し、指定したユーザーを追加するリクエスト。

フィールド
space	Space 必須。Space.spaceType 項目は必須です。 スペースを作成するには、Space.spaceType を SPACE に設定し、Space.displayName を設定します。スペースの設定時に ALREADY_EXISTS というエラー メッセージが表示された場合は、別の displayName を試してください。Google Workspace 組織内の既存のスペースで、この表示名がすでに使用されている可能性があります。 グループ チャットを作成するには、Space.spaceType を GROUP_CHAT に設定します。Space.displayName は設定しないでください。 人間同士の 1 対 1 の会話を作成するには、Space.spaceType を DIRECT_MESSAGE に設定し、Space.singleUserBotDm を false に設定します。Space.displayName または Space.spaceDetails を設定しないでください。 人間と呼び出し元の Chat 用アプリとの 1 対 1 の会話を作成するには、Space.spaceType を DIRECT_MESSAGE に、Space.singleUserBotDm を true に設定します。Space.displayName または Space.spaceDetails を設定しないでください。 DIRECT_MESSAGE スペースがすでに存在する場合は、新しいスペースを作成する代わりに、そのスペースが返されます。
request_id	string 省略可。このリクエストの一意の識別子。ランダムな UUID をおすすめします。既存のリクエスト ID を指定すると、新しいスペースが作成されるのではなく、その ID で作成されたスペースが返されます。同じ Chat 用アプリの既存のリクエスト ID を別の認証済みユーザーで指定すると、エラーが返されます。
memberships[]	Membership 省略可。スペースへの参加を招待する Google Chat のユーザーまたはグループ。呼び出しユーザーは自動的に追加されるため、省略します。 現在、このセットでは（呼び出し元に加えて）最大 49 個のメンバーシップが許可されています。 ユーザー メンバーシップの場合、Membership.member フィールドには、name が入力された user（形式: users/{user}）と User.Type.HUMAN に設定された type を含める必要があります。スペースの設定時に追加できるのはユーザーのみです（Chat 用アプリの追加は、通話アプリとのダイレクト メッセージの設定でのみサポートされています）。ユーザーのメールアドレスを {user} のエイリアスとして使用してメンバーを追加することもできます。たとえば、user.name は users/[e-mail] になります。Gmail ユーザーまたは外部の Google Workspace ドメインのユーザーを招待するには、ユーザーのメールアドレスを {user} に使用する必要があります。 Google グループのメンバーシップの場合、Membership.group_member フィールドには name が入力された group が含まれている必要があります（形式: groups/{group}）。Space.spaceType を SPACE に設定した場合にのみ、Google グループを追加できます。 Space.spaceType を SPACE に設定する場合は省略可。 Space.spaceType を GROUP_CHAT に設定し、2 つ以上のメンバーシップを設定する場合は必須。 Space.spaceType を DIRECT_MESSAGE に設定し、人間のユーザーとメンバーシップを 1 つだけ指定する場合は必須です。 人間と呼び出し元の Chat 用アプリ間の 1 対 1 の会話を作成する場合（Space.spaceType を DIRECT_MESSAGE に、Space.singleUserBotDm を true に設定する場合）は、空にする必要があります。

SlashCommand

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

フィールド
command_id	int64 スラッシュ コマンドの ID。

SlashCommandMetadata

スラッシュ コマンド（/）のアノテーション メタデータ。

フィールド
bot	User コマンドが呼び出された Chat 用アプリ。
type	Type スラッシュ コマンドのタイプ。
command_name	string 呼び出されたスラッシュ コマンドの名前。
command_id	int64 呼び出されたスラッシュ コマンドのコマンド ID。
triggers_dialog	bool スラッシュ コマンドがダイアログ用かどうかを示します。

タイプ

列挙型
TYPE_UNSPECIFIED	列挙型のデフォルト値。使用しないでください。
ADD	スペースに Chat 用アプリを追加します。
INVOKE	スペースでスラッシュ コマンドを呼び出す。

スペース

Google Chat のスペース。スペースは、2 人以上のユーザー間の会話、またはユーザーと Chat 用アプリ間の 1 対 1 のメッセージです。

フィールド
name	string ID。Space のリソース名。 形式: spaces/{space} ここで、{space} はスペースのシステム割り当て ID を表します。スペース ID は、spaces.list() メソッドを呼び出すか、スペースの URL から取得できます。たとえば、スペースの URL が https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA の場合、スペース ID は AAAAAAAAA です。
type (deprecated)	Type この項目は非推奨です。 出力専用。非推奨: 代わりに、space_type を使用してください。スペースのタイプ。
space_type	SpaceType 省略可。スペースのタイプ。スペースの作成時、またはスペースのスペースタイプを更新する際に必要です。他の用途では出力のみ。
single_user_bot_dm	bool 省略可。スペースが Chat 用アプリと 1 人のユーザー間の DM かどうか。
threaded (deprecated)	bool この項目は非推奨です。 出力専用。非推奨: 代わりに、spaceThreadingState を使用してください。このスペースでメッセージがスレッド化されているかどうか。
display_name	string 省略可。スペースの表示名。spaceType が SPACE のスペースを作成する場合は必須です。スペースの作成時または displayName の更新時にエラー メッセージ ALREADY_EXISTS が表示された場合は、別の displayName を試してください。Google Workspace 組織内の既存のスペースで、この表示名がすでに使用されている可能性があります。 ダイレクト メッセージの場合、このフィールドは空の場合があります。 最大 128 文字をサポートします。
external_user_allowed	bool 省略可。変更不可。このスペースで Google Chat のユーザーをメンバーとして許可するかどうか。Google Workspace 組織でスペースを作成する際の入力。次の条件でスペースを作成する場合は、このフィールドを省略します。 認証されたユーザーは一般ユーザー向けアカウント（管理対象外のユーザー アカウント）を使用します。一般ユーザー向けアカウントで作成されたスペースでは、デフォルトですべての Google Chat ユーザーが許可されます。 既存のスペースの場合、このフィールドは出力専用です。
space_threading_state	SpaceThreadingState 出力専用。Chat スペースのスレッドの状態。
space_details	SpaceDetails 省略可。説明やルールなど、スペースの詳細。
space_history_state	HistoryState 省略可。このスペースのメッセージとスレッドのメッセージ履歴の状態。
import_mode	bool 省略可。このスペースが Import Mode で作成されたかどうか。Google Workspace へのデータ移行の一部として作成されたかどうか。スペースのインポート中は、インポートが完了するまでユーザーに表示されません。 Import Mode でスペースを作成するには、ユーザー認証が必要です。
create_time	Timestamp 省略可。変更不可。Chat で作成されたスペースの場合、スペースが作成された日時。このフィールドは、インポート モードのスペースで使用される場合を除き、出力専用です。 インポート モードのスペースの場合は、元の作成時間を保持するために、このフィールドをソースでスペースが作成された過去のタイムスタンプに設定します。 spaceType が GROUP_CHAT または SPACE の場合にのみ、出力に値が入力されます。
last_active_time	Timestamp 出力専用。スペース内の最後のメッセージのタイムスタンプ。
admin_installed	bool 出力専用。Chat 用アプリを含むダイレクト メッセージ（DM）スペースの場合、スペースが Google Workspace 管理者によって作成されたかどうか。管理者は、組織内のユーザーに代わって、Chat 用アプリとのダイレクト メッセージをインストールして設定できます。 管理者によるインストールをサポートするには、Chat 用アプリにダイレクト メッセージ機能が必要です。
membership_count	MembershipCount 出力専用。メンバータイプ別にグループ化された参加メンバーシップの数。space_type が SPACE、DIRECT_MESSAGE、GROUP_CHAT の場合に設定されます。
access_settings	AccessSettings 省略可。スペースのアクセス設定を指定します。space_type が SPACE の場合にのみ入力されます。
space_uri	string 出力専用。ユーザーがスペースにアクセスするための URI。
import_mode_expire_time	Timestamp 出力専用。インポート モードのままの場合に、システムによってスペースが自動的に削除される日時。 インポート モードで作成された各スペースは、spaces.completeImport を使用して、この有効期限が切れる前にこのモードを終了する必要があります。 このフィールドは、インポート モードで作成されたスペースに対してのみ入力されます。
customer	string 省略可。変更不可。スペースのドメインの顧客 ID。アプリ認証を使用してスペースを作成し、SpaceType が SPACE の場合にのみ必須です。それ以外の場合は設定しないでください。 形式は customers/{customer} です。ここで、customer は [Admin SDK の顧客リソース]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers) の id です。限定公開アプリでは、customers/my_customer エイリアスを使用して、アプリと同じ Google Workspace 組織にスペースを作成することもできます。 DM の場合、このフィールドは入力されません。 デベロッパー プレビュー: Google Workspace デベロッパー プレビュー プログラムの一部として利用できます。このプログラムでは、特定の機能にいち早くアクセスできます。
共用体フィールド space_permission_settings。スペースの権限設定を表します。space_type が SPACE の場合にのみ入力されます。space_permission_settings は次のいずれかになります。
predefined_permission_settings	PredefinedPermissionSettings 省略可。入力のみのスペースの権限設定を事前に定義します。スペースの作成時にのみ入力します。このフィールドが設定されていない場合、コラボレーション スペースが作成されます。スペースを作成すると、PermissionSettings フィールドに設定が入力されます。 事前定義された権限設定の設定は、以下をサポートしています。 デベロッパー プレビューでは、chat.app.spaces または chat.app.spaces.create スコープで管理者による承認を伴うアプリの認証。 ユーザー認証
permission_settings	PermissionSettings 省略可。既存のスペースのスペース権限設定。正確なスペースの権限設定を更新するための入力。既存の権限設定が置き換えられます。出力には、現在の権限設定の一覧が表示されます。 権限設定の読み取りと更新は、次のものをサポートしています。 デベロッパー プレビューでは、chat.app.spaces スコープで管理者による承認を伴うアプリ認証。Chat 用アプリがスペースを作成した場合にのみ、入力と設定が可能です。 ユーザー認証

AccessSettings

スペースのアクセス設定を表します。

フィールド
access_state	AccessState 出力専用。スペースのアクセス状態を示します。
audience	string 省略可。スペースを検出、参加、プレビューできる対象ユーザーのリソース名。設定されていない場合、スペースに個別に招待または追加されたユーザーまたは Google グループのみがアクセスできます。詳しくは、対象グループにスペースを見つけてもらうをご覧ください。 形式: audiences/{audience} Google Workspace 組織のデフォルトの対象ユーザーを使用するには、audiences/default に設定します。 対象ユーザーの読み取りは、次の機能をサポートしています。 ユーザー認証 アプリ認証（管理者による承認あり）。chat.app.spaces デベロッパー プレビュー: Google Workspace デベロッパー プレビュー プログラムの一部として利用できます。このプログラムでは、特定の機能にいち早くアクセスできます。 アプリ認証で chat.bot スコープを使用する場合、このフィールドは入力されません。 対象ユーザーを設定するには、ユーザー認証が必要です。

AccessState

スペースのアクセス状態を表します。

列挙型
ACCESS_STATE_UNSPECIFIED	アクセス状態が不明か、この API でサポートされていません。
PRIVATE	スペースを検出してアクセスできるのは、他のユーザーまたは Google Workspace 管理者によって個別に追加または招待されたユーザーまたは Google グループのみです。
DISCOVERABLE	スペースの管理者が、対象ユーザーにスペースへのアクセス権を付与している。スペースに個別に追加または招待されたユーザーや Google グループも、スペースを見つけてアクセスできます。詳しくは、特定のユーザーがスペースを見つけられるようにするをご覧ください。 検索可能なスペースを作成するには、ユーザー認証が必要です。

MembershipCount

スペースのメンバーシップの数をカテゴリ別にグループ化したものを表します。

フィールド
joined_direct_human_user_count	int32 出力専用。スペースに直接参加したユーザーの数。参加したグループのメンバーシップによって参加したユーザーはカウントされません。
joined_group_count	int32 出力専用。スペースに直接参加しているすべてのグループの数。

PermissionSetting

スペースの権限設定を表します。

フィールド
managers_allowed	bool 省略可。スペースの管理者がこの権限を持っているかどうか。
members_allowed	bool 省略可。管理者以外のメンバーにこの権限があるかどうか。

PermissionSettings

既存の名前付きスペースを更新するときに指定できる権限設定。

スペースの作成時に権限設定を行うには、リクエストで PredefinedPermissionSettings フィールドを指定します。

フィールド
manage_members_and_groups	PermissionSetting 省略可。スペースのメンバーとグループを管理するための設定。
modify_space_details	PermissionSetting 省略可。スペースの名前、アバター、説明、ガイドラインを更新するための設定。
toggle_history	PermissionSetting 省略可。スペースの履歴のオンとオフを切り替える設定。
use_at_mention_all	PermissionSetting 省略可。スペースで @all を使用するための設定。
manage_apps	PermissionSetting 省略可。スペース内のアプリを管理するための設定。
manage_webhooks	PermissionSetting 省略可。スペース内の Webhook を管理するための設定。
post_messages	PermissionSetting 出力専用。スペースでメッセージを投稿するための設定。
reply_messages	PermissionSetting 省略可。スペース内のメッセージに返信する設定。

PredefinedPermissionSettings

名前付きスペースの作成時にのみ指定できる事前定義された権限設定。今後、他の設定が追加される可能性があります。名前付きスペースの権限設定について詳しくは、スペースについてをご覧ください。

列挙型
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED	指定なし。使用しないでください。
COLLABORATION_SPACE	スペースをコラボレーション スペースにして、すべてのメンバーがメッセージを投稿できるようにする設定。
ANNOUNCEMENT_SPACE	スペースを、スペースの管理者のみがメッセージを投稿できるお知らせスペースにする設定。

SpaceDetails

説明やルールなど、スペースの詳細。

フィールド
description	string 省略可。スペースの説明。たとえば、スペースのディスカッション トピック、機能的な目的、参加者について説明します。 最大 150 文字までサポートします。
guidelines	string 省略可。スペースのルール、期待されること、エチケット。 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 のダイレクト メッセージ。すべてのメッセージがフラットです。なお、このデータには 2 人のユーザー間のダイレクト メッセージは含まれません。

SpaceBatchUpdatedEventData

スペースに対する複数の更新のイベント ペイロード。

イベントタイプ: google.workspace.chat.space.v1.batchUpdated

フィールド
spaces[]	SpaceUpdatedEventData 更新されたスペースのリスト。

SpaceEvent

Google Chat スペースの変更やアクティビティを表すイベント。詳しくは、Google Chat のイベントを操作するをご覧ください。

フィールド
name	string スペース イベントのリソース名。 形式: spaces/{space}/spaceEvents/{spaceEvent}
event_time	Timestamp イベントが発生した時刻。
event_type	string スペース イベントのタイプ。各イベントタイプにはバッチ バージョンがあります。これは、短期間に発生するイベントタイプの複数のインスタンスを表します。spaceEvents.list() リクエストの場合は、クエリ フィルタでバッチ イベントタイプを省略します。デフォルトでは、サーバーはイベントタイプとそのバッチ バージョンの両方を返します。 メッセージでサポートされているイベントタイプ: 新着メッセージ: google.workspace.chat.message.v1.created 更新されたメッセージ: google.workspace.chat.message.v1.updated 削除されたメッセージ: google.workspace.chat.message.v1.deleted 複数の新着メッセージ: google.workspace.chat.message.v1.batchCreated 複数の更新されたメッセージ: google.workspace.chat.message.v1.batchUpdated 複数の削除済みメッセージ: google.workspace.chat.message.v1.batchDeleted メンバーシップでサポートされているイベントタイプ: 新しいメンバーシップ: google.workspace.chat.membership.v1.created 更新されたメンバーシップ: google.workspace.chat.membership.v1.updated メンバーシップを削除しました: google.workspace.chat.membership.v1.deleted 複数の新しいメンバーシップ: google.workspace.chat.membership.v1.batchCreated 複数のメンバーシップの更新: google.workspace.chat.membership.v1.batchUpdated 複数の削除されたメンバーシップ: google.workspace.chat.membership.v1.batchDeleted リアクションでサポートされているイベントタイプ: 新しいリアクション: google.workspace.chat.reaction.v1.created 削除されたリアクション: google.workspace.chat.reaction.v1.deleted 複数の新しいリアクション: google.workspace.chat.reaction.v1.batchCreated 複数の削除されたリアクション: google.workspace.chat.reaction.v1.batchDeleted スペースに関するサポートされているイベントタイプ: 更新されたスペース: google.workspace.chat.space.v1.updated 複数のスペースの更新: google.workspace.chat.space.v1.batchUpdated
共用体フィールド payload。 payload は次のいずれかになります。
message_created_event_data	MessageCreatedEventData 新しいメッセージのイベント ペイロード。 イベントタイプ: google.workspace.chat.message.v1.created
message_updated_event_data	MessageUpdatedEventData 更新されたメッセージのイベント ペイロード。 イベントタイプ: google.workspace.chat.message.v1.updated
message_deleted_event_data	MessageDeletedEventData 削除されたメッセージのイベント ペイロード。 イベントタイプ: google.workspace.chat.message.v1.deleted
message_batch_created_event_data	MessageBatchCreatedEventData 複数の新しいメッセージのイベント ペイロード。 イベントタイプ: google.workspace.chat.message.v1.batchCreated
message_batch_updated_event_data	MessageBatchUpdatedEventData 複数の更新されたメッセージのイベント ペイロード。 イベントタイプ: google.workspace.chat.message.v1.batchUpdated
message_batch_deleted_event_data	MessageBatchDeletedEventData 複数の削除済みメッセージのイベント ペイロード。 イベントタイプ: google.workspace.chat.message.v1.batchDeleted
space_updated_event_data	SpaceUpdatedEventData スペース更新のイベント ペイロード。 イベントタイプ: google.workspace.chat.space.v1.updated
space_batch_updated_event_data	SpaceBatchUpdatedEventData スペースに対する複数の更新のイベント ペイロード。 イベントタイプ: google.workspace.chat.space.v1.batchUpdated
membership_created_event_data	MembershipCreatedEventData 新しいメンバーシップのイベント ペイロード。 イベントタイプ: google.workspace.chat.membership.v1.created
membership_updated_event_data	MembershipUpdatedEventData 更新されたメンバーシップのイベント ペイロード。 イベントタイプ: google.workspace.chat.membership.v1.updated
membership_deleted_event_data	MembershipDeletedEventData 削除されたメンバーシップのイベント ペイロード。 イベントタイプ: google.workspace.chat.membership.v1.deleted
membership_batch_created_event_data	MembershipBatchCreatedEventData 複数の新しいメンバーシップのイベント ペイロード。 イベントタイプ: google.workspace.chat.membership.v1.batchCreated
membership_batch_updated_event_data	MembershipBatchUpdatedEventData 複数の更新されたメンバーシップのイベント ペイロード。 イベントタイプ: google.workspace.chat.membership.v1.batchUpdated
membership_batch_deleted_event_data	MembershipBatchDeletedEventData 複数の削除されたメンバーシップのイベント ペイロード。 イベントタイプ: google.workspace.chat.membership.v1.batchDeleted
reaction_created_event_data	ReactionCreatedEventData 新しいリアクションのイベント ペイロード。 イベントタイプ: google.workspace.chat.reaction.v1.created
reaction_deleted_event_data	ReactionDeletedEventData 削除されたリアクションのイベント ペイロード。 イベントタイプ: google.workspace.chat.reaction.v1.deleted
reaction_batch_created_event_data	ReactionBatchCreatedEventData 複数の新しいリアクションのイベント ペイロード。 イベントタイプ: google.workspace.chat.reaction.v1.batchCreated
reaction_batch_deleted_event_data	ReactionBatchDeletedEventData 複数の削除されたリアクションのイベント ペイロード。 イベントタイプ: google.workspace.chat.reaction.v1.batchDeleted

SpaceNotificationSetting

スペース内のユーザーの通知設定。

フィールド
name	string ID。スペースの通知設定のリソース名。形式: users/{user}/spaces/{space}/spaceNotificationSetting。
notification_setting	NotificationSetting 通知設定。
mute_setting	MuteSetting スペースの通知ミュート設定。

MuteSetting

スペースの通知ミュート設定のタイプ。

列挙型
MUTE_SETTING_UNSPECIFIED	予約済み。
UNMUTED	ユーザーには、通知設定に基づいてスペースの通知が届きます。
MUTED	通知設定に関係なく、ユーザーにスペースの通知は届きません。

NotificationSetting

通知設定のタイプ。今後、他のタイプもサポートされる可能性があります。

列挙型
NOTIFICATION_SETTING_UNSPECIFIED	予約済み。
ALL	通知は、名前リンク、フォロー中のスレッド、新しいスレッドの最初のメッセージによってトリガーされます。ユーザーが手動でフォローを解除しない限り、すべての新しいスレッドは自動的にフォローされます。
MAIN_CONVERSATIONS	通知は、名前リンク、フォロー中のスレッド、新しいスレッドの最初のメッセージによってトリガーされます。1 対 1 のダイレクト メッセージでは利用できません。
FOR_YOU	通知は、名前リンク、フォロー中のスレッドによってトリガーされます。1 対 1 のダイレクト メッセージでは利用できません。
OFF	通知はオフになっています。

SpaceReadState

スペース内のユーザーの既読状態。既読メッセージと未読メッセージの識別に使用されます。

フィールド
name	string スペースの読み取り状態のリソース名。 形式: users/{user}/spaces/{space}/spaceReadState
last_read_time	Timestamp 省略可。ユーザーのスペースの読み取り状態が更新された時刻。通常、これは最後に読んだメッセージのタイムスタンプ、またはユーザーが指定したタイムスタンプ（スペース内の最後に読んだ位置をマークするため）のいずれかに対応します。

SpaceUpdatedEventData

更新されたスペースのイベント ペイロード。

イベントタイプ: google.workspace.chat.space.v1.updated

フィールド
space	Space 更新されたスペース。

スレッド

Google Chat スペースのスレッド。使用例については、メッセージ スレッドを開始する、または返信するをご覧ください。

メッセージの作成時にスレッドを指定する場合は、messageReplyOption フィールドを設定して、一致するスレッドが見つからなかった場合の処理を決定できます。

フィールド
name	string ID。スレッドのリソース名。 例: spaces/{space}/threads/{thread}
thread_key	string 省略可。スレッドの作成または更新の入力。それ以外の場合は、出力のみ。スレッドの ID。最大 4,000 文字までサポートします。 この ID は、設定した Chat 用アプリに固有のものです。たとえば、複数の Chat 用アプリが同じスレッドキーを使用してメッセージを作成した場合、メッセージは異なるスレッドに投稿されます。ユーザーまたは別の Chat 用アプリによって作成されたスレッドに返信するには、代わりにスレッドの name フィールドを指定します。

ThreadReadState

スレッド内のユーザーの既読状態。既読メッセージと未読メッセージの識別に使用されます。

フィールド
name	string スレッドの読み取り状態のリソース名。 形式: users/{user}/spaces/{space}/threads/{thread}/threadReadState
last_read_time	Timestamp ユーザーのスレッドの既読状態が更新された時間。通常、これはスレッド内の最後に読んだメッセージのタイムスタンプに対応します。

UpdateMembershipRequest

メンバーシップを更新するためのリクエスト メッセージ。

フィールド
membership	Membership 必須。更新するメンバーシップ。update_mask で指定されたフィールドのみが更新されます。
update_mask	FieldMask 必須。更新するフィールド パス。複数の値を指定する場合はカンマで区切るか、* を使用してすべてのフィールド パスを更新します。 現在サポートされているフィールド パス: role
use_admin_access	bool 省略可。true の場合、メソッドはユーザーの Google Workspace 管理者権限を使用して実行されます。 呼び出しユーザーは、Chat とスペースの会話を管理する権限を持つ Google Workspace 管理者である必要があります。 chat.admin.memberships OAuth 2.0 スコープが必要です。

UpdateMessageRequest

メッセージの更新リクエスト。

フィールド
message	Message 必須。フィールドが更新されたメッセージ。
update_mask	FieldMask 必須。更新するフィールド パス。複数の値を指定する場合はカンマで区切るか、* を使用してすべてのフィールド パスを更新します。 現在サポートされているフィールド パス: text attachment cards（アプリの認証が必要です）。 cards_v2（アプリの認証が必要です）。 accessory_widgets（アプリの認証が必要です）。
allow_missing	bool 省略可。true とメッセージが見つからない場合は、新しいメッセージが作成され、updateMask は無視されます。指定されたメッセージ ID はクライアント割り当てである必要があります。そうでない場合、リクエストは失敗します。

UpdateSpaceNotificationSettingRequest

スペースの通知設定を更新するリクエスト。通話中のユーザーの通知設定の更新のみをサポートします。

フィールド
space_notification_setting	SpaceNotificationSetting 必須。スペースの通知設定のリソース名は、users/{user}/spaces/{space}/spaceNotificationSetting の形式で入力する必要があります。update_mask で指定されたフィールドのみが更新されます。
update_mask	FieldMask 必須。サポートされているフィールド パス: notification_setting mute_setting

UpdateSpaceReadStateRequest

UpdateSpaceReadState API のリクエスト メッセージ。

フィールド
space_read_state	SpaceReadState 必須。スペースの読み取り状態と更新するフィールド。 呼び出し元ユーザーの読み取り状態の更新のみをサポートします。 呼び出し元ユーザーを参照するには、次のいずれかを設定します。 me エイリアス。例: users/me/spaces/{space}/spaceReadState Workspace のメールアドレス。例: users/[e-mail]/spaces/{space}/spaceReadState ユーザー ID。例: users/123456789/spaces/{space}/spaceReadState 形式: users/{user}/spaces/{space}/spaceReadState
update_mask	FieldMask 必須。更新するフィールド パス。現在サポートされているフィールド パス: last_read_time last_read_time が最新のメッセージ作成時刻より前の場合は、スペースが UI で未読として表示されます。 スペースを既読にするには、last_read_time を最新のメッセージ作成時刻より後の（大きい）値に設定します。last_read_time は、最新のメッセージ作成時刻と一致するように強制的に変換されます。スペースの既読状態は、スペースのトップレベルの会話に表示されるメッセージの既読状態にのみ影響します。スレッド内の返信はこのタイムスタンプの影響を受けず、スレッドの既読状態に依存します。

UpdateSpaceRequest

1 つのスペースを更新するリクエスト。

フィールド
space	Space 必須。更新するフィールドを含む Space。Space.name は spaces/{space} の形式で入力する必要があります。update_mask で指定されたフィールドのみが更新されます。
update_mask	FieldMask 必須。更新されたフィールド パス。複数ある場合はカンマで区切ります。 スペースの次のフィールドを更新できます。 space_details: スペースの説明を更新します。最大 150 文字までサポートします。 display_name: spaceType フィールドが SPACE のスペースの表示名の更新のみをサポートします。エラー メッセージ ALREADY_EXISTS が表示された場合は、別の値を試してください。Google Workspace 組織内の既存のスペースで、この表示名がすでに使用されている可能性があります。 space_type: GROUP_CHAT スペースタイプから SPACE への変更のみをサポートします。更新マスクに space_type とともに display_name を含め、指定されたスペースに空でない表示名と SPACE スペースタイプがあることを確認します。既存のスペースに SPACE タイプがすでに存在する場合、表示名を更新するときに指定したスペースに space_type マスクと SPACE タイプを含めることは省略可能です。他の方法でスペースタイプを更新しようとすると、無効な引数エラーが発生します。space_type は useAdminAccess ではサポートされていません。 space_history_state: スペースの履歴をオンまたはオフにして、スペースの履歴設定を更新します。Google Workspace 組織で履歴設定が有効になっている場合にのみサポートされます。スペースの履歴の状態を更新するには、リクエスト内の他のすべてのフィールド マスクを省略する必要があります。space_history_state は useAdminAccess ではサポートされていません。 access_settings.audience: spaceType フィールドが SPACE の名前付きスペースで、スペースを見つけられるユーザー、スペースに参加できるユーザー、メッセージをプレビューできるユーザーのアクセス設定を更新します。既存のスペースにターゲット ユーザーが設定されている場合は、このフィールド マスクの値を省略することで、ターゲット ユーザーを削除してスペースへのアクセスを制限できます。スペースのアクセス設定を更新するには、認証ユーザーがスペース管理者である必要があり、リクエスト内の他のすべてのフィールド マスクを省略する必要があります。スペースがインポート モードの場合、このフィールドを更新することはできません。詳しくは、特定のユーザーがスペースを見つけられるようにするをご覧ください。access_settings.audience は useAdminAccess ではサポートされていません。 permission_settings: スペースの権限設定の変更をサポートします。権限設定を更新する場合は、permissionSettings フィールド マスクのみを指定できます。他のフィールド マスクを同時に更新することはできません。permissionSettings は useAdminAccess ではサポートされていません。サポートされているフィールド マスクは次のとおりです。 permission_settings.manageMembersAndGroups permission_settings.modifySpaceDetails permission_settings.toggleHistory permission_settings.useAtMentionAll permission_settings.manageApps permission_settings.manageWebhooks permission_settings.replyMessages
use_admin_access	bool 省略可。true の場合、メソッドはユーザーの Google Workspace 管理者権限を使用して実行されます。 呼び出しユーザーは、Chat とスペースの会話を管理する権限を持つ Google Workspace 管理者である必要があります。 chat.admin.spaces OAuth 2.0 スコープが必要です。 一部の FieldMask 値は、管理者アクセスではサポートされていません。詳しくは、update_mask の説明をご覧ください。

ユーザー

Google Chat のユーザー。リクエストの出力として返される場合、Chat 用アプリがユーザーとして認証されると、User リソースの出力にはユーザーの name と type のみが入力されます。

フィールド
name	string Google Chat user のリソース名。 形式: users/{user}。users/app は、呼び出し元アプリの bot ユーザーのエイリアスとして使用できます。 human users の場合、{user} は次のユーザー ID と同じです。 People API の Person の id。たとえば、Chat API の users/123456789 は、People API の 123456789 人物プロファイル ID と同じ人物を表します。 Admin SDK Directory API の user の id。 ユーザーのメールアドレスは、API リクエストで {user} のエイリアスとして使用できます。たとえば、[e-mail] の People API の人物プロファイル ID が 123456789 の場合、users/[e-mail] をエイリアスとして使用して users/123456789 を参照できます。API から返されるのは、正規のリソース名（users/123456789 など）のみです。
display_name	string 出力専用。ユーザーの表示名。
domain_id	string ユーザーの Google Workspace ドメインの一意の識別子。
type	Type ユーザータイプ。
is_anonymous	bool 出力専用。true の場合、ユーザーは削除されているか、プロフィールが表示されていません。

タイプ

列挙型
TYPE_UNSPECIFIED	列挙型のデフォルト値。使用しないでください。
HUMAN	人間のユーザー。
BOT	Chat アプリのユーザー。

UserMentionMetadata

ユーザーメンション（@）のアノテーション メタデータ。

フィールド
user	User ユーザーが言及した。
type	Type ユーザーメンションのタイプ。

タイプ

列挙型
TYPE_UNSPECIFIED	列挙型のデフォルト値。使用しないでください。
ADD	スペースにユーザーを追加します。
MENTION	スペースでユーザーにメンションします。

WidgetMarkup

ウィジェットは、テキストや画像を表示する UI 要素です。

フィールド
buttons[]	Button ボタンのリスト。ボタンも oneof data であり、これらのフィールドのいずれか 1 つのみを設定する必要があります。
共用体フィールド data。WidgetMarkup には、次のいずれか 1 つだけを指定できます。複数の WidgetMarkup フィールドを使用して、より多くのアイテムを表示できます。data は次のいずれかになります。
text_paragraph	TextParagraph このウィジェットにテキストの段落を表示します。
image	Image このウィジェットに画像を表示します。
key_value	KeyValue このウィジェットに Key-Value アイテムを表示します。

ボタン

ボタン。テキスト ボタンまたは画像ボタンを指定できます。

フィールド
共用体フィールド type。 type は次のいずれかになります。
text_button	TextButton テキストと onclick アクションを含むボタン。
image_button	ImageButton 画像と onclick アクションを含むボタン。

FormAction

フォーム アクションは、フォームが送信されたときの動作を記述します。たとえば、Apps Script を呼び出してフォームを処理できます。

フィールド
action_method_name	string メソッド名は、フォームのどの部分がフォームの送信をトリガーしたかを特定するために使用されます。この情報は、カードクリック イベントの一部として Chat 用アプリにエコーバックされます。共通の動作をトリガーする複数の要素に同じメソッド名を使用できます。
parameters[]	ActionParameter アクション パラメータのリスト。

ActionParameter

アクション メソッドが呼び出されたときに指定する文字列パラメータのリスト。たとえば、[今すぐスヌーズ]、[1 日スヌーズ]、[来週スヌーズ] の 3 つのスヌーズ ボタンがあるとします。action method = snooze() を使用して、文字列パラメータのリストでスヌーズ タイプとスヌーズ時間を渡すことができます。

フィールド
key	string アクション スクリプトのパラメータの名前。
value	string パラメータの値。

アイコン

サポートされているアイコンのセット。

列挙型
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	string 画像の URL です。
on_click	OnClick onclick アクション。
aspect_ratio	double この画像のアスペクト比（幅と高さ）。このフィールドを使用すると、画像の読み込みを待機している間、画像の適切な高さを確保できます。これは、画像の組み込みアスペクト比をオーバーライドするためのものではありません。設定されていない場合、サーバーは画像をプリフェッチして入力します。

ImageButton

onclick アクションを含む画像ボタン。

フィールド
on_click	OnClick onclick アクション。
name	string ユーザー補助機能に使用されるこの image_button の名前。この名前が指定されていない場合は、デフォルト値が提供されます。
共用体フィールド icons。アイコンは Icon enum または URL で指定できます。icons は次のいずれかになります。
icon	Icon Chat API が提供するアイコンのインデックスを指定する enum で指定されたアイコン。
icon_url	string URL で指定されたアイコン。

KeyValue

UI 要素には、キー（ラベル）と値（コンテンツ）が含まれます。この要素には、onclick ボタンなどのアクションを含めることもできます。

フィールド
top_label	string 上部のラベルのテキスト。書式設定されたテキストがサポートされています。テキストの書式設定について詳しくは、Google Chat アプリでテキストの書式を設定すると Google Workspace アドオンでテキストの書式を設定するをご覧ください。
content	string コンテンツのテキスト。書式設定されたテキストがサポートされ、常に必要です。テキストの書式設定について詳しくは、Google Chat アプリでテキストの書式を設定すると Google Workspace アドオンでテキストの書式を設定するをご覧ください。
content_multiline	bool コンテンツが複数行であるかどうか。
bottom_label	string 下部のラベルのテキスト。書式設定されたテキストがサポートされています。テキストの書式設定について詳しくは、Google Chat アプリでテキストの書式を設定すると Google Workspace アドオンでテキストの書式を設定するをご覧ください。
on_click	OnClick onclick アクション。クリックできるのは、上部のラベル、下部のラベル、コンテンツ領域のみです。
共用体フィールド icons。アイコン、top_label、bottom_label のうち少なくとも 1 つを定義する必要があります。icons は次のいずれかになります。
icon	Icon Chat API によって対応するアイコン画像に置き換えられる列挙型値。
icon_url	string URL で指定されたアイコン。
共用体フィールド control。コントロール ウィジェット。button または switch_widget のいずれか一方を設定できますが、両方は設定できません。control は次のいずれかになります。
button	Button クリックしてアクションをトリガーできるボタン。

OnClick

onclick アクション（リンクを開くなど）。

フィールド
共用体フィールド data。 data は次のいずれかになります。
action	FormAction 指定されている場合、この onclick アクションによってフォーム アクションがトリガーされます。
open_link	OpenLink この onclick アクションは、指定されている場合、リンクを開くアクションをトリガーします。

OpenLink

新しいウィンドウを開くリンク。

フィールド
url	string 開く URL。

TextButton

テキストと onclick アクションを含むボタン。

フィールド
text	string ボタンのテキスト。
on_click	OnClick ボタンの onclick アクション。

TextParagraph

テキストの段落。書式設定されたテキストがサポートされています。テキストの書式設定について詳しくは、Google Chat アプリでテキストの書式を設定すると Google Workspace アドオンでテキストの書式を設定するをご覧ください。

フィールド
text	string