List Data Transfers
Definition
The "List Data Transfers" action in the Google Directory allows you to retrieve a list of data transfer requests within a customer account. You can filter these transfers by the source user, destination user, or the status of the transfer. This action helps administrators track the progress of data transfers, monitor their status, and gather information about the specific data being transferred between users. Key capabilities of this action include fetching data transfer details like the transfer ID, users involved, transfer status, request time, and specific application transfer parameters for each data transfer request.
Example Use Cases
-
Monitor Data Transfer Progress
Administrators can use this action to monitor the ongoing data transfer requests within the organization, tracking the status and progress of data being transferred between users.
-
Audit User Data Transfers
To ensure compliance and audit data migration or transfers, administrators can list all data transfers for a customer, including the users involved, to keep track of any movement of sensitive data.
-
Troubleshoot Transfer Issues
If a data transfer is taking longer than expected or has encountered errors, this action allows the administrator to review the transfer’s status and related application parameters to identify potential issues.
-
Manage User Data Migrations
During large-scale user migrations (e.g., organizational restructuring), administrators can use this action to track and manage the transfer of user data like emails, files, or calendars between accounts.
-
Verify Data Integrity Post-Transfer
After a data transfer is complete, administrators can use this action to check if the data was transferred successfully, verify application-specific parameters, and ensure no data was left behind or incorrectly transferred.
Inputs
-
Connection
This field specifies the connection to the Google Directory service, allowing the action to interact with the API. It is required for authenticating and executing the request. You must provide the appropriate API connection that has access to the data you wish to retrieve.
-
Data Transfer From User
This field allows you to specify the source user whose data is being transferred. It refers to the user account from which the data will be transferred. The input can be the user's email address, alias, or unique ID.
-
Insert the User You Want to Transfer
This field specifies the destination user to whom the data will be transferred. The input should be the email address, alias, or unique ID of the user who will receive the data from the source user.
-
Select Data to Transfer
This field is a checkbox list of the types of data that you want to transfer. The available options are:
- Drive and Docs: Select this to include files from Google Drive and Google Docs in the transfer. This will also allow files that are not shared with anyone to be transferred.
- Calendar: Select this to transfer the user's calendar data. This option also includes releasing all calendar resources booked in events organized by the source user.
- Data Studio: Select this option to transfer assets from Google Data Studio, including assets that are not shared with anyone. Only future non-private events with at least one guest or resource will be transferred.
These options allow administrators to fine-tune what data to include in the transfer process. If none of these checkboxes are selected, no data will be transferred.
Outputs
-
Data Transfer ID
This is a unique identifier for the specific data transfer. It allows you to track and reference the transfer operation. You can use this ID to query or manage the data transfer in future requests.
-
Transfer Data From User
This field represents the source user who initiated the data transfer. It will contain the unique ID, email address, or alias of the user whose data is being transferred. This value confirms the user from whom the data originated.
-
Insert the User You Want to Transfer
This field represents the destination user to whom the data is being transferred. It will show the unique ID, email address, or alias of the user who will receive the transferred data.
-
Overall Transfer Status Code
This field indicates the overall status of the data transfer request. It provides a numerical or textual status, such as "Pending," "Completed," or "Failed," that helps track the progress of the data transfer. This is a key field for understanding whether the transfer has been successful or if there are any issues that need to be addressed.
-
Kind
This field identifies the resource type associated with the data transfer. It helps categorize and define the data transfer as part of a particular resource. Typically, this will be a constant value like "admin#directory#dataTransfer."
-
Request Time
This field indicates the timestamp when the data transfer request was initiated. It gives you the exact time when the transfer process started, which can be helpful for logging, tracking, and debugging purposes.
-
Application Data Transfer
This field includes the specific data transfer parameters associated with different applications within the Google Directory. These parameters determine which data within an application will be included in the transfer. This field is further broken down into:
- Application ID: The identifier of the application for which data is being transferred.
- Application Transfer Status: The current status of the transfer for this specific application, such as "Pending," "In Progress," or "Completed."
- Application Transfer Params: These are the specific parameters used to define what data from the application will be transferred, including key values like "files," "events," or "assets." This allows for more granular control over what is transferred for each specific application (e.g., Google Drive, Calendar, or Data Studio).
These outputs give administrators detailed information about each data transfer, making it easy to track, manage, and report on the transfer process for individual users and applications.
Example of Using
Situation: A company needs to monitor and track the status of data transfers that are happening within their organization. For instance, a user is transitioning to a new role and all of their files, emails, and calendar events need to be transferred to another user.
Step-by-Step:
-
Initiating the Transfer: The admin initiates the data transfer for a specific user (the source user), transferring their Google Drive files, Calendar events, and Data Studio assets to a new user (the destination user).
-
Monitoring the Progress: To ensure that the data transfer is proceeding as expected, the admin uses the "List Data Transfers" action to retrieve the status of the ongoing data transfer request.
-
Checking the Output:
- Data Transfer ID: The admin references the unique ID of the transfer to track its progress.
- Transfer Data From User: The admin confirms the source user (e.g., the user leaving the company) whose data is being transferred.
- Insert the User You Want to Transfer: The admin ensures the correct destination user (e.g., the new employee) is receiving the data.
- Overall Transfer Status Code: The admin can see whether the transfer is "Completed," "Pending," or "Failed."
- Application Data Transfer: The admin can check the detailed transfer status for each application (e.g., Google Drive, Calendar), including which specific data (files, events, etc.) has been successfully transferred.
-
Resolving Issues: If the status code indicates a failure, the admin can investigate which specific application (e.g., Calendar) caused the issue and resolve it.
This action helps the admin monitor the status of multiple data transfers in one go, ensuring smooth transitions for users within the organization.
Updated 3 days ago