Package google.chat.v1

インデックス

ChatService

デベロッパーは、Google Chat プラットフォームで Chat 用アプリを構築し、統合できます。

CompleteImportSpace

rpc CompleteImportSpace(CompleteImportSpaceRequest) returns (CompleteImportSpaceResponse)

指定したスペースのインポート プロセスを完了し、ユーザーに表示します。アプリの認証とドメイン全体の委任が必要です。詳細については、Google Chat アプリにデータのインポートを許可するをご覧ください。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/chat.import

詳細については、承認ガイドをご覧ください。
CreateMembership

rpc CreateMembership(CreateMembershipRequest) returns (Membership)

呼び出し元アプリに、人間のメンバーシップまたはアプリ メンバーシップを作成します。他のアプリのメンバーシップの作成はサポートされていません。例については、ユーザーまたは Google Chat アプリをスペースに招待または追加するをご覧ください。メンバーシップを作成する際に、指定したメンバーが自動承諾ポリシーを無効にしている場合、そのメンバーは招待されます。スペースに参加するには、スペースへの招待を承諾する必要があります。それ以外の場合、メンバーシップを作成すると、指定したスペースにメンバーが直接追加されます。ユーザー認証が必要です。

追加するメンバーを指定するには、人間またはアプリのメンバーに membership.member.name を設定するか、グループ メンバーに membership.group_member.name を設定します。

  • 2 人のユーザー間のスペースまたはダイレクト メッセージに通話アプリを追加するには、users/app を使用します。他のアプリをスペースに追加できません。

  • 人間のユーザーを追加するには、users/{user} を使用します。ここで、{user} はユーザーのメールアドレスです。同じ Workspace 組織内のユーザーの場合、{user} には People API のユーザーの id や、Directory API のユーザーの id を指定できます。たとえば、user@example.com の People API ユーザー プロフィール ID が 123456789 の場合、membership.member.name を users/user@example.com または users/123456789 に設定することで、ユーザーをスペースに追加できます。

  • 名前付きスペースに Google グループを追加または招待するには、groups/{group} を使用します。ここで、{group} は Cloud Identity Groups API からグループの id です。たとえば、Cloud Identity Groups Lookup API を使用して、グループメール group@example.com の ID 123456789 を取得し、membership.group_member.name を groups/123456789 に設定することで、名前付きスペースにグループを追加したり、招待したりできます。グループのメールアドレスはサポートされていません。Google グループは名前付きスペースのメンバーとしてのみ追加できます。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • 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 スペースでメッセージを作成する。メッセージの最大サイズは、テキストとカードを含む 32,000 バイトです。例については、メッセージを送信するをご覧ください。

このメソッドを呼び出すには認証が必要で、次の認証タイプがサポートされています。

  • テキスト メッセージの場合、ユーザー認証またはアプリの認証がサポートされています。
  • カード メッセージの場合、アプリの認証のみがサポートされます。（カード メッセージを作成できるのは Chat アプリのみです）。
認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.create

詳細については、承認ガイドをご覧ください。
CreateReaction

rpc CreateReaction(CreateReactionRequest) returns (Reaction)

リアクションを作成してメッセージに追加します。Unicode 絵文字のみがサポートされています。例については、メッセージにリアクションを追加するをご覧ください。ユーザー認証が必要です。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.create

詳細については、承認ガイドをご覧ください。
CreateSpace

rpc CreateSpace(CreateSpaceRequest) returns (Space)

名前付きスペースを作成します。トピック別にグループ化されたスペースはサポートされていません。例については、スペースを作成するをご覧ください。

スペースの作成時に「ALREADY_EXISTS」というエラー メッセージが表示された場合は、別の displayName をお試しください。Google Workspace 組織内の既存のスペースでは、この表示名がすでに使用されている可能性があります。

ユーザー認証が必要です。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

詳細については、承認ガイドをご覧ください。
DeleteMembership

rpc DeleteMembership(DeleteMembershipRequest) returns (Membership)

メンバーシップを削除します。例については、スペースからユーザーまたは Google Chat アプリを削除するをご覧ください。

ユーザー認証が必要です。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • 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)

メッセージを削除します。例については、メッセージを削除するをご覧ください。

認証が必要です。アプリの認証とユーザー認証をサポートします。アプリの認証を使用する場合、リクエストで削除できるのは呼び出し元の Chat アプリによって作成されたメッセージのみです。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages

詳細については、承認ガイドをご覧ください。
DeleteReaction

rpc DeleteReaction(DeleteReactionRequest) returns (Empty)

メッセージへのリアクションを削除します。Unicode 絵文字のみがサポートされています。例については、リアクションを削除するをご覧ください。ユーザー認証が必要です。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions

詳細については、承認ガイドをご覧ください。
DeleteSpace

rpc DeleteSpace(DeleteSpaceRequest) returns (Empty)

名前付きスペースを削除します。常にカスケード削除が実行されます。つまり、スペースに投稿されたメッセージやスペースのメンバーなど、スペースの子リソースも削除されます。例については、スペースを削除するをご覧ください。スペースを削除する権限を持つユーザーにユーザー認証が必要です。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • 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 アプリ間のダイレクト メッセージ スペースを返します。

ユーザー認証またはアプリの認証が必要です。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

詳細については、承認ガイドをご覧ください。
GetAttachment

rpc GetAttachment(GetAttachmentRequest) returns (Attachment)

メッセージの添付ファイルのメタデータを取得します。添付ファイルのデータは、メディア API を使用して取得されます。例については、メッセージの添付ファイルに関するメタデータの取得をご覧ください。アプリの認証が必要です。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/chat.bot

詳細については、承認ガイドをご覧ください。
GetMembership

rpc GetMembership(GetMembershipRequest) returns (Membership)

メンバーシップに関する詳細を返します。例については、ユーザーまたは Google Chat アプリのメンバーシップに関する詳細情報を取得するをご覧ください。

認証が必要です。アプリの認証とユーザー認証をサポートします。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • 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)

メッセージの詳細を返します。例については、メッセージの詳細を取得するをご覧ください。

認証が必要です。アプリの認証とユーザー認証をサポートします。

注: ブロック中のメンバーやスペースからメッセージが返されることがあります。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

詳細については、承認ガイドをご覧ください。
GetSpace

rpc GetSpace(GetSpaceRequest) returns (Space)

スペースの詳細を返します。例については、スペースの詳細を取得するをご覧ください。

認証が必要です。アプリの認証とユーザー認証をサポートします。

認可スコープ

次の 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

詳細については、承認ガイドをご覧ください。
GetSpaceEvent

rpc GetSpaceEvent(GetSpaceEventRequest) returns (SpaceEvent)

Google Chat スペースからイベントを返します。イベント ペイロードには、変更されたリソースの最新バージョンが含まれます。たとえば、新しいメッセージに関するイベントをリクエストし、その後メッセージが更新された場合、サーバーは更新された Message リソースをイベント ペイロードで返します。

ユーザー認証が必要です。イベントを取得するには、認証済みのユーザーがスペースのメンバーである必要があります。

例については、Google Chat スペースからの予定の詳細を取得するをご覧ください。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

詳細については、承認ガイドをご覧ください。
GetSpaceReadState

rpc GetSpaceReadState(GetSpaceReadStateRequest) returns (SpaceReadState)

スペース内でのユーザーの既読状態に関する詳細を返します。既読メッセージと未読メッセージを識別するために使用されます。例については、ユーザーのスペース読み取り状態の詳細を取得するをご覧ください。

ユーザー認証が必要です。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/chat.users.readstate
  • https://www.googleapis.com/auth/chat.users.readstate.readonly

詳細については、承認ガイドをご覧ください。
GetThreadReadState

rpc GetThreadReadState(GetThreadReadStateRequest) returns (ThreadReadState)

スレッド内のユーザーの既読状態に関する詳細を返します。既読または未読のメッセージを識別するために使用されます。例については、ユーザーのスレッドの読み取り状態の詳細を取得するをご覧ください。

ユーザー認証が必要です。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/chat.users.readstate
  • https://www.googleapis.com/auth/chat.users.readstate.readonly

詳細については、承認ガイドをご覧ください。
ListMemberships

rpc ListMemberships(ListMembershipsRequest) returns (ListMembershipsResponse)

スペースのメンバーを一覧表示します。例については、スペース内のユーザーと Google Chat アプリを一覧表示するをご覧ください。アプリの認証を使用してメンバーを一覧表示する場合、Chat アプリがアクセスできるスペースのメンバーシップが一覧表示されますが、Chat アプリのメンバーシップは除きます。[ユーザー認証] を使用して、メンバーを一覧表示する場合、認証されたユーザーがアクセスできるスペースのメンバーシップを一覧表示します。

認証が必要です。アプリの認証とユーザー認証をサポートします。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

詳細については、承認ガイドをご覧ください。
ListMessages

rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse)

発信者がメンバーになっているスペース内のメッセージ（ブロック中のメンバーとスペースからのメッセージを含む）を一覧表示します。例については、メッセージを一覧表示するをご覧ください。ユーザー認証が必要です。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

詳細については、承認ガイドをご覧ください。
ListReactions

rpc ListReactions(ListReactionsRequest) returns (ListReactionsResponse)

