An image file and cropping parameters from which a background image for this shared drive is set. This is a write only field; it can only be set on `drive.drives.update` requests that don't set `themeId`. When specified, all fields of the `backgroundImageFile` must be set.

The ID of an image file in Google Drive to use for the background image.

The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high.

The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image.

The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.

Output only. A short-lived link to this shared drive's background image.

Output only. Capabilities the current user has on this shared drive.

Output only. Whether the current user can add children to folders in this shared drive.

Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this shared drive.

Output only. Whether the current user can change the `domainUsersOnly` restriction of this shared drive.

Output only. Whether the current user can change the background of this shared drive.

Output only. Whether the current user can change the `driveMembersOnly` restriction of this shared drive.

Output only. Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this shared drive.

Output only. Whether the current user can comment on files in this shared drive.

Output only. Whether the current user can copy files in this shared drive.

Output only. Whether the current user can delete children from folders in this shared drive.

Output only. Whether the current user can delete this shared drive. Attempting to delete the shared drive may still fail if there are untrashed items inside the shared drive.

Output only. Whether the current user can download files in this shared drive.

Output only. Whether the current user can edit files in this shared drive

Output only. Whether the current user can list the children of folders in this shared drive.

Output only. Whether the current user can add members to this shared drive or remove them or change their role.

Output only. Whether the current user can read the revisions resource of files in this shared drive.

Output only. Whether the current user can rename files or folders in this shared drive.

Output only. Whether the current user can rename this shared drive.

Output only. Whether the current user can reset the shared drive restrictions to defaults.

Output only. Whether the current user can share files or folders in this shared drive.

Output only. Whether the current user can trash children from folders in this shared drive.

The color of this shared drive as an RGB hex string. It can only be set on a `drive.drives.update` request that does not set `themeId`.

The time at which the shared drive was created (RFC 3339 date-time).

Whether the shared drive is hidden from default view.

Output only. The ID of this shared drive which is also the ID of the top level folder of this shared drive.

Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#drive"`.

