On This Page
Overview
The Google Workspace (formally G Suite) connector in SkySync allows you to analyze, migrate, copy, and synchronize files between your Google Workspace account and cloud storage repositories and on-premise network file shares. The first step is to create the Google Workspace connection by providing the connection information required for SkySync to connect to the platform/server.
Creating connection | SkySync application user-interface
Select Connections > Add connection.
Select Google Workspace as the platform on the Add connection modal.
Enter the connection information. Reference the table below for details about each field.
Test the connection to ensure SkySync can connect using the information entered.
You will see a "Connection test succeeded" message on the Add connection modal when SkySync establishes connection. (If you don't see this message, verify the information you entered.)
Select Done.
Add connection modal - Google Workspace
Field | Description | Required |
|---|---|---|
Display as | Enter the display name for the connection. If you will be creating multiple connections, ensure the name readily identifies the connection. The name displays in the application, and you can use it to search for the connection and filter lists. The maximum length is 255 characters. | Optional |
Service account email | Enter the email address created during the Service Account creation process. It will resemble | Required |
Private key | Enter the x509 private key. This is the value created when creating the new private key when creating a new Service Account in the Google IAM & admin Console. It will begin with You can click the Choose a file on your computer link to import the key from a file on your computer. Use the file upload dialog that appears to locate the file that contains the key you want to use. | Required |
Drive Space | Select the level where the connection should be made. My Drive: This is the default entry. When selected, the connection will be made at the "My Drive" (the highest) level of the account. Unorganized: Selecting this option creates the connection to the unorganized content in the account. Unorganized files are files that are orphaned. This means the file exists but isn’t a part of a file structure. This happens when parent folders get deleted. These files can only be found by searching the drive for "is:unorganized owner:me." Shared with me: This creates the connection to the shared content (content available through the "Shared with me" menu option within the account). | |
Subject email | Enter the email address for the account whose data will be transferred. This is the "sub" claim on the JSON Web Token that SkySync will use to connect with Google Workspace. If you create a job using impersonation (“run as”), that setting will override the account added here. | Required |
Domain | Enter the target domain name. For example, If you do not include the domain for the Subject Email, you must include the domain in this field. This domain will then be used as the domain for the account. | Optional |
Token uri | Enter the custom authentication URI. If not supplied, the default is used - | Optional |
Preserve content type | Indicate if SkySync should try to preserve files in their original content type. This feature is mainly used for Google to Google transfers. The default value is No. This means that an upload content type is not specified. Most files will still preserve content types. However, Google native documents and Microsoft Office files will transfer as Microsoft Office files. Selecting Yes will preserve files in their original content type. Google native documents will transfer as Google native documents. Microsoft Office files will transfer as Microsoft Office files. | Optional |
Import as Google native documents | Indicate if SkySync should import Microsoft Office documents as Google documents. This feature is mainly used when transferring from any platform, such as Box to Google. The default value is No. This means Microsoft Office files will be preserved as their original content type. Selecting Yes will import all Microsoft Office files as Google native documents. | Optional |
Behavior when deleting files | Select the type of delete SkySync should perform when deleting items: Permanent or Soft. Soft delete is the default delete behavior; however, Permanent is the recommended behavior. A soft delete marks items as a deleted. You can still access them to restore or permanently delete the items. A permanent delete removes the items. This delete is not reversible. | Optional |
Allow file discovery | Indicate if files with shared links should be searchable. The default value is No. This means that only users with whom the file has been shared can find and access the file. Selecting Yes sets the "People can search for this file" setting in the file link settings to TRUE. This means any files with shared links can be found and accessed by any user through the search. | Optional |
Features and Limitations
Platforms all have unique features and limitations. SkySync’s transfer engine manages these differences between platforms and allows you to configure actions based on Job Policies and Behaviors. Utilize the Platform Comparison tool to see how your integration platforms may interact regarding features and limitations.
Files and Folders
Below is list of supported and unsupported features as well as additional file/folder restrictions.
Supported | Not Supported | Other Features and Limitations |
|---|---|---|
File size maximum: 5 TB | ||
Path length maximum: None | ||
Segment path length: 500 | ||
Restricted types: See Other Restrictions below. | ||
No leading spaces in file name/folder name | ||
No trailing spaces before or after file extensions | ||
Path Lengths
Google Workspace does not impose restrictions for the total path length.
Segment path lengths are limited to 500 character. Segments are delimited by a forward slash (/). For example, <max 500 characters>/<max 500 characters>.
Other Restrictions and Limitations
Google Workspace also has the following restrictions and limitations for content. SkySync will handle the content as indicated.
Non-Transferable File Types and Elements
The following file types and elements cannot be transferred.
Sites, Forms, Fusion Tables, My Maps and Google Workspace Marketplace are all files that are not transferable.
Comments in Docs, Sheets, and Slides are not transferable.
Google Docs
Native Google documents will be handled as indicated below.
Although some platforms such as Box and Dropbox support Google Docs, SkySync does not currently support transferring them to Google Workspace.
When transferring Google Docs from Google Workspace to another platform, SkySync will export the documents as Microsoft Office documents.
Google Forms, Fusion Tables, Sites and My Maps are not available for download in Google Workspace. This means SkySync is prevented from transferring these items. Expected behavior is the item will be flagged with the error message "IO Violation and message:Downloading content is not supported for file...".
Microsoft Office Documents
When transferring Microsoft Office documents to Google Workspace, you can choose to either keep their original format or import them as Google Docs when setting up the connection.
Create Connection | Multiple Domains
SkySync supports creating a connection with access to multiple domains within an enterprise.
Ensure to use an Admin account that has full access to the corresponding domains.
Omit the domain name when creating the connection.
Use the admin account as the subject / Subject email when creating the connection.
Create connection | SkySync API
The sample code below shows how to create a Google Workspace connection that uses impersonation. Make sure the following fields are set accordingly.
The id should be google-suite.
The client_email should be the Google Workspace Admin Service Account.
The subject should be the email for the user you would like to impersonate.
{
"name": "Google Workspace Service Account (Admin Connection)",
"type": "service_account",
"project_id": "your-project-id",
"platform": {
"id": "google-suite"
},
"auth": {
"private_key": "-----BEGIN PRIVATE KEY-----...-----END PRIVATE KEY-----\n",
"client_email": "jd-service@your-project-id.iam.gserviceaccount.com",
"client_id": "12345678901234567890",
"subject": "jdeveloper@example.com,"
"delete_behavior": "permanent"
}
}