メッセージに対するリアクションを一覧表示します。例については、メッセージのリアクションを一覧表示するをご覧ください。ユーザー認証が必要です。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

詳細については、承認ガイドをご覧ください。
ListSpaceEvents

rpc ListSpaceEvents(ListSpaceEventsRequest) returns (ListSpaceEventsResponse)

Google Chat スペースのイベントを一覧表示します。各イベントのペイロードには、Chat リソースの最新バージョンが含まれます。たとえば、スペースの新しいメンバーに関するイベントを一覧表示すると、サーバーは最新のメンバーシップ情報を含む Membership リソースを返します。リクエストされた期間中に新しいメンバーが削除された場合、イベント ペイロードには空の Membership リソースが含まれます。

ユーザー認証が必要です。イベントを一覧表示するには、認証済みのユーザーがスペースのメンバーである必要があります。

例については、Google Chat スペースのイベントを一覧表示するをご覧ください。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

詳細については、承認ガイドをご覧ください。
ListSpaces

rpc ListSpaces(ListSpacesRequest) returns (ListSpacesResponse)

呼び出し元がメンバーになっているスペースを一覧表示します。グループ チャットと DM は、最初のメッセージが送信されるまで表示されません。例については、スペースを一覧表示するをご覧ください。

認証が必要です。アプリの認証とユーザー認証をサポートします。

呼び出し元または認証されたユーザーに表示されるスペースを一覧表示します。グループ チャットと DM は、最初のメッセージが送信されるまで表示されません。

Google Workspace の組織ごとにすべての名前付きスペースを一覧表示するには、代わりに Workspace の管理者権限を使用して spaces.search() メソッドを使用します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

詳細については、承認ガイドをご覧ください。
SearchSpaces

rpc SearchSpaces(SearchSpacesRequest) returns (SearchSpacesResponse)

ユーザーの検索に基づいてスペースのリストを返します。ユーザー認証が必要です。このユーザーは Google Workspace 組織の管理者である必要があります。リクエストでは、use_admin_access を true に設定します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces.readonly

詳細については、承認ガイドをご覧ください。
SetUpSpace

rpc SetUpSpace(SetUpSpaceRequest) returns (Space)

スペースを作成し、指定したユーザーを追加します。呼び出し元のユーザーはスペースに自動的に追加されるため、リクエストでメンバーシップとして指定しないでください。例については、初期メンバーを含むスペースを設定するをご覧ください。

追加する人間のメンバーを指定するには、適切な membership.member.name を持つメンバーシップを追加します。人間のユーザーを追加するには、users/{user} を使用します。ここで、{user} はユーザーのメールアドレスです。同じ Workspace 組織内のユーザーの場合、{user} には People API のユーザーの id や、Directory API のユーザーの id を指定できます。たとえば、user@example.com の People API ユーザー プロフィール ID が 123456789 の場合、membership.member.name を users/user@example.com または users/123456789 に設定することで、ユーザーをスペースに追加できます。

追加する Google グループを指定するには、適切な membership.group_member.name を持つメンバーシップを追加します。Google グループを追加または招待するには、groups/{group} を使用します。ここで、{group} は Cloud Identity Groups API で取得したグループの id です。たとえば、Cloud Identity Groups Lookup API を使用して、グループメール group@example.com の 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 組織内の既存のスペースでは、この表示名がすでに使用されている可能性があります。

ユーザー認証が必要です。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

詳細については、承認ガイドをご覧ください。
UpdateMembership

rpc UpdateMembership(UpdateMembershipRequest) returns (Membership)

メンバーシップを更新します。例については、スペース内のユーザーのメンバーシップを更新するをご覧ください。

ユーザー認証が必要です。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • 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 メソッドの使用をおすすめします。例については、メッセージを更新するをご覧ください。

認証が必要です。アプリの認証とユーザー認証をサポートします。アプリの認証を使用する場合、リクエストで更新できるのは、呼び出し元の Chat アプリによって作成されたメッセージのみです。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages

詳細については、承認ガイドをご覧ください。
UpdateSpace

rpc UpdateSpace(UpdateSpaceRequest) returns (Space)

スペースを更新します。例については、スペースを更新するをご覧ください。

displayName フィールドの更新時にエラー メッセージ「ALREADY_EXISTS」が表示される場合は、別の表示名をお試しください。Google Workspace 組織内の既存のスペースでは、この表示名がすでに使用されている可能性があります。

ユーザー認証が必要です。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces

詳細については、承認ガイドをご覧ください。
UpdateSpaceReadState

rpc UpdateSpaceReadState(UpdateSpaceReadStateRequest) returns (SpaceReadState)

スペース内のユーザーの既読状態を更新します。既読メッセージと未読メッセージを識別するために使用します。例については、ユーザーのスペース読み取り状態を更新するをご覧ください。

ユーザー認証が必要です。

認可スコープ

次の 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

更新されたウィジェットのレスポンス。ウィジェットの予測入力オプションを提供するために使用します。

フィールド
widget

string

更新されたウィジェットの ID。この ID は、更新リクエストをトリガーしたウィジェットの ID と一致する必要があります。
共用体フィールド updated_widget。ウィジェットがユーザーの操作に応じて更新される。updated_widget は次のいずれかになります。
suggestions

SelectionItems

ウィジェットの予測入力結果のリスト

ActionStatus

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

フィールド
status_code

Code

ステータス コード。
user_facing_message

string

リクエストのステータスについてユーザーに送信するメッセージ。設定しない場合、status_code に基づく汎用メッセージが送信されます。

Annotation

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

書式なしテキストのメッセージ本文の例:

Hello @FooBot how are you!"

対応するアノテーションのメタデータ:

"annotations":[{
  "type":"USER_MENTION",
  "startIndex":6,
  "length":7,
  "userMention": {
    "user": {
      "name":"users/{user}",
      "displayName":"FooBot",
      "avatarUrl":"https://goo.gl/aeDtrS",
      "type":"BOT"
    },
    "type":"MENTION"
   }
}]
フィールド
type

AnnotationType

このアノテーションの型。
length

int32

このアノテーションが対応する書式なしテキスト メッセージ本文の部分文字列の長さ。
start_index

int32

このアノテーションが対応する書式なしテキストのメッセージ本文の開始インデックス（0 から始まり、両端を含む）。
共用体フィールド metadata。アノテーションに関する追加のメタデータ。metadata は次のいずれかになります。
user_mention

UserMentionMetadata

ユーザーのメンションのメタデータ。
slash_command

SlashCommandMetadata

スラッシュ コマンドのメタデータ。

AnnotationType

アノテーションの型。

列挙型
ANNOTATION_TYPE_UNSPECIFIED 列挙型のデフォルト値。使用しないでください。
USER_MENTION ユーザーが名前リンク付きでメンションされる。
SLASH_COMMAND スラッシュ コマンドが呼び出されます。

AttachedGif

URL で指定された GIF 画像。

フィールド
uri

string

出力専用。GIF 画像をホストする URL。

添付ファイル

Google Chat での添付ファイル。

フィールド
name

string

アタッチメントのリソース名（spaces/{space}/messages/{message}/attachments/{attachment} の形式）。
content_name

string

出力専用。コンテンツの元のファイル名（フルパスではない）。
content_type

string

出力専用。ファイルのコンテンツ タイプ（MIME タイプ）。
thumbnail_uri

string

出力専用。ユーザーに添付ファイルをプレビューするために使用するサムネイル URL。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

添付ファイル データのリソース名。このフィールドは、添付ファイル データをダウンロードするために Media API で使用されます。
attachment_upload_token

string

アップロードされた添付ファイルへの参照を含む不透明トークン。クライアントによって不透明な文字列として扱われ、添付ファイルを含む Chat メッセージを作成または更新するために使用されます。

CardWithId

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

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

カードビルダーでカードをデザインしてプレビューする。

カードビルダーを開く

フィールド
card_id

string

メッセージに複数のカードが含まれている場合は必須です。メッセージ内のカードの一意の識別子。
card

Card

カード最大サイズは 32 KB です。

ChatSpaceLinkData

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

フィールド
space

string

リンクされた Chat スペース リソースのスペース。

形式: spaces/{space}
thread

string

リンクされた Chat スペース リソースのスレッド。

形式: spaces/{space}/threads/{thread}
message

string

リンクされた Chat スペース リソースのメッセージ。

形式: spaces/{space}/messages/{message}

CompleteImportSpaceRequest

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

フィールド
name

string

必須。インポート モードのスペースのリソース名。

形式: spaces/{space}

CompleteImportSpaceResponse

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

フィールド
space

Space

インポート モードのスペース。

ContextualAddOnMarkup

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

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

カード

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

フィールド
header

CardHeader

カードのヘッダー。通常、ヘッダーにはタイトルと画像を指定します。
sections[]

Section

セクションは線の区切りで区切られます。
card_actions[]

CardAction

このカードでの操作。
name

string

カードの名前。

CardAction

カード アクションとは、カードに関連付けられているアクションです。請求書カードの場合、通常は請求書を削除するか、請求書をメールで送信するか、ブラウザで請求書を開きます。

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

フィールド
action_label

string

