> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# google-drive-api
> Google Drive API
**Server path:** `/google-drive-api` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| --------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`google-drive-api_copy_file`](#google-drive-api_copy_file) | Creates a copy of a file and applies any requested updates with patch semantics. Folders cannot be copied. |
| [`google-drive-api_create_comment`](#google-drive-api_create_comment) | Creates a comment on a file. |
| [`google-drive-api_create_file`](#google-drive-api_create_file) | Creates a file. |
| [`google-drive-api_create_permission`](#google-drive-api_create_permission) | Creates a permission for a file or shared drive. For more information on creating permissions, see Share files, folders & drives. |
| [`google-drive-api_create_reply`](#google-drive-api_create_reply) | Creates a reply to a comment. |
| [`google-drive-api_delete_comment`](#google-drive-api_delete_comment) | Deletes a comment. |
| [`google-drive-api_delete_file`](#google-drive-api_delete_file) | 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. If the target is a folder, all descendants owned by the user are also deleted. |
| [`google-drive-api_delete_permission`](#google-drive-api_delete_permission) | Deletes a permission. |
| [`google-drive-api_delete_reply`](#google-drive-api_delete_reply) | Deletes a reply. |
| [`google-drive-api_export_file`](#google-drive-api_export_file) | Exports a Google Workspace document to the requested MIME type and returns exported byte content. Note that the exported content is limited to 10MB. |
| [`google-drive-api_get_about`](#google-drive-api_get_about) | Gets information about the user, the user's Drive, and system capabilities. |
| [`google-drive-api_get_comment`](#google-drive-api_get_comment) | Gets a comment by ID. |
| [`google-drive-api_get_file`](#google-drive-api_get_file) | Gets a file's metadata or content by ID. |
| [`google-drive-api_get_permission`](#google-drive-api_get_permission) | Gets a permission by ID. |
| [`google-drive-api_get_reply`](#google-drive-api_get_reply) | Gets a reply by ID. |
| [`google-drive-api_list_comments`](#google-drive-api_list_comments) | Lists a file's comments. |
| [`google-drive-api_list_files`](#google-drive-api_list_files) | Lists or searches files. |
| [`google-drive-api_list_permissions`](#google-drive-api_list_permissions) | Lists a file's or shared drive's permissions. |
| [`google-drive-api_list_replies`](#google-drive-api_list_replies) | Lists a comment's replies. |
| [`google-drive-api_update_comment`](#google-drive-api_update_comment) | Updates a comment with patch semantics. |
| [`google-drive-api_update_file`](#google-drive-api_update_file) | 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 change automatically, such as modifiedDate. This method supports patch semantics. |
| [`google-drive-api_update_permission`](#google-drive-api_update_permission) | Updates a permission with patch semantics. |
| [`google-drive-api_update_reply`](#google-drive-api_update_reply) | Updates a reply with patch semantics. |
***
## google-drive-api\_copy\_file
Creates a copy of a file and applies any requested updates with patch semantics. Folders cannot be copied.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------------ | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `alt` | string | No | — | Data format for the response. |
| `fields` | string | No | — | Selector specifying which fields to include in a partial response. |
| `key` | string | No | — | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
| `oauth_token` | string | No | — | OAuth 2.0 token for the current user. |
| `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. |
| `quotaUser` | string | No | — | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
| `userIp` | string | No | — | Deprecated. Please use quotaUser instead. |
| `fileId` | string | Yes | — | The ID of the file. |
| `enforceSingleParent` | boolean | No | — | Deprecated. Copying files into multiple folders is no longer supported. Use shortcuts instead. |
| `ignoreDefaultVisibility` | boolean | No | — | Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders. |
| `includeLabels` | string | No | — | A comma-separated list of IDs of labels to include in the labelInfo part of the response. |
| `includePermissionsForView` | string | No | — | Specifies which additional view's permissions to include in the response. Only 'published' is supported. |
| `keepRevisionForever` | boolean | No | — | Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions. |
| `ocrLanguage` | string | No | — | A language hint for OCR processing during image import (ISO 639-1 code). |
| `supportsAllDrives` | boolean | No | — | Whether the requesting application supports both My Drives and shared drives. |
| `supportsTeamDrives` | boolean | No | — | Deprecated use supportsAllDrives instead. |
| `appProperties` | object | No | — | A collection of arbitrary key-value pairs that are private to the requesting app. Entries with null values are cleared in update and copy requests. These properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with an OAuth 2 client ID. You cannot use an API key to retrieve private properties. |
| `capabilities` | object | No | — | Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user can take. |
| `contentHints` | object | No | — | Additional information about the content of the file. These fields are never populated in responses. |
| `contentRestrictions` | object\[] | No | — | Restrictions for accessing the content of the file. Only populated if such a restriction exists. |
| `copyRequiresWriterPermission` | boolean | No | — | Whether the options to copy, print, or download this file, should be disabled for readers and commenters. |
| `createdTime` | string | No | — | The time at which the file was created (RFC 3339 date-time). |
| `description` | string | No | — | A short description of the file. |
| `driveId` | string | No | — | ID of the shared drive the file resides in. Only populated for items in shared drives. |
| `explicitlyTrashed` | boolean | No | — | Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder. |
| `exportLinks` | object | No | — | Links for exporting Docs Editors files to specific formats. |
| `fileExtension` | string | No | — | The final component of fullFileExtension. This is only available for files with binary content in Google Drive. |
| `folderColorRgb` | string | No | — | The color for a folder or shortcut to a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource. If an unsupported color is specified, the closest color in the palette will be used instead. |
| `fullFileExtension` | string | No | — | The full file extension extracted from the name field. Can contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive. This is automatically updated when the name field changes, however it's not cleared if the new name does not contain a valid extension. |
| `hasAugmentedPermissions` | boolean | No | — | Whether there are permissions directly on this file. This field is only populated for items in shared drives. |
| `hasThumbnail` | boolean | No | — | Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field. |
| `headRevisionId` | string | No | — | The ID of the file's head revision. This is only available for files with binary content in Google Drive. |
| `iconLink` | string | No | — | A static, unauthenticated link to the file's icon. |
| `id` | string | No | — | The ID of the file. |
| `imageMediaMetadata` | object | No | — | Additional metadata about image media, if available. |
| `isAppAuthorized` | boolean | No | — | Whether the requesting app created or opened the file. |
| `kind` | string | No | — | Identifies what kind of resource this is. Value: the fixed string "drive#file". |
| `labelInfo` | object | No | — | An overview of the labels on the file. |
| `lastModifyingUser` | object | No | — | Information about a Drive user. |
| `linkShareMetadata` | object | No | — | Contains details about the link URLs that clients are using to refer to this item. |
| `md5Checksum` | string | No | — | The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive. |
| `mimeType` | string | No | — | The MIME type of the file. Google Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource. |
| `modifiedByMe` | boolean | No | — | Whether this user has modified the file. |
| `modifiedByMeTime` | string | No | — | The last time the user modified the file (RFC 3339 date-time). |
| `modifiedTime` | string | No | — | The last time anyone modified the file (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user. |
| `name` | string | No | — | The name of the file. This isn't necessarily unique within a folder. Note that for immutable items such as the top-level folders of shared drives, My Drive root folder, and Application Data folder the name is constant. |
| `originalFilename` | string | No | — | The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive. |
| `ownedByMe` | boolean | No | — | Whether the user owns the file. Not populated for items in shared drives. |
| `owners` | object\[] | No | — | The owner of this file. Only certain legacy files might have more than one owner. This field isn't populated for items in shared drives. |
| `parents` | string\[] | No | — | The IDs of the parent folders that contain the file. If not specified as part of a create request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests must use the addParents and removeParents parameters to modify the parents list. |
| `permissionIds` | string\[] | No | — | List of permission IDs for users with access to this file. |
| `permissions` | object\[] | No | — | The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives. |
| `properties` | object | No | — | A collection of arbitrary key-value pairs that are visible to all apps. Entries with null values are cleared in update and copy requests. |
| `quotaBytesUsed` | string | No | — | The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled. |
| `resourceKey` | string | No | — | A key needed to access the item via a shared link. |
| `sha1Checksum` | string | No | — | The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files. |
| `sha256Checksum` | string | No | — | The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files. |
| `shared` | boolean | No | — | Whether the file has been shared. Not populated for items in shared drives. |
| `sharedWithMeTime` | string | No | — | The time at which the file was shared with the user, if applicable (RFC 3339 date-time). |
| `sharingUser` | object | No | — | Information about a Drive user. |
| `shortcutDetails` | object | No | — | Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut. |
| `size` | string | No | — | The size of the file's content in bytes. This field is populated for files with binary content stored in Google Drive and for Docs Editors files; it's not populated for shortcuts or folders. |
| `spaces` | string\[] | No | — | The list of spaces that contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'. |
| `starred` | boolean | No | — | Whether the user has starred the file. |
| `teamDriveId` | string | No | — | Deprecated - use driveId instead. |
| `thumbnailLink` | string | No | — | A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in Files.thumbnailLink must be fetched using a credentialed request. |
| `thumbnailVersion` | string | No | — | The thumbnail version for use in thumbnail cache invalidation. |
| `trashed` | boolean | No | — | Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner can trash a file. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file. |
| `trashedTime` | string | No | — | The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives. |
| `trashingUser` | object | No | — | Information about a Drive user. |
| `version` | string | No | — | A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user. |
| `videoMediaMetadata` | object | No | — | Additional metadata about video media. This might not be available immediately upon upload. |
| `viewedByMe` | boolean | No | — | Whether this user has viewed the file. |
| `viewedByMeTime` | string | No | — | The last time the user viewed the file (RFC 3339 date-time). |
| `viewersCanCopyContent` | boolean | No | — | Deprecated - use copyRequiresWriterPermission instead. |
| `webContentLink` | string | No | — | A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive. |
| `webViewLink` | string | No | — | A link for opening the file in a relevant Google editor or viewer in a browser. |
| `writersCanShare` | boolean | No | — | Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters."
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead."
},
"fileId": {
"type": "string",
"description": "The ID of the file."
},
"enforceSingleParent": {
"type": "boolean",
"description": "Deprecated. Copying files into multiple folders is no longer supported. Use shortcuts instead."
},
"ignoreDefaultVisibility": {
"type": "boolean",
"description": "Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders."
},
"includeLabels": {
"type": "string",
"description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response."
},
"includePermissionsForView": {
"type": "string",
"description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported."
},
"keepRevisionForever": {
"type": "boolean",
"description": "Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions."
},
"ocrLanguage": {
"type": "string",
"description": "A language hint for OCR processing during image import (ISO 639-1 code)."
},
"supportsAllDrives": {
"type": "boolean",
"description": "Whether the requesting application supports both My Drives and shared drives."
},
"supportsTeamDrives": {
"type": "boolean",
"description": "Deprecated use supportsAllDrives instead."
},
"appProperties": {
"type": "object",
"description": "A collection of arbitrary key-value pairs that are private to the requesting app. Entries with null values are cleared in update and copy requests. These properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with an OAuth 2 client ID. You cannot use an API key to retrieve private properties."
},
"capabilities": {
"type": "object",
"description": "Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user can take.",
"properties": {
"canAcceptOwnership": {
"type": "boolean",
"description": "Whether the current user is the pending owner of the file. Not populated for shared drive files."
},
"canAddChildren": {
"type": "boolean",
"description": "Whether the current user can add children to this folder. This is always false when the item isn't a folder."
},
"canAddFolderFromAnotherDrive": {
"type": "boolean",
"description": "Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item isn't a folder. Only populated for items in shared drives."
},
"canAddMyDriveParent": {
"type": "boolean",
"description": "Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files."
},
"canChangeCopyRequiresWriterPermission": {
"type": "boolean",
"description": "Whether the current user can change the copyRequiresWriterPermission restriction of this file."
},
"canChangeSecurityUpdateEnabled": {
"type": "boolean",
"description": "Whether the current user can change the securityUpdateEnabled field on link share metadata."
},
"canChangeViewersCanCopyContent": {
"type": "boolean",
"description": "Deprecated"
},
"canComment": {
"type": "boolean",
"description": "Whether the current user can comment on this file."
},
"canCopy": {
"type": "boolean",
"description": "Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it's not a folder."
},
"canDelete": {
"type": "boolean",
"description": "Whether the current user can delete this file."
},
"canDeleteChildren": {
"type": "boolean",
"description": "Whether the current user can delete children of this folder. This is false when the item isn't a folder. Only populated for items in shared drives."
},
"canDownload": {
"type": "boolean",
"description": "Whether the current user can download this file."
},
"canEdit": {
"type": "boolean",
"description": "Whether the current user can edit this file. Other factors might limit the type of changes a user can make to a file. For example, see canChangeCopyRequiresWriterPermission or canModifyContent."
},
"canListChildren": {
"type": "boolean",
"description": "Whether the current user can list the children of this folder. This is always false when the item isn't a folder."
},
"canModifyContent": {
"type": "boolean",
"description": "Whether the current user can modify the content of this file."
},
"canModifyContentRestriction": {
"type": "boolean",
"description": "Whether the current user can modify restrictions on content of this file."
},
"canModifyLabels": {
"type": "boolean",
"description": "Whether the current user can modify the labels on this file."
},
"canMoveChildrenOutOfDrive": {
"type": "boolean",
"description": "Whether the current user can move children of this folder outside of the shared drive. This is false when the item isn't a folder. Only populated for items in shared drives."
},
"canMoveChildrenOutOfTeamDrive": {
"type": "boolean",
"description": "Deprecated - use canMoveChildrenOutOfDrive instead."
},
"canMoveChildrenWithinDrive": {
"type": "boolean",
"description": "Whether the current user can move children of this folder within this shared drive or My Drive. This is false when the item isn't a folder. Note that a request to move the child might still fail depending on the current user's access to the child and to the destination folder."
},
"canMoveChildrenWithinTeamDrive": {
"type": "boolean",
"description": "Deprecated - use canMoveChildrenWithinDrive instead."
},
"canMoveItemIntoTeamDrive": {
"type": "boolean",
"description": "Deprecated - use canMoveItemOutOfDrive instead."
},
"canMoveItemOutOfDrive": {
"type": "boolean",
"description": "Whether the current user can move this item outside of this shared drive or My Drive by changing its parent. Note that a request to change the parent of the item might still fail depending on the new parent that's being added."
},
"canMoveItemOutOfTeamDrive": {
"type": "boolean",
"description": "Deprecated - use canMoveItemOutOfDrive instead."
},
"canMoveItemWithinDrive": {
"type": "boolean",
"description": "Whether the current user can move this item within this shared drive or My Drive. Note that a request to change the parent of the item might still fail depending on the new parent that's being added and the parent that's being removed."
},
"canMoveItemWithinTeamDrive": {
"type": "boolean",
"description": "Deprecated - use canMoveItemWithinDrive instead."
},
"canMoveTeamDriveItem": {
"type": "boolean",
"description": "Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead."
},
"canReadDrive": {
"type": "boolean",
"description": "Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives."
},
"canReadLabels": {
"type": "boolean",
"description": "Whether the current user can read the labels on this file."
},
"canReadRevisions": {
"type": "boolean",
"description": "Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it's not a folder, can be read."
},
"canReadTeamDrive": {
"type": "boolean",
"description": "Deprecated - use canReadDrive instead."
},
"canRemoveChildren": {
"type": "boolean",
"description": "Whether the current user can remove children from this folder. This is always false when the item isn't a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead."
},
"canRemoveMyDriveParent": {
"type": "boolean",
"description": "Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files."
},
"canRename": {
"type": "boolean",
"description": "Whether the current user can rename this file."
},
"canShare": {
"type": "boolean",
"description": "Whether the current user can modify the sharing settings for this file."
},
"canTrash": {
"type": "boolean",
"description": "Whether the current user can move this file to trash."
},
"canTrashChildren": {
"type": "boolean",
"description": "Whether the current user can trash children of this folder. This is false when the item isn't a folder. Only populated for items in shared drives."
},
"canUntrash": {
"type": "boolean",
"description": "Whether the current user can restore this file from trash."
}
}
},
"contentHints": {
"type": "object",
"description": "Additional information about the content of the file. These fields are never populated in responses.",
"properties": {
"indexableText": {
"type": "string",
"description": "Text to be indexed for the file to improve fullText queries. This is limited to 128 KB in length and might contain HTML elements. For more information, see Manage file metadata."
},
"thumbnail": {
"type": "object",
"description": "A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail."
}
}
},
"contentRestrictions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"readOnly": {
"type": "boolean",
"description": "Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified."
},
"reason": {
"type": "string",
"description": "Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true."
},
"restrictingUser": {
"type": "object",
"description": "Information about a Drive user."
},
"restrictionTime": {
"type": "string",
"format": "date-time",
"description": "The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true."
},
"type": {
"type": "string",
"description": "The type of the content restriction. Currently the only possible value is globalContentRestriction."
}
}
},
"description": "Restrictions for accessing the content of the file. Only populated if such a restriction exists."
},
"copyRequiresWriterPermission": {
"type": "boolean",
"description": "Whether the options to copy, print, or download this file, should be disabled for readers and commenters."
},
"createdTime": {
"type": "string",
"description": "The time at which the file was created (RFC 3339 date-time)."
},
"description": {
"type": "string",
"description": "A short description of the file."
},
"driveId": {
"type": "string",
"description": "ID of the shared drive the file resides in. Only populated for items in shared drives."
},
"explicitlyTrashed": {
"type": "boolean",
"description": "Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder."
},
"exportLinks": {
"type": "object",
"description": "Links for exporting Docs Editors files to specific formats."
},
"fileExtension": {
"type": "string",
"description": "The final component of fullFileExtension. This is only available for files with binary content in Google Drive."
},
"folderColorRgb": {
"type": "string",
"description": "The color for a folder or shortcut to a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource. If an unsupported color is specified, the closest color in the palette will be used instead."
},
"fullFileExtension": {
"type": "string",
"description": "The full file extension extracted from the name field. Can contain multiple concatenated extensions, such as \"tar.gz\". This is only available for files with binary content in Google Drive. This is automatically updated when the name field changes, however it's not cleared if the new name does not contain a valid extension."
},
"hasAugmentedPermissions": {
"type": "boolean",
"description": "Whether there are permissions directly on this file. This field is only populated for items in shared drives."
},
"hasThumbnail": {
"type": "boolean",
"description": "Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field."
},
"headRevisionId": {
"type": "string",
"description": "The ID of the file's head revision. This is only available for files with binary content in Google Drive."
},
"iconLink": {
"type": "string",
"description": "A static, unauthenticated link to the file's icon."
},
"id": {
"type": "string",
"description": "The ID of the file."
},
"imageMediaMetadata": {
"type": "object",
"description": "Additional metadata about image media, if available.",
"properties": {
"aperture": {
"type": "number",
"description": "The aperture used to create the photo (f-number)."
},
"cameraMake": {
"type": "string",
"description": "The make of the camera used to create the photo."
},
"cameraModel": {
"type": "string",
"description": "The model of the camera used to create the photo."
},
"colorSpace": {
"type": "string",
"description": "The color space of the photo."
},
"exposureBias": {
"type": "number",
"description": "The exposure bias of the photo (APEX value)."
},
"exposureMode": {
"type": "string",
"description": "The exposure mode used to create the photo."
},
"exposureTime": {
"type": "number",
"description": "The length of the exposure, in seconds."
},
"flashUsed": {
"type": "boolean",
"description": "Whether a flash was used to create the photo."
},
"focalLength": {
"type": "number",
"description": "The focal length used to create the photo, in millimeters."
},
"height": {
"type": "integer",
"description": "The height of the image in pixels."
},
"isoSpeed": {
"type": "integer",
"description": "The ISO speed used to create the photo."
},
"lens": {
"type": "string",
"description": "The lens used to create the photo."
},
"location": {
"type": "object",
"description": "Geographic location information stored in the image."
},
"maxApertureValue": {
"type": "number",
"description": "The smallest f-number of the lens at the focal length used to create the photo (APEX value)."
},
"meteringMode": {
"type": "string",
"description": "The metering mode used to create the photo."
},
"rotation": {
"type": "integer",
"description": "The number of clockwise 90-degree rotations applied from the image's original orientation."
},
"sensor": {
"type": "string",
"description": "The type of sensor used to create the photo."
},
"subjectDistance": {
"type": "integer",
"description": "The distance to the subject of the photo, in meters."
},
"time": {
"type": "string",
"description": "The date and time the photo was taken (EXIF DateTime)."
},
"whiteBalance": {
"type": "string",
"description": "The white balance mode used to create the photo."
},
"width": {
"type": "integer",
"description": "The width of the image in pixels."
}
}
},
"isAppAuthorized": {
"type": "boolean",
"description": "Whether the requesting app created or opened the file."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"drive#file\"."
},
"labelInfo": {
"type": "object",
"description": "An overview of the labels on the file.",
"properties": {
"labels": {
"type": "array",
"items": {
"type": "object"
},
"description": "The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned."
}
}
},
"lastModifyingUser": {
"type": "object",
"description": "Information about a Drive user.",
"properties": {
"displayName": {
"type": "string",
"description": "A plain text displayable name for this user."
},
"emailAddress": {
"type": "string",
"description": "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."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"drive#user\"."
},
"me": {
"type": "boolean",
"description": "Whether this user is the requesting user."
},
"permissionId": {
"type": "string",
"description": "The user's ID as visible in Permission resources."
},
"photoLink": {
"type": "string",
"description": "A link to the user's profile photo, if available."
}
}
},
"linkShareMetadata": {
"type": "object",
"description": "Contains details about the link URLs that clients are using to refer to this item.",
"properties": {
"securityUpdateEligible": {
"type": "boolean",
"description": "Whether the file is eligible for security update."
},
"securityUpdateEnabled": {
"type": "boolean",
"description": "Whether the security update is enabled for this file."
}
}
},
"md5Checksum": {
"type": "string",
"description": "The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive."
},
"mimeType": {
"type": "string",
"description": "The MIME type of the file. Google Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource."
},
"modifiedByMe": {
"type": "boolean",
"description": "Whether this user has modified the file."
},
"modifiedByMeTime": {
"type": "string",
"description": "The last time the user modified the file (RFC 3339 date-time)."
},
"modifiedTime": {
"type": "string",
"description": "The last time anyone modified the file (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user."
},
"name": {
"type": "string",
"description": "The name of the file. This isn't necessarily unique within a folder. Note that for immutable items such as the top-level folders of shared drives, My Drive root folder, and Application Data folder the name is constant."
},
"originalFilename": {
"type": "string",
"description": "The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive."
},
"ownedByMe": {
"type": "boolean",
"description": "Whether the user owns the file. Not populated for items in shared drives."
},
"owners": {
"type": "array",
"items": {
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "A plain text displayable name for this user."
},
"emailAddress": {
"type": "string",
"description": "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."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"drive#user\"."
},
"me": {
"type": "boolean",
"description": "Whether this user is the requesting user."
},
"permissionId": {
"type": "string",
"description": "The user's ID as visible in Permission resources."
},
"photoLink": {
"type": "string",
"description": "A link to the user's profile photo, if available."
}
}
},
"description": "The owner of this file. Only certain legacy files might have more than one owner. This field isn't populated for items in shared drives."
},
"parents": {
"type": "array",
"items": {
"type": "string"
},
"description": "The IDs of the parent folders that contain the file. If not specified as part of a create request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests must use the addParents and removeParents parameters to modify the parents list."
},
"permissionIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of permission IDs for users with access to this file."
},
"permissions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"allowFileDiscovery": {
"type": "boolean",
"description": "Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone."
},
"deleted": {
"type": "boolean",
"description": "Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions."
},
"displayName": {
"type": "string",
"description": "The \"pretty\" name of the value of the permission. The following is a list of examples for each type of permission: - user - User's full name, as defined for their Google Account, such as \"Joe Smith.\" - group - Name of the Google Group, such as \"The Company Administrators.\" - domain - String domain name, such as \"your-company.com.\" - anyone - No displayName is present."
},
"domain": {
"type": "string",
"description": "The domain to which this permission refers. The following options are currently allowed: - The entire domain, such as \"your-company.com.\" - A target audience, such as \"ID.audience.googledomains.com.\""
},
"emailAddress": {
"type": "string",
"description": "The email address of the user or group to which this permission refers."
},
"expirationTime": {
"type": "string",
"format": "date-time",
"description": "The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They cannot be set on shared drive items. - They can only be set on user and group permissions. - The time must be in the future. - The time cannot be more than one year in the future."
},
"id": {
"type": "string",
"description": "The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"drive#permission\"."
},
"pendingOwner": {
"type": "boolean",
"description": "Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that aren't in a shared drive."
},
"permissionDetails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"inherited": {
"type": "boolean",
"description": "Whether this permission is inherited. This field is always populated. This is an output-only field."
},
"inheritedFrom": {
"type": "string",
"description": "The ID of the item from which this permission is inherited. This is an output-only field."
},
"permissionType": {
"type": "string",
"description": "The permission type for this user. While new values may be added in future, the following are currently allowed: - file - member"
},
"role": {
"type": "string",
"description": "The primary role for this user. While new values may be added in the future, the following are currently allowed: - organizer - fileOrganizer - writer - commenter - reader"
}
}
},
"description": "Details of whether the permissions on this shared drive item are inherited or are directly on this item. This is an output-only field that's present only for shared drive items."
},
"photoLink": {
"type": "string",
"description": "A link to the user's profile photo, if available."
},
"role": {
"type": "string",
"description": "The role granted by this permission. While new values may be supported in the future, the following are currently allowed: - owner - organizer - fileOrganizer - writer - commenter - reader"
},
"teamDrivePermissionDetails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"inherited": {
"type": "boolean",
"description": "Deprecated - use permissionDetails/inherited instead."
},
"inheritedFrom": {
"type": "string",
"description": "Deprecated - use permissionDetails/inheritedFrom instead."
},
"role": {
"type": "string",
"description": "Deprecated - use permissionDetails/role instead."
},
"teamDrivePermissionType": {
"type": "string",
"description": "Deprecated - use permissionDetails/permissionType instead."
}
}
},
"description": "Deprecated - use permissionDetails instead."
},
"type": {
"type": "string",
"description": "The type of the grantee. Valid values are: - user - group - domain - anyone When creating a permission, if type is user or group, you must provide an emailAddress for the user or group. When type is domain, you must provide a domain. There isn't extra information required for the anyone type."
},
"view": {
"type": "string",
"description": "Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value."
}
}
},
"description": "The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives."
},
"properties": {
"type": "object",
"description": "A collection of arbitrary key-value pairs that are visible to all apps. Entries with null values are cleared in update and copy requests."
},
"quotaBytesUsed": {
"type": "string",
"description": "The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled."
},
"resourceKey": {
"type": "string",
"description": "A key needed to access the item via a shared link."
},
"sha1Checksum": {
"type": "string",
"description": "The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files."
},
"sha256Checksum": {
"type": "string",
"description": "The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files."
},
"shared": {
"type": "boolean",
"description": "Whether the file has been shared. Not populated for items in shared drives."
},
"sharedWithMeTime": {
"type": "string",
"description": "The time at which the file was shared with the user, if applicable (RFC 3339 date-time)."
},
"sharingUser": {
"type": "object",
"description": "Information about a Drive user.",
"properties": {
"displayName": {
"type": "string",
"description": "A plain text displayable name for this user."
},
"emailAddress": {
"type": "string",
"description": "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."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"drive#user\"."
},
"me": {
"type": "boolean",
"description": "Whether this user is the requesting user."
},
"permissionId": {
"type": "string",
"description": "The user's ID as visible in Permission resources."
},
"photoLink": {
"type": "string",
"description": "A link to the user's profile photo, if available."
}
}
},
"shortcutDetails": {
"type": "object",
"description": "Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.",
"properties": {
"targetId": {
"type": "string",
"description": "The ID of the file that this shortcut points to."
},
"targetMimeType": {
"type": "string",
"description": "The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created."
},
"targetResourceKey": {
"type": "string",
"description": "The ResourceKey for the target file."
}
}
},
"size": {
"type": "string",
"description": "The size of the file's content in bytes. This field is populated for files with binary content stored in Google Drive and for Docs Editors files; it's not populated for shortcuts or folders."
},
"spaces": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of spaces that contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'."
},
"starred": {
"type": "boolean",
"description": "Whether the user has starred the file."
},
"teamDriveId": {
"type": "string",
"description": "Deprecated - use driveId instead."
},
"thumbnailLink": {
"type": "string",
"description": "A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in Files.thumbnailLink must be fetched using a credentialed request."
},
"thumbnailVersion": {
"type": "string",
"description": "The thumbnail version for use in thumbnail cache invalidation."
},
"trashed": {
"type": "boolean",
"description": "Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner can trash a file. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file."
},
"trashedTime": {
"type": "string",
"description": "The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives."
},
"trashingUser": {
"type": "object",
"description": "Information about a Drive user.",
"properties": {
"displayName": {
"type": "string",
"description": "A plain text displayable name for this user."
},
"emailAddress": {
"type": "string",
"description": "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."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"drive#user\"."
},
"me": {
"type": "boolean",
"description": "Whether this user is the requesting user."
},
"permissionId": {
"type": "string",
"description": "The user's ID as visible in Permission resources."
},
"photoLink": {
"type": "string",
"description": "A link to the user's profile photo, if available."
}
}
},
"version": {
"type": "string",
"description": "A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user."
},
"videoMediaMetadata": {
"type": "object",
"description": "Additional metadata about video media. This might not be available immediately upon upload.",
"properties": {
"durationMillis": {
"type": "string",
"description": "The duration of the video in milliseconds."
},
"height": {
"type": "integer",
"description": "The height of the video in pixels."
},
"width": {
"type": "integer",
"description": "The width of the video in pixels."
}
}
},
"viewedByMe": {
"type": "boolean",
"description": "Whether this user has viewed the file."
},
"viewedByMeTime": {
"type": "string",
"description": "The last time the user viewed the file (RFC 3339 date-time)."
},
"viewersCanCopyContent": {
"type": "boolean",
"description": "Deprecated - use copyRequiresWriterPermission instead."
},
"webContentLink": {
"type": "string",
"description": "A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive."
},
"webViewLink": {
"type": "string",
"description": "A link for opening the file in a relevant Google editor or viewer in a browser."
},
"writersCanShare": {
"type": "boolean",
"description": "Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives."
}
},
"required": [
"PCID",
"fileId"
]
}
```
***
## google-drive-api\_create\_comment
Creates a comment on a file.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `alt` | string | No | — | Data format for the response. |
| `fields` | string | No | — | Selector specifying which fields to include in a partial response. |
| `key` | string | No | — | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
| `oauth_token` | string | No | — | OAuth 2.0 token for the current user. |
| `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. |
| `quotaUser` | string | No | — | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
| `userIp` | string | No | — | Deprecated. Please use quotaUser instead. |
| `fileId` | string | Yes | — | The ID of the file. |
| `anchor` | string | No | — | A region of the document represented as a JSON string. For details on defining anchor properties, refer to Add comments and replies. |
| `author` | object | No | — | Information about a Drive user. |
| `content` | string | No | — | The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed. |
| `createdTime` | string | No | — | The time at which the comment was created (RFC 3339 date-time). |
| `deleted` | boolean | No | — | Whether the comment has been deleted. A deleted comment has no content. |
| `htmlContent` | string | No | — | The content of the comment with HTML formatting. |
| `id` | string | No | — | The ID of the comment. |
| `kind` | string | No | — | Identifies what kind of resource this is. Value: the fixed string "drive#comment". |
| `modifiedTime` | string | No | — | The last time the comment or any of its replies was modified (RFC 3339 date-time). |
| `quotedFileContent` | object | No | — | The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment. |
| `replies` | object\[] | No | — | The full list of replies to the comment in chronological order. |
| `resolved` | boolean | No | — | Whether the comment has been resolved by one of its replies. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters."
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead."
},
"fileId": {
"type": "string",
"description": "The ID of the file."
},
"anchor": {
"type": "string",
"description": "A region of the document represented as a JSON string. For details on defining anchor properties, refer to Add comments and replies."
},
"author": {
"type": "object",
"description": "Information about a Drive user.",
"properties": {
"displayName": {
"type": "string",
"description": "A plain text displayable name for this user."
},
"emailAddress": {
"type": "string",
"description": "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."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"drive#user\"."
},
"me": {
"type": "boolean",
"description": "Whether this user is the requesting user."
},
"permissionId": {
"type": "string",
"description": "The user's ID as visible in Permission resources."
},
"photoLink": {
"type": "string",
"description": "A link to the user's profile photo, if available."
}
}
},
"content": {
"type": "string",
"description": "The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed."
},
"createdTime": {
"type": "string",
"description": "The time at which the comment was created (RFC 3339 date-time)."
},
"deleted": {
"type": "boolean",
"description": "Whether the comment has been deleted. A deleted comment has no content."
},
"htmlContent": {
"type": "string",
"description": "The content of the comment with HTML formatting."
},
"id": {
"type": "string",
"description": "The ID of the comment."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"drive#comment\"."
},
"modifiedTime": {
"type": "string",
"description": "The last time the comment or any of its replies was modified (RFC 3339 date-time)."
},
"quotedFileContent": {
"type": "object",
"description": "The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment.",
"properties": {
"mimeType": {
"type": "string",
"description": "The MIME type of the quoted content."
},
"value": {
"type": "string",
"description": "The quoted content itself. This is interpreted as plain text if set through the API."
}
}
},
"replies": {
"type": "array",
"items": {
"type": "object",
"properties": {
"action": {
"type": "string",
"description": "The action the reply performed to the parent comment. Valid values are: - resolve - reopen"
},
"author": {
"type": "object",
"description": "Information about a Drive user."
},
"content": {
"type": "string",
"description": "The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified."
},
"createdTime": {
"type": "string",
"format": "date-time",
"description": "The time at which the reply was created (RFC 3339 date-time)."
},
"deleted": {
"type": "boolean",
"description": "Whether the reply has been deleted. A deleted reply has no content."
},
"htmlContent": {
"type": "string",
"description": "The content of the reply with HTML formatting."
},
"id": {
"type": "string",
"description": "The ID of the reply."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"drive#reply\"."
},
"modifiedTime": {
"type": "string",
"format": "date-time",
"description": "The last time the reply was modified (RFC 3339 date-time)."
}
}
},
"description": "The full list of replies to the comment in chronological order."
},
"resolved": {
"type": "boolean",
"description": "Whether the comment has been resolved by one of its replies."
}
},
"required": [
"PCID",
"fileId"
]
}
```
***
## google-drive-api\_create\_file
Creates a file.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------------ | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `alt` | string | No | — | Data format for the response. |
| `fields` | string | No | — | Selector specifying which fields to include in a partial response. |
| `key` | string | No | — | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
| `oauth_token` | string | No | — | OAuth 2.0 token for the current user. |
| `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. |
| `quotaUser` | string | No | — | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
| `userIp` | string | No | — | Deprecated. Please use quotaUser instead. |
| `enforceSingleParent` | boolean | No | — | Deprecated. Creating files in multiple folders is no longer supported. |
| `ignoreDefaultVisibility` | boolean | No | — | Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders. |
| `includeLabels` | string | No | — | A comma-separated list of IDs of labels to include in the labelInfo part of the response. |
| `includePermissionsForView` | string | No | — | Specifies which additional view's permissions to include in the response. Only 'published' is supported. |
| `keepRevisionForever` | boolean | No | — | Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions. |
| `ocrLanguage` | string | No | — | A language hint for OCR processing during image import (ISO 639-1 code). |
| `supportsAllDrives` | boolean | No | — | Whether the requesting application supports both My Drives and shared drives. |
| `supportsTeamDrives` | boolean | No | — | Deprecated use supportsAllDrives instead. |
| `useContentAsIndexableText` | boolean | No | — | Whether to use the uploaded content as indexable text. |
| `appProperties` | object | No | — | A collection of arbitrary key-value pairs that are private to the requesting app. Entries with null values are cleared in update and copy requests. These properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with an OAuth 2 client ID. You cannot use an API key to retrieve private properties. |
| `capabilities` | object | No | — | Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user can take. |
| `contentHints` | object | No | — | Additional information about the content of the file. These fields are never populated in responses. |
| `contentRestrictions` | object\[] | No | — | Restrictions for accessing the content of the file. Only populated if such a restriction exists. |
| `copyRequiresWriterPermission` | boolean | No | — | Whether the options to copy, print, or download this file, should be disabled for readers and commenters. |
| `createdTime` | string | No | — | The time at which the file was created (RFC 3339 date-time). |
| `description` | string | No | — | A short description of the file. |
| `driveId` | string | No | — | ID of the shared drive the file resides in. Only populated for items in shared drives. |
| `explicitlyTrashed` | boolean | No | — | Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder. |
| `exportLinks` | object | No | — | Links for exporting Docs Editors files to specific formats. |
| `fileExtension` | string | No | — | The final component of fullFileExtension. This is only available for files with binary content in Google Drive. |
| `folderColorRgb` | string | No | — | The color for a folder or shortcut to a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource. If an unsupported color is specified, the closest color in the palette will be used instead. |
| `fullFileExtension` | string | No | — | The full file extension extracted from the name field. Can contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive. This is automatically updated when the name field changes, however it's not cleared if the new name does not contain a valid extension. |
| `hasAugmentedPermissions` | boolean | No | — | Whether there are permissions directly on this file. This field is only populated for items in shared drives. |
| `hasThumbnail` | boolean | No | — | Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field. |
| `headRevisionId` | string | No | — | The ID of the file's head revision. This is only available for files with binary content in Google Drive. |
| `iconLink` | string | No | — | A static, unauthenticated link to the file's icon. |
| `id` | string | No | — | The ID of the file. |
| `imageMediaMetadata` | object | No | — | Additional metadata about image media, if available. |
| `isAppAuthorized` | boolean | No | — | Whether the requesting app created or opened the file. |
| `kind` | string | No | — | Identifies what kind of resource this is. Value: the fixed string "drive#file". |
| `labelInfo` | object | No | — | An overview of the labels on the file. |
| `lastModifyingUser` | object | No | — | Information about a Drive user. |
| `linkShareMetadata` | object | No | — | Contains details about the link URLs that clients are using to refer to this item. |
| `md5Checksum` | string | No | — | The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive. |
| `mimeType` | string | No | — | The MIME type of the file. Google Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource. |
| `modifiedByMe` | boolean | No | — | Whether this user has modified the file. |
| `modifiedByMeTime` | string | No | — | The last time the user modified the file (RFC 3339 date-time). |
| `modifiedTime` | string | No | — | The last time anyone modified the file (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user. |
| `name` | string | No | — | The name of the file. This isn't necessarily unique within a folder. Note that for immutable items such as the top-level folders of shared drives, My Drive root folder, and Application Data folder the name is constant. |
| `originalFilename` | string | No | — | The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive. |
| `ownedByMe` | boolean | No | — | Whether the user owns the file. Not populated for items in shared drives. |
| `owners` | object\[] | No | — | The owner of this file. Only certain legacy files might have more than one owner. This field isn't populated for items in shared drives. |
| `parents` | string\[] | No | — | The IDs of the parent folders that contain the file. If not specified as part of a create request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests must use the addParents and removeParents parameters to modify the parents list. |
| `permissionIds` | string\[] | No | — | List of permission IDs for users with access to this file. |
| `permissions` | object\[] | No | — | The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives. |
| `properties` | object | No | — | A collection of arbitrary key-value pairs that are visible to all apps. Entries with null values are cleared in update and copy requests. |
| `quotaBytesUsed` | string | No | — | The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled. |
| `resourceKey` | string | No | — | A key needed to access the item via a shared link. |
| `sha1Checksum` | string | No | — | The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files. |
| `sha256Checksum` | string | No | — | The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files. |
| `shared` | boolean | No | — | Whether the file has been shared. Not populated for items in shared drives. |
| `sharedWithMeTime` | string | No | — | The time at which the file was shared with the user, if applicable (RFC 3339 date-time). |
| `sharingUser` | object | No | — | Information about a Drive user. |
| `shortcutDetails` | object | No | — | Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut. |
| `size` | string | No | — | The size of the file's content in bytes. This field is populated for files with binary content stored in Google Drive and for Docs Editors files; it's not populated for shortcuts or folders. |
| `spaces` | string\[] | No | — | The list of spaces that contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'. |
| `starred` | boolean | No | — | Whether the user has starred the file. |
| `teamDriveId` | string | No | — | Deprecated - use driveId instead. |
| `thumbnailLink` | string | No | — | A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in Files.thumbnailLink must be fetched using a credentialed request. |
| `thumbnailVersion` | string | No | — | The thumbnail version for use in thumbnail cache invalidation. |
| `trashed` | boolean | No | — | Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner can trash a file. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file. |
| `trashedTime` | string | No | — | The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives. |
| `trashingUser` | object | No | — | Information about a Drive user. |
| `version` | string | No | — | A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user. |
| `videoMediaMetadata` | object | No | — | Additional metadata about video media. This might not be available immediately upon upload. |
| `viewedByMe` | boolean | No | — | Whether this user has viewed the file. |
| `viewedByMeTime` | string | No | — | The last time the user viewed the file (RFC 3339 date-time). |
| `viewersCanCopyContent` | boolean | No | — | Deprecated - use copyRequiresWriterPermission instead. |
| `webContentLink` | string | No | — | A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive. |
| `webViewLink` | string | No | — | A link for opening the file in a relevant Google editor or viewer in a browser. |
| `writersCanShare` | boolean | No | — | Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters."
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead."
},
"enforceSingleParent": {
"type": "boolean",
"description": "Deprecated. Creating files in multiple folders is no longer supported."
},
"ignoreDefaultVisibility": {
"type": "boolean",
"description": "Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders."
},
"includeLabels": {
"type": "string",
"description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response."
},
"includePermissionsForView": {
"type": "string",
"description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported."
},
"keepRevisionForever": {
"type": "boolean",
"description": "Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions."
},
"ocrLanguage": {
"type": "string",
"description": "A language hint for OCR processing during image import (ISO 639-1 code)."
},
"supportsAllDrives": {
"type": "boolean",
"description": "Whether the requesting application supports both My Drives and shared drives."
},
"supportsTeamDrives": {
"type": "boolean",
"description": "Deprecated use supportsAllDrives instead."
},
"useContentAsIndexableText": {
"type": "boolean",
"description": "Whether to use the uploaded content as indexable text."
},
"appProperties": {
"type": "object",
"description": "A collection of arbitrary key-value pairs that are private to the requesting app. Entries with null values are cleared in update and copy requests. These properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with an OAuth 2 client ID. You cannot use an API key to retrieve private properties."
},
"capabilities": {
"type": "object",
"description": "Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user can take.",
"properties": {
"canAcceptOwnership": {
"type": "boolean",
"description": "Whether the current user is the pending owner of the file. Not populated for shared drive files."
},
"canAddChildren": {
"type": "boolean",
"description": "Whether the current user can add children to this folder. This is always false when the item isn't a folder."
},
"canAddFolderFromAnotherDrive": {
"type": "boolean",
"description": "Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item isn't a folder. Only populated for items in shared drives."
},
"canAddMyDriveParent": {
"type": "boolean",
"description": "Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files."
},
"canChangeCopyRequiresWriterPermission": {
"type": "boolean",
"description": "Whether the current user can change the copyRequiresWriterPermission restriction of this file."
},
"canChangeSecurityUpdateEnabled": {
"type": "boolean",
"description": "Whether the current user can change the securityUpdateEnabled field on link share metadata."
},
"canChangeViewersCanCopyContent": {
"type": "boolean",
"description": "Deprecated"
},
"canComment": {
"type": "boolean",
"description": "Whether the current user can comment on this file."
},
"canCopy": {
"type": "boolean",
"description": "Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it's not a folder."
},
"canDelete": {
"type": "boolean",
"description": "Whether the current user can delete this file."
},
"canDeleteChildren": {
"type": "boolean",
"description": "Whether the current user can delete children of this folder. This is false when the item isn't a folder. Only populated for items in shared drives."
},
"canDownload": {
"type": "boolean",
"description": "Whether the current user can download this file."
},
"canEdit": {
"type": "boolean",
"description": "Whether the current user can edit this file. Other factors might limit the type of changes a user can make to a file. For example, see canChangeCopyRequiresWriterPermission or canModifyContent."
},
"canListChildren": {
"type": "boolean",
"description": "Whether the current user can list the children of this folder. This is always false when the item isn't a folder."
},
"canModifyContent": {
"type": "boolean",
"description": "Whether the current user can modify the content of this file."
},
"canModifyContentRestriction": {
"type": "boolean",
"description": "Whether the current user can modify restrictions on content of this file."
},
"canModifyLabels": {
"type": "boolean",
"description": "Whether the current user can modify the labels on this file."
},
"canMoveChildrenOutOfDrive": {
"type": "boolean",
"description": "Whether the current user can move children of this folder outside of the shared drive. This is false when the item isn't a folder. Only populated for items in shared drives."
},
"canMoveChildrenOutOfTeamDrive": {
"type": "boolean",
"description": "Deprecated - use canMoveChildrenOutOfDrive instead."
},
"canMoveChildrenWithinDrive": {
"type": "boolean",
"description": "Whether the current user can move children of this folder within this shared drive or My Drive. This is false when the item isn't a folder. Note that a request to move the child might still fail depending on the current user's access to the child and to the destination folder."
},
"canMoveChildrenWithinTeamDrive": {
"type": "boolean",
"description": "Deprecated - use canMoveChildrenWithinDrive instead."
},
"canMoveItemIntoTeamDrive": {
"type": "boolean",
"description": "Deprecated - use canMoveItemOutOfDrive instead."
},
"canMoveItemOutOfDrive": {
"type": "boolean",
"description": "Whether the current user can move this item outside of this shared drive or My Drive by changing its parent. Note that a request to change the parent of the item might still fail depending on the new parent that's being added."
},
"canMoveItemOutOfTeamDrive": {
"type": "boolean",
"description": "Deprecated - use canMoveItemOutOfDrive instead."
},
"canMoveItemWithinDrive": {
"type": "boolean",
"description": "Whether the current user can move this item within this shared drive or My Drive. Note that a request to change the parent of the item might still fail depending on the new parent that's being added and the parent that's being removed."
},
"canMoveItemWithinTeamDrive": {
"type": "boolean",
"description": "Deprecated - use canMoveItemWithinDrive instead."
},
"canMoveTeamDriveItem": {
"type": "boolean",
"description": "Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead."
},
"canReadDrive": {
"type": "boolean",
"description": "Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives."
},
"canReadLabels": {
"type": "boolean",
"description": "Whether the current user can read the labels on this file."
},
"canReadRevisions": {
"type": "boolean",
"description": "Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it's not a folder, can be read."
},
"canReadTeamDrive": {
"type": "boolean",
"description": "Deprecated - use canReadDrive instead."
},
"canRemoveChildren": {
"type": "boolean",
"description": "Whether the current user can remove children from this folder. This is always false when the item isn't a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead."
},
"canRemoveMyDriveParent": {
"type": "boolean",
"description": "Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files."
},
"canRename": {
"type": "boolean",
"description": "Whether the current user can rename this file."
},
"canShare": {
"type": "boolean",
"description": "Whether the current user can modify the sharing settings for this file."
},
"canTrash": {
"type": "boolean",
"description": "Whether the current user can move this file to trash."
},
"canTrashChildren": {
"type": "boolean",
"description": "Whether the current user can trash children of this folder. This is false when the item isn't a folder. Only populated for items in shared drives."
},
"canUntrash": {
"type": "boolean",
"description": "Whether the current user can restore this file from trash."
}
}
},
"contentHints": {
"type": "object",
"description": "Additional information about the content of the file. These fields are never populated in responses.",
"properties": {
"indexableText": {
"type": "string",
"description": "Text to be indexed for the file to improve fullText queries. This is limited to 128 KB in length and might contain HTML elements. For more information, see Manage file metadata."
},
"thumbnail": {
"type": "object",
"description": "A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail."
}
}
},
"contentRestrictions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"readOnly": {
"type": "boolean",
"description": "Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified."
},
"reason": {
"type": "string",
"description": "Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true."
},
"restrictingUser": {
"type": "object",
"description": "Information about a Drive user."
},
"restrictionTime": {
"type": "string",
"format": "date-time",
"description": "The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true."
},
"type": {
"type": "string",
"description": "The type of the content restriction. Currently the only possible value is globalContentRestriction."
}
}
},
"description": "Restrictions for accessing the content of the file. Only populated if such a restriction exists."
},
"copyRequiresWriterPermission": {
"type": "boolean",
"description": "Whether the options to copy, print, or download this file, should be disabled for readers and commenters."
},
"createdTime": {
"type": "string",
"description": "The time at which the file was created (RFC 3339 date-time)."
},
"description": {
"type": "string",
"description": "A short description of the file."
},
"driveId": {
"type": "string",
"description": "ID of the shared drive the file resides in. Only populated for items in shared drives."
},
"explicitlyTrashed": {
"type": "boolean",
"description": "Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder."
},
"exportLinks": {
"type": "object",
"description": "Links for exporting Docs Editors files to specific formats."
},
"fileExtension": {
"type": "string",
"description": "The final component of fullFileExtension. This is only available for files with binary content in Google Drive."
},
"folderColorRgb": {
"type": "string",
"description": "The color for a folder or shortcut to a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource. If an unsupported color is specified, the closest color in the palette will be used instead."
},
"fullFileExtension": {
"type": "string",
"description": "The full file extension extracted from the name field. Can contain multiple concatenated extensions, such as \"tar.gz\". This is only available for files with binary content in Google Drive. This is automatically updated when the name field changes, however it's not cleared if the new name does not contain a valid extension."
},
"hasAugmentedPermissions": {
"type": "boolean",
"description": "Whether there are permissions directly on this file. This field is only populated for items in shared drives."
},
"hasThumbnail": {
"type": "boolean",
"description": "Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field."
},
"headRevisionId": {
"type": "string",
"description": "The ID of the file's head revision. This is only available for files with binary content in Google Drive."
},
"iconLink": {
"type": "string",
"description": "A static, unauthenticated link to the file's icon."
},
"id": {
"type": "string",
"description": "The ID of the file."
},
"imageMediaMetadata": {
"type": "object",
"description": "Additional metadata about image media, if available.",
"properties": {
"aperture": {
"type": "number",
"description": "The aperture used to create the photo (f-number)."
},
"cameraMake": {
"type": "string",
"description": "The make of the camera used to create the photo."
},
"cameraModel": {
"type": "string",
"description": "The model of the camera used to create the photo."
},
"colorSpace": {
"type": "string",
"description": "The color space of the photo."
},
"exposureBias": {
"type": "number",
"description": "The exposure bias of the photo (APEX value)."
},
"exposureMode": {
"type": "string",
"description": "The exposure mode used to create the photo."
},
"exposureTime": {
"type": "number",
"description": "The length of the exposure, in seconds."
},
"flashUsed": {
"type": "boolean",
"description": "Whether a flash was used to create the photo."
},
"focalLength": {
"type": "number",
"description": "The focal length used to create the photo, in millimeters."
},
"height": {
"type": "integer",
"description": "The height of the image in pixels."
},
"isoSpeed": {
"type": "integer",
"description": "The ISO speed used to create the photo."
},
"lens": {
"type": "string",
"description": "The lens used to create the photo."
},
"location": {
"type": "object",
"description": "Geographic location information stored in the image."
},
"maxApertureValue": {
"type": "number",
"description": "The smallest f-number of the lens at the focal length used to create the photo (APEX value)."
},
"meteringMode": {
"type": "string",
"description": "The metering mode used to create the photo."
},
"rotation": {
"type": "integer",
"description": "The number of clockwise 90-degree rotations applied from the image's original orientation."
},
"sensor": {
"type": "string",
"description": "The type of sensor used to create the photo."
},
"subjectDistance": {
"type": "integer",
"description": "The distance to the subject of the photo, in meters."
},
"time": {
"type": "string",
"description": "The date and time the photo was taken (EXIF DateTime)."
},
"whiteBalance": {
"type": "string",
"description": "The white balance mode used to create the photo."
},
"width": {
"type": "integer",
"description": "The width of the image in pixels."
}
}
},
"isAppAuthorized": {
"type": "boolean",
"description": "Whether the requesting app created or opened the file."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"drive#file\"."
},
"labelInfo": {
"type": "object",
"description": "An overview of the labels on the file.",
"properties": {
"labels": {
"type": "array",
"items": {
"type": "object"
},
"description": "The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned."
}
}
},
"lastModifyingUser": {
"type": "object",
"description": "Information about a Drive user.",
"properties": {
"displayName": {
"type": "string",
"description": "A plain text displayable name for this user."
},
"emailAddress": {
"type": "string",
"description": "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."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"drive#user\"."
},
"me": {
"type": "boolean",
"description": "Whether this user is the requesting user."
},
"permissionId": {
"type": "string",
"description": "The user's ID as visible in Permission resources."
},
"photoLink": {
"type": "string",
"description": "A link to the user's profile photo, if available."
}
}
},
"linkShareMetadata": {
"type": "object",
"description": "Contains details about the link URLs that clients are using to refer to this item.",
"properties": {
"securityUpdateEligible": {
"type": "boolean",
"description": "Whether the file is eligible for security update."
},
"securityUpdateEnabled": {
"type": "boolean",
"description": "Whether the security update is enabled for this file."
}
}
},
"md5Checksum": {
"type": "string",
"description": "The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive."
},
"mimeType": {
"type": "string",
"description": "The MIME type of the file. Google Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource."
},
"modifiedByMe": {
"type": "boolean",
"description": "Whether this user has modified the file."
},
"modifiedByMeTime": {
"type": "string",
"description": "The last time the user modified the file (RFC 3339 date-time)."
},
"modifiedTime": {
"type": "string",
"description": "The last time anyone modified the file (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user."
},
"name": {
"type": "string",
"description": "The name of the file. This isn't necessarily unique within a folder. Note that for immutable items such as the top-level folders of shared drives, My Drive root folder, and Application Data folder the name is constant."
},
"originalFilename": {
"type": "string",
"description": "The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive."
},
"ownedByMe": {
"type": "boolean",
"description": "Whether the user owns the file. Not populated for items in shared drives."
},
"owners": {
"type": "array",
"items": {
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "A plain text displayable name for this user."
},
"emailAddress": {
"type": "string",
"description": "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."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"drive#user\"."
},
"me": {
"type": "boolean",
"description": "Whether this user is the requesting user."
},
"permissionId": {
"type": "string",
"description": "The user's ID as visible in Permission resources."
},
"photoLink": {
"type": "string",
"description": "A link to the user's profile photo, if available."
}
}
},
"description": "The owner of this file. Only certain legacy files might have more than one owner. This field isn't populated for items in shared drives."
},
"parents": {
"type": "array",
"items": {
"type": "string"
},
"description": "The IDs of the parent folders that contain the file. If not specified as part of a create request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests must use the addParents and removeParents parameters to modify the parents list."
},
"permissionIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of permission IDs for users with access to this file."
},
"permissions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"allowFileDiscovery": {
"type": "boolean",
"description": "Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone."
},
"deleted": {
"type": "boolean",
"description": "Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions."
},
"displayName": {
"type": "string",
"description": "The \"pretty\" name of the value of the permission. The following is a list of examples for each type of permission: - user - User's full name, as defined for their Google Account, such as \"Joe Smith.\" - group - Name of the Google Group, such as \"The Company Administrators.\" - domain - String domain name, such as \"your-company.com.\" - anyone - No displayName is present."
},
"domain": {
"type": "string",
"description": "The domain to which this permission refers. The following options are currently allowed: - The entire domain, such as \"your-company.com.\" - A target audience, such as \"ID.audience.googledomains.com.\""
},
"emailAddress": {
"type": "string",
"description": "The email address of the user or group to which this permission refers."
},
"expirationTime": {
"type": "string",
"format": "date-time",
"description": "The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They cannot be set on shared drive items. - They can only be set on user and group permissions. - The time must be in the future. - The time cannot be more than one year in the future."
},
"id": {
"type": "string",
"description": "The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"drive#permission\"."
},
"pendingOwner": {
"type": "boolean",
"description": "Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that aren't in a shared drive."
},
"permissionDetails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"inherited": {
"type": "boolean",
"description": "Whether this permission is inherited. This field is always populated. This is an output-only field."
},
"inheritedFrom": {
"type": "string",
"description": "The ID of the item from which this permission is inherited. This is an output-only field."
},
"permissionType": {
"type": "string",
"description": "The permission type for this user. While new values may be added in future, the following are currently allowed: - file - member"
},
"role": {
"type": "string",
"description": "The primary role for this user. While new values may be added in the future, the following are currently allowed: - organizer - fileOrganizer - writer - commenter - reader"
}
}
},
"description": "Details of whether the permissions on this shared drive item are inherited or are directly on this item. This is an output-only field that's present only for shared drive items."
},
"photoLink": {
"type": "string",
"description": "A link to the user's profile photo, if available."
},
"role": {
"type": "string",
"description": "The role granted by this permission. While new values may be supported in the future, the following are currently allowed: - owner - organizer - fileOrganizer - writer - commenter - reader"
},
"teamDrivePermissionDetails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"inherited": {
"type": "boolean",
"description": "Deprecated - use permissionDetails/inherited instead."
},
"inheritedFrom": {
"type": "string",
"description": "Deprecated - use permissionDetails/inheritedFrom instead."
},
"role": {
"type": "string",
"description": "Deprecated - use permissionDetails/role instead."
},
"teamDrivePermissionType": {
"type": "string",
"description": "Deprecated - use permissionDetails/permissionType instead."
}
}
},
"description": "Deprecated - use permissionDetails instead."
},
"type": {
"type": "string",
"description": "The type of the grantee. Valid values are: - user - group - domain - anyone When creating a permission, if type is user or group, you must provide an emailAddress for the user or group. When type is domain, you must provide a domain. There isn't extra information required for the anyone type."
},
"view": {
"type": "string",
"description": "Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value."
}
}
},
"description": "The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives."
},
"properties": {
"type": "object",
"description": "A collection of arbitrary key-value pairs that are visible to all apps. Entries with null values are cleared in update and copy requests."
},
"quotaBytesUsed": {
"type": "string",
"description": "The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled."
},
"resourceKey": {
"type": "string",
"description": "A key needed to access the item via a shared link."
},
"sha1Checksum": {
"type": "string",
"description": "The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files."
},
"sha256Checksum": {
"type": "string",
"description": "The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files."
},
"shared": {
"type": "boolean",
"description": "Whether the file has been shared. Not populated for items in shared drives."
},
"sharedWithMeTime": {
"type": "string",
"description": "The time at which the file was shared with the user, if applicable (RFC 3339 date-time)."
},
"sharingUser": {
"type": "object",
"description": "Information about a Drive user.",
"properties": {
"displayName": {
"type": "string",
"description": "A plain text displayable name for this user."
},
"emailAddress": {
"type": "string",
"description": "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."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"drive#user\"."
},
"me": {
"type": "boolean",
"description": "Whether this user is the requesting user."
},
"permissionId": {
"type": "string",
"description": "The user's ID as visible in Permission resources."
},
"photoLink": {
"type": "string",
"description": "A link to the user's profile photo, if available."
}
}
},
"shortcutDetails": {
"type": "object",
"description": "Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.",
"properties": {
"targetId": {
"type": "string",
"description": "The ID of the file that this shortcut points to."
},
"targetMimeType": {
"type": "string",
"description": "The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created."
},
"targetResourceKey": {
"type": "string",
"description": "The ResourceKey for the target file."
}
}
},
"size": {
"type": "string",
"description": "The size of the file's content in bytes. This field is populated for files with binary content stored in Google Drive and for Docs Editors files; it's not populated for shortcuts or folders."
},
"spaces": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of spaces that contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'."
},
"starred": {
"type": "boolean",
"description": "Whether the user has starred the file."
},
"teamDriveId": {
"type": "string",
"description": "Deprecated - use driveId instead."
},
"thumbnailLink": {
"type": "string",
"description": "A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in Files.thumbnailLink must be fetched using a credentialed request."
},
"thumbnailVersion": {
"type": "string",
"description": "The thumbnail version for use in thumbnail cache invalidation."
},
"trashed": {
"type": "boolean",
"description": "Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner can trash a file. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file."
},
"trashedTime": {
"type": "string",
"description": "The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives."
},
"trashingUser": {
"type": "object",
"description": "Information about a Drive user.",
"properties": {
"displayName": {
"type": "string",
"description": "A plain text displayable name for this user."
},
"emailAddress": {
"type": "string",
"description": "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."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"drive#user\"."
},
"me": {
"type": "boolean",
"description": "Whether this user is the requesting user."
},
"permissionId": {
"type": "string",
"description": "The user's ID as visible in Permission resources."
},
"photoLink": {
"type": "string",
"description": "A link to the user's profile photo, if available."
}
}
},
"version": {
"type": "string",
"description": "A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user."
},
"videoMediaMetadata": {
"type": "object",
"description": "Additional metadata about video media. This might not be available immediately upon upload.",
"properties": {
"durationMillis": {
"type": "string",
"description": "The duration of the video in milliseconds."
},
"height": {
"type": "integer",
"description": "The height of the video in pixels."
},
"width": {
"type": "integer",
"description": "The width of the video in pixels."
}
}
},
"viewedByMe": {
"type": "boolean",
"description": "Whether this user has viewed the file."
},
"viewedByMeTime": {
"type": "string",
"description": "The last time the user viewed the file (RFC 3339 date-time)."
},
"viewersCanCopyContent": {
"type": "boolean",
"description": "Deprecated - use copyRequiresWriterPermission instead."
},
"webContentLink": {
"type": "string",
"description": "A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive."
},
"webViewLink": {
"type": "string",
"description": "A link for opening the file in a relevant Google editor or viewer in a browser."
},
"writersCanShare": {
"type": "boolean",
"description": "Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives."
}
},
"required": [
"PCID"
]
}
```
***
## google-drive-api\_create\_permission
Creates a permission for a file or shared drive. For more information on creating permissions, see Share files, folders & drives.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `alt` | string | No | — | Data format for the response. |
| `fields` | string | No | — | Selector specifying which fields to include in a partial response. |
| `key` | string | No | — | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
| `oauth_token` | string | No | — | OAuth 2.0 token for the current user. |
| `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. |
| `quotaUser` | string | No | — | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
| `userIp` | string | No | — | Deprecated. Please use quotaUser instead. |
| `fileId` | string | Yes | — | The ID of the file or shared drive. |
| `emailMessage` | string | No | — | A plain text custom message to include in the notification email. |
| `enforceSingleParent` | boolean | No | — | Deprecated. See moveToNewOwnersRoot for details. |
| `moveToNewOwnersRoot` | boolean | No | — | This parameter will only take effect if the item is not in a shared drive and the request is attempting to transfer the ownership of the item. If set to true, the item will be moved to the new owner's My Drive root folder and all prior parents removed. If set to false, parents are not changed. |
| `sendNotificationEmail` | boolean | No | — | Whether to send a notification email when sharing to users or groups. This defaults to true for users and groups, and is not allowed for other requests. It must not be disabled for ownership transfers. |
| `supportsAllDrives` | boolean | No | — | Whether the requesting application supports both My Drives and shared drives. |
| `supportsTeamDrives` | boolean | No | — | Deprecated use supportsAllDrives instead. |
| `transferOwnership` | boolean | No | — | Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. File owners can only transfer ownership of files existing on My Drive. Files existing in a shared drive are owned by the organization that owns that shared drive. Ownership transfers are not supported for files and folders in shared drives. Organizers of a shared drive can move items from that shared drive into their My Drive which transfers the ownership to them. |
| `useDomainAdminAccess` | boolean | No | — | Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs. |
| `allowFileDiscovery` | boolean | No | — | Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone. |
| `deleted` | boolean | No | — | Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. |
| `displayName` | string | No | — | The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: - user - User's full name, as defined for their Google Account, such as "Joe Smith." - group - Name of the Google Group, such as "The Company Administrators." - domain - String domain name, such as "your-company.com." - anyone - No displayName is present. |
| `domain` | string | No | — | The domain to which this permission refers. The following options are currently allowed: - The entire domain, such as "your-company.com." - A target audience, such as "ID.audience.googledomains.com." |
| `emailAddress` | string | No | — | The email address of the user or group to which this permission refers. |
| `expirationTime` | string | No | — | The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They cannot be set on shared drive items. - They can only be set on user and group permissions. - The time must be in the future. - The time cannot be more than one year in the future. |
| `id` | string | No | — | The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values. |
| `kind` | string | No | — | Identifies what kind of resource this is. Value: the fixed string "drive#permission". |
| `pendingOwner` | boolean | No | — | Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that aren't in a shared drive. |
| `permissionDetails` | object\[] | No | — | Details of whether the permissions on this shared drive item are inherited or are directly on this item. This is an output-only field that's present only for shared drive items. |
| `photoLink` | string | No | — | A link to the user's profile photo, if available. |
| `role` | string | No | — | The role granted by this permission. While new values may be supported in the future, the following are currently allowed: - owner - organizer - fileOrganizer - writer - commenter - reader |
| `teamDrivePermissionDetails` | object\[] | No | — | Deprecated - use permissionDetails instead. |
| `type` | string | No | — | The type of the grantee. Valid values are: - user - group - domain - anyone When creating a permission, if type is user or group, you must provide an emailAddress for the user or group. When type is domain, you must provide a domain. There isn't extra information required for the anyone type. |
| `view` | string | No | — | Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters."
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead."
},
"fileId": {
"type": "string",
"description": "The ID of the file or shared drive."
},
"emailMessage": {
"type": "string",
"description": "A plain text custom message to include in the notification email."
},
"enforceSingleParent": {
"type": "boolean",
"description": "Deprecated. See moveToNewOwnersRoot for details."
},
"moveToNewOwnersRoot": {
"type": "boolean",
"description": "This parameter will only take effect if the item is not in a shared drive and the request is attempting to transfer the ownership of the item. If set to true, the item will be moved to the new owner's My Drive root folder and all prior parents removed. If set to false, parents are not changed."
},
"sendNotificationEmail": {
"type": "boolean",
"description": "Whether to send a notification email when sharing to users or groups. This defaults to true for users and groups, and is not allowed for other requests. It must not be disabled for ownership transfers."
},
"supportsAllDrives": {
"type": "boolean",
"description": "Whether the requesting application supports both My Drives and shared drives."
},
"supportsTeamDrives": {
"type": "boolean",
"description": "Deprecated use supportsAllDrives instead."
},
"transferOwnership": {
"type": "boolean",
"description": "Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. File owners can only transfer ownership of files existing on My Drive. Files existing in a shared drive are owned by the organization that owns that shared drive. Ownership transfers are not supported for files and folders in shared drives. Organizers of a shared drive can move items from that shared drive into their My Drive which transfers the ownership to them."
},
"useDomainAdminAccess": {
"type": "boolean",
"description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs."
},
"allowFileDiscovery": {
"type": "boolean",
"description": "Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone."
},
"deleted": {
"type": "boolean",
"description": "Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions."
},
"displayName": {
"type": "string",
"description": "The \"pretty\" name of the value of the permission. The following is a list of examples for each type of permission: - user - User's full name, as defined for their Google Account, such as \"Joe Smith.\" - group - Name of the Google Group, such as \"The Company Administrators.\" - domain - String domain name, such as \"your-company.com.\" - anyone - No displayName is present."
},
"domain": {
"type": "string",
"description": "The domain to which this permission refers. The following options are currently allowed: - The entire domain, such as \"your-company.com.\" - A target audience, such as \"ID.audience.googledomains.com.\""
},
"emailAddress": {
"type": "string",
"description": "The email address of the user or group to which this permission refers."
},
"expirationTime": {
"type": "string",
"description": "The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They cannot be set on shared drive items. - They can only be set on user and group permissions. - The time must be in the future. - The time cannot be more than one year in the future."
},
"id": {
"type": "string",
"description": "The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"drive#permission\"."
},
"pendingOwner": {
"type": "boolean",
"description": "Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that aren't in a shared drive."
},
"permissionDetails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"inherited": {
"type": "boolean",
"description": "Whether this permission is inherited. This field is always populated. This is an output-only field."
},
"inheritedFrom": {
"type": "string",
"description": "The ID of the item from which this permission is inherited. This is an output-only field."
},
"permissionType": {
"type": "string",
"description": "The permission type for this user. While new values may be added in future, the following are currently allowed: - file - member"
},
"role": {
"type": "string",
"description": "The primary role for this user. While new values may be added in the future, the following are currently allowed: - organizer - fileOrganizer - writer - commenter - reader"
}
}
},
"description": "Details of whether the permissions on this shared drive item are inherited or are directly on this item. This is an output-only field that's present only for shared drive items."
},
"photoLink": {
"type": "string",
"description": "A link to the user's profile photo, if available."
},
"role": {
"type": "string",
"description": "The role granted by this permission. While new values may be supported in the future, the following are currently allowed: - owner - organizer - fileOrganizer - writer - commenter - reader"
},
"teamDrivePermissionDetails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"inherited": {
"type": "boolean",
"description": "Deprecated - use permissionDetails/inherited instead."
},
"inheritedFrom": {
"type": "string",
"description": "Deprecated - use permissionDetails/inheritedFrom instead."
},
"role": {
"type": "string",
"description": "Deprecated - use permissionDetails/role instead."
},
"teamDrivePermissionType": {
"type": "string",
"description": "Deprecated - use permissionDetails/permissionType instead."
}
}
},
"description": "Deprecated - use permissionDetails instead."
},
"type": {
"type": "string",
"description": "The type of the grantee. Valid values are: - user - group - domain - anyone When creating a permission, if type is user or group, you must provide an emailAddress for the user or group. When type is domain, you must provide a domain. There isn't extra information required for the anyone type."
},
"view": {
"type": "string",
"description": "Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value."
}
},
"required": [
"PCID",
"fileId"
]
}
```
***
## google-drive-api\_create\_reply
Creates a reply to a comment.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `alt` | string | No | — | Data format for the response. |
| `fields` | string | No | — | Selector specifying which fields to include in a partial response. |
| `key` | string | No | — | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
| `oauth_token` | string | No | — | OAuth 2.0 token for the current user. |
| `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. |
| `quotaUser` | string | No | — | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
| `userIp` | string | No | — | Deprecated. Please use quotaUser instead. |
| `fileId` | string | Yes | — | The ID of the file. |
| `commentId` | string | Yes | — | The ID of the comment. |
| `action` | string | No | — | The action the reply performed to the parent comment. Valid values are: - resolve - reopen |
| `author` | object | No | — | Information about a Drive user. |
| `content` | string | No | — | The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified. |
| `createdTime` | string | No | — | The time at which the reply was created (RFC 3339 date-time). |
| `deleted` | boolean | No | — | Whether the reply has been deleted. A deleted reply has no content. |
| `htmlContent` | string | No | — | The content of the reply with HTML formatting. |
| `id` | string | No | — | The ID of the reply. |
| `kind` | string | No | — | Identifies what kind of resource this is. Value: the fixed string "drive#reply". |
| `modifiedTime` | string | No | — | The last time the reply was modified (RFC 3339 date-time). |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters."
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead."
},
"fileId": {
"type": "string",
"description": "The ID of the file."
},
"commentId": {
"type": "string",
"description": "The ID of the comment."
},
"action": {
"type": "string",
"description": "The action the reply performed to the parent comment. Valid values are: - resolve - reopen"
},
"author": {
"type": "object",
"description": "Information about a Drive user.",
"properties": {
"displayName": {
"type": "string",
"description": "A plain text displayable name for this user."
},
"emailAddress": {
"type": "string",
"description": "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."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"drive#user\"."
},
"me": {
"type": "boolean",
"description": "Whether this user is the requesting user."
},
"permissionId": {
"type": "string",
"description": "The user's ID as visible in Permission resources."
},
"photoLink": {
"type": "string",
"description": "A link to the user's profile photo, if available."
}
}
},
"content": {
"type": "string",
"description": "The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified."
},
"createdTime": {
"type": "string",
"description": "The time at which the reply was created (RFC 3339 date-time)."
},
"deleted": {
"type": "boolean",
"description": "Whether the reply has been deleted. A deleted reply has no content."
},
"htmlContent": {
"type": "string",
"description": "The content of the reply with HTML formatting."
},
"id": {
"type": "string",
"description": "The ID of the reply."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"drive#reply\"."
},
"modifiedTime": {
"type": "string",
"description": "The last time the reply was modified (RFC 3339 date-time)."
}
},
"required": [
"PCID",
"fileId",
"commentId"
]
}
```
***
## google-drive-api\_delete\_comment
Deletes a comment.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| `alt` | string | No | — | Data format for the response. |
| `fields` | string | No | — | Selector specifying which fields to include in a partial response. |
| `key` | string | No | — | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
| `oauth_token` | string | No | — | OAuth 2.0 token for the current user. |
| `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. |
| `quotaUser` | string | No | — | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
| `userIp` | string | No | — | Deprecated. Please use quotaUser instead. |
| `fileId` | string | Yes | — | The ID of the file. |
| `commentId` | string | Yes | — | The ID of the comment. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters."
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead."
},
"fileId": {
"type": "string",
"description": "The ID of the file."
},
"commentId": {
"type": "string",
"description": "The ID of the comment."
}
},
"required": [
"PCID",
"fileId",
"commentId"
]
}
```
***
## google-drive-api\_delete\_file
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. If the target is a folder, all descendants owned by the user are also deleted.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `alt` | string | No | — | Data format for the response. |
| `fields` | string | No | — | Selector specifying which fields to include in a partial response. |
| `key` | string | No | — | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
| `oauth_token` | string | No | — | OAuth 2.0 token for the current user. |
| `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. |
| `quotaUser` | string | No | — | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
| `userIp` | string | No | — | Deprecated. Please use quotaUser instead. |
| `fileId` | string | Yes | — | The ID of the file. |
| `enforceSingleParent` | boolean | No | — | Deprecated. If an item is not in a shared drive and its last parent is deleted but the item itself is not, the item will be placed under its owner's root. |
| `supportsAllDrives` | boolean | No | — | Whether the requesting application supports both My Drives and shared drives. |
| `supportsTeamDrives` | boolean | No | — | Deprecated use supportsAllDrives instead. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters."
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead."
},
"fileId": {
"type": "string",
"description": "The ID of the file."
},
"enforceSingleParent": {
"type": "boolean",
"description": "Deprecated. If an item is not in a shared drive and its last parent is deleted but the item itself is not, the item will be placed under its owner's root."
},
"supportsAllDrives": {
"type": "boolean",
"description": "Whether the requesting application supports both My Drives and shared drives."
},
"supportsTeamDrives": {
"type": "boolean",
"description": "Deprecated use supportsAllDrives instead."
}
},
"required": [
"PCID",
"fileId"
]
}
```
***
## google-drive-api\_delete\_permission
Deletes a permission.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `alt` | string | No | — | Data format for the response. |
| `fields` | string | No | — | Selector specifying which fields to include in a partial response. |
| `key` | string | No | — | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
| `oauth_token` | string | No | — | OAuth 2.0 token for the current user. |
| `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. |
| `quotaUser` | string | No | — | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
| `userIp` | string | No | — | Deprecated. Please use quotaUser instead. |
| `fileId` | string | Yes | — | The ID of the file or shared drive. |
| `permissionId` | string | Yes | — | The ID of the permission. |
| `supportsAllDrives` | boolean | No | — | Whether the requesting application supports both My Drives and shared drives. |
| `supportsTeamDrives` | boolean | No | — | Deprecated use supportsAllDrives instead. |
| `useDomainAdminAccess` | boolean | No | — | Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters."
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead."
},
"fileId": {
"type": "string",
"description": "The ID of the file or shared drive."
},
"permissionId": {
"type": "string",
"description": "The ID of the permission."
},
"supportsAllDrives": {
"type": "boolean",
"description": "Whether the requesting application supports both My Drives and shared drives."
},
"supportsTeamDrives": {
"type": "boolean",
"description": "Deprecated use supportsAllDrives instead."
},
"useDomainAdminAccess": {
"type": "boolean",
"description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs."
}
},
"required": [
"PCID",
"fileId",
"permissionId"
]
}
```
***
## google-drive-api\_delete\_reply
Deletes a reply.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| `alt` | string | No | — | Data format for the response. |
| `fields` | string | No | — | Selector specifying which fields to include in a partial response. |
| `key` | string | No | — | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
| `oauth_token` | string | No | — | OAuth 2.0 token for the current user. |
| `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. |
| `quotaUser` | string | No | — | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
| `userIp` | string | No | — | Deprecated. Please use quotaUser instead. |
| `fileId` | string | Yes | — | The ID of the file. |
| `commentId` | string | Yes | — | The ID of the comment. |
| `replyId` | string | Yes | — | The ID of the reply. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters."
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead."
},
"fileId": {
"type": "string",
"description": "The ID of the file."
},
"commentId": {
"type": "string",
"description": "The ID of the comment."
},
"replyId": {
"type": "string",
"description": "The ID of the reply."
}
},
"required": [
"PCID",
"fileId",
"commentId",
"replyId"
]
}
```
***
## google-drive-api\_export\_file
Exports a Google Workspace document to the requested MIME type and returns exported byte content. Note that the exported content is limited to 10MB.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| `alt` | string | No | — | Data format for the response. |
| `fields` | string | No | — | Selector specifying which fields to include in a partial response. |
| `key` | string | No | — | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
| `oauth_token` | string | No | — | OAuth 2.0 token for the current user. |
| `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. |
| `quotaUser` | string | No | — | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
| `userIp` | string | No | — | Deprecated. Please use quotaUser instead. |
| `fileId` | string | Yes | — | The ID of the file. |
| `mimeType` | string | Yes | — | The MIME type of the format requested for this export. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters."
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead."
},
"fileId": {
"type": "string",
"description": "The ID of the file."
},
"mimeType": {
"type": "string",
"description": "The MIME type of the format requested for this export."
}
},
"required": [
"PCID",
"fileId",
"mimeType"
]
}
```
***
## google-drive-api\_get\_about
Gets information about the user, the user's Drive, and system capabilities.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| `alt` | string | No | — | Data format for the response. |
| `fields` | string | No | — | Selector specifying which fields to include in a partial response. |
| `key` | string | No | — | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
| `oauth_token` | string | No | — | OAuth 2.0 token for the current user. |
| `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. |
| `quotaUser` | string | No | — | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
| `userIp` | string | No | — | Deprecated. Please use quotaUser instead. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters."
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead."
}
},
"required": [
"PCID"
]
}
```
***
## google-drive-api\_get\_comment
Gets a comment by ID.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| `alt` | string | No | — | Data format for the response. |
| `fields` | string | No | — | Selector specifying which fields to include in a partial response. |
| `key` | string | No | — | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
| `oauth_token` | string | No | — | OAuth 2.0 token for the current user. |
| `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. |
| `quotaUser` | string | No | — | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
| `userIp` | string | No | — | Deprecated. Please use quotaUser instead. |
| `fileId` | string | Yes | — | The ID of the file. |
| `commentId` | string | Yes | — | The ID of the comment. |
| `includeDeleted` | boolean | No | — | Whether to return deleted comments. Deleted comments will not include their original content. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters."
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead."
},
"fileId": {
"type": "string",
"description": "The ID of the file."
},
"commentId": {
"type": "string",
"description": "The ID of the comment."
},
"includeDeleted": {
"type": "boolean",
"description": "Whether to return deleted comments. Deleted comments will not include their original content."
}
},
"required": [
"PCID",
"fileId",
"commentId"
]
}
```
***
## google-drive-api\_get\_file
Gets a file's metadata or content by ID.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| `alt` | string | No | — | Data format for the response. |
| `fields` | string | No | — | Selector specifying which fields to include in a partial response. |
| `key` | string | No | — | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
| `oauth_token` | string | No | — | OAuth 2.0 token for the current user. |
| `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. |
| `quotaUser` | string | No | — | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
| `userIp` | string | No | — | Deprecated. Please use quotaUser instead. |
| `fileId` | string | Yes | — | The ID of the file. |
| `acknowledgeAbuse` | boolean | No | — | Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media. |
| `includeLabels` | string | No | — | A comma-separated list of IDs of labels to include in the labelInfo part of the response. |
| `includePermissionsForView` | string | No | — | Specifies which additional view's permissions to include in the response. Only 'published' is supported. |
| `supportsAllDrives` | boolean | No | — | Whether the requesting application supports both My Drives and shared drives. |
| `supportsTeamDrives` | boolean | No | — | Deprecated use supportsAllDrives instead. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters."
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead."
},
"fileId": {
"type": "string",
"description": "The ID of the file."
},
"acknowledgeAbuse": {
"type": "boolean",
"description": "Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media."
},
"includeLabels": {
"type": "string",
"description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response."
},
"includePermissionsForView": {
"type": "string",
"description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported."
},
"supportsAllDrives": {
"type": "boolean",
"description": "Whether the requesting application supports both My Drives and shared drives."
},
"supportsTeamDrives": {
"type": "boolean",
"description": "Deprecated use supportsAllDrives instead."
}
},
"required": [
"PCID",
"fileId"
]
}
```
***
## google-drive-api\_get\_permission
Gets a permission by ID.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `alt` | string | No | — | Data format for the response. |
| `fields` | string | No | — | Selector specifying which fields to include in a partial response. |
| `key` | string | No | — | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
| `oauth_token` | string | No | — | OAuth 2.0 token for the current user. |
| `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. |
| `quotaUser` | string | No | — | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
| `userIp` | string | No | — | Deprecated. Please use quotaUser instead. |
| `fileId` | string | Yes | — | The ID of the file. |
| `permissionId` | string | Yes | — | The ID of the permission. |
| `supportsAllDrives` | boolean | No | — | Whether the requesting application supports both My Drives and shared drives. |
| `supportsTeamDrives` | boolean | No | — | Deprecated use supportsAllDrives instead. |
| `useDomainAdminAccess` | boolean | No | — | Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters."
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead."
},
"fileId": {
"type": "string",
"description": "The ID of the file."
},
"permissionId": {
"type": "string",
"description": "The ID of the permission."
},
"supportsAllDrives": {
"type": "boolean",
"description": "Whether the requesting application supports both My Drives and shared drives."
},
"supportsTeamDrives": {
"type": "boolean",
"description": "Deprecated use supportsAllDrives instead."
},
"useDomainAdminAccess": {
"type": "boolean",
"description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs."
}
},
"required": [
"PCID",
"fileId",
"permissionId"
]
}
```
***
## google-drive-api\_get\_reply
Gets a reply by ID.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| `alt` | string | No | — | Data format for the response. |
| `fields` | string | No | — | Selector specifying which fields to include in a partial response. |
| `key` | string | No | — | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
| `oauth_token` | string | No | — | OAuth 2.0 token for the current user. |
| `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. |
| `quotaUser` | string | No | — | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
| `userIp` | string | No | — | Deprecated. Please use quotaUser instead. |
| `fileId` | string | Yes | — | The ID of the file. |
| `commentId` | string | Yes | — | The ID of the comment. |
| `replyId` | string | Yes | — | The ID of the reply. |
| `includeDeleted` | boolean | No | — | Whether to return deleted replies. Deleted replies will not include their original content. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters."
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead."
},
"fileId": {
"type": "string",
"description": "The ID of the file."
},
"commentId": {
"type": "string",
"description": "The ID of the comment."
},
"replyId": {
"type": "string",
"description": "The ID of the reply."
},
"includeDeleted": {
"type": "boolean",
"description": "Whether to return deleted replies. Deleted replies will not include their original content."
}
},
"required": [
"PCID",
"fileId",
"commentId",
"replyId"
]
}
```
***
## google-drive-api\_list\_comments
Lists a file's comments.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| `alt` | string | No | — | Data format for the response. |
| `fields` | string | No | — | Selector specifying which fields to include in a partial response. |
| `key` | string | No | — | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
| `oauth_token` | string | No | — | OAuth 2.0 token for the current user. |
| `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. |
| `quotaUser` | string | No | — | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
| `userIp` | string | No | — | Deprecated. Please use quotaUser instead. |
| `fileId` | string | Yes | — | The ID of the file. |
| `includeDeleted` | boolean | No | — | Whether to include deleted comments. Deleted comments will not include their original content. |
| `pageSize` | integer | No | — | The maximum number of comments to return per page. |
| `pageToken` | string | No | — | The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response. |
| `startModifiedTime` | string | No | — | The minimum value of 'modifiedTime' for the result comments (RFC 3339 date-time). |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters."
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead."
},
"fileId": {
"type": "string",
"description": "The ID of the file."
},
"includeDeleted": {
"type": "boolean",
"description": "Whether to include deleted comments. Deleted comments will not include their original content."
},
"pageSize": {
"type": "integer",
"description": "The maximum number of comments to return per page."
},
"pageToken": {
"type": "string",
"description": "The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response."
},
"startModifiedTime": {
"type": "string",
"description": "The minimum value of 'modifiedTime' for the result comments (RFC 3339 date-time)."
}
},
"required": [
"PCID",
"fileId"
]
}
```
***
## google-drive-api\_list\_files
Lists or searches files.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `alt` | string | No | — | Data format for the response. |
| `fields` | string | No | — | Selector specifying which fields to include in a partial response. |
| `key` | string | No | — | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
| `oauth_token` | string | No | — | OAuth 2.0 token for the current user. |
| `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. |
| `quotaUser` | string | No | — | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
| `userIp` | string | No | — | Deprecated. Please use quotaUser instead. |
| `corpora` | string | No | — | Groupings of files to which the query applies. Supported groupings are: 'user' (files created by, opened by, or shared directly with the user), 'drive' (files in the specified shared drive as indicated by the 'driveId'), 'domain' (files shared to the user's domain), and 'allDrives' (A combination of 'user' and 'drive' for all drives where the user is a member). When able, use 'user' or 'drive', instead of 'allDrives', for efficiency. |
| `corpus` | string | No | — | The source of files to list. Deprecated: use 'corpora' instead. |
| `driveId` | string | No | — | ID of the shared drive to search. |
| `includeItemsFromAllDrives` | boolean | No | — | Whether both My Drive and shared drive items should be included in results. |
| `includeLabels` | string | No | — | A comma-separated list of IDs of labels to include in the labelInfo part of the response. |
| `includePermissionsForView` | string | No | — | Specifies which additional view's permissions to include in the response. Only 'published' is supported. |
| `includeTeamDriveItems` | boolean | No | — | Deprecated use includeItemsFromAllDrives instead. |
| `orderBy` | string | No | — | A comma-separated list of sort keys. Valid keys are 'createdTime', 'folder', 'modifiedByMeTime', 'modifiedTime', 'name', 'name\_natural', 'quotaBytesUsed', 'recency', 'sharedWithMeTime', 'starred', and 'viewedByMeTime'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedTime desc,name. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored. |
| `pageSize` | integer | No | — | The maximum number of files to return per page. Partial or empty result pages are possible even before the end of the files list has been reached. |
| `pageToken` | string | No | — | The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response. |
| `q` | string | No | — | A query for filtering the file results. See the "Search for Files" guide for supported syntax. |
| `spaces` | string | No | — | A comma-separated list of spaces to query within the corpora. Supported values are 'drive' and 'appDataFolder'. |
| `supportsAllDrives` | boolean | No | — | Whether the requesting application supports both My Drives and shared drives. |
| `supportsTeamDrives` | boolean | No | — | Deprecated use supportsAllDrives instead. |
| `teamDriveId` | string | No | — | Deprecated use driveId instead. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters."
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead."
},
"corpora": {
"type": "string",
"description": "Groupings of files to which the query applies. Supported groupings are: 'user' (files created by, opened by, or shared directly with the user), 'drive' (files in the specified shared drive as indicated by the 'driveId'), 'domain' (files shared to the user's domain), and 'allDrives' (A combination of 'user' and 'drive' for all drives where the user is a member). When able, use 'user' or 'drive', instead of 'allDrives', for efficiency."
},
"corpus": {
"type": "string",
"description": "The source of files to list. Deprecated: use 'corpora' instead.",
"enum": [
"domain",
"user"
]
},
"driveId": {
"type": "string",
"description": "ID of the shared drive to search."
},
"includeItemsFromAllDrives": {
"type": "boolean",
"description": "Whether both My Drive and shared drive items should be included in results."
},
"includeLabels": {
"type": "string",
"description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response."
},
"includePermissionsForView": {
"type": "string",
"description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported."
},
"includeTeamDriveItems": {
"type": "boolean",
"description": "Deprecated use includeItemsFromAllDrives instead."
},
"orderBy": {
"type": "string",
"description": "A comma-separated list of sort keys. Valid keys are 'createdTime', 'folder', 'modifiedByMeTime', 'modifiedTime', 'name', 'name_natural', 'quotaBytesUsed', 'recency', 'sharedWithMeTime', 'starred', and 'viewedByMeTime'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedTime desc,name. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored."
},
"pageSize": {
"type": "integer",
"description": "The maximum number of files to return per page. Partial or empty result pages are possible even before the end of the files list has been reached."
},
"pageToken": {
"type": "string",
"description": "The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response."
},
"q": {
"type": "string",
"description": "A query for filtering the file results. See the \"Search for Files\" guide for supported syntax."
},
"spaces": {
"type": "string",
"description": "A comma-separated list of spaces to query within the corpora. Supported values are 'drive' and 'appDataFolder'."
},
"supportsAllDrives": {
"type": "boolean",
"description": "Whether the requesting application supports both My Drives and shared drives."
},
"supportsTeamDrives": {
"type": "boolean",
"description": "Deprecated use supportsAllDrives instead."
},
"teamDriveId": {
"type": "string",
"description": "Deprecated use driveId instead."
}
},
"required": [
"PCID"
]
}
```
***
## google-drive-api\_list\_permissions
Lists a file's or shared drive's permissions.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `alt` | string | No | — | Data format for the response. |
| `fields` | string | No | — | Selector specifying which fields to include in a partial response. |
| `key` | string | No | — | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
| `oauth_token` | string | No | — | OAuth 2.0 token for the current user. |
| `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. |
| `quotaUser` | string | No | — | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
| `userIp` | string | No | — | Deprecated. Please use quotaUser instead. |
| `fileId` | string | Yes | — | The ID of the file or shared drive. |
| `includePermissionsForView` | string | No | — | Specifies which additional view's permissions to include in the response. Only 'published' is supported. |
| `pageSize` | integer | No | — | The maximum number of permissions to return per page. When not set for files in a shared drive, at most 100 results will be returned. When not set for files that are not in a shared drive, the entire list will be returned. |
| `pageToken` | string | No | — | The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response. |
| `supportsAllDrives` | boolean | No | — | Whether the requesting application supports both My Drives and shared drives. |
| `supportsTeamDrives` | boolean | No | — | Deprecated use supportsAllDrives instead. |
| `useDomainAdminAccess` | boolean | No | — | Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters."
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead."
},
"fileId": {
"type": "string",
"description": "The ID of the file or shared drive."
},
"includePermissionsForView": {
"type": "string",
"description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported."
},
"pageSize": {
"type": "integer",
"description": "The maximum number of permissions to return per page. When not set for files in a shared drive, at most 100 results will be returned. When not set for files that are not in a shared drive, the entire list will be returned."
},
"pageToken": {
"type": "string",
"description": "The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response."
},
"supportsAllDrives": {
"type": "boolean",
"description": "Whether the requesting application supports both My Drives and shared drives."
},
"supportsTeamDrives": {
"type": "boolean",
"description": "Deprecated use supportsAllDrives instead."
},
"useDomainAdminAccess": {
"type": "boolean",
"description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs."
}
},
"required": [
"PCID",
"fileId"
]
}
```
***
## google-drive-api\_list\_replies
Lists a comment's replies.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| `alt` | string | No | — | Data format for the response. |
| `fields` | string | No | — | Selector specifying which fields to include in a partial response. |
| `key` | string | No | — | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
| `oauth_token` | string | No | — | OAuth 2.0 token for the current user. |
| `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. |
| `quotaUser` | string | No | — | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
| `userIp` | string | No | — | Deprecated. Please use quotaUser instead. |
| `fileId` | string | Yes | — | The ID of the file. |
| `commentId` | string | Yes | — | The ID of the comment. |
| `includeDeleted` | boolean | No | — | Whether to include deleted replies. Deleted replies will not include their original content. |
| `pageSize` | integer | No | — | The maximum number of replies to return per page. |
| `pageToken` | string | No | — | The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters."
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead."
},
"fileId": {
"type": "string",
"description": "The ID of the file."
},
"commentId": {
"type": "string",
"description": "The ID of the comment."
},
"includeDeleted": {
"type": "boolean",
"description": "Whether to include deleted replies. Deleted replies will not include their original content."
},
"pageSize": {
"type": "integer",
"description": "The maximum number of replies to return per page."
},
"pageToken": {
"type": "string",
"description": "The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response."
}
},
"required": [
"PCID",
"fileId",
"commentId"
]
}
```
***
## google-drive-api\_update\_comment
Updates a comment with patch semantics.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `alt` | string | No | — | Data format for the response. |
| `fields` | string | No | — | Selector specifying which fields to include in a partial response. |
| `key` | string | No | — | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
| `oauth_token` | string | No | — | OAuth 2.0 token for the current user. |
| `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. |
| `quotaUser` | string | No | — | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
| `userIp` | string | No | — | Deprecated. Please use quotaUser instead. |
| `fileId` | string | Yes | — | The ID of the file. |
| `commentId` | string | Yes | — | The ID of the comment. |
| `anchor` | string | No | — | A region of the document represented as a JSON string. For details on defining anchor properties, refer to Add comments and replies. |
| `author` | object | No | — | Information about a Drive user. |
| `content` | string | No | — | The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed. |
| `createdTime` | string | No | — | The time at which the comment was created (RFC 3339 date-time). |
| `deleted` | boolean | No | — | Whether the comment has been deleted. A deleted comment has no content. |
| `htmlContent` | string | No | — | The content of the comment with HTML formatting. |
| `id` | string | No | — | The ID of the comment. |
| `kind` | string | No | — | Identifies what kind of resource this is. Value: the fixed string "drive#comment". |
| `modifiedTime` | string | No | — | The last time the comment or any of its replies was modified (RFC 3339 date-time). |
| `quotedFileContent` | object | No | — | The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment. |
| `replies` | object\[] | No | — | The full list of replies to the comment in chronological order. |
| `resolved` | boolean | No | — | Whether the comment has been resolved by one of its replies. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters."
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead."
},
"fileId": {
"type": "string",
"description": "The ID of the file."
},
"commentId": {
"type": "string",
"description": "The ID of the comment."
},
"anchor": {
"type": "string",
"description": "A region of the document represented as a JSON string. For details on defining anchor properties, refer to Add comments and replies."
},
"author": {
"type": "object",
"description": "Information about a Drive user.",
"properties": {
"displayName": {
"type": "string",
"description": "A plain text displayable name for this user."
},
"emailAddress": {
"type": "string",
"description": "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."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"drive#user\"."
},
"me": {
"type": "boolean",
"description": "Whether this user is the requesting user."
},
"permissionId": {
"type": "string",
"description": "The user's ID as visible in Permission resources."
},
"photoLink": {
"type": "string",
"description": "A link to the user's profile photo, if available."
}
}
},
"content": {
"type": "string",
"description": "The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed."
},
"createdTime": {
"type": "string",
"description": "The time at which the comment was created (RFC 3339 date-time)."
},
"deleted": {
"type": "boolean",
"description": "Whether the comment has been deleted. A deleted comment has no content."
},
"htmlContent": {
"type": "string",
"description": "The content of the comment with HTML formatting."
},
"id": {
"type": "string",
"description": "The ID of the comment."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"drive#comment\"."
},
"modifiedTime": {
"type": "string",
"description": "The last time the comment or any of its replies was modified (RFC 3339 date-time)."
},
"quotedFileContent": {
"type": "object",
"description": "The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment.",
"properties": {
"mimeType": {
"type": "string",
"description": "The MIME type of the quoted content."
},
"value": {
"type": "string",
"description": "The quoted content itself. This is interpreted as plain text if set through the API."
}
}
},
"replies": {
"type": "array",
"items": {
"type": "object",
"properties": {
"action": {
"type": "string",
"description": "The action the reply performed to the parent comment. Valid values are: - resolve - reopen"
},
"author": {
"type": "object",
"description": "Information about a Drive user."
},
"content": {
"type": "string",
"description": "The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified."
},
"createdTime": {
"type": "string",
"format": "date-time",
"description": "The time at which the reply was created (RFC 3339 date-time)."
},
"deleted": {
"type": "boolean",
"description": "Whether the reply has been deleted. A deleted reply has no content."
},
"htmlContent": {
"type": "string",
"description": "The content of the reply with HTML formatting."
},
"id": {
"type": "string",
"description": "The ID of the reply."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"drive#reply\"."
},
"modifiedTime": {
"type": "string",
"format": "date-time",
"description": "The last time the reply was modified (RFC 3339 date-time)."
}
}
},
"description": "The full list of replies to the comment in chronological order."
},
"resolved": {
"type": "boolean",
"description": "Whether the comment has been resolved by one of its replies."
}
},
"required": [
"PCID",
"fileId",
"commentId"
]
}
```
***
## google-drive-api\_update\_file
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 change automatically, such as modifiedDate. This method supports patch semantics.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------------ | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `alt` | string | No | — | Data format for the response. |
| `fields` | string | No | — | Selector specifying which fields to include in a partial response. |
| `key` | string | No | — | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
| `oauth_token` | string | No | — | OAuth 2.0 token for the current user. |
| `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. |
| `quotaUser` | string | No | — | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
| `userIp` | string | No | — | Deprecated. Please use quotaUser instead. |
| `fileId` | string | Yes | — | The ID of the file. |
| `addParents` | string | No | — | A comma-separated list of parent IDs to add. |
| `enforceSingleParent` | boolean | No | — | Deprecated. Adding files to multiple folders is no longer supported. Use shortcuts instead. |
| `includeLabels` | string | No | — | A comma-separated list of IDs of labels to include in the labelInfo part of the response. |
| `includePermissionsForView` | string | No | — | Specifies which additional view's permissions to include in the response. Only 'published' is supported. |
| `keepRevisionForever` | boolean | No | — | Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions. |
| `ocrLanguage` | string | No | — | A language hint for OCR processing during image import (ISO 639-1 code). |
| `removeParents` | string | No | — | A comma-separated list of parent IDs to remove. |
| `supportsAllDrives` | boolean | No | — | Whether the requesting application supports both My Drives and shared drives. |
| `supportsTeamDrives` | boolean | No | — | Deprecated use supportsAllDrives instead. |
| `useContentAsIndexableText` | boolean | No | — | Whether to use the uploaded content as indexable text. |
| `appProperties` | object | No | — | A collection of arbitrary key-value pairs that are private to the requesting app. Entries with null values are cleared in update and copy requests. These properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with an OAuth 2 client ID. You cannot use an API key to retrieve private properties. |
| `capabilities` | object | No | — | Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user can take. |
| `contentHints` | object | No | — | Additional information about the content of the file. These fields are never populated in responses. |
| `contentRestrictions` | object\[] | No | — | Restrictions for accessing the content of the file. Only populated if such a restriction exists. |
| `copyRequiresWriterPermission` | boolean | No | — | Whether the options to copy, print, or download this file, should be disabled for readers and commenters. |
| `createdTime` | string | No | — | The time at which the file was created (RFC 3339 date-time). |
| `description` | string | No | — | A short description of the file. |
| `driveId` | string | No | — | ID of the shared drive the file resides in. Only populated for items in shared drives. |
| `explicitlyTrashed` | boolean | No | — | Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder. |
| `exportLinks` | object | No | — | Links for exporting Docs Editors files to specific formats. |
| `fileExtension` | string | No | — | The final component of fullFileExtension. This is only available for files with binary content in Google Drive. |
| `folderColorRgb` | string | No | — | The color for a folder or shortcut to a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource. If an unsupported color is specified, the closest color in the palette will be used instead. |
| `fullFileExtension` | string | No | — | The full file extension extracted from the name field. Can contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive. This is automatically updated when the name field changes, however it's not cleared if the new name does not contain a valid extension. |
| `hasAugmentedPermissions` | boolean | No | — | Whether there are permissions directly on this file. This field is only populated for items in shared drives. |
| `hasThumbnail` | boolean | No | — | Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field. |
| `headRevisionId` | string | No | — | The ID of the file's head revision. This is only available for files with binary content in Google Drive. |
| `iconLink` | string | No | — | A static, unauthenticated link to the file's icon. |
| `id` | string | No | — | The ID of the file. |
| `imageMediaMetadata` | object | No | — | Additional metadata about image media, if available. |
| `isAppAuthorized` | boolean | No | — | Whether the requesting app created or opened the file. |
| `kind` | string | No | — | Identifies what kind of resource this is. Value: the fixed string "drive#file". |
| `labelInfo` | object | No | — | An overview of the labels on the file. |
| `lastModifyingUser` | object | No | — | Information about a Drive user. |
| `linkShareMetadata` | object | No | — | Contains details about the link URLs that clients are using to refer to this item. |
| `md5Checksum` | string | No | — | The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive. |
| `mimeType` | string | No | — | The MIME type of the file. Google Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource. |
| `modifiedByMe` | boolean | No | — | Whether this user has modified the file. |
| `modifiedByMeTime` | string | No | — | The last time the user modified the file (RFC 3339 date-time). |
| `modifiedTime` | string | No | — | The last time anyone modified the file (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user. |
| `name` | string | No | — | The name of the file. This isn't necessarily unique within a folder. Note that for immutable items such as the top-level folders of shared drives, My Drive root folder, and Application Data folder the name is constant. |
| `originalFilename` | string | No | — | The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive. |
| `ownedByMe` | boolean | No | — | Whether the user owns the file. Not populated for items in shared drives. |
| `owners` | object\[] | No | — | The owner of this file. Only certain legacy files might have more than one owner. This field isn't populated for items in shared drives. |
| `parents` | string\[] | No | — | The IDs of the parent folders that contain the file. If not specified as part of a create request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests must use the addParents and removeParents parameters to modify the parents list. |
| `permissionIds` | string\[] | No | — | List of permission IDs for users with access to this file. |
| `permissions` | object\[] | No | — | The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives. |
| `properties` | object | No | — | A collection of arbitrary key-value pairs that are visible to all apps. Entries with null values are cleared in update and copy requests. |
| `quotaBytesUsed` | string | No | — | The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled. |
| `resourceKey` | string | No | — | A key needed to access the item via a shared link. |
| `sha1Checksum` | string | No | — | The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files. |
| `sha256Checksum` | string | No | — | The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files. |
| `shared` | boolean | No | — | Whether the file has been shared. Not populated for items in shared drives. |
| `sharedWithMeTime` | string | No | — | The time at which the file was shared with the user, if applicable (RFC 3339 date-time). |
| `sharingUser` | object | No | — | Information about a Drive user. |
| `shortcutDetails` | object | No | — | Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut. |
| `size` | string | No | — | The size of the file's content in bytes. This field is populated for files with binary content stored in Google Drive and for Docs Editors files; it's not populated for shortcuts or folders. |
| `spaces` | string\[] | No | — | The list of spaces that contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'. |
| `starred` | boolean | No | — | Whether the user has starred the file. |
| `teamDriveId` | string | No | — | Deprecated - use driveId instead. |
| `thumbnailLink` | string | No | — | A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in Files.thumbnailLink must be fetched using a credentialed request. |
| `thumbnailVersion` | string | No | — | The thumbnail version for use in thumbnail cache invalidation. |
| `trashed` | boolean | No | — | Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner can trash a file. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file. |
| `trashedTime` | string | No | — | The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives. |
| `trashingUser` | object | No | — | Information about a Drive user. |
| `version` | string | No | — | A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user. |
| `videoMediaMetadata` | object | No | — | Additional metadata about video media. This might not be available immediately upon upload. |
| `viewedByMe` | boolean | No | — | Whether this user has viewed the file. |
| `viewedByMeTime` | string | No | — | The last time the user viewed the file (RFC 3339 date-time). |
| `viewersCanCopyContent` | boolean | No | — | Deprecated - use copyRequiresWriterPermission instead. |
| `webContentLink` | string | No | — | A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive. |
| `webViewLink` | string | No | — | A link for opening the file in a relevant Google editor or viewer in a browser. |
| `writersCanShare` | boolean | No | — | Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters."
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead."
},
"fileId": {
"type": "string",
"description": "The ID of the file."
},
"addParents": {
"type": "string",
"description": "A comma-separated list of parent IDs to add."
},
"enforceSingleParent": {
"type": "boolean",
"description": "Deprecated. Adding files to multiple folders is no longer supported. Use shortcuts instead."
},
"includeLabels": {
"type": "string",
"description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response."
},
"includePermissionsForView": {
"type": "string",
"description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported."
},
"keepRevisionForever": {
"type": "boolean",
"description": "Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions."
},
"ocrLanguage": {
"type": "string",
"description": "A language hint for OCR processing during image import (ISO 639-1 code)."
},
"removeParents": {
"type": "string",
"description": "A comma-separated list of parent IDs to remove."
},
"supportsAllDrives": {
"type": "boolean",
"description": "Whether the requesting application supports both My Drives and shared drives."
},
"supportsTeamDrives": {
"type": "boolean",
"description": "Deprecated use supportsAllDrives instead."
},
"useContentAsIndexableText": {
"type": "boolean",
"description": "Whether to use the uploaded content as indexable text."
},
"appProperties": {
"type": "object",
"description": "A collection of arbitrary key-value pairs that are private to the requesting app. Entries with null values are cleared in update and copy requests. These properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with an OAuth 2 client ID. You cannot use an API key to retrieve private properties."
},
"capabilities": {
"type": "object",
"description": "Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user can take.",
"properties": {
"canAcceptOwnership": {
"type": "boolean",
"description": "Whether the current user is the pending owner of the file. Not populated for shared drive files."
},
"canAddChildren": {
"type": "boolean",
"description": "Whether the current user can add children to this folder. This is always false when the item isn't a folder."
},
"canAddFolderFromAnotherDrive": {
"type": "boolean",
"description": "Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item isn't a folder. Only populated for items in shared drives."
},
"canAddMyDriveParent": {
"type": "boolean",
"description": "Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files."
},
"canChangeCopyRequiresWriterPermission": {
"type": "boolean",
"description": "Whether the current user can change the copyRequiresWriterPermission restriction of this file."
},
"canChangeSecurityUpdateEnabled": {
"type": "boolean",
"description": "Whether the current user can change the securityUpdateEnabled field on link share metadata."
},
"canChangeViewersCanCopyContent": {
"type": "boolean",
"description": "Deprecated"
},
"canComment": {
"type": "boolean",
"description": "Whether the current user can comment on this file."
},
"canCopy": {
"type": "boolean",
"description": "Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it's not a folder."
},
"canDelete": {
"type": "boolean",
"description": "Whether the current user can delete this file."
},
"canDeleteChildren": {
"type": "boolean",
"description": "Whether the current user can delete children of this folder. This is false when the item isn't a folder. Only populated for items in shared drives."
},
"canDownload": {
"type": "boolean",
"description": "Whether the current user can download this file."
},
"canEdit": {
"type": "boolean",
"description": "Whether the current user can edit this file. Other factors might limit the type of changes a user can make to a file. For example, see canChangeCopyRequiresWriterPermission or canModifyContent."
},
"canListChildren": {
"type": "boolean",
"description": "Whether the current user can list the children of this folder. This is always false when the item isn't a folder."
},
"canModifyContent": {
"type": "boolean",
"description": "Whether the current user can modify the content of this file."
},
"canModifyContentRestriction": {
"type": "boolean",
"description": "Whether the current user can modify restrictions on content of this file."
},
"canModifyLabels": {
"type": "boolean",
"description": "Whether the current user can modify the labels on this file."
},
"canMoveChildrenOutOfDrive": {
"type": "boolean",
"description": "Whether the current user can move children of this folder outside of the shared drive. This is false when the item isn't a folder. Only populated for items in shared drives."
},
"canMoveChildrenOutOfTeamDrive": {
"type": "boolean",
"description": "Deprecated - use canMoveChildrenOutOfDrive instead."
},
"canMoveChildrenWithinDrive": {
"type": "boolean",
"description": "Whether the current user can move children of this folder within this shared drive or My Drive. This is false when the item isn't a folder. Note that a request to move the child might still fail depending on the current user's access to the child and to the destination folder."
},
"canMoveChildrenWithinTeamDrive": {
"type": "boolean",
"description": "Deprecated - use canMoveChildrenWithinDrive instead."
},
"canMoveItemIntoTeamDrive": {
"type": "boolean",
"description": "Deprecated - use canMoveItemOutOfDrive instead."
},
"canMoveItemOutOfDrive": {
"type": "boolean",
"description": "Whether the current user can move this item outside of this shared drive or My Drive by changing its parent. Note that a request to change the parent of the item might still fail depending on the new parent that's being added."
},
"canMoveItemOutOfTeamDrive": {
"type": "boolean",
"description": "Deprecated - use canMoveItemOutOfDrive instead."
},
"canMoveItemWithinDrive": {
"type": "boolean",
"description": "Whether the current user can move this item within this shared drive or My Drive. Note that a request to change the parent of the item might still fail depending on the new parent that's being added and the parent that's being removed."
},
"canMoveItemWithinTeamDrive": {
"type": "boolean",
"description": "Deprecated - use canMoveItemWithinDrive instead."
},
"canMoveTeamDriveItem": {
"type": "boolean",
"description": "Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead."
},
"canReadDrive": {
"type": "boolean",
"description": "Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives."
},
"canReadLabels": {
"type": "boolean",
"description": "Whether the current user can read the labels on this file."
},
"canReadRevisions": {
"type": "boolean",
"description": "Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it's not a folder, can be read."
},
"canReadTeamDrive": {
"type": "boolean",
"description": "Deprecated - use canReadDrive instead."
},
"canRemoveChildren": {
"type": "boolean",
"description": "Whether the current user can remove children from this folder. This is always false when the item isn't a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead."
},
"canRemoveMyDriveParent": {
"type": "boolean",
"description": "Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files."
},
"canRename": {
"type": "boolean",
"description": "Whether the current user can rename this file."
},
"canShare": {
"type": "boolean",
"description": "Whether the current user can modify the sharing settings for this file."
},
"canTrash": {
"type": "boolean",
"description": "Whether the current user can move this file to trash."
},
"canTrashChildren": {
"type": "boolean",
"description": "Whether the current user can trash children of this folder. This is false when the item isn't a folder. Only populated for items in shared drives."
},
"canUntrash": {
"type": "boolean",
"description": "Whether the current user can restore this file from trash."
}
}
},
"contentHints": {
"type": "object",
"description": "Additional information about the content of the file. These fields are never populated in responses.",
"properties": {
"indexableText": {
"type": "string",
"description": "Text to be indexed for the file to improve fullText queries. This is limited to 128 KB in length and might contain HTML elements. For more information, see Manage file metadata."
},
"thumbnail": {
"type": "object",
"description": "A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail."
}
}
},
"contentRestrictions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"readOnly": {
"type": "boolean",
"description": "Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified."
},
"reason": {
"type": "string",
"description": "Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true."
},
"restrictingUser": {
"type": "object",
"description": "Information about a Drive user."
},
"restrictionTime": {
"type": "string",
"format": "date-time",
"description": "The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true."
},
"type": {
"type": "string",
"description": "The type of the content restriction. Currently the only possible value is globalContentRestriction."
}
}
},
"description": "Restrictions for accessing the content of the file. Only populated if such a restriction exists."
},
"copyRequiresWriterPermission": {
"type": "boolean",
"description": "Whether the options to copy, print, or download this file, should be disabled for readers and commenters."
},
"createdTime": {
"type": "string",
"description": "The time at which the file was created (RFC 3339 date-time)."
},
"description": {
"type": "string",
"description": "A short description of the file."
},
"driveId": {
"type": "string",
"description": "ID of the shared drive the file resides in. Only populated for items in shared drives."
},
"explicitlyTrashed": {
"type": "boolean",
"description": "Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder."
},
"exportLinks": {
"type": "object",
"description": "Links for exporting Docs Editors files to specific formats."
},
"fileExtension": {
"type": "string",
"description": "The final component of fullFileExtension. This is only available for files with binary content in Google Drive."
},
"folderColorRgb": {
"type": "string",
"description": "The color for a folder or shortcut to a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource. If an unsupported color is specified, the closest color in the palette will be used instead."
},
"fullFileExtension": {
"type": "string",
"description": "The full file extension extracted from the name field. Can contain multiple concatenated extensions, such as \"tar.gz\". This is only available for files with binary content in Google Drive. This is automatically updated when the name field changes, however it's not cleared if the new name does not contain a valid extension."
},
"hasAugmentedPermissions": {
"type": "boolean",
"description": "Whether there are permissions directly on this file. This field is only populated for items in shared drives."
},
"hasThumbnail": {
"type": "boolean",
"description": "Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field."
},
"headRevisionId": {
"type": "string",
"description": "The ID of the file's head revision. This is only available for files with binary content in Google Drive."
},
"iconLink": {
"type": "string",
"description": "A static, unauthenticated link to the file's icon."
},
"id": {
"type": "string",
"description": "The ID of the file."
},
"imageMediaMetadata": {
"type": "object",
"description": "Additional metadata about image media, if available.",
"properties": {
"aperture": {
"type": "number",
"description": "The aperture used to create the photo (f-number)."
},
"cameraMake": {
"type": "string",
"description": "The make of the camera used to create the photo."
},
"cameraModel": {
"type": "string",
"description": "The model of the camera used to create the photo."
},
"colorSpace": {
"type": "string",
"description": "The color space of the photo."
},
"exposureBias": {
"type": "number",
"description": "The exposure bias of the photo (APEX value)."
},
"exposureMode": {
"type": "string",
"description": "The exposure mode used to create the photo."
},
"exposureTime": {
"type": "number",
"description": "The length of the exposure, in seconds."
},
"flashUsed": {
"type": "boolean",
"description": "Whether a flash was used to create the photo."
},
"focalLength": {
"type": "number",
"description": "The focal length used to create the photo, in millimeters."
},
"height": {
"type": "integer",
"description": "The height of the image in pixels."
},
"isoSpeed": {
"type": "integer",
"description": "The ISO speed used to create the photo."
},
"lens": {
"type": "string",
"description": "The lens used to create the photo."
},
"location": {
"type": "object",
"description": "Geographic location information stored in the image."
},
"maxApertureValue": {
"type": "number",
"description": "The smallest f-number of the lens at the focal length used to create the photo (APEX value)."
},
"meteringMode": {
"type": "string",
"description": "The metering mode used to create the photo."
},
"rotation": {
"type": "integer",
"description": "The number of clockwise 90-degree rotations applied from the image's original orientation."
},
"sensor": {
"type": "string",
"description": "The type of sensor used to create the photo."
},
"subjectDistance": {
"type": "integer",
"description": "The distance to the subject of the photo, in meters."
},
"time": {
"type": "string",
"description": "The date and time the photo was taken (EXIF DateTime)."
},
"whiteBalance": {
"type": "string",
"description": "The white balance mode used to create the photo."
},
"width": {
"type": "integer",
"description": "The width of the image in pixels."
}
}
},
"isAppAuthorized": {
"type": "boolean",
"description": "Whether the requesting app created or opened the file."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"drive#file\"."
},
"labelInfo": {
"type": "object",
"description": "An overview of the labels on the file.",
"properties": {
"labels": {
"type": "array",
"items": {
"type": "object"
},
"description": "The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned."
}
}
},
"lastModifyingUser": {
"type": "object",
"description": "Information about a Drive user.",
"properties": {
"displayName": {
"type": "string",
"description": "A plain text displayable name for this user."
},
"emailAddress": {
"type": "string",
"description": "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."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"drive#user\"."
},
"me": {
"type": "boolean",
"description": "Whether this user is the requesting user."
},
"permissionId": {
"type": "string",
"description": "The user's ID as visible in Permission resources."
},
"photoLink": {
"type": "string",
"description": "A link to the user's profile photo, if available."
}
}
},
"linkShareMetadata": {
"type": "object",
"description": "Contains details about the link URLs that clients are using to refer to this item.",
"properties": {
"securityUpdateEligible": {
"type": "boolean",
"description": "Whether the file is eligible for security update."
},
"securityUpdateEnabled": {
"type": "boolean",
"description": "Whether the security update is enabled for this file."
}
}
},
"md5Checksum": {
"type": "string",
"description": "The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive."
},
"mimeType": {
"type": "string",
"description": "The MIME type of the file. Google Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource."
},
"modifiedByMe": {
"type": "boolean",
"description": "Whether this user has modified the file."
},
"modifiedByMeTime": {
"type": "string",
"description": "The last time the user modified the file (RFC 3339 date-time)."
},
"modifiedTime": {
"type": "string",
"description": "The last time anyone modified the file (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user."
},
"name": {
"type": "string",
"description": "The name of the file. This isn't necessarily unique within a folder. Note that for immutable items such as the top-level folders of shared drives, My Drive root folder, and Application Data folder the name is constant."
},
"originalFilename": {
"type": "string",
"description": "The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive."
},
"ownedByMe": {
"type": "boolean",
"description": "Whether the user owns the file. Not populated for items in shared drives."
},
"owners": {
"type": "array",
"items": {
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "A plain text displayable name for this user."
},
"emailAddress": {
"type": "string",
"description": "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."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"drive#user\"."
},
"me": {
"type": "boolean",
"description": "Whether this user is the requesting user."
},
"permissionId": {
"type": "string",
"description": "The user's ID as visible in Permission resources."
},
"photoLink": {
"type": "string",
"description": "A link to the user's profile photo, if available."
}
}
},
"description": "The owner of this file. Only certain legacy files might have more than one owner. This field isn't populated for items in shared drives."
},
"parents": {
"type": "array",
"items": {
"type": "string"
},
"description": "The IDs of the parent folders that contain the file. If not specified as part of a create request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests must use the addParents and removeParents parameters to modify the parents list."
},
"permissionIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of permission IDs for users with access to this file."
},
"permissions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"allowFileDiscovery": {
"type": "boolean",
"description": "Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone."
},
"deleted": {
"type": "boolean",
"description": "Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions."
},
"displayName": {
"type": "string",
"description": "The \"pretty\" name of the value of the permission. The following is a list of examples for each type of permission: - user - User's full name, as defined for their Google Account, such as \"Joe Smith.\" - group - Name of the Google Group, such as \"The Company Administrators.\" - domain - String domain name, such as \"your-company.com.\" - anyone - No displayName is present."
},
"domain": {
"type": "string",
"description": "The domain to which this permission refers. The following options are currently allowed: - The entire domain, such as \"your-company.com.\" - A target audience, such as \"ID.audience.googledomains.com.\""
},
"emailAddress": {
"type": "string",
"description": "The email address of the user or group to which this permission refers."
},
"expirationTime": {
"type": "string",
"format": "date-time",
"description": "The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They cannot be set on shared drive items. - They can only be set on user and group permissions. - The time must be in the future. - The time cannot be more than one year in the future."
},
"id": {
"type": "string",
"description": "The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"drive#permission\"."
},
"pendingOwner": {
"type": "boolean",
"description": "Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that aren't in a shared drive."
},
"permissionDetails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"inherited": {
"type": "boolean",
"description": "Whether this permission is inherited. This field is always populated. This is an output-only field."
},
"inheritedFrom": {
"type": "string",
"description": "The ID of the item from which this permission is inherited. This is an output-only field."
},
"permissionType": {
"type": "string",
"description": "The permission type for this user. While new values may be added in future, the following are currently allowed: - file - member"
},
"role": {
"type": "string",
"description": "The primary role for this user. While new values may be added in the future, the following are currently allowed: - organizer - fileOrganizer - writer - commenter - reader"
}
}
},
"description": "Details of whether the permissions on this shared drive item are inherited or are directly on this item. This is an output-only field that's present only for shared drive items."
},
"photoLink": {
"type": "string",
"description": "A link to the user's profile photo, if available."
},
"role": {
"type": "string",
"description": "The role granted by this permission. While new values may be supported in the future, the following are currently allowed: - owner - organizer - fileOrganizer - writer - commenter - reader"
},
"teamDrivePermissionDetails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"inherited": {
"type": "boolean",
"description": "Deprecated - use permissionDetails/inherited instead."
},
"inheritedFrom": {
"type": "string",
"description": "Deprecated - use permissionDetails/inheritedFrom instead."
},
"role": {
"type": "string",
"description": "Deprecated - use permissionDetails/role instead."
},
"teamDrivePermissionType": {
"type": "string",
"description": "Deprecated - use permissionDetails/permissionType instead."
}
}
},
"description": "Deprecated - use permissionDetails instead."
},
"type": {
"type": "string",
"description": "The type of the grantee. Valid values are: - user - group - domain - anyone When creating a permission, if type is user or group, you must provide an emailAddress for the user or group. When type is domain, you must provide a domain. There isn't extra information required for the anyone type."
},
"view": {
"type": "string",
"description": "Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value."
}
}
},
"description": "The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives."
},
"properties": {
"type": "object",
"description": "A collection of arbitrary key-value pairs that are visible to all apps. Entries with null values are cleared in update and copy requests."
},
"quotaBytesUsed": {
"type": "string",
"description": "The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled."
},
"resourceKey": {
"type": "string",
"description": "A key needed to access the item via a shared link."
},
"sha1Checksum": {
"type": "string",
"description": "The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files."
},
"sha256Checksum": {
"type": "string",
"description": "The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it's not populated for Docs Editors or shortcut files."
},
"shared": {
"type": "boolean",
"description": "Whether the file has been shared. Not populated for items in shared drives."
},
"sharedWithMeTime": {
"type": "string",
"description": "The time at which the file was shared with the user, if applicable (RFC 3339 date-time)."
},
"sharingUser": {
"type": "object",
"description": "Information about a Drive user.",
"properties": {
"displayName": {
"type": "string",
"description": "A plain text displayable name for this user."
},
"emailAddress": {
"type": "string",
"description": "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."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"drive#user\"."
},
"me": {
"type": "boolean",
"description": "Whether this user is the requesting user."
},
"permissionId": {
"type": "string",
"description": "The user's ID as visible in Permission resources."
},
"photoLink": {
"type": "string",
"description": "A link to the user's profile photo, if available."
}
}
},
"shortcutDetails": {
"type": "object",
"description": "Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.",
"properties": {
"targetId": {
"type": "string",
"description": "The ID of the file that this shortcut points to."
},
"targetMimeType": {
"type": "string",
"description": "The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created."
},
"targetResourceKey": {
"type": "string",
"description": "The ResourceKey for the target file."
}
}
},
"size": {
"type": "string",
"description": "The size of the file's content in bytes. This field is populated for files with binary content stored in Google Drive and for Docs Editors files; it's not populated for shortcuts or folders."
},
"spaces": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of spaces that contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'."
},
"starred": {
"type": "boolean",
"description": "Whether the user has starred the file."
},
"teamDriveId": {
"type": "string",
"description": "Deprecated - use driveId instead."
},
"thumbnailLink": {
"type": "string",
"description": "A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in Files.thumbnailLink must be fetched using a credentialed request."
},
"thumbnailVersion": {
"type": "string",
"description": "The thumbnail version for use in thumbnail cache invalidation."
},
"trashed": {
"type": "boolean",
"description": "Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner can trash a file. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file."
},
"trashedTime": {
"type": "string",
"description": "The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives."
},
"trashingUser": {
"type": "object",
"description": "Information about a Drive user.",
"properties": {
"displayName": {
"type": "string",
"description": "A plain text displayable name for this user."
},
"emailAddress": {
"type": "string",
"description": "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."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"drive#user\"."
},
"me": {
"type": "boolean",
"description": "Whether this user is the requesting user."
},
"permissionId": {
"type": "string",
"description": "The user's ID as visible in Permission resources."
},
"photoLink": {
"type": "string",
"description": "A link to the user's profile photo, if available."
}
}
},
"version": {
"type": "string",
"description": "A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user."
},
"videoMediaMetadata": {
"type": "object",
"description": "Additional metadata about video media. This might not be available immediately upon upload.",
"properties": {
"durationMillis": {
"type": "string",
"description": "The duration of the video in milliseconds."
},
"height": {
"type": "integer",
"description": "The height of the video in pixels."
},
"width": {
"type": "integer",
"description": "The width of the video in pixels."
}
}
},
"viewedByMe": {
"type": "boolean",
"description": "Whether this user has viewed the file."
},
"viewedByMeTime": {
"type": "string",
"description": "The last time the user viewed the file (RFC 3339 date-time)."
},
"viewersCanCopyContent": {
"type": "boolean",
"description": "Deprecated - use copyRequiresWriterPermission instead."
},
"webContentLink": {
"type": "string",
"description": "A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive."
},
"webViewLink": {
"type": "string",
"description": "A link for opening the file in a relevant Google editor or viewer in a browser."
},
"writersCanShare": {
"type": "boolean",
"description": "Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives."
}
},
"required": [
"PCID",
"fileId"
]
}
```
***
## google-drive-api\_update\_permission
Updates a permission with patch semantics.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `alt` | string | No | — | Data format for the response. |
| `fields` | string | No | — | Selector specifying which fields to include in a partial response. |
| `key` | string | No | — | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
| `oauth_token` | string | No | — | OAuth 2.0 token for the current user. |
| `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. |
| `quotaUser` | string | No | — | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
| `userIp` | string | No | — | Deprecated. Please use quotaUser instead. |
| `fileId` | string | Yes | — | The ID of the file or shared drive. |
| `permissionId` | string | Yes | — | The ID of the permission. |
| `removeExpiration` | boolean | No | — | Whether to remove the expiration date. |
| `supportsAllDrives` | boolean | No | — | Whether the requesting application supports both My Drives and shared drives. |
| `supportsTeamDrives` | boolean | No | — | Deprecated use supportsAllDrives instead. |
| `transferOwnership` | boolean | No | — | Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. File owners can only transfer ownership of files existing on My Drive. Files existing in a shared drive are owned by the organization that owns that shared drive. Ownership transfers are not supported for files and folders in shared drives. Organizers of a shared drive can move items from that shared drive into their My Drive which transfers the ownership to them. |
| `useDomainAdminAccess` | boolean | No | — | Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs. |
| `allowFileDiscovery` | boolean | No | — | Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone. |
| `deleted` | boolean | No | — | Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. |
| `displayName` | string | No | — | The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: - user - User's full name, as defined for their Google Account, such as "Joe Smith." - group - Name of the Google Group, such as "The Company Administrators." - domain - String domain name, such as "your-company.com." - anyone - No displayName is present. |
| `domain` | string | No | — | The domain to which this permission refers. The following options are currently allowed: - The entire domain, such as "your-company.com." - A target audience, such as "ID.audience.googledomains.com." |
| `emailAddress` | string | No | — | The email address of the user or group to which this permission refers. |
| `expirationTime` | string | No | — | The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They cannot be set on shared drive items. - They can only be set on user and group permissions. - The time must be in the future. - The time cannot be more than one year in the future. |
| `id` | string | No | — | The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values. |
| `kind` | string | No | — | Identifies what kind of resource this is. Value: the fixed string "drive#permission". |
| `pendingOwner` | boolean | No | — | Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that aren't in a shared drive. |
| `permissionDetails` | object\[] | No | — | Details of whether the permissions on this shared drive item are inherited or are directly on this item. This is an output-only field that's present only for shared drive items. |
| `photoLink` | string | No | — | A link to the user's profile photo, if available. |
| `role` | string | No | — | The role granted by this permission. While new values may be supported in the future, the following are currently allowed: - owner - organizer - fileOrganizer - writer - commenter - reader |
| `teamDrivePermissionDetails` | object\[] | No | — | Deprecated - use permissionDetails instead. |
| `type` | string | No | — | The type of the grantee. Valid values are: - user - group - domain - anyone When creating a permission, if type is user or group, you must provide an emailAddress for the user or group. When type is domain, you must provide a domain. There isn't extra information required for the anyone type. |
| `view` | string | No | — | Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters."
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead."
},
"fileId": {
"type": "string",
"description": "The ID of the file or shared drive."
},
"permissionId": {
"type": "string",
"description": "The ID of the permission."
},
"removeExpiration": {
"type": "boolean",
"description": "Whether to remove the expiration date."
},
"supportsAllDrives": {
"type": "boolean",
"description": "Whether the requesting application supports both My Drives and shared drives."
},
"supportsTeamDrives": {
"type": "boolean",
"description": "Deprecated use supportsAllDrives instead."
},
"transferOwnership": {
"type": "boolean",
"description": "Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. File owners can only transfer ownership of files existing on My Drive. Files existing in a shared drive are owned by the organization that owns that shared drive. Ownership transfers are not supported for files and folders in shared drives. Organizers of a shared drive can move items from that shared drive into their My Drive which transfers the ownership to them."
},
"useDomainAdminAccess": {
"type": "boolean",
"description": "Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs."
},
"allowFileDiscovery": {
"type": "boolean",
"description": "Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone."
},
"deleted": {
"type": "boolean",
"description": "Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions."
},
"displayName": {
"type": "string",
"description": "The \"pretty\" name of the value of the permission. The following is a list of examples for each type of permission: - user - User's full name, as defined for their Google Account, such as \"Joe Smith.\" - group - Name of the Google Group, such as \"The Company Administrators.\" - domain - String domain name, such as \"your-company.com.\" - anyone - No displayName is present."
},
"domain": {
"type": "string",
"description": "The domain to which this permission refers. The following options are currently allowed: - The entire domain, such as \"your-company.com.\" - A target audience, such as \"ID.audience.googledomains.com.\""
},
"emailAddress": {
"type": "string",
"description": "The email address of the user or group to which this permission refers."
},
"expirationTime": {
"type": "string",
"description": "The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They cannot be set on shared drive items. - They can only be set on user and group permissions. - The time must be in the future. - The time cannot be more than one year in the future."
},
"id": {
"type": "string",
"description": "The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"drive#permission\"."
},
"pendingOwner": {
"type": "boolean",
"description": "Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that aren't in a shared drive."
},
"permissionDetails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"inherited": {
"type": "boolean",
"description": "Whether this permission is inherited. This field is always populated. This is an output-only field."
},
"inheritedFrom": {
"type": "string",
"description": "The ID of the item from which this permission is inherited. This is an output-only field."
},
"permissionType": {
"type": "string",
"description": "The permission type for this user. While new values may be added in future, the following are currently allowed: - file - member"
},
"role": {
"type": "string",
"description": "The primary role for this user. While new values may be added in the future, the following are currently allowed: - organizer - fileOrganizer - writer - commenter - reader"
}
}
},
"description": "Details of whether the permissions on this shared drive item are inherited or are directly on this item. This is an output-only field that's present only for shared drive items."
},
"photoLink": {
"type": "string",
"description": "A link to the user's profile photo, if available."
},
"role": {
"type": "string",
"description": "The role granted by this permission. While new values may be supported in the future, the following are currently allowed: - owner - organizer - fileOrganizer - writer - commenter - reader"
},
"teamDrivePermissionDetails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"inherited": {
"type": "boolean",
"description": "Deprecated - use permissionDetails/inherited instead."
},
"inheritedFrom": {
"type": "string",
"description": "Deprecated - use permissionDetails/inheritedFrom instead."
},
"role": {
"type": "string",
"description": "Deprecated - use permissionDetails/role instead."
},
"teamDrivePermissionType": {
"type": "string",
"description": "Deprecated - use permissionDetails/permissionType instead."
}
}
},
"description": "Deprecated - use permissionDetails instead."
},
"type": {
"type": "string",
"description": "The type of the grantee. Valid values are: - user - group - domain - anyone When creating a permission, if type is user or group, you must provide an emailAddress for the user or group. When type is domain, you must provide a domain. There isn't extra information required for the anyone type."
},
"view": {
"type": "string",
"description": "Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value."
}
},
"required": [
"PCID",
"fileId",
"permissionId"
]
}
```
***
## google-drive-api\_update\_reply
Updates a reply with patch semantics.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `alt` | string | No | — | Data format for the response. |
| `fields` | string | No | — | Selector specifying which fields to include in a partial response. |
| `key` | string | No | — | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
| `oauth_token` | string | No | — | OAuth 2.0 token for the current user. |
| `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. |
| `quotaUser` | string | No | — | An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
| `userIp` | string | No | — | Deprecated. Please use quotaUser instead. |
| `fileId` | string | Yes | — | The ID of the file. |
| `commentId` | string | Yes | — | The ID of the comment. |
| `replyId` | string | Yes | — | The ID of the reply. |
| `action` | string | No | — | The action the reply performed to the parent comment. Valid values are: - resolve - reopen |
| `author` | object | No | — | Information about a Drive user. |
| `content` | string | No | — | The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified. |
| `createdTime` | string | No | — | The time at which the reply was created (RFC 3339 date-time). |
| `deleted` | boolean | No | — | Whether the reply has been deleted. A deleted reply has no content. |
| `htmlContent` | string | No | — | The content of the reply with HTML formatting. |
| `id` | string | No | — | The ID of the reply. |
| `kind` | string | No | — | Identifies what kind of resource this is. Value: the fixed string "drive#reply". |
| `modifiedTime` | string | No | — | The last time the reply was modified (RFC 3339 date-time). |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alt": {
"type": "string",
"description": "Data format for the response.",
"enum": [
"json"
]
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"key": {
"type": "string",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks."
},
"quotaUser": {
"type": "string",
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters."
},
"userIp": {
"type": "string",
"description": "Deprecated. Please use quotaUser instead."
},
"fileId": {
"type": "string",
"description": "The ID of the file."
},
"commentId": {
"type": "string",
"description": "The ID of the comment."
},
"replyId": {
"type": "string",
"description": "The ID of the reply."
},
"action": {
"type": "string",
"description": "The action the reply performed to the parent comment. Valid values are: - resolve - reopen"
},
"author": {
"type": "object",
"description": "Information about a Drive user.",
"properties": {
"displayName": {
"type": "string",
"description": "A plain text displayable name for this user."
},
"emailAddress": {
"type": "string",
"description": "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."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"drive#user\"."
},
"me": {
"type": "boolean",
"description": "Whether this user is the requesting user."
},
"permissionId": {
"type": "string",
"description": "The user's ID as visible in Permission resources."
},
"photoLink": {
"type": "string",
"description": "A link to the user's profile photo, if available."
}
}
},
"content": {
"type": "string",
"description": "The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified."
},
"createdTime": {
"type": "string",
"description": "The time at which the reply was created (RFC 3339 date-time)."
},
"deleted": {
"type": "boolean",
"description": "Whether the reply has been deleted. A deleted reply has no content."
},
"htmlContent": {
"type": "string",
"description": "The content of the reply with HTML formatting."
},
"id": {
"type": "string",
"description": "The ID of the reply."
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"drive#reply\"."
},
"modifiedTime": {
"type": "string",
"description": "The last time the reply was modified (RFC 3339 date-time)."
}
},
"required": [
"PCID",
"fileId",
"commentId",
"replyId"
]
}
```