Package google.chat.v1

インデックス

• ChatService（インターフェース）
• AccessoryWidget（メッセージ）
• ActionResponse（メッセージ）
• ActionResponse.ResponseType（列挙型）
• ActionResponse.SelectionItems（メッセージ）
• ActionResponse.UpdatedWidget（メッセージ）
• ActionStatus（メッセージ）
• Annotation（メッセージ）
• AnnotationType（列挙型）
• AppCommandMetadata（メッセージ）
• AppCommandMetadata.AppCommandType（列挙型）
• AttachedGif（メッセージ）
• Attachment（メッセージ）
• Attachment.Source（列挙型）
• AttachmentDataRef（メッセージ）
• Audience（メッセージ）
• Availability（メッセージ）
• Availability.State（列挙型）
• CalendarEventLinkData（メッセージ）
• CardWithId（メッセージ）
• ChatSpaceLinkData（メッセージ）
• Citation（メッセージ）
• CitedSource（メッセージ）
• CitedSource.Footer（メッセージ）
• CitedSource.Snippet（メッセージ）
• CompleteImportSpaceRequest（メッセージ）
• CompleteImportSpaceResponse（メッセージ）
• ContextualAddOnMarkup（メッセージ）
• ContextualAddOnMarkup.Card（メッセージ）
• ContextualAddOnMarkup.Card.CardAction（メッセージ）
• ContextualAddOnMarkup.Card.CardHeader（メッセージ）
• ContextualAddOnMarkup.Card.CardHeader.ImageStyle（列挙型）
• ContextualAddOnMarkup.Card.Section（メッセージ）
• CreateCustomEmojiRequest（メッセージ）
• CreateMembershipRequest（メッセージ）
• CreateMessageNotificationOptions（メッセージ）
• CreateMessageNotificationOptions.NotificationType（列挙型）
• CreateMessagePinRequest（メッセージ）
• CreateMessageRequest（メッセージ）
• CreateMessageRequest.MessageReplyOption（列挙型）
• CreateReactionRequest（メッセージ）
• CreateSectionRequest（メッセージ）
• CreateSpaceRequest（メッセージ）
• CustomEmoji（メッセージ）
• CustomEmoji.CustomEmojiPayload（メッセージ）
• CustomEmojiMetadata（メッセージ）
• CustomStatus（メッセージ）
• DeleteCustomEmojiRequest（メッセージ）
• DeleteMembershipRequest（メッセージ）
• DeleteMessagePinRequest（メッセージ）
• DeleteMessageRequest（メッセージ）
• DeleteReactionRequest（メッセージ）
• DeleteSectionRequest（メッセージ）
• DeleteSpaceRequest（メッセージ）
• DeletionMetadata（メッセージ）
• DeletionMetadata.DeletionType（列挙型）
• Dialog（メッセージ）
• DialogAction（メッセージ）
• DoNotDisturbMetadata（メッセージ）
• DriveDataRef（メッセージ）
• DriveLinkData（メッセージ）
• Elements（メッセージ）
• ElementsImage（メッセージ）
• Emoji（メッセージ）
• EmojiReactionSummary（メッセージ）
• FindDirectMessageRequest（メッセージ）
• FindGroupChatsRequest（メッセージ）
• FindGroupChatsResponse（メッセージ）
• ForwardedMetadata（メッセージ）
• GetAttachmentRequest（メッセージ）
• GetAvailabilityRequest（メッセージ）
• GetCustomEmojiRequest（メッセージ）
• GetMembershipRequest（メッセージ）
• GetMessageRequest（メッセージ）
• GetSpaceEventRequest（メッセージ）
• GetSpaceNotificationSettingRequest（メッセージ）
• GetSpaceReadStateRequest（メッセージ）
• GetSpaceRequest（メッセージ）
• GetThreadReadStateRequest（メッセージ）
• Group（メッセージ）
• HistoryState（列挙型）
• ListCustomEmojisRequest（メッセージ）
• ListCustomEmojisResponse（メッセージ）
• ListMembershipsRequest（メッセージ）
• ListMembershipsResponse（メッセージ）
• ListMessagePinsRequest（メッセージ）
• ListMessagePinsResponse（メッセージ）
• ListMessagesRequest（メッセージ）
• ListMessagesResponse（メッセージ）
• ListReactionsRequest（メッセージ）
• ListReactionsResponse（メッセージ）
• ListSectionItemsRequest（メッセージ）
• ListSectionItemsResponse（メッセージ）
• ListSectionsRequest（メッセージ）
• ListSectionsResponse（メッセージ）
• ListSpaceEventsRequest（メッセージ）
• ListSpaceEventsResponse（メッセージ）
• ListSpacesRequest（メッセージ）
• ListSpacesResponse（メッセージ）
• MarkAsActiveRequest（メッセージ）
• MarkAsAwayRequest（メッセージ）
• MarkAsDoNotDisturbRequest（メッセージ）
• MarkupSyntax（列挙型）
• MatchedUrl（メッセージ）
• MeetSpaceLinkData（メッセージ）
• MeetSpaceLinkData.HuddleStatus（列挙型）
• MeetSpaceLinkData.Type（列挙型）
• Membership（メッセージ）
• Membership.Affiliation（列挙型）
• Membership.MembershipRole（列挙型）
• Membership.MembershipState（列挙型）
• MembershipBatchCreatedEventData（メッセージ）
• MembershipBatchDeletedEventData（メッセージ）
• MembershipBatchUpdatedEventData（メッセージ）
• MembershipCreatedEventData（メッセージ）
• MembershipDeletedEventData（メッセージ）
• MembershipUpdatedEventData（メッセージ）
• Message（メッセージ）
• MessageBatchCreatedEventData（メッセージ）
• MessageBatchDeletedEventData（メッセージ）
• MessageBatchUpdatedEventData（メッセージ）
• MessageCreatedEventData（メッセージ）
• MessageDeletedEventData（メッセージ）
• MessagePin（メッセージ）
• MessageUpdatedEventData（メッセージ）
• MoveSectionItemRequest（メッセージ）
• MoveSectionItemResponse（メッセージ）
• PositionSectionRequest（メッセージ）
• PositionSectionRequest.Position（列挙型）
• PositionSectionResponse（メッセージ）
• QuotedMessageMetadata（メッセージ）
• QuotedMessageMetadata.QuoteType（列挙型）
• QuotedMessageSnapshot（メッセージ）
• Reaction（メッセージ）
• ReactionBatchCreatedEventData（メッセージ）
• ReactionBatchDeletedEventData（メッセージ）
• ReactionCreatedEventData（メッセージ）
• ReactionDeletedEventData（メッセージ）
• ReplaceMessageCardsRequest（メッセージ）
• ReplaceMessageCardsResponse（メッセージ）
• RichLinkMetadata（メッセージ）
• RichLinkMetadata.RichLinkType（列挙型）
• SearchMessageResult（メッセージ）
• SearchMessagesRequest（メッセージ）
• SearchMessagesRequest.SearchMessagesView（列挙型）
• SearchMessagesResponse（メッセージ）
• SearchSpacesRequest（メッセージ）
• SearchSpacesResponse（メッセージ）
• SearchSpacesResponse.SearchSpaceResult（メッセージ）
• Section（メッセージ）
• Section.SectionType（列挙型）
• SectionItem（メッセージ）
• SetUpSpaceRequest（メッセージ）
• SlashCommand（メッセージ）
• SlashCommandMetadata（メッセージ）
• SlashCommandMetadata.Type（列挙型）
• Space（メッセージ）
• Space.AccessPermissionSetting（メッセージ）
• Space.AccessPermissionSettings（メッセージ）
• Space.AccessSettings（メッセージ）
• Space.AccessSettings.AccessState（列挙型）
• Space.MembershipCount（メッセージ）
• Space.PermissionSetting（メッセージ）
• Space.PermissionSettings（メッセージ）
• Space.PredefinedPermissionSettings（列挙型）
• Space.Principal（メッセージ）
• Space.SpaceDetails（メッセージ）
• Space.SpaceThreadingState（列挙型）
• Space.SpaceType（列挙型）
• Space.Type（列挙型）
• SpaceBatchUpdatedEventData（メッセージ）
• SpaceEvent（メッセージ）
• SpaceNotificationSetting（メッセージ）
• SpaceNotificationSetting.MuteSetting（列挙型）
• SpaceNotificationSetting.NotificationSetting（列挙型）
• SpaceReadState（メッセージ）
• SpaceUpdatedEventData（メッセージ）
• SpaceView（列挙型）
• Thread（メッセージ）
• ThreadReadState（メッセージ）
• UpdateAvailabilityRequest（メッセージ）
• UpdateMembershipRequest（メッセージ）
• UpdateMessageRequest（メッセージ）
• UpdateSectionRequest（メッセージ）
• 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 詳しくは、承認ガイドをご覧ください。

CreateMessagePin
rpc CreateMessagePin(CreateMessagePinRequest) returns (MessagePin) メッセージの固定を作成します。 次のいずれかの認可スコープを使用したユーザー認証が必要です。 https://www.googleapis.com/auth/chat.spaces.pins https://www.googleapis.com/auth/chat.spaces 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/chat.spaces.pins https://www.googleapis.com/auth/chat.spaces 詳しくは、承認ガイドをご覧ください。

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 詳しくは、承認ガイドをご覧ください。

CreateSection

rpc CreateSection(CreateSectionRequest) returns (Section) Google Chat でセクションを作成します。セクションを使用すると、グループの会話をグループ化したり、Chat のナビゲーション パネルに表示されるスペースのリストをカスタマイズしたりできます。作成できるのは、CUSTOM_SECTION タイプのセクションのみです。詳しくは、Google Chat でセクションを作成、整理するをご覧ください。 認可スコープを使用したユーザー認証が必要です。 https://www.googleapis.com/auth/chat.users.sections 認可スコープ 次の OAuth スコープが必要です。 https://www.googleapis.com/auth/chat.users.sections 詳しくは、承認ガイドをご覧ください。

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 詳しくは、承認ガイドをご覧ください。

DeleteMessagePin
rpc DeleteMessagePin(DeleteMessagePinRequest) returns (Empty) メッセージの固定を削除します。 次のいずれかの認可スコープを使用したユーザー認証が必要です。 https://www.googleapis.com/auth/chat.spaces.pins https://www.googleapis.com/auth/chat.spaces 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/chat.spaces.pins https://www.googleapis.com/auth/chat.spaces 詳しくは、承認ガイドをご覧ください。

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 詳しくは、承認ガイドをご覧ください。

DeleteSection
rpc DeleteSection(DeleteSectionRequest) returns (Empty) CUSTOM_SECTION タイプのセクションを削除します。 セクションにスペースなどのアイテムが含まれている場合、それらのアイテムは Google Chat のデフォルトのセクションに移動され、削除されません。 詳しくは、Google Chat でセクションを作成、整理するをご覧ください。 認可スコープを使用したユーザー認証が必要です。 https://www.googleapis.com/auth/chat.users.sections 認可スコープ 次の OAuth スコープが必要です。 https://www.googleapis.com/auth/chat.users.sections 詳しくは、承認ガイドをご覧ください。

DeleteSpace

rpc DeleteSpace(DeleteSpaceRequest) returns (Empty) 名前付きスペースを削除します。常にカスケード削除を実行します。つまり、スペースの子リソース（スペースに投稿されたメッセージやスペースのメンバーシップなど）も削除されます。例については、スペースを削除するをご覧ください。 次の種類の認証をサポートしています。 管理者承認と認可スコープを使用したアプリ認証: 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 詳しくは、承認ガイドをご覧ください。

FindGroupChats