操作メニュー項目に表示されるために使用されるラベル。
on_click

OnClick

このアクション アイテムの click アクション。

CardHeader

フィールド
title

string

タイトルを指定してください。ヘッダーの高さは固定されています。タイトルとサブタイトルの両方を指定すると、それぞれが 1 行になります。タイトルのみを指定する場合は、2 行に記述します。
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 つのウィジェットが含まれている必要があります。

CreateMembershipRequest

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

フィールド
parent

string

必須。メンバーシップを作成するスペースのリソース名。

形式: spaces/{space}
membership

Membership

必須。作成するメンバーシップ関係。memberType フィールドには、user.name フィールドと user.type フィールドに値が入力されたユーザーが含まれている必要があります。サーバーはリソース名を割り当て、指定されたものを上書きします。Chat アプリで人間のユーザーのメンバーシップ関係を作成する場合、chat.memberships スコープを使用し、user.type を HUMAN に設定して、user.name を users/{user} 形式で設定する必要があります。{user} にはユーザーのメールアドレスを指定します。同じ Workspace 組織内のユーザーの場合、{user} は People API のユーザーの id にすることも、Directory API のユーザーの id にすることもできます。たとえば、user@example.com の People API ユーザー プロフィール ID が 123456789 の場合、membership.member.name を users/user@example.com または users/123456789 に設定することで、ユーザーをスペースに追加できます。Chat アプリが自身のメンバーシップ関係を作成する際は、chat.memberships.app スコープを使用し、user.type を BOT に設定し、user.name を users/app に設定する必要があります。
use_admin_access

bool

true の場合、メソッドはユーザーの Google Workspace 管理者権限を使用して実行されます。

発信ユーザーは、「Chat とスペースの会話の管理」権限を持つ Google Workspace 管理者である必要があります。

chat.admin.memberships OAuth 2.0 スコープが必要です。

管理者アクセスを使用して、アプリのメンバーシップを作成したり、管理者の Google Workspace 組織外のユーザーのメンバーシップを作成したりすることはできません。

CreateMessageRequest

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

フィールド
parent

string

必須。メッセージを作成するスペースのリソース名。

形式: spaces/{space}
message

Message

必須。メッセージ本文。
thread_key
(deprecated)

string

省略可。非推奨: 代わりに thread.thread_key を使用してください。スレッドの ID。最大 4,000 文字をサポートします。スレッドを開始したりスレッドに追加したりするには、メッセージを作成して threadKey または thread.name を指定します。使用例については、メッセージ スレッドを開始または返信するをご覧ください。
request_id

string

省略可。このメッセージの一意のリクエスト ID。既存のリクエスト ID を指定すると、新しいメッセージを作成するのではなく、その ID で作成されたメッセージが返されます。
message_reply_option

MessageReplyOption

省略可。メールがスレッドを開始するか、スレッドに返信するかを指定します。名前付きスペースでのみサポートされています。
message_id

string

省略可。メッセージのカスタム ID。システムによって割り当てられた ID をメッセージのリソース名（メッセージの name フィールドに表示）に保存することなく、Chat アプリでメッセージを取得、更新、削除できます。

このフィールドの値は、次の要件を満たす必要があります。

  • client- で始まります。たとえば、client-custom-name は有効なカスタム ID ですが、custom-name は有効ではありません。
  • 63 文字以下で、小文字、数字、ハイフンのみを使用します。
  • スペース内で一意である。Chat アプリでは、同じカスタム ID を異なるメッセージに使用することはできません。

詳しくは、メッセージに名前を付けるをご覧ください。

MessageReplyOption

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

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

CreateReactionRequest

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

フィールド
parent

string

必須。リアクションが作成されるメッセージ。

形式: spaces/{space}/messages/{message}
reaction

Reaction

必須。作成するリアクション。

CreateSpaceRequest

名前付きスペースを作成するためのリクエスト。

フィールド
space

Space

必須。displayName フィールドと spaceType フィールドに値を入力する必要があります。SpaceType.SPACE のみがサポートされています。

「ALREADY_EXISTS」というエラー メッセージが表示された場合は、別の displayName をお試しください。Google Workspace 組織内の既存のスペースでは、この表示名がすでに使用されている可能性があります。

スペース name はサーバーで割り当てられているため、このフィールドに指定されたものはすべて無視されます。
request_id

string

省略可。このリクエストの一意の識別子。ランダムな UUID をおすすめします。既存のリクエスト ID を指定すると、新しいスペースを作成するのではなく、その ID で作成されたスペースが返されます。同じ Chat アプリから別の認証済みユーザーを含む既存のリクエスト ID を指定すると、エラーが返されます。

CustomEmoji

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

フィールド
uid

string

出力専用。カスタム絵文字リソースの一意のキー。

DeleteMembershipRequest

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

フィールド
name

string

必須。削除するメンバーシップのリソース名。Chat アプリでは、ユーザーが指定した内容をまたは独自のメンバーシップが必要です。Chat アプリで他のアプリを削除することはできません。できます。

人間のメンバーシップを削除する場合、chat.memberships スコープと spaces/{space}/members/{member} 形式が必要です。このメールアドレスは {member} のエイリアスとして使用できます。たとえば、spaces/{space}/members/example@gmail.com のようにします。ここで、example@gmail.com は Google Chat ユーザーのメールアドレスです。

アプリ メンバーシップを削除する場合は、chat.memberships.app スコープと spaces/{space}/members/app 形式が必要です。

形式: spaces/{space}/members/{member} または spaces/{space}/members/app。
use_admin_access

bool

true の場合、メソッドはユーザーの Google Workspace 管理者権限を使用して実行されます。

発信ユーザーは、「Chat とスペースの会話の管理」権限を持つ Google Workspace 管理者である必要があります。

chat.admin.memberships OAuth 2.0 スコープが必要です。

管理者権限を使用してスペース内のアプリ メンバーシップを削除することはできません。

DeleteMessageRequest

メッセージの削除をリクエストします。

フィールド
name

string

必須。メッセージのリソース名。

形式: spaces/{space}/messages/{message}

メッセージにカスタム ID を設定している場合は、{message} の clientAssignedMessageId フィールドの値を使用できます。詳しくは、メッセージに名前を付けるをご覧ください。
force

bool

true の場合、メッセージを削除するとスレッド返信も削除されます。false に設定すると、メッセージにスレッド返信が含まれている場合、削除が失敗します。

ユーザーとして認証している場合にのみ適用されます。Chat 用アプリとして認証する場合には影響しません。

DeleteReactionRequest

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

フィールド
name

string

必須。削除するリアクションの名前。

形式: spaces/{space}/messages/{message}/reactions/{reaction}

DeleteSpaceRequest

スペースの削除をリクエストします。

フィールド
name

string

必須。削除するスペースのリソース名。

形式: spaces/{space}
use_admin_access

bool

true の場合、メソッドはユーザーの Google Workspace 管理者権限を使用して実行されます。

発信ユーザーは、「Chat とスペースの会話の管理」権限を持つ Google Workspace 管理者である必要があります。

chat.admin.delete OAuth 2.0 スコープが必要です。

DeletionMetadata

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

フィールド
deletion_type

DeletionType

メッセージを削除したユーザーを示します。

DeletionType

メッセージを削除したユーザーと、削除方法

列挙型
DELETION_TYPE_UNSPECIFIED この値は使用されません。
CREATOR ユーザーが自分のメッセージを削除した。
SPACE_OWNER スペースのオーナーがメッセージを削除しました。
ADMIN Google Workspace 管理者がメッセージを削除した。
APP_MESSAGE_EXPIRY Chat アプリの期限が切れたときに独自のメッセージを削除しました。
CREATOR_VIA_APP ユーザーに代わって Chat アプリがメッセージを削除しました。
SPACE_OWNER_VIA_APP スペースのオーナーに代わって Chat アプリがメッセージを削除しました。

ダイアログ

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

フィールド
body

Card

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

DialogAction

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

フィールド
action_status

ActionStatus

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

Dialog

入力のみのリクエストの Dialog。

DriveDataRef

ドライブのアタッチメントのデータへの参照。

フィールド
drive_file_id

string

ドライブ ファイルの ID。Drive API で使用する。

DriveLinkData

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

フィールド
drive_data_ref

DriveDataRef

Google ドライブ ファイルを参照する DriveDataRef。
mime_type

string

リンクされた Google ドライブ リソースの MIME タイプ。

絵文字

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

フィールド
共用体フィールド content。絵文字の内容。content は次のいずれかになります。
unicode

string

Unicode 文字列で表される基本的な絵文字。
custom_emoji

CustomEmoji

出力専用。カスタム絵文字。

EmojiReactionSummary

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

フィールド
emoji

Emoji

リアクションに関連付けられた絵文字。
reaction_count

int32

関連付けられている絵文字を使用したリアクションの合計数。

FindDirectMessageRequest

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

フィールド
name

string

必須。ダイレクト メッセージを検索するユーザーのリソース名。

形式: users/{user}。ここで、{user} は People API の人物の id、または Directory API のユーザーの id です。たとえば、People API のプロフィール ID が 123456789 の場合、users/123456789 を name として使用すると、そのユーザーとのダイレクト メッセージを検索できます。ユーザーとして認証されたら、そのメールアドレスを {user} のエイリアスとして使用できます。たとえば、users/example@gmail.com のようにします。ここで、example@gmail.com は Google Chat ユーザーのメールアドレスです。

