mirror of
https://github.com/GAM-team/GAM.git
synced 2026-06-03 22:01:39 +00:00
59e425e41c
Some checks failed
Push wiki / pushwiki (push) Has been cancelled
Build and test GAM / build (false, build, 1, Build Intel Ubuntu Jammy, ubuntu-22.04) (push) Has been cancelled
Build and test GAM / build (false, build, 10, Build x86_64 macOS 15, macos-15-intel) (push) Has been cancelled
Build and test GAM / build (false, build, 11, Build Arm MacOS 26, macos-26) (push) Has been cancelled
Build and test GAM / build (false, build, 12, Build Intel Windows, windows-2025) (push) Has been cancelled
Build and test GAM / build (false, build, 13, Build Arm Windows, windows-11-arm) (push) Has been cancelled
Build and test GAM / build (false, build, 2, Build Intel Ubuntu Noble, ubuntu-24.04) (push) Has been cancelled
Build and test GAM / build (false, build, 3, Build Arm Ubuntu Noble, ubuntu-24.04-arm) (push) Has been cancelled
Build and test GAM / build (false, build, 4, Build Arm Ubuntu Jammy, ubuntu-22.04-arm) (push) Has been cancelled
Build and test GAM / build (false, build, 5, Build Intel StaticX Legacy, ubuntu-22.04, yes) (push) Has been cancelled
Build and test GAM / build (false, build, 6, Build Arm StaticX Legacy, ubuntu-22.04-arm, yes) (push) Has been cancelled
Build and test GAM / build (false, build, 8, Build Arm MacOS 14, macos-14) (push) Has been cancelled
Build and test GAM / build (false, build, 9, Build Arm MacOS 15, macos-15) (push) Has been cancelled
Build and test GAM / build (false, test, 14, Test Python 3.10, ubuntu-24.04, 3.10) (push) Has been cancelled
Build and test GAM / build (false, test, 15, Test Python 3.11, ubuntu-24.04, 3.11) (push) Has been cancelled
Build and test GAM / build (false, test, 16, Test Python 3.12, ubuntu-24.04, 3.12) (push) Has been cancelled
Build and test GAM / build (false, test, 17, Test Python 3.15-dev, ubuntu-24.04, 3.15-dev) (push) Has been cancelled
Build and test GAM / build (true, test, 18, Test Python 3.14 freethread, ubuntu-24.04, 3.14) (push) Has been cancelled
Build and test GAM / merge (push) Has been cancelled
Build and test GAM / publish (push) Has been cancelled
Check for Google Root CA Updates / check-certs (push) Has been cancelled
CodeQL / Analyze (python) (push) Has been cancelled
81 lines
3.5 KiB
Markdown
81 lines
3.5 KiB
Markdown
# Google Data Transfers
|
|
- [API documentation](#api-documentation)
|
|
- [Definitions](#definitions)
|
|
- [Display transfer apps](#display-transfer-apps)
|
|
- [Create transfers](#create-transfers)
|
|
- [Display transfers](#display-transfers)
|
|
|
|
## API documentation
|
|
* [Data Transfer API](https://developers.google.com/admin-sdk/data-transfer/reference/rest/v1/transfers)
|
|
* [Prepare account for transfer](https://support.google.com/a/answer/1247799)
|
|
|
|
## Definitions
|
|
```
|
|
<DataTransferService> ::=
|
|
calendar|
|
|
datastudio|lookerstudio|"looker studio"|
|
|
drive|gdrive|googledrive|"drive and docs"
|
|
<DataTransferServiceList> ::= "<DataTransferService>(,<DataTransferService>)*"
|
|
|
|
<UniqueID> ::= id:<String>
|
|
<UserItem> ::= <EmailAddress>|<UniqueID>|<String>
|
|
<OldOwnerID> ::= <UserItem>
|
|
<NewOwnerID> ::= <UserItem>
|
|
<TransferID> ::= <String>
|
|
```
|
|
|
|
## Display transfer apps
|
|
```
|
|
gam print|show transferapps
|
|
```
|
|
|
|
## Create transfers
|
|
```
|
|
gam create|add datatransfer|transfer <OldOwnerID> <DataTransferServiceList> <NewOwnerID>
|
|
[private|shared|all] [privacy_level private|shared|private,shared]
|
|
[releaseresources [<Boolean>]]
|
|
(<ParameterKey> <ParameterValue>)*
|
|
[wait <Integer> <Integer>]
|
|
```
|
|
For`lookerstudio` and `drive`, there are options to control the privacy level of the files to be transferred.
|
|
* `private` or `privacy_level private` - Transfer files that are not shared with anyone
|
|
* `shared` or `privacy_level shared` - Transfer files shared with at least one other user; this is the **default**
|
|
* `all` or `privacy_level private,shared` - Transfer all files
|
|
|
|
For calendars, there is an option to indicate whether to release resources for future events.
|
|
* `releaseresources false` - Do not release resources for future events; this is the default.
|
|
* `releaseresources` or `releaseresources true` - Release resources for future events
|
|
|
|
A `<TransferID>` is returned which can be used to monitor the progress of the transfer.
|
|
|
|
NOTE: For calendars, the behaviour is not sufficiently defined in the API documentation.
|
|
Background transfers only transfer future non-private events with at least one guest/resource.
|
|
|
|
The option `<ParameterKey> <ParameterValue>` is for future expansion.
|
|
|
|
By default, GAM does not wait for the transfer to complete. The option `wait <Integer> <Integer>` causes GAM to wait
|
|
for the transfer to complete. The first `<Integer>` must be in the range 5-60 and is the number
|
|
of seconds between checks to see if the transfer has completed. The second `<Integer>` is the maximum number of checks to perform.
|
|
|
|
## Display transfers
|
|
```
|
|
gam info datatransfer|transfer <TransferID>
|
|
gam show datatransfers|transfers
|
|
[olduser|oldowner <UserItem>] [newuser|newowner <UserItem>]
|
|
[status completed|failed|inprogress|<String>] [delimiter <Character>]
|
|
gam print datatransfers|transfers [todrive <ToDriveAttribute>*]
|
|
[olduser|oldowner <UserItem>] [newuser|newowner <UserItem>]
|
|
[status completed|failed|inprogress|<String>] [delimiter <Character>]
|
|
(addcsvdata <FieldName> <String>)*
|
|
```
|
|
By default, all data transfer operations are printed, use these options to select specific transfers.
|
|
* `olduser|oldowner <UserItem>`
|
|
* `newuser|newowner <UserItem>`
|
|
* `status completed|failed|inprogress`
|
|
|
|
By default, the entries in lists of items are separated by the `csv_output_field_delimiter` from `gam.cfg`.
|
|
* `delimiter <Character>` - Separate list items with `<Character>`
|
|
|
|
Add additional columns of data from the command line to the output
|
|
* `addcsvdata <FieldName> <String>`
|