rpc FindGroupChats(FindGroupChatsRequest) returns (FindGroupChatsResponse) spaceType == GROUP_CHAT を含むすべてのスペースを返します。これらのスペースの人間メンバーシップには、呼び出し元のユーザーと FindGroupChatsRequest.users で指定されたユーザーが正確に含まれています。会話に参加しているメンバーのみがサポートされます。例については、グループ チャットを検索するをご覧ください。 呼び出し元のユーザーが一部のユーザーをブロックしているか、一部のユーザーによってブロックされている場合、指定されたユーザーのセット全体を含むスペースが見つからない場合、このメソッドはブロックされたユーザーまたはブロックしているユーザーを含まないスペースを返します。 指定するユーザーのセットには、人間（アプリ以外）のメンバーシップのみを含める必要があります。人間以外のユーザーを含むリクエストは、スペースを返しません。 次のいずれかの認可スコープを使用したユーザー認証が必要です。 https://www.googleapis.com/auth/chat.memberships.readonly https://www.googleapis.com/auth/chat.memberships 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/chat.memberships https://www.googleapis.com/auth/chat.memberships.readonly 詳しくは、承認ガイドをご覧ください。

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

GetAvailability

rpc GetAvailability(GetAvailabilityRequest) returns (Availability) Google Chat の人間のユーザーの空き状況情報を返します。たとえば、ユーザーがオンラインかオフラインかを確認したり、カスタム ステータス メッセージを取得したりするために使用できます。 このメソッドは、認証済みユーザーの空き時間情報のみを取得します。 次のいずれかの認可スコープを使用したユーザー認証が必要です。 https://www.googleapis.com/auth/chat.users.availability.readonly https://www.googleapis.com/auth/chat.users.availability 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/chat.users.availability https://www.googleapis.com/auth/chat.users.availability.readonly 詳しくは、承認ガイドをご覧ください。

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: この認可スコープを使用すると、このメソッドは、Chat アプリがアクセスできるメッセージ（ダイレクト メッセージや Chat アプリを呼び出すスラッシュ コマンドなど）の詳細を返します。 https://www.googleapis.com/auth/chat.app.messages.readonly（管理者の承認が必要）。この認証スコープを使用すると、このメソッドはスペース内の公開メッセージの詳細を返します。 次のいずれかの認可スコープを使用したユーザー認証。 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 https://www.googleapis.com/auth/chat.app.messages.readonly 詳しくは、承認ガイドをご覧ください。

GetSpace

rpc GetSpace(GetSpaceRequest) returns (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.app.spaces https://www.googleapis.com/auth/chat.app.spaces.readonly https://www.googleapis.com/auth/chat.app.messages.readonly https://www.googleapis.com/auth/chat.app.memberships https://www.googleapis.com/auth/chat.app.memberships.readonly 次のいずれかの認可スコープを使用したユーザー認証。 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.app.memberships https://www.googleapis.com/auth/chat.app.memberships.readonly https://www.googleapis.com/auth/chat.app.messages.readonly https://www.googleapis.com/auth/chat.app.spaces https://www.googleapis.com/auth/chat.app.spaces.readonly https://www.googleapis.com/auth/chat.app.all.messages.readonly https://www.googleapis.com/auth/chat.app.all.spaces.readonly https://www.googleapis.com/auth/chat.app.all.memberships.readonly 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 用アプリのメンバー（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 詳しくは、承認ガイドをご覧ください。

ListMessagePins

rpc ListMessagePins(ListMessagePinsRequest) returns (ListMessagePinsResponse) スペース内のメッセージの固定を一覧表示します。ユーザーは、スペース内の重要なメッセージを固定して、簡単にアクセスできるようにすることができます。詳しくは、Google Chat で会話を固定または固定解除するをご覧ください。 次のいずれかの認可スコープを使用したユーザー認証が必要です。 https://www.googleapis.com/auth/chat.spaces.pins.readonly https://www.googleapis.com/auth/chat.spaces.pins https://www.googleapis.com/auth/chat.spaces.readonly https://www.googleapis.com/auth/chat.spaces 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/chat.spaces.pins https://www.googleapis.com/auth/chat.spaces.pins.readonly https://www.googleapis.com/auth/chat.spaces https://www.googleapis.com/auth/chat.spaces.readonly 詳しくは、承認ガイドをご覧ください。

ListMessages

rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse) 呼び出し元がメンバーであるスペース内のメッセージ（ブロックされたメンバーやスペースからのメッセージを含む）を一覧表示します。新しいスペース メンバーを知らせるメッセージなどのシステム メッセージは含まれません。メッセージのないスペースからメッセージを一覧表示すると、レスポンスは空のオブジェクトになります。REST/HTTP インターフェースを使用する場合、レスポンスには空の JSON オブジェクト {} が含まれます。例については、メッセージを一覧表示するをご覧ください。 次の種類の認証をサポートしています。 管理者承認によるアプリ認証（認可スコープは次のとおり）: https://www.googleapis.com/auth/chat.app.messages.readonly。この認証スコープを使用する場合、このメソッドはスペース内の公開メッセージのみを返します。プライベート メッセージは含まれません。 次のいずれかの認可スコープを使用したユーザー認証。 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 https://www.googleapis.com/auth/chat.app.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 詳しくは、承認ガイドをご覧ください。

ListSectionItems

rpc ListSectionItems(ListSectionItemsRequest) returns (ListSectionItemsResponse) セクション内のアイテムを一覧表示します。 セクション アイテムにできるのはスペースのみです。詳しくは、Google Chat でセクションを作成、整理するをご覧ください。 認可スコープを使用したユーザー認証が必要です。 https://www.googleapis.com/auth/chat.users.sections https://www.googleapis.com/auth/chat.users.sections.readonly 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/chat.users.sections https://www.googleapis.com/auth/chat.users.sections.readonly 詳しくは、承認ガイドをご覧ください。

ListSections

rpc ListSections(ListSectionsRequest) returns (ListSectionsResponse) Chat ユーザーが利用できるセクションを一覧表示します。セクションを使用すると、会話をグループ化し、Chat のナビゲーション パネルに表示されるスペースのリストをカスタマイズできます。詳しくは、Google Chat でセクションを作成、整理するをご覧ください。 認可スコープを使用したユーザー認証が必要です。 https://www.googleapis.com/auth/chat.users.sections https://www.googleapis.com/auth/chat.users.sections.readonly 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/chat.users.sections https://www.googleapis.com/auth/chat.users.sections.readonly 詳しくは、承認ガイドをご覧ください。

ListSpaceEvents

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

MarkAsActive

rpc MarkAsActive(MarkAsActiveRequest) returns (Availability) Google Chat でユーザーを ACTIVE としてマークします。 ユーザーの対応可能状態を ACTIVE に設定します。ACTIVE 状態は指定された有効期限まで続き、有効期限が切れるとユーザーの状態は AWAY になります。ユーザーが Chat をアクティブに使用している場合、ACTIVE 状態の期間が指定された有効期限を超えて延長されることがあります。 このメソッドは、認証済みユーザーの空き状況のみを更新します。 認可スコープを使用したユーザー認証が必要です。 https://www.googleapis.com/auth/chat.users.availability 認可スコープ 次の OAuth スコープが必要です。 https://www.googleapis.com/auth/chat.users.availability 詳しくは、承認ガイドをご覧ください。

MarkAsAway
rpc MarkAsAway(MarkAsAwayRequest) returns (Availability) Google Chat でユーザーを AWAY としてマークします。 ユーザーの状態を「離席中」に設定します。ユーザーのアクティビティの影響は受けません。 このメソッドは、認証済みユーザーの空き状況のみを更新します。 認可スコープを使用したユーザー認証が必要です。 https://www.googleapis.com/auth/chat.users.availability 認可スコープ 次の OAuth スコープが必要です。 https://www.googleapis.com/auth/chat.users.availability 詳しくは、承認ガイドをご覧ください。

MarkAsDoNotDisturb

rpc MarkAsDoNotDisturb(MarkAsDoNotDisturbRequest) returns (Availability) Google Chat でユーザーを DO_NOT_DISTURB としてマークします。 指定された有効期限まで、ユーザーの空き状況を DO_NOT_DISTURB に設定します。DO_NOT_DISTURB の場合、通常、ユーザーに通知は届きません。 このメソッドは、認証済みユーザーの空き状況のみを更新します。 認可スコープを使用したユーザー認証が必要です。 https://www.googleapis.com/auth/chat.users.availability 認可スコープ 次の OAuth スコープが必要です。 https://www.googleapis.com/auth/chat.users.availability 詳しくは、承認ガイドをご覧ください。

MoveSectionItem
rpc MoveSectionItem(MoveSectionItemRequest) returns (MoveSectionItemResponse) アイテムをあるセクションから別のセクションに移動します。たとえば、セクションにスペースが含まれている場合、このメソッドを使用してスペースを別のセクションに移動できます。詳しくは、Google Chat でセクションを作成、整理するをご覧ください。 認可スコープを使用したユーザー認証が必要です。 https://www.googleapis.com/auth/chat.users.sections 認可スコープ 次の OAuth スコープが必要です。 https://www.googleapis.com/auth/chat.users.sections 詳しくは、承認ガイドをご覧ください。

PositionSection
rpc PositionSection(PositionSectionRequest) returns (PositionSectionResponse) セクションの並べ替え順序を変更します。詳しくは、Google Chat でセクションを作成、整理するをご覧ください。 認可スコープを使用したユーザー認証が必要です。 https://www.googleapis.com/auth/chat.users.sections 認可スコープ 次の OAuth スコープが必要です。 https://www.googleapis.com/auth/chat.users.sections 詳しくは、承認ガイドをご覧ください。

ReplaceMessageCards

rpc ReplaceMessageCards(ReplaceMessageCardsRequest) returns (ReplaceMessageCardsResponse) メッセージに含まれるカードを置き換えます。 Chat 用アプリが人間が作成したメッセージのカードを置き換えることができるのは、メッセージにすでにカードが含まれており、そのカードがアプリによって作成された場合のみです。 アプリがカードを空のリストに置き換えると、カードは削除されます。カードを削除すると、アプリはカードをメッセージに再度追加できなくなります。 認可スコープ https://www.googleapis.com/auth/chat.bot を使用したアプリ認証が必要です。 認可スコープ 次の OAuth スコープが必要です。 https://www.googleapis.com/auth/chat.bot 詳しくは、承認ガイドをご覧ください。

SearchMessages

rpc SearchMessages(SearchMessagesRequest) returns (SearchMessagesResponse) 呼び出し元のユーザーがアクセスできる Google Chat のメッセージを検索します。検索条件に一致するメッセージのリストを返します。 ユーザーがアクセスできるすべてのスペースを検索するには、parent を spaces/- に設定します。parent に他の値を使用すると、INVALID_ARGUMENT エラーが発生します。返されたメッセージの name フィールドには、メッセージが存在する特定の space を含む完全なリソース名が入力されます。 この API は、すべてのメッセージ タイプを返すわけではありません。以下に示す種類のメッセージはレスポンスに含まれません。ListMessages を使用して、すべてのメッセージを一覧表示します。 認証済みユーザーに表示されるプライベート メッセージ。 Chat 用アプリによってスペースまたはグループ チャットに投稿されたメッセージ。 Chat アプリの DM 内のメッセージ。 ブロックされたユーザーからのメッセージ。 発信者がミュートしたスペース内のメッセージ。 次のいずれかの認可スコープを使用したユーザー認証が必要です。 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 詳しくは、承認ガイドをご覧ください。

SearchSpaces

rpc SearchSpaces(SearchSpacesRequest) returns (SearchSpacesResponse) Google Workspace 組織内のスペースのリストを返します。例については、スペースを検索して管理するをご覧ください。 use_admin_access が false に設定されている場合、結果は呼び出し元のユーザーが参加しているスペースに限定されます。管理者権限で検索するには、use_admin_access を true に設定します。 次の種類の認証をサポートしています。 次のいずれかの認可スコープを使用したユーザー認証。 https://www.googleapis.com/auth/chat.spaces.readonly https://www.googleapis.com/auth/chat.spaces 管理者権限を持つユーザー認証と、次のいずれかの認可スコープ。 https://www.googleapis.com/auth/chat.admin.spaces.readonly https://www.googleapis.com/auth/chat.admin.spaces 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/chat.spaces https://www.googleapis.com/auth/chat.spaces.readonly 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 Person プロファイル 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 詳しくは、承認ガイドをご覧ください。

