Method: matters.holds.addHeldAccounts
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
アカウントを記録保持(リティゲーション ホールド)に追加します。正常に追加されたアカウントのリストを返します。アカウントを追加できるのは、既存のアカウントベースの保留に限られます。
HTTP リクエスト
POST https://vault.googleapis.com/v1/matters/{matterId}/holds/{holdId}:addHeldAccounts
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ |
matterId |
string
案件 ID。
|
holdId |
string
保留 ID。
|
リクエストの本文
リクエストの本文には、次の構造のデータが含まれます。
JSON 表現 |
{
"emails": [
string
],
"accountIds": [
string
]
} |
フィールド |
emails[] |
string
保留に追加するアカウントのメールアドレスのカンマ区切りリスト。emails または accountIds のいずれかを指定してください。両方を指定することはできません。
|
accountIds[] |
string
保留に追加するアカウントのアカウント ID のカンマ区切りのリスト。emails または accountIds のいずれかを指定してください。両方を指定することはできません。
|
レスポンスの本文
保留中のアカウントの一括作成に対するレスポンス。
成功した場合、レスポンスの本文には次の構造のデータが含まれます。
フィールド |
responses[] |
object (AddHeldAccountResult )
レスポンスのリスト(バッチ リクエストと同じ順序)。
|
認可スコープ
次の OAuth スコープが必要です。
https://www.googleapis.com/auth/ediscovery
詳しくは、認可ガイドをご覧ください。
AddHeldAccountResult
各アカウントの作成ステータスと、成功した場合の HeldAccount。
フィールド |
account |
object (HeldAccount )
アカウントが正常に作成された場合に返されます。
|
status |
object (Status )
リクエストのステータスを報告します。失敗した場合は、エラー メッセージを返します。
|
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2025-07-25 UTC。
[null,null,["最終更新日 2025-07-25 UTC。"],[],[],null,["# Method: matters.holds.addHeldAccounts\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n - [JSON representation](#body.AddHeldAccountsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [AddHeldAccountResult](#AddHeldAccountResult)\n - [JSON representation](#AddHeldAccountResult.SCHEMA_REPRESENTATION)\n- [Try it!](#try-it)\n\nAdds accounts to a hold. Returns a list of accounts that have been successfully added. Accounts can be added only to an existing account-based hold.\n\n### HTTP request\n\n`POST https://vault.googleapis.com/v1/matters/{matterId}/holds/{holdId}:addHeldAccounts`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|-------------------------|\n| `matterId` | `string` The matter ID. |\n| `holdId` | `string` The hold ID. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------|\n| ``` { \"emails\": [ string ], \"accountIds\": [ string ] } ``` |\n\n| Fields ||\n|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------|\n| `emails[]` | `string` A comma-separated list of the emails of the accounts to add to the hold. Specify either **emails** or **accountIds**, but not both. |\n| `accountIds[]` | `string` A comma-separated list of the account IDs of the accounts to add to the hold. Specify either **emails** or **accountIds**, but not both. |\n\n### Response body\n\nResponse for batch create held accounts.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"responses\": [ { object (/workspace/vault/reference/rest/v1/matters.holds/addHeldAccounts#AddHeldAccountResult) } ] } ``` |\n\n| Fields ||\n|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `responses[]` | `object (`[AddHeldAccountResult](/workspace/vault/reference/rest/v1/matters.holds/addHeldAccounts#AddHeldAccountResult)`)` The list of responses, in the same order as the batch request. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/ediscovery`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent).\n\nAddHeldAccountResult\n--------------------\n\nThe status of each account creation, and the **HeldAccount**, if successful.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"account\": { object (/workspace/vault/reference/rest/v1/matters.holds.accounts#HeldAccount) }, \"status\": { object (/workspace/vault/reference/rest/v1/operations#Status) } } ``` |\n\n| Fields ||\n|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `account` | `object (`[HeldAccount](/workspace/vault/reference/rest/v1/matters.holds.accounts#HeldAccount)`)` Returned when the account was successfully created. |\n| `status` | `object (`[Status](/workspace/vault/reference/rest/v1/operations#Status)`)` Reports the request status. If it failed, returns an error message. |"]]