Package google.chat.v1

インデックス

ChatService

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

CompleteImportSpace

rpc CompleteImportSpace(CompleteImportSpaceRequest) returns (CompleteImportSpaceResponse)

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

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

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

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

認可スコープ

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

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

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

rpc CreateCustomEmoji(CreateCustomEmojiRequest) returns (CustomEmoji)

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

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

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

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

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

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

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

rpc CreateMembership(CreateMembershipRequest) returns (Membership)

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

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

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

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

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

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

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

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

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

認可スコープ

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

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

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

rpc CreateMessage(CreateMessageRequest) returns (Message)

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

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

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

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

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

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

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

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

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

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

認可スコープ

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

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

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

rpc CreateReaction(CreateReactionRequest) returns (Reaction)

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

次のいずれかの認可スコープによるユーザー認証が必要です。

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

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

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

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

rpc CreateSpace(CreateSpaceRequest) returns (Space)

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

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

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

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

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

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

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

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

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

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

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

認可スコープ

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

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

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

rpc DeleteCustomEmoji(DeleteCustomEmojiRequest) returns (Empty)

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

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

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

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

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

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

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

rpc DeleteMembership(DeleteMembershipRequest) returns (Membership)

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

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

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

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

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

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

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

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

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

認可スコープ

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

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

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

rpc DeleteMessage(DeleteMessageRequest) returns (Empty)

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

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

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

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

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

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

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

認可スコープ

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

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

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

rpc DeleteReaction(DeleteReactionRequest) returns (Empty)

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

次のいずれかの認可スコープによるユーザー認証が必要です。

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

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

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

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

rpc DeleteSpace(DeleteSpaceRequest) returns (Empty)

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

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

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

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

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

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

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

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

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

rpc FindDirectMessage(FindDirectMessageRequest) returns (Space)

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

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

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

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

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

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

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

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

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

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

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

rpc GetAttachment(GetAttachmentRequest) returns (Attachment)

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

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

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

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

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

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

rpc GetCustomEmoji(GetCustomEmojiRequest) returns (CustomEmoji)

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

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

次のいずれかの認可スコープによるユーザー認証が必要です。

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

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

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

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

rpc GetMembership(GetMembershipRequest) returns (Membership)

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

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

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

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

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

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

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

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

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

rpc GetMessage(GetMessageRequest) returns (Message)

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

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

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

    • https://www.googleapis.com/auth/chat.bot: この認証スコープを使用すると、このメソッドは、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.messages.readonly
    • https://www.googleapis.com/auth/chat.app.memberships

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

    • 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.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

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

rpc GetSpaceNotificationSetting(GetSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

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

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

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

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

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

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

rpc GetSpaceReadState(GetSpaceReadStateRequest) returns (SpaceReadState)

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

次のいずれかの認可スコープによるユーザー認証が必要です。

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

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

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

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

rpc GetThreadReadState(GetThreadReadStateRequest) returns (ThreadReadState)

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

次のいずれかの認可スコープによるユーザー認証が必要です。

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

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

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

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

rpc ListCustomEmojis(ListCustomEmojisRequest) returns (ListCustomEmojisResponse)

認証済みユーザーに表示されるカスタム絵文字のリストを取得します。

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

次のいずれかの認可スコープによるユーザー認証が必要です。

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

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

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

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

rpc ListMemberships(ListMembershipsRequest) returns (ListMembershipsResponse)

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

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

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

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

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

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

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

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

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

rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse)

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

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

  • デベロッパー プレビューの管理者による承認によるアプリ認証（認可スコープあり）:

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

詳しくは、承認ガイドをご覧ください。
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.messages.readonly
    • https://www.googleapis.com/auth/chat.app.memberships

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

    • 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.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

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

rpc ListSpaces(ListSpacesRequest) returns (ListSpacesResponse)

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

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

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

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

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

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

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

認可スコープ

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

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

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

rpc SearchSpaces(SearchSpacesRequest) returns (SearchSpacesResponse)

管理者の検索に基づいて、Google Workspace 組織内のスペースのリストを返します。リクエストでは、use_admin_access を true に設定します。例については、スペースを検索して管理するをご覧ください。

管理者権限を持つユーザー認証と、次のいずれかの承認スコープが必要です。

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

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

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

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

rpc SetUpSpace(SetUpSpaceRequest) returns (Space)

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

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

追加する Google グループを指定するには、適切な membership.group_member.name を使用してメンバーシップを追加します。Google グループを追加または招待するには、groups/{group} を使用します。ここで、{group} は Cloud Identity Groups API のグループの id です。たとえば、Cloud Identity Groups lookup API を使用してグループ メール [email protected] の ID 123456789 を取得し、membership.group_member.name を groups/123456789 に設定してグループをスペースに追加できます。グループ メールはサポートされていません。Google グループは、名前付きスペースのメンバーとしてのみ追加できます。