UpdateAvailability
rpc UpdateAvailability(UpdateAvailabilityRequest) returns (Availability) 人間のユーザーの空き状況情報を更新します。このメソッドで更新できるのは custom_status フィールドのみです。 このメソッドは、認証済みユーザーの空き状況のみを更新します。 次のいずれかの認可スコープを使用したユーザー認証が必要です。 https://www.googleapis.com/auth/chat.users.availability 認可スコープ 次の OAuth スコープが必要です。 https://www.googleapis.com/auth/chat.users.availability 詳しくは、承認ガイドをご覧ください。

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 詳しくは、承認ガイドをご覧ください。

UpdateSection
rpc UpdateSection(UpdateSectionRequest) returns (Section) セクションを更新します。更新できるのは、CUSTOM_SECTION タイプのセクションのみです。詳しくは、Google Chat でセクションを作成、整理するをご覧ください。 認可スコープを使用したユーザー認証が必要です。 https://www.googleapis.com/auth/chat.users.sections 認可スコープ 次の OAuth スコープが必要です。 https://www.googleapis.com/auth/chat.users.sections 詳しくは、承認ガイドをご覧ください。

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 に基づく一般的なメッセージが送信されます。

メモ

アノテーションは、メッセージの書式なしテキスト本文に関連付けることも、start_index と length が 0 の Google ドキュメントやスプレッドシートなどの Google Workspace リソースにリンクするチップに関連付けることもできます。テキスト メッセージに基本的な書式設定を追加するには、テキスト メッセージの書式設定をご覧ください。

書式なしテキストのメール本文の例:

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 このアノテーションが対応する、書式なしテキストのメール本文内の部分文字列の長さ。存在しない場合は、長さが 0 であることを示します。
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 メニューからコマンドを選択する。
MESSAGE_ACTION	メッセージ アクション。ユーザーが Chat のメッセージ コンテキスト メニューからコマンドを選択します。

AttachedGif

URL で指定された GIF 画像。

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

添付ファイル

Google Chat の添付ファイル。

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

オーディエンス

Google Chat のターゲット ユーザー。対象グループは、Google Workspace 組織内のユーザーのグループを表し、管理者が定義します。対象グループは、リソースのアクセスと公開設定を構成するために使用されます。たとえば、特定のユーザー グループがスペースを検出できるように設定できます。

詳しくは、対象グループと対象グループがスペースを検出できるようにするをご覧ください。

フィールド
name	string スペースを検索または参加できるターゲット ユーザーのリソース名。詳しくは、対象グループがスペースを検出できるようにするをご覧ください。形式: audiences/{audience} Google Workspace 組織のデフォルトの対象グループを使用するには、audiences/default に設定します。

対象

Google Chat でのユーザーの現在の空き状況情報（ステータス（アクティブ、オフライン、サイレント モードなど）やカスタム ステータスなど）を表します。

フィールド
name	string ID。ユーザーの空き状況のリソース名。 形式: users/{user}/availability {user} は、People API または Admin SDK Directory API のユーザーの ID です。例: users/123456789 ユーザーのメールアドレスまたは me を、呼び出し元を参照するエイリアスとして使用することもできます。たとえば、users/[e-mail] や users/me です。
state	State 出力専用。ユーザーの現在の空き状況。
custom_status	CustomStatus 省略可。ユーザーのカスタム ステータス。
共用体フィールド state_metadata。ユーザーの空き状況に関連付けられた追加のメタデータ。state_metadata は次のいずれかになります。
do_not_disturb_metadata	DoNotDisturbMetadata 出力専用。ユーザーの状態が DO_NOT_DISTURB に設定されている場合のメタデータ。

州

ユーザーの現在の対応可能状態を表します。

列挙型
STATE_UNSPECIFIED	デフォルト値。状態は指定されていません。
ACTIVE	ユーザーは最近のアクティビティに基づいて現在アクティブです。
IDLE	ユーザーは現在アイドル状態です。この状態は、ACTIVE の後に一定時間操作が行われなかったことを示します。この後、AWAY に移行する可能性があります。
AWAY	ユーザーは現在不在です。この状態は、ACTIVE 状態または IDLE 状態で一定期間操作が行われなかった後に自動的に設定されるか、ユーザーが手動で設定できます。MarkAsAway を使用して手動で設定した場合、この状態はユーザー アクティビティに関係なく維持されます。
DO_NOT_DISTURB	ユーザーがサイレント モードの状態（手動で設定）

CalendarEventLinkData

カレンダーの予定リンクのデータ。

フィールド
calendar_id	string リンクされたカレンダーのカレンダー ID。
event_id	string リンクされたカレンダーの予定の予定 ID。

CardWithId

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

Chat 用アプリは、アプリ認証を使用してカードを作成できます。デベロッパー プレビュー プログラムの一環として、Chat アプリがユーザーとして認証されると、カード メッセージを作成できます。Chat アプリがデベロッパー プレビュー プログラムに参加していない場合、ユーザー認証付きのカードを作成することはできません。

カードを含むメッセージを作成する方法については、メッセージを送信するをご覧ください。

カードビルダーを使用してカードを設計し、プレビューする。

カードビルダーを開く

フィールド
card_id	string メッセージに複数のカードが含まれている場合は必須です。メッセージ内のカードの固有識別子。
card	Card カード。最大サイズは 32 KB です。
owner_user	User 出力専用。カードを所有するアプリ。

ChatSpaceLinkData

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

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

引用

デベロッパー プレビュー: Google Workspace デベロッパー プレビュー プログラムの一部として利用できます。このプログラムでは、特定の機能に早期アクセスできます。

引用は、インライン参照に関する詳細情報をユーザーに提供できるインライン参照です。対応するインライン引用は、<chat-citation data-id="{id}">{text}</chat-citation> のマークアップ形式でメッセージ テキストに含める必要があります。引用は、メッセージの markup_syntax が MARKDOWN に設定されている場合にのみサポートされます。

Elements.citations 内の参照されていない引用（メッセージ テキストに一致する <chat-citation> タグがない引用）は無視され、メッセージが拒否される原因にはなりません。

フィールド
id	string 必須。アプリで定義された ID。ASCII 文字と数字のみを使用し、63 文字未満にする必要があります。
cited_sources[]	CitedSource 省略可。引用に関連するソースのリスト。ソースは引用のポップアップ カードに表示されます。

CitedSource

デベロッパー プレビュー: Google Workspace デベロッパー プレビュー プログラムの一部として利用できます。このプログラムでは、特定の機能に早期アクセスできます。

情報源への参照。

フィールド
title	string 必須。CitedSource の書式なしテキストのタイトル。このフィールドは書式設定をサポートしていません。
uri	string 必須。この CitedSource によって参照されるリソースを指す URI。
snippet	Snippet 省略可。ソースから直接取得した情報を含むスニペット。
footer	Footer 省略可。スニペットとともにフッターの形式で表示される追加情報。

フッター

デベロッパー プレビュー: Google Workspace デベロッパー プレビュー プログラムの一部として利用できます。このプログラムでは、特定の機能に早期アクセスできます。

ソースのフッター。アトリビューションに使用されます。

フィールド
text	string 省略可。フッターに表示するテキスト。

スニペット

デベロッパー プレビュー: Google Workspace デベロッパー プレビュー プログラムの一部として利用できます。このプログラムでは、特定の機能に早期アクセスできます。

より大きなコーパスからの抜粋を表すスニペット オブジェクト。

フィールド
text	string 省略可。コーパスから直接取得された短いプレーンテキストの抜粋。Chat でレンダリングされる可能性があります。マークダウン形式はサポートされていません。
image_preview	ElementsImage 省略可。引用の作成時に入力として提供されたスニペットの画像プレビュー。

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 必須。メンバーシップを作成するスペースのリソース名。 形式: spaces/{space}
membership	Membership 必須。作成するメンバーシップ関係。 memberType フィールドには、user.name フィールドと user.type フィールドが入力されたユーザーが含まれている必要があります。サーバーはリソース名を割り当て、指定されたものを上書きします。 Chat 用アプリが人間のユーザーのメンバーシップ関係を作成する場合は、特定の認可スコープを使用し、特定のフィールドに特定の値を設定する必要があります。 ユーザーとして認証する場合は、chat.memberships 認可スコープが必要です。 アプリとして認証する場合は、chat.app.memberships 認可スコープが必要です。 user.type を HUMAN に設定し、user.name を users/{user} 形式で設定します。ここで、{user} はユーザーのメールアドレスにできます。同じ Workspace 組織内のユーザーの場合、{user} は People API の person の id、または Directory API のユーザーの id にすることもできます。たとえば、[e-mail] の People API Person プロファイル 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 組織外のユーザーのメンバーシップを作成したりすることはできません。

CreateMessageNotificationOptions

メッセージが投稿されたときの通知動作のオプション。

フィールド
notification_type	NotificationType メッセージの通知タイプ。

NotificationType

メッセージの通知タイプのオプション。

列挙型
NOTIFICATION_TYPE_NONE	デフォルトの動作。通知の動作は、人間のユーザーが Chat UI を使用してメッセージを送信する場合と同様です。人間の送信者には通知は送信されません。
NOTIFICATION_TYPE_FORCE_NOTIFY	受信者に強制的に通知する。これにより、ユーザーのスペースの通知設定と Google Chat のサイレント モードの設定がバイパスされます。このオプションでは、デバイスレベルのサイレント モード設定はバイパスされません。 アプリ認証が必要です。
NOTIFICATION_TYPE_SILENT	受信者に通知せず、メールを未読としてマークしません。これは、ユーザーが会話をミュートしたり、Chat のサイレント モードを有効にしたりした場合と同様に動作します。 アプリ認証が必要です。

CreateMessagePinRequest

メッセージの固定を作成するためのリクエスト メッセージ。

フィールド
parent	string 必須。メッセージの固定を作成する親スペース。形式: spaces/{space}
message_pin	MessagePin 必須。作成する MessagePin。

CreateMessageRequest

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

フィールド
parent	string 必須。メッセージを作成するスペースのリソース名。 形式: spaces/{space}
message	Message 必須。メッセージ本文。
thread_key (deprecated)	string この項目は非推奨です。 省略可。非推奨: 代わりに、thread.thread_key を使用してください。スレッドの ID。最大 4,000 文字に対応します。スレッドを開始またはスレッドに追加するには、メッセージを作成し、threadKey または thread.name を指定します。使用例については、メッセージ スレッドを開始または返信するをご覧ください。
request_id	string 省略可。このリクエストの一意の ID。ランダムな UUID をおすすめします。リクエスト ID を指定すると、リクエストがべき等になり、同じリクエスト ID を持つ複数の同一のリクエストで作成されるメッセージが 1 つだけになります。同じリクエスト ID を持つ後続のリクエストは、リクエストされた詳細が現在の状態と異なる場合でも、既存のメッセージを返し、メッセージを更新しません。 このフィールドを効果的に使用するには: 後続のリクエストが元のリクエストと同じであり、同じ認証情報を使用していることを確認します。 指定されたリクエスト ID でメッセージがすでに作成されている場合、リクエストはそのメッセージを返します。返されたメッセージが完全に入力されていない場合があります。API は、システム割り当てのリソース名が入力されたリクエスト内のメッセージをエコーします。メッセージの最新のメタデータを取得するには、GetMessage を呼び出します。 別の認証済みユーザーで既存のリクエスト ID を再利用すると、エラーが発生します。
message_reply_option	MessageReplyOption 省略可。メッセージがスレッドを開始するか、スレッドに返信するかを指定します。名前付きスペースでのみサポートされます。 ユーザー インタラクションに応答する場合、このフィールドは無視されます。スレッド内のやり取りの場合、返信は同じスレッドに作成されます。それ以外の場合、返信は新しいスレッドとして作成されます。
message_id	string 省略可。メッセージのカスタム ID。Chat 用アプリは、メッセージのリソース名（メッセージの name フィールドに表示）にシステム割り当て ID を保存しなくても、メッセージの取得、更新、削除を行うことができます。 このフィールドの値は、次の要件を満たす必要があります。 client- で始まる。たとえば、client-custom-name は有効なカスタム ID ですが、custom-name は無効です。 63 文字以下で、英小文字、数字、ハイフンのみを使用します。 スペース内で一意です。Chat 用アプリは、異なるメッセージに同じカスタム ID を使用することはできません。 詳しくは、メッセージに名前を付けるをご覧ください。
create_message_notification_options	CreateMessageNotificationOptions 省略可。メッセージが投稿されたときの通知動作を制御します。詳細については、通知を強制する、またはサイレント メッセージを送信するをご覧ください。

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 必須。作成するリアクション。

