{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://artifacts.apis.io/google-drive/json-schema/google-drive-change-list-schema.json", "title": "ChangeList", "description": "A list of changes for a user.", "x-generated": "2026-11-04", "x-method": "derived", "x-generator": "derive-json-schema.py", "x-source": "openapi/google-drive-changes-api-openapi.yml#/components/schemas/ChangeList", "type": "object", "properties": { "nextPageToken": { "type": "string", "description": "The page token for the next page of changes. This will be absent if the end of the changes list has been reached. The page token doesn't expire." }, "newStartPageToken": { "type": "string", "description": "The starting page token for future changes. This will be present only if the end of the current changes list has been reached. The page token doesn't expire." }, "changes": { "type": "array", "description": "The list of changes. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.", "items": { "$ref": "#/$defs/Change" } }, "kind": { "type": "string", "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#changeList\"`.", "default": "drive#changeList" } }, "$defs": { "Change": { "type": "object", "description": "A change to a file or shared drive.", "properties": { "changeType": { "type": "string", "description": "The type of the change. Possible values are `file` and `drive`." }, "file": { "$ref": "#/$defs/File" }, "drive": { "$ref": "#/$defs/Drive" }, "teamDrive": { "$ref": "#/$defs/TeamDrive" }, "teamDriveId": { "type": "string", "description": "Deprecated: Use `driveId` instead." }, "type": { "type": "string", "description": "Deprecated: Use `changeType` instead." }, "fileId": { "type": "string", "description": "The ID of the file which has changed." }, "removed": { "type": "boolean", "description": "Whether the file or shared drive has been removed from this list of changes, for example by deletion or loss of access." }, "driveId": { "type": "string", "description": "The ID of the shared drive associated with this change." }, "kind": { "type": "string", "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#change\"`.", "default": "drive#change" }, "time": { "type": "string", "description": "The time of this change (RFC 3339 date-time).", "format": "date-time" } } }, "ClientEncryptionDetails": { "type": "object", "description": "Details about the client-side encryption applied to the file.", "properties": { "decryptionMetadata": { "$ref": "#/$defs/DecryptionMetadata" }, "encryptionState": { "type": "string", "description": "The encryption state of the file. The values expected here are: - encrypted - unencrypted " } } }, "ContentRestriction": { "type": "object", "description": "A restriction for accessing the content of the file.", "properties": { "restrictionTime": { "type": "string", "description": "The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.", "format": "date-time" }, "ownerRestricted": { "type": "boolean", "description": "Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction." }, "systemRestricted": { "type": "boolean", "description": "Output only. Whether the content restriction was applied by the system, for example due to an esignature. Users cannot modify or remove system restricted content restrictions." }, "type": { "type": "string", "description": "Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`." }, "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": { "$ref": "#/$defs/User" }, "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." } } }, "DecryptionMetadata": { "type": "object", "description": "Representation of the CSE DecryptionMetadata.", "properties": { "kaclsName": { "type": "string", "description": "The name of the KACLS (Key ACL Service) used to encrypt the file." }, "kaclsId": { "type": "string", "description": "The ID of the KACLS (Key ACL Service) used to encrypt the file.", "format": "int64" }, "keyFormat": { "type": "string", "description": "Key format for the unwrapped key. Must be `tinkAesGcmKey`." }, "aes256GcmChunkSize": { "type": "string", "description": "Chunk size used if content was encrypted with the AES 256 GCM Cipher. Possible values are: - default - small " }, "wrappedKey": { "type": "string", "description": "The URL-safe Base64 encoded wrapped key used to encrypt the contents of the file." }, "jwt": { "type": "string", "description": "The signed JSON Web Token (JWT) which can be used to authorize the requesting user with the Key ACL Service (KACLS). The JWT asserts that the requesting user has at least read permissions on the file." }, "encryptionResourceKeyHash": { "type": "string", "description": "The URL-safe Base64 encoded HMAC-SHA256 digest of the resource metadata with its DEK (Data Encryption Key); see https://developers.google.com/workspace/cse/reference" } } }, "DownloadRestriction": { "type": "object", "description": "A restriction for copy and download of the file.", "properties": { "restrictedForReaders": { "type": "boolean", "description": "Whether download and copy is restricted for readers." }, "restrictedForWriters": { "type": "boolean", "description": "Whether download and copy is restricted for writers. If true, download is also restricted for readers." } } }, "DownloadRestrictionsMetadata": { "type": "object", "description": "Download restrictions applied to the file.", "properties": { "itemDownloadRestriction": { "$ref": "#/$defs/DownloadRestriction" }, "effectiveDownloadRestrictionWithContext": { "$ref": "#/$defs/DownloadRestriction" } } }, "Drive": { "type": "object", "description": "Representation of a shared drive. Some resource methods (such as `drives.update`) require a `driveId`. Use the `drives.list` method to retrieve the ID for a shared drive.", "properties": { "capabilities": { "type": "object", "description": "Output only. Capabilities the current user has on this shared drive.", "properties": { "canRenameDrive": { "type": "boolean", "description": "Output only. Whether the current user can rename this shared drive." }, "canDownload": { "type": "boolean", "description": "Output only. Whether the current user can download files in this shared drive." }, "canRename": { "type": "boolean", "description": "Output only. Whether the current user can rename files or folders in this shared drive." }, "canReadRevisions": { "type": "boolean", "description": "Output only. Whether the current user can read the revisions resource of files in this shared drive." }, "canEdit": { "type": "boolean", "description": "Output only. Whether the current user can edit files in this shared drive" }, "canAddChildren": { "type": "boolean", "description": "Output only. Whether the current user can add children to folders in this shared drive." }, "canDeleteDrive": { "type": "boolean", "description": "Output only. Whether the current user can delete this shared drive. Attempting to delete the shared drive may still fail if there are untrashed items inside the shared drive." }, "canTrashChildren": { "type": "boolean", "description": "Output only. Whether the current user can trash children from folders in this shared drive." }, "canChangeDownloadRestriction": { "type": "boolean", "description": "Output only. Whether the current user can change organizer-applied download restrictions of this shared drive." }, "canListChildren": { "type": "boolean", "description": "Output only. Whether the current user can list the children of folders in this shared drive." }, "canChangeCopyRequiresWriterPermissionRestriction": { "type": "boolean", "description": "Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this shared drive." }, "canShare": { "type": "boolean", "description": "Output only. Whether the current user can share files or folders in this shared drive." }, "canManageMembers": { "type": "boolean", "description": "Output only. Whether the current user can add members to this shared drive or remove them or change their role." }, "canComment": { "type": "boolean", "description": "Output only. Whether the current user can comment on files in this shared drive." }, "canChangeDomainUsersOnlyRestriction": { "type": "boolean", "description": "Output only. Whether the current user can change the `domainUsersOnly` restriction of this shared drive." }, "canChangeDriveBackground": { "type": "boolean", "description": "Output only. Whether the current user can change the background of this shared drive." }, "canChangeDriveMembersOnlyRestriction": { "type": "boolean", "description": "Output only. Whether the current user can change the `driveMembersOnly` restriction of this shared drive." }, "canDeleteChildren": { "type": "boolean", "description": "Output only. Whether the current user can delete children from folders in this shared drive." }, "canChangeSharingFoldersRequiresOrganizerPermissionRestriction": { "type": "boolean", "description": "Output only. Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this shared drive." }, "canResetDriveRestrictions": { "type": "boolean", "description": "Output only. Whether the current user can reset the shared drive restrictions to defaults." }, "canCopy": { "type": "boolean", "description": "Output only. Whether the current user can copy files in this shared drive." } } }, "restrictions": { "type": "object", "description": "A set of restrictions that apply to this shared drive or items inside this shared drive. Note that restrictions can't be set when creating a shared drive. To add a restriction, first create a shared drive and then use `drives.update` to add restrictions.", "properties": { "copyRequiresWriterPermission": { "type": "boolean", "description": "Whether the options to copy, print, or download files inside this shared drive, should be disabled for readers and commenters. When this restriction is set to `true`, it will override the similarly named field to `true` for any file inside this shared drive." }, "sharingFoldersRequiresOrganizerPermission": { "type": "boolean", "description": "If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders." }, "driveMembersOnly": { "type": "boolean", "description": "Whether access to items inside this shared drive is restricted to its members." }, "domainUsersOnly": { "type": "boolean", "description": "Whether access to this shared drive and items inside this shared drive is restricted to users of the domain to which this shared drive belongs. This restriction may be overridden by other sharing policies controlled outside of this shared drive." }, "downloadRestriction": { "$ref": "#/$defs/DownloadRestriction" }, "adminManagedRestrictions": { "type": "boolean", "description": "Whether administrative privileges on this shared drive are required to modify restrictions." } } }, "hidden": { "type": "boolean", "description": "Whether the shared drive is hidden from default view." }, "createdTime": { "type": "string", "description": "The time at which the shared drive was created (RFC 3339 date-time).", "format": "date-time" }, "backgroundImageFile": { "type": "object", "description": "An image file and cropping parameters from which a background image for this shared drive is set. This is a write only field; it can only be set on `drive.drives.update` requests that don't set `themeId`. When specified, all fields of the `backgroundImageFile` must be set.", "properties": { "xCoordinate": { "type": "number", "description": "The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image.", "format": "float" }, "id": { "type": "string", "description": "The ID of an image file in Google Drive to use for the background image." }, "width": { "type": "number", "description": "The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high.", "format": "float" }, "yCoordinate": { "type": "number", "description": "The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.", "format": "float" } } }, "name": { "type": "string", "description": "The name of this shared drive." }, "orgUnitId": { "type": "string", "description": "Output only. The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`." }, "id": { "type": "string", "description": "Output only. The ID of this shared drive which is also the ID of the top level folder of this shared drive." }, "backgroundImageLink": { "type": "string", "description": "Output only. A short-lived link to this shared drive's background image." }, "kind": { "type": "string", "description": "Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#drive\"`.", "default": "drive#drive" }, "colorRgb": { "type": "string", "description": "The color of this shared drive as an RGB hex string. It can only be set on a `drive.drives.update` request that does not set `themeId`." }, "themeId": { "type": "string", "description": "The ID of the theme from which the background image and color will be set. The set of possible `driveThemes` can be retrieved from a `drive.about.get` response. When not specified on a `drive.drives.create` request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set `colorRgb` or `backgroundImageFile`." } } }, "File": { "type": "object", "description": "The metadata for a file. Some resource methods (such as `files.update`) require a `fileId`. Use the `files.list` method to retrieve the ID for a file.", "properties": { "imageMediaMetadata": { "type": "object", "description": "Output only. Additional metadata about image media, if available.", "properties": { "exposureMode": { "type": "string", "description": "Output only. The exposure mode used to create the photo." }, "aperture": { "type": "number", "description": "Output only. The aperture used to create the photo (f-number).", "format": "float" }, "meteringMode": { "type": "string", "description": "Output only. The metering mode used to create the photo." }, "exposureBias": { "type": "number", "description": "Output only. The exposure bias of the photo (APEX value).", "format": "float" }, "isoSpeed": { "type": "integer", "description": "Output only. The ISO speed used to create the photo.", "format": "int32" }, "colorSpace": { "type": "string", "description": "Output only. The color space of the photo." }, "subjectDistance": { "type": "integer", "description": "Output only. The distance to the subject of the photo, in meters.", "format": "int32" }, "location": { "type": "object", "description": "Output only. Geographic location information stored in the image.", "properties": { "latitude": { "type": "number", "description": "Output only. The latitude stored in the image.", "format": "double" }, "altitude": { "type": "number", "description": "Output only. The altitude stored in the image.", "format": "double" }, "longitude": { "type": "number", "description": "Output only. The longitude stored in the image.", "format": "double" } } }, "cameraMake": { "type": "string", "description": "Output only. The make of the camera used to create the photo." }, "height": { "type": "integer", "description": "Output only. The height of the image in pixels.", "format": "int32" }, "focalLength": { "type": "number", "description": "Output only. The focal length used to create the photo, in millimeters.", "format": "float" }, "cameraModel": { "type": "string", "description": "Output only. The model of the camera used to create the photo." }, "lens": { "type": "string", "description": "Output only. The lens used to create the photo." }, "exposureTime": { "type": "number", "description": "Output only. The length of the exposure, in seconds.", "format": "float" }, "rotation": { "type": "integer", "description": "Output only. The number of clockwise 90 degree rotations applied from the image's original orientation.", "format": "int32" }, "maxApertureValue": { "type": "number", "description": "Output only. The smallest f-number of the lens at the focal length used to create the photo (APEX value).", "format": "float" }, "time": { "type": "string", "description": "Output only. The date and time the photo was taken (EXIF DateTime)." }, "whiteBalance": { "type": "string", "description": "Output only. The white balance mode used to create the photo." }, "sensor": { "type": "string", "description": "Output only. The type of sensor used to create the photo." }, "flashUsed": { "type": "boolean", "description": "Output only. Whether a flash was used to create the photo." }, "width": { "type": "integer", "description": "Output only. The width of the image in pixels.", "format": "int32" } } }, "quotaBytesUsed": { "type": "string", "description": "Output only. The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with `keepForever` enabled.", "format": "int64" }, "viewedByMeTime": { "type": "string", "description": "The last time the file was viewed by the user (RFC 3339 date-time).", "format": "date-time" }, "properties": { "type": "object", "description": "A collection of arbitrary key-value pairs which are visible to all apps.\nEntries with null values are cleared in update and copy requests.", "additionalProperties": { "type": "string" } }, "clientEncryptionDetails": { "$ref": "#/$defs/ClientEncryptionDetails" }, "folderColorRgb": { "type": "string", "description": "The color for a folder or a shortcut to a folder as an RGB hex string. The supported colors are published in the `folderColorPalette` field of the [`about`](/workspace/drive/api/reference/rest/v3/about) resource. If an unsupported color is specified, the closest color in the palette is used instead." }, "modifiedByMeTime": { "type": "string", "description": "The last time the file was modified by the user (RFC 3339 date-time).", "format": "date-time" }, "modifiedTime": { "type": "string", "description": "he last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user.", "format": "date-time" }, "shortcutDetails": { "type": "object", "description": "Information about a shortcut file.", "properties": { "targetMimeType": { "type": "string", "description": "Output only. 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": "Output only. The `resourceKey` for the target file." }, "targetId": { "type": "string", "description": "The ID of the file that this shortcut points to. Can only be set on `files.create` requests." } } }, "id": { "type": "string", "description": "The ID of the file." }, "videoMediaMetadata": { "type": "object", "description": "Output only. Additional metadata about video media. This may not be available immediately upon upload.", "properties": { "durationMillis": { "type": "string", "description": "Output only. The duration of the video in milliseconds.", "format": "int64" }, "width": { "type": "integer", "description": "Output only. The width of the video in pixels.", "format": "int32" }, "height": { "type": "integer", "description": "Output only. The height of the video in pixels.", "format": "int32" } } }, "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 may contain HTML elements." }, "thumbnail": { "type": "object", "description": "A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail.", "properties": { "mimeType": { "type": "string", "description": "The MIME type of the thumbnail." }, "image": { "type": "string", "description": "The thumbnail data encoded with URL-safe Base64 ([RFC 4648 section 5](https://datatracker.ietf.org/doc/html/rfc4648#section-5)).", "format": "byte" } } } } }, "parents": { "type": "array", "description": "The ID of the parent folder containing the file. A file can only have one parent folder; specifying multiple parents isn't supported. If not specified as part of a create request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parent of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list.", "items": { "type": "string" } }, "fullFileExtension": { "type": "string", "description": "Output only. The full file extension extracted from the `name` field. May 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 doesn't contain a valid extension." }, "fileExtension": { "type": "string", "description": "Output only. The final component of `fullFileExtension`. This is only available for files with binary content in Google Drive." }, "webContentLink": { "type": "string", "description": "Output only. A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive." }, "downloadRestrictions": { "$ref": "#/$defs/DownloadRestrictionsMetadata" }, "capabilities": { "type": "object", "description": "Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. For more information, see [Understand file capabilities](https://developers.google.com/workspace/drive/api/guides/manage-sharing#capabilities).", "properties": { "canReadTeamDrive": { "type": "boolean", "description": "Deprecated: Output only. Use `canReadDrive` instead." }, "canStartApproval": { "type": "boolean", "description": "Whether the current user can start an approval on the file." }, "canModifyEditorContentRestriction": { "type": "boolean", "description": "Output only. Whether the current user can add or modify content restrictions on the file which are editor restricted." }, "canDelete": { "type": "boolean", "description": "Output only. Whether the current user can delete this file." }, "canRemoveMyDriveParent": { "type": "boolean", "description": "Output only. 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." }, "canReadDrive": { "type": "boolean", "description": "Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives." }, "canMoveItemWithinTeamDrive": { "type": "boolean", "description": "Deprecated: Output only. Use `canMoveItemWithinDrive` instead." }, "canComment": { "type": "boolean", "description": "Output only. Whether the current user can comment on this file." }, "canRemoveChildren": { "type": "boolean", "description": "Output only. 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." }, "canAddMyDriveParent": { "type": "boolean", "description": "Output only. 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." }, "canTrashChildren": { "type": "boolean", "description": "Output only. 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." }, "canCopy": { "type": "boolean", "description": "Output only. 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 if it's not a folder." }, "canMoveTeamDriveItem": { "type": "boolean", "description": "Deprecated: Output only. Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead." }, "canChangeItemDownloadRestriction": { "type": "boolean", "description": "Output only. Whether the current user can change the owner or organizer-applied download restrictions of the file." }, "canAddFolderFromAnotherDrive": { "type": "boolean", "description": "Output only. 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." }, "canMoveChildrenOutOfTeamDrive": { "type": "boolean", "description": "Deprecated: Output only. Use `canMoveChildrenOutOfDrive` instead." }, "canMoveItemOutOfDrive": { "type": "boolean", "description": "Output only. Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that's being added." }, "canReadRevisions": { "type": "boolean", "description": "Output only. 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 if it's not a folder, can be read." }, "canModifyContent": { "type": "boolean", "description": "Output only. Whether the current user can modify the content of this file." }, "canModifyOwnerContentRestriction": { "type": "boolean", "description": "Output only. Whether the current user can add or modify content restrictions which are owner restricted." }, "canTrash": { "type": "boolean", "description": "Output only. Whether the current user can move this file to trash." }, "canChangeViewersCanCopyContent": { "type": "boolean", "description": "Deprecated: Output only." }, "canAcceptOwnership": { "type": "boolean", "description": "Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files." }, "canModifyLabels": { "type": "boolean", "description": "Output only. Whether the current user can modify the labels on the file." }, "canChangeSecurityUpdateEnabled": { "type": "boolean", "description": "Output only. Whether the current user can change the `securityUpdateEnabled` field on link share metadata." }, "canDisableInheritedPermissions": { "type": "boolean", "description": "Whether a user can disable inherited permissions." }, "canChangeCopyRequiresWriterPermission": { "type": "boolean", "description": "Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file." }, "canMoveChildrenWithinTeamDrive": { "type": "boolean", "description": "Deprecated: Output only. Use `canMoveChildrenWithinDrive` instead." }, "canDownload": { "type": "boolean", "description": "Output only. Whether the current user can download this file." }, "canEdit": { "type": "boolean", "description": "Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or `canModifyContent`." }, "canUntrash": { "type": "boolean", "description": "Output only. Whether the current user can restore this file from trash." }, "canRename": { "type": "boolean", "description": "Output only. Whether the current user can rename this file." }, "canModifyContentRestriction": { "type": "boolean", "description": "Deprecated: Output only. Use one of `canModifyEditorContentRestriction`, `canModifyOwnerContentRestriction`, or `canRemoveContentRestriction`." }, "canMoveChildrenWithinDrive": { "type": "boolean", "description": "Output only. Whether the current user can move children of this folder within this drive. This is `false` when the item isn't a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder." }, "canListChildren": { "type": "boolean", "description": "Output only. Whether the current user can list the children of this folder. This is always `false` when the item isn't a folder." }, "canMoveItemOutOfTeamDrive": { "type": "boolean", "description": "Deprecated: Output only. Use `canMoveItemOutOfDrive` instead." }, "canMoveItemWithinDrive": { "type": "boolean", "description": "Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that's being added and the parent that is being removed." }, "canMoveChildrenOutOfDrive": { "type": "boolean", "description": "Output only. 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." }, "canDeleteChildren": { "type": "boolean", "description": "Output only. 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." }, "canMoveItemIntoTeamDrive": { "type": "boolean", "description": "Deprecated: Output only. Use `canMoveItemOutOfDrive` instead." }, "canAccessViaGenAi": { "type": "boolean", "description": "Whether the current user can access this file via Gen AI features. For more information, see [Drive MCP file eligibility](https://developers.google.com/workspace/drive/api/guides/drive-mcp-server-file-eligibility)." }, "canEnableInheritedPermissions": { "type": "boolean", "description": "Whether a user can re-enable inherited permissions." }, "canShare": { "type": "boolean", "description": "Output only. Whether the current user can modify the sharing settings for this file." }, "canRemoveContentRestriction": { "type": "boolean", "description": "Output only. Whether there's a content restriction on the file that can be removed by the current user." }, "canReadLabels": { "type": "boolean", "description": "Output only. Whether the current user can read the labels on the file." }, "canAddChildren": { "type": "boolean", "description": "Output only. Whether the current user can add children to this folder. This is always `false` when the item isn't a folder." } } }, "viewersCanCopyContent": { "type": "boolean", "description": "Deprecated: Use `copyRequiresWriterPermission` instead." }, "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, the My Drive root folder, and the Application Data folder, the name is constant." }, "kind": { "type": "string", "description": "Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#file\"`.", "default": "drive#file" }, "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." }, "webViewLink": { "type": "string", "description": "Output only. A link for opening the file in a relevant Google editor or viewer in a browser." }, "teamDriveId": { "type": "string", "description": "Deprecated: Output only. Use `driveId` instead." }, "hasThumbnail": { "type": "boolean", "description": "Output only. Whether this file has a thumbnail. This doesn't indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field." }, "hasAugmentedPermissions": { "type": "boolean", "description": "Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives." }, "modifiedByMe": { "type": "boolean", "description": "Output only. Whether the file has been modified by this user." }, "thumbnailVersion": { "type": "string", "description": "Output only. The thumbnail version for use in thumbnail cache invalidation.", "format": "int64" }, "spaces": { "type": "array", "description": "Output only. The list of spaces which contain the file. The currently supported values are `drive`, `appDataFolder`, and `photos`.", "items": { "type": "string" } }, "sha1Checksum": { "type": "string", "description": "Output only. 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." }, "thumbnailLink": { "type": "string", "description": "Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies. Consider using a proxy server. 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." }, "sharedWithMeTime": { "type": "string", "description": "The time at which the file was shared with the user, if applicable (RFC 3339 date-time).", "format": "date-time" }, "writersCanShare": { "type": "boolean", "description": "Whether users with only `writer` permission can modify the file's permissions. Not populated for items in shared drives." }, "resourceKey": { "type": "string", "description": "Output only. A key needed to access the item via a shared link." }, "shared": { "type": "boolean", "description": "Output only. Whether the file has been shared. Not populated for items in shared drives." }, "version": { "type": "string", "description": "Output only. 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.", "format": "int64" }, "lastModifyingUser": { "$ref": "#/$defs/User" }, "viewedByMe": { "type": "boolean", "description": "Output only. Whether the file has been viewed by this user." }, "md5Checksum": { "type": "string", "description": "Output only. The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive." }, "appProperties": { "type": "object", "description": "A collection of arbitrary key-value pairs which are private to the requesting app.\nEntries 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 a OAuth 2 client ID. You cannot use an API key to retrieve private properties.", "additionalProperties": { "type": "string" } }, "sha256Checksum": { "type": "string", "description": "Output only. 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." }, "linkShareMetadata": { "type": "object", "description": "Contains details about the link URLs that clients are using to refer to this item.", "properties": { "securityUpdateEnabled": { "type": "boolean", "description": "Output only. Whether the security update is enabled for this file." }, "securityUpdateEligible": { "type": "boolean", "description": "Output only. Whether the file is eligible for security update." } } }, "exportLinks": { "type": "object", "description": "Output only. Links for exporting Docs Editors files to specific formats.", "readOnly": true, "additionalProperties": { "type": "string" } }, "size": { "type": "string", "description": "Output only. Size in bytes of blobs and Google Workspace editor files. Won't be populated for files that have no size, like shortcuts and folders.", "format": "int64" }, "description": { "type": "string", "description": "A short description of the file." }, "contentRestrictions": { "type": "array", "description": "Restrictions for accessing the content of the file. Only populated if such a restriction exists.", "items": { "$ref": "#/$defs/ContentRestriction" } }, "iconLink": { "type": "string", "description": "Output only. A static, unauthenticated link to the file's icon." }, "permissionIds": { "type": "array", "description": "Output only. List of permission IDs for users with access to this file.", "items": { "type": "string" } }, "owners": { "type": "array", "description": "Output only. The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.", "items": { "$ref": "#/$defs/User" } }, "driveId": { "type": "string", "description": "Output only. ID of the shared drive the file resides in. Only populated for items in shared drives." }, "trashed": { "type": "boolean", "description": "Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, but other users can still access the file in the owner's trash until it's permanently deleted." }, "ownedByMe": { "type": "boolean", "description": "Output only. Whether the user owns the file. Not populated for items in shared drives." }, "headRevisionId": { "type": "string", "description": "Output only. The ID of the file's head revision. This is currently only available for files with binary content in Google Drive." }, "inheritedPermissionsDisabled": { "type": "boolean", "description": "Whether this file has inherited permissions disabled. Inherited permissions are enabled by default." }, "trashedTime": { "type": "string", "description": "The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.", "format": "date-time" }, "labelInfo": { "type": "object", "description": "Label information on the file.", "properties": { "labels": { "type": "array", "description": "Output only. The set of labels on the file as requested by the label IDs in the `includeLabels` parameter. By default, no labels are returned.", "items": { "$ref": "#/$defs/Label" } } } }, "permissions": { "type": "array", "description": "Output only. 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.", "items": { "$ref": "#/$defs/Permission" } }, "copyRequiresWriterPermission": { "type": "boolean", "description": "Whether the options to copy, print, or download this file should be disabled for readers and commenters." }, "sharingUser": { "$ref": "#/$defs/User" }, "mimeType": { "type": "string", "description": "The MIME type of the file. Google Drive attempts 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 is imported, if possible. The supported import formats are published in the [`about`](/workspace/drive/api/reference/rest/v3/about) resource." }, "createdTime": { "type": "string", "description": "The time at which the file was created (RFC 3339 date-time).", "format": "date-time" }, "starred": { "type": "boolean", "description": "Whether the user has starred the file." }, "isAppAuthorized": { "type": "boolean", "description": "Output only. Whether the file was created or opened by the requesting app." }, "trashingUser": { "$ref": "#/$defs/User" }, "explicitlyTrashed": { "type": "boolean", "description": "Output only. Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder." } } }, "Label": { "type": "object", "description": "Representation of label and label fields.", "properties": { "revisionId": { "type": "string", "description": "The revision ID of the label." }, "id": { "type": "string", "description": "The ID of the label." }, "kind": { "type": "string", "description": "This is always drive#label" }, "fields": { "type": "object", "description": "A map of the fields on the label, keyed by the field's ID.", "additionalProperties": { "$ref": "#/$defs/LabelField" } } } }, "LabelField": { "type": "object", "description": "Representation of field, which is a typed key-value pair.", "properties": { "text": { "type": "array", "description": "Only present if `valueType` is `text`.", "items": { "type": "string" } }, "kind": { "type": "string", "description": "This is always drive#labelField." }, "dateString": { "type": "array", "description": "Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD.", "items": { "type": "string", "format": "date" } }, "id": { "type": "string", "description": "The identifier of this label field." }, "valueType": { "type": "string", "description": "The field type. While new values may be supported in the future, the following are currently allowed: * `dateString` * `integer` * `selection` * `text` * `user`" }, "selection": { "type": "array", "description": "Only present if `valueType` is `selection`", "items": { "type": "string" } }, "user": { "type": "array", "description": "Only present if `valueType` is `user`.", "items": { "$ref": "#/$defs/User" } }, "integer": { "type": "array", "description": "Only present if `valueType` is `integer`.", "items": { "type": "string", "format": "int64" } } } }, "Permission": { "type": "object", "description": "A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing). By default, permission requests only return a subset of fields. Permission `kind`, `ID`, `type`, and `role` are always returned. To retrieve specific fields, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter). Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive.", "properties": { "role": { "type": "string", "description": "The role granted by this permission. Supported values include: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles)." }, "domain": { "type": "string", "description": "Output only. The domain to which this permission refers.", "readOnly": true }, "deleted": { "type": "boolean", "description": "Output only. Whether the account associated with this permission has been deleted. This field only pertains to permissions of type `user` or `group`." }, "inheritedPermissionsDisabled": { "type": "boolean", "description": "When `true`, only organizers, owners, and users with permissions added directly on the item can access it." }, "teamDrivePermissionDetails": { "type": "array", "description": "Output only. Deprecated: Output only. Use `permissionDetails` instead.", "readOnly": true, "items": { "type": "object", "properties": { "teamDrivePermissionType": { "type": "string", "description": "Deprecated: Output only. Use `permissionDetails/permissionType` instead." }, "inheritedFrom": { "type": "string", "description": "Deprecated: Output only. Use `permissionDetails/inheritedFrom` instead." }, "role": { "type": "string", "description": "Deprecated: Output only. Use `permissionDetails/role` instead." }, "inherited": { "type": "boolean", "description": "Deprecated: Output only. Use `permissionDetails/inherited` instead." } } } }, "pendingOwner": { "type": "boolean", "description": "Whether the account associated with this permission is a pending owner. Only populated for permissions of type `user` for files that aren't in a shared drive." }, "emailAddress": { "type": "string", "description": "Output only. The email address of the user or group to which this permission refers.", "readOnly": true }, "id": { "type": "string", "description": "Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in the [User resource](https://developers.google.com/workspace/drive/api/reference/rest/v3/User) as `permissionId`. IDs should be treated as opaque values." }, "type": { "type": "string", "description": "The type of the grantee. Supported values include: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. If `type` is `domain`, you must provide a `domain`. If `type` is `anyone`, no extra information is required." }, "view": { "type": "string", "description": "Indicates the view for this permission. Only populated for permissions that belong to a view. The only supported values are `published` and `metadata`: * `published`: The permission's role is `publishedReader`. * `metadata`: The item is only visible to the `metadata` view because the item has limited access and the scope has at least read access to the parent. The `metadata` view is only supported on folders. For more information, see [Views](https://developers.google.com/workspace/drive/api/guides/ref-roles#views)." }, "displayName": { "type": "string", "description": "Output only. 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 \"Dana A.\" * `group` - Name of the Google Group, such as \"The Company Administrators.\" * `domain` - String domain name, such as \"cymbalgroup.com.\" * `anyone` - No `displayName` is present." }, "photoLink": { "type": "string", "description": "Output only. A link to the user's profile photo, if available." }, "permissionDetails": { "type": "array", "description": "Output only. Details of whether the permissions on this item are inherited or are directly on this item.", "readOnly": true, "items": { "type": "object", "properties": { "inherited": { "type": "boolean", "description": "Output only. Whether this permission is inherited. This field is always populated. This is an output-only field." }, "role": { "type": "string", "description": "Output only. The primary role for this user. Supported values include: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles)." }, "inheritedFrom": { "type": "string", "description": "Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives.", "readOnly": true }, "permissionType": { "type": "string", "description": "Output only. The permission type for this user. Supported values include: * `file` * `member`" } } } }, "kind": { "type": "string", "description": "Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#permission\"`.", "default": "drive#permission" }, "expirationTime": { "type": "string", "description": "The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future", "format": "date-time" }, "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`." } } }, "TeamDrive": { "type": "object", "description": "Deprecated: use the drive collection instead. Next ID: 33", "properties": { "name": { "type": "string", "description": "The name of this Team Drive." }, "createdTime": { "type": "string", "description": "The time at which the Team Drive was created (RFC 3339 date-time).", "format": "date-time" }, "colorRgb": { "type": "string", "description": "The color of this Team Drive as an RGB hex string. It can only be set on a `drive.teamdrives.update` request that does not set `themeId`." }, "restrictions": { "type": "object", "description": "A set of restrictions that apply to this Team Drive or items inside this Team Drive.", "properties": { "adminManagedRestrictions": { "type": "boolean", "description": "Whether administrative privileges on this Team Drive are required to modify restrictions." }, "domainUsersOnly": { "type": "boolean", "description": "Whether access to this Team Drive and items inside this Team Drive is restricted to users of the domain to which this Team Drive belongs. This restriction may be overridden by other sharing policies controlled outside of this Team Drive." }, "copyRequiresWriterPermission": { "type": "boolean", "description": "Whether the options to copy, print, or download files inside this Team Drive, should be disabled for readers and commenters. When this restriction is set to `true`, it will override the similarly named field to `true` for any file inside this Team Drive." }, "downloadRestriction": { "$ref": "#/$defs/DownloadRestriction" }, "teamMembersOnly": { "type": "boolean", "description": "Whether access to items inside this Team Drive is restricted to members of this Team Drive." }, "sharingFoldersRequiresOrganizerPermission": { "type": "boolean", "description": "If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders." } } }, "themeId": { "type": "string", "description": "The ID of the theme from which the background image and color will be set. The set of possible `teamDriveThemes` can be retrieved from a `drive.about.get` response. When not specified on a `drive.teamdrives.create` request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set `colorRgb` or `backgroundImageFile`." }, "capabilities": { "type": "object", "description": "Capabilities the current user has on this Team Drive.", "properties": { "canTrashChildren": { "type": "boolean", "description": "Whether the current user can trash children from folders in this Team Drive." }, "canListChildren": { "type": "boolean", "description": "Whether the current user can list the children of folders in this Team Drive." }, "canRename": { "type": "boolean", "description": "Whether the current user can rename files or folders in this Team Drive." }, "canChangeTeamDriveBackground": { "type": "boolean", "description": "Whether the current user can change the background of this Team Drive." }, "canChangeSharingFoldersRequiresOrganizerPermissionRestriction": { "type": "boolean", "description": "Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this Team Drive." }, "canRenameTeamDrive": { "type": "boolean", "description": "Whether the current user can rename this Team Drive." }, "canReadRevisions": { "type": "boolean", "description": "Whether the current user can read the revisions resource of files in this Team Drive." }, "canDownload": { "type": "boolean", "description": "Whether the current user can download files in this Team Drive." }, "canCopy": { "type": "boolean", "description": "Whether the current user can copy files in this Team Drive." }, "canChangeTeamMembersOnlyRestriction": { "type": "boolean", "description": "Whether the current user can change the `teamMembersOnly` restriction of this Team Drive." }, "canDeleteChildren": { "type": "boolean", "description": "Whether the current user can delete children from folders in this Team Drive." }, "canEdit": { "type": "boolean", "description": "Whether the current user can edit files in this Team Drive" }, "canChangeDownloadRestriction": { "type": "boolean", "description": "Output only. Whether the current user can change organizer-applied download restrictions of this shared drive.", "readOnly": true }, "canChangeCopyRequiresWriterPermissionRestriction": { "type": "boolean", "description": "Whether the current user can change the `copyRequiresWriterPermission` restriction of this Team Drive." }, "canRemoveChildren": { "type": "boolean", "description": "Deprecated: Use `canDeleteChildren` or `canTrashChildren` instead." }, "canManageMembers": { "type": "boolean", "description": "Whether the current user can add members to this Team Drive or remove them or change their role." }, "canChangeDomainUsersOnlyRestriction": { "type": "boolean", "description": "Whether the current user can change the `domainUsersOnly` restriction of this Team Drive." }, "canComment": { "type": "boolean", "description": "Whether the current user can comment on files in this Team Drive." }, "canShare": { "type": "boolean", "description": "Whether the current user can share files or folders in this Team Drive." }, "canAddChildren": { "type": "boolean", "description": "Whether the current user can add children to folders in this Team Drive." }, "canDeleteTeamDrive": { "type": "boolean", "description": "Whether the current user can delete this Team Drive. Attempting to delete the Team Drive may still fail if there are untrashed items inside the Team Drive." }, "canResetTeamDriveRestrictions": { "type": "boolean", "description": "Whether the current user can reset the Team Drive restrictions to defaults." } } }, "kind": { "type": "string", "description": "Identifies what kind of resource this is. Value: the fixed string `\"drive#teamDrive\"`.", "default": "drive#teamDrive" }, "backgroundImageFile": { "type": "object", "description": "The background image file for a Team Drive.", "properties": { "yCoordinate": { "type": "number", "description": "The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.", "format": "float" }, "width": { "type": "number", "description": "The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high.", "format": "float" }, "id": { "type": "string", "description": "The ID of an image file in Drive to use for the background image." }, "xCoordinate": { "type": "number", "description": "The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image.", "format": "float" } } }, "id": { "type": "string", "description": "The ID of this Team Drive which is also the ID of the top level folder of this Team Drive." }, "orgUnitId": { "type": "string", "description": "The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`." }, "backgroundImageLink": { "type": "string", "description": "A short-lived link to this Team Drive's background image." } } }, "User": { "type": "object", "description": "Information about a Drive user.", "properties": { "photoLink": { "type": "string", "description": "Output only. A link to the user's profile photo, if available.", "readOnly": true }, "emailAddress": { "type": "string", "description": "Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.", "readOnly": true }, "me": { "type": "boolean", "description": "Output only. Whether this user is the requesting user.", "readOnly": true }, "displayName": { "type": "string", "description": "Output only. A plain text displayable name for this user.", "readOnly": true }, "kind": { "type": "string", "description": "Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`.", "default": "drive#user", "readOnly": true }, "permissionId": { "type": "string", "description": "Output only. The user's ID as visible in Permission resources.", "readOnly": true } } } } }