GetAttachmentRequest

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

フィールド
name

string

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

GetMembershipRequest

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

フィールド
name

string

必須。取得するメンバーシップのリソース名。

ユーザー認証を使用してアプリのメンバーシップを取得するには、必要に応じて spaces/{space}/members/app を使用します。

形式: spaces/{space}/members/{member} または spaces/{space}/members/app

ユーザーとして認証されたら、そのユーザーのメールアドレスを {member} のエイリアスとして使用できます。たとえば、spaces/{space}/members/example@gmail.com のようにします。ここで、example@gmail.com は Google Chat ユーザーのメールアドレスです。
use_admin_access

bool

true の場合、メソッドはユーザーの Google Workspace 管理者権限を使用して実行されます。

発信ユーザーは、「Chat とスペースの会話の管理」権限を持つ Google Workspace 管理者である必要があります。

chat.admin.memberships または chat.admin.memberships.readonly の OAuth 2.0 スコープが必要です。

管理者権限を使用している場合、スペースでアプリ メンバーシップを取得することはできません。

GetMessageRequest

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

フィールド
name

string

必須。メッセージのリソース名。

形式: spaces/{space}/messages/{message}

メッセージにカスタム ID を設定している場合は、{message} の clientAssignedMessageId フィールドの値を使用できます。詳しくは、メッセージに名前を付けるをご覧ください。

GetSpaceEventRequest

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

フィールド
name

string

必須。スペース イベントのリソース名。

形式: spaces/{space}/spaceEvents/{spaceEvent}

GetSpaceReadStateRequest

GetSpaceReadState API に対するリクエスト メッセージ。

フィールド
name

string

必須。取得するスペース読み取り状態のリソース名。

呼び出し元ユーザーの読み取り状態の取得のみをサポートします。

呼び出し元のユーザーを参照するには、次のいずれかを設定します。

  • me エイリアス。例: users/me/spaces/{space}/spaceReadState

  • Workspace のメールアドレス。たとえば、users/user@example.com/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/user@example.com/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 の保持ルールで指定されています。

ListMembershipsRequest

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

フィールド
parent

string

必須。メンバーシップ リストを取得するスペースのリソース名。

形式: spaces/{space}
page_size

int32

省略可。返されるメンバーシップの最大数。サービスはこの値よりも少ない値を返すことがあります。

指定しない場合、最大で 100 個のメンバーシップが返されます。

最大値は 1,000 です。1,000 を超える値を使用すると、自動的に 1,000 に変更されます。

負の値を指定すると、INVALID_ARGUMENT エラーが返されます。
page_token

string

省略可。メンバーシップを一覧表示する前回の呼び出しから受け取ったページトークン。このパラメータを指定すると、後続のページを取得できます。

ページ分割を行う場合、指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。他のパラメータに異なる値を渡すと、予期しない結果が生じる可能性があります。
filter

string

省略可。クエリフィルタ。

メンバーシップは、メンバーのロール（role）と種類（member.type）でフィルタできます。

ロールでフィルタするには、role を ROLE_MEMBER または ROLE_MANAGER に設定します。

タイプでフィルタするには、member.type を HUMAN または BOT に設定します。デベロッパー プレビュー: != 演算子を使用して member.type をフィルタすることもできます。

ロールとタイプの両方でフィルタするには、AND 演算子を使用します。ロールまたはタイプでフィルタするには、OR 演算子を使用します。

use_admin_access が true に設定されている場合は、member.type = "HUMAN" または member.type != "BOT" のいずれかが必要です。他のメンバータイプのフィルタは拒否されます。

たとえば、次のクエリは有効です。

role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
member.type = "HUMAN" AND role = "ROLE_MANAGER"

member.type != "BOT"

次のクエリは無効です。

member.type = "HUMAN" AND member.type = "BOT"
role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"

無効なクエリは、サーバーによって INVALID_ARGUMENT エラーで拒否されます。
show_groups

bool

省略可。true の場合、他のタイプのメンバーシップに加えて、Google Group に関連付けられたメンバーシップも返します。filter が設定されている場合、フィルタ条件に一致する Google Group のメンバーシップは返されません。
show_invited

bool

省略可。true の場合、他のタイプのメンバーシップに加えて、invited のメンバーに関連付けられたメンバーシップも返します。フィルタを設定した場合、フィルタ条件に一致する invited のメンバーシップは返されません。

現在はユーザー認証が必要です。
use_admin_access

bool

true の場合、メソッドはユーザーの Google Workspace 管理者権限を使用して実行されます。

発信ユーザーは、「Chat とスペースの会話の管理」権限を持つ Google Workspace 管理者である必要があります。

chat.admin.memberships.readonly または chat.admin.memberships の OAuth 2.0 スコープが必要です。

管理者権限を使用している場合、スペース内のアプリ メンバーシップを一覧表示することはできません。

ListMembershipsResponse

スペースのリスト メンバーシップに対するレスポンス。

フィールド
memberships[]

Membership

順序なしリスト。リクエストされた（または最初の）ページのメンバーシップのリスト。
next_page_token

string

結果の次のページを取得するために pageToken として送信できるトークン。空の場合、後続のページはありません。

ListMessagesRequest

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

フィールド
parent

string

必須。メッセージを一覧表示するスペースのリソース名。

形式: spaces/{space}
page_size

int32

返されるメッセージの最大数。サービスから返されるメッセージはこの値よりも少ないことがあります。

指定しない場合は、最大で 25 個が返されます。

最大値は 1,000 です。1,000 を超える値を使用すると、自動的に 1,000 に変更されます。

負の値を指定すると、INVALID_ARGUMENT エラーが返されます。
page_token

string

前のクエリから再開する場合は省略可。

前回の list メッセージ呼び出しから受け取ったページトークン。このパラメータを指定すると、後続のページを取得できます。

ページ分割を行う場合、指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。他のパラメータに異なる値を渡すと、予期しない結果が生じる可能性があります。
filter

string

クエリフィルタ。

日付（create_time）やスレッド（thread.name）でメッセージをフィルタできます。

作成日でメッセージをフィルタするには、create_time に RFC-3339 形式のタイムスタンプと二重引用符を指定します。例: "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

削除済みのメッセージを含めるかどうかを指定します。削除されたメッセージには、削除日時とその削除に関するメタデータが含まれますが、メッセージのコンテンツは利用できません。

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）でリアクションをフィルタできます。

複数の絵文字やユーザーのリアクションをフィルタするには、類似のフィールドを OR 演算子（emoji.unicode = "🙂" OR emoji.unicode = "👍" や user.name = "users/AAAAAA" OR user.name = "users/BBBBBB" など）で結合します。

絵文字やユーザーでリアクションをフィルタするには、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

結果の次のページを取得するための継続トークン。結果の最後のページは空になります。

ListSpaceEventsRequest

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

フィールド
parent

string

必須。イベントが発生した Google Chat スペースのリソース名。

形式: spaces/{space}。
page_size

int32

省略可。返されるスペース イベントの最大数。サービスはこの値よりも少ない値を返すことがあります。

負の値を指定すると、INVALID_ARGUMENT エラーが返されます。
page_token

string

前回のリストスペース イベント呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、スペース イベントをリストするために指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。他のパラメータに異なる値を渡すと、予期しない結果が生じる可能性があります。
filter

string

必須。クエリフィルタ。

has : 演算子を使用して、少なくとも 1 つのイベントタイプ（event_type）を指定する必要があります。複数のイベントタイプでフィルタするには、OR 演算子を使用します。フィルタではバッチイベントタイプを省略します。このリクエストにより、関連するバッチイベントが自動的に返されます。たとえば、新しいリアクション（google.workspace.chat.reaction.v1.created）でフィルタした場合、サーバーはバッチの新しいリアクション イベント（google.workspace.chat.reaction.v1.batchCreated）も返します。サポートされているイベントタイプの一覧については、SpaceEvents リファレンス ドキュメントをご覧ください。

必要に応じて、開始時間（start_time）と終了時間（end_time）でフィルタすることもできます。

  • start_time: スペース イベントの一覧表示を開始する排他的なタイムスタンプ。過去 28 日前までのイベントを一覧表示できます。指定しない場合、過去 28 日間のスペース イベントが一覧表示されます。
  • end_time: スペース イベントを一覧表示するまでの包括的なタイムスタンプ。指定しない場合、リクエスト時点までのイベントが一覧表示されます。

開始時間または終了時間を指定するには、等号 = 演算子を使用し、RFC-3339 の形式を使用します。start_time と end_time の両方でフィルタするには、AND 演算子を使用します。

たとえば、次のクエリは有効です。

start_time="2023-08-23T19:20:33+00:00" AND
end_time="2023-08-23T19:21:54+00:00"

start_time="2023-08-23T19:20:33+00:00" AND
(event_types:"google.workspace.chat.space.v1.updated" OR
event_types:"google.workspace.chat.message.v1.created")

次のクエリは無効です。

