Package google.chat.v1

rpc CompleteImportSpace(CompleteImportSpaceRequest) returns (CompleteImportSpaceResponse)

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

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

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

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

認可スコープ

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

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

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

rpc CreateCustomEmoji(CreateCustomEmojiRequest) returns (CustomEmoji)

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

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

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

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

認可スコープ

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

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

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

rpc CreateMembership(CreateMembershipRequest) returns (Membership)

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

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

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

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

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

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

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

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

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

• ユーザーをスペースに招待または追加する。
• Google グループをスペースに招待または追加する。
• Chat アプリをスペースに追加する。

認可スコープ

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

rpc GetAttachment(GetAttachmentRequest) returns (Attachment)

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

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

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

認可スコープ

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

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

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

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

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

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

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

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

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

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

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

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

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

rpc GetSpaceNotificationSetting(GetSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

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

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

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

認可スコープ

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

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

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

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

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

rpc GetThreadReadState(GetThreadReadStateRequest) returns (