名前付きスペースまたはグループ チャットの場合、発信者が一部のメンバーをブロックしている、または一部のメンバーにブロックされている、または一部のメンバーを追加する権限がない場合、それらのメンバーは作成されたスペースに追加されません。

通話中のユーザーと別のユーザー間のダイレクト メッセージ（DM）を作成するには、ユーザーを表すメンバーシップを 1 つだけ指定します。一方のユーザーが他方のユーザーをブロックしている場合、リクエストは失敗し、DM は作成されません。

通話中のユーザーと通話中のアプリの間に DM を作成するには、Space.singleUserBotDm を true に設定し、メンバーシップを指定しないでください。このメソッドを使用して設定できるのは、通話アプリとの DM のみです。通話アプリをスペースのメンバーとして追加したり、2 人のユーザー間の既存の DM に追加したりするには、スペースにユーザーまたはアプリを招待または追加するをご覧ください。

2 人のユーザー間に DM がすでに存在する場合、リクエストの作成時に一方のユーザーが他方のユーザーをブロックしていても、既存の DM が返されます。

スレッド返信のあるスペースはサポートされていません。スペースの設定時に ALREADY_EXISTS というエラー メッセージが表示された場合は、別の displayName を試してください。Google Workspace 組織内の既存のスペースで、この表示名がすでに使用されている可能性があります。

次のいずれかの認可スコープによるユーザー認証が必要です。

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

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

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

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

rpc UpdateMembership(UpdateMembershipRequest) returns (Membership)

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

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

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

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

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

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

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

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

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

rpc UpdateMessage(UpdateMessageRequest) returns (Message)

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

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

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

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

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

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

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

認可スコープ

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

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

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

rpc UpdateSpace(UpdateSpaceRequest) returns (Space)

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

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

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

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

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

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

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

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

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

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

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

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

rpc UpdateSpaceNotificationSetting(UpdateSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

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

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

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

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

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

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

rpc UpdateSpaceReadState(UpdateSpaceReadStateRequest) returns (SpaceReadState)

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

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

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

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

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

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

AccessoryWidget

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

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

ButtonList

ボタンのリスト。

ActionResponse

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

フィールド
type

ResponseType

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

string

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

DialogAction

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

UpdatedWidget

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

ResponseType

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

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

SelectionItems

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

フィールド
items[]

SelectionItem

SelectionItem オブジェクトの配列。

UpdatedWidget

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

フィールド
widget

string

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

SelectionItems

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

ActionStatus

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

フィールド
status_code

Code

ステータス コード。
user_facing_message

string

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

メモ

出力専用。アノテーションは、メッセージのプレーン テキストの本文、または start_index と length が 0 の Google ドキュメントや 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 メニューからコマンドを選択します。

AttachedGif

URL で指定された GIF 画像。

フィールド
uri

string

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

添付ファイル

Google Chat の添付ファイル。

フィールド
name

string

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

string

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

string

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

string

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

string

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

Source

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

AttachmentDataRef

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

DriveDataRef

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

ソース

添付ファイルのソース。

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

AttachmentDataRef

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

フィールド
resource_name

string

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

string

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

CalendarEventLinkData

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

フィールド
calendar_id

string

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

string

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

CardWithId

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

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

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

カードビルダーを開く

フィールド
card_id

string

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

Card

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

ChatSpaceLinkData

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

フィールド
space

string

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

形式: spaces/{space}
thread

string

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

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

string

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

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

CompleteImportSpaceRequest

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

フィールド
name

string

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

形式: spaces/{space}

CompleteImportSpaceResponse

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

フィールド
space

Space

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

ContextualAddOnMarkup

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

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

カード

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

フィールド
header

CardHeader

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

Section

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

CardAction

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

string

カードの名前。

CardAction

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

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

フィールド
action_label

string

アクション メニュー項目に表示されていたラベル。
on_click

OnClick

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

CardHeader

フィールド
title

string

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

string

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

ImageStyle

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

string

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

ImageStyle

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

セクション

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

フィールド
header

string

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

WidgetMarkup

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

CreateCustomEmojiRequest

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

フィールド
custom_emoji

CustomEmoji

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

CreateMembershipRequest

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

フィールド
parent

string

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

形式: spaces/{space}
membership

Membership

必須。作成するメンバーシップ リレーション。

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

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

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

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

  • user.type を HUMAN に設定し、user.name を users/{user} 形式で設定します。ここで、{user} はユーザーのメールアドレスにできます。同じ Workspace 組織内のユーザーの場合、{user} は People API の person の id、または Directory API のユーザーの id にすることもできます。たとえば、[email protected] の People API の人物プロファイル ID が 123456789 の場合、membership.member.name を users/[email protected] または users/123456789 に設定することで、ユーザーをスペースに追加できます。

スペースを所有する Workspace 組織外のユーザーを招待するには、