Package google.chat.v1

インデックス

ChatService

デベロッパーが Google Chat Platform で Chat 用アプリやインテグレーションを構築できるようにします。

CompleteImportSpace

rpc CompleteImportSpace(CompleteImportSpaceRequest) returns (CompleteImportSpaceResponse)

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

ユーザー認証と、認可スコープを使用したドメイン全体の委任が必要です。

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

詳細については、Google Chat アプリにデータのインポートを許可するをご覧ください。

認可スコープ

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

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

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

rpc CreateCustomEmoji(CreateCustomEmojiRequest) returns (CustomEmoji)

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

カスタム絵文字は Google Workspace アカウントでのみ使用でき、管理者が組織でカスタム絵文字を有効にする必要があります。詳しくは、Google Chat のカスタム絵文字についてとカスタム絵文字の権限を管理するをご覧ください。

認可スコープを使用したユーザー認証が必要です。

  • https://www.googleapis.com/auth/chat.customemojis
認可スコープ

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

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

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

rpc CreateMembership(CreateMembershipRequest) returns (Membership)

呼び出し元の Chat 用アプリ、ユーザー、または Google グループのメンバーシップを作成します。他の Chat 用アプリのメンバーシップを作成することはできません。メンバーシップを作成する際に、指定したメンバーの自動承認ポリシーがオフになっている場合は、そのメンバーは招待され、参加する前にスペースの招待を承諾する必要があります。それ以外の場合、メンバーシップを作成すると、指定されたスペースにメンバーが直接追加されます。

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

  • 管理者による承認と承認スコープを使用したアプリの認証:

    • https://www.googleapis.com/auth/chat.app.memberships

  • 次のいずれかの認可スコープを使用したユーザー認証:

    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.memberships.app（通話アプリをスペースに追加するため）
    • https://www.googleapis.com/auth/chat.import（インポート モードのスペースのみ）
    • ユーザー認証では、管理者アカウントが認証され、use_admin_access が true で、次の認可スコープが使用されている場合に、管理者権限が付与されます。
      • https://www.googleapis.com/auth/chat.admin.memberships

アプリ認証は、次のユースケースではサポートされていません。

  • スペースを所有する Workspace 組織外のユーザーを招待する。
  • スペースに Google グループを追加する。
  • スペースに Chat 用アプリを追加する。

使用例については、以下をご覧ください。

認可スコープ

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

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

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

rpc CreateMessage(CreateMessageRequest) returns (Message)

Google Chat スペースにメッセージを作成します。例については、メッセージを送信するをご覧ください。

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

  • 認可スコープを使用したアプリ認証:
    • https://www.googleapis.com/auth/chat.bot
  • 次のいずれかの認可スコープを使用したユーザー認証:
    • https://www.googleapis.com/auth/chat.messages.create
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import（インポート モードのスペースのみ）

Chat では、リクエストで使用する認証のタイプに応じて、メッセージの送信者を異なる方法で特定します。

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

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

次の図は、ユーザー認証を使用した場合に Chat がメッセージを帰属させる方法を示しています。Chat では、ユーザーがメッセージの送信者として表示され、Chat アプリの名前が表示されることで、Chat アプリがメッセージに関連付けられます。メッセージの内容にはテキスト（text）のみを含めることができます。

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

メッセージの内容を含むメッセージの最大サイズは 32,000 バイトです。

Webhook リクエストの場合、レスポンスにメッセージ全体が含まれていません。レスポンスには、リクエストに含まれていた情報に加えて、name フィールドと thread.name フィールドのみが入力されます。

認可スコープ

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

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

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

rpc CreateMessagePin(CreateMessagePinRequest) returns (MessagePin)

メッセージのピン留めを作成します。

次のいずれかの認可スコープを使用したユーザー認証が必要です。

  • https://www.googleapis.com/auth/chat.spaces.pins
  • https://www.googleapis.com/auth/chat.spaces
認可スコープ

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

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

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

rpc CreateReaction(CreateReactionRequest) returns (Reaction)

リアクションを作成してメッセージに追加します。例については、メッセージにリアクションを追加するをご覧ください。

次のいずれかの認可スコープを使用したユーザー認証が必要です。

  • https://www.googleapis.com/auth/chat.messages.reactions.create
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.import（インポート モードのスペースのみ）
認可スコープ

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

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

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

rpc CreateSection(CreateSectionRequest) returns (Section)

Google Chat でセクションを作成します。セクションを使用すると、会話をグループ化したり、Chat のナビゲーション パネルに表示されるスペースのリストをカスタマイズしたりできます。作成できるのは CUSTOM_SECTION タイプのセクションのみです。詳しくは、Google Chat でセクションを作成、整理するをご覧ください。

認可スコープを使用したユーザー認証が必要です。

  • https://www.googleapis.com/auth/chat.users.sections
認可スコープ

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

  • https://www.googleapis.com/auth/chat.users.sections

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

rpc CreateSpace(CreateSpaceRequest) returns (Space)

スペースを作成します。Import mode で名前付きスペースまたはグループ チャットを作成するために使用できます。例については、スペースを作成するをご覧ください。

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

  • 管理者による承認と次のいずれかの認可スコープによるアプリ認証:

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

  • 次のいずれかの認可スコープを使用したユーザー認証:

    • https://www.googleapis.com/auth/chat.spaces.create
    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.import（インポート モードのスペースのみ）

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

アプリとして認証すると、Chat 用アプリがスペースのメンバーとして追加されます。ただし、ユーザー認証とは異なり、Chat 用アプリはスペース管理者として追加されません。デフォルトでは、スペースのすべてのメンバーが Chat 用アプリをスペースから削除できます。スペース管理者のみがスペースからアプリを削除できるようにするには、space.permission_settings.manage_apps を managers_allowed に設定します。

作成時のスペース メンバーシップは、スペースが Import mode で作成されたかどうかによって異なります。

  • インポート モード: メンバーは作成されません。
  • その他のすべてのモード: 通話ユーザーがメンバーとして追加されます。これは次のようになります。
    • アプリ認証を使用している場合はアプリ自体。
    • ユーザー認証を使用する場合のユーザー。

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

認可スコープ

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

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

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

rpc DeleteCustomEmoji(DeleteCustomEmojiRequest) returns (Empty)

カスタム絵文字を削除します。デフォルトでは、ユーザーは自分で作成したカスタム絵文字のみを削除できます。管理者が割り当てた絵文字管理者は、組織内のカスタム絵文字を削除できます。Google Chat のカスタム絵文字についてをご覧ください。

カスタム絵文字は Google Workspace アカウントでのみ使用でき、管理者が組織でカスタム絵文字を有効にする必要があります。詳しくは、Google Chat のカスタム絵文字についてとカスタム絵文字の権限を管理するをご覧ください。

認可スコープを使用したユーザー認証が必要です。

  • https://www.googleapis.com/auth/chat.customemojis
認可スコープ

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

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

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

rpc DeleteMembership(DeleteMembershipRequest) returns (Membership)

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

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

  • 管理者による承認と承認スコープを使用したアプリの認証:

    • https://www.googleapis.com/auth/chat.app.memberships

  • 次のいずれかの認可スコープを使用したユーザー認証:

    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.memberships.app（スペースから通話アプリを削除するため）
    • https://www.googleapis.com/auth/chat.import（インポート モードのスペースのみ）
    • ユーザー認証では、管理者アカウントが認証され、use_admin_access が true で、次の認可スコープが使用されている場合に、管理者権限が付与されます。
      • https://www.googleapis.com/auth/chat.admin.memberships

アプリ認証は、次のユースケースではサポートされていません。

  • スペースから Google グループを削除する。
  • スペースから Chat 用アプリを削除する。

スペースの管理者のメンバーシップを削除するには、リクエストを行うユーザーがスペースの管理者である必要があります。アプリ認証を使用している場合、Chat 用アプリはスペースの作成者である必要があります。

認可スコープ

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

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

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

rpc DeleteMessage(DeleteMessageRequest) returns (Empty)

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

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

  • 認可スコープを使用したアプリ認証:

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

  • 次のいずれかの認可スコープを使用したユーザー認証:

    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import（インポート モードのスペースのみ）

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

認可スコープ

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

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

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

rpc DeleteMessagePin(DeleteMessagePinRequest) returns (Empty)

メッセージのピン留めを削除します。

次のいずれかの認可スコープを使用したユーザー認証が必要です。

  • https://www.googleapis.com/auth/chat.spaces.pins
  • https://www.googleapis.com/auth/chat.spaces
認可スコープ

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

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

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

rpc DeleteReaction(DeleteReactionRequest) returns (Empty)

メッセージに対するリアクションを削除します。例については、リアクションを削除するをご覧ください。

次のいずれかの認可スコープを使用したユーザー認証が必要です。

  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.import（インポート モードのスペースのみ）
認可スコープ

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

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

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

rpc DeleteSection(DeleteSectionRequest) returns (Empty)

CUSTOM_SECTION タイプのセクションを削除します。

セクションにスペースなどのアイテムが含まれている場合、アイテムは Google Chat のデフォルトのセクションに移動され、削除されません。

詳しくは、Google Chat でセクションを作成、整理するをご覧ください。

認可スコープを使用したユーザー認証が必要です。

  • https://www.googleapis.com/auth/chat.users.sections
認可スコープ

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

  • https://www.googleapis.com/auth/chat.users.sections

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

rpc DeleteSpace(DeleteSpaceRequest) returns (Empty)

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

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

  • 管理者による承認と承認スコープを使用したアプリの認証:

    • https://www.googleapis.com/auth/chat.app.delete（アプリが作成したスペースのみ）

  • 次のいずれかの認可スコープを使用したユーザー認証:

    • https://www.googleapis.com/auth/chat.delete
    • https://www.googleapis.com/auth/chat.import（インポート モードのスペースのみ）
    • ユーザー認証では、管理者アカウントが認証され、use_admin_access が true で、次の認可スコープが使用されている場合に、管理者権限が付与されます。
      • https://www.googleapis.com/auth/chat.admin.delete
認可スコープ

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

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

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

rpc FindDirectMessage(FindDirectMessageRequest) returns (Space)

指定されたユーザーとの既存のダイレクト メッセージを返します。ダイレクト メッセージ スペースが見つからない場合は、404 NOT_FOUND エラーを返します。例については、ダイレクト メッセージを探すをご覧ください。

アプリ認証では、指定されたユーザーと呼び出し元の Chat 用アプリ間のダイレクト メッセージ スペースを返します。

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

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

  • 認可スコープを使用したアプリ認証:

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

  • 次のいずれかの認可スコープを使用したユーザー認証:

    • https://www.googleapis.com/auth/chat.spaces.readonly
    • https://www.googleapis.com/auth/chat.spaces
認可スコープ

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

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

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

rpc FindGroupChats(FindGroupChatsRequest) returns (FindGroupChatsResponse)

spaceType == GROUP_CHAT を持ち、人間メンバーシップに呼び出しユーザーと FindGroupChatsRequest.users で指定されたユーザーが正確に含まれているすべてのスペースを返します。会話に参加しているメンバーのみがサポートされます。例については、グループ チャットを見つけるをご覧ください。

呼び出し元のユーザーが一部のユーザーをブロックしている場合、または一部のユーザーにブロックされている場合、指定されたユーザーのセット全体を含むスペースが見つからないと、このメソッドはブロックされたユーザーまたはブロックしているユーザーを含まないスペースを返します。

指定されたユーザーのセットには、人間（アプリ以外）のメンバーシップのみが含まれている必要があります。人間以外のユーザーを含むリクエストでは、スペースは返されません。

次のいずれかの認可スコープを使用したユーザー認証が必要です。

  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.memberships
認可スコープ

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

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

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

rpc GetAttachment(GetAttachmentRequest) returns (Attachment)

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

認可スコープによるアプリ認証が必要です。

  • https://www.googleapis.com/auth/chat.bot
認可スコープ

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

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

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

rpc GetAvailability(GetAvailabilityRequest) returns (Availability)

Google Chat のユーザーの空き情報を返します。たとえば、ユーザーがオンラインか離席中かを確認したり、カスタム ステータス メッセージを取得したりするために使用できます。

このメソッドは、認証されたユーザーの空き状況のみを取得します。

次のいずれかの認可スコープを使用したユーザー認証が必要です。

  • https://www.googleapis.com/auth/chat.users.availability.readonly
  • https://www.googleapis.com/auth/chat.users.availability
認可スコープ

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

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

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

