Package google.chat.v1

インデックス

ChatService

デベロッパーが Google Chat Platform で Chat アプリと統合を構築できるようにします。

CompleteImportSpace

rpc CompleteImportSpace(CompleteImportSpaceRequest) returns (CompleteImportSpaceResponse)

指定したスペースのインポート プロセスが完了し、ユーザーに表示されます。

アプリ認証とドメイン全体の委任が必要です。詳細については、Google Chat アプリにデータのインポートを許可するをご覧ください。

認可スコープ

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

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

詳しくは、認可ガイドをご覧ください。
CreateCustomEmoji

rpc CreateCustomEmoji(CreateCustomEmojiRequest) returns (CustomEmoji)

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

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

認可スコープ

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

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

詳しくは、認可ガイドをご覧ください。
CreateMembership

rpc CreateMembership(CreateMembershipRequest) returns (Membership)

呼び出し元の 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 スペースにメッセージを作成します。例については、メッセージを送信するをご覧ください。

create() メソッドには、ユーザー認証またはアプリ認証のいずれかが必要です。Chat では、リクエストで使用する認証の種類に応じて、メッセージ送信者の属性が異なります。

次の図は、アプリ認証を使用する場合に Chat がメッセージをどのように属性付けるかを示しています。Chat ではメッセージの送信者として Chat アプリが表示されます。メッセージのコンテンツには、テキスト（text）、カード（cardsV2）、アクセサリ ウィジェット（accessoryWidgets）を含めることができます。

アプリの認証で送信されたメッセージ

次の図は、ユーザー認証を使用した場合に Chat がメッセージをどのように属性付けるかを示しています。Chat ではユーザーがメッセージの送信者として表示され、Chat 用アプリにはその名前が表示されます。メッセージのコンテンツにはテキスト（text）のみを含めることができます。

ユーザー認証で送信されたメッセージ

メッセージ コンテンツを含む最大メッセージ サイズは 32,000 バイトです。

認可スコープ

次の 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 組織内の既存のスペースで、この表示名がすでに使用されている可能性があります。

デベロッパー プレビュー プログラムのメンバーであれば、spaceType.GROUP_CHAT を使用してインポート モードでグループ チャットを作成できます。

次のタイプの認証がサポートされています。

アプリとして認証する場合は、リクエストに space.customer フィールドを設定する必要があります。

認可スコープ

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

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

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

認可スコープ

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

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

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

rpc DeleteMembership(DeleteMembershipRequest) returns (Membership)

メンバーシップを削除します。例については、スペースからユーザーまたは 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

詳細については、承認ガイドをご覧ください。
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.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 アプリ間のダイレクト メッセージ スペースを返します。

ユーザー認証では、指定されたユーザーと認証済みユーザーの間のダイレクト メッセージ スペースを返します。

// 次のタイプの認証をサポートしています。

認可スコープ

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

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

認可スコープ

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

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

詳しくは、認可ガイドをご覧ください。
GetCustomEmoji

rpc GetCustomEmoji(GetCustomEmojiRequest) returns (CustomEmoji)

カスタム絵文字に関する詳細を返します。

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

認可スコープ

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

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

詳しくは、認可ガイドをご覧ください。
GetMembership

rpc GetMembership(GetMembershipRequest) returns (Membership)

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

次のタイプの認証がサポートされています。

  • アプリの認証

  • ユーザー認証 リクエストの use_admin_access フィールドを設定することで、管理者権限でこの方法を認証および認可できます。

認可スコープ

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

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

次のタイプの認証がサポートされています。

  • アプリの認証

  • ユーザー認証 リクエストで use_admin_access フィールドを設定すると、管理者権限でこのメソッドを認証して承認できます。

認可スコープ

次の 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 フィールドは返されません。

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

例については、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

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

rpc ListCustomEmojis(ListCustomEmojisRequest) returns (ListCustomEmojisResponse)

認証済みユーザーに表示されるカスタム絵文字を一覧表示します。

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

認可スコープ

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

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

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

rpc ListMemberships(ListMembershipsRequest) returns (ListMembershipsResponse)

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

次のタイプの認証がサポートされています。

  • アプリの認証

  • ユーザー認証 リクエストで use_admin_access フィールドを設定すると、管理者権限でこのメソッドを認証して承認できます。

認可スコープ

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

発信者がメンバーになっているスペース内のメッセージ（ブロック中のメンバーとスペースからのメッセージを含む）を一覧表示します。メッセージがないスペースからのメッセージを一覧表示すると、レスポンスは空のオブジェクトになります。REST/HTTP インターフェースを使用する場合、レスポンスには空の JSON オブジェクト {} が含まれます。例については、メッセージを一覧表示するをご覧ください。

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

認可スコープ

次の 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 は、最初のメッセージが送信されるまで表示されません。例については、スペースを一覧表示するをご覧ください。