start_time="2023-08-23T19:20:33+00:00" OR
end_time="2023-08-23T19:21:54+00:00"

event_types:"google.workspace.chat.space.v1.updated" AND
event_types:"google.workspace.chat.message.v1.created"

無効なクエリは、サーバーによって INVALID_ARGUMENT エラーで拒否されます。

ListSpaceEventsResponse

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

フィールド
space_events[]

SpaceEvent

結果は時系列で返されます（古いイベントが先）。
next_page_token

string

より多くのイベントを取得するために使用される継続トークン。このフィールドを省略すると、後続のページはなくなります。

ListSpacesRequest

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

フィールド
page_size

int32

省略可。返されるスペースの最大数。サービスはこの値よりも少ない値を返すことがあります。

指定しない場合、最大で 100 個のスペースが返されます。

最大値は 1,000 です。1,000 を超える値を使用すると、自動的に 1,000 に変更されます。

負の値を指定すると、INVALID_ARGUMENT エラーが返されます。
page_token

string

省略可。前の list スペース呼び出しから受け取ったページトークン。このパラメータを指定すると、後続のページを取得できます。

ページ分割を行う場合、フィルタ値は、ページトークンを提供した呼び出しと一致する必要があります。別の値を渡すと、予期しない結果になる可能性があります。
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

リクエストされた（または最初の）ページのスペースのリスト。
next_page_token

string

トークンを pageToken として送信して、結果の次のページを取得できます。空の場合、後続のページはありません。

MatchedUrl

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

フィールド
url

string

出力専用。一致した URL。

メンバーシップ

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

フィールド
name

string

サーバーによって割り当てられたメンバーシップのリソース名。

形式: spaces/{space}/members/{member}
state

MembershipState

出力専用。メンバーシップの状態。
role

MembershipRole

省略可。Chat スペース内のユーザーのロール。これにより、スペースで許可されるアクションが決まります。

このフィールドは UpdateMembership での入力としてのみ使用できます。
create_time

Timestamp

省略可。変更不可。メンバーシップの作成時刻（メンバーがスペースに参加した、スペースに招待されたなど）。このフィールドは出力専用です。ただし、インポート モードのスペースで過去のメンバーシップをインポートするために使用する場合は除きます。
delete_time

Timestamp

省略可。変更不可。メンバーシップの削除日時（メンバーがスペースから退出したとき、スペースから削除されたときなど）。このフィールドは出力専用です。ただし、インポート モードのスペースで過去のメンバーシップをインポートするために使用する場合は除きます。
共用体フィールド memberType。このメンバーシップに関連付けられているメンバー。他のメンバータイプは今後サポートされる可能性があります。memberType は次のいずれかになります。
member

User

メンバーシップが対応する Google Chat ユーザーまたはアプリ。Chat アプリがユーザーとして認証された場合、出力はユーザーの name と type に入力されます。
group_member

Group

メンバーシップが対応する Google グループ。

MembershipRole

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

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

MembershipState

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

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

MembershipBatchCreatedEventData

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

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

フィールド
memberships[]

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

メッセージのリソース名。

形式: spaces/{space}/messages/{message}

ここで、{space} はメッセージが投稿されているスペースの ID で、{message} はシステムによって割り当てられたメッセージの ID です。例: spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB

メッセージの作成時にカスタム ID を設定する場合、{message} を clientAssignedMessageId フィールドの値に置き換えることで、この ID を使用してリクエストでメッセージを指定できます。例: spaces/AAAAAAAAAAA/messages/client-custom-name。詳しくは、メッセージに名前を付けるをご覧ください。
sender

User

出力専用。メッセージを作成したユーザー。Chat アプリがユーザーとして認証された場合、出力はユーザーの name と type に入力されます。
create_time

Timestamp

省略可。変更不可。Chat で作成されたスペースの場合、メッセージが作成された時刻。このフィールドは出力専用です。ただし、インポート モードのスペースで使用する場合は除きます。

インポート モードのスペースの場合、元の作成時間を保持するため、このフィールドを、ソースでメッセージが作成された過去のタイムスタンプに設定します。
last_update_time

Timestamp

出力専用。ユーザーがメッセージを最後に編集した時刻。メッセージが編集されていない場合、このフィールドは空です。
delete_time

Timestamp

出力専用。Google Chat でメッセージが削除された時刻。メッセージが削除されない場合、このフィールドは空です。
text

string

書式なしテキストのメッセージ本文。画像、動画、ウェブページへの最初のリンクは、プレビュー チップを生成します。Google Chat ユーザーまたはスペース内の全員に名前リンクを付けることもできます。

テキスト メッセージの作成方法については、テキスト メッセージを送信するをご覧ください。
formatted_text

string

出力専用。書式設定を伝達するためのマークアップが追加されたメッセージ text が含まれています。この項目には、UI に表示されるすべての書式を設定できるとは限りませんが、以下が含まれます。

  • 太字、斜体、取り消し線、等幅、等幅、箇条書きのマークアップ構文。

  • ユーザーの名前リンク（<users/{user}> の形式を使用）。

  • <{url}|{rendered_text}> の形式を使用するカスタム ハイパーリンク。1 つ目の文字列は URL、2 つ目の文字列はレンダリングされたテキストです（例: <http://example.com|custom text>）。

  • :{emoji_name}: 形式のカスタム絵文字（例: :smile:）。これは Unicode 絵文字（笑顔の絵文字の U+1F600 など）には適用されません。

詳しくは、メッセージで送信されたテキストの書式を表示するをご覧ください。
cards[]
(deprecated)

Card

非推奨: 代わりに cards_v2 を使用してください。

UI 要素（書式設定されたテキスト、ボタン、クリック可能な画像など）の表示に使用できる、リッチで書式設定されたインタラクティブなカード。カードは通常、書式なしテキストの本文の下に表示されます。cards と cards_v2 の最大サイズは 32 KB です。
cards_v2[]

CardWithId

cards の配列。

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

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

カードビルダーでカードをデザインしてプレビューする。

カードビルダーを開く
annotations[]

Annotation

出力専用。このメッセージの text に関連付けられているアノテーション。
thread

Thread

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

Space

Chat アプリがユーザーとして認証された場合は、出力がスペース name に入力されます。
fallback_text

string

メッセージのカードに関する書式なしテキストの説明。実際のカードを表示できない場合に使用されます（モバイル通知など）。
action_response

ActionResponse

入力のみのChat 用アプリが回答の投稿方法を構成するために使用できるパラメータ。
argument_text

string

出力専用。Chat 用アプリの名前リンクがすべて取り除かれた、書式なしテキスト形式のメッセージ。
slash_command

SlashCommand

出力専用。スラッシュ コマンドの情報（該当する場合）。
attachment[]

Attachment

ユーザーがアップロードした添付ファイル。
matched_url

MatchedUrl

出力専用。リンク プレビュー パターンに一致する spaces.messages.text の URL。詳細については、プレビュー リンクをご覧ください。
thread_reply

bool

出力専用。true の場合、メッセージは返信スレッドの返信になります。false に設定すると、メッセージは、スペースの最上位の会話に、スレッドの最初のメッセージ、またはスレッド返信のないメッセージとして表示されます。

スペースがスレッドでの返信に対応していない場合、このフィールドは常に false になります。
client_assigned_message_id

string

省略可。メッセージのカスタム ID。フィールドを使用して、メッセージの識別や、メッセージの取得、削除、更新を行うことができます。カスタム ID を設定するには、メッセージの作成時に messageId フィールドを指定します。詳しくは、メッセージに名前を付けるをご覧ください。
emoji_reaction_summaries[]

EmojiReactionSummary

出力専用。メッセージ上の絵文字リアクションの概要のリスト。
private_message_viewer

User

変更不可。メッセージを作成するための入力。それ以外の場合は出力のみ。メッセージを閲覧できるユーザー。設定すると、メッセージは非公開になり、指定したユーザーと Chat アプリにのみ表示されます。非公開メッセージではリンク プレビューと添付ファイルはサポートされていません。

プライベート メッセージを送信できるのは Chat アプリのみです。Chat アプリがメッセージを送信するためにユーザーとして認証される場合、メッセージを非公開にすることはできないため、このフィールドを省略する必要があります。

詳しくは、Google Chat ユーザーに非公開メッセージを送信するをご覧ください。
deletion_metadata

DeletionMetadata

出力専用。削除されたメッセージについての情報。delete_time が設定されている場合、メッセージは削除されます。
quoted_message_metadata

QuotedMessageMetadata

出力専用。スペースで Google Chat ユーザーが引用したメッセージに関する情報。Google Chat ユーザーは、メッセージを引用して返信することができます。
attached_gifs[]

AttachedGif

出力専用。メッセージに添付された GIF 画像。
accessory_widgets[]

AccessoryWidget

メールの下部に表示される、1 つ以上のインタラクティブなウィジェット。テキスト、カード、またはその両方を含むメッセージにアクセサリ ウィジェットを追加できます。ダイアログを含むメッセージではサポートされていません。詳しくは、メールの下部にインタラクティブなウィジェットを追加するをご覧ください。

アクセサリ ウィジェットでメッセージを作成するには、アプリの認証が必要です。

MessageBatchCreatedEventData

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

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