rpc GetCustomEmoji(GetCustomEmojiRequest) returns (CustomEmoji)

カスタム絵文字の詳細を返します。

カスタム絵文字は Google Workspace アカウントでのみ使用でき、管理者が組織でカスタム絵文字を有効にする必要があります。詳しくは、Google Chat のカスタム絵文字についてとカスタム絵文字の権限を管理するをご覧ください。

次のいずれかの認可スコープを使用したユーザー認証が必要です。

  • https://www.googleapis.com/auth/chat.customemojis.readonly
  • https://www.googleapis.com/auth/chat.customemojis
認可スコープ

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

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

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

rpc GetMembership(GetMembershipRequest) returns (Membership)

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

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

  • 次のいずれかの認可スコープを使用したアプリ認証:

    • https://www.googleapis.com/auth/chat.bot
    • https://www.googleapis.com/auth/chat.app.memberships（管理者の承認が必要）

  • 次のいずれかの認可スコープを使用したユーザー認証:

    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships
    • ユーザー認証では、管理者アカウントが認証され、use_admin_access が true であり、次のいずれかの認可スコープが使用されている場合に、管理者権限が付与されます。
      • https://www.googleapis.com/auth/chat.admin.memberships.readonly
      • https://www.googleapis.com/auth/chat.admin.memberships
認可スコープ

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

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

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

rpc GetMessage(GetMessageRequest) returns (Message)

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

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

  • 次のいずれかの認可スコープを使用したアプリ認証:

    • https://www.googleapis.com/auth/chat.bot: この認証スコープを使用すると、このメソッドは、Chat アプリがアクセスできるメッセージ（ダイレクト メッセージや Chat アプリを呼び出すスラッシュ コマンドなど）の詳細を返します。
    • 管理者による承認が必要な https://www.googleapis.com/auth/chat.app.messages.readonly。この認証スコープを使用すると、このメソッドはスペース内の公開メッセージの詳細を返します。

  • 次のいずれかの認可スコープを使用したユーザー認証:

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

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

認可スコープ

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

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

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

rpc GetSpace(GetSpaceRequest) returns (Space)

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

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

  • 次のいずれかの認可スコープを使用したアプリ認証:

    • https://www.googleapis.com/auth/chat.bot
    • https://www.googleapis.com/auth/chat.app.spaces（管理者の承認あり）

  • 次のいずれかの認可スコープを使用したユーザー認証:

    • https://www.googleapis.com/auth/chat.spaces.readonly
    • https://www.googleapis.com/auth/chat.spaces
    • ユーザー認証では、管理者アカウントが認証され、use_admin_access が true であり、次のいずれかの認可スコープが使用されている場合に、管理者権限が付与されます。
      • https://www.googleapis.com/auth/chat.admin.spaces.readonly
      • https://www.googleapis.com/auth/chat.admin.spaces

アプリ認証には次の制限があります。

  • space.access_settings は、chat.app.spaces スコープを使用している場合にのみ入力されます。
  • space.predefind_permission_settings と space.permission_settings は、chat.app.spaces スコープを使用する場合にのみ、アプリが作成したスペースに対してのみ入力されます。
認可スコープ

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

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

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

rpc GetSpaceEvent(GetSpaceEventRequest) returns (SpaceEvent)

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

注: このリクエストの Space イベントデータの Space オブジェクトでは、permissionSettings フィールドは返されません。

リクエストされたデータの読み取りに適した認可スコープで、次のタイプの認証をサポートします。

  • 次のいずれかの認可スコープを使用した管理者による承認によるアプリ認証:

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

  • 次のいずれかの認可スコープを使用したユーザー認証:

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

イベントを取得するには、認証された呼び出し元がスペースのメンバーである必要があります。

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

認可スコープ

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

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

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

rpc GetSpaceNotificationSetting(GetSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

スペースの通知設定を取得します。例については、発信者のスペース通知設定を取得するをご覧ください。

認可スコープを使用したユーザー認証が必要です。

  • https://www.googleapis.com/auth/chat.users.spacesettings
認可スコープ

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

  • https://www.googleapis.com/auth/chat.users.spacesettings

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

rpc GetSpaceReadState(GetSpaceReadStateRequest) returns (SpaceReadState)

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

次のいずれかの認可スコープを使用したユーザー認証が必要です。

  • https://www.googleapis.com/auth/chat.users.readstate.readonly
  • https://www.googleapis.com/auth/chat.users.readstate
認可スコープ

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

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

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

rpc GetThreadReadState(GetThreadReadStateRequest) returns (ThreadReadState)

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

次のいずれかの認可スコープを使用したユーザー認証が必要です。

  • https://www.googleapis.com/auth/chat.users.readstate.readonly
  • https://www.googleapis.com/auth/chat.users.readstate
認可スコープ

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

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

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

rpc ListCustomEmojis(ListCustomEmojisRequest) returns (ListCustomEmojisResponse)

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

カスタム絵文字は Google Workspace アカウントでのみ使用でき、管理者が組織でカスタム絵文字を有効にする必要があります。詳しくは、Google Chat のカスタム絵文字についてとカスタム絵文字の権限を管理するをご覧ください。

次のいずれかの認可スコープを使用したユーザー認証が必要です。

  • https://www.googleapis.com/auth/chat.customemojis.readonly
  • https://www.googleapis.com/auth/chat.customemojis
認可スコープ

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

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

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

rpc ListMemberships(ListMembershipsRequest) returns (ListMembershipsResponse)

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

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

  • 次のいずれかの認可スコープを使用したアプリ認証:

    • https://www.googleapis.com/auth/chat.bot
    • https://www.googleapis.com/auth/chat.app.memberships（管理者の承認が必要）

  • 次のいずれかの認可スコープを使用したユーザー認証:

    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.import（インポート モードのスペースのみ）
    • ユーザー認証では、管理者アカウントが認証され、use_admin_access が true であり、次のいずれかの認可スコープが使用されている場合に、管理者権限が付与されます。
      • https://www.googleapis.com/auth/chat.admin.memberships.readonly
      • https://www.googleapis.com/auth/chat.admin.memberships
認可スコープ

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

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

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

rpc ListMessagePins(ListMessagePinsRequest) returns (ListMessagePinsResponse)

スペース内のメッセージのピン留めの一覧を取得します。スペースで重要なメッセージをピン留めして、簡単にアクセスできるようにすることができます。詳しくは、Google Chat で会話を固定または固定解除するをご覧ください。

次のいずれかの認可スコープを使用したユーザー認証が必要です。

  • https://www.googleapis.com/auth/chat.spaces.pins.readonly
  • https://www.googleapis.com/auth/chat.spaces.pins
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.spaces
認可スコープ

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

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

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

rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse)

通話の発信者がメンバーであるスペース内のメッセージを一覧表示します。ブロックされたメンバーやスペースからのメッセージも含まれます。新しいスペース メンバーの追加を知らせるメッセージなどのシステム メッセージは含まれません。メッセージのないスペースのメッセージを一覧表示すると、レスポンスは空のオブジェクトになります。REST/HTTP インターフェースを使用する場合、レスポンスには空の JSON オブジェクト {} が含まれます。例については、メッセージを一覧表示するをご覧ください。

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

  • 認可スコープを使用した管理者による承認によるアプリ認証:

    • https://www.googleapis.com/auth/chat.app.messages.readonly。この認証スコープを使用すると、このメソッドはスペース内の公開メッセージのみを返します。プライベート メッセージは含まれません。

  • 次のいずれかの認可スコープを使用したユーザー認証:

    • https://www.googleapis.com/auth/chat.messages.readonly
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import（インポート モードのスペースのみ）
認可スコープ

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

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

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

rpc ListReactions(ListReactionsRequest) returns (ListReactionsResponse)

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

次のいずれかの認可スコープを使用したユーザー認証が必要です。

  • https://www.googleapis.com/auth/chat.messages.reactions.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages
認可スコープ

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

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

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

rpc ListSectionItems(ListSectionItemsRequest) returns (ListSectionItemsResponse)

セクション内のアイテムをリスト表示します。

セクション アイテムにできるのはスペースのみです。詳しくは、Google Chat でセクションを作成、整理するをご覧ください。

認可スコープを使用したユーザー認証が必要です。

  • https://www.googleapis.com/auth/chat.users.sections
  • https://www.googleapis.com/auth/chat.users.sections.readonly
認可スコープ

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

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

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

rpc ListSections(ListSectionsRequest) returns (ListSectionsResponse)

Chat ユーザーが利用できるセクションを一覧表示します。セクションを使用すると、会話をグループ化したり、Chat のナビゲーション パネルに表示されるスペースのリストをカスタマイズしたりできます。詳しくは、Google Chat でセクションを作成、整理するをご覧ください。

認可スコープを使用したユーザー認証が必要です。

  • https://www.googleapis.com/auth/chat.users.sections
  • https://www.googleapis.com/auth/chat.users.sections.readonly
認可スコープ

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

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

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

rpc ListSpaceEvents(ListSpaceEventsRequest) returns (ListSpaceEventsResponse)

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

リクエストされたデータの読み取りに適した認可スコープで、次のタイプの認証をサポートします。

  • 次のいずれかの認可スコープを使用した管理者による承認によるアプリ認証:

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

  • 次のいずれかの認可スコープを使用したユーザー認証:

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

イベントを一覧表示するには、認証された呼び出し元がスペースのメンバーである必要があります。

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

認可スコープ

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

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

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

rpc ListSpaces(ListSpacesRequest) returns (ListSpacesResponse)

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

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

  • 認可スコープを使用したアプリ認証:

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

  • 次のいずれかの認可スコープを使用したユーザー認証:

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

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

認可スコープ

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

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

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

rpc MarkAsActive(MarkAsActiveRequest) returns (Availability)

Google Chat でユーザーを ACTIVE としてマークします。

ユーザーの可用性状態を ACTIVE に設定します。ACTIVE 状態は指定された有効期限まで続き、その時点でユーザーの状態は AWAY になります。ユーザーが Chat を積極的に使用している場合、ACTIVE 状態の期間が指定された有効期限を超えて延長されることがあります。

このメソッドは、認証されたユーザーの空き状況のみを更新します。

認可スコープによるユーザー認証が必要です。

  • https://www.googleapis.com/auth/chat.users.availability
認可スコープ

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

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

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

rpc MarkAsAway(MarkAsAwayRequest) returns (Availability)

Google Chat でユーザーを AWAY としてマークします。

ユーザーの状態を離席中に設定します。ユーザーのアクティビティの影響を受けません。

このメソッドは、認証されたユーザーの空き状況のみを更新します。

認可スコープによるユーザー認証が必要です。

  • https://www.googleapis.com/auth/chat.users.availability
認可スコープ

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

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

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

rpc MarkAsDoNotDisturb(MarkAsDoNotDisturbRequest) returns (Availability)

Google Chat でユーザーを DO_NOT_DISTURB としてマークします。

指定された有効期限までユーザーのステータスを DO_NOT_DISTURB に設定します。通常、DO_NOT_DISTURB の場合、ユーザーは通知を受け取りません。

このメソッドは、認証されたユーザーの空き状況のみを更新します。

認可スコープによるユーザー認証が必要です。

  • https://www.googleapis.com/auth/chat.users.availability
認可スコープ

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

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

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

rpc MoveSectionItem(MoveSectionItemRequest) returns (MoveSectionItemResponse)

アイテムをあるセクションから別のセクションに移動します。たとえば、セクションにスペースが含まれている場合、このメソッドを使用してスペースを別のセクションに移動できます。詳しくは、Google Chat でセクションを作成、整理するをご覧ください。

認可スコープを使用したユーザー認証が必要です。

  • https://www.googleapis.com/auth/chat.users.sections
認可スコープ

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

  • https://www.googleapis.com/auth/chat.users.sections

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

rpc PositionSection(PositionSectionRequest) returns (PositionSectionResponse)

セクションの並べ替え順序を変更します。詳しくは、Google Chat でセクションを作成、整理するをご覧ください。

認可スコープを使用したユーザー認証が必要です。

  • https://www.googleapis.com/auth/chat.users.sections
認可スコープ

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

  • https://www.googleapis.com/auth/chat.users.sections

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

rpc ReplaceMessageCards(ReplaceMessageCardsRequest) returns (ReplaceMessageCardsResponse)

メッセージに含まれるカードを置き換えます。

Chat 用アプリは、メッセージにすでにカードが含まれていて、そのカードがアプリによって作成された場合にのみ、人間が作成したメッセージのカードを置き換えることができます。