次のタイプの認証をサポートしています。

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 に設定することで、ユーザーを Space に追加できます。

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

次のタイプの認証をサポートしています。

アプリ認証を使用する場合、リクエストで更新できるのは、呼び出し元の 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.app.spaces
  • 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。チャットアプリでは、この 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 行を占有します。タイトルのみを指定した場合、タイトルは両方の行に表示されます。
subtitle

string

カード ヘッダーのサブタイトル。
image_style

ImageStyle

画像の種類（正方形の枠線や円形の枠線など）。
image_url

string

カードヘッダーの画像の URL。

ImageStyle

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

セクション

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

フィールド
header

string

セクションのヘッダー。書式設定されたテキストがサポートされています。テキストの書式設定について詳しくは、Google Chat アプリでのテキストの書式設定と Google Workspace アドオンでのテキストの書式設定をご覧ください。
widgets[]

WidgetMarkup

セクションには、少なくとも 1 つのウィジェットを含める必要があります。

CreateCustomEmojiRequest

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

フィールド
custom_emoji

CustomEmoji

必須。作成するカスタム絵文字。

CreateMembershipRequest

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

フィールド
parent

string

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

形式: spaces/{space}
membership

Membership

必須。作成するメンバーシップ関係。

memberType フィールドには、user.name フィールドと user.type フィールドに値が入力されたユーザーが含まれている必要があります。サーバーはリソース名を割り当て、指定されたものを上書きします。

Chat アプリが人間のユーザーのメンバーシップ関係を作成する場合は、特定の認可スコープを使用し、特定のフィールドに特定の値を設定する必要があります。

  • ユーザーとして認証する場合は、chat.memberships 承認スコープが必要です。

  • アプリとして認証する場合は、chat.app.memberships 承認スコープが必要です。アプリとして認証できるのは、

  • 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 組織内の既存のスペースでは、この表示名がすでに使用されている可能性があります。

デベロッパー プレビュー プログラムのメンバーである場合は、importMode が true に設定されている場合に SpaceType.GROUP_CHAT を使用できます。

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

string

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

CustomEmoji

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

フィールド
name

string

ID。サーバーによって割り当てられたカスタム絵文字のリソース名。

形式: customEmojis/{customEmoji}
uid

string

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

string

変更不可。カスタム絵文字にユーザーが指定した名前。組織内で一意です。

カスタム絵文字が作成される場合は必須で、それ以外の場合はのみ出力されます。

絵文字の名前の先頭と末尾はコロンにし、小文字にする必要があります。使用できるのは英数字、ハイフン、アンダースコアのみです。ハイフンやアンダースコアは単語の区切りに使用し、連続して使用することはできません。

例: :valid-emoji-name:
temporary_image_uri

string

出力専用。カスタム絵文字の画像 URL。10 分以上有効です。カスタム絵文字の作成時には、回答に入力されません。
payload

CustomEmojiPayload

入力のみのペイロード データ。

CustomEmojiPayload

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

フィールド
file_content

bytes

必須。入力のみのカスタム絵文字に使用される画像。

ペイロードは 256 KB 未満で、画像のサイズは 64～500 ピクセルの範囲で指定する必要があります。制限は変更される可能性があります。
filename

string

必須。入力のみの画像ファイル名。

サポートされているファイル拡張子: .png、.jpg、.gif。

DeleteCustomEmojiRequest

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

フィールド
name

string

必須。削除するカスタム絵文字のリソース名。

形式: customEmojis/{customEmoji}

絵文字名は {customEmoji} のエイリアスとして使用できます。たとえば、customEmojis/:example-emoji: です。ここで、:example-emoji: はカスタム絵文字の絵文字名です。

DeleteMembershipRequest

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

フィールド
name

string

必須。削除するメンバーシップのリソース名。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

入力のみのリクエストのダイアログ。

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 の場合、name として users/123456789 を使用して、そのユーザーとのダイレクト メッセージを検索できます。ユーザーとして認証されたら、そのメールアドレスを {user} のエイリアスとして使用できます。たとえば、users/example@gmail.com です。ここで、example@gmail.com は Google Chat ユーザーのメールアドレスです。

GetAttachmentRequest

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

フィールド
name

string

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

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/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 の保持ルールで指定されています。

ListCustomEmojisRequest

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

フィールド
page_size

int32

省略可。返されるカスタム絵文字の最大数。このサービスは、この値よりも少ないカスタム絵文字を返すことができます。指定しない場合、デフォルト値は 25 です。最大値は 200 です。200 を超える値は 200 に変更されます。
page_token

string

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

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

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

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

ページネーションを行う場合、指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致している必要があります。他のパラメータに異なる値を渡すと、予期しない結果が生じる可能性があります。
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 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} の形式で指定します。1 つのクエリで指定できる 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

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

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