CreateSectionRequest

セクションを作成するためのリクエスト メッセージ。

フィールド
parent	string 必須。セクションが作成される親リソース名。 形式: users/{user}
section	Section 必須。作成するセクション。

CreateSpaceRequest

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

フィールド
space	Space 必須。displayName フィールドと spaceType フィールドは必須です。SpaceType.SPACE と SpaceType.GROUP_CHAT のみがサポートされています。SpaceType.GROUP_CHAT は、importMode が true に設定されている場合にのみ使用できます。 エラー メッセージ ALREADY_EXISTS が表示された場合は、別の displayName をお試しください。Google Workspace 組織内の既存のスペースで、この表示名がすでに使用されている可能性があります。 スペース name はサーバーに割り当てられているため、このフィールドで指定されたものはすべて無視されます。
request_id	string 省略可。このリクエストの一意の ID。ランダムな UUID をおすすめします。リクエスト ID を指定すると、リクエストがべき等になり、同じリクエスト ID を持つ複数の同一リクエストで作成されるスペースが 1 つだけになります。同じリクエスト ID を使用した後続のリクエストでは、リクエストされた詳細が現在の状態と異なる場合でも、既存のスペースが返され、スペースは更新されません。 このフィールドを効果的に使用するには: 後続のリクエストが元のリクエストと同じであり、同じ認証情報を使用していることを確認します。 指定されたリクエスト ID でスペースがすでに作成されている場合、リクエストはそのスペースを返します。返されるスペースは完全に入力されていない可能性があります。API は、システム割り当てのリソース名が入力されたリクエスト内のスペースをエコーします。スペースの最新のメタデータを取得するには、GetSpace を呼び出します。 別の認証済みユーザーで既存のリクエスト 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 カスタム絵文字。

CustomStatus

Google Chat でのユーザーのカスタム ステータスを表します。これには、ユーザーが自分の空き状況に関するコンテキストをさらに提供するために設定する、短いテキスト メッセージとオプションの絵文字が含まれます。

フィールド
text	string 必須。カスタム ステータスのテキスト。これは最大 64 文字の文字列です。
emoji	Emoji 必須。カスタム ステータスの絵文字。Unicode 絵文字のみがサポートされています。カスタム絵文字はサポートされていません。
共用体フィールド expiration。カスタム ステータスの有効期限。絶対タイムスタンプまたは有効期間として指定できます。expiration は次のいずれかになります。
expire_time	Timestamp カスタム ステータスの有効期限を示すタイムスタンプ。
ttl	Duration 入力専用。カスタム ステータスの有効期限が切れるまでの有効期間。

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 スコープが必要です。 管理者権限を使用してスペース内のアプリ メンバーシップを削除することはできません。

DeleteMessagePinRequest

メッセージの固定を解除するためのリクエスト メッセージ。

フィールド
name	string 必須。削除するメッセージ ピンのリソース名。形式: spaces/{space}/messagePins/{message_pin}

DeleteMessageRequest

メッセージを削除するリクエスト。

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

DeleteReactionRequest

メッセージへのリアクションを削除します。

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

DeleteSectionRequest

セクションを削除するためのリクエスト メッセージ。

デベロッパー プレビュー: Google Workspace デベロッパー プレビュー プログラムの一部として利用できます。このプログラムでは、特定の機能に早期アクセスできます。

フィールド
name	string 必須。削除するセクションの名前。 形式: users/{user}/sections/{section}

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 入力専用。リクエストのダイアログ。

DoNotDisturbMetadata

DO_NOT_DISTURB の在庫状況に関連付けられたメタデータ。在庫状況の有効期限を指定します。

フィールド
expiration_time	Timestamp 出力専用。ユーザーを DO_NOT_DISTURB としてマークする期限のタイムスタンプ。最長 1 年先まで設定できます。

DriveDataRef

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

フィールド
drive_file_id	string ドライブ ファイルの ID。Drive API と組み合わせて使用します。

DriveLinkData

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

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

要素

デベロッパー プレビュー: Google Workspace デベロッパー プレビュー プログラムの一部として利用できます。このプログラムでは、特定の機能に早期アクセスできます。

要素は、メッセージの作成時に指定されたメッセージ テキストに関連付けられる場合と関連付けられない場合がある追加のコンポーネントです。

フィールド
cited_sources[]	CitedSource メッセージの下にフッターリンクとして表示されるソースのリスト。これらはインラインで参照されません。インライン参照には citations を使用します。
citations[]	Citation メッセージ テキスト内で（<chat-citation> タグを介して）参照されるインライン引用のリスト。インタラクティブなポップアップ カードとしてレンダリングされます。

ElementsImage

デベロッパー プレビュー: Google Workspace デベロッパー プレビュー プログラムの一部として利用できます。このプログラムでは、特定の機能に早期アクセスできます。

画像を表すさまざまな方法をカプセル化するオブジェクト。現在サポートされている表現: - URI から取得された画像。今後、他の表現もサポートされる可能性があります。

フィールド
共用体フィールド image。必須。サポートされている画像表現のいずれか。image は次のいずれかになります。
image_uri	string 必須。画像の一般公開 URI。

絵文字

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

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

EmojiReactionSummary

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

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

FindDirectMessageRequest

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

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

FindGroupChatsRequest

ユーザー リソースに基づいてグループ チャット スペースを取得するリクエスト。

フィールド
users[]	string 省略可。呼び出し元ユーザーとのグループ チャットに参加しているすべての人間ユーザーのリソース名。Chat アプリをリクエストに含めることはできません。 1 つのリクエストで指定できるユーザーの最大数は 49 人です。 形式: users/{user}。{user} は、People API のユーザーの id、または Directory API のユーザーの id です。たとえば、呼び出し元のユーザーと、People API プロファイル ID が 123456789 と 987654321 の 2 人のユーザーを含むすべてのグループ チャットを検索するには、users/123456789 と users/987654321 を使用します。このメールアドレスを {user} のエイリアスとして使用することもできます。たとえば、users/[e-mail]（[e-mail] は Google Chat ユーザーのメールアドレス）。
page_size	int32 省略可。返されるスペースの最大数。サービスが返す値はこれよりも少ないことがあります。 指定されていない場合、最大で 10 個のスペースが返されます。 最大値は 30 です。30 を超える値を使用すると、自動的に 30 に変更されます。 負の値を指定すると、INVALID_ARGUMENT エラーが返されます。
page_token	string 省略可。前回のグループ チャットの検索呼び出しから受け取ったページトークン。後続のページを取得するには、このパラメータを指定します。 ページ分割を行う場合、指定する他のすべてのパラメータは、トークンを提供した呼び出しと一致する必要があります。異なる値を渡すと、予期しない結果になる可能性があります。
space_view	SpaceView リクエストされたスペースビューのタイプ。設定しない場合、デフォルトの SPACE_VIEW_RESOURCE_NAME_ONLY が使用されます。SPACE_VIEW_EXPANDED を指定するリクエストには、スペースデータの読み取りを許可するスコープ（https://www.googleapis.com/auth/chat.spaces や https://www.googleapis.com/auth/chat.spaces.readonly など）を含める必要があります。

FindGroupChatsResponse

呼び出し元のユーザーとリクエストされたユーザーのみを含むグループ チャット スペースを含むレスポンス。

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

ForwardedMetadata

メッセージの転送元のスペースに関するメタデータ。

フィールド
space	string 出力専用。ソーススペースのリソース名。形式: spaces/{space}
space_display_name	string 出力専用。転送時の転送元スペースまたは DM の表示名。SPACE の場合、これはスペース名です。DIRECT_MESSAGE の場合、これは他の参加者の名前（「ユーザー A」など）です。GROUP_CHAT の場合、これはメンバーの名前を基に生成された名前で、作成者を含めて 5 人までに制限されます（例: 「ユーザー A、ユーザー B」）。

GetAttachmentRequest

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

フィールド
name	string 必須。アタッチメントのリソース名（spaces/{space}/messages/{message}/attachments/{attachment} 形式）。

GetAvailabilityRequest

GetAvailability メソッドに対するリクエスト メッセージ。

フィールド
name	string 必須。取得する空き状況のリソース名。 形式: users/{user}/availability {user} は、People API または Admin SDK Directory API のユーザーの ID です。例: users/123456789 ユーザーのメールアドレスまたは me を、呼び出し元を参照するエイリアスとして使用することもできます。たとえば、users/[e-mail] や users/me です。

GetCustomEmojiRequest

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

フィールド
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 を設定している場合は、clientAssignedMessageId フィールドの値を {message} に使用できます。詳しくは、メッセージに名前を付けるをご覧ください。
markup_syntax	MarkupSyntax 省略可。Chat メッセージの formatted_text フィールドに必要な出力構文を指定します。

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

1 つのスペースを返すリクエスト。

フィールド
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 個のメンバーシップが返されます。 最大値は 1,000 です。1,000 を超える値を使用すると、自動的に 1,000 に変更されます。 負の値を指定すると、INVALID_ARGUMENT エラーが返されます。
page_token	string 省略可。前回の list 呼び出しから受け取ったページトークン。後続のページを取得するには、このパラメータを指定します。 ページ分割を行う場合、指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。他のパラメータに異なる値を渡すと、予期しない結果になる可能性があります。
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 として送信できるトークン。空の場合、後続のページはありません。

ListMessagePinsRequest

メッセージ ピンを一覧表示するためのリクエスト メッセージ。

フィールド
parent	string 必須。固定されたアイテムのコレクションを所有する親スペース。形式: spaces/{space}
page_size	int32 省略可。返されるメッセージ ピンの最大数。サービスが返すメッセージの数は、この値より少ない場合があります。最大値は 100 です。100 を超える値を使用すると、自動的に 100 に変更されます。指定されていない場合は、最大で 100 個のメッセージ ピンが返されます。負の値を指定すると、INVALID_ARGUMENT エラーが返されます。
page_token	string 省略可。前回の list message pins 呼び出しから受け取ったページトークン。後続のページを取得するには、このパラメータを指定します。 ページ分割を行う場合、指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。他のパラメータに異なる値を渡すと、予期しない結果になる可能性があります。

ListMessagePinsResponse

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

フィールド
message_pins[]	MessagePin 指定されたスペースの固定表示されたメッセージ。
next_page_token	string トークンを pageToken として送信すると、結果の次のページを取得できます。空の場合、後続のページはありません。

ListMessagesRequest

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

フィールド
parent	string 必須。メッセージを一覧表示するスペースのリソース名。 形式: spaces/{space}
page_size	int32 省略可。返されるメッセージの最大数。サービスが返すメッセージの数は、この値より少ない場合があります。 指定されていない場合、最大で 25 個が返されます。 最大値は 1,000 です。1,000 を超える値を使用すると、自動的に 1,000 に変更されます。 負の値を指定すると、INVALID_ARGUMENT エラーが返されます。
page_token	string 省略可。前回の list messages 呼び出しから受け取ったページトークン。後続のページを取得するには、このパラメータを指定します。 ページ分割を行う場合、指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。他のパラメータに異なる値を渡すと、予期しない結果になる可能性があります。
filter	string 省略可。クエリフィルタ。 メッセージは日付（create_time）とスレッド（thread.name）でフィルタできます。 作成日でメッセージをフィルタするには、RFC-3339 形式のタイムスタンプと二重引用符を使用して create_time を指定します。例: "2023-04-21T11:30:00-04:00"。大なり演算子 > を使用すると、タイムスタンプより後に作成されたメッセージを一覧表示できます。小なり演算子 < を使用すると、タイムスタンプより前に作成されたメッセージを一覧表示できます。特定の期間内のメッセージをフィルタするには、2 つのタイムスタンプの間で AND 演算子を使用します。 スレッドでフィルタするには、thread.name を spaces/{space}/threads/{thread} の形式で指定します。クエリごとに指定できる 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 省略可。削除されたメッセージを含めるかどうか。削除されたメッセージには、削除された時刻と削除に関するメタデータが含まれますが、メッセージの内容は利用できません。
markup_syntax	MarkupSyntax 省略可。Chat メッセージの formatted_text フィールドに必要な出力構文を指定します。

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 演算子を使用して、類似したフィールドを結合します。 絵文字とユーザーでリアクションをフィルタするには、AND 演算子（emoji.unicode = "🙂" AND user.name = "users/AAAAAA" など）を使用します。 クエリで 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 結果の次のページを取得するための継続トークン。結果の最後のページでは空になります。