アプリがカードを空のリストに置き換えると、カードは削除されます。カードを削除すると、アプリはカードをメッセージに追加し直すことができなくなります。

承認スコープを使用したアプリ認証が必要です。- https://www.googleapis.com/auth/chat.bot

認可スコープ

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

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

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

rpc SearchMessages(SearchMessagesRequest) returns (SearchMessagesResponse)

呼び出し元のユーザーがアクセスできる Google Chat のメッセージを検索します。検索条件に一致するメッセージのリストを返します。

ユーザーがアクセスできるすべてのスペースを検索するには、parent を spaces/- に設定します。parent に他の値を使用すると、INVALID_ARGUMENT エラーが発生します。返されたメッセージの name フィールドには、メッセージが存在する特定の space を含む完全なリソース名が入力されます。

この API はすべてのメッセージ タイプを返しません。以下の種類のメッセージはレスポンスに含まれません。すべてのメッセージを一覧表示するには、ListMessages を使用します。

  • 認証されたユーザーに表示される非公開メッセージ。
  • スペースまたはグループ チャットで Chat 用アプリによって投稿されたメッセージ。
  • Chat 用アプリの DM のメッセージ。
  • ブロックしたユーザーからのメッセージ。
  • 発信者がミュートしたスペース内のメッセージ。

次のいずれかの認可スコープを使用したユーザー認証が必要です。

  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages
認可スコープ

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

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

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

rpc SearchSpaces(SearchSpacesRequest) returns (SearchSpacesResponse)

Google Workspace 組織内のスペースのリストを返します。例については、スペースを検索して管理するをご覧ください。

use_admin_access が false に設定されている場合、結果は呼び出しユーザーが参加しているスペースに限定されます。管理者権限で検索するには、use_admin_access を true に設定します。

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

認可スコープ

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

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

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

rpc SetUpSpace(SetUpSpaceRequest) returns (Space)

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

追加するユーザー メンバーを指定するには、適切な membership.member.name を使用してメンバーシップを追加します。人間のユーザーを追加するには、users/{user} を使用します。ここで、{user} はユーザーのメールアドレスにできます。同じ Workspace 組織内のユーザーの場合、{user} は People API の人物の id、または Directory API のユーザーの id にすることもできます。たとえば、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 組織内の既存のスペースで、この表示名がすでに使用されている可能性があります。

次のいずれかの認可スコープを使用したユーザー認証が必要です。

  • https://www.googleapis.com/auth/chat.spaces.create
  • https://www.googleapis.com/auth/chat.spaces
認可スコープ

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

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

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

rpc UpdateAvailability(UpdateAvailabilityRequest) returns (Availability)

人間のユーザーの空き情報を更新します。このメソッドで更新できるのは custom_status フィールドのみです。

このメソッドは、認証されたユーザーの空き状況のみを更新します。

次のいずれかの認可スコープを使用したユーザー認証が必要です。

  • https://www.googleapis.com/auth/chat.users.availability
認可スコープ

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

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

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

rpc UpdateMembership(UpdateMembershipRequest) returns (Membership)

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

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

  • 管理者による承認と承認スコープを使用したアプリの認証:

    • https://www.googleapis.com/auth/chat.app.memberships（アプリが作成したスペースのみ）

  • 次のいずれかの認可スコープを使用したユーザー認証:

    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.import（インポート モードのスペースのみ）
    • ユーザー認証では、管理者アカウントが認証され、use_admin_access が true で、次の認可スコープが使用されている場合に、管理者権限が付与されます。
      • https://www.googleapis.com/auth/chat.admin.memberships
認可スコープ

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

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

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

rpc UpdateMessage(UpdateMessageRequest) returns (Message)

メッセージを更新します。patch メソッドと update メソッドには違いがあります。patch メソッドは patch リクエストを使用し、update メソッドは put リクエストを使用します。patch メソッドを使用することをおすすめします。例については、メッセージを更新するをご覧ください。

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

  • 認可スコープを使用したアプリ認証:

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

  • 次のいずれかの認可スコープを使用したユーザー認証:

    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import（インポート モードのスペースのみ）

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

認可スコープ

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

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

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

rpc UpdateSection(UpdateSectionRequest) returns (Section)

セクションを更新します。更新できるのは、タイプ CUSTOM_SECTION のセクションのみです。詳しくは、Google Chat でセクションを作成、整理するをご覧ください。

認可スコープを使用したユーザー認証が必要です。

  • https://www.googleapis.com/auth/chat.users.sections
認可スコープ

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

  • https://www.googleapis.com/auth/chat.users.sections

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

rpc UpdateSpace(UpdateSpaceRequest) returns (Space)

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

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

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

  • 管理者による承認と次のいずれかの認可スコープによるアプリ認証:

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

  • 次のいずれかの認可スコープを使用したユーザー認証:

    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.import（インポート モードのスペースのみ）
    • ユーザー認証では、管理者アカウントが認証され、use_admin_access が true で、次の認可スコープが使用されている場合に、管理者権限が付与されます。
      • https://www.googleapis.com/auth/chat.admin.spaces

アプリ認証には次の制限があります。

  • space.predefined_permission_settings または space.permission_settings を更新するには、アプリがスペースの作成者である必要があります。
  • アプリ認証では space.access_settings.audience の更新はサポートされていません。
認可スコープ

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

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

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