string

必須。クエリフィルタ。

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

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

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

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

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

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

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

次のクエリは無効です。

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

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

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

ListSpaceEventsResponse

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

フィールド
space_events[]

SpaceEvent

結果は時系列で返されます（古いイベントが先）。注: list リクエストの場合、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

リクエストされた（または最初の）ページのスペースのリスト。注: list リクエストの場合、permissionSettings フィールドは Space オブジェクトで返されません。
next_page_token

string

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

MatchedUrl

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

フィールド
url

string

出力専用。一致した URL。

メンバーシップ

Google Chat のメンバーシップ関係を表します。たとえば、ユーザーまたは 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 グループ。

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:）。これは、笑顔の絵文字の U+1F600 など、Unicode 絵文字には適用されません。

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

Card

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

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

CardWithId

cards の配列。

カードを作成できるのは 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 API を呼び出し、次の項目を省略する必要があります。

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

DeletionMetadata

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

QuotedMessageMetadata

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

AttachedGif

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

AccessoryWidget

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

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

MessageBatchCreatedEventData

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

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

フィールド
messages[]

MessageCreatedEventData

新しいメッセージのリスト。

MessageBatchDeletedEventData

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

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

フィールド
messages[]

MessageDeletedEventData

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

MessageBatchUpdatedEventData

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

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

フィールド
messages[]

MessageUpdatedEventData

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

MessageCreatedEventData

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

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

フィールド
message

Message

新しいメッセージ。

MessageDeletedEventData

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

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

フィールド
message

Message

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

MessageUpdatedEventData

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

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

フィールド
message

Message

更新されたメッセージ。

QuotedMessageMetadata

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

フィールド
name

string

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

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

Timestamp

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

リアクション

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

フィールド
name

string

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

形式: 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

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

ページネーションを行う場合、指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致している必要があります。他のパラメータに異なる値を渡すと、予期しない結果が生じる可能性があります。
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 が入力された user（形式: users/{user}）を含め、type を User.Type.HUMAN に設定する必要があります。スペースの設定時にのみ、人間のユーザーを追加できます（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 に設定する場合は必須です。

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

フィールド
name

string

Space のリソース名。

形式: spaces/{space}

ここで、{space} はスペースにシステムによって割り当てられた ID を表します。スペース ID を取得するには、spaces.list() メソッドを呼び出すか、スペースの URL を使用します。たとえば、スペースの URL が https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA の場合、スペース ID は AAAAAAAAA です。
type
(deprecated)

Type

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

SpaceType

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

bool

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

bool

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

string

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

ダイレクト メッセージの場合、このフィールドは空になることがあります。

128 文字までサポートされます。
external_user_allowed

bool

変更不可。このスペースで Google Chat のすべてのユーザーをメンバーとして許可するかどうか。Google Workspace 組織でスペースを作成するときに入力します。次の条件でスペースを作成する場合は、このフィールドを省略します。

  • 認証されたユーザーが一般ユーザー アカウント（管理対象外のユーザー アカウント）を使用している。デフォルトでは、一般ユーザー向けアカウントで作成されたスペースでは、すべての Google Chat ユーザーが許可されます。

既存のスペースの場合、このフィールドは出力専用です。
space_threading_state

SpaceThreadingState

出力専用。Chat スペースのスレッド状態。
space_details

SpaceDetails

スペースの詳細（説明やルールなど）。
space_history_state

HistoryState

このスペース内のメッセージとスレッドのメッセージ履歴の状態。
import_mode

bool

省略可。このスペースが、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。
customer

string

省略可。変更不可。スペースのドメインのお客様 ID。アプリ認証でスペースを作成し、SpaceType が SPACE の場合にのみ必要です。それ以外の場合は設定しないでください。

customers/{customer} の形式。ここで、customer は [Admin SDK ユーザー リソース]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers)の id です。限定公開アプリでは、customers/my_customer エイリアスを使用して、アプリと同じ Google Workspace 組織にスペースを作成することもできます。

DM の場合、このフィールドは入力されません。

共用体フィールド space_permission_settings。スペースの権限の設定を表します。space_type が SPACE の場合にのみ入力されます。

ユーザー認証が必要です。space_permission_settings は次のいずれかになります。
predefined_permission_settings

PredefinedPermissionSettings

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

PermissionSettings

省略可。既存のスペースのスペース権限の設定。スペースの権限設定を厳密に更新するための入力。既存の権限設定が置き換えられます。出力には、現在の権限設定が一覧表示されます。

AccessSettings

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

フィールド
access_state

AccessState

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

string

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

形式: audiences/{audience}

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

対象ユーザーの読み取りは、次の機能をサポートしています。

アプリの認証で chat.bot スコープを使用している場合、このフィールドには値が入力されません。