ListSectionItemsRequest

セクション アイテムを一覧表示するためのリクエスト メッセージ。

フィールド
parent	string 必須。親。このセクション アイテムのコレクションを所有するセクション リソース名です。呼び出し元ユーザーのセクション アイテムの一覧表示のみをサポートします。 スペースでフィルタする場合は、ワイルドカード - を使用してすべてのセクションを検索します。例: users/{user}/sections/- 形式: users/{user}/sections/{section}
page_size	int32 省略可。返されるセクション アイテムの最大数。サービスから返される数は、この値より少ない場合があります。 指定されていない場合は、最大で 10 個のセクション アイテムが返されます。 最大値は 100 です。100 を超える値を使用すると、自動的に 100 に変更されます。 負の値を指定すると、INVALID_ARGUMENT エラーが返されます。
page_token	string 省略可。前回の list section items 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。 ページ分割を行う場合、指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。他のパラメータに異なる値を渡すと、予期しない結果になる可能性があります。
filter	string 省略可。クエリフィルタ。 現在、スペースによるフィルタリングのみがサポートされています。 例: space = spaces/{space} 無効なクエリは INVALID_ARGUMENT エラーで拒否されます。

ListSectionItemsResponse

セクション アイテムを一覧表示するためのレスポンス メッセージ。

フィールド
section_items[]	SectionItem 指定されたセクションのセクション アイテム。
next_page_token	string 次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

ListSectionsRequest

セクションを一覧表示するリクエスト メッセージ。

フィールド
parent	string 必須。親。このセクション コレクションを所有するユーザー リソース名です。呼び出し元ユーザーのセクションの一覧表示のみをサポートします。呼び出し元のユーザーを参照するには、次のいずれかを設定します。 me エイリアス。例: users/me Workspace のメールアドレス。例: users/[e-mail] ユーザー ID。例: users/123456789 形式: users/{user}
page_size	int32 省略可。返されるセクションの最大数。サービスから返される数は、この値より少ない場合があります。 指定されていない場合は、最大で 10 セクションが返されます。 最大値は 100 です。100 を超える値を使用すると、自動的に 100 に変更されます。 負の値を指定すると、INVALID_ARGUMENT エラーが返されます。
page_token	string 省略可。前回の list sections 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。 ページ分割を行う場合、指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。他のパラメータに異なる値を渡すと、予期しない結果になる可能性があります。

ListSectionsResponse

セクションの一覧表示に対するレスポンス メッセージ。

フィールド
sections[]	Section 指定したユーザーのセクション。
next_page_token	string 次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

ListSpaceEventsRequest

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

フィールド
parent	string 必須。イベントが発生した Google Chat スペースのリソース名。 形式: spaces/{space}。
page_size	int32 省略可。返されるスペース イベントの最大数。サービスが返す値はこれよりも少ないことがあります。 負の値を指定すると、INVALID_ARGUMENT エラーが返されます。
page_token	string 省略可。前回のスペース イベント一覧呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。 ページ分割を行う場合、スペース イベントの一覧表示に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。他のパラメータに異なる値を渡すと、予期しない結果になる可能性があります。
filter	string 必須。クエリフィルタ。 : 演算子を使用して、少なくとも 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 個のスペースが返されます。 最大値は 1,000 です。1,000 を超える値を使用すると、自動的に 1,000 に変更されます。 負の値を指定すると、INVALID_ARGUMENT エラーが返されます。
page_token	string 省略可。前回の list spaces 呼び出しから受け取ったページトークン。後続のページを取得するには、このパラメータを指定します。 ページ分割を行う場合、フィルタ値はページトークンを提供した呼び出しと一致する必要があります。別の値を渡すと、予期しない結果になる可能性があります。
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 として送信すると、結果の次のページを取得できます。空の場合、後続のページはありません。

MarkAsActiveRequest

MarkAsActive メソッドに対するリクエスト メッセージ。

フィールド
name	string 必須。アクティブとしてマークする空き状況のリソース名。形式: users/{user}/availability {user} は、People API または Admin SDK Directory API のユーザーの ID です。例: users/123456789 ユーザーのメールアドレスまたは me を、呼び出し元を参照するエイリアスとして使用することもできます。たとえば、users/[e-mail] や users/me です。
共用体フィールド expiration。ACTIVE の可用性状態の有効期限。有効期限が切れると、ユーザーは [退席中] としてマークされます。有効期限が指定されていない場合、ACTIVE 状態は現在の時刻から 30 分後に期限切れになります。expiration は次のいずれかになります。
expire_time	Timestamp ACTIVE 状態が期限切れになる絶対タイムスタンプ。
ttl	Duration 現在から ACTIVE 状態が期限切れになるまでの期間。短い TTL を使用すると、この短い期間の後のアクティビティに基づいてユーザーの状態を効果的にリセットできます。

MarkAsAwayRequest

MarkAsAway メソッドに対するリクエスト メッセージ。

フィールド
name	string 必須。不在としてマークする空き状況のリソース名。形式: users/{user}/availability {user} は、People API または Admin SDK Directory API のユーザーの ID です。例: users/123456789 ユーザーのメールアドレスまたは me を、呼び出し元を参照するエイリアスとして使用することもできます。たとえば、users/[e-mail] や users/me です。

MarkAsDoNotDisturbRequest

MarkAsDoNotDisturb メソッドに対するリクエスト メッセージ。

フィールド
name	string 必須。サイレント モードとしてマークする空き状況のリソース名。形式: users/{user}/availability {user} は、People API または Admin SDK Directory API のユーザーの ID です。例: users/123456789 ユーザーのメールアドレスまたは me を、呼び出し元を参照するエイリアスとして使用することもできます。たとえば、users/[e-mail] や users/me です。
共用体フィールド expiration。必須。DND の対応可能状態の有効期限。有効期限が切れると、ユーザーは [退席中] としてマークされます。指定できるのは、現在の時刻から 1 年先までです。expiration は次のいずれかになります。
expire_time	Timestamp DND 状態が終了する絶対タイムスタンプ。
ttl	Duration 現在の時刻から DND 状態が期限切れになるまでの期間。

MarkupSyntax

チャット メッセージ テキストの書式設定に使用するマークアップ構文を指定します。Message リソースの text フィールドに適用されます。

列挙型
MARKUP_SYNTAX_UNSPECIFIED	未指定の値を表します。
MARKUP_SYNTAX_CHAT	Google Chat のマークアップ構文を使用します。詳しくは、https://developers.google.com/workspace/chat/format-messages#format-texts をご覧ください。
MARKUP_SYNTAX_MARKDOWN	Markdown 構文を使用します。この構文は CommonMark 仕様に基づいており、追加の拡張機能が用意されています。詳しくは、https://developers.google.com/workspace/chat/format-messages#format-texts をご覧ください。

MatchedUrl

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

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

MeetSpaceLinkData

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

フィールド
meeting_code	string リンクされた Meet スペースの会議コード。
type	Type Meet スペースのタイプを示します。
huddle_status	HuddleStatus 省略可。出力専用。Meet がハドルの場合、ハドルのステータスを示します。それ以外の場合、これは設定されません。

HuddleStatus

ハドルのステータス

列挙型
HUDDLE_STATUS_UNSPECIFIED	列挙型のデフォルト値。使用しないでください。
STARTED	ハドルが開始されました。
ENDED	ハドルが終了しました。この場合、Meet スペースの URI と ID は無効になります。
MISSED	ハドルは不在着信となりました。この場合、Meet スペースの URI と ID は無効になります。

タイプ

Meet スペースのタイプ。

列挙型
TYPE_UNSPECIFIED	列挙型のデフォルト値。使用しないでください。
MEETING	Meet のスペースは会議です。
HUDDLE	Meet スペースがハドルである。

メンバーシップ

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

フィールド
name	string ID。サーバーによって割り当てられたメンバーシップのリソース名。 形式: spaces/{space}/members/{member}
state	MembershipState 出力専用。メンバーシップの状態。
role	MembershipRole 省略可。Chat スペース内でのユーザーのロール。スペース内で許可される操作を決定します。 このフィールドは、UpdateMembership の入力としてのみ使用できます。
create_time	Timestamp 省略可。変更不可。メンバーシップの作成日時（メンバーがスペースに参加した日時、またはスペースへの参加に招待された日時など）。このフィールドは出力専用です。ただし、インポート モードのスペースで過去のメンバーシップをインポートするために使用される場合を除きます。
delete_time	Timestamp 省略可。変更不可。メンバーがスペースから退出したときや削除されたときなど、メンバーシップの削除日時。このフィールドは出力専用です。ただし、インポート モードのスペースで過去のメンバーシップをインポートするために使用される場合を除きます。
affiliation	Affiliation 出力専用。スペースを所有する Workspace 組織とのユーザーの関係。一般ユーザー向けアカウントが所有するスペースでは、すべてのメンバーの所属は EXTERNAL です。
共用体フィールド memberType。このメンバーシップに関連付けられているメンバー。今後、他のメンバータイプもサポートされる可能性があります。memberType は次のいずれかになります。
member	User 省略可。メンバーシップに対応する Google Chat ユーザーまたはアプリ。Chat アプリがユーザーとして認証する場合、出力には、内部ユーザーと外部ユーザーの両方の user name フィールドと type フィールドのみが入力されます。ただし、スペースのメンバーである場合や、呼び出し元ユーザーとのダイレクト メッセージ（DM）会話など、以前に親和性があった場合を除きます。
group_member	Group 省略可。メンバーシップが対応する Google グループ。 Google グループのメンバーシップを読み取りまたは変更するには、ユーザー認証が必要です。

所属

スペースを所有する Google Workspace 組織へのユーザーの所属を表します。この列挙型には、今後さらに値が追加される可能性があります。

列挙型
AFFILIATION_UNSPECIFIED	デフォルト値。この値は使用されません。
INTERNAL	スペースを所有する Google Workspace 組織によって管理されているアカウント。
EXTERNAL	スペースを所有する Google Workspace 組織外のアカウント（一般ユーザー向けアカウント、別の Workspace 組織が管理するアカウントなど）。
MANAGED_EXTERNAL	スペースを所有する Workspace 組織によって管理されているが、組織外のユーザー（ゲストユーザーなど）にプロビジョニングされているアカウント。ゲストについて詳しくは、https://support.google.com/chat/answer/16997417 をご覧ください。

MembershipRole

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

列挙型
MEMBERSHIP_ROLE_UNSPECIFIED	デフォルト値。users の場合: スペースのメンバーではありませんが、招待できます。Google Groups の場合: 常にこのロールが割り当てられます（今後、他の列挙値が使用される可能性があります）。
ROLE_MEMBER	スペースのメンバー。Chat UI では、このロールはメンバーと呼ばれます。 ユーザーには、スペースへのメッセージ送信などの基本的な権限があります。管理者とオーナーは、スペース内のメンバーに次のような追加の権限を付与できます。 メンバーを追加または削除する。 スペースの詳細を変更する。 履歴のオンまたはオフ。 @all を使用して、スペース内の全員にメンションします。 スペースにインストールされている Chat 用アプリと Webhook を管理する。 ダイレクト メッセージと名前のないグループ会話では、すべてのユーザーにこのロールが割り当てられます。
ROLE_MANAGER	スペースのオーナー。Chat UI では、このロールはオーナーと呼ばれます。 ユーザーには、スペースを管理するためのスペース権限がすべて付与されます。これには、次の権限が含まれます。 スペース内の他のメンバーのロールをメンバー、管理者、オーナーに変更する。 スペースを削除します。 SpaceType.SPACE（名前付きスペース）でのみサポートされています。 詳しくは、スペースのオーナーまたは管理者の役割についての記事をご覧ください。
ROLE_ASSISTANT_MANAGER	スペースの管理者。Chat UI では、このロールはマネージャーと呼ばれます。 ユーザーは ROLE_MEMBER のすべての基本権限を持ち、オーナーから管理権限のサブセットを付与されることができます。デフォルトでは、管理者はオーナーと同じ権限を持ちますが、以下の操作は行えません。 スペースを削除します。 別のスペース メンバーをオーナーにする。 オーナーのロールを変更する。 デフォルトでは、マネージャーの権限には以下が含まれます（ただし、これらに限定されません）。 別のメンバーを管理者に指定します。 スペース内のメッセージを削除する。 スペースの権限の管理。 スペースの設定で「メンバーを管理」権限が付与されている場合、スペースへの参加リクエストの通知を受け取る。 スペースを検索可能にする。 SpaceType.SPACE（名前付きスペース）でのみサポートされています。 詳しくは、スペースの設定を管理するをご覧ください。