rpc UpdateSpaceNotificationSetting(UpdateSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

スペースの通知設定を更新します。例については、呼び出し元のスペースの通知設定を更新するをご覧ください。

認可スコープを使用したユーザー認証が必要です。

  • https://www.googleapis.com/auth/chat.users.spacesettings
認可スコープ

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

  • https://www.googleapis.com/auth/chat.users.spacesettings

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

rpc UpdateSpaceReadState(UpdateSpaceReadStateRequest) returns (SpaceReadState)

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

認可スコープを使用したユーザー認証が必要です。

  • https://www.googleapis.com/auth/chat.users.readstate
認可スコープ

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

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

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

AccessoryWidget

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

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

ButtonList

ボタンのリスト。

ActionResponse

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

フィールド
type

ResponseType

入力専用。Chat 用アプリのレスポンスのタイプ。
url

string

入力専用。ユーザーが認証または構成を行うための URL。（REQUEST_CONFIG レスポンス タイプの場合のみ）。
dialog_action

DialogAction

入力専用。ダイアログに関連するインタラクション イベントへのレスポンス。ResponseType.Dialog を指定する必要があります。
updated_widget

UpdatedWidget

入力専用。更新されたウィジェットのレスポンス。

ResponseType

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

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

SelectionItems

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

フィールド
items[]

SelectionItem

SelectionItem オブジェクトの配列。

UpdatedWidget

selectionInput ウィジェットの場合、複数選択メニューの予測入力候補を返します。

フィールド
widget

string

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

SelectionItems

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

ActionStatus

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

フィールド
status_code

Code

ステータス コード。
user_facing_message

string

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

メモ

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

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

Hello @FooBot how are you!"

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

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

AnnotationType

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

int32

このアノテーションに対応するプレーン テキスト メッセージ本文のサブ文字列の長さ。存在しない場合、長さが 0 であることを示します。
start_index

int32

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

UserMentionMetadata

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

SlashCommandMetadata

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

CustomEmojiMetadata

カスタム絵文字のメタデータ。

AnnotationType

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

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

AppCommandMetadata

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

フィールド
app_command_id

int32

Chat API 構成で指定されたコマンドの ID。
app_command_type

AppCommandType

Chat 用アプリのコマンドのタイプ。

AppCommandType

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

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

AttachedGif

URL で指定された GIF 画像。

フィールド
uri

string

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

添付ファイル

Google Chat の添付ファイル。

フィールド
name

string

ID。添付ファイルのリソース名。

形式: spaces/{space}/messages/{message}/attachments/{attachment}。
content_name

string

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

string

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

string

出力専用。添付ファイルをユーザーにプレビューするために使用するサムネイル URL。チャットアプリはこの URL を使用して添付ファイルのコンテンツをダウンロードしないでください。
download_uri

string

出力専用。人間が添付ファイルをダウンロードできるようにするために使用する必要があるダウンロード URL。チャットアプリはこの URL を使用して添付ファイルのコンテンツをダウンロードしないでください。
source

Source

出力専用。添付ファイルのソース。
共用体フィールド data_ref。添付ファイルへのデータ参照。data_ref は次のいずれかになります。
attachment_data_ref

AttachmentDataRef

省略可。添付ファイル データへの参照。このフィールドは、添付ファイル付きのメッセージを作成または更新する場合、またはメディア API を使用して添付ファイル データをダウンロードする場合に使用されます。
drive_data_ref

DriveDataRef

出力専用。Google ドライブの添付ファイルへの参照。このフィールドは Google Drive API で使用されます。

ソース

添付ファイルのソース。

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

AttachmentDataRef

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

フィールド
resource_name

string

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

string

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

オーディエンス

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

詳しくは、ターゲット オーディエンスとターゲット オーディエンスにスペースを検出可能にするをご覧ください。

フィールド
name

string

スペースを見つけたり参加したりできる対象ユーザーのリソース名。詳しくは、対象グループにスペースを見つけてもらうをご覧ください。形式: audiences/{audience}

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

対象

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

フィールド
name

string

ID。ユーザーの空き状況のリソース名。

形式: users/{user}/availability

{user} は、People API または Admin SDK Directory API の Person の ID です。例: users/123456789

ユーザーのメールアドレスまたは me を、発信者を指すエイリアスとして使用することもできます。たとえば、users/user@example.com や users/me です。
state

State

出力専用。ユーザーの現在の空き状況。
custom_status

CustomStatus

省略可。ユーザーのカスタム ステータス。
共用体フィールド state_metadata。ユーザーのステータスに関連付けられた追加のメタデータ。state_metadata は次のいずれかになります。
do_not_disturb_metadata

DoNotDisturbMetadata

出力専用。ユーザーの状態が DO_NOT_DISTURB に設定されている場合のメタデータ。

州

ユーザーの現在の空き状況を表します。

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

CalendarEventLinkData

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

フィールド
calendar_id

string

リンクされたカレンダーのカレンダー ID。
event_id

string

リンクされたカレンダーの予定のイベント ID。

CardWithId

Google Chat のチャット メッセージのカード。

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

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

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

カードビルダーを開く

フィールド
card_id

string

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

Card

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

ChatSpaceLinkData

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

フィールド
space

string

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

形式: spaces/{space}
thread

string

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

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

string

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

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

引用

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

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

フィールド
id

string

必須。アプリ定義の ID。ASCII 文字と数字のみを含み、63 文字未満にする必要があります。
cited_sources[]

CitedSource

省略可。引用に関連するソースのリスト。引用元は引用ポップアップ カードに表示されます。

CitedSource

情報源への参照。

フィールド
title

string

必須。CitedSource の平文のタイトル。このフィールドは書式設定に対応していません。
uri

string

必須。この CitedSource で参照されるリソースを指す URI。
snippet

Snippet

省略可。ソースから直接取得した情報を含むスニペット。
footer

Footer

省略可。スニペットとともにフッターの形式で表示する追加情報。

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

フィールド
text

string

省略可。フッターに表示するテキスト。

スニペット

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

フィールド
text

string

省略可。Chat でレンダリングされる可能性のある、コーパスから直接取得した短い平文の抜粋。マークダウン形式はサポートされていません。
image_preview

ElementsImage

省略可。引用を作成するときに入力として提供されるスニペットの画像プレビュー。

CompleteImportSpaceRequest

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

フィールド
name

string

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

形式: spaces/{space}

CompleteImportSpaceResponse

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

フィールド
space

Space

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

ContextualAddOnMarkup

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

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

カード

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

フィールド
header

CardHeader

カードのヘッダー。ヘッダーには通常、タイトルと画像が含まれます。
sections[]

Section

セクションは分割線で区切ります。
card_actions[]

CardAction

このカードのアクション。
name

string

カードの名前。

CardAction

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

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

フィールド
action_label

string

操作メニュー項目に表示されていたラベル。
on_click

OnClick

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

CardHeader

フィールド
title

string

タイトルを指定する必要があります。ヘッダーの高さは固定されています。タイトルとサブタイトルの両方が指定されている場合、それぞれ 1 行を占有します。タイトルのみが指定されている場合は、両方の行が使用されます。
subtitle

string

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

ImageStyle

画像のタイプ（正方形の枠線や円形の枠線など）。
image_url

string

カードのヘッダーにある画像の URL。

ImageStyle

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

セクション

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

フィールド
header

string

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

WidgetMarkup

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

CreateCustomEmojiRequest

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

フィールド
custom_emoji

CustomEmoji

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

CreateMembershipRequest

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

フィールド
parent

string

必須。メンバーシップを作成する 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 の person の id、または Directory API のユーザーの id にすることもできます。たとえば、user@example.com の People API の人物プロファイル ID が 123456789 の場合、membership.member.name を users/user@example.com または users/123456789 に設定することで、ユーザーをスペースに追加できます。

スペースを所有する Workspace 組織外のユーザーを招待するには、ユーザー認証が必要です。

Chat 用アプリがメンバーシップ関係を自身のために作成する場合は、ユーザーとして認証し、chat.memberships.app スコープを使用し、user.type を BOT に設定し、user.name を users/app に設定する必要があります。
use_admin_access

bool

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

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

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

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

CreateMessageNotificationOptions

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

フィールド
notification_type

NotificationType

メッセージの通知タイプ。

NotificationType

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

列挙型
NOTIFICATION_TYPE_NONE デフォルトの動作。通知の動作は、人間が Chat UI を使用してメッセージを送信する場合と同様です。人間の送信者には通知が送信されません。
NOTIFICATION_TYPE_FORCE_NOTIFY

受信者に強制的に通知します。これにより、ユーザーのスペースの通知設定と Chat のサイレント モードの設定がバイパスされます。このオプションでは、デバイスレベルのサイレント モード設定はバイパスされません。

アプリの認証が必要です。
NOTIFICATION_TYPE_SILENT

受信者に通知せず、メールを未読としてマークしません。これは、ユーザーが会話をミュートしたり、チャットのサイレント モードを有効にしたりした場合と同様の動作になります。

アプリの認証が必要です。

CreateMessagePinRequest

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

フィールド
parent

string

必須。メッセージのピンを作成する親スペース。形式: spaces/{space}
message_pin

MessagePin

必須。作成する MessagePin。

CreateMessageRequest

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

フィールド
parent

string

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

形式: spaces/{space}
message

Message

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

string

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

string

省略可。このリクエストの一意の ID。ランダムな UUID をおすすめします。リクエスト ID を指定すると、リクエストがべき等になり、同じリクエスト ID を持つ複数の同一リクエストが 1 つのメッセージの作成のみにつながります。同じリクエスト ID を持つ後続のリクエストは、リクエストされた詳細が現在の状態と異なる場合でも、既存のメッセージを返し、メッセージを更新しません。

このフィールドを効果的に使用するには:

  • 後続のリクエストが元のリクエストと同じで、同じ認証情報を使用していることを確認します。
  • 指定されたリクエスト ID でメッセージがすでに作成されている場合、リクエストはそのメッセージを返します。返されるメッセージは完全に設定されていない場合があります。API は、リクエスト内のメッセージをシステム割り当てのリソース名でエコーバックします。メッセージの最新のメタデータを取得するには、GetMessage を呼び出します。
  • 別の認証済みユーザーで既存のリクエスト ID を再利用すると、エラーが発生します。
message_reply_option

MessageReplyOption

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

ユーザー インタラクションに応答する場合、このフィールドは無視されます。スレッド内のやり取りの場合、返信は同じスレッドに作成されます。それ以外の場合は、返信は新しいスレッドとして作成されます。
message_id

string

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

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

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

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

CreateMessageNotificationOptions

省略可。メッセージが投稿されたときの通知の動作を制御します。詳しくは、通知を強制的に表示する、またはサイレント メッセージを送信するをご覧ください。

MessageReplyOption

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

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

CreateReactionRequest

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

フィールド
parent

string

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

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

Reaction

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

CreateSectionRequest

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

フィールド
parent

string

必須。セクションが作成される親リソース名。

形式: users/{user}
section

Section

必須。作成するセクション。

CreateSpaceRequest

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

フィールド
space

Space

必須。displayName フィールドと spaceType フィールドに値を設定する必要があります。SpaceType.SPACE と SpaceType.GROUP_CHAT のみがサポートされています。SpaceType.GROUP_CHAT は、importMode が true に設定されている場合にのみ使用できます。

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

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

string

省略可。このリクエストの一意の ID。ランダムな UUID をおすすめします。リクエスト ID を指定すると、リクエストがべき等になり、同じリクエスト ID を持つ複数の同一リクエストが 1 つのスペースの作成のみにつながります。リクエスト ID が同じ後続のリクエストでは、リクエストされた詳細が現在の状態と異なる場合でも、既存のスペースが返され、スペースは更新されません。

このフィールドを効果的に使用するには:

  • 後続のリクエストが元のリクエストと同じで、同じ認証情報を使用していることを確認します。
  • 指定されたリクエスト ID でスペースがすでに作成されている場合、リクエストはそのスペースを返します。返されるスペースは完全に設定されていない場合があります。API は、リクエスト内のスペースを、システム割り当てのリソース名が設定された状態でエコーします。スペースの最新のメタデータを取得するには、GetSpace を呼び出します。
  • 別の認証済みユーザーで既存のリクエスト ID を再利用すると、エラーが発生します。

CustomEmoji

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

フィールド
name

string

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

形式: customEmojis/{customEmoji}
uid

string

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

string

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

カスタム絵文字の作成時に必須。それ以外の場合は出力専用。

絵文字の名前はコロンで始まり、コロンで終わる必要があります。また、小文字で、英数字、ハイフン、アンダースコアのみを使用できます。なお、ハイフンとアンダースコアは単語を区切る目的にのみ使用してください。これらを連続して使用することはできません。

例: :valid-emoji-name:
temporary_image_uri

string

出力専用。カスタム絵文字の一時的な画像 URL。少なくとも 10 分間有効です。カスタム絵文字の作成時に、レスポンスにこの値は入力されません。
payload

CustomEmojiPayload

省略可。入力専用。ペイロード データ。カスタム絵文字の作成時に必須です。

CustomEmojiPayload

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

フィールド
file_content

bytes

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

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

string

必須。入力専用。画像ファイル名。

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

CustomEmojiMetadata

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

フィールド
custom_emoji

CustomEmoji

カスタム絵文字。

CustomStatus

Google Chat でのユーザーのカスタム ステータスを表します。これには、ユーザーが設定した短いテキスト メッセージと、空き状況に関するコンテキストをより詳しく伝えるための絵文字（省略可）が含まれます。

フィールド
text

string

必須。カスタム ステータスのテキスト。これは最大長が 64 の文字列になります。
emoji

Emoji

必須。カスタム ステータスの絵文字。Unicode 絵文字のみがサポートされています。カスタム絵文字は対象外です。
共用体フィールド expiration。カスタム ステータスの有効期限。絶対タイムスタンプまたは存続期間として指定できます。expiration は次のいずれかになります。
expire_time

Timestamp

カスタム ステータスの有効期限のタイムスタンプ。
ttl

Duration

入力専用。カスタム ステータスの有効期限が切れるまでの存続期間。

DeleteCustomEmojiRequest

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

フィールド
name

string

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

形式: customEmojis/{customEmoji}

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

DeleteMembershipRequest

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

フィールド
name

string

必須。削除するメンバーシップのリソース名。チャットアプリは、人間のユーザーまたは自身のメンバーシップを削除できます。Chat 用アプリは、他のアプリのメンバーシップを削除できません。

ユーザー メンバーシップを削除する場合は、ユーザー認証の chat.memberships スコープ、またはアプリ認証の chat.memberships.app スコープと 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 スコープが必要です。

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

DeleteMessagePinRequest

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

フィールド
name

string

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

DeleteMessageRequest

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

フィールド
name

string

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

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

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

bool

省略可。true の場合、メッセージを削除すると、そのスレッドの返信も削除されます。false の場合、メッセージにスレッド化された返信があると、削除は失敗します。

ユーザーとして認証する場合にのみ適用されます。Chat 用アプリとして認証する場合は無効です。

DeleteReactionRequest

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

フィールド
name

string

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

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

DeleteSectionRequest

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

フィールド
name

string

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

形式: users/{user}/sections/{section}

DeleteSpaceRequest

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

フィールド
name

string

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

形式: spaces/{space}
use_admin_access

bool

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

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

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

DeletionMetadata

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

フィールド
deletion_type

DeletionType

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

DeletionType

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

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

ダイアログ

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

フィールド
body

Card

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

DialogAction

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

フィールド
action_status

ActionStatus

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

Dialog

入力専用。リクエストの Dialog。

DoNotDisturbMetadata

DO_NOT_DISTURB の可用性状態に関連付けられたメタデータ。状態の有効期限が切れる日時を指定します。

フィールド
expiration_time

Timestamp

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

DriveDataRef

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

フィールド
drive_file_id

string

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

DriveLinkData

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

フィールド
drive_data_ref

DriveDataRef

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

string

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

要素

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

フィールド
cited_sources[]

CitedSource

メッセージの下にフッターリンクとして表示されるソースのリスト。これらはインラインで参照されません。インライン参照には citations を使用します。
citations[]

Citation

メッセージ テキスト内で参照されている（<chat-citation> タグ経由）インライン引用のリスト。インタラクティブなホバーカードとしてレンダリングされます。

ElementsImage

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

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

string

必須。画像の一般公開 URI。

絵文字

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

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

string

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

CustomEmoji

カスタム絵文字。

EmojiReactionSummary

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

フィールド
emoji

Emoji

出力専用。リアクションに関連付けられている絵文字。
reaction_count

int32

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

FindDirectMessageRequest

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

フィールド
name

string

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

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

FindGroupChatsRequest

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

フィールド
users[]

string

省略可。通話中のユーザーとのグループ チャットに参加しているすべてのユーザーのリソース名。Chat 用アプリはリクエストに含めることができません。

1 つのリクエストで指定できるユーザーの最大数は 49 です。

形式: users/{user}。ここで、{user} は People API の person の id、または Directory API の user の id のいずれかです。たとえば、通話中のユーザーと他の 2 人のユーザー（People API プロファイル ID が 123456789 と 987654321）を含むすべてのグループ チャットを検索するには、users/123456789 と users/987654321 を使用します。メールアドレスを {user} のエイリアスとして使用することもできます。たとえば、users/example@gmail.com（example@gmail.com は Google Chat ユーザーのメールアドレス）。
page_size

int32

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

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

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

負の値は INVALID_ARGUMENT エラーを返します。
page_token

string

省略可。グループ チャットを検索する前回の呼び出しから受け取ったページトークン。後続のページを取得するには、このパラメータを指定します。

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

SpaceView

リクエストされたスペースビューのタイプ。設定しない場合、デフォルトは SPACE_VIEW_RESOURCE_NAME_ONLY です。SPACE_VIEW_EXPANDED を指定するリクエストには、スペースデータの読み取りを許可するスコープ（https://www.googleapis.com/auth/chat.spaces や https://www.googleapis.com/auth/chat.spaces.readonly など）を含める必要があります。

FindGroupChatsResponse

通話中のユーザーとリクエストされたユーザーのみを含むグループ チャット スペースを含むレスポンス。

フィールド
spaces[]

Space

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

string

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

ForwardedMetadata

メッセージが転送されたソース スペースに関するメタデータ。

フィールド
space

string

出力専用。ソース スペースのリソース名。形式: spaces/{space}
space_display_name

string

出力専用。転送時の送信元スペースまたは DM の表示名。SPACE の場合、これはスペース名です。DIRECT_MESSAGE の場合は、他の参加者の名前（「ユーザー A」など）です。GROUP_CHAT の場合、これはメンバーのファースト ネームに基づいて生成された名前で、クリエイターを含めて 5 人までに制限されます（例: 「ユーザー A、ユーザー B」）。

GetAttachmentRequest

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

フィールド
name

string

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

GetAvailabilityRequest

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

フィールド
name

string

必須。取得する可用性のリソース名。

形式: users/{user}/availability

{user} は、People API または Admin SDK Directory API の Person の ID です。例: users/123456789

ユーザーのメールアドレスまたは me を、発信者を指すエイリアスとして使用することもできます。たとえば、users/user@example.com や users/me です。

GetCustomEmojiRequest

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

フィールド
name

string

必須。カスタム絵文字のリソース名。

形式: customEmojis/{customEmoji}

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

GetMembershipRequest

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

フィールド
name

string

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

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

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

ユーザーのメールアドレスを {member} のエイリアスとして使用できます。たとえば、spaces/{space}/members/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 を設定している場合は、clientAssignedMessageId フィールドの値を {message} に使用できます。詳しくは、メッセージに名前を付けるをご覧ください。

GetSpaceEventRequest

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

フィールド
name

string

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

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

GetSpaceNotificationSettingRequest

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

フィールド
name

string

必須。形式: users/{user}/spaces/{space}/spaceNotificationSetting

  • users/me/spaces/{space}/spaceNotificationSetting、または
  • users/user@example.com/spaces/{space}/spaceNotificationSetting、または
  • users/123456789/spaces/{space}/spaceNotificationSetting。注: パスで許可されるのは、呼び出し元のユーザー ID またはメールアドレスのみです。

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

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

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

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

前のカスタム絵文字一覧呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

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

ListMessagePinsRequest

リスティング メッセージのピン留めに関するリクエスト メッセージ。

フィールド
parent

string

必須。固定アイテムのコレクションを所有する親スペース。形式: spaces/{space}
page_size

int32

省略可。返されるメッセージのピン留めの最大数。サービスが返すメッセージの数は、この値よりも少ないことがあります。最大値は 100 です。100 を超える値を使用すると、自動的に 100 に変更されます。指定されていない場合は、最大で 100 件のメッセージのピン留めが返されます。負の値は INVALID_ARGUMENT エラーを返します。
page_token

string

省略可。前回の list メッセージのピン留め呼び出しから受け取ったページトークン。後続のページを取得するには、このパラメータを指定します。

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

ListMessagePinsResponse

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

フィールド
message_pins[]

MessagePin

指定されたスペースの固定メッセージ。
next_page_token

string

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

ListMessagesRequest

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

フィールド
parent

string

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

形式: spaces/{space}
page_size

int32

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

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

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

負の値は INVALID_ARGUMENT エラーを返します。
page_token

string

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

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

string

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

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

作成日でメッセージをフィルタするには、RFC-3339 形式のタイムスタンプと二重引用符を使用して create_time を指定します。例: "2023-04-21T11:30:00-04:00"。大なり演算子 > を使用すると、タイムスタンプより後に作成されたメッセージを一覧表示できます。また、小なり演算子 < を使用すると、タイムスタンプより前に作成されたメッセージを一覧表示できます。時間間隔内のメッセージをフィルタするには、2 つのタイムスタンプの間に AND 演算子を使用します。

スレッドでフィルタするには、spaces/{space}/threads/{thread} 形式で thread.name を指定します。クエリごとに指定できる thread.name は 1 つだけです。

スレッドと日付の両方でフィルタするには、クエリで AND 演算子を使用します。

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

create_time > "2012-04-21T11:30:00-04:00"

create_time > "2012-04-21T11:30:00-04:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

create_time > "2012-04-21T11:30:00+00:00" AND

create_time < "2013-01-01T00:00:00+00:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

thread.name = spaces/AAAAAAAAAAA/threads/123

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

string

省略可。メッセージのリストの順序。並べ替えオペレーションで並べ替える値を指定します。有効な順序付けオペレーションの値は次のとおりです。

  • 昇順の場合は ASC。

  • 降順の場合は DESC。

デフォルトの順序は create_time ASC です。
show_deleted

bool

省略可。削除されたメッセージを含めるかどうか。削除されたメッセージには、削除された日時と削除に関するメタデータが含まれますが、メッセージの内容は利用できません。

ListMessagesResponse

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

フィールド
messages[]

Message

メッセージのリスト。
next_page_token

string

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

ListReactionsRequest

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

フィールド
parent

string

必須。ユーザーがリアクションしたメッセージ。

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

int32

省略可。返されるリアクションの最大数。サービスが返すリアクションの数は、この値よりも少ないことがあります。指定しない場合、デフォルト値は 25 です。最大値は 200 です。200 を超える値は 200 に変更されます。
page_token

string

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

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

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

string

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

リアクションは、絵文字（emoji.unicode または emoji.custom_emoji.uid）とユーザー（user.name）でフィルタできます。

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

絵文字とユーザーでリアクションをフィルタするには、emoji.unicode = "🙂" AND user.name = "users/AAAAAA" などの AND 演算子を使用します。

クエリで AND と OR の両方を使用する場合は、括弧でグループ化します。

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

user.name = "users/{user}"
emoji.unicode = "🙂"
emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR emoji.unicode = "👍"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" AND user.name = "users/{user}"
(emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}")
AND user.name = "users/{user}"

次のクエリは無効です。

emoji.unicode = "🙂" AND emoji.unicode = "👍"
emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" OR
user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
AND user.name = "users/{user}"

無効なクエリは INVALID_ARGUMENT エラーで拒否されます。

ListReactionsResponse

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

フィールド
reactions[]

Reaction

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

string

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

ListSectionItemsRequest

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

フィールド
parent

string

必須。親。このセクション アイテムのコレクションを所有するセクション リソース名です。呼び出しユーザーのリスト セクション アイテムのみをサポートします。

スペースでフィルタリングする場合は、ワイルドカード - を使用してすべてのセクションを検索します。例: users/{user}/sections/-

形式: users/{user}/sections/{section}
page_size

int32

省略可。返されるセクション アイテムの最大数。サービスから返される数は、この値より少ない場合があります。

指定されていない場合、最大で 10 個のセクション アイテムが返されます。

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

負の値は INVALID_ARGUMENT エラーを返します。
page_token

string

省略可。前のセクション項目のリスト呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

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

string

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

現在、スペースによるフィルタリングのみがサポートされています。

例: space = spaces/{space}

無効なクエリは INVALID_ARGUMENT エラーで拒否されます。

ListSectionItemsResponse

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

フィールド
section_items[]

SectionItem

指定されたセクションのセクション アイテム。
next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

ListSectionsRequest

リスティング セクションのリクエスト メッセージ。

フィールド
parent

string

必須。このセクションのコレクションを所有するユーザー リソース名の親。呼び出しユーザーのリスティング セクションのみをサポートします。呼び出し元ユーザーを参照するには、次のいずれかを設定します。

  • me エイリアス。例: users/me

  • Workspace のメールアドレス。例: users/user@example.com

  • ユーザー ID。例: users/123456789

形式: users/{user}
page_size

int32

省略可。返されるセクションの最大数。サービスから返される数は、この値より少ない場合があります。

指定されていない場合は、最大で 10 個のセクションが返されます。

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

負の値は INVALID_ARGUMENT エラーを返します。
page_token

string

省略可。前のセクションの一覧呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

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

ListSectionsResponse

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

フィールド
sections[]

Section

指定したユーザーのセクション。
next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

ListSpaceEventsRequest

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

フィールド
parent

string

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

形式: spaces/{space}。
page_size

int32

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

負の値は INVALID_ARGUMENT エラーを返します。
page_token

string

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

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

string

必須。クエリフィルタ。

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

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

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

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

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

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

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

次のクエリは無効です。

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

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

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

ListSpaceEventsResponse

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

フィールド
space_events[]

SpaceEvent

結果は時系列順（最も古いイベントが最初）で返されます。注: permissionSettings フィールドは、リスト リクエストの Space オブジェクトでは返されません。
next_page_token

string

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

ListSpacesRequest

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

フィールド
page_size

int32

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

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

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

負の値は INVALID_ARGUMENT エラーを返します。
page_token

string

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

ページ分割を行う場合、フィルタ値はページトークンを提供した呼び出しと一致している必要があります。別の値を渡すと、予期しない結果が生じる可能性があります。
filter

string

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

スペースはスペースタイプ（space_type）でフィルタできます。

スペースタイプでフィルタするには、SPACE や GROUP_CHAT などの有効な列挙型値を指定する必要があります（space_type は SPACE_TYPE_UNSPECIFIED にできません）。複数のスペースタイプをクエリするには、OR 演算子を使用します。

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

space_type = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

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

ListSpacesResponse

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

フィールド
spaces[]

Space

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

string

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

MarkAsActiveRequest

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

フィールド
name

string

必須。有効としてマークする可用性のリソース名。形式: users/{user}/availability

{user} は、People API または Admin SDK Directory API の Person の ID です。例: users/123456789

ユーザーのメールアドレスまたは me を、発信者を指すエイリアスとして使用することもできます。たとえば、users/user@example.com や users/me です。
共用体フィールド expiration。ACTIVE の登録可否ステータスの有効期限。期限が切れると、ユーザーは不在としてマークされます。有効期限が指定されていない場合、ACTIVE 状態は現在の時刻から 30 分後に期限切れになります。expiration は次のいずれかになります。
expire_time

Timestamp

ACTIVE 状態が期限切れになる絶対タイムスタンプ。
ttl

Duration

現在から ACTIVE 状態が期限切れになるまでの期間。短い TTL を使用すると、この短い期間の後にユーザーの状態をアクティビティに基づいて効果的にリセットできます。

MarkAsAwayRequest

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

フィールド
name

string

必須。不在としてマークする空き状況のリソース名。形式: users/{user}/availability

{user} は、People API または Admin SDK Directory API の Person の ID です。例: users/123456789

ユーザーのメールアドレスまたは me を、発信者を指すエイリアスとして使用することもできます。たとえば、users/user@example.com や users/me です。

MarkAsDoNotDisturbRequest

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

フィールド
name

string

必須。サイレント モードに設定する空き時間のリソース名。形式: users/{user}/availability

{user} は、People API または Admin SDK Directory API の Person の ID です。例: users/123456789

ユーザーのメールアドレスまたは me を、発信者を指すエイリアスとして使用することもできます。たとえば、users/user@example.com や users/me です。
共用体フィールド expiration。必須。おやすみモードの有効期限。期限が切れると、ユーザーは不在としてマークされます。現在から 1 年先まで設定できます。expiration は次のいずれかになります。
expire_time

Timestamp

サイレント モードの有効期限が切れる絶対タイムスタンプ。
ttl

Duration

現在時刻からサイレント モードの状態が終了するまでの時間。

MarkupSyntax

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

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

MatchedUrl

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

フィールド
url

string

出力専用。一致した URL。

MeetSpaceLinkData

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

フィールド
meeting_code

string

リンクされた Meet スペースの会議コード。
type

Type

Meet スペースのタイプを示します。
huddle_status

HuddleStatus

省略可。出力専用。Meet がハドルである場合、ハドルのステータスを示します。それ以外の場合は設定されません。

HuddleStatus

ハドルのステータス

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

タイプ

Meet スペースのタイプ。

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

メンバーシップ

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

フィールド
name

string

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

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

MembershipState

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

MembershipRole

省略可。Chat スペース内のユーザーのロール。スペースで許可されるアクションを決定します。

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

Timestamp

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

Timestamp

省略可。変更不可。メンバーシップの削除時間（メンバーがスペースから退出したときや削除されたときなど）。このフィールドは、インポート モードのスペースで過去のメンバーシップをインポートする場合を除き、出力専用です。
affiliation

Affiliation

出力専用。スペースを所有する Workspace 組織に対するユーザーの関係。一般ユーザー アカウントが所有するスペースでは、すべてのメンバーの所属が EXTERNAL になります。
共用体フィールド memberType。このメンバーシップに関連付けられているメンバー。今後、他のメンバー タイプがサポートされる可能性があります。memberType は次のいずれかになります。
member

User

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

Group

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

Google グループのメンバーシップの読み取りまたは変更には、ユーザー認証が必要です。

所属

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

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

MembershipRole

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

列挙型
MEMBERSHIP_ROLE_UNSPECIFIED デフォルト値。users の場合: スペースのメンバーではないが、招待できる。Google Groups の場合: 常にこのロールが割り当てられます（他の列挙値が今後使用される可能性があります）。
ROLE_MEMBER

スペースのメンバー。チャット UI では、このロールはメンバーと呼ばれます。

ユーザーは、スペースにメッセージを送信するなどの基本的な権限を持っています。管理者とオーナーは、スペースでメンバーに次の追加権限を付与できます。

  • メンバーを追加または削除します。
  • スペースの詳細を変更します。
  • 履歴をオンまたはオフにします。
  • @all を使用して、スペースのメンバー全員にメンションします。
  • スペースにインストールされている Chat 用アプリと Webhook を管理します。

ダイレクト メッセージと名前のないグループ会話では、全員にこの役割が割り当てられます。
ROLE_MANAGER

スペースのオーナー。チャット UI では、このロールはオーナーと呼ばれます。

ユーザーは、スペースを管理するためのスペース権限をすべて持っています。これには、次の権限が含まれます。

  • スペース内の他のメンバーのロールをメンバー、マネージャー、オーナーに変更する。
  • スペースを削除します。

SpaceType.SPACE（名前付きスペース）でのみサポートされています。

詳しくは、スペースのオーナーまたは管理者の役割についてをご覧ください。
ROLE_ASSISTANT_MANAGER

スペースの管理者。Chat UI では、このロールは「管理者」と呼ばれます。

ユーザーは ROLE_MEMBER のすべての基本権限を持ち、オーナーによって管理者権限のサブセットが付与されることがあります。デフォルトでは、マネージャーにはオーナーと同じ権限がありますが、以下の操作は行えません。

  • スペースを削除します。
  • 他のスペース メンバーをオーナーにする。
  • オーナーのロールを変更する。

デフォルトでは、管理者の権限には以下が含まれます（これらに限定されません）。

  • 他のメンバーをマネージャーにする。
  • スペースでメッセージを削除する。
  • スペースの権限を管理する。
  • スペースの設定で管理者が「メンバーを管理」権限を持っている場合、スペースへの参加リクエストの通知を受け取ります。
  • スペースを検索可能にします。

SpaceType.SPACE（名前付きスペース）でのみサポートされています。

詳しくは、スペースの設定を管理するをご覧ください。

MembershipState

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

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

MembershipBatchCreatedEventData

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

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

フィールド
memberships[]

MembershipCreatedEventData

新しいメンバーシップのリスト。

MembershipBatchDeletedEventData

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

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

フィールド
memberships[]

MembershipDeletedEventData

削除されたメンバーシップのリスト。

MembershipBatchUpdatedEventData

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

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

フィールド
memberships[]

MembershipUpdatedEventData

更新されたメンバーシップのリスト。

MembershipCreatedEventData

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

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

フィールド
membership

Membership

新しいメンバーシップ。

MembershipDeletedEventData

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

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

フィールド
membership

Membership

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

MembershipUpdatedEventData

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

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

フィールド
membership

Membership

更新されたメンバーシップ。

メッセージ

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

フィールド
name

string

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

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

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

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

User

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

Timestamp

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

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

Timestamp

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

Timestamp

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

string

省略可。メッセージのプレーン テキストの本文。画像、動画、ウェブページへの最初のリンクは、プレビュー チップを生成します。Google Chat ユーザーまたはスペース内の全員を@メンションすることもできます。

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

string

出力専用。フォーマットを伝えるためのマークアップが追加されたメッセージ text が含まれます。このフィールドには、UI に表示されるすべての書式設定が反映されない場合がありますが、次のものが含まれます。

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

  • ユーザーメンション: <users/{user}> 形式を使用します。

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

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

  • アスタリスク（*）を使用して箇条書きの項目を作成します（例: * item）。

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

Card

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

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

CardWithId

省略可。カードの配列。

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

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

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

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

Annotation

出力専用。アノテーションは、メッセージのプレーン テキストの本文、または start_index と length が 0 の Google ドキュメントやスプレッドシートなどの Google Workspace リソースにリンクするチップに関連付けることができます。
thread

Thread

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

Space

出力専用。Chat 用アプリがユーザーとして認証される場合、出力には space name のみが入力されます。
fallback_text

string

省略可。メッセージのカードのプレーン テキストの説明。実際のカードを表示できない場合（モバイル通知など）に使用されます。
action_response

ActionResponse

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

string

出力専用。すべての Chat 用アプリのメンションが削除されたメッセージの書式なしテキストの本文。
slash_command

SlashCommand

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

Attachment

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

MatchedUrl

出力専用。リンク プレビュー パターンと一致する Chat メッセージの text フィールド内の URL。詳しくは、リンクのプレビューをご覧ください。
thread_reply

bool

出力専用。true の場合、メッセージは返信スレッドの返信です。false の場合、メッセージはスペースのトップレベルの会話に、スレッドの最初のメッセージまたはスレッド形式の返信がないメッセージとして表示されます。

スペースがスレッドでの返信をサポートしていない場合、このフィールドは常に false になります。
silent

bool

出力専用。サイレント メッセージかどうか。サイレント メッセージとは、Chat が受信者へのプッシュ通知を抑制するメッセージです。
client_assigned_message_id

string

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

EmojiReactionSummary

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

User

省略可。変更不可。メッセージ作成の入力。それ以外の場合は出力のみ。メッセージを閲覧できるユーザー。このフィールドを設定すると、メッセージは非公開になり、指定されたユーザーと Chat 用アプリにのみ表示されます。このフィールドをリクエストに含めるには、アプリ認証を使用して Chat API を呼び出し、次の項目を省略する必要があります。

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

DeletionMetadata

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

QuotedMessageMetadata

省略可。別のメッセージが引用しているメッセージに関する情報。

メッセージを作成する際に、同じスレッド内のメッセージを引用したり、ルート メッセージを引用して新しいルート メッセージを作成したりできます。ただし、別のスレッドのメッセージの返信を引用することはできません。

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

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

AttachedGif

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

AccessoryWidget

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

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

Elements

省略可。要素は、メッセージの作成時に提供される追加のコンポーネントで、メッセージ テキストの特定の部分に関連付けられている場合とそうでない場合があります。これらはアノテーションとは異なります。アノテーションは出力専用で、メッセージ フラグメントまたはメッセージ テキスト全体に関連付けられた補足情報を提供します。
markup_syntax

MarkupSyntax

省略可。サーバーがメッセージの text フィールドのコンテンツを解釈する方法を指定します。

MessageBatchCreatedEventData

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

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

フィールド
messages[]

MessageCreatedEventData

新着メッセージの一覧。

MessageBatchDeletedEventData

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

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

フィールド
messages[]

MessageDeletedEventData

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

MessageBatchUpdatedEventData

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

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

フィールド
messages[]

MessageUpdatedEventData

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

MessageCreatedEventData

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

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

フィールド
message

Message

新しいメッセージ。

MessageDeletedEventData

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

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

フィールド
message

Message

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

MessagePin

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

フィールド
name

string

ID。メッセージのピン留めリソース名。形式: spaces/{space}/messagePins/{message_pin} リソース ID コンポーネントは、メッセージのリソース ID コンポーネントと一致します。たとえば、spaces/AAA/messages/bbb.ccc を含むメッセージは、リソース名 spaces/AAA/messagePins/bbb.ccc を含むメッセージピンに対応します。
message

string

必須。変更不可。固定されているメッセージのリソース名。形式: spaces/{space}/messages/{message}

MessageUpdatedEventData

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

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

フィールド
message

Message

更新されたメッセージ。

MoveSectionItemRequest

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

フィールド
name

string

必須。移動するセクション アイテムのリソース名。

形式: users/{user}/sections/{section}/items/{item}
target_section

string

必須。セクション アイテムの移動先のセクションのリソース名。

形式: users/{user}/sections/{section}

MoveSectionItemResponse

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

フィールド
section_item

SectionItem

更新されたセクション アイテム。

PositionSectionRequest

セクションの位置を設定するリクエスト メッセージ。

フィールド
name

string

必須。配置するセクションのリソース名。

形式: users/{user}/sections/{section}
共用体フィールド position。必須。セクションの新しい位置。position は次のいずれかになります。
sort_order

int32

省略可。セクションのリスト内のセクションの絶対位置。位置は 0 より大きい値にする必要があります。位置がセクションの数より大きい場合、セクションはリストの末尾に追加されます。このオペレーションは、指定された位置にセクションを挿入し、その位置にある元のセクションとそれより下のセクションを次の位置に移動します。
relative_position

Position

省略可。セクションのリスト内でのセクションの相対位置。

ポジション

セクションの位置。

列挙型
POSITION_UNSPECIFIED 位置が指定されていません。
START セクション リストの先頭。
END セクションのリストの末尾。

PositionSectionResponse

セクションの位置決めに対するレスポンス メッセージ。

フィールド
section

Section

更新されたセクション。

QuotedMessageMetadata

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

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

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

フィールド
name

string

必須。引用されたメッセージのリソース名。

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

Timestamp

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

メッセージが編集された場合は、このフィールド last_update_time を使用します。メッセージが編集されていない場合は、create_time を使用します。

last_update_time が引用メッセージの最新バージョンと一致しない場合、リクエストは失敗します。
quote_type

QuoteType

省略可。見積もりタイプを指定します。設定されていない場合、下位互換性のためにメッセージの読み取り/書き込みパスの REPLY がデフォルトになります。
quoted_message_snapshot

QuotedMessageSnapshot

出力専用。引用されたメッセージの内容のスナップショット。
forwarded_metadata

ForwardedMetadata

出力専用。引用されたメッセージのソース スペースに関するメタデータ。FORWARD 見積もりタイプの場合のみ入力されます。

QuoteType

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

列挙型
QUOTE_TYPE_UNSPECIFIED 予約済み。この値は使用されません。
REPLY

quote_type が REPLY の場合、次の操作を行うことができます。

  • スレッドで返信する場合は、そのスレッド内の別のメッセージを引用できます。

  • ルート メッセージを作成する場合は、そのスペース内の別のルート メッセージを引用できます。
FORWARD

quote_type が FORWARD の場合、次のものを引用できます。

  • 別のスペースからのメッセージ。

  • 同じスペース内の別のスレッドからのメッセージへの返信。

QuotedMessageSnapshot

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

フィールド
sender

string

出力専用。引用されたメッセージの作成者の名前。REPLY と FORWARD の両方の引用タイプで入力されます。
text

string

出力専用。引用されたメッセージのテキスト コンテンツのスナップショット。
formatted_text

string

出力専用。ハイパーリンク、カスタム絵文字、マークアップなどのリッチ フォーマットをサポートするためにマークアップが追加された引用メッセージ text が含まれます。FORWARD 引用タイプの場合にのみ入力されます。
annotations[]

Annotation

出力専用。引用されたメッセージの本文から解析されたアノテーション。FORWARD 見積もりタイプの場合のみ入力されます。
attachments[]

Attachment

出力専用。引用されたメッセージに含まれていた添付ファイル。これらは、引用されたメッセージの添付ファイルのメタデータのコピーです。FORWARD 見積もりタイプの場合のみ入力されます。

リアクション

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

フィールド
name

string

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

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

User

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

Emoji

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

ReactionBatchCreatedEventData

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

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

フィールド
reactions[]

ReactionCreatedEventData

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

ReactionBatchDeletedEventData

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

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

フィールド
reactions[]

ReactionDeletedEventData

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

ReactionCreatedEventData

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

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

フィールド
reaction

Reaction

新しいリアクション。

ReactionDeletedEventData

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

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

フィールド
reaction

Reaction

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

ReplaceMessageCardsRequest

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

フィールド
name

string

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

形式: spaces/{space}/messages/{message}
cards_v2[]

CardWithId

省略可。メッセージに含めるカードの配列。これらのカードは、メッセージの既存のカードと置き換わります。空の場合、メッセージに含まれる元のカードはクリアされます。

ReplaceMessageCardsResponse

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

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

RichLinkMetadata

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

フィールド
uri

string

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

RichLinkType

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

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

SearchMessageResult

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

フィールド
message

Message

一致したメッセージ。
space_mute_setting

MuteSetting

メッセージが投稿されたスペースでの通話ユーザーのミュート設定。発信側アプリは、この情報を使用して、スペースがユーザーに対してミュートされているかどうかに応じてメッセージを処理する方法を決定できます。

リクエスト ビューが SEARCH_MESSAGES_VIEW_FULL で、呼び出し元の認証情報に次の認可スコープが含まれている場合にのみ返されます。

  • https://www.googleapis.com/auth/chat.users.spacesettings
read

bool

一致したメッセージが通話中のユーザーによって読まれたかどうかを示します。

リクエスト ビューが SEARCH_MESSAGES_VIEW_FULL で、呼び出し元の認証情報に次のいずれかの認可スコープが含まれている場合にのみ返されます。

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

SearchMessagesRequest

メッセージの検索のリクエスト メッセージ。

フィールド
parent

string

必須。検索範囲となるスペースのリソース名。

ユーザーがアクセスできるすべてのスペースを検索するには、このフィールドを spaces/- に設定します。parent に他の値を使用すると、INVALID_ARGUMENT エラーが発生します。

検索対象を 1 つ以上のスペースに限定するには、filter で space.name または space.display_name を使用します。
filter

string

必須。検索クエリ。

クエリでは、結果のフィルタに使用される 1 つ以上の検索キーワードを指定できます。

次のメッセージ フィールドを使用して結果をフィルタすることもできます。

  • create_time: RFC-3339 形式のタイムスタンプを受け入れます。サポートされている比較演算子は < と >= です。
  • sender.name: 送信者のリソース名（users/{user}）。= のみがサポートされています。このメールアドレスを {user} のエイリアスとして使用できます。たとえば、users/example@gmail.com などです。ここで、example@gmail.com は Google Chat ユーザーのメールアドレスです。
  • space.name: メッセージが投稿されるスペースのリソース名。（spaces/{space}）。= のみをサポートします。このフィルタが設定されていない場合、ユーザーがスペース メンバーとしてアクセスできるすべてのダイレクト メッセージとスペースで検索が実行されます。
  • space.display_name: 演算子 :（has）をサポートし、表示名が部分的に一致するスペースに基づいてフィルタします。結果は、一致度の高い上位 5 つのスペースに限定されます。たとえば、space.display_name:Project は、表示名に「Project」という単語が含まれている上位 5 つのスペース内のメッセージを検索します。
  • attachment: 添付ファイルの有無を確認する演算子 :*（has any）をサポートします。attachment:* が指定されている場合は、1 つ以上の添付ファイルがあるメッセージのみが返されます。
  • annotations.user_mentions.user.name: 言及されたユーザーのリソース名（users/{user}）。:（has）のみをサポートします。たとえば、annotations.user_mentions.user.name:"users/1234567890" は、指定されたユーザーへの言及を含むメッセージのみを返します。または、エイリアス me を使用して、呼び出し元ユーザーに言及しているメッセージをフィルタすることもできます（例: annotations.user_mentions.user.name:users/me）。メールアドレスを {user} のエイリアスとして使用することもできます（例: users/example@gmail.com）。

高度なフィルタリングでは、次の関数も使用できます。

  • has_link(): メッセージ テキストに 1 つ以上のハイパーリンクが含まれているメッセージのみを返します。
  • is_unread(): 呼び出し元のユーザーが既読にしたメッセージを除外します。

space.display_name フィルタを使用するには、呼び出し元の認証情報に次のいずれかの認可スコープが含まれている必要があります。

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

is_unread() フィルタを使用するには、呼び出し元の認証情報に次のいずれかの認可スコープが含まれている必要があります。

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

異なるフィールドでは、AND 演算子のみがサポートされています。有効な例は sender.name = "users/1234567890" AND is_unread() です。AND という単語は省略可能で、省略した場合は暗黙的に指定されたものとみなされます。たとえば、sender.name = "users/1234567890" is_unread() は有効で、前の例と同じです。OR は異なるフィールド間ではサポートされていないため、sender.name = "users/1234567890" OR is_unread() は無効な例です。

同じフィールド内:

  • create_time は AND のみをサポートし、create_time >= "2022-01-01T00:00:00+00:00" AND create_time < "2023-01-01T00:00:00+00:00" などの間隔を表すためにのみ使用できます。
  • sender.name は OR 演算子のみをサポートします（例: sender.name = "users/1234567890" OR sender.name = "users/0987654321"）。
  • space.name は OR 演算子のみをサポートします（例: space.name = "spaces/ABCDEFGH" OR space.name = "spaces/QWERTYUI"）。
  • space.display_name は AND 演算子と OR 演算子をサポートしますが、両方を組み合わせたものはサポートしません。たとえば、space.display_name:Project AND space.display_name:Tasks は、Project と Tasks の両方を含む表示名のスペースにあるメッセージを返します。一方、space.display_name:Project OR space.display_name:Tasks は、Project または Tasks のいずれか、または両方を含む表示名のスペースにあるメッセージを返します。
  • annotations.user_mentions.user.name は AND 演算子と OR 演算子をサポートしますが、両方を組み合わせたものはサポートしません。たとえば、annotations.user_mentions.user.name:"users/1234567890" AND annotations.user_mentions.user.name:"users/0987654321" は両方のユーザーに言及しているメッセージのみを返しますが、annotations.user_mentions.user.name:"users/1234567890" OR annotations.user_mentions.user.name:"users/0987654321" はどちらかのユーザーまたは両方のユーザーに言及しているメッセージを返します。

同じクエリで AND 演算子と OR 演算子を組み合わせる場合は、演算子の優先順位を明確にするためにかっこが必要です。例: (sender.name="users/me" OR sender.name="users/123456") AND is_unread()それ以外の場合、括弧は省略可能です。

次のクエリの例は有効です。

"Pending reports" AND create_time >= "2023-01-01T00:00:00Z"

sender.name = "users/example@gmail.com"

annotations.user_mentions.user.name:"users/0987654321"

attachment:* AND space.name = "spaces/ABCDEFGH"

tasks AND is_unread() AND sender.name = "users/1234567890"

"things to do" "urgent"

(sender.name = "users/1234567890")
AND (create_time < "2023-05-01T00:00:00Z")

tasks AND space.name = "spaces/ABCDEFGH" AND has_link()

"project one" is_unread()

space.display_name:Project tasks

クエリの最大長は 1,000 文字です。

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

int32

省略可。返される結果の最大件数です。サービスから返される数は、この値より少ない場合があります。

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

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

string

省略可。前のメッセージ検索呼び出しから受け取ったトークン。後続のページを取得するには、このパラメータを指定します。

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

string

省略可。結果リストの並べ替え順序。

並べ替えに使用できる属性は次のとおりです。

デフォルトの順序は create_time desc です。クエリ（create_time または relevance）ごとに 1 つの順序のみがサポートされます。降順（desc）のみがサポートされており、順序属性の後に指定する必要があります。
view

SearchMessagesView

省略可。返す検索結果ビューの種類を指定します。デフォルト値は SEARCH_MESSAGES_VIEW_BASIC です。

SearchMessagesView

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

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

SearchMessagesResponse

メッセージの検索に対するレスポンス メッセージ。

フィールド
results[]

SearchMessageResult

クエリに一致した検索結果のリスト。
next_page_token

string

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

SearchSpacesRequest

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

フィールド
use_admin_access

bool

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

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

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

int32

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

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

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

string

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

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

string

必須。検索クエリ。

useAdminAccess が true に設定されている場合、次のパラメータを使用して検索できます。

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

useAdminAccess が false に設定されている場合:

  • display_name
  • external_user_allowed
  • space_type

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

useAdminAccess が true に設定されている場合は customer が必要です。これは、スペースを取得する顧客を示すために使用されます。サポートされる値は customers/my_customer のみです。

display_name は HAS（:）演算子のみを受け入れます。照合するテキストは、まずトークンにトークン化され、各トークンはスペースの display_name 内の任意の場所で、大文字と小文字を区別せずに独立して接頭辞照合されます。たとえば、Fun Eve は Fun event または The evening was fun と一致しますが、notFun event または even とは一致しません。useAdminAccess が false に設定されている場合、意味のある結果を取得するには display_name が必要です。それ以外の場合、デフォルトの動作は空のレスポンスを返すことです。

external_user_allowed は、true または false のいずれかを受け入れます。

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

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

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

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

次のクエリの例は、useAdminAccess が true に設定されている場合に有効です。

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

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

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

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

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

次のクエリの例は、useAdminAccess が false に設定されている場合に有効です。

display_name:"Hello World" AND space_type = "SPACE"

(display_name:"Hello" OR display_name:"Fun") AND space_type = "SPACE"

(external_user_allowed = "true" AND space_type = "SPACE") // Returns an
empty response.

(external_user_allowed = "true" AND display_name:"Hello" AND space_type =
"SPACE")
order_by

string

省略可。スペースのリストの並べ替え方法。

並べ替えに使用できる属性は次のとおりです。

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

useAdminAccess が false の場合、順序付けでサポートされるのは create_time と relevance のみです。管理者以外の検索では、これらのフィールドで DESC のみがサポートされています。

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

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

  • 降順の場合は DESC。

サポートされている構文は、useAdminAccess が true に設定されている場合です。

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

useAdminAccess が false に設定されている場合:

SearchSpacesResponse

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

フィールド
spaces[]
(deprecated)

Space

非推奨: 代わりに、新しい results フィールドを使用してください。リクエストされたスペースのページ。このフィールドは、useAdminAccess が true に設定され、新しい results フィールドに置き換えられた場合にのみ入力されます。
next_page_token

string

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

int32

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

SearchSpaceResult

出力専用。クエリに一致した検索結果のリスト。

SearchSpaceResult

スペース検索の単一の結果アイテム。

フィールド
space

Space

出力専用。一致したスペース。

セクション

Google Chat のセクションを表します。セクションを使用すると、スペースを整理できます。セクションには次の 2 種類があります。

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

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

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

フィールド
name

string

ID。セクションのリソース名。

システム セクションの場合、セクション ID は定数文字列です。

  • DEFAULT_DIRECT_MESSAGES: users/{user}/sections/default-direct-messages
  • DEFAULT_SPACES: users/{user}/sections/default-spaces
  • DEFAULT_APPS: users/{user}/sections/default-apps

形式: users/{user}/sections/{section}
display_name

string

省略可。セクションの表示名。CUSTOM_SECTION タイプのセクションに対してのみデータが入力されます。最大 80 文字に対応します。CUSTOM_SECTION の作成時に必須。
sort_order

int32

出力専用。他のセクションとの相対的な順序。sort_order 値が小さいセクションは、値が大きいセクションより前に表示されます。
type

SectionType

必須。セクションのタイプ。

SectionType

セクションの種類。

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

SectionItem

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

フィールド
name

string

ID。セクション アイテムのリソース名。

形式: users/{user}/sections/{section}/items/{item}
共用体フィールド item。必須。セクション アイテム。item は次のいずれかになります。
space

string

省略可。Space のリソース名。

形式: spaces/{space}

SetUpSpaceRequest

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

フィールド
space

Space

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

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

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

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

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

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

string

省略可。このリクエストの一意の ID。ランダムな UUID をおすすめします。リクエスト ID を指定すると、リクエストがべき等になり、同じリクエスト ID を持つ複数の同一リクエストが 1 つのスペースの作成のみにつながります。リクエスト ID が同じ後続のリクエストでは、リクエストされた詳細が現在の状態と異なる場合でも、既存のスペースが返され、スペースは更新されません。

このフィールドを効果的に使用するには:

  • 後続のリクエストが元のリクエストと同じで、同じ認証情報を使用していることを確認します。
  • 指定されたリクエスト ID でスペースがすでに作成されている場合、リクエストはそのスペースを返します。返されるスペースは完全に設定されていない場合があります。API は、リクエスト内のスペースを、システム割り当てのリソース名が設定された状態でエコーします。スペースの最新のメタデータを取得するには、GetSpace を呼び出します。
  • 別の認証済みユーザーで既存のリクエスト ID を再利用すると、エラーが発生します。
memberships[]

Membership

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

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

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

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

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

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

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

人間と呼び出し元の Chat 用アプリ間の 1 対 1 の会話を作成する場合（Space.spaceType を DIRECT_MESSAGE に、Space.singleUserBotDm を true に設定する場合）は、空にする必要があります。

SlashCommand

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

フィールド
command_id

int64

スラッシュ コマンドの ID。

SlashCommandMetadata

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

フィールド
bot

User

コマンドが呼び出された Chat 用アプリ。
type

Type

スラッシュ コマンドのタイプ。
command_name

string

呼び出されたスラッシュ コマンドの名前。
command_id

int64

呼び出されたスラッシュ コマンドのコマンド ID。
triggers_dialog

bool

スラッシュ コマンドがダイアログ用かどうかを示します。

タイプ

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

スペース

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

フィールド
name

string

ID。Space のリソース名。

形式: spaces/{space}

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

Type

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

SpaceType

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

bool

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

bool

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

string

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

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

最大 128 文字に対応します。
external_user_allowed

bool

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

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

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

SpaceThreadingState

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

SpaceDetails

省略可。説明やルールなど、スペースの詳細。
space_history_state

HistoryState

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

bool

省略可。このスペースが Import Mode で作成されたかどうか。これは、Google Workspace へのデータ移行の一部です。スペースのインポート中は、インポートが完了するまでユーザーに表示されません。

Import Mode でスペースを作成するには、ユーザー認証が必要です。
create_time

Timestamp

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

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

spaceType が GROUP_CHAT または SPACE の場合にのみ、出力に値が入力されます。
last_active_time

Timestamp

出力専用。スペース内の最後のメッセージのタイムスタンプ。
admin_installed

bool

出力専用。Chat 用アプリを含むダイレクト メッセージ（DM）スペースの場合、スペースが Google Workspace 管理者によって作成されたかどうか。管理者は、組織内のユーザーに代わって、Chat 用アプリとのダイレクト メッセージをインストールして設定できます。

管理者によるインストールをサポートするには、Chat 用アプリにダイレクト メッセージ機能が必要です。
membership_count

MembershipCount

出力専用。メンバータイプ別にグループ化された参加メンバーシップの数。space_type が SPACE、DIRECT_MESSAGE、GROUP_CHAT の場合に設定されます。
access_settings

AccessSettings

省略可。スペースのアクセス設定を指定します。space_type が SPACE の場合にのみ入力されます。
space_uri

string

出力専用。ユーザーがスペースにアクセスするための URI。
import_mode_expire_time

Timestamp

出力専用。インポート モードのままの場合に、システムによってスペースが自動的に削除される日時。

インポート モードで作成された各スペースは、spaces.completeImport を使用して、この有効期限が切れる前にこのモードを終了する必要があります。

このフィールドは、インポート モードで作成されたスペースに対してのみ入力されます。
customer

string

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

customers/{customer} 形式。ここで、customer は Admin SDK の顧客リソースの id です。限定公開アプリでは、customers/my_customer エイリアスを使用して、アプリと同じ Google Workspace 組織にスペースを作成することもできます。

このフィールドは、ダイレクト メッセージ（DM）の場合や、Google Workspace ユーザー以外がスペースを作成した場合は入力されません。
共用体フィールド space_permission_settings。スペースの権限設定を表します。space_type が SPACE の場合にのみ入力されます。space_permission_settings は次のいずれかになります。
predefined_permission_settings

PredefinedPermissionSettings

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

事前定義された権限設定の設定は、以下をサポートしています。
permission_settings

PermissionSettings

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

権限設定の読み取りと更新は、次のものをサポートしています。

AccessPermissionSetting

アクセス権限の設定。

フィールド
principals[]

Principal

省略可。順序なしリスト。この権限で許可されているプリンシパル。

AccessPermissionSettings

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

フィールド
discover_space_setting

AccessPermissionSetting

省略可。スペースを検出するためのアクセス権限の設定。
join_space_setting

AccessPermissionSetting

省略可。スペースに参加するためのアクセス権限の設定。

AccessSettings

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

フィールド
access_state

AccessState

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

string

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

形式: audiences/{audience}

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

ターゲット オーディエンスのサポート:

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

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

AccessPermissionSettings

省略可。スペースのアクセス許可の設定。

スペースの作成時に対象ユーザーを設定するには、リクエストで accessSettings.audience フィールドを指定します。

AccessState

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

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

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

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

MembershipCount

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

フィールド
joined_direct_human_user_count

int32

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

int32

出力専用。スペースに直接参加しているすべてのグループの数。

PermissionSetting

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

フィールド
managers_allowed

bool

省略可。スペースのオーナー（ROLE_MANAGER）にこの権限があるかどうか。
members_allowed

bool

省略可。基本的なスペース メンバー（ROLE_MEMBER）がこの権限を持っているかどうか。
assistant_managers_allowed

bool

省略可。スペース管理者（ROLE_ASSISTANT_MANAGER）がこの権限を持っているかどうか。

PermissionSettings

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

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

フィールド
manage_members_and_groups

PermissionSetting

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

PermissionSetting

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

PermissionSetting

省略可。スペースの履歴のオンとオフを切り替える設定。
use_at_mention_all

PermissionSetting

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

PermissionSetting

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

PermissionSetting

省略可。スペース内の Webhook を管理するための設定。
post_messages

PermissionSetting

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

PermissionSetting

省略可。スペース内のメッセージに返信する設定。

PredefinedPermissionSettings

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

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

プリンシパル

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

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

Audience

オーディエンス。

SpaceDetails

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

フィールド
description

string

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

最大 150 文字に対応します。
guidelines

string

省略可。スペースのルール、期待されること、エチケット。

最大 5,000 文字に対応します。

SpaceThreadingState

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

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

メッセージ スレッドをサポートしていないスペース。このスペース スレッドの状態は、次のような特別なケースでのみ使用されます。

  • スレッド表示が意図的にオフになっている会議のチャットの保持。
  • 2022 年より前に作成された以前のグループ会話。

SpaceType

スペースのタイプ。スペースの作成または更新時に必要です。その他の用途では出力のみ。

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

タイプ

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

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

SpaceBatchUpdatedEventData

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

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

フィールド
spaces[]

SpaceUpdatedEventData

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

SpaceEvent

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

フィールド
name

string

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

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

Timestamp

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

string

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

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

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

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

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

リアクションでサポートされているイベントタイプ:

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

スペースに関するサポートされているイベントタイプ:

  • 更新されたスペース: google.workspace.chat.space.v1.updated
  • 複数のスペースの更新: google.workspace.chat.space.v1.batchUpdated

共用体フィールド payload。

payload は次のいずれかになります。
message_created_event_data

MessageCreatedEventData

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

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

MessageUpdatedEventData

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

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

MessageDeletedEventData

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

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

MessageBatchCreatedEventData

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

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

MessageBatchUpdatedEventData

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

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

MessageBatchDeletedEventData

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

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

SpaceUpdatedEventData

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

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

SpaceBatchUpdatedEventData

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

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

MembershipCreatedEventData

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

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

MembershipUpdatedEventData

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

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

MembershipDeletedEventData

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

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

MembershipBatchCreatedEventData

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

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

MembershipBatchUpdatedEventData

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

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

MembershipBatchDeletedEventData

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

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

ReactionCreatedEventData

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

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

ReactionDeletedEventData

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

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

ReactionBatchCreatedEventData

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

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

ReactionBatchDeletedEventData

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

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

SpaceNotificationSetting

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

フィールド
name

string

ID。スペースの通知設定のリソース名。形式: users/{user}/spaces/{space}/spaceNotificationSetting。
notification_setting

NotificationSetting

通知設定。
mute_setting

MuteSetting

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

MuteSetting

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

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

NotificationSetting

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

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

SpaceReadState

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

フィールド
name

string

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

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

Timestamp

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

SpaceUpdatedEventData

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

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

フィールド
space

Space

更新されたスペース。

SpaceView

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

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

スレッド

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

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

フィールド
name

string

ID。スレッドのリソース名。

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

string

省略可。スレッドの作成または更新の入力。それ以外の場合は出力のみ。スレッドの ID。最大 4,000 文字に対応します。

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

ThreadReadState

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

フィールド
name

string

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

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

Timestamp

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

UpdateAvailabilityRequest

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

フィールド
availability

Availability

必須。更新する公開設定。
update_mask

FieldMask

必須。更新するフィールドのリスト。更新できるフィールドは custom_status のみです。

UpdateMembershipRequest

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

フィールド
membership

Membership

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

FieldMask

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

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

  • role
use_admin_access

bool

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

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

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

UpdateMessageRequest

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

フィールド
message

Message

必須。フィールドが更新されたメッセージ。
update_mask

FieldMask

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

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

  • text

  • attachment

  • cards（アプリの認証が必要です）。

  • cards_v2（アプリの認証が必要です）。

  • accessory_widgets（アプリの認証が必要です）。

  • quoted_message_metadata（引用されたメッセージの削除のみを許可します）。
allow_missing

bool

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

UpdateSectionRequest

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

フィールド
section

Section

必須。更新するセクション。
update_mask

FieldMask

必須。更新するフィールドを指定するマスク。

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

  • display_name

UpdateSpaceNotificationSettingRequest

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

フィールド
space_notification_setting

SpaceNotificationSetting

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

FieldMask

必須。サポートされているフィールドパス:

  • notification_setting

  • mute_setting

UpdateSpaceReadStateRequest

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

フィールド
space_read_state

SpaceReadState

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

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

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

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

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

FieldMask

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

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

space_details: スペースの説明とガイドラインを更新します。更新リクエストで、説明とガイドラインの両方を SpaceDetails として渡す必要があります。フィールドの 1 つだけを更新する場合は、他のフィールドの既存の値を渡します。

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

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

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

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

access_settings.access_permission_settings: spaceType フィールドが SPACE のスペースを見つけて参加できるユーザーのアクセス権設定を更新します。スペースへの参加が許可されているプリンシパルは、スペースの検出も許可されている必要があります。スペースのアクセス権限設定を更新するには、認証ユーザーがスペースの管理者またはアシスタント管理者である必要があり、リクエスト内の他のすべてのフィールド マスクを省略する必要があります。スペースがインポート モードの場合、このフィールドは更新できません。詳しくは、特定のユーザーがスペースを見つけられるようにするをご覧ください。access_settings.access_permission_settings は useAdminAccess ではサポートされていません。サポートされているフィールド マスクは次のとおりです。

  • access_settings.access_permission_settings.discoverSpaceSetting
  • access_settings.access_permission_settings.joinSpaceSetting

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

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

bool

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

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

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

一部の FieldMask 値は、管理者アクセスではサポートされていません。詳しくは、update_mask の説明をご覧ください。

ユーザー

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

フィールド
name

string

Google Chat の user のリソース名。

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

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

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

  • Admin SDK Directory API の user の id。

  • ユーザーのメールアドレスは、API リクエストで {user} のエイリアスとして使用できます。たとえば、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

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

TextParagraph

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

Image

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

KeyValue

このウィジェットに Key-Value の項目を表示します。

ボタン

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

フィールド

共用体フィールド type。

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

TextButton

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

ImageButton

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

FormAction

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

フィールド
action_method_name

string

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

ActionParameter

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

ActionParameter

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

フィールド
key

string

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

string

パラメータの値。

アイコン

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

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

画像

URL で指定された画像。onclick アクションを設定できます。

フィールド
image_url

string

画像の URL です。
on_click

OnClick

onclick アクション。
aspect_ratio

double

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

ImageButton

onclick アクションを含む画像ボタン。

フィールド
on_click

OnClick

onclick アクション。
name

string

ユーザー補助に使用されるこの image_button の名前。この名前が指定されていない場合は、デフォルト値が提供されます。
共用体フィールド icons。アイコンは Icon enum または URL で指定できます。icons は次のいずれかになります。
icon

Icon

Chat API が提供するアイコンのインデックスを指定する enum で指定されたアイコン。
icon_url

string

URL で指定されたアイコン。

KeyValue

UI 要素には、キー（ラベル）と値（コンテンツ）が含まれます。この要素には、onclick ボタンなどのアクションを含めることもできます。

フィールド
top_label

string

上部のラベルのテキスト。書式設定されたテキストがサポートされています。テキストの書式設定について詳しくは、Google Chat アプリでテキストの書式を設定すると Google Workspace アドオンでテキストの書式を設定するをご覧ください。
content

string

コンテンツのテキスト。書式設定されたテキストがサポートされ、常に必要です。テキストの書式設定について詳しくは、Google Chat アプリでテキストの書式を設定すると Google Workspace アドオンでテキストの書式を設定するをご覧ください。
content_multiline

bool

コンテンツが複数行であるかどうか。
bottom_label

string

下部のラベルのテキスト。書式設定されたテキストがサポートされています。テキストの書式設定について詳しくは、Google Chat アプリでテキストの書式を設定すると Google Workspace アドオンでテキストの書式を設定するをご覧ください。
on_click

OnClick

onclick アクション。クリックできるのは、上部のラベル、下部のラベル、コンテンツ領域のみです。
共用体フィールド icons。アイコン、top_label、bottom_label のうち少なくとも 1 つを定義する必要があります。icons は次のいずれかになります。
icon

Icon

Chat API によって対応するアイコン画像に置き換えられる列挙型値。
icon_url

string

URL で指定されたアイコン。
共用体フィールド control。コントロール ウィジェット。button または switch_widget のいずれか一方を設定できますが、両方は設定できません。control は次のいずれかになります。
button

Button

クリックしてアクションをトリガーできるボタン。

OnClick

onclick アクション（リンクを開くなど）。

フィールド

共用体フィールド data。

data は次のいずれかになります。
action

FormAction

指定されている場合、この onclick アクションによってフォーム アクションがトリガーされます。

TextButton

テキストと onclick アクションを含むボタン。

フィールド
text

string

ボタンのテキスト。
on_click

OnClick

ボタンの onclick アクション。

TextParagraph

テキストの段落。書式設定されたテキストがサポートされています。テキストの書式設定について詳しくは、Google Chat アプリでテキストの書式を設定すると Google Workspace アドオンでテキストの書式を設定するをご覧ください。

フィールド
text

string