REST Resource: transfers
Stay organized with collections
Save and categorize content based on your preferences.
Resource: DataTransfer
A Transfer resource represents the transfer of the ownership of user data between users.
| JSON representation |
{
"id": string,
"oldOwnerUserId": string,
"newOwnerUserId": string,
"applicationDataTransfers": [
{
object (ApplicationDataTransfer)
}
],
"overallTransferStatusCode": string,
"kind": string,
"etag": string,
"requestTime": string
} |
| Fields |
id |
string
Read-only. The transfer's ID.
|
oldOwnerUserId |
string
ID of the user whose data is being transferred.
|
newOwnerUserId |
string
ID of the user to whom the data is being transferred.
|
applicationDataTransfers[] |
object (ApplicationDataTransfer)
The list of per-application data transfer resources. It contains details of the applications associated with this transfer resource, and also specifies the applications for which data transfer has to be done at the time of the transfer resource creation.
|
overallTransferStatusCode |
string
Read-only. Overall transfer status.
|
kind |
string
Identifies the resource as a DataTransfer request.
|
etag |
string
ETag of the resource.
|
requestTime |
string
Read-only. The time at which the data transfer was requested.
|
ApplicationDataTransfer
Template to map fields of ApplicationDataTransfer resource.
| JSON representation |
{
"applicationId": string,
"applicationTransferParams": [
{
object (ApplicationTransferParam)
}
],
"applicationTransferStatus": string
} |
| Fields |
applicationId |
string (int64 format)
The application's ID.
|
applicationTransferParams[] |
object (ApplicationTransferParam)
The transfer parameters for the application. These parameters are used to select the data which will get transferred in context of this application. For more information about the specific values available for each application, see the Transfer parameters reference.
|
applicationTransferStatus |
string
Read-only. Current status of transfer for this application.
|
Methods |
|
|
Retrieves a data transfer request by its resource ID. |
|
|
Inserts a data transfer request. |
|
|
Lists the transfers for a customer by source user, destination user, or status. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-25 UTC.
[null,null,["Last updated 2025-03-25 UTC."],[],[],null,["# REST Resource: transfers\n\nResource: DataTransfer\n----------------------\n\nA Transfer resource represents the transfer of the ownership of user data between users.\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"id\": string, \"oldOwnerUserId\": string, \"newOwnerUserId\": string, \"applicationDataTransfers\": [ { object (/workspace/admin/data-transfer/reference/rest/v1/transfers#ApplicationDataTransfer) } ], \"overallTransferStatusCode\": string, \"kind\": string, \"etag\": string, \"requestTime\": string } ``` |\n\n| Fields ||\n|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `id` | `string` Read-only. The transfer's ID. |\n| `oldOwnerUserId` | `string` ID of the user whose data is being transferred. |\n| `newOwnerUserId` | `string` ID of the user to whom the data is being transferred. |\n| `applicationDataTransfers[]` | `object (`[ApplicationDataTransfer](/workspace/admin/data-transfer/reference/rest/v1/transfers#ApplicationDataTransfer)`)` The list of per-application data transfer resources. It contains details of the applications associated with this transfer resource, and also specifies the applications for which data transfer has to be done at the time of the transfer resource creation. |\n| `overallTransferStatusCode` | `string` Read-only. Overall transfer status. |\n| `kind` | `string` Identifies the resource as a DataTransfer request. |\n| `etag` | `string` ETag of the resource. |\n| `requestTime` | `string` Read-only. The time at which the data transfer was requested. |\n\nApplicationDataTransfer\n-----------------------\n\nTemplate to map fields of ApplicationDataTransfer resource.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"applicationId\": string, \"applicationTransferParams\": [ { object (/workspace/admin/data-transfer/reference/rest/v1/ApplicationTransferParam) } ], \"applicationTransferStatus\": string } ``` |\n\n| Fields ||\n|-------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `applicationId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The application's ID. |\n| `applicationTransferParams[]` | `object (`[ApplicationTransferParam](/workspace/admin/data-transfer/reference/rest/v1/ApplicationTransferParam)`)` The transfer parameters for the application. These parameters are used to select the data which will get transferred in context of this application. For more information about the specific values available for each application, see the [Transfer parameters](https://developers.google.com/workspace/admin/data-transfer/v1/parameters) reference. |\n| `applicationTransferStatus` | `string` Read-only. Current status of transfer for this application. |\n\n| Methods ------- ||\n|---------------------------------------------------------------------------------|---------------------------------------------------------------------------------|\n| ### [get](/workspace/admin/data-transfer/reference/rest/v1/transfers/get) | Retrieves a data transfer request by its resource ID. |\n| ### [insert](/workspace/admin/data-transfer/reference/rest/v1/transfers/insert) | Inserts a data transfer request. |\n| ### [list](/workspace/admin/data-transfer/reference/rest/v1/transfers/list) | Lists the transfers for a customer by source user, destination user, or status. |"]]