MembershipState

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

列挙型
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 フィールドのみが入力されます。ただし、スペースのメンバーである場合や、呼び出し元ユーザーとのダイレクト メッセージ（DM）会話など、以前に親和性があった場合を除きます。
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:）。これは、Unicode 絵文字（笑顔の絵文字の U+1F600 など）には適用されません。 アスタリスク（*）を使用した箇条書きリストの項目（例: * item）。 詳しくは、メッセージで送信されたテキストの書式設定を表示するをご覧ください。
cards[] (deprecated)	Card この項目は非推奨です。 非推奨: 代わりに、cards_v2 を使用してください。 書式設定されたテキスト、ボタン、クリック可能な画像などの UI 要素を表示するために使用できる、書式設定されたインタラクティブなリッチカード。カードは通常、メッセージの書式なしテキストの本文の下に表示されます。cards と cards_v2 の最大サイズは 32 KB です。
cards_v2[]	CardWithId 省略可。カードの配列。 Chat 用アプリは、アプリ認証を使用してカードを作成できます。デベロッパー プレビュー プログラムの一環として、Chat アプリがユーザーとして認証されると、カード メッセージを作成できます。Chat アプリがデベロッパー プレビュー プログラムに参加していない場合、ユーザー認証付きのカードを作成することはできません。 カードを含むメッセージを作成する方法については、メッセージを送信するをご覧ください。 カードビルダーを使用してカードを設計し、プレビューする。 カードビルダーを開く
annotations[]	Annotation 出力専用。アノテーションは、メッセージの書式なしテキスト本文に関連付けることも、start_index と length が 0 の Google ドキュメントやスプレッドシートなどの Google Workspace リソースにリンクするチップに関連付けることもできます。
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 出力専用。Chat メッセージの text フィールドにある URL が、リンク プレビューのパターンと一致している。詳細については、リンクをプレビューするをご覧ください。
thread_reply	bool 出力専用。true の場合、メッセージは返信スレッド内の返信です。false の場合、メッセージはスペースの最上位の会話に、スレッドの最初のメッセージまたはスレッド返信のないメッセージとして表示されます。 スペースがスレッドでの返信をサポートしていない場合、このフィールドは常に false です。
silent	bool 出力専用。サイレント メッセージかどうか。サイレント メッセージとは、受信者へのプッシュ通知が Chat によって抑制されるメッセージです。
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 省略可。別のメッセージが引用するメッセージに関する情報。 メッセージを作成するときに、同じスレッド内のメッセージを引用したり、ルート メッセージを引用して新しいルート メッセージを作成したりできます。ただし、別のスレッドのメッセージ返信を引用することはできません。 メッセージを更新するときに、quotedMessageMetadata フィールドを追加または置換することはできませんが、削除することはできます。 使用例については、別のメッセージを引用するをご覧ください。
attached_gifs[]	AttachedGif 出力専用。メッセージに添付された GIF 画像。
accessory_widgets[]	AccessoryWidget 省略可。メッセージの下部に表示される 1 つ以上のインタラクティブ ウィジェット。アクセサリー ウィジェットは、テキスト、カード、またはテキストとカードの両方を含むメッセージに追加できます。ダイアログを含むメッセージではサポートされていません。詳細については、メッセージの下部にインタラクティブ ウィジェットを追加するをご覧ください。 アクセサリー ウィジェットを含むメッセージを作成するには、アプリ認証が必要です。
elements	Elements 省略可。要素は、メッセージの作成時に提供される追加のコンポーネントであり、メッセージ テキストの特定の部分に関連付けられている場合と、関連付けられていない場合があります。これはアノテーションとは異なります。アノテーションは出力専用で、メッセージ フラグメントまたはメッセージ テキスト全体に関連付けられた補足情報を提供します。 デベロッパー プレビュー: Google Workspace デベロッパー プレビュー プログラムの一部として利用できます。このプログラムでは、特定の機能に早期アクセスできます。
markup_syntax	MarkupSyntax 省略可。サーバーがメッセージの text フィールドの内容を解釈する方法を指定します。

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、deletionMetadata フィールドのみが入力されます。

MessagePin

チャット メッセージの固定。詳しくは、メッセージを固定するをご覧ください。

フィールド
name	string ID。メッセージ ピンのリソース名。形式: spaces/{space}/messagePins/{message_pin}。リソース ID コンポーネントは、メッセージのリソース ID コンポーネントと一致します。たとえば、spaces/AAA/messages/bbb.ccc を含むメッセージは、リソース名が spaces/AAA/messagePins/bbb.ccc のメッセージ ピンに対応します。
message	string 必須。変更不可。固定されたメッセージのリソース名。形式: spaces/{space}/messages/{message}

MessageUpdatedEventData

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

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

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

MoveSectionItemRequest

セクション間でセクション アイテムを移動するためのリクエスト メッセージ。

フィールド
name	string 必須。移動するセクション アイテムのリソース名。 形式: users/{user}/sections/{section}/items/{item}
target_section	string 必須。セクション アイテムの移動先となるセクションのリソース名。 形式: users/{user}/sections/{section}

MoveSectionItemResponse

セクション アイテムを移動するためのレスポンス メッセージ。

フィールド
section_item	SectionItem 更新されたセクション アイテム。

PositionSectionRequest

セクションを配置するためのリクエスト メッセージ。

フィールド
name	string 必須。配置するセクションのリソース名。 形式: users/{user}/sections/{section}
共用体フィールド position。必須。セクションの新しい位置。position は次のいずれかになります。
sort_order	int32 省略可。セクションのリスト内でのセクションの絶対位置。位置は 0 より大きい値にする必要があります。位置がセクション数より大きい場合、セクションはリストの末尾に追加されます。このオペレーションでは、指定された位置にセクションが挿入され、その位置にあった元のセクションとその下のセクションが次の位置にシフトされます。
relative_position	Position 省略可。セクションのリスト内でのセクションの相対位置。

ポジション

セクションの位置。

列挙型
POSITION_UNSPECIFIED	位置が指定されていません。
START	セクションのリストの開始。
END	セクションのリストの終わり。

PositionSectionResponse

セクションを配置するためのレスポンス メッセージ。

フィールド
section	Section 更新されたセクション。

QuotedMessageMetadata

別のメッセージが引用するメッセージに関する情報。

メッセージを更新するときに、quotedMessageMetadata フィールドを追加または置換することはできませんが、削除することはできます。

使用例については、別のメッセージを引用するをご覧ください。

フィールド
name	string 必須。引用されたメッセージのリソース名。 形式: spaces/{space}/messages/{message}
last_update_time	Timestamp 必須。引用されたメッセージが作成されたとき、または引用されたメッセージが最後に更新されたときのタイムスタンプ。 メッセージが編集された場合は、このフィールド last_update_time を使用します。メッセージが編集されていない場合は、create_time を使用します。 last_update_time が引用メッセージの最新バージョンと一致しない場合、リクエストは失敗します。
quote_type	QuoteType 省略可。見積もりの種類を指定します。設定されていない場合、下位互換性のために、メッセージの読み取り/書き込みパスでデフォルトの REPLY になります。
quoted_message_snapshot	QuotedMessageSnapshot 出力専用。引用されたメッセージの内容のスナップショット。
forwarded_metadata	ForwardedMetadata 出力専用。引用されたメッセージのソーススペースに関するメタデータ。FORWARD 見積もりタイプの場合にのみ入力されます。

QuoteType

引用されたメッセージの引用タイプ。

列挙型
QUOTE_TYPE_UNSPECIFIED	Reserved. この値は使用されません。
REPLY	quote_type が REPLY の場合、次の操作を行うことができます。 スレッド内で返信する場合は、そのスレッド内の別のメッセージを引用できます。 ルート メッセージを作成する場合は、そのスペース内の別のルート メッセージを引用できます。
FORWARD	quote_type が FORWARD の場合、以下を引用できます。 別のスペースからのメッセージ。 同じスペース内の別のスレッドからのメッセージ返信。

QuotedMessageSnapshot

引用または転送時の引用メッセージの内容のスナップショットを提供します。

フィールド
sender	string 出力専用。引用されたメッセージの作成者の名前。REPLY と FORWARD の両方の引用タイプに入力されます。
text	string 出力専用。引用されたメッセージのテキスト コンテンツのスナップショット。
formatted_text	string 出力専用。引用メッセージ text が含まれます。ハイパーリンク、カスタム絵文字、マークアップなどのリッチ フォーマットをサポートするためにマークアップが追加されています。FORWARD 引用タイプの場合にのみ入力されます。
annotations[]	Annotation 出力専用。引用メッセージのテキスト本文から解析されたアノテーション。FORWARD 見積もりタイプの場合にのみ入力されます。
attachments[]	Attachment 出力専用。引用されたメッセージに含まれていた添付ファイル。これらは、引用されたメッセージの添付ファイルのメタデータのコピーです。FORWARD 引用タイプに対してのみ入力されます。

リアクション

メッセージへのリアクション。

フィールド
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 削除されたリアクション。

ReplaceMessageCardsRequest

ReplaceMessageCards API メソッドのリクエスト メッセージ。

フィールド
name	string 必須。メッセージのリソース名。 形式: spaces/{space}/messages/{message}
cards_v2[]	CardWithId 省略可。メッセージに含めるカードの配列。これらのカードは、メッセージの既存のカードに置き換わります。空の場合、メッセージに含まれる元のカードはクリアされます。

ReplaceMessageCardsResponse

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

ReplaceMessageCards API のレスポンス メッセージ。

RichLinkMetadata

リソースへのリッチリンク。リッチリンクは、メッセージの書式なしテキスト本文に関連付けることも、start_index と length が 0 の Google ドキュメントやスプレッドシートなどの Google Workspace リソースにリンクするチップを表すこともできます。

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

RichLinkType

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

列挙型
RICH_LINK_TYPE_UNSPECIFIED	列挙型のデフォルト値。使用しないでください。
DRIVE_FILE	Google ドライブのリッチリンク タイプ。
CHAT_SPACE	Chat スペースのリッチリンク タイプ。（例: スペースのスマートチップ）。
GMAIL_MESSAGE	Gmail メッセージのリッチリンク タイプ。具体的には、[Chat に共有] の Gmail チップです。この API は、GMAIL_MESSAGE リンクを含むメッセージの読み取りのみをサポートしています。
MEET_SPACE	Meet メッセージのリッチリンク タイプ。（例: Meet チップ）。
CALENDAR_EVENT	カレンダー メッセージのリッチリンク タイプ。たとえば、カレンダー チップです。

SearchMessageResult

メッセージ検索の 1 つの結果アイテム。

フィールド
message	Message 一致したメッセージ。
space_mute_setting	MuteSetting メッセージが投稿されたスペースの呼び出し元ユーザーのミュート設定。呼び出し元アプリは、この情報を使用して、スペースがユーザーに対してミュートされているかどうかに応じて、メッセージの処理方法を決定できます。 リクエスト ビューが SEARCH_MESSAGES_VIEW_FULL で、呼び出し元の認証情報に次の認可スコープが含まれている場合にのみ返されます。 https://www.googleapis.com/auth/chat.users.spacesettings
read	bool 一致したメッセージが呼び出し元のユーザーによって読み取られたかどうかを示します。 リクエスト ビューが SEARCH_MESSAGES_VIEW_FULL で、呼び出し元の認証情報に次のいずれかの認可スコープが含まれている場合にのみ返されます。 https://www.googleapis.com/auth/chat.users.readstate.readonly https://www.googleapis.com/auth/chat.users.readstate