フィールド
messages[]

MessageCreatedEventData

新着メッセージのリスト。

MessageBatchDeletedEventData

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

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

フィールド
messages[]

MessageDeletedEventData

削除されたメッセージのリスト。

MessageBatchUpdatedEventData

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

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

フィールド
messages[]

MessageUpdatedEventData

更新されたメッセージのリスト。

MessageCreatedEventData

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

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

フィールド
message

Message

新しいメッセージ。

MessageDeletedEventData

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

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

フィールド
message

Message

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

MessageUpdatedEventData

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

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

フィールド
message

Message

更新されたメッセージ。

QuotedMessageMetadata

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

フィールド
name

string

出力専用。引用されたメッセージのリソース名。

形式: spaces/{space}/messages/{message}
last_update_time

Timestamp

出力専用。引用されたメッセージが作成されたときのタイムスタンプ、または引用されたメッセージが最後に更新されたときのタイムスタンプ。

リアクション

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

フィールド
name

string

リアクションのリソース名。

形式: spaces/{space}/messages/{message}/reactions/{reaction}
user

User

出力専用。リアクションを作成したユーザー。
emoji

Emoji

リアクションで使用される絵文字。

ReactionBatchCreatedEventData

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

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

フィールド
reactions[]

ReactionCreatedEventData

新しいリアクションのリスト。

ReactionBatchDeletedEventData

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

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

フィールド
reactions[]

ReactionDeletedEventData

削除されたリアクションのリスト。

ReactionCreatedEventData

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

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

フィールド
reaction

Reaction

新しいリアクション。

ReactionDeletedEventData

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

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

フィールド
reaction

Reaction

削除されたリアクション。

RichLinkMetadata

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

フィールド
uri

string

このリンクの URI。
共用体フィールド data。リンクされたリソースのデータ。data は次のいずれかになります。

RichLinkType

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

列挙型
DRIVE_FILE Google ドライブのリッチリンク タイプ。
CHAT_SPACE Chat スペースのリッチリンク タイプ。（スペースのスマートチップなど）。

SearchSpacesRequest

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

フィールド
use_admin_access

bool

true の場合、メソッドはユーザーの Google Workspace 管理者権限を使用して実行されます。

発信ユーザーは、「Chat とスペースの会話の管理」権限を持つ Google Workspace 管理者である必要があります。

chat.admin.spaces.readonly または chat.admin.spaces の OAuth 2.0 スコープが必要です。

このメソッドは現在、管理者アクセスのみをサポートしているため、このフィールドに使用できるのは true のみです。
page_size

int32

返されるスペースの最大数。サービスが返す値はこれより少ないことがあります。

指定しない場合、最大で 100 個のスペースが返されます。

最大値は 1,000 です。1,000 を超える値を使用すると、自動的に 1,000 に変更されます。
page_token

string

前回の検索スペース呼び出しから受け取ったトークン。このパラメータを指定すると、後続のページを取得できます。

ページ分割を行う場合、指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。他のパラメータに異なる値を渡すと、予期しない結果が生じる可能性があります。
query

string

必須。検索クエリ。

次のパラメータを使用して検索できます。

  • create_time
  • customer
  • display_name
  • external_user_allowed
  • last_active_time
  • space_history_state
  • space_type

create_time と last_active_time は RFC-3339 形式のタイムスタンプを受け入れます。サポートされている比較演算子は =、<、>、<=、>= です。

customer は必須で、スペースを取得する顧客を示すために使用されます。サポートされている値は customers/my_customer のみです。

display_name では、HAS（:）演算子のみを使用できます。照合するテキストはまずトークンにトークン化され、各トークンはスペースの display_name 内のどこかで部分文字列として個別に照合され、大文字と小文字は区別されません。たとえば、Fun Eve は Fun event や The evening was fun と一致しますが、notFun event や even には一致しません。

external_user_allowed は、true または false を受け入れます。

space_history_state は、space リソースの historyState フィールドの値のみを受け入れます。

space_type は必須です。有効な値は SPACE のみです。

異なるフィールドでは、AND 演算子のみがサポートされています。有効な例は space_type = "SPACE" AND display_name:"Hello"、無効な例は space_type = "SPACE" OR display_name:"Hello" です。

同じフィールドのうち、space_type は AND 演算子と OR 演算子をサポートしていません。display_name、「space_history_state」、「external_user_allowed」OR 演算子のみをサポートしています。last_active_time と create_time は、AND 演算子と OR 演算子の両方をサポートします。AND は、last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00" などの間隔を表すためにのみ使用できます。

次のクエリは有効です。

customer = "customers/my_customer" AND space_type = "SPACE"

customer = "customers/my_customer" AND space_type = "SPACE" AND
display_name:"Hello World"