対象グループを設定するには、ユーザー認証が必要です。

AccessState

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

列挙型
ACCESS_STATE_UNSPECIFIED アクセス状態が不明であるか、この API ではサポートされていません。
PRIVATE スペースを検出してアクセスできるのは、他のユーザーまたは Google Workspace 管理者によって個別に追加または招待されたユーザーまたは Google グループのみです。
DISCOVERABLE

スペースの管理者が、対象グループにスペースへのアクセス権を付与しました。スペースに個別に追加または招待されたユーザーや Google グループも、スペースを見つけてアクセスできます。詳しくは、特定のユーザーがスペースを見つけられるようにするをご覧ください。

検出可能なスペースを作成するには、ユーザー認証が必要です。

MembershipCount

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

フィールド
joined_direct_human_user_count

int32

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

int32

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

PermissionSetting

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

フィールド
managers_allowed

bool

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

bool

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

PermissionSettings

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

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

フィールド
manage_members_and_groups

PermissionSetting

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

PermissionSetting

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

PermissionSetting

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

PermissionSetting

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

PermissionSetting

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

PermissionSetting

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

PermissionSetting

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

PermissionSetting

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

PredefinedPermissionSettings

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

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

SpaceDetails

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

フィールド
description

string

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

最大 150 文字をサポートします。
guidelines

string

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

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

SpaceThreadingState

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

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

SpaceType

スペースのタイプ。スペースの作成または更新時に必要です。他の使用方法の場合は出力のみ。

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

タイプ

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

列挙型
TYPE_UNSPECIFIED 予約済み。
ROOM 2 人以上の人間との会話。
DM 人間と Chat アプリ間の 1 対 1 のダイレクト メッセージ。すべてのメッセージがフラットです。ただし、人間同士のダイレクト メッセージは対象外です。

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 アプリが同じスレッドキーを使用してメッセージを作成した場合、メッセージは異なるスレッドに投稿されます。ユーザーまたは他の 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: スペースの説明を更新します。150 文字までサポートされます。

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

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

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

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

permission_settings: スペースの権限設定を変更できます。権限設定を更新する場合は、permissionSettings フィールド マスクのみを指定できます。他のフィールド マスクを同時に更新することはできません。permissionSettings は useAdminAccess ではサポートされていません。サポートされているフィールド マスクは次のとおりです。

  • permission_settings.manageMembersAndGroups
  • permission_settings.modifySpaceDetails
  • permission_settings.toggleHistory
  • permission_settings.useAtMentionAll
  • permission_settings.manageApps
  • permission_settings.manageWebhooks
  • permission_settings.replyMessages
use_admin_access

bool

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

呼び出し元のユーザーは、Chat とスペースの会話の管理権限を持つ Google Workspace 管理者である必要があります。

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

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

ユーザー

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

フィールド
name

string

Google Chat user のリソース名。

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

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

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

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

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

string

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

string

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

Type

ユーザーの種類。
is_anonymous

bool

出力専用。true の場合、ユーザーは削除されているか、プロフィールが表示されません。

タイプ

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

UserMentionMetadata

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

フィールド
user

User

お客様が言及した内容。
type

Type

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

タイプ

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

WidgetMarkup

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

フィールド
buttons[]

Button

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

TextParagraph

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

Image

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

KeyValue

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

ボタン

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

フィールド

共用体フィールド type。

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

TextButton

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

ImageButton

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

FormAction

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

フィールド
action_method_name

string

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

ActionParameter

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

ActionParameter

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

フィールド
key

string

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

string

パラメータの値。

アイコン

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

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

画像

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

フィールド
image_url

string

画像の URL です。
on_click

OnClick

onclick アクション。
aspect_ratio

double

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

ImageButton

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

フィールド
on_click

OnClick

onclick アクション。
name

string

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

Icon

Chat API から提供されたアイコンをインデックスする enum で指定されたアイコン。
icon_url

string

URL で指定されたアイコン。

KeyValue

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

フィールド
top_label

string

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

string

コンテンツのテキスト。書式設定されたテキストがサポートされており、常に必須です。テキストの書式設定の詳細については、Google Chat アプリでのテキストの書式設定と Google Workspace アドオンでのテキストの書式設定をご覧ください。
content_multiline

bool

コンテンツを複数行にする必要があります。
bottom_label

string

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

OnClick

onclick アクション。クリックできるのは、上部ラベル、下部ラベル、コンテンツ領域のみです。
共用体フィールド icons。アイコン top_label と bottom_label のうち少なくとも 1 つを定義する必要があります。icons は次のいずれかになります。
icon

Icon

Chat API によって対応するアイコン画像に置き換えられる列挙型の値。
icon_url

string

URL で指定されたアイコン。
共用体フィールド control。コントロール ウィジェット。button または switch_widget は、いずれか 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