SearchMessagesRequest

メッセージを検索するためのリクエスト メッセージ。

フィールド
parent	string 必須。検索対象のスペースのリソース名。 ユーザーがアクセスできるすべてのスペースを検索するには、このフィールドを spaces/- に設定します。parent に他の値を使用すると、INVALID_ARGUMENT エラーが発生します。 検索を 1 つ以上のスペースに制限するには、filter で space.name または space.display_name を使用します。
filter	string 必須。検索クエリ。 クエリでは、結果のフィルタに使用される 1 つ以上の検索広告キーワードを指定できます。 次のメッセージ フィールドを使用して結果をフィルタすることもできます。 create_time: RFC-3339 形式のタイムスタンプを受け入れます。サポートされている比較演算子は < と >= です。 sender.name: 送信者のリソース名（users/{user}）。= のみをサポートしています。このメールアドレスは {user} のエイリアスとして使用できます。たとえば、users/[e-mail]。ここで、[e-mail] は Google Chat ユーザーのメールアドレスです。 space.name: メッセージが投稿されるスペースのリソース名。（spaces/{space}）。= のみをサポートします。このフィルタが設定されていない場合、ユーザーがスペース メンバーとしてアクセスできるすべてのダイレクト メッセージとスペースが検索されます。 space.display_name: 演算子 :（has）をサポートし、表示名の部分一致に基づいてスペースをフィルタします。結果は、一致する上位 5 つのスペースに限定されます。たとえば、space.display_name:Project は、表示名に「Project」という単語が含まれる上位 5 つのスペース内のメッセージを検索します。 space.space_type: スペースのタイプ。= のみをサポートします。たとえば、space.space_type="DIRECT_MESSAGE" はダイレクト メッセージからのメッセージのみを返します。指定できる値は DIRECT_MESSAGE、GROUP_CHAT、SPACE です。 attachment: 演算子 :*（いずれかを含む）をサポートし、添付ファイルの有無を確認します。attachment:* が指定されている場合、1 つ以上の添付ファイルがあるメッセージのみが返されます。 annotations.user_mentions.user.name: メンションされたユーザー（users/{user}）のリソース名。:（has）のみをサポートします。たとえば、annotations.user_mentions.user.name:"users/1234567890" は、指定されたユーザーへのメンションを含むメッセージのみを返します。また、エイリアス me を使用して、呼び出し元ユーザーに言及しているメッセージをフィルタすることもできます（例: annotations.user_mentions.user.name:users/me）。メールアドレスを {user} のエイリアスとして使用することもできます（例: users/[e-mail]）。 高度なフィルタリングでは、次の関数も使用できます。 has_link(): メッセージ テキストに 1 つ以上のハイパーリンクが含まれているメッセージのみを返します。 is_unread(): 呼び出し元のユーザーが読んだメッセージを除外します。 space.display_name フィルタまたは space.space_type フィルタを使用するには、呼び出し元の認証情報に次のいずれかの認可スコープが含まれている必要があります。 https://www.googleapis.com/auth/chat.spaces.readonly https://www.googleapis.com/auth/chat.spaces is_unread() フィルタを使用するには、呼び出し元の認証情報に次のいずれかの認可スコープが含まれている必要があります。 https://www.googleapis.com/auth/chat.users.readstate.readonly https://www.googleapis.com/auth/chat.users.readstate 異なるフィールド間では、AND 演算子のみがサポートされます。有効な例は sender.name = "users/1234567890" AND is_unread() です。AND という単語は省略可能で、省略した場合は暗黙的に指定されます。たとえば、sender.name = "users/1234567890" is_unread() は有効であり、前の例と同等です。無効な例は sender.name = "users/1234567890" OR is_unread() です。OR は異なるフィールド間ではサポートされていないためです。 同じフィールド内: create_time は AND のみをサポートし、create_time >= "2022-01-01T00:00:00+00:00" AND create_time < "2023-01-01T00:00:00+00:00" などの間隔を表すためにのみ使用できます。 sender.name は OR 演算子のみをサポートします（例: sender.name = "users/1234567890" OR sender.name = "users/0987654321"）。 space.name は OR 演算子のみをサポートします（例: space.name = "spaces/ABCDEFGH" OR space.name = "spaces/QWERTYUI"）。 space.display_name は演算子 AND と OR をサポートしていますが、両方を混在させることはできません。たとえば、space.display_name:Project AND space.display_name:Tasks は、表示名に Project と Tasks の両方を含むスペース内のメッセージを返します。一方、space.display_name:Project OR space.display_name:Tasks は、表示名に Project または Tasks、あるいはその両方を含むスペース内のメッセージを返します。 space.space_type は OR 演算子のみをサポートしています（例: space.space_type = "DIRECT_MESSAGE" OR space.space_type = "GROUP_CHAT"）。 annotations.user_mentions.user.name は、演算子 AND と OR をサポートしていますが、両方を混在させることはできません。たとえば、annotations.user_mentions.user.name:"users/1234567890" AND annotations.user_mentions.user.name:"users/0987654321" は両方のユーザーに言及しているメッセージのみを返しますが、annotations.user_mentions.user.name:"users/1234567890" OR annotations.user_mentions.user.name:"users/0987654321" はどちらか一方または両方のユーザーに言及しているメッセージを返します。 同じクエリで AND 演算子と OR 演算子を組み合わせる場合は、演算子の優先順位を明確にするために括弧が必要です。例: (sender.name="users/me" OR sender.name="users/123456") AND is_unread()それ以外の場合、括弧は省略可能です。 次のクエリの例は有効です。 "Pending reports" AND create_time >= "2023-01-01T00:00:00Z" sender.name = "users/[e-mail]" annotations.user_mentions.user.name:"users/0987654321" attachment:* AND space.name = "spaces/ABCDEFGH" tasks AND is_unread() AND sender.name = "users/1234567890" "things to do" "urgent" (sender.name = "users/1234567890") AND (create_time < "2023-05-01T00:00:00Z") tasks AND space.name = "spaces/ABCDEFGH" AND has_link() "project one" is_unread() space.display_name:Project tasks クエリの最大長は 1,000 文字です。 無効なクエリはサーバーによって拒否され、INVALID_ARGUMENT エラーが返されます。
page_size	int32 省略可。返される結果の最大件数です。サービスから返される数は、この値より少ない場合があります。 指定されていない場合、最大で 25 個が返されます。 最大値は 100 です。100 を超える値を使用すると、自動的に 100 に変更されます。
page_token	string 省略可。前回の search messages 呼び出しから受け取ったトークン。後続のページを取得するには、このパラメータを指定します。 ページ分割を行う場合、指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。他のパラメータに異なる値を渡すと、予期しない結果になる可能性があります。
order_by	string 省略可。結果リストの並べ替え方法。 並べ替えに使用できる属性は次のとおりです。 create_time: メッセージの作成時刻で結果を並べ替えます。デフォルト値。 relevance: 関連性の高い順に結果を並べ替えます。（ デベロッパー プレビュー） デフォルトの順序は create_time desc です。クエリごとに 1 つの順序（create_time または relevance）のみがサポートされています。降順（desc）のみがサポートされており、order 属性の後に指定する必要があります。
markup_syntax	MarkupSyntax 省略可。Chat メッセージの formatted_text フィールドに必要な出力構文を指定します。
view	SearchMessagesView 省略可。返す検索結果ビューの種類を指定します。デフォルト値は SEARCH_MESSAGES_VIEW_BASIC です。

SearchMessagesView

部分的な検索結果でサポートされているビューの種類。

列挙型
SEARCH_MESSAGES_VIEW_UNSPECIFIED	デフォルト値 / 未設定値。API はデフォルトで BASIC ビューになります。
SEARCH_MESSAGES_VIEW_BASIC	結果には一致したメッセージのみが含まれ、追加のメタデータは含まれません。これがデフォルト値です。
SEARCH_MESSAGES_VIEW_FULL	一致したメッセージや追加のメタデータなど、結果のすべてが含まれます。

SearchMessagesResponse

メッセージを検索するためのレスポンス メッセージ。

フィールド
results[]	SearchMessageResult クエリに一致した検索結果のリスト。
next_page_token	string 次のページを取得するために使用できるトークン。このフィールドが空の場合、後続のページはありません。

SearchSpacesRequest

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

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

SearchSpacesResponse

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

フィールド
spaces[] (deprecated)	Space この項目は非推奨です。 非推奨: 代わりに新しい results フィールドを使用してください。リクエストされたスペースのページ。このフィールドは、useAdminAccess が true に設定されている場合にのみ入力されます。このフィールドは非推奨となり、新しい results フィールドに置き換えられました。
next_page_token	string 次のページを取得するために使用できるトークン。このフィールドが空の場合、後続のページはありません。 useAdminAccess が true に設定されている場合にのみ入力されます。
total_size	int32 すべてのページでクエリに一致するスペースの合計数。結果が 10,000 スペースを超える場合、この値は推定値です。 useAdminAccess が true に設定されている場合にのみ入力されます。
results[]	SearchSpaceResult 出力専用。クエリに一致した検索結果のリスト。

SearchSpaceResult

スペース検索の 1 つの結果アイテム。

フィールド
space	Space 出力専用。一致したスペース。

セクション

Google Chat のセクションを表します。セクションは、ユーザーがスペースを整理するのに役立ちます。セクションには次の 2 種類があります。

1. システム セクション: Google Chat によって管理される事前定義されたセクションです。リソース名は固定されており、作成、削除、display_name の変更はできません。次に例を示します。

   • users/{user}/sections/default-direct-messages
   • users/{user}/sections/default-spaces
   • users/{user}/sections/default-apps

2. カスタム セクション: ユーザーが作成して管理するセクションです。CreateSection を使用してカスタム セクションを作成するには、display_name が必要です。カスタム セクションは、UpdateSection を使用して更新し、DeleteSection を使用して削除できます。

フィールド
name	string ID。セクションのリソース名。 システム セクションの場合、セクション ID は定数文字列です。 DEFAULT_DIRECT_MESSAGES: users/{user}/sections/default-direct-messages DEFAULT_SPACES: users/{user}/sections/default-spaces DEFAULT_APPS: users/{user}/sections/default-apps 形式: users/{user}/sections/{section}
display_name	string 省略可。セクションの表示名。CUSTOM_SECTION タイプのセクションにのみ入力されます。最大 80 文字に対応します。CUSTOM_SECTION を作成する場合は必須です。
sort_order	int32 出力専用。他のセクションとの相対的なセクションの順序。sort_order 値が小さいセクションは、値が大きいセクションよりも前に表示されます。
type	SectionType 必須。セクションのタイプ。

SectionType

セクション タイプ。

列挙型
SECTION_TYPE_UNSPECIFIED	セクション タイプが指定されていません。
CUSTOM_SECTION	カスタム セクション。
DEFAULT_DIRECT_MESSAGES	2 人のユーザー間の DIRECT_MESSAGE またはカスタム セクションに属さない GROUP_CHAT スペースを含むデフォルトのセクション。
DEFAULT_SPACES	カスタム セクションに属していないデフォルトのスペース。
DEFAULT_APPS	ユーザーのインストール済みのアプリを含むデフォルトのセクション。

SectionItem

ユーザー定義のセクション アイテム。これは、セクションにグループ化されたスペースなどのセクション アイテムを表すために使用されます。