customer = "customers/my_customer" AND space_type = "SPACE" AND
(last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time >
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND space_type = "SPACE" AND
(display_name:"Hello World" OR display_name:"Fun event") AND
(last_active_time > "2020-01-01T00:00:00+00:00" AND last_active_time <
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND space_type = "SPACE" AND
(create_time > "2019-01-01T00:00:00+00:00" AND create_time <
"2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND
(space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF")
order_by

string

省略可。スペースのリストの順序。

並べ替え可能な属性は次のとおりです。

  • membership_count.joined_direct_human_user_count - スペースに直接参加した人間のユーザーの数を示します。
  • last_active_time - このスペースの任意のトピックに対象アイテムが最後に追加された時刻を示します。
  • create_time — スペースが作成された時刻を示します。

有効な順序付けオペレーションの値は次のとおりです。

  • 昇順の場合は ASC。デフォルト値。

  • DESC: 降順。

サポートされている構文は次のとおりです。

  • membership_count.joined_direct_human_user_count DESC
  • membership_count.joined_direct_human_user_count ASC
  • last_active_time DESC
  • last_active_time ASC
  • create_time DESC
  • create_time ASC

SearchSpacesResponse

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

フィールド
spaces[]

Space

リクエストされたスペースのページ。
next_page_token

string

次のページを取得するために使用できるトークン。このフィールドが空の場合、後続のページはありません。
total_size

int32

すべてのページでのクエリに一致するスペースの合計数。結果が 10,000 スペースを超える場合、この値は推定値です。

SetUpSpaceRequest

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

フィールド
space

Space

必須。Space.spaceType 項目は必須です。

スペースを作成するには、Space.spaceType を SPACE に設定し、Space.displayName を設定します。スペースの設定中にエラー メッセージ ALREADY_EXISTS が表示された場合は、別の displayName をお試しください。Google Workspace 組織内の既存のスペースでは、この表示名がすでに使用されている可能性があります。

グループ チャットを作成するには、Space.spaceType を GROUP_CHAT に設定します。Space.displayName は設定しないでください。

人間との 1 対 1 の会話を作成するには、Space.spaceType を DIRECT_MESSAGE に設定し、Space.singleUserBotDm を false に設定します。Space.displayName または Space.spaceDetails は設定しないでください。

人間と呼び出し元の Chat アプリの 1 対 1 の会話を作成するには、Space.spaceType を DIRECT_MESSAGE、Space.singleUserBotDm を true に設定します。Space.displayName または Space.spaceDetails は設定しないでください。

DIRECT_MESSAGE のスペースがすでに存在する場合、新しいスペースを作成するのではなく、そのスペースが返されます。
request_id

string

省略可。このリクエストの一意の識別子。ランダムな UUID をおすすめします。既存のリクエスト ID を指定すると、新しいスペースを作成するのではなく、その ID で作成されたスペースが返されます。同じ Chat アプリから別の認証済みユーザーを含む既存のリクエスト ID を指定すると、エラーが返されます。
memberships[]

Membership

省略可。スペースに招待する Google Chat のユーザーまたはグループ。呼び出し元のユーザーは自動的に追加されるため、除外します。

このセットでは現在、（呼び出し元に加えて）最大 20 のメンバーシップが許可されています。

人間のメンバーシップの場合、Membership.member フィールドには、name が入力され（形式: users/{user}）、type が User.Type.HUMAN に設定された user が含まれている必要があります。人間のユーザーを追加できるのは、スペースの設定時のみです（Chat アプリの追加は、通話アプリでのダイレクト メッセージの設定でのみサポートされています）。このユーザーのメールアドレスを使用して、{user} のエイリアスとしてメンバーを追加することもできます。たとえば、user.name は users/example@gmail.com です。Gmail ユーザーまたは外部の Google Workspace ドメインのユーザーを招待するには、そのユーザーのメールアドレスを {user} に使用する必要があります。

Google グループ メンバーシップの場合、Membership.group_member フィールドには name が入力された group が含まれている必要があります（groups/{group} の形式）。Space.spaceType を SPACE に設定している場合、Google グループのみを追加できます。

Space.spaceType を SPACE に設定する場合は省略可。

2 つ以上のメンバーシップとともに Space.spaceType を GROUP_CHAT に設定する場合は必須です。

メンバーシップを 1 つだけ指定し、人間のユーザーが Space.spaceType を DIRECT_MESSAGE に設定する場合は必須です。

人間と呼び出し元の 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 のスペース。スペースとは、複数のユーザー間の会話、またはユーザーと Chat アプリ間の 1 対 1 のメッセージのことです。

フィールド
name

string

スペースのリソース名。

形式: spaces/{space}
type
(deprecated)

Type

出力専用。非推奨: 代わりに space_type を使用してください。スペースのタイプ。
space_type

SpaceType

スペースのタイプ。スペースを作成する場合やスペースのタイプを更新する場合に必須です。他の用途の場合のみ出力。
single_user_bot_dm

bool

省略可。スペースが Chat アプリと 1 人の人間間の DM であるかどうか。
threaded
(deprecated)

bool

出力専用。非推奨: 代わりに spaceThreadingState を使用してください。このスペースでメッセージがスレッド形式になっているかどうか。
display_name

string

スペースの表示名。スペースを作成する場合は必須です。スペースの作成時または 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 にこのスペースが作成されたかどうか。スペースのインポート中は、インポートが完了するまでユーザーには表示されません。
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。
共用体フィールド space_permission_settings。スペースの権限の設定を表します。space_type が SPACE の場合にのみ入力されます。space_permission_settings は次のいずれかになります。
predefined_permission_settings

PredefinedPermissionSettings

省略可。入力のみのスペースの権限の設定。スペースを作成するための入力。このフィールドが設定されていない場合は、コラボレーション スペースが作成されます。スペースを作成すると、PermissionSettings フィールドに設定が入力されます。
permission_settings

PermissionSettings

省略可。スペースを更新するために設定できる正確な権限設定。スペースを更新するための入力です。それ以外の場合は、出力のみ。スペースの作成には、代わりに predefined_permission_settings を使用してください。

AccessSettings

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

フィールド
access_state

AccessState

出力専用。スペースのアクセス状態を示します。
audience

string

省略可。スペースの検出、スペースへの参加、スペース内のメッセージのプレビューが可能な対象グループのリソース名。未設定のままにした場合、個別に招待されたユーザーまたはスペースに追加されたユーザーまたは Google グループのみがスペースにアクセスできます。詳しくは、対象グループがスペースを検索可能にするをご覧ください。

形式: audiences/{audience}

Google Workspace 組織のデフォルトの対象グループを使用するには、audiences/default に設定します。

AccessState

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

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

MembershipCount

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

フィールド
joined_direct_human_user_count

int32

スペースに直接参加した人間のユーザーの数。参加グループのメンバーであるユーザーの数はカウントされません。
joined_group_count

int32

スペースに直接参加したすべてのグループの数。

PermissionSetting

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

フィールド
managers_allowed

bool

スペースの管理者がこの権限を持っているかどうか。
members_allowed

bool

マネージャー以外のメンバーにこの権限が付与されているかどうか。

PermissionSettings

名前付きスペースの権限の設定。スペースの作成時に権限を設定するには、リクエストの PredefinedPermissionSettings フィールドを指定します。

フィールド
manage_members_and_groups

PermissionSetting

スペースのメンバーとグループを管理するための設定です。
modify_space_details

PermissionSetting

スペースの名前、アバター、説明、ガイドラインを更新するための設定です。
toggle_history

PermissionSetting

スペースの履歴のオンとオフを切り替えるための設定です。
use_at_mention_all

PermissionSetting

スペースで @all を使用するための設定。
manage_apps

PermissionSetting

スペース内のアプリを管理するための設定です。
manage_webhooks

PermissionSetting

スペースで Webhook を管理するための設定です。
post_messages

PermissionSetting

出力専用。スペースにメッセージを投稿するための設定です。
reply_messages

PermissionSetting

スペース内のメッセージに返信するための設定です。

PredefinedPermissionSettings

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

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

SpaceDetails

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

フィールド
description

string

省略可。スペースの説明。たとえば、スペースのディスカッション トピック、機能上の目的、参加者について説明してください。

150 文字までサポートされます。
guidelines

string

省略可。スペースのルール、期待、マナー。

最大 5,000 文字をサポートします。

SpaceThreadingState

Chat スペースのスレッド状態の種類を指定します。

列挙型
SPACE_THREADING_STATE_UNSPECIFIED 予約済み。
THREADED_MESSAGES メッセージのスレッドをサポートする名前付きスペース。ユーザーがメッセージに返信すると、スレッド内で返信できるため、元のメッセージのコンテキストで返信できます。
GROUPED_MESSAGES 会話がトピック別に整理されている名前付きスペース。トピックとその返信はグループ化されます。
UNTHREADED_MESSAGES 2 人間のダイレクト メッセージ（DM）や 3 人以上間のグループ会話

SpaceType

スペースのタイプ。スペースを作成または更新する場合は必須です。他の用途の場合のみ出力。

列挙型
SPACE_TYPE_UNSPECIFIED 予約済み。
SPACE メッセージの送信、ファイルの共有、共同編集を行う場所です。SPACE には Chat 用アプリを含めることができます。
GROUP_CHAT 3 人以上のグループ会話GROUP_CHAT には Chat 用アプリを含めることができます。
DIRECT_MESSAGE 2 人、または人間と Chat アプリの 1 対 1 のメッセージ。

タイプ

非推奨: 代わりに SpaceType を使用してください。

列挙型
TYPE_UNSPECIFIED 予約済み。
ROOM 2 人以上の人間による会話。
DM 人間と Chat アプリ間の 1 対 1 のダイレクト メッセージ。すべてのメッセージがフラットです。なお、これには 2 人の人間間のダイレクト メッセージは含まれません。

SpaceBatchUpdatedEventData

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

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

フィールド
spaces[]

SpaceUpdatedEventData

更新されたスペースのリスト。

SpaceEvent

Google Chat スペースでの変更またはアクティビティを表すイベント。詳しくは、Google Chat からの予定を管理するをご覧ください。

フィールド
name

string

スペース イベントのリソース名。

形式: spaces/{space}/spaceEvents/{spaceEvent}
event_time

Timestamp

イベントが発生した時刻。
event_type

string

スペースのイベントの種類。各イベントタイプにはバッチ バージョンがあります。これは、短期間に発生するイベントタイプの複数のインスタンスを表します。spaceEvents.list() リクエストの場合、クエリフィルタでバッチイベントタイプを省略します。デフォルトでは、サーバーはイベントタイプとバッチ バージョンの両方を返します。

メッセージでサポートされるイベントタイプ:

  • 新しいメッセージ: google.workspace.chat.message.v1.created
  • 更新されたメッセージ: google.workspace.chat.message.v1.updated
  • 削除されたメッセージ: google.workspace.chat.message.v1.deleted
  • 複数の新着メッセージ: google.workspace.chat.message.v1.batchCreated
  • 複数の更新されたメッセージ: google.workspace.chat.message.v1.batchUpdated
  • 複数の削除されたメッセージ: google.workspace.chat.message.v1.batchDeleted 件

メンバーシップでサポートされているイベントタイプ:

  • 新しいメンバーシップ: google.workspace.chat.membership.v1.created
  • メンバーシップを更新しました: google.workspace.chat.membership.v1.updated
  • 削除されたメンバーシップ: google.workspace.chat.membership.v1.deleted
  • 複数の新規メンバーシップ: google.workspace.chat.membership.v1.batchCreated
  • 複数のメンバーシップの更新: google.workspace.chat.membership.v1.batchUpdated
  • 複数の削除されたメンバーシップ: google.workspace.chat.membership.v1.batchDeleted

リアクションでサポートされているアクティビティの種類:

  • 新しいリアクション: google.workspace.chat.reaction.v1.created
  • リアクション「google.workspace.chat.reaction.v1.deleted」を削除しました
  • 複数の新しいリアクション: google.workspace.chat.reaction.v1.batchCreated
  • 複数の削除されたリアクション: google.workspace.chat.reaction.v1.batchDeleted

Space についてサポートされているイベントタイプ:

  • スペースを更新しました: 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

SpaceReadState

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

フィールド
name

string

スペースの読み取り状態のリソース名。

形式: users/{user}/spaces/{space}/spaceReadState
last_read_time

Timestamp

省略可。ユーザーのスペース読み取り状態が更新された時刻。通常これは、最後に読み取られたメッセージのタイムスタンプか、スペース内の最後の既読位置をマークするためにユーザーが指定したタイムスタンプのいずれかに対応します。

SpaceUpdatedEventData

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

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

フィールド
space

Space

更新されたスペース。

スレッド

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

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

フィールド
name

string

スレッドのリソース名。

例: spaces/{space}/threads/{thread}
thread_key

string

省略可。スレッドを作成または更新するための入力。それ以外の場合は、出力のみ。スレッドの ID。最大 4,000 文字をサポートします。

この ID は、設定元の Chat アプリに固有のものです。たとえば、複数の Chat アプリが同じスレッドキーを使用して 1 つのメッセージを作成した場合、それらのメッセージは別々のスレッドに投稿されます。ユーザーまたは他の Chat アプリによって作成されたスレッドで返信するには、代わりにスレッドの name フィールドを指定します。

ThreadReadState

スレッド内のユーザーの既読状態。既読メールと未読メールを区別するために使用します。

フィールド
name

string

スレッド読み取り状態のリソース名。

形式: users/{user}/spaces/{space}/threads/{thread}/threadReadState
last_read_time

Timestamp

ユーザーのスレッド読み取り状態が更新された時刻。通常、これはスレッドで最後に読まれたメッセージのタイムスタンプに対応します。

UpdateMembershipRequest

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

フィールド
membership

Membership

必須。更新するメンバーシップ。update_mask で指定されたフィールドのみが更新されます。
update_mask

FieldMask

必須。更新するフィールドパス。複数の値をカンマで区切るか、* を使用してすべてのフィールドパスを更新します。

現在サポートされているフィールドパス:

  • role
use_admin_access

bool

true の場合、メソッドはユーザーの Google Workspace 管理者権限を使用して実行されます。

発信ユーザーは、「Chat とスペースの会話の管理」権限を持つ Google Workspace 管理者である必要があります。

chat.admin.memberships OAuth 2.0 スコープが必要です。

UpdateMessageRequest

メッセージの更新をリクエストします。

フィールド
message

Message

必須。フィールドを更新したメッセージ。
update_mask

FieldMask

必須。更新するフィールドパス。複数の値をカンマで区切るか、* を使用してすべてのフィールドパスを更新します。

現在サポートされているフィールドパス:
allow_missing

bool

省略可。true でメッセージが見つからない場合は、新しいメッセージが作成され、updateMask は無視されます。指定されたメッセージ ID は client-assigned である必要があります。そうでない場合、リクエストは失敗します。

UpdateSpaceReadStateRequest

UpdateSpaceReadState API に対するリクエスト メッセージ。

フィールド
space_read_state

SpaceReadState

必須。スペースの読み取り状態と更新するフィールド。

呼び出し元ユーザーの読み取り状態の更新のみをサポートします。

呼び出し元のユーザーを参照するには、次のいずれかを設定します。

  • me エイリアス。例: users/me/spaces/{space}/spaceReadState

  • Workspace のメールアドレス。たとえば、users/user@example.com/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.name は spaces/{space} の形式で入力する必要があります。update_mask で指定されたフィールドのみが更新されます。
update_mask

FieldMask

必須。更新されたフィールドパス。複数ある場合はカンマで区切って指定します。

スペースの次のフィールドを更新できます。

  • space_details

  • display_name: spaceType フィールドが SPACE のスペースの表示名のみ更新がサポートされています。エラー メッセージ ALREADY_EXISTS が表示された場合は、別の値をお試しください。Google Workspace 組織内の既存のスペースでは、この表示名がすでに使用されている可能性があります。

  • space_type: GROUP_CHAT スペースタイプを SPACE に変更することのみをサポートします。更新マスクに display_name を space_type とともに含め、指定されたスペースの表示名と SPACE スペースタイプが空でないことを確認します。既存のスペースがすでに SPACE タイプである場合、表示名を更新するときに、指定されたスペースに space_type マスクと SPACE タイプを含めるかどうかは任意です。他の方法でスペースタイプを更新しようとすると、無効な引数のエラーが発生します。space_type は管理者権限でサポートされていません。

  • space_history_state: スペースの履歴をオンまたはオフにして、スペースの履歴設定を更新します。Google Workspace の組織に対して履歴設定が有効になっている場合にのみサポートされます。スペースの履歴の状態を更新するには、リクエストで他のすべてのフィールド マスクを省略する必要があります。space_history_state は管理者権限でサポートされていません。

  • access_settings.audience: spaceType フィールドが SPACE の名前付きスペースで、スペースの検出、スペースへの参加、メッセージのプレビューを行えるユーザーのアクセス設定を更新します。既存のスペースに対象グループがある場合は、このフィールド マスクの値を省略することで、そのオーディエンスを削除し、スペースへのアクセスを制限できます。スペースのアクセス設定を更新するには、認証するユーザーがスペースの管理者である必要があります。また、リクエストで他のすべてのフィールド マスクを省略する必要があります。スペースがインポート モードの場合、このフィールドを更新することはできません。詳しくは、特定のユーザーがスペースを検索可能にするをご覧ください。access_settings.audience は管理者権限でサポートされていません。

  • デベロッパー プレビュー: スペースの権限設定の変更をサポートします。サポートされているフィールド パスは、permission_settings.manage_members_and_groups、permission_settings.modify_space_details、permission_settings.toggle_history、permission_settings.use_at_mention_all、permission_settings.manage_apps、permission_settings.manage_webhooks、permission_settings.reply_messages です（警告: 他のすべての権限以外の設定フィールドパスと相互に排他的）。permission_settings は管理者権限でサポートされていません。
use_admin_access

bool

true の場合、メソッドはユーザーの Google Workspace 管理者権限を使用して実行されます。

発信ユーザーは、「Chat とスペースの会話の管理」権限を持つ Google Workspace 管理者である必要があります。

chat.admin.spaces OAuth 2.0 スコープが必要です。

一部の FieldMask 値は、管理者権限を使用してサポートされません。詳しくは、update_mask の説明をご覧ください。

ユーザー

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

フィールド
name

string

Google Chat user のリソース名。

形式: users/{user}。users/app は、呼び出し元のアプリ bot ユーザーのエイリアスとして使用できます。

human users の場合、{user} は次のユーザー ID と同じです。

  • People API の Person の id。たとえば、Chat API の users/123456789 は、People API の 123456789 人物プロフィール ID と同じ人物を表します。

  • Admin SDK Directory API のユーザーの id。

  • ユーザーのメールアドレスは、API リクエストで {user} のエイリアスとして使用できます。たとえば、user@example.com の People API ユーザー プロフィール ID が 123456789 の場合、users/123456789 を参照するためのエイリアスとして users/user@example.com を使用できます。API から返されるのは正規のリソース名（例: users/123456789）のみです。
display_name

string

出力専用。ユーザーの表示名。
domain_id

string

ユーザーの Google Workspace ドメインの一意の識別子。
type

Type

ユーザータイプ。
is_anonymous

bool

出力専用。true の場合、ユーザーが削除されるか、ユーザーのプロフィールが表示されなくなります。

タイプ

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

UserMentionMetadata

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

フィールド
user

User

お客様が言及した。
type

Type

ユーザーのメンションのタイプ。

タイプ

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

WidgetMarkup

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

フィールド
buttons[]

Button

ボタンのリスト。ボタンも oneof data であり、これらのフィールドのうち 1 つだけを設定する必要があります。
共用体フィールド data。WidgetMarkup に指定できるのは、以下のアイテムのうち 1 つのみです。複数の WidgetMarkup フィールドを使用すると、より多くのアイテムを表示できます。data は次のいずれかになります。
text_paragraph

TextParagraph

このウィジェットに段落テキストを表示します。
image

Image

このウィジェットに画像を表示します。
key_value

KeyValue

このウィジェットに Key-Value アイテムを表示します。

ボタン

ボタン。テキストボタンまたは画像ボタンです。

フィールド

共用体フィールド type。

type は次のいずれかになります。
text_button

TextButton

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

ImageButton

画像と onclick アクションのボタン。

FormAction

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

フィールド
action_method_name

string

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

ActionParameter

アクション パラメータのリスト。

ActionParameter

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

フィールド
key

string

アクション スクリプトのパラメータの名前。
value

string

パラメータの値。

アイコン

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

列挙型
ICON_UNSPECIFIED
AIRPLANE
BOOKMARK
BUS
CAR
CLOCK
CONFIRMATION_NUMBER_ICON
DOLLAR
DESCRIPTION
EMAIL
EVENT_PERFORMER
EVENT_SEAT
FLIGHT_ARRIVAL
FLIGHT_DEPARTURE
HOTEL
HOTEL_ROOM_TYPE
INVITE
MAP_PIN
MEMBERSHIP
MULTIPLE_PEOPLE
OFFER
PERSON
PHONE
RESTAURANT_ICON
SHOPPING_CART
STAR
STORE
TICKET
TRAIN
VIDEO_CAMERA
VIDEO_PLAY

画像

URL で指定され、onclick アクションを持つ画像。

フィールド
image_url

string

画像の URL です。
on_click

OnClick

onclick アクション。
aspect_ratio

double

この画像のアスペクト比（幅と高さ）。このフィールドを使用すると、画像の読み込みを待っている間に画像の高さを適切に予約できます。画像に組み込まれているアスペクト比をオーバーライドするためのものではありません。未設定の場合、サーバーは画像をプリフェッチして埋めます。

ImageButton

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

フィールド
on_click

OnClick

onclick アクション。
name

string

ユーザー補助に使用されるこの image_button の名前。名前が指定されていない場合は、デフォルト値が提供されます。
共用体フィールド icons。アイコンは、Icon enum または URL で指定できます。icons は次のいずれかになります。
icon

Icon

enum で指定されたアイコン。Chat API が提供するアイコンを指します。
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 は、いずれか 1 つを設定できます。両方を設定することはできません。control は次のいずれかになります。
button

Button

クリックしてアクションをトリガーできるボタン。

OnClick

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

フィールド

共用体フィールド data。

data は次のいずれかになります。
action

FormAction

onclick アクションが指定されている場合、フォーム アクションがトリガーされます。

TextButton

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

フィールド
text

string

ボタンのテキスト。
on_click

OnClick

ボタンの onclick アクション。

TextParagraph

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

フィールド
text

string