Output only. The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`.

A set of restrictions that apply to this shared drive or items inside this shared drive.

Whether administrative privileges on this shared drive are required to modify restrictions.

Whether the options to copy, print, or download files inside this shared drive, should be disabled for readers and commenters. When this restriction is set to `true`, it will override the similarly named field to `true` for any file inside this shared drive.

Whether access to this shared drive and items inside this shared drive is restricted to users of the domain to which this shared drive belongs. This restriction may be overridden by other sharing policies controlled outside of this shared drive.

Whether access to items inside this shared drive is restricted to its members.

If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders.

The ID of the theme from which the background image and color will be set. The set of possible `driveThemes` can be retrieved from a `drive.about.get` response. When not specified on a `drive.drives.create` request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set `colorRgb` or `backgroundImageFile`.

Drives

Files

Items

Google Drive

Download File

Get Connected Account Details

Upload File

Gets information about the user, the user's Drive, and system capabilities.

Drive About Get

Gets the starting pageToken for listing future changes.

Drive Changes Get Start Page Token

Lists the changes for a user or shared drive.

Drive Changes List

Drive Changes Watch

Stops watching resources through this channel.

Drive Channels Stop

Drive Comments List

Drive Comments Create

Drive Comments Get

Drive Comments Delete

Drive Comments Update

 Lists the user's shared drives. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for shared drives](/drive/api/guides/search-shareddrives) guide.

Drive Drives List

Drive Drives Create

Drive Drives Get

Permanently deletes a shared drive for which the user is an `organizer`. The shared drive cannot contain any untrashed items.

Drive Drives Delete

Drive Drives Update

Hides a shared drive from the default view.

Drive Drives Hide

Restores a shared drive to the default view.

Drive Drives Unhide

Creates a copy of a file and applies any requested updates with patch semantics.

Drive Files Copy

 Lists the user's files. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for files & folders](/drive/api/guides/search-files) guide. *Note:* This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results.

Drive Files List

 Creates a new file. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/drive/api/guides/manage-uploads). Apps creating shortcuts with `files.create` must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `name` property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `"name": "cat.jpg"` in the metadata. Subsequent `GET` requests include the read-only `fileExtension` property populated with the extension originally specified in the `title` property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with extension) based on the title. In cases where the extension is missing, Drive attempts to determine the extension based on the file's MIME type.

Drive Files Create

 Gets a file's metadata or content by ID. If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/drive/api/reference/rest/v3/files/export) instead. For more information, see [Download & export files](/drive/api/guides/manage-downloads).

Drive Files Get

Permanently deletes a file owned by the user without moving it to the trash. If the file belongs to a shared drive, the user must be an `organizer` on the parent folder. If the target is a folder, all descendants owned by the user are also deleted.

Drive Files Delete

 Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/drive/api/guides/manage-uploads).

Drive Files Update

Permanently deletes all of the user's trashed files.

Drive Files Empty Trash

Exports a Google Workspace document to the requested MIME type and returns exported byte content. Note that the exported content is limited to 10MB.

Drive Files Export

Generates a set of file IDs which can be provided in create or copy requests.

Drive Files Generate Ids

Drive Files List Labels

Modifies the set of labels applied to a file. Returns a list of the labels that were added or modified.

Drive Files Modify Labels

Drive Files Watch

Lists a file's or shared drive's permissions.

Drive Permissions List

Creates a permission for a file or shared drive. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.

Drive Permissions Create

Drive Permissions Get

Deletes a permission. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.

Drive Permissions Delete

Updates a permission with patch semantics. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.

Drive Permissions Update

Drive Replies List

Drive Replies Create

Drive Replies Get

Drive Replies Delete

Drive Replies Update

Gets a revision's metadata or content by ID.

Drive Revisions Get

Permanently deletes a file version. You can only delete revisions for files with binary content in Google Drive, like images or videos. Revisions for other files, like Google Docs or Sheets, and the last remaining file version can't be deleted.

Drive Revisions Delete

Drive Revisions Update

Drive Revisions List

Drive Teamdrives List

Drive Teamdrives Create

Drive Teamdrives Get

Drive Teamdrives Delete

Drive Teamdrives Update

Dropbox

Microsoft Sharepoint

MS OneDrive

# Continuous Import of Files and Folders (Drive Items) to Your App

This scenario enables your application to continuously sync and download Files and Folders (Drive Items) from any external application to your app's API. It handles the initial import of Drive Items and keeps them synchronized when a drive item is created, updated, or deleted in the external application.

When receiving Files data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

1. **Initial Import**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page.
   - Integration.app transforms the output into a consistent format compatible with your API, allowing you to save the data efficiently.

2. **Continuous Sync**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.

3. **Download File**:
   - Make a single API request to start file download from external app, it will return download file URI, that you can use to download file from any source in the same way

Continuously Import Files and Folders to my App

Import files and folders, download files and receive created/updated or deleted events

AWS S3

# Continuous Import of Folders to Your App

This scenario enables your application to continuously sync Folders from any external application to your app's API. It handles the initial import of Folders and keeps them synchronized when a Folder is created, updated, or deleted in the external application.

When receiving Folders data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

1. **Initial Import**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page.
   - Integration.app transforms the output into a consistent format compatible with your API, allowing you to save the data efficiently.

2. **Continuous Sync**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.

Continuously Import Folders to my App

Import Folders and receive created/updated or deleted events

# Get all Folders

This scenario enables your application to get a complete list of Folders from any external application to your app's API in the same way. 

When receiving Folders data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

You will call a Integration.app REST API endpoint or SDK methods to retrieve a single page of Folders along with the `cursor` if next page is available.
Repeate this request in a loop from your code to retrieve all Folders page by page.


Get all Folders

Imports all Folders from any external application to your App.

# Realtime Full two-way Sync of Folders

This scenario enables your application to fully sync Folders between your app and any external application in both directions. It handles the initial import/export of Folders and then sends events when a Folder is created, updated, or deleted on any side, as close to real-time as possible.

Folder fields will be mapped from your application's schema to the application-specific schema.

## How It Works

1. **Initial Sync**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page. Integration.app transforms the output into a consistent format compatible with your API, allowing you to save and match data efficiently.
   - Make another set of requests to create Folders in external app, if needed.

2. **Continuous Sync from External App**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events from external applications.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.


2. **Continuous Sync from Your App**:
   - You will get a single webhook URI that you will use to send events about created, updated, or deleted Folders to Integration.app.
   - Once send, Integration.app will map the webhook payload to the format supported by external application and send the correct request


Two-way realtime sync of Folders

Bi-directional realtime sync of Folders with records deduplication

# Download File


This scenario allows your application to download files from Box, Dropbox, Google Drive, OneDrive or Microsoft SharePoint.
File fields will be mapped from schema supported by your application to the application-specific schema

## How it works

1. **Download File**:
   - Call Integration.app REST API or SDK with file ID from external app.
   - When called, Integration.app retrieves the requested file from the original storage, and provides you with a temporary download link. This guarantees same interface for you for downloading files in the same way from any application

2. **Configuration options**:
    - You can get small files via Actions or use this action in Flow to download large files up to a few GBs.
    - Google drive: Since Google Drive supports Docs, Sheets, Slides and more in addition to uploaded files,
you can use an additional `exportAs` parameter to specify which MIME-type (out of [supported](https://developers.google.com/drive/api/guides/ref-export-formats)) you want to export the file to.
By default, we export Google Docs in the Microsoft Office formats (.docx, .xlsx, .pptx).


Download files from Box, Dropbox, Google Drive, OneDrive or Microsoft SharePoint.

# Continuous Import of Drives to Your App

This scenario enables your application to continuously sync Drives from any external application to your app's API. It handles the initial import of Drives and keeps them synchronized when a Drive is created, updated, or deleted in the external application.

When receiving Drives data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

1. **Initial Import**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page.
   - Integration.app transforms the output into a consistent format compatible with your API, allowing you to save the data efficiently.

2. **Continuous Sync**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.

Continuously Import Drives to my App

Import Drives and receive created/updated or deleted events

# Delete Folder

This scenario allows your application to delete a Folder from any external application. 
You will pass ID of the Folder you want to delete and Integration.app will handle the rest.

## How It Works

1. **Delete Folder API call**:
   - Call Integration.app REST API or SDK with ID of the Folder you want to delete and Integration.app will send the correct request to the external app.


Delete Folder

Deletes Folder in any external application

# Continuous Import of Drive Items to Your App

This scenario enables your application to continuously sync Drive Items from any external application to your app's API. It handles the initial import of Drive Items and keeps them synchronized when a Drive Item is created, updated, or deleted in the external application.

When receiving Drive Items data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

1. **Initial Import**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page.
   - Integration.app transforms the output into a consistent format compatible with your API, allowing you to save the data efficiently.

2. **Continuous Sync**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.

Continuously Import Drive Items to my App

Import Drive Items and receive created/updated or deleted events

# Delete Drive Item

This scenario allows your application to delete a Drive Item from any external application. 
You will pass ID of the Drive Item you want to delete and Integration.app will handle the rest.

## How It Works

1. **Delete Drive Item API call**:
   - Call Integration.app REST API or SDK with ID of the Drive Item you want to delete and Integration.app will send the correct request to the external app.


Delete Drive Item

Deletes Drive Item in any external application

# Get all Drive Items

This scenario enables your application to get a complete list of Drive Items from any external application to your app's API in the same way. 

When receiving Drive Items data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

You will call a Integration.app REST API endpoint or SDK methods to retrieve a single page of Drive Items along with the `cursor` if next page is available.
Repeate this request in a loop from your code to retrieve all Drive Items page by page.


Get all Drive Items

Imports all Drive Items from any external application to your App.

Salesforce

# Delete File

This scenario allows your application to delete a File from any external application. 
You will pass ID of the File you want to delete and Integration.app will handle the rest.

## How It Works

1. **Delete File API call**:
   - Call Integration.app REST API or SDK with ID of the File you want to delete and Integration.app will send the correct request to the external app.


Delete File

# Get all Drives

This scenario enables your application to get a complete list of Drives from any external application to your app's API in the same way. 

When receiving Drives data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

You will call a Integration.app REST API endpoint or SDK methods to retrieve a single page of Drives along with the `cursor` if next page is available.
Repeate this request in a loop from your code to retrieve all Drives page by page.


Get all Drives

Imports all Drives from any external application to your App.

# Realtime Full two-way Sync of Drives

This scenario enables your application to fully sync Drives between your app and any external application in both directions. It handles the initial import/export of Drives and then sends events when a Drive is created, updated, or deleted on any side, as close to real-time as possible.

Drive fields will be mapped from your application's schema to the application-specific schema.

## How It Works

1. **Initial Sync**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page. Integration.app transforms the output into a consistent format compatible with your API, allowing you to save and match data efficiently.
   - Make another set of requests to create Drives in external app, if needed.

2. **Continuous Sync from External App**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events from external applications.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.


2. **Continuous Sync from Your App**:
   - You will get a single webhook URI that you will use to send events about created, updated, or deleted Drives to Integration.app.
   - Once send, Integration.app will map the webhook payload to the format supported by external application and send the correct request


Two-way realtime sync of Drives

Bi-directional realtime sync of Drives with records deduplication

# Realtime Full two-way Sync of Drive Items

This scenario enables your application to fully sync Drive Items between your app and any external application in both directions. It handles the initial import/export of Drive Items and then sends events when a Drive Item is created, updated, or deleted on any side, as close to real-time as possible.

Drive Item fields will be mapped from your application's schema to the application-specific schema.

## How It Works

1. **Initial Sync**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page. Integration.app transforms the output into a consistent format compatible with your API, allowing you to save and match data efficiently.
   - Make another set of requests to create Drive Items in external app, if needed.

2. **Continuous Sync from External App**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events from external applications.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.


2. **Continuous Sync from Your App**:
   - You will get a single webhook URI that you will use to send events about created, updated, or deleted Drive Items to Integration.app.
   - Once send, Integration.app will map the webhook payload to the format supported by external application and send the correct request


Two-way realtime sync of Drive Items

Bi-directional realtime sync of Drive Items with records deduplication

# Realtime Full two-way Sync of Files

This scenario enables your application to fully sync Files between your app and any external application in both directions. It handles the initial import/export of Files and then sends events when a File is created, updated, or deleted on any side, as close to real-time as possible.

File fields will be mapped from your application's schema to the application-specific schema.

## How It Works

1. **Initial Sync**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page. Integration.app transforms the output into a consistent format compatible with your API, allowing you to save and match data efficiently.
   - Make another set of requests to create Files in external app, if needed.

2. **Continuous Sync from External App**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events from external applications.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.


2. **Continuous Sync from Your App**:
   - You will get a single webhook URI that you will use to send events about created, updated, or deleted Files to Integration.app.
   - Once send, Integration.app will map the webhook payload to the format supported by external application and send the correct request


Two-way realtime sync of Files

Bi-directional realtime sync of Files with records deduplication

# Get all Files

This scenario enables your application to get a complete list of Files from any external application to your app's API in the same way. 

When receiving Files data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

You will call a Integration.app REST API endpoint or SDK methods to retrieve a single page of Files along with the `cursor` if next page is available.
Repeate this request in a loop from your code to retrieve all Files page by page.


Get all Files

Imports all Files from any external application to your App.

Information about the user, the user's Drive, and system capabilities.

Whether the user has installed the requesting app.

Whether the user can create shared drives.

Deprecated: Use `canCreateDrives` instead.

A list of themes that are supported for shared drives.

The color of this theme as an RGB hex string.

A map of source MIME type to possible targets for all supported exports.

The currently supported folder colors as RGB hex strings.

A map of source MIME type to possible targets for all supported imports.

Identifies what kind of resource this is. Value: the fixed string `"drive#about"`.

A map of maximum import sizes by MIME type, in bytes.

The user's storage quota limits and usage. All fields are measured in bytes.

The usage limit, if applicable. This will not be present if the user has unlimited storage.

The usage by trashed files in Google Drive.

Deprecated: Use `driveThemes/backgroundImageLink` instead.

Deprecated: Use `driveThemes/colorRgb` instead.

Deprecated: Use `driveThemes/id` instead.

Output only. A plain text displayable name for this user.

Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.

Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`.

Output only. Whether this user is the requesting user.

Output only. The user's ID as visible in Permission resources.

Output only. A link to the user's profile photo, if available.

Field Name	API Key	Type
Query	query	object
Access Token	query.access_token	string
Alt	query.alt	string
Callback	query.callback	string
Fields	query.fields	string

Field Name	API Key	Type	Description
Kind	kind	string	Identifies what kind of resource this is. Value: the fixed string `"drive#about"`.
Storage Quota	storageQuota	object	The user's storage quota limits and usage. All fields are measured in bytes.
Limit	storageQuota.limit	string	The usage limit, if applicable. This will not be present if the user has unlimited storage.
Usage In Drive	storageQuota.usageInDrive	string	The usage by all files in Google Drive.
Usage In Drive Trash	storageQuota.usageInDriveTrash	string	The usage by trashed files in Google Drive.

Google Drive API Integration Profile

Drive About Get in Google Drive API

Build every single integration your customers need with AI