フィールド
name	string ID。セクション アイテムのリソース名。 形式: users/{user}/sections/{section}/items/{item}
共用体フィールド item。必須。セクション アイテム。item は次のいずれかになります。
space	string 省略可。スペースのリソース名。 形式: spaces/{space}

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 省略可。このリクエストの一意の ID。ランダムな UUID をおすすめします。リクエスト ID を指定すると、リクエストがべき等になり、同じリクエスト ID を持つ複数の同一リクエストで作成されるスペースが 1 つだけになります。同じリクエスト ID を使用した後続のリクエストでは、リクエストされた詳細が現在の状態と異なる場合でも、既存のスペースが返され、スペースは更新されません。 このフィールドを効果的に使用するには: 後続のリクエストが元のリクエストと同じであり、同じ認証情報を使用していることを確認します。 指定されたリクエスト ID でスペースがすでに作成されている場合、リクエストはそのスペースを返します。返されるスペースは完全に入力されていない可能性があります。API は、システム割り当てのリソース名が入力されたリクエスト内のスペースをエコーします。スペースの最新のメタデータを取得するには、GetSpace を呼び出します。 別の認証済みユーザーで既存のリクエスト 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}）が含まれている必要があります。Google グループを追加できるのは、Space.spaceType を SPACE に設定する場合のみです。 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。スペースのリソース名。 形式: 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 省略可。このスペースが、Google Workspace へのデータ移行の一環として Import Mode で作成されたかどうか。インポート中のスペースは、インポートが完了するまでユーザーには表示されません。 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 の顧客リソースの 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 用アプリがスペースを作成した場合にのみ入力され、設定できます。 ユーザー認証

AccessPermissionSetting

アクセス権限の設定。

フィールド
principals[]	Principal 省略可。順序なしリスト。この権限が許可されているプリンシパル。

AccessPermissionSettings

スペースのアクセス権限の設定。

フィールド
discover_space_setting	AccessPermissionSetting 省略可。スペースを検出するためのアクセス権限の設定。
join_space_setting	AccessPermissionSetting 省略可。スペースに参加するためのアクセス権限の設定。
view_space_membership_setting	AccessPermissionSetting 省略可。スペースのメンバーシップを表示するためのアクセス権限の設定。スペースのメンバーシップを表示できるユーザーを更新する場合は、更新マスクとリクエスト本文で PermissionSettings.view_space_membership と一緒に指定する必要があります。対象グループに閲覧権限を付与する場合は、同じリクエストですべてのメンバーに PermissionSettings.view_space_membership も付与する必要があります。既存の対象グループを削除するには（たとえば、閲覧権限をスペースの管理者またはアシスタント マネージャーのみに制限する場合）、空の AccessPermissionSetting（principals なし）を指定します。

AccessSettings

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

フィールド
access_state	AccessState 出力専用。スペースのアクセス状態を示します。
audience	string 省略可。スペースを検索して参加し、スペース内のメッセージをプレビューできるターゲット ユーザーのリソース名。設定されていない場合、そのスペースに個別に招待または追加されたユーザーまたは Google グループのみがアクセスできます。詳しくは、対象グループがスペースを検出できるようにするをご覧ください。 形式: audiences/{audience} Google Workspace 組織のデフォルトの対象グループを使用するには、audiences/default に設定します。 ターゲット ユーザーの読み取りは、以下をサポートしています。 ユーザー認証 chat.app.spaces スコープでの管理者承認によるアプリ認証。 アプリ認証で chat.bot スコープを使用する場合、このフィールドは入力されません。 対象オーディエンスを設定するには、ユーザー認証が必要です。
access_permission_settings	AccessPermissionSettings 省略可。スペースのアクセス権限の設定。 スペースの作成時に対象グループを設定するには、リクエストで accessSettings.audience フィールドを指定します。

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 省略可。スペースのオーナー（ROLE_MANAGER）にこの権限があるかどうか。
members_allowed	bool 省略可。基本スペースのメンバー（ROLE_MEMBER）にこの権限があるかどうか。
assistant_managers_allowed	bool 省略可。スペースの管理者（ROLE_ASSISTANT_MANAGER）にこの権限があるかどうか。

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 省略可。スペース内のメッセージに返信するための設定。
view_space_membership	PermissionSetting 省略可。スペース メンバーシップを表示するための設定。スペースのメンバーシップを表示できるユーザーを更新する場合は、更新マスクとリクエスト本文で AccessPermissionSettings.view_space_membership_setting と一緒に指定する必要があります。閲覧権限を特定のロール（スペースの管理者やアシスタント マネージャーなど）に制限する場合は、ここで目的のロール権限を指定し、同じリクエストで空の AccessPermissionSettings.view_space_membership_setting を指定します。AccessPermissionSettings.view_space_membership_setting でターゲット オーディエンスが設定されている場合、この設定はすべてのメンバーに付与する必要があります。

PredefinedPermissionSettings

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

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

プリンシパル

アクセス権が付与されたエンティティを表すプリンシパル。

フィールド
共用体フィールド principal_type。プリンシパルのタイプ。principal_type は次のいずれかになります。
audience	Audience オーディエンス。

SpaceDetails

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

フィールド
description	string 省略可。スペースの説明。たとえば、スペースのディスカッション トピック、機能的な目的、参加者などを説明します。 最大 4,096 文字に対応します。
guidelines	string 省略可。スペースのルール、期待されること、エチケット。 最大 5,000 文字に対応します。

SpaceThreadingState

Chat スペースのスレッドの状態のタイプを指定します。

列挙型
SPACE_THREADING_STATE_UNSPECIFIED	予約済み。
THREADED_MESSAGES	メッセージ スレッドをサポートするスペース。ユーザーがメッセージに返信するときに、スレッド内で返信できるため、元のメッセージのコンテキストに沿って返信できます。
GROUPED_MESSAGES	会話がトピック別に整理された名前付きスペース。トピックとそれに対する返信がグループ化されます。
UNTHREADED_MESSAGES	メッセージ スレッドをサポートしていないスペース。このスペースのスレッド化状態は、次のような特殊なケースでのみ使用されます。 スレッド形式が意図的にオフにされている会議のチャットの保持。 2022 年より前に作成された以前のグループ会話。

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 更新されたスペース。

SpaceView

Space リソースで入力するフィールドを指定するビュー。今後のリリースとの互換性を確保するため、コードで追加の値を考慮することをおすすめします。

列挙型
SPACE_VIEW_UNSPECIFIED	デフォルト値 / 未設定値。
SPACE_VIEW_RESOURCE_NAME_ONLY	Space リソース名のみが入力されます。
SPACE_VIEW_EXPANDED	Space リソース フィールドに値を入力します。注: permissionSettings フィールドには値が入力されません。SPACE_VIEW_EXPANDED を指定するリクエストには、スペースデータの読み取りを許可するスコープ（https://www.googleapis.com/auth/chat.spaces や https://www.googleapis.com/auth/chat.spaces.readonly など）を含める必要があります。

スレッド

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 ユーザーのスレッドの既読状態が更新された時刻。通常、これはスレッド内の最後に読み取られたメッセージのタイムスタンプに対応します。

UpdateAvailabilityRequest

UpdateAvailability メソッドに対するリクエスト メッセージ。

フィールド
availability	Availability 必須。更新する在庫状況。
update_mask	FieldMask 必須。更新するフィールドのリスト。更新できるフィールドは custom_status のみです。

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（アプリ認証が必要です）。 quoted_message_metadata（引用されたメッセージの削除のみを許可します）。
allow_missing	bool 省略可。true でメッセージが見つからない場合は、新しいメッセージが作成され、updateMask は無視されます。指定されたメッセージ ID はクライアント割り当てである必要があります。そうでない場合、リクエストは失敗します。

UpdateSectionRequest

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

フィールド
section	Section 必須。更新するセクション。
update_mask	FieldMask 必須。更新するフィールドを指定するマスク。 現在サポートされているフィールドパスは次のとおりです。 display_name

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: スペースの説明とガイドラインを更新します。更新リクエストで、説明とガイドラインの両方を SpaceDetails として渡す必要があります。いずれかのフィールドのみを更新する場合は、もう一方のフィールドの既存の値を渡します。 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 ではサポートされていません。 access_settings.access_permission_settings: spaceType フィールドが SPACE であるスペースを検出して参加できるユーザーのアクセス権限設定を更新します。スペースへの参加を許可されているプリンシパルは、スペースの検出も許可されている必要があります。スペースのアクセス権限の設定を更新するには、認証ユーザーがスペースの管理者またはアシスタント マネージャーであり、リクエスト内の他のすべてのフィールド マスクを省略する必要があります。スペースがインポート モードの場合、このフィールドは更新できません。詳しくは、特定のユーザーがスペースを検出できるようにするをご覧ください。access_settings.access_permission_settings は useAdminAccess ではサポートされていません。サポートされているフィールド マスクは次のとおりです。 access_settings.access_permission_settings.discoverSpaceSetting access_settings.access_permission_settings.joinSpaceSetting access_settings.access_permission_settings.viewSpaceMembershipSetting permission_settings: スペースの権限設定の変更をサポートします。権限設定を更新する場合は、permissionSettings フィールド マスクのみを指定できます。他のフィールド マスクを同時に更新することはできません。サポートされているフィールド マスクは次のとおりです。 permission_settings.manageMembersAndGroups permission_settings.modifySpaceDetails permission_settings.toggleHistory permission_settings.useAtMentionAll permission_settings.manageApps permission_settings.manageWebhooks permission_settings.replyMessages permission_settings.viewSpaceMembership
use_admin_access	bool 省略可。true の場合、このメソッドはユーザーの Google Workspace 管理者権限を使用して実行されます。 呼び出し元のユーザーは、Chat とスペースの会話の管理権限を持つ Google Workspace 管理者である必要があります。 chat.admin.spaces OAuth 2.0 スコープが必要です。 一部の FieldMask 値は、管理者権限ではサポートされていません。詳細については、update_mask の説明をご覧ください。

ユーザー

Google Chat のユーザー。

リクエストの出力として返される場合、Chat 用アプリがユーザーとして認証されると、User リソースの出力（Messages API や Memberships API など）には、内部ユーザーと外部ユーザーの両方の 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 Person プロファイル ID と同じ人物を表します。 Admin SDK Directory API のユーザーの id。 ユーザーのメールアドレスを API リクエストで {user} のエイリアスとして使用できます。たとえば、[e-mail] の People API Person プロファイル ID が 123456789 の場合、users/[e-mail] をエイリアスとして使用して users/123456789 を参照できます。API から返されるのは、正規のリソース名（users/123456789 など）のみです。
display_name	string 出力専用。ユーザーの表示名。 アプリ認証とユーザー認証の両方で入力されます。このフィールドは、アプリ認証で行われたリクエストの場合に常に設定されます。ユーザー認証を使用して Messages API と Memberships API を呼び出す場合、このフィールドは、メッセージの sender、annotations 内のユーザー（ユーザー メンションなど）、Membership リソース内のユーザーについて、内部ユーザーと外部ユーザーの両方に入力されます。ただし、ユーザーがスペースのメンバーであるか、呼び出し元ユーザーと以前に親和性がある場合に限ります。
avatar_url	string 出力専用。ユーザーのアバター画像の URL。 ユーザー認証を使用して Messages API と Memberships API を呼び出す場合、このフィールドは、メッセージの sender、annotations 内のユーザー（ユーザー メンションなど）、Membership リソース内の内部ユーザーと外部ユーザーの両方に入力されます。ただし、ユーザーがスペースのメンバーであるか、呼び出し元のユーザーと以前に親和性がある場合に限ります。
email	string 出力専用。ユーザーのメール アドレスです。 ユーザー認証を使用して Messages API と Memberships API を呼び出す場合、このフィールドは、メッセージの sender、annotations 内のユーザー（ユーザー メンションなど）、Membership リソース内のユーザーについて、内部ユーザーと外部ユーザーの両方に入力されます。ただし、ユーザーがスペースのメンバーであるか、呼び出し元ユーザーと以前に親和性がある場合に限ります。
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 には、次のいずれかの項目のみを指定できます。複数の WidgetMarkup フィールドを使用して、より多くのアイテムを表示できます。data は次のいずれかになります。
text_paragraph	TextParagraph このウィジェットにテキスト段落を表示します。
image	Image このウィジェットに画像を表示します。
key_value	KeyValue このウィジェットに Key-Value 項目を表示します。

ボタン

A ボタン。テキストボタンまたは画像ボタンにすることができます。

フィールド
共用体フィールド 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