Close httplib2 connections.
- get(includeSubscribed=None, maxChangeIdCount=None, startChangeId=None)
get(includeSubscribed=None, maxChangeIdCount=None, startChangeId=None, x__xgafv=None)
Gets the information about the current user along with Drive API settings
get(includeSubscribed=None, maxChangeIdCount=None, startChangeId=None)
+ get(includeSubscribed=None, maxChangeIdCount=None, startChangeId=None, x__xgafv=None)
Gets the information about the current user along with Drive API settings Args: - includeSubscribed: boolean, Whether to count changes outside the My Drive hierarchy. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive will be omitted from the maxChangeIdCount. + includeSubscribed: boolean, Whether to count changes outside the My Drive hierarchy. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive will be omitted from the `maxChangeIdCount`. maxChangeIdCount: string, Maximum number of remaining change IDs to count startChangeId: string, Change ID to start counting from when calculating number of remaining change IDs + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format Returns: An object of the form: @@ -113,12 +117,8 @@diff --git a/docs/dyn/drive_v2.apps.html b/docs/dyn/drive_v2.apps.html index 0e3053fd4a6..502401b9a74 100644 --- a/docs/dyn/drive_v2.apps.html +++ b/docs/dyn/drive_v2.apps.html @@ -72,16 +72,16 @@ -Method Details
}, ], "canCreateDrives": True or False, # Whether the user can create shared drives. - "canCreateTeamDrives": True or False, # Deprecated - use canCreateDrives instead. - "domainSharingPolicy": "A String", # The domain sharing policy for the current user. Possible values are: - # - allowed - # - allowedWithWarning - # - incomingOnly - # - disallowed + "canCreateTeamDrives": True or False, # Deprecated: Use `canCreateDrives` instead. + "domainSharingPolicy": "A String", # The domain sharing policy for the current user. Possible values are: * `allowed` * `allowedWithWarning` * `incomingOnly` * `disallowed` "driveThemes": [ # A list of themes that are supported for shared drives. { "backgroundImageLink": "A String", # A link to this theme's background image. @@ -153,7 +153,7 @@Method Details
}, ], "isCurrentAppInstalled": True or False, # A boolean indicating whether the authenticated app is installed by the authenticated user. - "kind": "drive#about", # This is always drive#about. + "kind": "drive#about", # This is always `drive#about`. "languageCode": "A String", # The user's language or locale code, as defined by BCP 47, with some extensions from Unicode's LDML format (http://www.unicode.org/reports/tr35/). "largestChangeId": "A String", # The largest change id. "maxUploadSizes": [ # List of max upload sizes for each file type. The most specific type takes precedence. @@ -174,27 +174,25 @@Method Details
"quotaBytesUsed": "A String", # The number of quota bytes used by Google Drive. "quotaBytesUsedAggregate": "A String", # The number of quota bytes used by all Google apps (Drive, Picasa, etc.). "quotaBytesUsedInTrash": "A String", # The number of quota bytes used by trashed items. - "quotaType": "A String", # The type of the user's storage quota. Possible values are: - # - LIMITED - # - UNLIMITED + "quotaType": "A String", # The type of the user's storage quota. Possible values are: * `LIMITED` * `UNLIMITED` "remainingChangeIds": "A String", # The number of remaining change ids, limited to no more than 2500. "rootFolderId": "A String", # The id of the root folder. "selfLink": "A String", # A link back to this item. - "teamDriveThemes": [ # Deprecated - use driveThemes instead. + "teamDriveThemes": [ # Deprecated: Use `driveThemes` instead. { - "backgroundImageLink": "A String", # Deprecated - use driveThemes/backgroundImageLink instead. - "colorRgb": "A String", # Deprecated - use driveThemes/colorRgb instead. - "id": "A String", # Deprecated - use driveThemes/id instead. + "backgroundImageLink": "A String", # Deprecated: Use `driveThemes/backgroundImageLink` instead. + "colorRgb": "A String", # Deprecated: Use `driveThemes/colorRgb` instead. + "id": "A String", # Deprecated: Use `driveThemes/id` instead. }, ], "user": { # Information about a Drive user. # The authenticated user. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, }
Close httplib2 connections.
+get(appId, x__xgafv=None)
Gets a specific app.
- list(appFilterExtensions=None, appFilterMimeTypes=None, languageCode=None)
list(appFilterExtensions=None, appFilterMimeTypes=None, languageCode=None, x__xgafv=None)
Lists a user's installed apps.
get(appId)
+ get(appId, x__xgafv=None)
Gets a specific app. Args: appId: string, The ID of the app. (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format Returns: An object of the form: @@ -106,21 +110,18 @@Method Details
"hasDriveWideScope": True or False, # Whether the app has drive-wide scope. An app with drive-wide scope can access all files in the user's drive. "icons": [ # The various icons for the app. { - "category": "A String", # Category of the icon. Allowed values are: - # - application - icon for the application - # - document - icon for a file associated with the app - # - documentShared - icon for a shared file associated with the app + "category": "A String", # Category of the icon. Allowed values are: * `application` - icon for the application * `document` - icon for a file associated with the app * `documentShared` - icon for a shared file associated with the app "iconUrl": "A String", # URL for the icon. "size": 42, # Size of the icon. Represented as the maximum of the width and height. }, ], "id": "A String", # The ID of the app. "installed": True or False, # Whether the app is installed. - "kind": "drive#app", # This is always drive#app. + "kind": "drive#app", # This is always `drive#app`. "longDescription": "A String", # A long description of the app. "name": "A String", # The name of the app. "objectType": "A String", # The type of object this app creates (e.g. Chart). If empty, the app name should be used instead. - "openUrlTemplate": "A String", # The template url for opening files with this app. The template will contain {ids} and/or {exportIds} to be replaced by the actual file ids. See Open Files for the full documentation. + "openUrlTemplate": "A String", # The template url for opening files with this app. The template will contain `{ids}` and/or `{exportIds}` to be replaced by the actual file ids. See Open Files for the full documentation. "primaryFileExtensions": [ # The list of primary file extensions. "A String", ], @@ -145,13 +146,17 @@Method Details
list(appFilterExtensions=None, appFilterMimeTypes=None, languageCode=None)
+ list(appFilterExtensions=None, appFilterMimeTypes=None, languageCode=None, x__xgafv=None)
Lists a user's installed apps. Args: - appFilterExtensions: string, A comma-separated list of file extensions for open with filtering. All apps within the given app query scope which can open any of the given file extensions will be included in the response. If appFilterMimeTypes are provided as well, the result is a union of the two resulting app lists. - appFilterMimeTypes: string, A comma-separated list of MIME types for open with filtering. All apps within the given app query scope which can open any of the given MIME types will be included in the response. If appFilterExtensions are provided as well, the result is a union of the two resulting app lists. + appFilterExtensions: string, A comma-separated list of file extensions for open with filtering. All apps within the given app query scope which can open any of the given file extensions will be included in the response. If `appFilterMimeTypes` are provided as well, the result is a union of the two resulting app lists. + appFilterMimeTypes: string, A comma-separated list of MIME types for open with filtering. All apps within the given app query scope which can open any of the given MIME types will be included in the response. If `appFilterExtensions` are provided as well, the result is a union of the two resulting app lists. languageCode: string, A language or locale code, as defined by BCP 47, with some extensions from Unicode's LDML format (http://www.unicode.org/reports/tr35/). + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format Returns: An object of the form: @@ -169,21 +174,18 @@Method Details
"hasDriveWideScope": True or False, # Whether the app has drive-wide scope. An app with drive-wide scope can access all files in the user's drive. "icons": [ # The various icons for the app. { - "category": "A String", # Category of the icon. Allowed values are: - # - application - icon for the application - # - document - icon for a file associated with the app - # - documentShared - icon for a shared file associated with the app + "category": "A String", # Category of the icon. Allowed values are: * `application` - icon for the application * `document` - icon for a file associated with the app * `documentShared` - icon for a shared file associated with the app "iconUrl": "A String", # URL for the icon. "size": 42, # Size of the icon. Represented as the maximum of the width and height. }, ], "id": "A String", # The ID of the app. "installed": True or False, # Whether the app is installed. - "kind": "drive#app", # This is always drive#app. + "kind": "drive#app", # This is always `drive#app`. "longDescription": "A String", # A long description of the app. "name": "A String", # The name of the app. "objectType": "A String", # The type of object this app creates (e.g. Chart). If empty, the app name should be used instead. - "openUrlTemplate": "A String", # The template url for opening files with this app. The template will contain {ids} and/or {exportIds} to be replaced by the actual file ids. See Open Files for the full documentation. + "openUrlTemplate": "A String", # The template url for opening files with this app. The template will contain `{ids}` and/or `{exportIds}` to be replaced by the actual file ids. See Open Files for the full documentation. "primaryFileExtensions": [ # The list of primary file extensions. "A String", ], @@ -206,7 +208,7 @@Method Details
"useByDefault": True or False, # Whether the app is selected as the default handler for the types it supports. }, ], - "kind": "drive#appList", # This is always drive#appList. + "kind": "drive#appList", # This is always `drive#appList`. "selfLink": "A String", # A link back to this list. }
Close httplib2 connections.
- get(changeId, driveId=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)
Deprecated - Use changes.getStartPageToken and changes.list to retrieve recent changes.
+get(changeId, driveId=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None, x__xgafv=None)
+Deprecated: Use `changes.getStartPageToken` and `changes.list` to retrieve recent changes.
- getStartPageToken(driveId=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)
getStartPageToken(driveId=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None, x__xgafv=None)
Gets the starting pageToken for listing future changes.
+list(driveId=None, includeCorpusRemovals=None, includeDeleted=None, includeItemsFromAllDrives=None, includeLabels=None, includePermissionsForView=None, includeSubscribed=None, includeTeamDriveItems=None, maxResults=None, pageToken=None, spaces=None, startChangeId=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None, x__xgafv=None)
Lists the changes for a user or shared drive.
Retrieves the next page of results.
+watch(body=None, driveId=None, includeCorpusRemovals=None, includeDeleted=None, includeItemsFromAllDrives=None, includeLabels=None, includePermissionsForView=None, includeSubscribed=None, includeTeamDriveItems=None, maxResults=None, pageToken=None, spaces=None, startChangeId=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None, x__xgafv=None)
Subscribe to changes for a user.
get(changeId, driveId=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)
- Deprecated - Use changes.getStartPageToken and changes.list to retrieve recent changes. +get(changeId, driveId=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None, x__xgafv=None)+Deprecated: Use `changes.getStartPageToken` and `changes.list` to retrieve recent changes. Args: changeId: string, The ID of the change. (required) - driveId: string, The shared drive from which the change is returned. + driveId: string, The shared drive from which the change will be returned. supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. - supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead. - teamDriveId: string, Deprecated use driveId instead. + supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead. + teamDriveId: string, Deprecated: Use `driveId` instead. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format Returns: An object of the form: { # Representation of a change to a file or shared drive. - "changeType": "A String", # The type of the change. Possible values are file and drive. + "changeType": "A String", # The type of the change. Possible values are `file` and `drive`. "deleted": True or False, # Whether the file or shared drive has been removed from this list of changes, for example by deletion or loss of access. "drive": { # Representation of a shared drive. # The updated state of the shared drive. Present if the changeType is drive, the user is still a member of the shared drive, and the shared drive has not been deleted. - "backgroundImageFile": { # 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. + "backgroundImageFile": { # 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. "id": "A String", # The ID of an image file in Google Drive to use for the background image. "width": 3.14, # 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. "xCoordinate": 3.14, # 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. "yCoordinate": 3.14, # 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. }, - "backgroundImageLink": "A String", # A short-lived link to this shared drive's background image. - "capabilities": { # Capabilities the current user has on this shared drive. - "canAddChildren": True or False, # Whether the current user can add children to folders in this shared drive. - "canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive. - "canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the domainUsersOnly restriction of this shared drive. - "canChangeDriveBackground": True or False, # Whether the current user can change the background of this shared drive. - "canChangeDriveMembersOnlyRestriction": True or False, # Whether the current user can change the driveMembersOnly restriction of this shared drive. - "canChangeSharingFoldersRequiresOrganizerPermissionRestriction": True or False, # Whether the current user can change the sharingFoldersRequiresOrganizerPermission restriction of this shared drive. - "canComment": True or False, # Whether the current user can comment on files in this shared drive. - "canCopy": True or False, # Whether the current user can copy files in this shared drive. - "canDeleteChildren": True or False, # Whether the current user can delete children from folders in this shared drive. - "canDeleteDrive": True or False, # 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. - "canDownload": True or False, # Whether the current user can download files in this shared drive. - "canEdit": True or False, # Whether the current user can edit files in this shared drive - "canListChildren": True or False, # Whether the current user can list the children of folders in this shared drive. - "canManageMembers": True or False, # Whether the current user can add members to this shared drive or remove them or change their role. - "canReadRevisions": True or False, # Whether the current user can read the revisions resource of files in this shared drive. - "canRename": True or False, # Whether the current user can rename files or folders in this shared drive. - "canRenameDrive": True or False, # Whether the current user can rename this shared drive. - "canResetDriveRestrictions": True or False, # Whether the current user can reset the shared drive restrictions to defaults. - "canShare": True or False, # Whether the current user can share files or folders in this shared drive. - "canTrashChildren": True or False, # Whether the current user can trash children from folders in this shared drive. + "backgroundImageLink": "A String", # Output only. A short-lived link to this shared drive's background image. + "capabilities": { # Output only. Capabilities the current user has on this shared drive. + "canAddChildren": True or False, # Output only. Whether the current user can add children to folders in this shared drive. + "canChangeCopyRequiresWriterPermissionRestriction": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this shared drive. + "canChangeDomainUsersOnlyRestriction": True or False, # Output only. Whether the current user can change the `domainUsersOnly` restriction of this shared drive. + "canChangeDriveBackground": True or False, # Output only. Whether the current user can change the background of this shared drive. + "canChangeDriveMembersOnlyRestriction": True or False, # Output only. Whether the current user can change the `driveMembersOnly` restriction of this shared drive. + "canChangeSharingFoldersRequiresOrganizerPermissionRestriction": True or False, # Output only. Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this shared drive. + "canComment": True or False, # Output only. Whether the current user can comment on files in this shared drive. + "canCopy": True or False, # Output only. Whether the current user can copy files in this shared drive. + "canDeleteChildren": True or False, # Output only. Whether the current user can delete children from folders in this shared drive. + "canDeleteDrive": True or False, # 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. + "canDownload": True or False, # Output only. Whether the current user can download files in this shared drive. + "canEdit": True or False, # Output only. Whether the current user can edit files in this shared drive + "canListChildren": True or False, # Output only. Whether the current user can list the children of folders in this shared drive. + "canManageMembers": True or False, # Output only. Whether the current user can add members to this shared drive or remove them or change their role. + "canReadRevisions": True or False, # Output only. Whether the current user can read the revisions resource of files in this shared drive. + "canRename": True or False, # Output only. Whether the current user can rename files or folders in this shared drive. + "canRenameDrive": True or False, # Output only. Whether the current user can rename this shared drive. + "canResetDriveRestrictions": True or False, # Output only. Whether the current user can reset the shared drive restrictions to defaults. + "canShare": True or False, # Output only. Whether the current user can share files or folders in this shared drive. + "canTrashChildren": True or False, # Output only. Whether the current user can trash children from folders in this shared drive. }, - "colorRgb": "A String", # 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. + "colorRgb": "A String", # 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`. "createdDate": "A String", # The time at which the shared drive was created (RFC 3339 date-time). "hidden": True or False, # Whether the shared drive is hidden from default view. - "id": "A String", # The ID of this shared drive which is also the ID of the top level folder of this shared drive. - "kind": "drive#drive", # This is always drive#drive + "id": "A String", # Output only. The ID of this shared drive which is also the ID of the top level folder of this shared drive. + "kind": "drive#drive", # Output only. This is always `drive#drive` "name": "A String", # The name of this shared drive. - "orgUnitId": "A String", # The organizational unit of this shared drive. This field is only populated on drives.list responses when the useDomainAdminAccess parameter is set to true. + "orgUnitId": "A String", # 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`. "restrictions": { # A set of restrictions that apply to this shared drive or items inside this shared drive. "adminManagedRestrictions": True or False, # Whether administrative privileges on this shared drive are required to modify restrictions. - "copyRequiresWriterPermission": True or False, # 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. + "copyRequiresWriterPermission": True or False, # 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. "domainUsersOnly": True or False, # 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. "driveMembersOnly": True or False, # Whether access to items inside this shared drive is restricted to its members. "sharingFoldersRequiresOrganizerPermission": True or False, # 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": "A String", # 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.insert 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. + "themeId": "A String", # 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.insert` 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`. }, "driveId": "A String", # The ID of the shared drive associated with this change. "file": { # The metadata for a file. # The updated state of the file. Present if the type is file and the file has not been removed from this list of changes. - "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer. - "appDataContents": True or False, # Whether this file is in the Application Data folder. - "canComment": True or False, # Deprecated: use capabilities/canComment. - "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions. - "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. - "canAcceptOwnership": True or False, # Whether the current user is the pending owner of the file. Not populated for shared drive files. - "canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder. - "canAddFolderFromAnotherDrive": True or False, # 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 is not a folder. Only populated for items in shared drives. - "canAddMyDriveParent": True or False, # 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": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file. - "canChangeRestrictedDownload": True or False, # Deprecated - "canChangeSecurityUpdateEnabled": True or False, # Whether the current user can change the securityUpdateEnabled field on link share metadata. - "canComment": True or False, # Whether the current user can comment on this file. - "canCopy": True or False, # 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 is not a folder. - "canDelete": True or False, # Whether the current user can delete this file. - "canDeleteChildren": True or False, # Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. - "canDownload": True or False, # Whether the current user can download this file. - "canEdit": True or False, # 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. - "canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder. - "canModifyContent": True or False, # Whether the current user can modify the content of this file. - "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file. - "canModifyLabels": True or False, # Whether the current user can modify the labels on this file. - "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. - "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. - "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not 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. - "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead. - "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. - "canMoveItemOutOfDrive": True or False, # 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 is being added. - "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. - "canMoveItemWithinDrive": True or False, # 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 is being added and the parent that is being removed. - "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. - "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. - "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. - "canReadLabels": True or False, # Whether the current user can read the labels on this file. - "canReadRevisions": True or False, # 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 isn't a folder, can be read. - "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. - "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. - "canRemoveMyDriveParent": True or False, # 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": True or False, # Whether the current user can rename this file. - "canShare": True or False, # Whether the current user can modify the sharing settings for this file. - "canTrash": True or False, # Whether the current user can move this file to trash. - "canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. - "canUntrash": True or False, # Whether the current user can restore this file from trash. + "alternateLink": "A String", # Output only. A link for opening the file in a relevant Google editor or viewer. + "appDataContents": True or False, # Output only. Whether this file is in the Application Data folder. + "canComment": True or False, # Output only. Deprecated: Use `capabilities/canComment` instead. + "canReadRevisions": True or False, # Output only. Deprecated: Use `capabilities/canReadRevisions` instead. + "capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. + "canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files. + "canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always false when the item is not a folder. + "canAddFolderFromAnotherDrive": True or False, # 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 is not a folder. Only populated for items in shared drives. + "canAddMyDriveParent": True or False, # 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. + "canChangeCopyRequiresWriterPermission": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file. + "canChangeRestrictedDownload": True or False, # Output only. Deprecated. + "canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata. + "canComment": True or False, # Output only. Whether the current user can comment on this file. + "canCopy": True or False, # 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 itself if it is not a folder. + "canDelete": True or False, # Output only. Whether the current user can delete this file. + "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDownload": True or False, # Output only. Whether the current user can download this file. + "canEdit": True or False, # 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`. + "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. + "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. + "canModifyContentRestriction": True or False, # Output only. Whether the current user can modify restrictions on content of this file. + "canModifyLabels": True or False, # Output only. Whether the current user can modify the labels on the file. + "canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. + "canMoveChildrenOutOfTeamDrive": True or False, # Output only. Deprecated: Use `canMoveChildrenOutOfDrive` instead. + "canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is false when the item is not 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. + "canMoveChildrenWithinTeamDrive": True or False, # Output only. Deprecated: Use `canMoveChildrenWithinDrive` instead. + "canMoveItemIntoTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemOutOfDrive` instead. + "canMoveItemOutOfDrive": True or False, # 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 is being added. + "canMoveItemOutOfTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemOutOfDrive` instead. + "canMoveItemWithinDrive": True or False, # 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 is being added and the parent that is being removed. + "canMoveItemWithinTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemWithinDrive` instead. + "canMoveTeamDriveItem": True or False, # Output only. Deprecated: Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead. + "canReadDrive": True or False, # Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. + "canReadLabels": True or False, # Output only. Whether the current user can read the labels on the file. + "canReadRevisions": True or False, # 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 itself if it is not a folder, can be read. + "canReadTeamDrive": True or False, # Output only. Deprecated: Use `canReadDrive` instead. + "canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead. + "canRemoveMyDriveParent": True or False, # 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. + "canRename": True or False, # Output only. Whether the current user can rename this file. + "canShare": True or False, # Output only. Whether the current user can modify the sharing settings for this file. + "canTrash": True or False, # Output only. Whether the current user can move this file to trash. + "canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists. { # A restriction for accessing the content of the file. "readOnly": True or False, # 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": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true. - "restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`. + "restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly` is true. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, "restrictionDate": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true. - "type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction. + "type": "A String", # Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`. }, ], "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters. - "copyable": True or False, # Deprecated: use capabilities/canCopy. + "copyable": True or False, # Output only. Deprecated: Use `capabilities/canCopy` instead. "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp). - "defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used. + "defaultOpenWithLink": "A String", # Output only. A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used. "description": "A String", # A short description of the file. - "downloadUrl": "A String", # Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives. - "editable": True or False, # Deprecated: use capabilities/canEdit. - "embedLink": "A String", # A link for embedding the file. - "etag": "A String", # ETag of the file. - "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. - "exportLinks": { # Links for exporting Docs Editors files to specific formats. - "a_key": "A String", # A mapping from export format to URL + "downloadUrl": "A String", # Output only. Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. + "driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives. + "editable": True or False, # Output only. Deprecated: Use `capabilities/canEdit` instead. + "embedLink": "A String", # Output only. A link for embedding the file. + "etag": "A String", # Output only. ETag of the file. + "explicitlyTrashed": True or False, # Output only. Whether this file has been explicitly trashed, as opposed to recursively trashed. + "exportLinks": { # Output only. Links for exporting Docs Editors files to specific formats. + "a_key": "A String", }, - "fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "fileSize": "A String", # 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 is not populated for shortcuts or folders. + "fileExtension": "A String", # Output only. The final component of `fullFileExtension` with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "fileSize": "A String", # Output only. Size in bytes of blobs and first party editor files. Won't be populated for files that have no size, like shortcuts and folders. "folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder or a shortcut to a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette. - "fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives. - "hasThumbnail": True or False, # 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": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "iconLink": "A String", # A link to the file's icon. + "fullFileExtension": "A String", # Output only. The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "hasAugmentedPermissions": True or False, # Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives. + "hasThumbnail": True or False, # Output only. 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": "A String", # Output only. The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "iconLink": "A String", # Output only. A link to the file's icon. "id": "A String", # The ID of the file. - "imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content. - "aperture": 3.14, # The aperture used to create the photo (f-number). - "cameraMake": "A String", # The make of the camera used to create the photo. - "cameraModel": "A String", # The model of the camera used to create the photo. - "colorSpace": "A String", # The color space of the photo. - "date": "A String", # The date and time the photo was taken (EXIF format timestamp). - "exposureBias": 3.14, # The exposure bias of the photo (APEX value). - "exposureMode": "A String", # The exposure mode used to create the photo. - "exposureTime": 3.14, # The length of the exposure, in seconds. - "flashUsed": True or False, # Whether a flash was used to create the photo. - "focalLength": 3.14, # The focal length used to create the photo, in millimeters. - "height": 42, # The height of the image in pixels. - "isoSpeed": 42, # The ISO speed used to create the photo. - "lens": "A String", # The lens used to create the photo. - "location": { # Geographic location information stored in the image. - "altitude": 3.14, # The altitude stored in the image. - "latitude": 3.14, # The latitude stored in the image. - "longitude": 3.14, # The longitude stored in the image. + "imageMediaMetadata": { # Output only. Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content. + "aperture": 3.14, # Output only. The aperture used to create the photo (f-number). + "cameraMake": "A String", # Output only. The make of the camera used to create the photo. + "cameraModel": "A String", # Output only. The model of the camera used to create the photo. + "colorSpace": "A String", # Output only. The color space of the photo. + "date": "A String", # Output only. The date and time the photo was taken (EXIF format timestamp). + "exposureBias": 3.14, # Output only. The exposure bias of the photo (APEX value). + "exposureMode": "A String", # Output only. The exposure mode used to create the photo. + "exposureTime": 3.14, # Output only. The length of the exposure, in seconds. + "flashUsed": True or False, # Output only. Whether a flash was used to create the photo. + "focalLength": 3.14, # Output only. The focal length used to create the photo, in millimeters. + "height": 42, # Output only. The height of the image in pixels. + "isoSpeed": 42, # Output only. The ISO speed used to create the photo. + "lens": "A String", # Output only. The lens used to create the photo. + "location": { # Output only. Geographic location information stored in the image. + "altitude": 3.14, # Output only. The altitude stored in the image. + "latitude": 3.14, # Output only. The latitude stored in the image. + "longitude": 3.14, # Output only. The longitude stored in the image. }, - "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value). - "meteringMode": "A String", # The metering mode used to create the photo. - "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation. - "sensor": "A String", # The type of sensor used to create the photo. - "subjectDistance": 42, # The distance to the subject of the photo, in meters. - "whiteBalance": "A String", # The white balance mode used to create the photo. - "width": 42, # The width of the image in pixels. + "maxApertureValue": 3.14, # Output only. The smallest f-number of the lens at the focal length used to create the photo (APEX value). + "meteringMode": "A String", # Output only. The metering mode used to create the photo. + "rotation": 42, # Output only. The number of clockwise 90 degree rotations applied from the image's original orientation. + "sensor": "A String", # Output only. The type of sensor used to create the photo. + "subjectDistance": 42, # Output only. The distance to the subject of the photo, in meters. + "whiteBalance": "A String", # Output only. The white balance mode used to create the photo. + "width": 42, # Output only. The width of the image in pixels. }, - "indexableText": { # Indexable text attributes for the file (can only be written). For more information, see Manage file metadata. + "indexableText": { # Indexable text attributes for the file (can only be written) "text": "A String", # The text to be indexed for this file. }, - "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. - "kind": "drive#file", # The type of file. This is always drive#file. - "labelInfo": { # An overview of the labels on the file. - "labels": [ # The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned. - { # Representation of a label and its fields. - "fields": { # A map of the label's fields keyed by the field ID. - "a_key": { # Representation of a label field. + "isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app. + "kind": "drive#file", # Output only. The type of file. This is always `drive#file`. + "labelInfo": { # Output only. An overview of the labels on the file. + "labels": [ # 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. + { # Representation of a label and label fields. + "fields": { # A map of the fields on the label, keyed by the field's ID. + "a_key": { # Representation of field, which is a typed key-value pair. "dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD. "A String", ], - "id": "A String", # The identifier of this field. - "integer": [ # Only present if valueType is integer. + "id": "A String", # The identifier of this label field. + "integer": [ # Only present if `valueType` is `integer`. "A String", ], - "kind": "drive#labelField", # This is always drive#labelField. - "selection": [ # Only present if valueType is selection. + "kind": "drive#labelField", # This is always `drive#labelField`. + "selection": [ # Only present if `valueType` is `selection` "A String", ], - "text": [ # Only present if valueType is text. + "text": [ # Only present if `valueType` is `text`. "A String", ], - "user": [ # Only present if valueType is user. + "user": [ # Only present if `valueType` is `user`. { # Information about a Drive user. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, ], - "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: - # - dateString - # - integer - # - selection - # - text - # - user + "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: * `dateString` * `integer` * `selection` * `text` * `user` }, }, "id": "A String", # The ID of the label. - "kind": "drive#label", # This is always drive#label + "kind": "drive#label", # This is always `drive#label` "revisionId": "A String", # The revision ID of the label. }, ], }, "labels": { # A group of labels for the file. - "hidden": True or False, # Deprecated. - "modified": True or False, # Whether the file has been modified by this user. - "restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead. + "hidden": True or False, # Output only. Deprecated. + "modified": True or False, # Output only. Whether the file has been modified by this user. + "restricted": True or False, # Output only. Deprecated: Use `copyRequiresWriterPermission` instead. "starred": True or False, # Whether this file is starred by the user. - "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may 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. + "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files. "viewed": True or False, # Whether this file has been viewed by this user. }, - "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "lastModifyingUserName": "A String", # Name of the last user to modify this file. + "lastModifyingUserName": "A String", # Output only. Name of the last user to modify this file. "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp). "linkShareMetadata": { # Contains details about the link URLs that clients are using to refer to this item. - "securityUpdateEligible": True or False, # Whether the file is eligible for security update. - "securityUpdateEnabled": True or False, # Whether the security update is enabled for this file. + "securityUpdateEligible": True or False, # Output only. Whether the file is eligible for security update. + "securityUpdateEnabled": True or False, # Output only. Whether the security update is enabled for this file. }, "markedViewedByMeDate": "A String", # Deprecated. - "md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. + "md5Checksum": "A String", # Output only. An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. "mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type. "modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date. "modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set. - "openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used. + "openWithLinks": { # Output only. A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used. "a_key": "A String", }, - "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Google Drive. - "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives. - "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives. + "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the `title` field. This is only available for files with binary content in Google Drive. + "ownedByMe": True or False, # Output only. Whether the file is owned by the current user. Not populated for items in shared drives. + "ownerNames": [ # Output only. Name(s) of the owner(s) of this file. Not populated for items in shared drives. "A String", ], - "owners": [ # 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. + "owners": [ # 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. { # Information about a Drive user. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, ], - "parents": [ # Collection of parent folders which contain this file. - # If not specified as part of an insert 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 can also use the addParents and removeParents parameters to modify the parents list. + "parents": [ # Collection of parent folders which contain this file. If not specified as part of an insert 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 can also use the `addParents` and `removeParents` parameters to modify the parents list. { # A reference to a file's parent. "id": "A String", # The ID of the parent. - "isRoot": True or False, # Whether or not the parent is the root folder. - "kind": "drive#parentReference", # This is always drive#parentReference. - "parentLink": "A String", # A link to the parent. - "selfLink": "A String", # A link back to this reference. + "isRoot": True or False, # Output only. Whether or not the parent is the root folder. + "kind": "drive#parentReference", # Output only. This is always `drive#parentReference`. + "parentLink": "A String", # Output only. A link to the parent. + "selfLink": "A String", # Output only. A link back to this reference. }, ], - "permissionIds": [ # List of permission IDs for users with access to this file. + "permissionIds": [ # Output only. List of permission IDs for users with access to this file. "A String", ], - "permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives. + "permissions": [ # Output only. The list of permissions for users with access to this file. Not populated for items in shared drives. { # A permission for a file. - "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. + "additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future. "A String", ], - "authKey": "A String", # Deprecated. - "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. - "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain. - "emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group. - "etag": "A String", # The ETag of the permission. - "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - # - They cannot be set on shared drive items - # - They can only be set on user and group permissions - # - The date must be in the future - # - The date cannot be more than a year in the future - "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "kind": "drive#permission", # This is always drive#permission. - "name": "A String", # The name for this permission. - "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive. - "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "authKey": "A String", # Output only. Deprecated. + "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. + "domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`. + "emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`. + "etag": "A String", # Output only. The ETag of the permission. + "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests + "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "kind": "drive#permission", # Output only. This is always `drive#permission`. + "name": "A String", # Output only. The name for this permission. + "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. + "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. { - "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. + "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. - "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: - # - file - # - member - "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: - # - organizer - # - fileOrganizer - # - writer - # - reader + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` + "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, ], - "photoLink": "A String", # A link to the profile photo, if available. - "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: - # - owner - # - organizer - # - fileOrganizer - # - writer - # - reader - "selfLink": "A String", # A link back to this permission. - "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. + "photoLink": "A String", # Output only. A link to the profile photo, if available. + "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader` + "selfLink": "A String", # Output only. A link back to this permission. + "teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead. { - "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. + "additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead. "A String", ], - "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. - "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. - "role": "A String", # Deprecated - use permissionDetails/role instead. - "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. + "inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead. + "inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead. + "role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead. + "teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead. }, ], - "type": "A String", # The account type. Allowed values are: - # - user - # - group - # - domain - # - anyone - "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value. + "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` + "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. "withLink": True or False, # Whether the link is required for this permission. }, ], "properties": [ # The list of properties. - { # A key-value pair attached to a file that is either public or private to an application. - # The following limits apply to file properties: - # - Maximum of 100 properties total per file - # - Maximum of 30 private properties per app - # - Maximum of 30 public properties - # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property. - "etag": "A String", # ETag of the property. + { # A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property + "etag": "A String", # Output only. ETag of the property. "key": "A String", # The key of this property. - "kind": "drive#property", # This is always drive#property. - "selfLink": "A String", # The link back to this property. + "kind": "drive#property", # Output only. This is always `drive#property`. + "selfLink": "A String", # Output only. The link back to this property. "value": "A String", # The value of this property. - "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE). Private 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. + "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. Private 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. }, ], - "quotaBytesUsed": "A String", # The number of quota bytes used by this file. - "resourceKey": "A String", # A key needed to access the item via a shared link. - "selfLink": "A String", # A link back to this file. - "sha1Checksum": "A String", # The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "sha256Checksum": "A String", # The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "shareable": True or False, # Deprecated: use capabilities/canShare. - "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives. + "quotaBytesUsed": "A String", # Output only. The number of quota bytes used by this file. + "resourceKey": "A String", # Output only. A key needed to access the item via a shared link. + "selfLink": "A String", # Output only. A link back to this file. + "sha1Checksum": "A String", # 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 is not populated for Docs Editors or shortcut files. + "sha256Checksum": "A String", # 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 is not populated for Docs Editors or shortcut files. + "shareable": True or False, # Output only. Deprecated: Use `capabilities/canShare` instead. + "shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives. "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp). - "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "sharingUser": { # Information about a Drive user. # Output only. User that shared the item with the current user, if available. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut. + "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. "targetId": "A String", # The ID of the file that this shortcut points to. - "targetMimeType": "A String", # 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": "A String", # The ResourceKey for the target file. + "targetMimeType": "A String", # 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": "A String", # Output only. The ResourceKey for the target file. }, - "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'. + "spaces": [ # Output only. The list of spaces which contain the file. Supported values are `drive`, `appDataFolder` and `photos`. "A String", ], - "teamDriveId": "A String", # Deprecated - use driveId instead. + "teamDriveId": "A String", # Output only. Deprecated: Use `driveId` instead. "thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated. "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5. "mimeType": "A String", # The MIME type of the thumbnail. }, - "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. 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": "A String", # The thumbnail version for use in thumbnail cache invalidation. + "thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content. + "thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation. "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant. "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives. - "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "trashingUser": { # Information about a Drive user. # Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file. - "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. + "userPermission": { # A permission for a file. # Output only. The permissions for the authenticated user on this file. + "additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future. "A String", ], - "authKey": "A String", # Deprecated. - "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. - "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain. - "emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group. - "etag": "A String", # The ETag of the permission. - "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - # - They cannot be set on shared drive items - # - They can only be set on user and group permissions - # - The date must be in the future - # - The date cannot be more than a year in the future - "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "kind": "drive#permission", # This is always drive#permission. - "name": "A String", # The name for this permission. - "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive. - "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "authKey": "A String", # Output only. Deprecated. + "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. + "domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`. + "emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`. + "etag": "A String", # Output only. The ETag of the permission. + "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests + "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "kind": "drive#permission", # Output only. This is always `drive#permission`. + "name": "A String", # Output only. The name for this permission. + "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. + "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. { - "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. + "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. - "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: - # - file - # - member - "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: - # - organizer - # - fileOrganizer - # - writer - # - reader + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` + "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, ], - "photoLink": "A String", # A link to the profile photo, if available. - "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: - # - owner - # - organizer - # - fileOrganizer - # - writer - # - reader - "selfLink": "A String", # A link back to this permission. - "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. + "photoLink": "A String", # Output only. A link to the profile photo, if available. + "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader` + "selfLink": "A String", # Output only. A link back to this permission. + "teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead. { - "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. + "additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead. "A String", ], - "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. - "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. - "role": "A String", # Deprecated - use permissionDetails/role instead. - "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. + "inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead. + "inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead. + "role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead. + "teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead. }, ], - "type": "A String", # The account type. Allowed values are: - # - user - # - group - # - domain - # - anyone - "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value. + "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` + "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. "withLink": True or False, # Whether the link is required for this permission. }, - "version": "A String", # 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 requesting user. - "videoMediaMetadata": { # Metadata about video media. This will only be present for video types. - "durationMillis": "A String", # The duration of the video in milliseconds. - "height": 42, # The height of the video in pixels. - "width": 42, # The width of the video in pixels. + "version": "A String", # 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 requesting user. + "videoMediaMetadata": { # Output only. Metadata about video media. This will only be present for video types. + "durationMillis": "A String", # Output only. The duration of the video in milliseconds. + "height": 42, # Output only. The height of the video in pixels. + "width": 42, # Output only. The width of the video in pixels. }, - "webContentLink": "A String", # A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials. - "webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting. + "webContentLink": "A String", # Output only. A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials. + "webViewLink": "A String", # Output only. A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting. "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives. }, "fileId": "A String", # The ID of the file associated with this change. "id": "A String", # The ID of the change. - "kind": "drive#change", # This is always drive#change. + "kind": "drive#change", # This is always `drive#change`. "modificationDate": "A String", # The time of this modification. "selfLink": "A String", # A link back to this change. - "teamDrive": { # Deprecated: use the drive collection instead. # Deprecated - use drive instead. - "backgroundImageFile": { # An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field; it can only be set on drive.teamdrives.update requests that don't set themeId. When specified, all fields of the backgroundImageFile must be set. + "teamDrive": { # Deprecated: Use the `drive` collection instead. # Deprecated: Use `drive` instead. + "backgroundImageFile": { # An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field; it can only be set on `drive.teamdrives.update` requests that don't set `themeId`. When specified, all fields of the `backgroundImageFile` must be set. "id": "A String", # The ID of an image file in Drive to use for the background image. "width": 3.14, # 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. "xCoordinate": 3.14, # 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. @@ -600,11 +555,11 @@Method Details
"backgroundImageLink": "A String", # A short-lived link to this Team Drive's background image. "capabilities": { # Capabilities the current user has on this Team Drive. "canAddChildren": True or False, # Whether the current user can add children to folders in this Team Drive. - "canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this Team Drive. - "canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the domainUsersOnly restriction of this Team Drive. - "canChangeSharingFoldersRequiresOrganizerPermissionRestriction": True or False, # Whether the current user can change the sharingFoldersRequiresOrganizerPermission restriction of this Team Drive. + "canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the `copyRequiresWriterPermission` restriction of this Team Drive. + "canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the `domainUsersOnly` restriction of this Team Drive. + "canChangeSharingFoldersRequiresOrganizerPermissionRestriction": True or False, # Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this Team Drive. "canChangeTeamDriveBackground": True or False, # Whether the current user can change the background of this Team Drive. - "canChangeTeamMembersOnlyRestriction": True or False, # Whether the current user can change the teamMembersOnly restriction of this Team Drive. + "canChangeTeamMembersOnlyRestriction": True or False, # Whether the current user can change the `teamMembersOnly` restriction of this Team Drive. "canComment": True or False, # Whether the current user can comment on files in this Team Drive. "canCopy": True or False, # Whether the current user can copy files in this Team Drive. "canDeleteChildren": True or False, # Whether the current user can delete children from folders in this Team Drive. @@ -614,72 +569,80 @@Method Details
"canListChildren": True or False, # Whether the current user can list the children of folders in this Team Drive. "canManageMembers": True or False, # Whether the current user can add members to this Team Drive or remove them or change their role. "canReadRevisions": True or False, # Whether the current user can read the revisions resource of files in this Team Drive. - "canRemoveChildren": True or False, # Deprecated - use canDeleteChildren or canTrashChildren instead. + "canRemoveChildren": True or False, # Deprecated: Use `canDeleteChildren` or `canTrashChildren` instead. "canRename": True or False, # Whether the current user can rename files or folders in this Team Drive. "canRenameTeamDrive": True or False, # Whether the current user can rename this Team Drive. "canResetTeamDriveRestrictions": True or False, # Whether the current user can reset the Team Drive restrictions to defaults. "canShare": True or False, # Whether the current user can share files or folders in this Team Drive. "canTrashChildren": True or False, # Whether the current user can trash children from folders in this Team Drive. }, - "colorRgb": "A String", # 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. + "colorRgb": "A String", # 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`. "createdDate": "A String", # The time at which the Team Drive was created (RFC 3339 date-time). "id": "A String", # The ID of this Team Drive which is also the ID of the top level folder of this Team Drive. - "kind": "drive#teamDrive", # This is always drive#teamDrive + "kind": "drive#teamDrive", # This is always `drive#teamDrive` "name": "A String", # The name of this Team Drive. - "orgUnitId": "A String", # The organizational unit of this shared drive. This field is only populated on drives.list responses when the useDomainAdminAccess parameter is set to true. + "orgUnitId": "A String", # The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`. "restrictions": { # A set of restrictions that apply to this Team Drive or items inside this Team Drive. "adminManagedRestrictions": True or False, # Whether administrative privileges on this Team Drive are required to modify restrictions. - "copyRequiresWriterPermission": True or False, # 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. + "copyRequiresWriterPermission": True or False, # 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. "domainUsersOnly": True or False, # 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. "sharingFoldersRequiresOrganizerPermission": True or False, # 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. "teamMembersOnly": True or False, # Whether access to items inside this Team Drive is restricted to members of this Team Drive. }, - "themeId": "A String", # 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.insert 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. + "themeId": "A String", # 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.insert` 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`. }, - "teamDriveId": "A String", # Deprecated - use driveId instead. - "type": "A String", # Deprecated - use changeType instead. + "teamDriveId": "A String", # Deprecated: Use `driveId` instead. + "type": "A String", # Deprecated: Use `changeType` instead. }
getStartPageToken(driveId=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)
+ getStartPageToken(driveId=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None, x__xgafv=None)
Gets the starting pageToken for listing future changes.
Args:
- driveId: string, The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive is returned.
+ driveId: string, The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive will be returned.
supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
- supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
- teamDriveId: string, Deprecated use driveId instead.
+ supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead.
+ teamDriveId: string, Deprecated: Use `driveId` instead.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
{
- "kind": "drive#startPageToken", # Identifies what kind of resource this is. Value: the fixed string "drive#startPageToken".
+ "kind": "drive#startPageToken", # Identifies what kind of resource this is. Value: the fixed string `"drive#startPageToken"`.
"startPageToken": "A String", # The starting page token for listing changes.
}
list(driveId=None, includeCorpusRemovals=None, includeDeleted=None, includeItemsFromAllDrives=None, includeLabels=None, includePermissionsForView=None, includeSubscribed=None, includeTeamDriveItems=None, maxResults=None, pageToken=None, spaces=None, startChangeId=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)
+ list(driveId=None, includeCorpusRemovals=None, includeDeleted=None, includeItemsFromAllDrives=None, includeLabels=None, includePermissionsForView=None, includeSubscribed=None, includeTeamDriveItems=None, maxResults=None, pageToken=None, spaces=None, startChangeId=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None, x__xgafv=None)
Lists the changes for a user or shared drive. Args: - driveId: string, The shared drive from which changes are returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier. + driveId: string, The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier. includeCorpusRemovals: boolean, Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file. includeDeleted: boolean, Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access. includeItemsFromAllDrives: boolean, Whether both My Drive and shared drive items should be included in results. - includeLabels: string, A comma-separated list of IDs of labels to include in the labelInfo part of the response. - includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported. - includeSubscribed: boolean, Whether to include changes outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive are omitted from the result. - includeTeamDriveItems: boolean, Deprecated use includeItemsFromAllDrives instead. + includeLabels: string, A comma-separated list of IDs of labels to include in the `labelInfo` part of the response. + includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only `published` is supported. + includeSubscribed: boolean, Whether to include changes outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive will be omitted from the result. + includeTeamDriveItems: boolean, Deprecated: Use `includeItemsFromAllDrives` instead. maxResults: integer, Maximum number of changes to return. - pageToken: string, 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 or to the response from the getStartPageToken method. - spaces: string, A comma-separated list of spaces to query. Supported values are 'drive', 'appDataFolder' and 'photos'. - startChangeId: string, Deprecated - use pageToken instead. + pageToken: string, 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 or to the response from the getStartPageToken method. + spaces: string, A comma-separated list of spaces to query. Supported values are `drive`, `appDataFolder` and `photos`. + startChangeId: string, Deprecated: Use `pageToken` instead. supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. - supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead. - teamDriveId: string, Deprecated use driveId instead. + supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead. + teamDriveId: string, Deprecated: Use `driveId` instead. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format Returns: An object of the form: @@ -688,485 +651,436 @@Method Details
"etag": "A String", # The ETag of the list. "items": [ # The list of changes. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. { # Representation of a change to a file or shared drive. - "changeType": "A String", # The type of the change. Possible values are file and drive. + "changeType": "A String", # The type of the change. Possible values are `file` and `drive`. "deleted": True or False, # Whether the file or shared drive has been removed from this list of changes, for example by deletion or loss of access. "drive": { # Representation of a shared drive. # The updated state of the shared drive. Present if the changeType is drive, the user is still a member of the shared drive, and the shared drive has not been deleted. - "backgroundImageFile": { # 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. + "backgroundImageFile": { # 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. "id": "A String", # The ID of an image file in Google Drive to use for the background image. "width": 3.14, # 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. "xCoordinate": 3.14, # 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. "yCoordinate": 3.14, # 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. }, - "backgroundImageLink": "A String", # A short-lived link to this shared drive's background image. - "capabilities": { # Capabilities the current user has on this shared drive. - "canAddChildren": True or False, # Whether the current user can add children to folders in this shared drive. - "canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive. - "canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the domainUsersOnly restriction of this shared drive. - "canChangeDriveBackground": True or False, # Whether the current user can change the background of this shared drive. - "canChangeDriveMembersOnlyRestriction": True or False, # Whether the current user can change the driveMembersOnly restriction of this shared drive. - "canChangeSharingFoldersRequiresOrganizerPermissionRestriction": True or False, # Whether the current user can change the sharingFoldersRequiresOrganizerPermission restriction of this shared drive. - "canComment": True or False, # Whether the current user can comment on files in this shared drive. - "canCopy": True or False, # Whether the current user can copy files in this shared drive. - "canDeleteChildren": True or False, # Whether the current user can delete children from folders in this shared drive. - "canDeleteDrive": True or False, # 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. - "canDownload": True or False, # Whether the current user can download files in this shared drive. - "canEdit": True or False, # Whether the current user can edit files in this shared drive - "canListChildren": True or False, # Whether the current user can list the children of folders in this shared drive. - "canManageMembers": True or False, # Whether the current user can add members to this shared drive or remove them or change their role. - "canReadRevisions": True or False, # Whether the current user can read the revisions resource of files in this shared drive. - "canRename": True or False, # Whether the current user can rename files or folders in this shared drive. - "canRenameDrive": True or False, # Whether the current user can rename this shared drive. - "canResetDriveRestrictions": True or False, # Whether the current user can reset the shared drive restrictions to defaults. - "canShare": True or False, # Whether the current user can share files or folders in this shared drive. - "canTrashChildren": True or False, # Whether the current user can trash children from folders in this shared drive. + "backgroundImageLink": "A String", # Output only. A short-lived link to this shared drive's background image. + "capabilities": { # Output only. Capabilities the current user has on this shared drive. + "canAddChildren": True or False, # Output only. Whether the current user can add children to folders in this shared drive. + "canChangeCopyRequiresWriterPermissionRestriction": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this shared drive. + "canChangeDomainUsersOnlyRestriction": True or False, # Output only. Whether the current user can change the `domainUsersOnly` restriction of this shared drive. + "canChangeDriveBackground": True or False, # Output only. Whether the current user can change the background of this shared drive. + "canChangeDriveMembersOnlyRestriction": True or False, # Output only. Whether the current user can change the `driveMembersOnly` restriction of this shared drive. + "canChangeSharingFoldersRequiresOrganizerPermissionRestriction": True or False, # Output only. Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this shared drive. + "canComment": True or False, # Output only. Whether the current user can comment on files in this shared drive. + "canCopy": True or False, # Output only. Whether the current user can copy files in this shared drive. + "canDeleteChildren": True or False, # Output only. Whether the current user can delete children from folders in this shared drive. + "canDeleteDrive": True or False, # 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. + "canDownload": True or False, # Output only. Whether the current user can download files in this shared drive. + "canEdit": True or False, # Output only. Whether the current user can edit files in this shared drive + "canListChildren": True or False, # Output only. Whether the current user can list the children of folders in this shared drive. + "canManageMembers": True or False, # Output only. Whether the current user can add members to this shared drive or remove them or change their role. + "canReadRevisions": True or False, # Output only. Whether the current user can read the revisions resource of files in this shared drive. + "canRename": True or False, # Output only. Whether the current user can rename files or folders in this shared drive. + "canRenameDrive": True or False, # Output only. Whether the current user can rename this shared drive. + "canResetDriveRestrictions": True or False, # Output only. Whether the current user can reset the shared drive restrictions to defaults. + "canShare": True or False, # Output only. Whether the current user can share files or folders in this shared drive. + "canTrashChildren": True or False, # Output only. Whether the current user can trash children from folders in this shared drive. }, - "colorRgb": "A String", # 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. + "colorRgb": "A String", # 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`. "createdDate": "A String", # The time at which the shared drive was created (RFC 3339 date-time). "hidden": True or False, # Whether the shared drive is hidden from default view. - "id": "A String", # The ID of this shared drive which is also the ID of the top level folder of this shared drive. - "kind": "drive#drive", # This is always drive#drive + "id": "A String", # Output only. The ID of this shared drive which is also the ID of the top level folder of this shared drive. + "kind": "drive#drive", # Output only. This is always `drive#drive` "name": "A String", # The name of this shared drive. - "orgUnitId": "A String", # The organizational unit of this shared drive. This field is only populated on drives.list responses when the useDomainAdminAccess parameter is set to true. + "orgUnitId": "A String", # 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`. "restrictions": { # A set of restrictions that apply to this shared drive or items inside this shared drive. "adminManagedRestrictions": True or False, # Whether administrative privileges on this shared drive are required to modify restrictions. - "copyRequiresWriterPermission": True or False, # 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. + "copyRequiresWriterPermission": True or False, # 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. "domainUsersOnly": True or False, # 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. "driveMembersOnly": True or False, # Whether access to items inside this shared drive is restricted to its members. "sharingFoldersRequiresOrganizerPermission": True or False, # 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": "A String", # 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.insert 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. + "themeId": "A String", # 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.insert` 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`. }, "driveId": "A String", # The ID of the shared drive associated with this change. "file": { # The metadata for a file. # The updated state of the file. Present if the type is file and the file has not been removed from this list of changes. - "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer. - "appDataContents": True or False, # Whether this file is in the Application Data folder. - "canComment": True or False, # Deprecated: use capabilities/canComment. - "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions. - "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. - "canAcceptOwnership": True or False, # Whether the current user is the pending owner of the file. Not populated for shared drive files. - "canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder. - "canAddFolderFromAnotherDrive": True or False, # 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 is not a folder. Only populated for items in shared drives. - "canAddMyDriveParent": True or False, # 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": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file. - "canChangeRestrictedDownload": True or False, # Deprecated - "canChangeSecurityUpdateEnabled": True or False, # Whether the current user can change the securityUpdateEnabled field on link share metadata. - "canComment": True or False, # Whether the current user can comment on this file. - "canCopy": True or False, # 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 is not a folder. - "canDelete": True or False, # Whether the current user can delete this file. - "canDeleteChildren": True or False, # Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. - "canDownload": True or False, # Whether the current user can download this file. - "canEdit": True or False, # 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. - "canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder. - "canModifyContent": True or False, # Whether the current user can modify the content of this file. - "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file. - "canModifyLabels": True or False, # Whether the current user can modify the labels on this file. - "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. - "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. - "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not 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. - "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead. - "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. - "canMoveItemOutOfDrive": True or False, # 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 is being added. - "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. - "canMoveItemWithinDrive": True or False, # 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 is being added and the parent that is being removed. - "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. - "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. - "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. - "canReadLabels": True or False, # Whether the current user can read the labels on this file. - "canReadRevisions": True or False, # 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 isn't a folder, can be read. - "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. - "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. - "canRemoveMyDriveParent": True or False, # 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": True or False, # Whether the current user can rename this file. - "canShare": True or False, # Whether the current user can modify the sharing settings for this file. - "canTrash": True or False, # Whether the current user can move this file to trash. - "canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. - "canUntrash": True or False, # Whether the current user can restore this file from trash. + "alternateLink": "A String", # Output only. A link for opening the file in a relevant Google editor or viewer. + "appDataContents": True or False, # Output only. Whether this file is in the Application Data folder. + "canComment": True or False, # Output only. Deprecated: Use `capabilities/canComment` instead. + "canReadRevisions": True or False, # Output only. Deprecated: Use `capabilities/canReadRevisions` instead. + "capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. + "canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files. + "canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always false when the item is not a folder. + "canAddFolderFromAnotherDrive": True or False, # 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 is not a folder. Only populated for items in shared drives. + "canAddMyDriveParent": True or False, # 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. + "canChangeCopyRequiresWriterPermission": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file. + "canChangeRestrictedDownload": True or False, # Output only. Deprecated. + "canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata. + "canComment": True or False, # Output only. Whether the current user can comment on this file. + "canCopy": True or False, # 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 itself if it is not a folder. + "canDelete": True or False, # Output only. Whether the current user can delete this file. + "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDownload": True or False, # Output only. Whether the current user can download this file. + "canEdit": True or False, # 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`. + "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. + "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. + "canModifyContentRestriction": True or False, # Output only. Whether the current user can modify restrictions on content of this file. + "canModifyLabels": True or False, # Output only. Whether the current user can modify the labels on the file. + "canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. + "canMoveChildrenOutOfTeamDrive": True or False, # Output only. Deprecated: Use `canMoveChildrenOutOfDrive` instead. + "canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is false when the item is not 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. + "canMoveChildrenWithinTeamDrive": True or False, # Output only. Deprecated: Use `canMoveChildrenWithinDrive` instead. + "canMoveItemIntoTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemOutOfDrive` instead. + "canMoveItemOutOfDrive": True or False, # 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 is being added. + "canMoveItemOutOfTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemOutOfDrive` instead. + "canMoveItemWithinDrive": True or False, # 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 is being added and the parent that is being removed. + "canMoveItemWithinTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemWithinDrive` instead. + "canMoveTeamDriveItem": True or False, # Output only. Deprecated: Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead. + "canReadDrive": True or False, # Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. + "canReadLabels": True or False, # Output only. Whether the current user can read the labels on the file. + "canReadRevisions": True or False, # 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 itself if it is not a folder, can be read. + "canReadTeamDrive": True or False, # Output only. Deprecated: Use `canReadDrive` instead. + "canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead. + "canRemoveMyDriveParent": True or False, # 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. + "canRename": True or False, # Output only. Whether the current user can rename this file. + "canShare": True or False, # Output only. Whether the current user can modify the sharing settings for this file. + "canTrash": True or False, # Output only. Whether the current user can move this file to trash. + "canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists. { # A restriction for accessing the content of the file. "readOnly": True or False, # 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": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true. - "restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`. + "restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly` is true. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, "restrictionDate": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true. - "type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction. + "type": "A String", # Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`. }, ], "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters. - "copyable": True or False, # Deprecated: use capabilities/canCopy. + "copyable": True or False, # Output only. Deprecated: Use `capabilities/canCopy` instead. "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp). - "defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used. + "defaultOpenWithLink": "A String", # Output only. A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used. "description": "A String", # A short description of the file. - "downloadUrl": "A String", # Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives. - "editable": True or False, # Deprecated: use capabilities/canEdit. - "embedLink": "A String", # A link for embedding the file. - "etag": "A String", # ETag of the file. - "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. - "exportLinks": { # Links for exporting Docs Editors files to specific formats. - "a_key": "A String", # A mapping from export format to URL + "downloadUrl": "A String", # Output only. Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. + "driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives. + "editable": True or False, # Output only. Deprecated: Use `capabilities/canEdit` instead. + "embedLink": "A String", # Output only. A link for embedding the file. + "etag": "A String", # Output only. ETag of the file. + "explicitlyTrashed": True or False, # Output only. Whether this file has been explicitly trashed, as opposed to recursively trashed. + "exportLinks": { # Output only. Links for exporting Docs Editors files to specific formats. + "a_key": "A String", }, - "fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "fileSize": "A String", # 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 is not populated for shortcuts or folders. + "fileExtension": "A String", # Output only. The final component of `fullFileExtension` with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "fileSize": "A String", # Output only. Size in bytes of blobs and first party editor files. Won't be populated for files that have no size, like shortcuts and folders. "folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder or a shortcut to a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette. - "fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives. - "hasThumbnail": True or False, # 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": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "iconLink": "A String", # A link to the file's icon. + "fullFileExtension": "A String", # Output only. The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "hasAugmentedPermissions": True or False, # Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives. + "hasThumbnail": True or False, # Output only. 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": "A String", # Output only. The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "iconLink": "A String", # Output only. A link to the file's icon. "id": "A String", # The ID of the file. - "imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content. - "aperture": 3.14, # The aperture used to create the photo (f-number). - "cameraMake": "A String", # The make of the camera used to create the photo. - "cameraModel": "A String", # The model of the camera used to create the photo. - "colorSpace": "A String", # The color space of the photo. - "date": "A String", # The date and time the photo was taken (EXIF format timestamp). - "exposureBias": 3.14, # The exposure bias of the photo (APEX value). - "exposureMode": "A String", # The exposure mode used to create the photo. - "exposureTime": 3.14, # The length of the exposure, in seconds. - "flashUsed": True or False, # Whether a flash was used to create the photo. - "focalLength": 3.14, # The focal length used to create the photo, in millimeters. - "height": 42, # The height of the image in pixels. - "isoSpeed": 42, # The ISO speed used to create the photo. - "lens": "A String", # The lens used to create the photo. - "location": { # Geographic location information stored in the image. - "altitude": 3.14, # The altitude stored in the image. - "latitude": 3.14, # The latitude stored in the image. - "longitude": 3.14, # The longitude stored in the image. + "imageMediaMetadata": { # Output only. Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content. + "aperture": 3.14, # Output only. The aperture used to create the photo (f-number). + "cameraMake": "A String", # Output only. The make of the camera used to create the photo. + "cameraModel": "A String", # Output only. The model of the camera used to create the photo. + "colorSpace": "A String", # Output only. The color space of the photo. + "date": "A String", # Output only. The date and time the photo was taken (EXIF format timestamp). + "exposureBias": 3.14, # Output only. The exposure bias of the photo (APEX value). + "exposureMode": "A String", # Output only. The exposure mode used to create the photo. + "exposureTime": 3.14, # Output only. The length of the exposure, in seconds. + "flashUsed": True or False, # Output only. Whether a flash was used to create the photo. + "focalLength": 3.14, # Output only. The focal length used to create the photo, in millimeters. + "height": 42, # Output only. The height of the image in pixels. + "isoSpeed": 42, # Output only. The ISO speed used to create the photo. + "lens": "A String", # Output only. The lens used to create the photo. + "location": { # Output only. Geographic location information stored in the image. + "altitude": 3.14, # Output only. The altitude stored in the image. + "latitude": 3.14, # Output only. The latitude stored in the image. + "longitude": 3.14, # Output only. The longitude stored in the image. }, - "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value). - "meteringMode": "A String", # The metering mode used to create the photo. - "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation. - "sensor": "A String", # The type of sensor used to create the photo. - "subjectDistance": 42, # The distance to the subject of the photo, in meters. - "whiteBalance": "A String", # The white balance mode used to create the photo. - "width": 42, # The width of the image in pixels. + "maxApertureValue": 3.14, # Output only. The smallest f-number of the lens at the focal length used to create the photo (APEX value). + "meteringMode": "A String", # Output only. The metering mode used to create the photo. + "rotation": 42, # Output only. The number of clockwise 90 degree rotations applied from the image's original orientation. + "sensor": "A String", # Output only. The type of sensor used to create the photo. + "subjectDistance": 42, # Output only. The distance to the subject of the photo, in meters. + "whiteBalance": "A String", # Output only. The white balance mode used to create the photo. + "width": 42, # Output only. The width of the image in pixels. }, - "indexableText": { # Indexable text attributes for the file (can only be written). For more information, see Manage file metadata. + "indexableText": { # Indexable text attributes for the file (can only be written) "text": "A String", # The text to be indexed for this file. }, - "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. - "kind": "drive#file", # The type of file. This is always drive#file. - "labelInfo": { # An overview of the labels on the file. - "labels": [ # The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned. - { # Representation of a label and its fields. - "fields": { # A map of the label's fields keyed by the field ID. - "a_key": { # Representation of a label field. + "isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app. + "kind": "drive#file", # Output only. The type of file. This is always `drive#file`. + "labelInfo": { # Output only. An overview of the labels on the file. + "labels": [ # 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. + { # Representation of a label and label fields. + "fields": { # A map of the fields on the label, keyed by the field's ID. + "a_key": { # Representation of field, which is a typed key-value pair. "dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD. "A String", ], - "id": "A String", # The identifier of this field. - "integer": [ # Only present if valueType is integer. + "id": "A String", # The identifier of this label field. + "integer": [ # Only present if `valueType` is `integer`. "A String", ], - "kind": "drive#labelField", # This is always drive#labelField. - "selection": [ # Only present if valueType is selection. + "kind": "drive#labelField", # This is always `drive#labelField`. + "selection": [ # Only present if `valueType` is `selection` "A String", ], - "text": [ # Only present if valueType is text. + "text": [ # Only present if `valueType` is `text`. "A String", ], - "user": [ # Only present if valueType is user. + "user": [ # Only present if `valueType` is `user`. { # Information about a Drive user. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, ], - "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: - # - dateString - # - integer - # - selection - # - text - # - user + "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: * `dateString` * `integer` * `selection` * `text` * `user` }, }, "id": "A String", # The ID of the label. - "kind": "drive#label", # This is always drive#label + "kind": "drive#label", # This is always `drive#label` "revisionId": "A String", # The revision ID of the label. }, ], }, "labels": { # A group of labels for the file. - "hidden": True or False, # Deprecated. - "modified": True or False, # Whether the file has been modified by this user. - "restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead. + "hidden": True or False, # Output only. Deprecated. + "modified": True or False, # Output only. Whether the file has been modified by this user. + "restricted": True or False, # Output only. Deprecated: Use `copyRequiresWriterPermission` instead. "starred": True or False, # Whether this file is starred by the user. - "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may 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. + "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files. "viewed": True or False, # Whether this file has been viewed by this user. }, - "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "lastModifyingUserName": "A String", # Name of the last user to modify this file. + "lastModifyingUserName": "A String", # Output only. Name of the last user to modify this file. "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp). "linkShareMetadata": { # Contains details about the link URLs that clients are using to refer to this item. - "securityUpdateEligible": True or False, # Whether the file is eligible for security update. - "securityUpdateEnabled": True or False, # Whether the security update is enabled for this file. + "securityUpdateEligible": True or False, # Output only. Whether the file is eligible for security update. + "securityUpdateEnabled": True or False, # Output only. Whether the security update is enabled for this file. }, "markedViewedByMeDate": "A String", # Deprecated. - "md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. + "md5Checksum": "A String", # Output only. An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. "mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type. "modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date. "modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set. - "openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used. + "openWithLinks": { # Output only. A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used. "a_key": "A String", }, - "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Google Drive. - "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives. - "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives. + "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the `title` field. This is only available for files with binary content in Google Drive. + "ownedByMe": True or False, # Output only. Whether the file is owned by the current user. Not populated for items in shared drives. + "ownerNames": [ # Output only. Name(s) of the owner(s) of this file. Not populated for items in shared drives. "A String", ], - "owners": [ # 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. + "owners": [ # 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. { # Information about a Drive user. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, ], - "parents": [ # Collection of parent folders which contain this file. - # If not specified as part of an insert 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 can also use the addParents and removeParents parameters to modify the parents list. + "parents": [ # Collection of parent folders which contain this file. If not specified as part of an insert 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 can also use the `addParents` and `removeParents` parameters to modify the parents list. { # A reference to a file's parent. "id": "A String", # The ID of the parent. - "isRoot": True or False, # Whether or not the parent is the root folder. - "kind": "drive#parentReference", # This is always drive#parentReference. - "parentLink": "A String", # A link to the parent. - "selfLink": "A String", # A link back to this reference. + "isRoot": True or False, # Output only. Whether or not the parent is the root folder. + "kind": "drive#parentReference", # Output only. This is always `drive#parentReference`. + "parentLink": "A String", # Output only. A link to the parent. + "selfLink": "A String", # Output only. A link back to this reference. }, ], - "permissionIds": [ # List of permission IDs for users with access to this file. + "permissionIds": [ # Output only. List of permission IDs for users with access to this file. "A String", ], - "permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives. + "permissions": [ # Output only. The list of permissions for users with access to this file. Not populated for items in shared drives. { # A permission for a file. - "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. + "additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future. "A String", ], - "authKey": "A String", # Deprecated. - "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. - "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain. - "emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group. - "etag": "A String", # The ETag of the permission. - "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - # - They cannot be set on shared drive items - # - They can only be set on user and group permissions - # - The date must be in the future - # - The date cannot be more than a year in the future - "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "kind": "drive#permission", # This is always drive#permission. - "name": "A String", # The name for this permission. - "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive. - "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "authKey": "A String", # Output only. Deprecated. + "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. + "domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`. + "emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`. + "etag": "A String", # Output only. The ETag of the permission. + "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests + "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "kind": "drive#permission", # Output only. This is always `drive#permission`. + "name": "A String", # Output only. The name for this permission. + "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. + "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. { - "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. + "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. - "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: - # - file - # - member - "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: - # - organizer - # - fileOrganizer - # - writer - # - reader + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` + "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, ], - "photoLink": "A String", # A link to the profile photo, if available. - "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: - # - owner - # - organizer - # - fileOrganizer - # - writer - # - reader - "selfLink": "A String", # A link back to this permission. - "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. + "photoLink": "A String", # Output only. A link to the profile photo, if available. + "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader` + "selfLink": "A String", # Output only. A link back to this permission. + "teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead. { - "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. + "additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead. "A String", ], - "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. - "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. - "role": "A String", # Deprecated - use permissionDetails/role instead. - "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. + "inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead. + "inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead. + "role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead. + "teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead. }, ], - "type": "A String", # The account type. Allowed values are: - # - user - # - group - # - domain - # - anyone - "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value. + "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` + "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. "withLink": True or False, # Whether the link is required for this permission. }, ], "properties": [ # The list of properties. - { # A key-value pair attached to a file that is either public or private to an application. - # The following limits apply to file properties: - # - Maximum of 100 properties total per file - # - Maximum of 30 private properties per app - # - Maximum of 30 public properties - # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property. - "etag": "A String", # ETag of the property. + { # A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property + "etag": "A String", # Output only. ETag of the property. "key": "A String", # The key of this property. - "kind": "drive#property", # This is always drive#property. - "selfLink": "A String", # The link back to this property. + "kind": "drive#property", # Output only. This is always `drive#property`. + "selfLink": "A String", # Output only. The link back to this property. "value": "A String", # The value of this property. - "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE). Private 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. + "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. Private 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. }, ], - "quotaBytesUsed": "A String", # The number of quota bytes used by this file. - "resourceKey": "A String", # A key needed to access the item via a shared link. - "selfLink": "A String", # A link back to this file. - "sha1Checksum": "A String", # The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "sha256Checksum": "A String", # The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "shareable": True or False, # Deprecated: use capabilities/canShare. - "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives. + "quotaBytesUsed": "A String", # Output only. The number of quota bytes used by this file. + "resourceKey": "A String", # Output only. A key needed to access the item via a shared link. + "selfLink": "A String", # Output only. A link back to this file. + "sha1Checksum": "A String", # 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 is not populated for Docs Editors or shortcut files. + "sha256Checksum": "A String", # 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 is not populated for Docs Editors or shortcut files. + "shareable": True or False, # Output only. Deprecated: Use `capabilities/canShare` instead. + "shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives. "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp). - "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "sharingUser": { # Information about a Drive user. # Output only. User that shared the item with the current user, if available. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut. + "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. "targetId": "A String", # The ID of the file that this shortcut points to. - "targetMimeType": "A String", # 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": "A String", # The ResourceKey for the target file. + "targetMimeType": "A String", # 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": "A String", # Output only. The ResourceKey for the target file. }, - "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'. + "spaces": [ # Output only. The list of spaces which contain the file. Supported values are `drive`, `appDataFolder` and `photos`. "A String", ], - "teamDriveId": "A String", # Deprecated - use driveId instead. + "teamDriveId": "A String", # Output only. Deprecated: Use `driveId` instead. "thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated. "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5. "mimeType": "A String", # The MIME type of the thumbnail. }, - "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. 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": "A String", # The thumbnail version for use in thumbnail cache invalidation. + "thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content. + "thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation. "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant. "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives. - "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "trashingUser": { # Information about a Drive user. # Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file. - "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. + "userPermission": { # A permission for a file. # Output only. The permissions for the authenticated user on this file. + "additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future. "A String", ], - "authKey": "A String", # Deprecated. - "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. - "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain. - "emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group. - "etag": "A String", # The ETag of the permission. - "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - # - They cannot be set on shared drive items - # - They can only be set on user and group permissions - # - The date must be in the future - # - The date cannot be more than a year in the future - "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "kind": "drive#permission", # This is always drive#permission. - "name": "A String", # The name for this permission. - "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive. - "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "authKey": "A String", # Output only. Deprecated. + "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. + "domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`. + "emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`. + "etag": "A String", # Output only. The ETag of the permission. + "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests + "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "kind": "drive#permission", # Output only. This is always `drive#permission`. + "name": "A String", # Output only. The name for this permission. + "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. + "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. { - "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. + "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. - "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: - # - file - # - member - "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: - # - organizer - # - fileOrganizer - # - writer - # - reader + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` + "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, ], - "photoLink": "A String", # A link to the profile photo, if available. - "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: - # - owner - # - organizer - # - fileOrganizer - # - writer - # - reader - "selfLink": "A String", # A link back to this permission. - "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. + "photoLink": "A String", # Output only. A link to the profile photo, if available. + "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader` + "selfLink": "A String", # Output only. A link back to this permission. + "teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead. { - "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. + "additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead. "A String", ], - "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. - "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. - "role": "A String", # Deprecated - use permissionDetails/role instead. - "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. + "inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead. + "inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead. + "role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead. + "teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead. }, ], - "type": "A String", # The account type. Allowed values are: - # - user - # - group - # - domain - # - anyone - "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value. + "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` + "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. "withLink": True or False, # Whether the link is required for this permission. }, - "version": "A String", # 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 requesting user. - "videoMediaMetadata": { # Metadata about video media. This will only be present for video types. - "durationMillis": "A String", # The duration of the video in milliseconds. - "height": 42, # The height of the video in pixels. - "width": 42, # The width of the video in pixels. + "version": "A String", # 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 requesting user. + "videoMediaMetadata": { # Output only. Metadata about video media. This will only be present for video types. + "durationMillis": "A String", # Output only. The duration of the video in milliseconds. + "height": 42, # Output only. The height of the video in pixels. + "width": 42, # Output only. The width of the video in pixels. }, - "webContentLink": "A String", # A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials. - "webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting. + "webContentLink": "A String", # Output only. A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials. + "webViewLink": "A String", # Output only. A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting. "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives. }, "fileId": "A String", # The ID of the file associated with this change. "id": "A String", # The ID of the change. - "kind": "drive#change", # This is always drive#change. + "kind": "drive#change", # This is always `drive#change`. "modificationDate": "A String", # The time of this modification. "selfLink": "A String", # A link back to this change. - "teamDrive": { # Deprecated: use the drive collection instead. # Deprecated - use drive instead. - "backgroundImageFile": { # An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field; it can only be set on drive.teamdrives.update requests that don't set themeId. When specified, all fields of the backgroundImageFile must be set. + "teamDrive": { # Deprecated: Use the `drive` collection instead. # Deprecated: Use `drive` instead. + "backgroundImageFile": { # An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field; it can only be set on `drive.teamdrives.update` requests that don't set `themeId`. When specified, all fields of the `backgroundImageFile` must be set. "id": "A String", # The ID of an image file in Drive to use for the background image. "width": 3.14, # 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. "xCoordinate": 3.14, # 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. @@ -1175,11 +1089,11 @@Method Details
"backgroundImageLink": "A String", # A short-lived link to this Team Drive's background image. "capabilities": { # Capabilities the current user has on this Team Drive. "canAddChildren": True or False, # Whether the current user can add children to folders in this Team Drive. - "canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this Team Drive. - "canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the domainUsersOnly restriction of this Team Drive. - "canChangeSharingFoldersRequiresOrganizerPermissionRestriction": True or False, # Whether the current user can change the sharingFoldersRequiresOrganizerPermission restriction of this Team Drive. + "canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the `copyRequiresWriterPermission` restriction of this Team Drive. + "canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the `domainUsersOnly` restriction of this Team Drive. + "canChangeSharingFoldersRequiresOrganizerPermissionRestriction": True or False, # Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this Team Drive. "canChangeTeamDriveBackground": True or False, # Whether the current user can change the background of this Team Drive. - "canChangeTeamMembersOnlyRestriction": True or False, # Whether the current user can change the teamMembersOnly restriction of this Team Drive. + "canChangeTeamMembersOnlyRestriction": True or False, # Whether the current user can change the `teamMembersOnly` restriction of this Team Drive. "canComment": True or False, # Whether the current user can comment on files in this Team Drive. "canCopy": True or False, # Whether the current user can copy files in this Team Drive. "canDeleteChildren": True or False, # Whether the current user can delete children from folders in this Team Drive. @@ -1189,33 +1103,33 @@Method Details
"canListChildren": True or False, # Whether the current user can list the children of folders in this Team Drive. "canManageMembers": True or False, # Whether the current user can add members to this Team Drive or remove them or change their role. "canReadRevisions": True or False, # Whether the current user can read the revisions resource of files in this Team Drive. - "canRemoveChildren": True or False, # Deprecated - use canDeleteChildren or canTrashChildren instead. + "canRemoveChildren": True or False, # Deprecated: Use `canDeleteChildren` or `canTrashChildren` instead. "canRename": True or False, # Whether the current user can rename files or folders in this Team Drive. "canRenameTeamDrive": True or False, # Whether the current user can rename this Team Drive. "canResetTeamDriveRestrictions": True or False, # Whether the current user can reset the Team Drive restrictions to defaults. "canShare": True or False, # Whether the current user can share files or folders in this Team Drive. "canTrashChildren": True or False, # Whether the current user can trash children from folders in this Team Drive. }, - "colorRgb": "A String", # 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. + "colorRgb": "A String", # 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`. "createdDate": "A String", # The time at which the Team Drive was created (RFC 3339 date-time). "id": "A String", # The ID of this Team Drive which is also the ID of the top level folder of this Team Drive. - "kind": "drive#teamDrive", # This is always drive#teamDrive + "kind": "drive#teamDrive", # This is always `drive#teamDrive` "name": "A String", # The name of this Team Drive. - "orgUnitId": "A String", # The organizational unit of this shared drive. This field is only populated on drives.list responses when the useDomainAdminAccess parameter is set to true. + "orgUnitId": "A String", # The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`. "restrictions": { # A set of restrictions that apply to this Team Drive or items inside this Team Drive. "adminManagedRestrictions": True or False, # Whether administrative privileges on this Team Drive are required to modify restrictions. - "copyRequiresWriterPermission": True or False, # 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. + "copyRequiresWriterPermission": True or False, # 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. "domainUsersOnly": True or False, # 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. "sharingFoldersRequiresOrganizerPermission": True or False, # 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. "teamMembersOnly": True or False, # Whether access to items inside this Team Drive is restricted to members of this Team Drive. }, - "themeId": "A String", # 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.insert 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. + "themeId": "A String", # 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.insert` 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`. }, - "teamDriveId": "A String", # Deprecated - use driveId instead. - "type": "A String", # Deprecated - use changeType instead. + "teamDriveId": "A String", # Deprecated: Use `driveId` instead. + "type": "A String", # Deprecated: Use `changeType` instead. }, ], - "kind": "drive#changeList", # This is always drive#changeList. + "kind": "drive#changeList", # This is always `drive#changeList`. "largestChangeId": "A String", # The current largest change ID. "newStartPageToken": "A String", # The starting page token for future changes. This will be present only if the end of the current changes list has been reached. "nextLink": "A String", # A link to the next page of changes. @@ -1239,60 +1153,64 @@Method Details
watch(body=None, driveId=None, includeCorpusRemovals=None, includeDeleted=None, includeItemsFromAllDrives=None, includeLabels=None, includePermissionsForView=None, includeSubscribed=None, includeTeamDriveItems=None, maxResults=None, pageToken=None, spaces=None, startChangeId=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)
+ watch(body=None, driveId=None, includeCorpusRemovals=None, includeDeleted=None, includeItemsFromAllDrives=None, includeLabels=None, includePermissionsForView=None, includeSubscribed=None, includeTeamDriveItems=None, maxResults=None, pageToken=None, spaces=None, startChangeId=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None, x__xgafv=None)
Subscribe to changes for a user.
Args:
body: object, The request body.
The object takes the form of:
-{ # An notification channel used to watch for resource changes.
+{ # A notification channel used to watch for resource changes.
"address": "A String", # The address where notifications are delivered for this channel.
"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
"id": "A String", # A UUID or similar unique string that identifies this channel.
- "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".
+ "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is `api#channel`.
"params": { # Additional parameters controlling delivery channel behavior. Optional.
- "a_key": "A String", # Declares a new parameter by name.
+ "a_key": "A String",
},
"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
"resourceUri": "A String", # A version-specific identifier for the watched resource.
"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
- "type": "A String", # The type of delivery mechanism used for this channel. Valid values are "web_hook" (or "webhook"). Both values refer to a channel where Http requests are used to deliver messages.
+ "type": "A String", # The type of delivery mechanism used for this channel.
}
- driveId: string, The shared drive from which changes are returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.
+ driveId: string, The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.
includeCorpusRemovals: boolean, Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file.
includeDeleted: boolean, Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.
includeItemsFromAllDrives: boolean, Whether both My Drive and shared drive items should be included in results.
- includeLabels: string, A comma-separated list of IDs of labels to include in the labelInfo part of the response.
- includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported.
- includeSubscribed: boolean, Whether to include changes outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive are omitted from the result.
- includeTeamDriveItems: boolean, Deprecated use includeItemsFromAllDrives instead.
+ includeLabels: string, A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.
+ includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only `published` is supported.
+ includeSubscribed: boolean, Whether to include changes outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive will be omitted from the result.
+ includeTeamDriveItems: boolean, Deprecated: Use `includeItemsFromAllDrives` instead.
maxResults: integer, Maximum number of changes to return.
- pageToken: string, 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 or to the response from the getStartPageToken method.
- spaces: string, A comma-separated list of spaces to query. Supported values are 'drive', 'appDataFolder' and 'photos'.
- startChangeId: string, Deprecated - use pageToken instead.
+ pageToken: string, 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 or to the response from the getStartPageToken method.
+ spaces: string, A comma-separated list of spaces to query. Supported values are `drive`, `appDataFolder` and `photos`.
+ startChangeId: string, Deprecated: Use `pageToken` instead.
supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
- supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
- teamDriveId: string, Deprecated use driveId instead.
+ supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead.
+ teamDriveId: string, Deprecated: Use `driveId` instead.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
- { # An notification channel used to watch for resource changes.
+ { # A notification channel used to watch for resource changes.
"address": "A String", # The address where notifications are delivered for this channel.
"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
"id": "A String", # A UUID or similar unique string that identifies this channel.
- "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".
+ "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is `api#channel`.
"params": { # Additional parameters controlling delivery channel behavior. Optional.
- "a_key": "A String", # Declares a new parameter by name.
+ "a_key": "A String",
},
"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
"resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
"resourceUri": "A String", # A version-specific identifier for the watched resource.
"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
- "type": "A String", # The type of delivery mechanism used for this channel. Valid values are "web_hook" (or "webhook"). Both values refer to a channel where Http requests are used to deliver messages.
+ "type": "A String", # The type of delivery mechanism used for this channel.
}
Close httplib2 connections.
-Stop watching resources through this channel
+stop(body=None, x__xgafv=None)
+Stops watching resources through this channel.
close()
@@ -87,28 +87,32 @@ stop(body=None)
- Stop watching resources through this channel +stop(body=None, x__xgafv=None)+Stops watching resources through this channel. Args: body: object, The request body. The object takes the form of: -{ # An notification channel used to watch for resource changes. +{ # A notification channel used to watch for resource changes. "address": "A String", # The address where notifications are delivered for this channel. "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. "id": "A String", # A UUID or similar unique string that identifies this channel. - "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel". + "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is `api#channel`. "params": { # Additional parameters controlling delivery channel behavior. Optional. - "a_key": "A String", # Declares a new parameter by name. + "a_key": "A String", }, "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional. "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. "resourceUri": "A String", # A version-specific identifier for the watched resource. "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. - "type": "A String", # The type of delivery mechanism used for this channel. Valid values are "web_hook" (or "webhook"). Both values refer to a channel where Http requests are used to deliver messages. + "type": "A String", # The type of delivery mechanism used for this channel. } + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format
Close httplib2 connections.
- delete(folderId, childId, enforceSingleParent=None)
delete(folderId, childId, enforceSingleParent=None, x__xgafv=None)
Removes a child from a folder.
+get(folderId, childId, x__xgafv=None)
Gets a specific child reference.
+insert(folderId, body=None, enforceSingleParent=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None)
Inserts a file into a folder.
- list(folderId, maxResults=None, orderBy=None, pageToken=None, q=None)
list(folderId, maxResults=None, orderBy=None, pageToken=None, q=None, x__xgafv=None)
Lists a folder's children.
@@ -99,37 +99,45 @@delete(folderId, childId, enforceSingleParent=None)
+ delete(folderId, childId, enforceSingleParent=None, x__xgafv=None)
Removes a child from a folder. Args: folderId: string, The ID of the folder. (required) childId: string, The ID of the child. (required) - enforceSingleParent: boolean, 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. + enforceSingleParent: boolean, Deprecated: If an item is not in a shared drive and its last parent is removed, the item is placed under its owner's root. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format
get(folderId, childId)
+ get(folderId, childId, x__xgafv=None)
Gets a specific child reference.
Args:
folderId: string, The ID of the folder. (required)
childId: string, The ID of the child. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
{ # A reference to a folder's child.
- "childLink": "A String", # A link to the child.
+ "childLink": "A String", # Output only. A link to the child.
"id": "A String", # The ID of the child.
- "kind": "drive#childReference", # This is always drive#childReference.
- "selfLink": "A String", # A link back to this reference.
+ "kind": "drive#childReference", # Output only. This is always `drive#childReference`.
+ "selfLink": "A String", # Output only. A link back to this reference.
}
insert(folderId, body=None, enforceSingleParent=None, supportsAllDrives=None, supportsTeamDrives=None)
+ insert(folderId, body=None, enforceSingleParent=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None)
Inserts a file into a folder. Args: @@ -138,37 +146,45 @@Method Details
The object takes the form of: { # A reference to a folder's child. - "childLink": "A String", # A link to the child. + "childLink": "A String", # Output only. A link to the child. "id": "A String", # The ID of the child. - "kind": "drive#childReference", # This is always drive#childReference. - "selfLink": "A String", # A link back to this reference. + "kind": "drive#childReference", # Output only. This is always `drive#childReference`. + "selfLink": "A String", # Output only. A link back to this reference. } - enforceSingleParent: boolean, Deprecated. Adding files to multiple folders is no longer supported. Use shortcuts instead. + enforceSingleParent: boolean, Deprecated: Adding files to multiple folders is no longer supported. Use `shortcuts` instead. supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. - supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead. + supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format Returns: An object of the form: { # A reference to a folder's child. - "childLink": "A String", # A link to the child. + "childLink": "A String", # Output only. A link to the child. "id": "A String", # The ID of the child. - "kind": "drive#childReference", # This is always drive#childReference. - "selfLink": "A String", # A link back to this reference. + "kind": "drive#childReference", # Output only. This is always `drive#childReference`. + "selfLink": "A String", # Output only. A link back to this reference. }
list(folderId, maxResults=None, orderBy=None, pageToken=None, q=None)
+ list(folderId, maxResults=None, orderBy=None, pageToken=None, q=None, x__xgafv=None)
Lists a folder's children. Args: folderId: string, The ID of the folder. (required) maxResults: integer, Maximum number of children to return. - orderBy: string, A comma-separated list of sort keys. Valid keys are 'createdDate', 'folder', 'lastViewedByMeDate', 'modifiedByMeDate', 'modifiedDate', 'quotaBytesUsed', 'recency', 'sharedWithMeDate', 'starred', and 'title'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedDate desc,title. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored. + orderBy: string, A comma-separated list of sort keys. Valid keys are `createdDate`, `folder`, `lastViewedByMeDate`, `modifiedByMeDate`, `modifiedDate`, `quotaBytesUsed`, `recency`, `sharedWithMeDate`, `starred`, and `title`. Each key sorts ascending by default, but may be reversed with the `desc` modifier. Example usage: ?orderBy=folder,modifiedDate desc,title. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored. pageToken: string, Page token for children. q: string, Query string for searching children. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format Returns: An object of the form: @@ -177,13 +193,13 @@Method Details
"etag": "A String", # The ETag of the list. "items": [ # The list of children. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. { # A reference to a folder's child. - "childLink": "A String", # A link to the child. + "childLink": "A String", # Output only. A link to the child. "id": "A String", # The ID of the child. - "kind": "drive#childReference", # This is always drive#childReference. - "selfLink": "A String", # A link back to this reference. + "kind": "drive#childReference", # Output only. This is always `drive#childReference`. + "selfLink": "A String", # Output only. A link back to this reference. }, ], - "kind": "drive#childList", # This is always drive#childList. + "kind": "drive#childList", # This is always `drive#childList`. "nextLink": "A String", # A link to the next page of children. "nextPageToken": "A String", # The page token for the next page of children. This will be absent if the end of the children list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. "selfLink": "A String", # A link back to this list. diff --git a/docs/dyn/drive_v2.comments.html b/docs/dyn/drive_v2.comments.html index a3e7608610e..0288e1f68b9 100644 --- a/docs/dyn/drive_v2.comments.html +++ b/docs/dyn/drive_v2.comments.html @@ -72,31 +72,31 @@ -Drive API . comments
+Google Drive API . comments
Instance Methods
Close httplib2 connections.
+delete(fileId, commentId, x__xgafv=None)Deletes a comment.
-
+get(fileId, commentId, includeDeleted=None)get(fileId, commentId, includeDeleted=None, x__xgafv=None)Gets a comment by ID.
+insert(fileId, body=None, x__xgafv=None)Creates a new comment on the given file.
-
+list(fileId, includeDeleted=None, maxResults=None, pageToken=None, updatedMin=None)list(fileId, includeDeleted=None, maxResults=None, pageToken=None, updatedMin=None, x__xgafv=None)Lists a file's comments.
Retrieves the next page of results.
-
+patch(fileId, commentId, body=None)patch(fileId, commentId, body=None, x__xgafv=None)Updates an existing comment.
-
+update(fileId, commentId, body=None)update(fileId, commentId, body=None, x__xgafv=None)Updates an existing comment.
Method Details
@@ -105,85 +105,89 @@Method Details
-delete(fileId, commentId)+delete(fileId, commentId, x__xgafv=None)Deletes a comment. Args: fileId: string, The ID of the file. (required) commentId: string, The ID of the comment. (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format-get(fileId, commentId, includeDeleted=None)+get(fileId, commentId, includeDeleted=None, x__xgafv=None)Gets a comment by ID. Args: fileId: string, The ID of the file. (required) commentId: string, The ID of the comment. (required) includeDeleted: boolean, If set, this will succeed when retrieving a deleted comment, and will include any deleted replies. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format Returns: An object of the form: { # A comment on a file in Google Drive. - "anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to Add comments and replies. - "author": { # Information about a Drive user. # The author of the comment. The author's email address and permission ID will not be populated. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Add comments and replies](https://developers.google.com/drive/api/v2/manage-comments). + "author": { # Information about a Drive user. # Output only. The author of the comment. The author's email address and permission ID will not be populated. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "commentId": "A String", # The ID of the comment. + "commentId": "A String", # Output only. The ID of the comment. "content": "A String", # The plain text content used to create this comment. This is not HTML safe and should only be used as a starting point to make edits to a comment's content. "context": { # The context of the file which is being commented on. "type": "A String", # The MIME type of the context snippet. "value": "A String", # Data representation of the segment of the file being commented on. In the case of a text file for example, this would be the actual text that the comment is about. }, "createdDate": "A String", # The date when this comment was first created. - "deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed. - "fileId": "A String", # The file which this comment is addressing. - "fileTitle": "A String", # The title of the file which this comment is addressing. - "htmlContent": "A String", # HTML formatted content for this comment. - "kind": "drive#comment", # This is always drive#comment. + "deleted": True or False, # Output only. Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed. + "fileId": "A String", # Output only. The file which this comment is addressing. + "fileTitle": "A String", # Output only. The title of the file which this comment is addressing. + "htmlContent": "A String", # Output only. HTML formatted content for this comment. + "kind": "drive#comment", # Output only. This is always `drive#comment`. "modifiedDate": "A String", # The date when this comment or any of its replies were last modified. - "replies": [ # Replies to this post. + "replies": [ # Output only. Replies to this post. { # A comment on a file in Google Drive. - "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "author": { # Information about a Drive user. # Output only. The author of the reply. The author's email address and permission ID will not be populated. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen). "createdDate": "A String", # The date when this reply was first created. - "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed. - "htmlContent": "A String", # HTML formatted content for this reply. - "kind": "drive#commentReply", # This is always drive#commentReply. + "deleted": True or False, # Output only. Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed. + "htmlContent": "A String", # Output only. HTML formatted content for this reply. + "kind": "drive#commentReply", # Output only. This is always `drive#commentReply`. "modifiedDate": "A String", # The date when this reply was last modified. - "replyId": "A String", # The ID of the reply. - "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are: - # - "resolve" - To resolve a comment. - # - "reopen" - To reopen (un-resolve) a comment. + "replyId": "A String", # Output only. The ID of the reply. + "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are: * `resolve` - To resolve a comment. * `reopen` - To reopen (un-resolve) a comment. }, ], - "selfLink": "A String", # A link back to this comment. - "status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status. - # - "open" - The comment is still open. - # - "resolved" - The comment has been resolved by one of its replies. + "selfLink": "A String", # Output only. A link back to this comment. + "status": "A String", # Output only. The status of this comment. Status can be changed by posting a reply to a comment with the desired status. * `open` - The comment is still open. * `resolved` - The comment has been resolved by one of its replies. }-insert(fileId, body=None)+insert(fileId, body=None, x__xgafv=None)Creates a new comment on the given file. Args: @@ -192,122 +196,118 @@Method Details
The object takes the form of: { # A comment on a file in Google Drive. - "anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to Add comments and replies. - "author": { # Information about a Drive user. # The author of the comment. The author's email address and permission ID will not be populated. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Add comments and replies](https://developers.google.com/drive/api/v2/manage-comments). + "author": { # Information about a Drive user. # Output only. The author of the comment. The author's email address and permission ID will not be populated. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "commentId": "A String", # The ID of the comment. + "commentId": "A String", # Output only. The ID of the comment. "content": "A String", # The plain text content used to create this comment. This is not HTML safe and should only be used as a starting point to make edits to a comment's content. "context": { # The context of the file which is being commented on. "type": "A String", # The MIME type of the context snippet. "value": "A String", # Data representation of the segment of the file being commented on. In the case of a text file for example, this would be the actual text that the comment is about. }, "createdDate": "A String", # The date when this comment was first created. - "deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed. - "fileId": "A String", # The file which this comment is addressing. - "fileTitle": "A String", # The title of the file which this comment is addressing. - "htmlContent": "A String", # HTML formatted content for this comment. - "kind": "drive#comment", # This is always drive#comment. + "deleted": True or False, # Output only. Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed. + "fileId": "A String", # Output only. The file which this comment is addressing. + "fileTitle": "A String", # Output only. The title of the file which this comment is addressing. + "htmlContent": "A String", # Output only. HTML formatted content for this comment. + "kind": "drive#comment", # Output only. This is always `drive#comment`. "modifiedDate": "A String", # The date when this comment or any of its replies were last modified. - "replies": [ # Replies to this post. + "replies": [ # Output only. Replies to this post. { # A comment on a file in Google Drive. - "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "author": { # Information about a Drive user. # Output only. The author of the reply. The author's email address and permission ID will not be populated. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen). "createdDate": "A String", # The date when this reply was first created. - "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed. - "htmlContent": "A String", # HTML formatted content for this reply. - "kind": "drive#commentReply", # This is always drive#commentReply. + "deleted": True or False, # Output only. Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed. + "htmlContent": "A String", # Output only. HTML formatted content for this reply. + "kind": "drive#commentReply", # Output only. This is always `drive#commentReply`. "modifiedDate": "A String", # The date when this reply was last modified. - "replyId": "A String", # The ID of the reply. - "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are: - # - "resolve" - To resolve a comment. - # - "reopen" - To reopen (un-resolve) a comment. + "replyId": "A String", # Output only. The ID of the reply. + "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are: * `resolve` - To resolve a comment. * `reopen` - To reopen (un-resolve) a comment. }, ], - "selfLink": "A String", # A link back to this comment. - "status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status. - # - "open" - The comment is still open. - # - "resolved" - The comment has been resolved by one of its replies. + "selfLink": "A String", # Output only. A link back to this comment. + "status": "A String", # Output only. The status of this comment. Status can be changed by posting a reply to a comment with the desired status. * `open` - The comment is still open. * `resolved` - The comment has been resolved by one of its replies. } + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format Returns: An object of the form: { # A comment on a file in Google Drive. - "anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to Add comments and replies. - "author": { # Information about a Drive user. # The author of the comment. The author's email address and permission ID will not be populated. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Add comments and replies](https://developers.google.com/drive/api/v2/manage-comments). + "author": { # Information about a Drive user. # Output only. The author of the comment. The author's email address and permission ID will not be populated. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "commentId": "A String", # The ID of the comment. + "commentId": "A String", # Output only. The ID of the comment. "content": "A String", # The plain text content used to create this comment. This is not HTML safe and should only be used as a starting point to make edits to a comment's content. "context": { # The context of the file which is being commented on. "type": "A String", # The MIME type of the context snippet. "value": "A String", # Data representation of the segment of the file being commented on. In the case of a text file for example, this would be the actual text that the comment is about. }, "createdDate": "A String", # The date when this comment was first created. - "deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed. - "fileId": "A String", # The file which this comment is addressing. - "fileTitle": "A String", # The title of the file which this comment is addressing. - "htmlContent": "A String", # HTML formatted content for this comment. - "kind": "drive#comment", # This is always drive#comment. + "deleted": True or False, # Output only. Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed. + "fileId": "A String", # Output only. The file which this comment is addressing. + "fileTitle": "A String", # Output only. The title of the file which this comment is addressing. + "htmlContent": "A String", # Output only. HTML formatted content for this comment. + "kind": "drive#comment", # Output only. This is always `drive#comment`. "modifiedDate": "A String", # The date when this comment or any of its replies were last modified. - "replies": [ # Replies to this post. + "replies": [ # Output only. Replies to this post. { # A comment on a file in Google Drive. - "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "author": { # Information about a Drive user. # Output only. The author of the reply. The author's email address and permission ID will not be populated. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen). "createdDate": "A String", # The date when this reply was first created. - "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed. - "htmlContent": "A String", # HTML formatted content for this reply. - "kind": "drive#commentReply", # This is always drive#commentReply. + "deleted": True or False, # Output only. Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed. + "htmlContent": "A String", # Output only. HTML formatted content for this reply. + "kind": "drive#commentReply", # Output only. This is always `drive#commentReply`. "modifiedDate": "A String", # The date when this reply was last modified. - "replyId": "A String", # The ID of the reply. - "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are: - # - "resolve" - To resolve a comment. - # - "reopen" - To reopen (un-resolve) a comment. + "replyId": "A String", # Output only. The ID of the reply. + "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are: * `resolve` - To resolve a comment. * `reopen` - To reopen (un-resolve) a comment. }, ], - "selfLink": "A String", # A link back to this comment. - "status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status. - # - "open" - The comment is still open. - # - "resolved" - The comment has been resolved by one of its replies. + "selfLink": "A String", # Output only. A link back to this comment. + "status": "A String", # Output only. The status of this comment. Status can be changed by posting a reply to a comment with the desired status. * `open` - The comment is still open. * `resolved` - The comment has been resolved by one of its replies. }-list(fileId, includeDeleted=None, maxResults=None, pageToken=None, updatedMin=None)+list(fileId, includeDeleted=None, maxResults=None, pageToken=None, updatedMin=None, x__xgafv=None)Lists a file's comments. Args: @@ -316,6 +316,10 @@Method Details
maxResults: integer, The maximum number of discussions to include in the response, used for paging. pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. updatedMin: string, Only discussions that were updated after this timestamp will be returned. Formatted as an RFC 3339 timestamp. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format Returns: An object of the form: @@ -323,61 +327,57 @@Method Details
{ # A list of comments on a file in Google Drive. "items": [ # The list of comments. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. { # A comment on a file in Google Drive. - "anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to Add comments and replies. - "author": { # Information about a Drive user. # The author of the comment. The author's email address and permission ID will not be populated. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Add comments and replies](https://developers.google.com/drive/api/v2/manage-comments). + "author": { # Information about a Drive user. # Output only. The author of the comment. The author's email address and permission ID will not be populated. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "commentId": "A String", # The ID of the comment. + "commentId": "A String", # Output only. The ID of the comment. "content": "A String", # The plain text content used to create this comment. This is not HTML safe and should only be used as a starting point to make edits to a comment's content. "context": { # The context of the file which is being commented on. "type": "A String", # The MIME type of the context snippet. "value": "A String", # Data representation of the segment of the file being commented on. In the case of a text file for example, this would be the actual text that the comment is about. }, "createdDate": "A String", # The date when this comment was first created. - "deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed. - "fileId": "A String", # The file which this comment is addressing. - "fileTitle": "A String", # The title of the file which this comment is addressing. - "htmlContent": "A String", # HTML formatted content for this comment. - "kind": "drive#comment", # This is always drive#comment. + "deleted": True or False, # Output only. Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed. + "fileId": "A String", # Output only. The file which this comment is addressing. + "fileTitle": "A String", # Output only. The title of the file which this comment is addressing. + "htmlContent": "A String", # Output only. HTML formatted content for this comment. + "kind": "drive#comment", # Output only. This is always `drive#comment`. "modifiedDate": "A String", # The date when this comment or any of its replies were last modified. - "replies": [ # Replies to this post. + "replies": [ # Output only. Replies to this post. { # A comment on a file in Google Drive. - "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "author": { # Information about a Drive user. # Output only. The author of the reply. The author's email address and permission ID will not be populated. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen). "createdDate": "A String", # The date when this reply was first created. - "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed. - "htmlContent": "A String", # HTML formatted content for this reply. - "kind": "drive#commentReply", # This is always drive#commentReply. + "deleted": True or False, # Output only. Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed. + "htmlContent": "A String", # Output only. HTML formatted content for this reply. + "kind": "drive#commentReply", # Output only. This is always `drive#commentReply`. "modifiedDate": "A String", # The date when this reply was last modified. - "replyId": "A String", # The ID of the reply. - "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are: - # - "resolve" - To resolve a comment. - # - "reopen" - To reopen (un-resolve) a comment. + "replyId": "A String", # Output only. The ID of the reply. + "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are: * `resolve` - To resolve a comment. * `reopen` - To reopen (un-resolve) a comment. }, ], - "selfLink": "A String", # A link back to this comment. - "status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status. - # - "open" - The comment is still open. - # - "resolved" - The comment has been resolved by one of its replies. + "selfLink": "A String", # Output only. A link back to this comment. + "status": "A String", # Output only. The status of this comment. Status can be changed by posting a reply to a comment with the desired status. * `open` - The comment is still open. * `resolved` - The comment has been resolved by one of its replies. }, ], - "kind": "drive#commentList", # This is always drive#commentList. + "kind": "drive#commentList", # This is always `drive#commentList`. "nextLink": "A String", # A link to the next page of comments. "nextPageToken": "A String", # The page token for the next page of comments. This will be absent if the end of the comments list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. "selfLink": "A String", # A link back to this list. @@ -399,7 +399,7 @@Method Details
-patch(fileId, commentId, body=None)+patch(fileId, commentId, body=None, x__xgafv=None)Updates an existing comment. Args: @@ -409,122 +409,118 @@Method Details
The object takes the form of: { # A comment on a file in Google Drive. - "anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to Add comments and replies. - "author": { # Information about a Drive user. # The author of the comment. The author's email address and permission ID will not be populated. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Add comments and replies](https://developers.google.com/drive/api/v2/manage-comments). + "author": { # Information about a Drive user. # Output only. The author of the comment. The author's email address and permission ID will not be populated. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "commentId": "A String", # The ID of the comment. + "commentId": "A String", # Output only. The ID of the comment. "content": "A String", # The plain text content used to create this comment. This is not HTML safe and should only be used as a starting point to make edits to a comment's content. "context": { # The context of the file which is being commented on. "type": "A String", # The MIME type of the context snippet. "value": "A String", # Data representation of the segment of the file being commented on. In the case of a text file for example, this would be the actual text that the comment is about. }, "createdDate": "A String", # The date when this comment was first created. - "deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed. - "fileId": "A String", # The file which this comment is addressing. - "fileTitle": "A String", # The title of the file which this comment is addressing. - "htmlContent": "A String", # HTML formatted content for this comment. - "kind": "drive#comment", # This is always drive#comment. + "deleted": True or False, # Output only. Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed. + "fileId": "A String", # Output only. The file which this comment is addressing. + "fileTitle": "A String", # Output only. The title of the file which this comment is addressing. + "htmlContent": "A String", # Output only. HTML formatted content for this comment. + "kind": "drive#comment", # Output only. This is always `drive#comment`. "modifiedDate": "A String", # The date when this comment or any of its replies were last modified. - "replies": [ # Replies to this post. + "replies": [ # Output only. Replies to this post. { # A comment on a file in Google Drive. - "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "author": { # Information about a Drive user. # Output only. The author of the reply. The author's email address and permission ID will not be populated. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen). "createdDate": "A String", # The date when this reply was first created. - "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed. - "htmlContent": "A String", # HTML formatted content for this reply. - "kind": "drive#commentReply", # This is always drive#commentReply. + "deleted": True or False, # Output only. Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed. + "htmlContent": "A String", # Output only. HTML formatted content for this reply. + "kind": "drive#commentReply", # Output only. This is always `drive#commentReply`. "modifiedDate": "A String", # The date when this reply was last modified. - "replyId": "A String", # The ID of the reply. - "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are: - # - "resolve" - To resolve a comment. - # - "reopen" - To reopen (un-resolve) a comment. + "replyId": "A String", # Output only. The ID of the reply. + "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are: * `resolve` - To resolve a comment. * `reopen` - To reopen (un-resolve) a comment. }, ], - "selfLink": "A String", # A link back to this comment. - "status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status. - # - "open" - The comment is still open. - # - "resolved" - The comment has been resolved by one of its replies. + "selfLink": "A String", # Output only. A link back to this comment. + "status": "A String", # Output only. The status of this comment. Status can be changed by posting a reply to a comment with the desired status. * `open` - The comment is still open. * `resolved` - The comment has been resolved by one of its replies. } + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format Returns: An object of the form: { # A comment on a file in Google Drive. - "anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to Add comments and replies. - "author": { # Information about a Drive user. # The author of the comment. The author's email address and permission ID will not be populated. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Add comments and replies](https://developers.google.com/drive/api/v2/manage-comments). + "author": { # Information about a Drive user. # Output only. The author of the comment. The author's email address and permission ID will not be populated. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "commentId": "A String", # The ID of the comment. + "commentId": "A String", # Output only. The ID of the comment. "content": "A String", # The plain text content used to create this comment. This is not HTML safe and should only be used as a starting point to make edits to a comment's content. "context": { # The context of the file which is being commented on. "type": "A String", # The MIME type of the context snippet. "value": "A String", # Data representation of the segment of the file being commented on. In the case of a text file for example, this would be the actual text that the comment is about. }, "createdDate": "A String", # The date when this comment was first created. - "deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed. - "fileId": "A String", # The file which this comment is addressing. - "fileTitle": "A String", # The title of the file which this comment is addressing. - "htmlContent": "A String", # HTML formatted content for this comment. - "kind": "drive#comment", # This is always drive#comment. + "deleted": True or False, # Output only. Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed. + "fileId": "A String", # Output only. The file which this comment is addressing. + "fileTitle": "A String", # Output only. The title of the file which this comment is addressing. + "htmlContent": "A String", # Output only. HTML formatted content for this comment. + "kind": "drive#comment", # Output only. This is always `drive#comment`. "modifiedDate": "A String", # The date when this comment or any of its replies were last modified. - "replies": [ # Replies to this post. + "replies": [ # Output only. Replies to this post. { # A comment on a file in Google Drive. - "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "author": { # Information about a Drive user. # Output only. The author of the reply. The author's email address and permission ID will not be populated. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen). "createdDate": "A String", # The date when this reply was first created. - "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed. - "htmlContent": "A String", # HTML formatted content for this reply. - "kind": "drive#commentReply", # This is always drive#commentReply. + "deleted": True or False, # Output only. Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed. + "htmlContent": "A String", # Output only. HTML formatted content for this reply. + "kind": "drive#commentReply", # Output only. This is always `drive#commentReply`. "modifiedDate": "A String", # The date when this reply was last modified. - "replyId": "A String", # The ID of the reply. - "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are: - # - "resolve" - To resolve a comment. - # - "reopen" - To reopen (un-resolve) a comment. + "replyId": "A String", # Output only. The ID of the reply. + "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are: * `resolve` - To resolve a comment. * `reopen` - To reopen (un-resolve) a comment. }, ], - "selfLink": "A String", # A link back to this comment. - "status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status. - # - "open" - The comment is still open. - # - "resolved" - The comment has been resolved by one of its replies. + "selfLink": "A String", # Output only. A link back to this comment. + "status": "A String", # Output only. The status of this comment. Status can be changed by posting a reply to a comment with the desired status. * `open` - The comment is still open. * `resolved` - The comment has been resolved by one of its replies. }-diff --git a/docs/dyn/drive_v2.drives.html b/docs/dyn/drive_v2.drives.html index 987750757e5..8f0ca1f0ad2 100644 --- a/docs/dyn/drive_v2.drives.html +++ b/docs/dyn/drive_v2.drives.html @@ -72,34 +72,34 @@ -update(fileId, commentId, body=None)+update(fileId, commentId, body=None, x__xgafv=None)Updates an existing comment. Args: @@ -534,117 +530,113 @@Method Details
The object takes the form of: { # A comment on a file in Google Drive. - "anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to Add comments and replies. - "author": { # Information about a Drive user. # The author of the comment. The author's email address and permission ID will not be populated. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Add comments and replies](https://developers.google.com/drive/api/v2/manage-comments). + "author": { # Information about a Drive user. # Output only. The author of the comment. The author's email address and permission ID will not be populated. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "commentId": "A String", # The ID of the comment. + "commentId": "A String", # Output only. The ID of the comment. "content": "A String", # The plain text content used to create this comment. This is not HTML safe and should only be used as a starting point to make edits to a comment's content. "context": { # The context of the file which is being commented on. "type": "A String", # The MIME type of the context snippet. "value": "A String", # Data representation of the segment of the file being commented on. In the case of a text file for example, this would be the actual text that the comment is about. }, "createdDate": "A String", # The date when this comment was first created. - "deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed. - "fileId": "A String", # The file which this comment is addressing. - "fileTitle": "A String", # The title of the file which this comment is addressing. - "htmlContent": "A String", # HTML formatted content for this comment. - "kind": "drive#comment", # This is always drive#comment. + "deleted": True or False, # Output only. Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed. + "fileId": "A String", # Output only. The file which this comment is addressing. + "fileTitle": "A String", # Output only. The title of the file which this comment is addressing. + "htmlContent": "A String", # Output only. HTML formatted content for this comment. + "kind": "drive#comment", # Output only. This is always `drive#comment`. "modifiedDate": "A String", # The date when this comment or any of its replies were last modified. - "replies": [ # Replies to this post. + "replies": [ # Output only. Replies to this post. { # A comment on a file in Google Drive. - "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "author": { # Information about a Drive user. # Output only. The author of the reply. The author's email address and permission ID will not be populated. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen). "createdDate": "A String", # The date when this reply was first created. - "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed. - "htmlContent": "A String", # HTML formatted content for this reply. - "kind": "drive#commentReply", # This is always drive#commentReply. + "deleted": True or False, # Output only. Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed. + "htmlContent": "A String", # Output only. HTML formatted content for this reply. + "kind": "drive#commentReply", # Output only. This is always `drive#commentReply`. "modifiedDate": "A String", # The date when this reply was last modified. - "replyId": "A String", # The ID of the reply. - "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are: - # - "resolve" - To resolve a comment. - # - "reopen" - To reopen (un-resolve) a comment. + "replyId": "A String", # Output only. The ID of the reply. + "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are: * `resolve` - To resolve a comment. * `reopen` - To reopen (un-resolve) a comment. }, ], - "selfLink": "A String", # A link back to this comment. - "status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status. - # - "open" - The comment is still open. - # - "resolved" - The comment has been resolved by one of its replies. + "selfLink": "A String", # Output only. A link back to this comment. + "status": "A String", # Output only. The status of this comment. Status can be changed by posting a reply to a comment with the desired status. * `open` - The comment is still open. * `resolved` - The comment has been resolved by one of its replies. } + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format Returns: An object of the form: { # A comment on a file in Google Drive. - "anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to Add comments and replies. - "author": { # Information about a Drive user. # The author of the comment. The author's email address and permission ID will not be populated. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Add comments and replies](https://developers.google.com/drive/api/v2/manage-comments). + "author": { # Information about a Drive user. # Output only. The author of the comment. The author's email address and permission ID will not be populated. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "commentId": "A String", # The ID of the comment. + "commentId": "A String", # Output only. The ID of the comment. "content": "A String", # The plain text content used to create this comment. This is not HTML safe and should only be used as a starting point to make edits to a comment's content. "context": { # The context of the file which is being commented on. "type": "A String", # The MIME type of the context snippet. "value": "A String", # Data representation of the segment of the file being commented on. In the case of a text file for example, this would be the actual text that the comment is about. }, "createdDate": "A String", # The date when this comment was first created. - "deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed. - "fileId": "A String", # The file which this comment is addressing. - "fileTitle": "A String", # The title of the file which this comment is addressing. - "htmlContent": "A String", # HTML formatted content for this comment. - "kind": "drive#comment", # This is always drive#comment. + "deleted": True or False, # Output only. Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed. + "fileId": "A String", # Output only. The file which this comment is addressing. + "fileTitle": "A String", # Output only. The title of the file which this comment is addressing. + "htmlContent": "A String", # Output only. HTML formatted content for this comment. + "kind": "drive#comment", # Output only. This is always `drive#comment`. "modifiedDate": "A String", # The date when this comment or any of its replies were last modified. - "replies": [ # Replies to this post. + "replies": [ # Output only. Replies to this post. { # A comment on a file in Google Drive. - "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "author": { # Information about a Drive user. # Output only. The author of the reply. The author's email address and permission ID will not be populated. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen). "createdDate": "A String", # The date when this reply was first created. - "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed. - "htmlContent": "A String", # HTML formatted content for this reply. - "kind": "drive#commentReply", # This is always drive#commentReply. + "deleted": True or False, # Output only. Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed. + "htmlContent": "A String", # Output only. HTML formatted content for this reply. + "kind": "drive#commentReply", # Output only. This is always `drive#commentReply`. "modifiedDate": "A String", # The date when this reply was last modified. - "replyId": "A String", # The ID of the reply. - "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are: - # - "resolve" - To resolve a comment. - # - "reopen" - To reopen (un-resolve) a comment. + "replyId": "A String", # Output only. The ID of the reply. + "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are: * `resolve` - To resolve a comment. * `reopen` - To reopen (un-resolve) a comment. }, ], - "selfLink": "A String", # A link back to this comment. - "status": "A String", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status. - # - "open" - The comment is still open. - # - "resolved" - The comment has been resolved by one of its replies. + "selfLink": "A String", # Output only. A link back to this comment. + "status": "A String", # Output only. The status of this comment. Status can be changed by posting a reply to a comment with the desired status. * `open` - The comment is still open. * `resolved` - The comment has been resolved by one of its replies. }Drive API . drives
+Google Drive API . drives
Instance Methods
Close httplib2 connections.
-
+delete(driveId, allowItemDeletion=None, useDomainAdminAccess=None)delete(driveId, allowItemDeletion=None, useDomainAdminAccess=None, x__xgafv=None)Permanently deletes a shared drive for which the user is an organizer. The shared drive cannot contain any untrashed items.
-
+get(driveId, useDomainAdminAccess=None)get(driveId, useDomainAdminAccess=None, x__xgafv=None)Gets a shared drive's metadata by ID.
+hide(driveId, x__xgafv=None)Hides a shared drive from the default view.
-
+insert(requestId, body=None)insert(requestId, body=None, x__xgafv=None)Creates a new shared drive.
-
-list(maxResults=None, pageToken=None, q=None, useDomainAdminAccess=None)Lists the user's shared drives.
+list(maxResults=None, pageToken=None, q=None, useDomainAdminAccess=None, x__xgafv=None)+Lists the user's shared drives. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for shared drives](/drive/api/guides/search-shareddrives) guide.
Retrieves the next page of results.
+unhide(driveId, x__xgafv=None)Restores a shared drive to the default view.
-
+update(driveId, body=None, useDomainAdminAccess=None)update(driveId, body=None, useDomainAdminAccess=None, x__xgafv=None)Updates the metadata for a shared drive.
Method Details
@@ -108,250 +108,270 @@Method Details
-delete(driveId, allowItemDeletion=None, useDomainAdminAccess=None)+delete(driveId, allowItemDeletion=None, useDomainAdminAccess=None, x__xgafv=None)Permanently deletes a shared drive for which the user is an organizer. The shared drive cannot contain any untrashed items. Args: driveId: string, The ID of the shared drive. (required) - allowItemDeletion: boolean, Whether any items inside the shared drive should also be deleted. This option is only supported when useDomainAdminAccess is also set to true. + allowItemDeletion: boolean, Whether any items inside the shared drive should also be deleted. This option is only supported when `useDomainAdminAccess` is also set to `true`. useDomainAdminAccess: boolean, Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format-get(driveId, useDomainAdminAccess=None)+get(driveId, useDomainAdminAccess=None, x__xgafv=None)Gets a shared drive's metadata by ID. Args: driveId: string, The ID of the shared drive. (required) useDomainAdminAccess: boolean, Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format Returns: An object of the form: { # Representation of a shared drive. - "backgroundImageFile": { # 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. + "backgroundImageFile": { # 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. "id": "A String", # The ID of an image file in Google Drive to use for the background image. "width": 3.14, # 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. "xCoordinate": 3.14, # 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. "yCoordinate": 3.14, # 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. }, - "backgroundImageLink": "A String", # A short-lived link to this shared drive's background image. - "capabilities": { # Capabilities the current user has on this shared drive. - "canAddChildren": True or False, # Whether the current user can add children to folders in this shared drive. - "canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive. - "canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the domainUsersOnly restriction of this shared drive. - "canChangeDriveBackground": True or False, # Whether the current user can change the background of this shared drive. - "canChangeDriveMembersOnlyRestriction": True or False, # Whether the current user can change the driveMembersOnly restriction of this shared drive. - "canChangeSharingFoldersRequiresOrganizerPermissionRestriction": True or False, # Whether the current user can change the sharingFoldersRequiresOrganizerPermission restriction of this shared drive. - "canComment": True or False, # Whether the current user can comment on files in this shared drive. - "canCopy": True or False, # Whether the current user can copy files in this shared drive. - "canDeleteChildren": True or False, # Whether the current user can delete children from folders in this shared drive. - "canDeleteDrive": True or False, # 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. - "canDownload": True or False, # Whether the current user can download files in this shared drive. - "canEdit": True or False, # Whether the current user can edit files in this shared drive - "canListChildren": True or False, # Whether the current user can list the children of folders in this shared drive. - "canManageMembers": True or False, # Whether the current user can add members to this shared drive or remove them or change their role. - "canReadRevisions": True or False, # Whether the current user can read the revisions resource of files in this shared drive. - "canRename": True or False, # Whether the current user can rename files or folders in this shared drive. - "canRenameDrive": True or False, # Whether the current user can rename this shared drive. - "canResetDriveRestrictions": True or False, # Whether the current user can reset the shared drive restrictions to defaults. - "canShare": True or False, # Whether the current user can share files or folders in this shared drive. - "canTrashChildren": True or False, # Whether the current user can trash children from folders in this shared drive. + "backgroundImageLink": "A String", # Output only. A short-lived link to this shared drive's background image. + "capabilities": { # Output only. Capabilities the current user has on this shared drive. + "canAddChildren": True or False, # Output only. Whether the current user can add children to folders in this shared drive. + "canChangeCopyRequiresWriterPermissionRestriction": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this shared drive. + "canChangeDomainUsersOnlyRestriction": True or False, # Output only. Whether the current user can change the `domainUsersOnly` restriction of this shared drive. + "canChangeDriveBackground": True or False, # Output only. Whether the current user can change the background of this shared drive. + "canChangeDriveMembersOnlyRestriction": True or False, # Output only. Whether the current user can change the `driveMembersOnly` restriction of this shared drive. + "canChangeSharingFoldersRequiresOrganizerPermissionRestriction": True or False, # Output only. Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this shared drive. + "canComment": True or False, # Output only. Whether the current user can comment on files in this shared drive. + "canCopy": True or False, # Output only. Whether the current user can copy files in this shared drive. + "canDeleteChildren": True or False, # Output only. Whether the current user can delete children from folders in this shared drive. + "canDeleteDrive": True or False, # 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. + "canDownload": True or False, # Output only. Whether the current user can download files in this shared drive. + "canEdit": True or False, # Output only. Whether the current user can edit files in this shared drive + "canListChildren": True or False, # Output only. Whether the current user can list the children of folders in this shared drive. + "canManageMembers": True or False, # Output only. Whether the current user can add members to this shared drive or remove them or change their role. + "canReadRevisions": True or False, # Output only. Whether the current user can read the revisions resource of files in this shared drive. + "canRename": True or False, # Output only. Whether the current user can rename files or folders in this shared drive. + "canRenameDrive": True or False, # Output only. Whether the current user can rename this shared drive. + "canResetDriveRestrictions": True or False, # Output only. Whether the current user can reset the shared drive restrictions to defaults. + "canShare": True or False, # Output only. Whether the current user can share files or folders in this shared drive. + "canTrashChildren": True or False, # Output only. Whether the current user can trash children from folders in this shared drive. }, - "colorRgb": "A String", # 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. + "colorRgb": "A String", # 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`. "createdDate": "A String", # The time at which the shared drive was created (RFC 3339 date-time). "hidden": True or False, # Whether the shared drive is hidden from default view. - "id": "A String", # The ID of this shared drive which is also the ID of the top level folder of this shared drive. - "kind": "drive#drive", # This is always drive#drive + "id": "A String", # Output only. The ID of this shared drive which is also the ID of the top level folder of this shared drive. + "kind": "drive#drive", # Output only. This is always `drive#drive` "name": "A String", # The name of this shared drive. - "orgUnitId": "A String", # The organizational unit of this shared drive. This field is only populated on drives.list responses when the useDomainAdminAccess parameter is set to true. + "orgUnitId": "A String", # 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`. "restrictions": { # A set of restrictions that apply to this shared drive or items inside this shared drive. "adminManagedRestrictions": True or False, # Whether administrative privileges on this shared drive are required to modify restrictions. - "copyRequiresWriterPermission": True or False, # 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. + "copyRequiresWriterPermission": True or False, # 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. "domainUsersOnly": True or False, # 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. "driveMembersOnly": True or False, # Whether access to items inside this shared drive is restricted to its members. "sharingFoldersRequiresOrganizerPermission": True or False, # 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": "A String", # 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.insert 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. + "themeId": "A String", # 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.insert` 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`. }-hide(driveId)+hide(driveId, x__xgafv=None)Hides a shared drive from the default view. Args: driveId: string, The ID of the shared drive. (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format Returns: An object of the form: { # Representation of a shared drive. - "backgroundImageFile": { # 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. + "backgroundImageFile": { # 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. "id": "A String", # The ID of an image file in Google Drive to use for the background image. "width": 3.14, # 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. "xCoordinate": 3.14, # 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. "yCoordinate": 3.14, # 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. }, - "backgroundImageLink": "A String", # A short-lived link to this shared drive's background image. - "capabilities": { # Capabilities the current user has on this shared drive. - "canAddChildren": True or False, # Whether the current user can add children to folders in this shared drive. - "canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive. - "canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the domainUsersOnly restriction of this shared drive. - "canChangeDriveBackground": True or False, # Whether the current user can change the background of this shared drive. - "canChangeDriveMembersOnlyRestriction": True or False, # Whether the current user can change the driveMembersOnly restriction of this shared drive. - "canChangeSharingFoldersRequiresOrganizerPermissionRestriction": True or False, # Whether the current user can change the sharingFoldersRequiresOrganizerPermission restriction of this shared drive. - "canComment": True or False, # Whether the current user can comment on files in this shared drive. - "canCopy": True or False, # Whether the current user can copy files in this shared drive. - "canDeleteChildren": True or False, # Whether the current user can delete children from folders in this shared drive. - "canDeleteDrive": True or False, # 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. - "canDownload": True or False, # Whether the current user can download files in this shared drive. - "canEdit": True or False, # Whether the current user can edit files in this shared drive - "canListChildren": True or False, # Whether the current user can list the children of folders in this shared drive. - "canManageMembers": True or False, # Whether the current user can add members to this shared drive or remove them or change their role. - "canReadRevisions": True or False, # Whether the current user can read the revisions resource of files in this shared drive. - "canRename": True or False, # Whether the current user can rename files or folders in this shared drive. - "canRenameDrive": True or False, # Whether the current user can rename this shared drive. - "canResetDriveRestrictions": True or False, # Whether the current user can reset the shared drive restrictions to defaults. - "canShare": True or False, # Whether the current user can share files or folders in this shared drive. - "canTrashChildren": True or False, # Whether the current user can trash children from folders in this shared drive. + "backgroundImageLink": "A String", # Output only. A short-lived link to this shared drive's background image. + "capabilities": { # Output only. Capabilities the current user has on this shared drive. + "canAddChildren": True or False, # Output only. Whether the current user can add children to folders in this shared drive. + "canChangeCopyRequiresWriterPermissionRestriction": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this shared drive. + "canChangeDomainUsersOnlyRestriction": True or False, # Output only. Whether the current user can change the `domainUsersOnly` restriction of this shared drive. + "canChangeDriveBackground": True or False, # Output only. Whether the current user can change the background of this shared drive. + "canChangeDriveMembersOnlyRestriction": True or False, # Output only. Whether the current user can change the `driveMembersOnly` restriction of this shared drive. + "canChangeSharingFoldersRequiresOrganizerPermissionRestriction": True or False, # Output only. Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this shared drive. + "canComment": True or False, # Output only. Whether the current user can comment on files in this shared drive. + "canCopy": True or False, # Output only. Whether the current user can copy files in this shared drive. + "canDeleteChildren": True or False, # Output only. Whether the current user can delete children from folders in this shared drive. + "canDeleteDrive": True or False, # 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. + "canDownload": True or False, # Output only. Whether the current user can download files in this shared drive. + "canEdit": True or False, # Output only. Whether the current user can edit files in this shared drive + "canListChildren": True or False, # Output only. Whether the current user can list the children of folders in this shared drive. + "canManageMembers": True or False, # Output only. Whether the current user can add members to this shared drive or remove them or change their role. + "canReadRevisions": True or False, # Output only. Whether the current user can read the revisions resource of files in this shared drive. + "canRename": True or False, # Output only. Whether the current user can rename files or folders in this shared drive. + "canRenameDrive": True or False, # Output only. Whether the current user can rename this shared drive. + "canResetDriveRestrictions": True or False, # Output only. Whether the current user can reset the shared drive restrictions to defaults. + "canShare": True or False, # Output only. Whether the current user can share files or folders in this shared drive. + "canTrashChildren": True or False, # Output only. Whether the current user can trash children from folders in this shared drive. }, - "colorRgb": "A String", # 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. + "colorRgb": "A String", # 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`. "createdDate": "A String", # The time at which the shared drive was created (RFC 3339 date-time). "hidden": True or False, # Whether the shared drive is hidden from default view. - "id": "A String", # The ID of this shared drive which is also the ID of the top level folder of this shared drive. - "kind": "drive#drive", # This is always drive#drive + "id": "A String", # Output only. The ID of this shared drive which is also the ID of the top level folder of this shared drive. + "kind": "drive#drive", # Output only. This is always `drive#drive` "name": "A String", # The name of this shared drive. - "orgUnitId": "A String", # The organizational unit of this shared drive. This field is only populated on drives.list responses when the useDomainAdminAccess parameter is set to true. + "orgUnitId": "A String", # 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`. "restrictions": { # A set of restrictions that apply to this shared drive or items inside this shared drive. "adminManagedRestrictions": True or False, # Whether administrative privileges on this shared drive are required to modify restrictions. - "copyRequiresWriterPermission": True or False, # 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. + "copyRequiresWriterPermission": True or False, # 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. "domainUsersOnly": True or False, # 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. "driveMembersOnly": True or False, # Whether access to items inside this shared drive is restricted to its members. "sharingFoldersRequiresOrganizerPermission": True or False, # 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": "A String", # 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.insert 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. + "themeId": "A String", # 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.insert` 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`. }-insert(requestId, body=None)+insert(requestId, body=None, x__xgafv=None)Creates a new shared drive. Args: - requestId: string, An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a shared drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same shared drive. If the shared drive already exists a 409 error will be returned. (required) + requestId: string, Required. An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a shared drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same shared drive. If the shared drive already exists a 409 error will be returned. (required) body: object, The request body. The object takes the form of: { # Representation of a shared drive. - "backgroundImageFile": { # 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. + "backgroundImageFile": { # 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. "id": "A String", # The ID of an image file in Google Drive to use for the background image. "width": 3.14, # 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. "xCoordinate": 3.14, # 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. "yCoordinate": 3.14, # 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. }, - "backgroundImageLink": "A String", # A short-lived link to this shared drive's background image. - "capabilities": { # Capabilities the current user has on this shared drive. - "canAddChildren": True or False, # Whether the current user can add children to folders in this shared drive. - "canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive. - "canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the domainUsersOnly restriction of this shared drive. - "canChangeDriveBackground": True or False, # Whether the current user can change the background of this shared drive. - "canChangeDriveMembersOnlyRestriction": True or False, # Whether the current user can change the driveMembersOnly restriction of this shared drive. - "canChangeSharingFoldersRequiresOrganizerPermissionRestriction": True or False, # Whether the current user can change the sharingFoldersRequiresOrganizerPermission restriction of this shared drive. - "canComment": True or False, # Whether the current user can comment on files in this shared drive. - "canCopy": True or False, # Whether the current user can copy files in this shared drive. - "canDeleteChildren": True or False, # Whether the current user can delete children from folders in this shared drive. - "canDeleteDrive": True or False, # 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. - "canDownload": True or False, # Whether the current user can download files in this shared drive. - "canEdit": True or False, # Whether the current user can edit files in this shared drive - "canListChildren": True or False, # Whether the current user can list the children of folders in this shared drive. - "canManageMembers": True or False, # Whether the current user can add members to this shared drive or remove them or change their role. - "canReadRevisions": True or False, # Whether the current user can read the revisions resource of files in this shared drive. - "canRename": True or False, # Whether the current user can rename files or folders in this shared drive. - "canRenameDrive": True or False, # Whether the current user can rename this shared drive. - "canResetDriveRestrictions": True or False, # Whether the current user can reset the shared drive restrictions to defaults. - "canShare": True or False, # Whether the current user can share files or folders in this shared drive. - "canTrashChildren": True or False, # Whether the current user can trash children from folders in this shared drive. + "backgroundImageLink": "A String", # Output only. A short-lived link to this shared drive's background image. + "capabilities": { # Output only. Capabilities the current user has on this shared drive. + "canAddChildren": True or False, # Output only. Whether the current user can add children to folders in this shared drive. + "canChangeCopyRequiresWriterPermissionRestriction": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this shared drive. + "canChangeDomainUsersOnlyRestriction": True or False, # Output only. Whether the current user can change the `domainUsersOnly` restriction of this shared drive. + "canChangeDriveBackground": True or False, # Output only. Whether the current user can change the background of this shared drive. + "canChangeDriveMembersOnlyRestriction": True or False, # Output only. Whether the current user can change the `driveMembersOnly` restriction of this shared drive. + "canChangeSharingFoldersRequiresOrganizerPermissionRestriction": True or False, # Output only. Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this shared drive. + "canComment": True or False, # Output only. Whether the current user can comment on files in this shared drive. + "canCopy": True or False, # Output only. Whether the current user can copy files in this shared drive. + "canDeleteChildren": True or False, # Output only. Whether the current user can delete children from folders in this shared drive. + "canDeleteDrive": True or False, # 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. + "canDownload": True or False, # Output only. Whether the current user can download files in this shared drive. + "canEdit": True or False, # Output only. Whether the current user can edit files in this shared drive + "canListChildren": True or False, # Output only. Whether the current user can list the children of folders in this shared drive. + "canManageMembers": True or False, # Output only. Whether the current user can add members to this shared drive or remove them or change their role. + "canReadRevisions": True or False, # Output only. Whether the current user can read the revisions resource of files in this shared drive. + "canRename": True or False, # Output only. Whether the current user can rename files or folders in this shared drive. + "canRenameDrive": True or False, # Output only. Whether the current user can rename this shared drive. + "canResetDriveRestrictions": True or False, # Output only. Whether the current user can reset the shared drive restrictions to defaults. + "canShare": True or False, # Output only. Whether the current user can share files or folders in this shared drive. + "canTrashChildren": True or False, # Output only. Whether the current user can trash children from folders in this shared drive. }, - "colorRgb": "A String", # 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. + "colorRgb": "A String", # 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`. "createdDate": "A String", # The time at which the shared drive was created (RFC 3339 date-time). "hidden": True or False, # Whether the shared drive is hidden from default view. - "id": "A String", # The ID of this shared drive which is also the ID of the top level folder of this shared drive. - "kind": "drive#drive", # This is always drive#drive + "id": "A String", # Output only. The ID of this shared drive which is also the ID of the top level folder of this shared drive. + "kind": "drive#drive", # Output only. This is always `drive#drive` "name": "A String", # The name of this shared drive. - "orgUnitId": "A String", # The organizational unit of this shared drive. This field is only populated on drives.list responses when the useDomainAdminAccess parameter is set to true. + "orgUnitId": "A String", # 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`. "restrictions": { # A set of restrictions that apply to this shared drive or items inside this shared drive. "adminManagedRestrictions": True or False, # Whether administrative privileges on this shared drive are required to modify restrictions. - "copyRequiresWriterPermission": True or False, # 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. + "copyRequiresWriterPermission": True or False, # 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. "domainUsersOnly": True or False, # 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. "driveMembersOnly": True or False, # Whether access to items inside this shared drive is restricted to its members. "sharingFoldersRequiresOrganizerPermission": True or False, # 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": "A String", # 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.insert 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. + "themeId": "A String", # 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.insert` 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`. } + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format Returns: An object of the form: { # Representation of a shared drive. - "backgroundImageFile": { # 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. + "backgroundImageFile": { # 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. "id": "A String", # The ID of an image file in Google Drive to use for the background image. "width": 3.14, # 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. "xCoordinate": 3.14, # 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. "yCoordinate": 3.14, # 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. }, - "backgroundImageLink": "A String", # A short-lived link to this shared drive's background image. - "capabilities": { # Capabilities the current user has on this shared drive. - "canAddChildren": True or False, # Whether the current user can add children to folders in this shared drive. - "canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive. - "canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the domainUsersOnly restriction of this shared drive. - "canChangeDriveBackground": True or False, # Whether the current user can change the background of this shared drive. - "canChangeDriveMembersOnlyRestriction": True or False, # Whether the current user can change the driveMembersOnly restriction of this shared drive. - "canChangeSharingFoldersRequiresOrganizerPermissionRestriction": True or False, # Whether the current user can change the sharingFoldersRequiresOrganizerPermission restriction of this shared drive. - "canComment": True or False, # Whether the current user can comment on files in this shared drive. - "canCopy": True or False, # Whether the current user can copy files in this shared drive. - "canDeleteChildren": True or False, # Whether the current user can delete children from folders in this shared drive. - "canDeleteDrive": True or False, # 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. - "canDownload": True or False, # Whether the current user can download files in this shared drive. - "canEdit": True or False, # Whether the current user can edit files in this shared drive - "canListChildren": True or False, # Whether the current user can list the children of folders in this shared drive. - "canManageMembers": True or False, # Whether the current user can add members to this shared drive or remove them or change their role. - "canReadRevisions": True or False, # Whether the current user can read the revisions resource of files in this shared drive. - "canRename": True or False, # Whether the current user can rename files or folders in this shared drive. - "canRenameDrive": True or False, # Whether the current user can rename this shared drive. - "canResetDriveRestrictions": True or False, # Whether the current user can reset the shared drive restrictions to defaults. - "canShare": True or False, # Whether the current user can share files or folders in this shared drive. - "canTrashChildren": True or False, # Whether the current user can trash children from folders in this shared drive. + "backgroundImageLink": "A String", # Output only. A short-lived link to this shared drive's background image. + "capabilities": { # Output only. Capabilities the current user has on this shared drive. + "canAddChildren": True or False, # Output only. Whether the current user can add children to folders in this shared drive. + "canChangeCopyRequiresWriterPermissionRestriction": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this shared drive. + "canChangeDomainUsersOnlyRestriction": True or False, # Output only. Whether the current user can change the `domainUsersOnly` restriction of this shared drive. + "canChangeDriveBackground": True or False, # Output only. Whether the current user can change the background of this shared drive. + "canChangeDriveMembersOnlyRestriction": True or False, # Output only. Whether the current user can change the `driveMembersOnly` restriction of this shared drive. + "canChangeSharingFoldersRequiresOrganizerPermissionRestriction": True or False, # Output only. Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this shared drive. + "canComment": True or False, # Output only. Whether the current user can comment on files in this shared drive. + "canCopy": True or False, # Output only. Whether the current user can copy files in this shared drive. + "canDeleteChildren": True or False, # Output only. Whether the current user can delete children from folders in this shared drive. + "canDeleteDrive": True or False, # 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. + "canDownload": True or False, # Output only. Whether the current user can download files in this shared drive. + "canEdit": True or False, # Output only. Whether the current user can edit files in this shared drive + "canListChildren": True or False, # Output only. Whether the current user can list the children of folders in this shared drive. + "canManageMembers": True or False, # Output only. Whether the current user can add members to this shared drive or remove them or change their role. + "canReadRevisions": True or False, # Output only. Whether the current user can read the revisions resource of files in this shared drive. + "canRename": True or False, # Output only. Whether the current user can rename files or folders in this shared drive. + "canRenameDrive": True or False, # Output only. Whether the current user can rename this shared drive. + "canResetDriveRestrictions": True or False, # Output only. Whether the current user can reset the shared drive restrictions to defaults. + "canShare": True or False, # Output only. Whether the current user can share files or folders in this shared drive. + "canTrashChildren": True or False, # Output only. Whether the current user can trash children from folders in this shared drive. }, - "colorRgb": "A String", # 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. + "colorRgb": "A String", # 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`. "createdDate": "A String", # The time at which the shared drive was created (RFC 3339 date-time). "hidden": True or False, # Whether the shared drive is hidden from default view. - "id": "A String", # The ID of this shared drive which is also the ID of the top level folder of this shared drive. - "kind": "drive#drive", # This is always drive#drive + "id": "A String", # Output only. The ID of this shared drive which is also the ID of the top level folder of this shared drive. + "kind": "drive#drive", # Output only. This is always `drive#drive` "name": "A String", # The name of this shared drive. - "orgUnitId": "A String", # The organizational unit of this shared drive. This field is only populated on drives.list responses when the useDomainAdminAccess parameter is set to true. + "orgUnitId": "A String", # 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`. "restrictions": { # A set of restrictions that apply to this shared drive or items inside this shared drive. "adminManagedRestrictions": True or False, # Whether administrative privileges on this shared drive are required to modify restrictions. - "copyRequiresWriterPermission": True or False, # 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. + "copyRequiresWriterPermission": True or False, # 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. "domainUsersOnly": True or False, # 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. "driveMembersOnly": True or False, # Whether access to items inside this shared drive is restricted to its members. "sharingFoldersRequiresOrganizerPermission": True or False, # 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": "A String", # 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.insert 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. + "themeId": "A String", # 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.insert` 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`. }-@@ -425,65 +445,69 @@list(maxResults=None, pageToken=None, q=None, useDomainAdminAccess=None)-Lists the user's shared drives. +list(maxResults=None, pageToken=None, q=None, useDomainAdminAccess=None, x__xgafv=None)+Lists the user's shared drives. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for shared drives](/drive/api/guides/search-shareddrives) guide. Args: maxResults: integer, Maximum number of shared drives to return per page. pageToken: string, Page token for shared drives. q: string, Query string for searching shared drives. useDomainAdminAccess: boolean, Issue the request as a domain administrator; if set to true, then all shared drives of the domain in which the requester is an administrator are returned. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format Returns: An object of the form: @@ -359,53 +379,53 @@Method Details
{ # A list of shared drives. "items": [ # The list of shared drives. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. { # Representation of a shared drive. - "backgroundImageFile": { # 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. + "backgroundImageFile": { # 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. "id": "A String", # The ID of an image file in Google Drive to use for the background image. "width": 3.14, # 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. "xCoordinate": 3.14, # 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. "yCoordinate": 3.14, # 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. }, - "backgroundImageLink": "A String", # A short-lived link to this shared drive's background image. - "capabilities": { # Capabilities the current user has on this shared drive. - "canAddChildren": True or False, # Whether the current user can add children to folders in this shared drive. - "canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive. - "canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the domainUsersOnly restriction of this shared drive. - "canChangeDriveBackground": True or False, # Whether the current user can change the background of this shared drive. - "canChangeDriveMembersOnlyRestriction": True or False, # Whether the current user can change the driveMembersOnly restriction of this shared drive. - "canChangeSharingFoldersRequiresOrganizerPermissionRestriction": True or False, # Whether the current user can change the sharingFoldersRequiresOrganizerPermission restriction of this shared drive. - "canComment": True or False, # Whether the current user can comment on files in this shared drive. - "canCopy": True or False, # Whether the current user can copy files in this shared drive. - "canDeleteChildren": True or False, # Whether the current user can delete children from folders in this shared drive. - "canDeleteDrive": True or False, # 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. - "canDownload": True or False, # Whether the current user can download files in this shared drive. - "canEdit": True or False, # Whether the current user can edit files in this shared drive - "canListChildren": True or False, # Whether the current user can list the children of folders in this shared drive. - "canManageMembers": True or False, # Whether the current user can add members to this shared drive or remove them or change their role. - "canReadRevisions": True or False, # Whether the current user can read the revisions resource of files in this shared drive. - "canRename": True or False, # Whether the current user can rename files or folders in this shared drive. - "canRenameDrive": True or False, # Whether the current user can rename this shared drive. - "canResetDriveRestrictions": True or False, # Whether the current user can reset the shared drive restrictions to defaults. - "canShare": True or False, # Whether the current user can share files or folders in this shared drive. - "canTrashChildren": True or False, # Whether the current user can trash children from folders in this shared drive. + "backgroundImageLink": "A String", # Output only. A short-lived link to this shared drive's background image. + "capabilities": { # Output only. Capabilities the current user has on this shared drive. + "canAddChildren": True or False, # Output only. Whether the current user can add children to folders in this shared drive. + "canChangeCopyRequiresWriterPermissionRestriction": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this shared drive. + "canChangeDomainUsersOnlyRestriction": True or False, # Output only. Whether the current user can change the `domainUsersOnly` restriction of this shared drive. + "canChangeDriveBackground": True or False, # Output only. Whether the current user can change the background of this shared drive. + "canChangeDriveMembersOnlyRestriction": True or False, # Output only. Whether the current user can change the `driveMembersOnly` restriction of this shared drive. + "canChangeSharingFoldersRequiresOrganizerPermissionRestriction": True or False, # Output only. Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this shared drive. + "canComment": True or False, # Output only. Whether the current user can comment on files in this shared drive. + "canCopy": True or False, # Output only. Whether the current user can copy files in this shared drive. + "canDeleteChildren": True or False, # Output only. Whether the current user can delete children from folders in this shared drive. + "canDeleteDrive": True or False, # 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. + "canDownload": True or False, # Output only. Whether the current user can download files in this shared drive. + "canEdit": True or False, # Output only. Whether the current user can edit files in this shared drive + "canListChildren": True or False, # Output only. Whether the current user can list the children of folders in this shared drive. + "canManageMembers": True or False, # Output only. Whether the current user can add members to this shared drive or remove them or change their role. + "canReadRevisions": True or False, # Output only. Whether the current user can read the revisions resource of files in this shared drive. + "canRename": True or False, # Output only. Whether the current user can rename files or folders in this shared drive. + "canRenameDrive": True or False, # Output only. Whether the current user can rename this shared drive. + "canResetDriveRestrictions": True or False, # Output only. Whether the current user can reset the shared drive restrictions to defaults. + "canShare": True or False, # Output only. Whether the current user can share files or folders in this shared drive. + "canTrashChildren": True or False, # Output only. Whether the current user can trash children from folders in this shared drive. }, - "colorRgb": "A String", # 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. + "colorRgb": "A String", # 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`. "createdDate": "A String", # The time at which the shared drive was created (RFC 3339 date-time). "hidden": True or False, # Whether the shared drive is hidden from default view. - "id": "A String", # The ID of this shared drive which is also the ID of the top level folder of this shared drive. - "kind": "drive#drive", # This is always drive#drive + "id": "A String", # Output only. The ID of this shared drive which is also the ID of the top level folder of this shared drive. + "kind": "drive#drive", # Output only. This is always `drive#drive` "name": "A String", # The name of this shared drive. - "orgUnitId": "A String", # The organizational unit of this shared drive. This field is only populated on drives.list responses when the useDomainAdminAccess parameter is set to true. + "orgUnitId": "A String", # 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`. "restrictions": { # A set of restrictions that apply to this shared drive or items inside this shared drive. "adminManagedRestrictions": True or False, # Whether administrative privileges on this shared drive are required to modify restrictions. - "copyRequiresWriterPermission": True or False, # 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. + "copyRequiresWriterPermission": True or False, # 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. "domainUsersOnly": True or False, # 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. "driveMembersOnly": True or False, # Whether access to items inside this shared drive is restricted to its members. "sharingFoldersRequiresOrganizerPermission": True or False, # 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": "A String", # 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.insert 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. + "themeId": "A String", # 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.insert` 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`. }, ], - "kind": "drive#driveList", # This is always drive#driveList + "kind": "drive#driveList", # This is always `drive#driveList` "nextPageToken": "A String", # The page token for the next page of shared drives. This will be absent if the end of the list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. }Method Details
unhide(driveId)
+ unhide(driveId, x__xgafv=None)
Restores a shared drive to the default view.
Args:
driveId: string, The ID of the shared drive. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
{ # Representation of a shared drive.
- "backgroundImageFile": { # 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.
+ "backgroundImageFile": { # 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.
"id": "A String", # The ID of an image file in Google Drive to use for the background image.
"width": 3.14, # 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.
"xCoordinate": 3.14, # 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.
"yCoordinate": 3.14, # 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.
},
- "backgroundImageLink": "A String", # A short-lived link to this shared drive's background image.
- "capabilities": { # Capabilities the current user has on this shared drive.
- "canAddChildren": True or False, # Whether the current user can add children to folders in this shared drive.
- "canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive.
- "canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the domainUsersOnly restriction of this shared drive.
- "canChangeDriveBackground": True or False, # Whether the current user can change the background of this shared drive.
- "canChangeDriveMembersOnlyRestriction": True or False, # Whether the current user can change the driveMembersOnly restriction of this shared drive.
- "canChangeSharingFoldersRequiresOrganizerPermissionRestriction": True or False, # Whether the current user can change the sharingFoldersRequiresOrganizerPermission restriction of this shared drive.
- "canComment": True or False, # Whether the current user can comment on files in this shared drive.
- "canCopy": True or False, # Whether the current user can copy files in this shared drive.
- "canDeleteChildren": True or False, # Whether the current user can delete children from folders in this shared drive.
- "canDeleteDrive": True or False, # 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.
- "canDownload": True or False, # Whether the current user can download files in this shared drive.
- "canEdit": True or False, # Whether the current user can edit files in this shared drive
- "canListChildren": True or False, # Whether the current user can list the children of folders in this shared drive.
- "canManageMembers": True or False, # Whether the current user can add members to this shared drive or remove them or change their role.
- "canReadRevisions": True or False, # Whether the current user can read the revisions resource of files in this shared drive.
- "canRename": True or False, # Whether the current user can rename files or folders in this shared drive.
- "canRenameDrive": True or False, # Whether the current user can rename this shared drive.
- "canResetDriveRestrictions": True or False, # Whether the current user can reset the shared drive restrictions to defaults.
- "canShare": True or False, # Whether the current user can share files or folders in this shared drive.
- "canTrashChildren": True or False, # Whether the current user can trash children from folders in this shared drive.
+ "backgroundImageLink": "A String", # Output only. A short-lived link to this shared drive's background image.
+ "capabilities": { # Output only. Capabilities the current user has on this shared drive.
+ "canAddChildren": True or False, # Output only. Whether the current user can add children to folders in this shared drive.
+ "canChangeCopyRequiresWriterPermissionRestriction": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this shared drive.
+ "canChangeDomainUsersOnlyRestriction": True or False, # Output only. Whether the current user can change the `domainUsersOnly` restriction of this shared drive.
+ "canChangeDriveBackground": True or False, # Output only. Whether the current user can change the background of this shared drive.
+ "canChangeDriveMembersOnlyRestriction": True or False, # Output only. Whether the current user can change the `driveMembersOnly` restriction of this shared drive.
+ "canChangeSharingFoldersRequiresOrganizerPermissionRestriction": True or False, # Output only. Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this shared drive.
+ "canComment": True or False, # Output only. Whether the current user can comment on files in this shared drive.
+ "canCopy": True or False, # Output only. Whether the current user can copy files in this shared drive.
+ "canDeleteChildren": True or False, # Output only. Whether the current user can delete children from folders in this shared drive.
+ "canDeleteDrive": True or False, # 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.
+ "canDownload": True or False, # Output only. Whether the current user can download files in this shared drive.
+ "canEdit": True or False, # Output only. Whether the current user can edit files in this shared drive
+ "canListChildren": True or False, # Output only. Whether the current user can list the children of folders in this shared drive.
+ "canManageMembers": True or False, # Output only. Whether the current user can add members to this shared drive or remove them or change their role.
+ "canReadRevisions": True or False, # Output only. Whether the current user can read the revisions resource of files in this shared drive.
+ "canRename": True or False, # Output only. Whether the current user can rename files or folders in this shared drive.
+ "canRenameDrive": True or False, # Output only. Whether the current user can rename this shared drive.
+ "canResetDriveRestrictions": True or False, # Output only. Whether the current user can reset the shared drive restrictions to defaults.
+ "canShare": True or False, # Output only. Whether the current user can share files or folders in this shared drive.
+ "canTrashChildren": True or False, # Output only. Whether the current user can trash children from folders in this shared drive.
},
- "colorRgb": "A String", # 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.
+ "colorRgb": "A String", # 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`.
"createdDate": "A String", # The time at which the shared drive was created (RFC 3339 date-time).
"hidden": True or False, # Whether the shared drive is hidden from default view.
- "id": "A String", # The ID of this shared drive which is also the ID of the top level folder of this shared drive.
- "kind": "drive#drive", # This is always drive#drive
+ "id": "A String", # Output only. The ID of this shared drive which is also the ID of the top level folder of this shared drive.
+ "kind": "drive#drive", # Output only. This is always `drive#drive`
"name": "A String", # The name of this shared drive.
- "orgUnitId": "A String", # The organizational unit of this shared drive. This field is only populated on drives.list responses when the useDomainAdminAccess parameter is set to true.
+ "orgUnitId": "A String", # 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`.
"restrictions": { # A set of restrictions that apply to this shared drive or items inside this shared drive.
"adminManagedRestrictions": True or False, # Whether administrative privileges on this shared drive are required to modify restrictions.
- "copyRequiresWriterPermission": True or False, # 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.
+ "copyRequiresWriterPermission": True or False, # 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.
"domainUsersOnly": True or False, # 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.
"driveMembersOnly": True or False, # Whether access to items inside this shared drive is restricted to its members.
"sharingFoldersRequiresOrganizerPermission": True or False, # 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": "A String", # 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.insert 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.
+ "themeId": "A String", # 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.insert` 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`.
}
update(driveId, body=None, useDomainAdminAccess=None)
+ update(driveId, body=None, useDomainAdminAccess=None, x__xgafv=None)
Updates the metadata for a shared drive. Args: @@ -492,102 +516,106 @@Method Details
The object takes the form of: { # Representation of a shared drive. - "backgroundImageFile": { # 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. + "backgroundImageFile": { # 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. "id": "A String", # The ID of an image file in Google Drive to use for the background image. "width": 3.14, # 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. "xCoordinate": 3.14, # 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. "yCoordinate": 3.14, # 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. }, - "backgroundImageLink": "A String", # A short-lived link to this shared drive's background image. - "capabilities": { # Capabilities the current user has on this shared drive. - "canAddChildren": True or False, # Whether the current user can add children to folders in this shared drive. - "canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive. - "canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the domainUsersOnly restriction of this shared drive. - "canChangeDriveBackground": True or False, # Whether the current user can change the background of this shared drive. - "canChangeDriveMembersOnlyRestriction": True or False, # Whether the current user can change the driveMembersOnly restriction of this shared drive. - "canChangeSharingFoldersRequiresOrganizerPermissionRestriction": True or False, # Whether the current user can change the sharingFoldersRequiresOrganizerPermission restriction of this shared drive. - "canComment": True or False, # Whether the current user can comment on files in this shared drive. - "canCopy": True or False, # Whether the current user can copy files in this shared drive. - "canDeleteChildren": True or False, # Whether the current user can delete children from folders in this shared drive. - "canDeleteDrive": True or False, # 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. - "canDownload": True or False, # Whether the current user can download files in this shared drive. - "canEdit": True or False, # Whether the current user can edit files in this shared drive - "canListChildren": True or False, # Whether the current user can list the children of folders in this shared drive. - "canManageMembers": True or False, # Whether the current user can add members to this shared drive or remove them or change their role. - "canReadRevisions": True or False, # Whether the current user can read the revisions resource of files in this shared drive. - "canRename": True or False, # Whether the current user can rename files or folders in this shared drive. - "canRenameDrive": True or False, # Whether the current user can rename this shared drive. - "canResetDriveRestrictions": True or False, # Whether the current user can reset the shared drive restrictions to defaults. - "canShare": True or False, # Whether the current user can share files or folders in this shared drive. - "canTrashChildren": True or False, # Whether the current user can trash children from folders in this shared drive. + "backgroundImageLink": "A String", # Output only. A short-lived link to this shared drive's background image. + "capabilities": { # Output only. Capabilities the current user has on this shared drive. + "canAddChildren": True or False, # Output only. Whether the current user can add children to folders in this shared drive. + "canChangeCopyRequiresWriterPermissionRestriction": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this shared drive. + "canChangeDomainUsersOnlyRestriction": True or False, # Output only. Whether the current user can change the `domainUsersOnly` restriction of this shared drive. + "canChangeDriveBackground": True or False, # Output only. Whether the current user can change the background of this shared drive. + "canChangeDriveMembersOnlyRestriction": True or False, # Output only. Whether the current user can change the `driveMembersOnly` restriction of this shared drive. + "canChangeSharingFoldersRequiresOrganizerPermissionRestriction": True or False, # Output only. Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this shared drive. + "canComment": True or False, # Output only. Whether the current user can comment on files in this shared drive. + "canCopy": True or False, # Output only. Whether the current user can copy files in this shared drive. + "canDeleteChildren": True or False, # Output only. Whether the current user can delete children from folders in this shared drive. + "canDeleteDrive": True or False, # 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. + "canDownload": True or False, # Output only. Whether the current user can download files in this shared drive. + "canEdit": True or False, # Output only. Whether the current user can edit files in this shared drive + "canListChildren": True or False, # Output only. Whether the current user can list the children of folders in this shared drive. + "canManageMembers": True or False, # Output only. Whether the current user can add members to this shared drive or remove them or change their role. + "canReadRevisions": True or False, # Output only. Whether the current user can read the revisions resource of files in this shared drive. + "canRename": True or False, # Output only. Whether the current user can rename files or folders in this shared drive. + "canRenameDrive": True or False, # Output only. Whether the current user can rename this shared drive. + "canResetDriveRestrictions": True or False, # Output only. Whether the current user can reset the shared drive restrictions to defaults. + "canShare": True or False, # Output only. Whether the current user can share files or folders in this shared drive. + "canTrashChildren": True or False, # Output only. Whether the current user can trash children from folders in this shared drive. }, - "colorRgb": "A String", # 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. + "colorRgb": "A String", # 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`. "createdDate": "A String", # The time at which the shared drive was created (RFC 3339 date-time). "hidden": True or False, # Whether the shared drive is hidden from default view. - "id": "A String", # The ID of this shared drive which is also the ID of the top level folder of this shared drive. - "kind": "drive#drive", # This is always drive#drive + "id": "A String", # Output only. The ID of this shared drive which is also the ID of the top level folder of this shared drive. + "kind": "drive#drive", # Output only. This is always `drive#drive` "name": "A String", # The name of this shared drive. - "orgUnitId": "A String", # The organizational unit of this shared drive. This field is only populated on drives.list responses when the useDomainAdminAccess parameter is set to true. + "orgUnitId": "A String", # 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`. "restrictions": { # A set of restrictions that apply to this shared drive or items inside this shared drive. "adminManagedRestrictions": True or False, # Whether administrative privileges on this shared drive are required to modify restrictions. - "copyRequiresWriterPermission": True or False, # 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. + "copyRequiresWriterPermission": True or False, # 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. "domainUsersOnly": True or False, # 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. "driveMembersOnly": True or False, # Whether access to items inside this shared drive is restricted to its members. "sharingFoldersRequiresOrganizerPermission": True or False, # 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": "A String", # 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.insert 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. + "themeId": "A String", # 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.insert` 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`. } useDomainAdminAccess: boolean, Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format Returns: An object of the form: { # Representation of a shared drive. - "backgroundImageFile": { # 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. + "backgroundImageFile": { # 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. "id": "A String", # The ID of an image file in Google Drive to use for the background image. "width": 3.14, # 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. "xCoordinate": 3.14, # 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. "yCoordinate": 3.14, # 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. }, - "backgroundImageLink": "A String", # A short-lived link to this shared drive's background image. - "capabilities": { # Capabilities the current user has on this shared drive. - "canAddChildren": True or False, # Whether the current user can add children to folders in this shared drive. - "canChangeCopyRequiresWriterPermissionRestriction": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive. - "canChangeDomainUsersOnlyRestriction": True or False, # Whether the current user can change the domainUsersOnly restriction of this shared drive. - "canChangeDriveBackground": True or False, # Whether the current user can change the background of this shared drive. - "canChangeDriveMembersOnlyRestriction": True or False, # Whether the current user can change the driveMembersOnly restriction of this shared drive. - "canChangeSharingFoldersRequiresOrganizerPermissionRestriction": True or False, # Whether the current user can change the sharingFoldersRequiresOrganizerPermission restriction of this shared drive. - "canComment": True or False, # Whether the current user can comment on files in this shared drive. - "canCopy": True or False, # Whether the current user can copy files in this shared drive. - "canDeleteChildren": True or False, # Whether the current user can delete children from folders in this shared drive. - "canDeleteDrive": True or False, # 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. - "canDownload": True or False, # Whether the current user can download files in this shared drive. - "canEdit": True or False, # Whether the current user can edit files in this shared drive - "canListChildren": True or False, # Whether the current user can list the children of folders in this shared drive. - "canManageMembers": True or False, # Whether the current user can add members to this shared drive or remove them or change their role. - "canReadRevisions": True or False, # Whether the current user can read the revisions resource of files in this shared drive. - "canRename": True or False, # Whether the current user can rename files or folders in this shared drive. - "canRenameDrive": True or False, # Whether the current user can rename this shared drive. - "canResetDriveRestrictions": True or False, # Whether the current user can reset the shared drive restrictions to defaults. - "canShare": True or False, # Whether the current user can share files or folders in this shared drive. - "canTrashChildren": True or False, # Whether the current user can trash children from folders in this shared drive. + "backgroundImageLink": "A String", # Output only. A short-lived link to this shared drive's background image. + "capabilities": { # Output only. Capabilities the current user has on this shared drive. + "canAddChildren": True or False, # Output only. Whether the current user can add children to folders in this shared drive. + "canChangeCopyRequiresWriterPermissionRestriction": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this shared drive. + "canChangeDomainUsersOnlyRestriction": True or False, # Output only. Whether the current user can change the `domainUsersOnly` restriction of this shared drive. + "canChangeDriveBackground": True or False, # Output only. Whether the current user can change the background of this shared drive. + "canChangeDriveMembersOnlyRestriction": True or False, # Output only. Whether the current user can change the `driveMembersOnly` restriction of this shared drive. + "canChangeSharingFoldersRequiresOrganizerPermissionRestriction": True or False, # Output only. Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this shared drive. + "canComment": True or False, # Output only. Whether the current user can comment on files in this shared drive. + "canCopy": True or False, # Output only. Whether the current user can copy files in this shared drive. + "canDeleteChildren": True or False, # Output only. Whether the current user can delete children from folders in this shared drive. + "canDeleteDrive": True or False, # 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. + "canDownload": True or False, # Output only. Whether the current user can download files in this shared drive. + "canEdit": True or False, # Output only. Whether the current user can edit files in this shared drive + "canListChildren": True or False, # Output only. Whether the current user can list the children of folders in this shared drive. + "canManageMembers": True or False, # Output only. Whether the current user can add members to this shared drive or remove them or change their role. + "canReadRevisions": True or False, # Output only. Whether the current user can read the revisions resource of files in this shared drive. + "canRename": True or False, # Output only. Whether the current user can rename files or folders in this shared drive. + "canRenameDrive": True or False, # Output only. Whether the current user can rename this shared drive. + "canResetDriveRestrictions": True or False, # Output only. Whether the current user can reset the shared drive restrictions to defaults. + "canShare": True or False, # Output only. Whether the current user can share files or folders in this shared drive. + "canTrashChildren": True or False, # Output only. Whether the current user can trash children from folders in this shared drive. }, - "colorRgb": "A String", # 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. + "colorRgb": "A String", # 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`. "createdDate": "A String", # The time at which the shared drive was created (RFC 3339 date-time). "hidden": True or False, # Whether the shared drive is hidden from default view. - "id": "A String", # The ID of this shared drive which is also the ID of the top level folder of this shared drive. - "kind": "drive#drive", # This is always drive#drive + "id": "A String", # Output only. The ID of this shared drive which is also the ID of the top level folder of this shared drive. + "kind": "drive#drive", # Output only. This is always `drive#drive` "name": "A String", # The name of this shared drive. - "orgUnitId": "A String", # The organizational unit of this shared drive. This field is only populated on drives.list responses when the useDomainAdminAccess parameter is set to true. + "orgUnitId": "A String", # 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`. "restrictions": { # A set of restrictions that apply to this shared drive or items inside this shared drive. "adminManagedRestrictions": True or False, # Whether administrative privileges on this shared drive are required to modify restrictions. - "copyRequiresWriterPermission": True or False, # 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. + "copyRequiresWriterPermission": True or False, # 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. "domainUsersOnly": True or False, # 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. "driveMembersOnly": True or False, # Whether access to items inside this shared drive is restricted to its members. "sharingFoldersRequiresOrganizerPermission": True or False, # 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": "A String", # 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.insert 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. + "themeId": "A String", # 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.insert` 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`. }
Close httplib2 connections.
-Creates a copy of the specified file. Folders cannot be copied.
+copy(fileId, body=None, convert=None, enforceSingleParent=None, includeLabels=None, includePermissionsForView=None, ocr=None, ocrLanguage=None, pinned=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, visibility=None, x__xgafv=None)
+Creates a copy of the specified file.
- delete(fileId, enforceSingleParent=None, supportsAllDrives=None, supportsTeamDrives=None)
delete(fileId, enforceSingleParent=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None)
Permanently deletes a file by ID. Skips the trash. The currently authenticated user must own the file or be an organizer on the parent for shared drive files.
- emptyTrash(driveId=None, enforceSingleParent=None)
Permanently deletes all trashed files of a user or shared drive.
+emptyTrash(driveId=None, enforceSingleParent=None, x__xgafv=None)
+Permanently deletes all of the user's trashed files.
+export(fileId, mimeType, x__xgafv=None)
Exports a Google Workspace document to the requested MIME type and returns exported byte content. Note that the exported content is limited to 10MB.
- export_media(fileId, mimeType)
export_media(fileId, mimeType, x__xgafv=None)
Exports a Google Workspace document to the requested MIME type and returns exported byte content. Note that the exported content is limited to 10MB.
- generateIds(maxResults=None, space=None, type=None)
generateIds(maxResults=None, space=None, type=None, x__xgafv=None)
Generates a set of file IDs which can be provided in insert or copy requests.
-Gets a file's metadata or content by ID.
+get(fileId, acknowledgeAbuse=None, includeLabels=None, includePermissionsForView=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None, x__xgafv=None)
+Gets a file's metadata or content by ID. If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/drive/api/reference/rest/v2/files/export) instead. For more information, see [Download & export files](/drive/api/guides/manage-downloads).
-Gets a file's metadata or content by ID.
+get_media(fileId, acknowledgeAbuse=None, includeLabels=None, includePermissionsForView=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None, x__xgafv=None)
+Gets a file's metadata or content by ID. If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/drive/api/reference/rest/v2/files/export) instead. For more information, see [Download & export files](/drive/api/guides/manage-downloads).
-Insert a new file.
+insert(body=None, convert=None, enforceSingleParent=None, includeLabels=None, includePermissionsForView=None, media_body=None, media_mime_type=None, ocr=None, ocrLanguage=None, pinned=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, useContentAsIndexableText=None, visibility=None, x__xgafv=None)
+Inserts a new file. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/drive/api/guides/manage-uploads). Apps creating shortcuts with `files.insert` must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `title` property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `"title": "cat.jpg"` in the metadata. Subsequent `GET` requests include the read-only `fileExtension` property populated with the extension originally specified in the `title` property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with extension) based on the title. In cases where the extension is missing, Drive attempts to determine the extension based on the file's MIME type.
-Lists the user's files.
+list(corpora=None, corpus=None, driveId=None, includeItemsFromAllDrives=None, includeLabels=None, includePermissionsForView=None, includeTeamDriveItems=None, maxResults=None, orderBy=None, pageToken=None, projection=None, q=None, spaces=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None, x__xgafv=None)
+Lists the user's files. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for files & folders](/drive/api/guides/search-files) guide. *Note:* This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results.
- listLabels(fileId, maxResults=None, pageToken=None)
listLabels(fileId, maxResults=None, pageToken=None, x__xgafv=None)
Lists the labels on a file.
@@ -117,29 +117,26 @@list_next()
Retrieves the next page of results.
- modifyLabels(fileId, body=None)
Modifies the set of labels on a file.
+modifyLabels(fileId, body=None, x__xgafv=None)
+Modifies the set of labels applied to a file. Returns a list of the labels that were added or modified.
+patch(fileId, addParents=None, body=None, convert=None, enforceSingleParent=None, includeLabels=None, includePermissionsForView=None, modifiedDateBehavior=None, newRevision=None, ocr=None, ocrLanguage=None, pinned=None, removeParents=None, setModifiedDate=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, updateViewedDate=None, useContentAsIndexableText=None, x__xgafv=None)
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.
+touch(fileId, includeLabels=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None)
Set the file's updated time to the current server time.
-Moves a file to the trash. The currently authenticated user must own the file or be at least a fileOrganizer on the parent for shared drive files. Only the owner may 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.
+trash(fileId, includeLabels=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None)
+Moves a file to the trash. The currently authenticated user must own the file or be at least a `fileOrganizer` on the parent for shared drive files. Only the owner may trash a file. The trashed item is excluded from all `files.list` responses returned for any user who doesn't 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. *Note:* Files moved to the trash still appear by default in results from the `files.list` method. To permanently remove a file, use `files.delete`.
-Restores a file from the trash. The currently authenticated user must own the file or be at least a fileOrganizer on the parent for shared drive files. Only the owner may untrash a file.
+untrash(fileId, includeLabels=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None)
+Restores a file from the trash. The currently authenticated user must own the file or be at least a `fileOrganizer` on the parent for shared drive files. Only the owner may untrash a 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 be changed automatically, such as modifiedDate. This method supports patch semantics.
+update(fileId, addParents=None, body=None, convert=None, enforceSingleParent=None, includeLabels=None, includePermissionsForView=None, media_body=None, media_mime_type=None, modifiedDateBehavior=None, newRevision=None, ocr=None, ocrLanguage=None, pinned=None, removeParents=None, setModifiedDate=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, updateViewedDate=None, useContentAsIndexableText=None, x__xgafv=None)
+Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/drive/api/guides/manage-uploads).
-Subscribe to changes on a file.
- -Subscribe to changes on a file.
+watch(fileId, acknowledgeAbuse=None, body=None, includeLabels=None, includePermissionsForView=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None, x__xgafv=None)
+Subscribes to changes to a file.
close()
@@ -147,8 +144,8 @@ copy(fileId, body=None, convert=None, enforceSingleParent=None, includeLabels=None, includePermissionsForView=None, ocr=None, ocrLanguage=None, pinned=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, visibility=None)
- Creates a copy of the specified file. Folders cannot be copied. +copy(fileId, body=None, convert=None, enforceSingleParent=None, includeLabels=None, includePermissionsForView=None, ocr=None, ocrLanguage=None, pinned=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, visibility=None, x__xgafv=None)+Creates a copy of the specified file. Args: fileId: string, The ID of the file to copy. (required) @@ -156,923 +153,849 @@Method Details
The object takes the form of: { # The metadata for a file. - "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer. - "appDataContents": True or False, # Whether this file is in the Application Data folder. - "canComment": True or False, # Deprecated: use capabilities/canComment. - "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions. - "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. - "canAcceptOwnership": True or False, # Whether the current user is the pending owner of the file. Not populated for shared drive files. - "canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder. - "canAddFolderFromAnotherDrive": True or False, # 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 is not a folder. Only populated for items in shared drives. - "canAddMyDriveParent": True or False, # 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": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file. - "canChangeRestrictedDownload": True or False, # Deprecated - "canChangeSecurityUpdateEnabled": True or False, # Whether the current user can change the securityUpdateEnabled field on link share metadata. - "canComment": True or False, # Whether the current user can comment on this file. - "canCopy": True or False, # 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 is not a folder. - "canDelete": True or False, # Whether the current user can delete this file. - "canDeleteChildren": True or False, # Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. - "canDownload": True or False, # Whether the current user can download this file. - "canEdit": True or False, # 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. - "canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder. - "canModifyContent": True or False, # Whether the current user can modify the content of this file. - "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file. - "canModifyLabels": True or False, # Whether the current user can modify the labels on this file. - "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. - "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. - "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not 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. - "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead. - "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. - "canMoveItemOutOfDrive": True or False, # 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 is being added. - "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. - "canMoveItemWithinDrive": True or False, # 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 is being added and the parent that is being removed. - "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. - "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. - "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. - "canReadLabels": True or False, # Whether the current user can read the labels on this file. - "canReadRevisions": True or False, # 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 isn't a folder, can be read. - "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. - "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. - "canRemoveMyDriveParent": True or False, # 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": True or False, # Whether the current user can rename this file. - "canShare": True or False, # Whether the current user can modify the sharing settings for this file. - "canTrash": True or False, # Whether the current user can move this file to trash. - "canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. - "canUntrash": True or False, # Whether the current user can restore this file from trash. + "alternateLink": "A String", # Output only. A link for opening the file in a relevant Google editor or viewer. + "appDataContents": True or False, # Output only. Whether this file is in the Application Data folder. + "canComment": True or False, # Output only. Deprecated: Use `capabilities/canComment` instead. + "canReadRevisions": True or False, # Output only. Deprecated: Use `capabilities/canReadRevisions` instead. + "capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. + "canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files. + "canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always false when the item is not a folder. + "canAddFolderFromAnotherDrive": True or False, # 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 is not a folder. Only populated for items in shared drives. + "canAddMyDriveParent": True or False, # 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. + "canChangeCopyRequiresWriterPermission": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file. + "canChangeRestrictedDownload": True or False, # Output only. Deprecated. + "canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata. + "canComment": True or False, # Output only. Whether the current user can comment on this file. + "canCopy": True or False, # 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 itself if it is not a folder. + "canDelete": True or False, # Output only. Whether the current user can delete this file. + "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDownload": True or False, # Output only. Whether the current user can download this file. + "canEdit": True or False, # 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`. + "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. + "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. + "canModifyContentRestriction": True or False, # Output only. Whether the current user can modify restrictions on content of this file. + "canModifyLabels": True or False, # Output only. Whether the current user can modify the labels on the file. + "canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. + "canMoveChildrenOutOfTeamDrive": True or False, # Output only. Deprecated: Use `canMoveChildrenOutOfDrive` instead. + "canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is false when the item is not 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. + "canMoveChildrenWithinTeamDrive": True or False, # Output only. Deprecated: Use `canMoveChildrenWithinDrive` instead. + "canMoveItemIntoTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemOutOfDrive` instead. + "canMoveItemOutOfDrive": True or False, # 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 is being added. + "canMoveItemOutOfTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemOutOfDrive` instead. + "canMoveItemWithinDrive": True or False, # 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 is being added and the parent that is being removed. + "canMoveItemWithinTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemWithinDrive` instead. + "canMoveTeamDriveItem": True or False, # Output only. Deprecated: Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead. + "canReadDrive": True or False, # Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. + "canReadLabels": True or False, # Output only. Whether the current user can read the labels on the file. + "canReadRevisions": True or False, # 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 itself if it is not a folder, can be read. + "canReadTeamDrive": True or False, # Output only. Deprecated: Use `canReadDrive` instead. + "canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead. + "canRemoveMyDriveParent": True or False, # 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. + "canRename": True or False, # Output only. Whether the current user can rename this file. + "canShare": True or False, # Output only. Whether the current user can modify the sharing settings for this file. + "canTrash": True or False, # Output only. Whether the current user can move this file to trash. + "canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists. { # A restriction for accessing the content of the file. "readOnly": True or False, # 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": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true. - "restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`. + "restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly` is true. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, "restrictionDate": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true. - "type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction. + "type": "A String", # Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`. }, ], "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters. - "copyable": True or False, # Deprecated: use capabilities/canCopy. + "copyable": True or False, # Output only. Deprecated: Use `capabilities/canCopy` instead. "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp). - "defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used. + "defaultOpenWithLink": "A String", # Output only. A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used. "description": "A String", # A short description of the file. - "downloadUrl": "A String", # Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives. - "editable": True or False, # Deprecated: use capabilities/canEdit. - "embedLink": "A String", # A link for embedding the file. - "etag": "A String", # ETag of the file. - "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. - "exportLinks": { # Links for exporting Docs Editors files to specific formats. - "a_key": "A String", # A mapping from export format to URL - }, - "fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "fileSize": "A String", # 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 is not populated for shortcuts or folders. + "downloadUrl": "A String", # Output only. Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. + "driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives. + "editable": True or False, # Output only. Deprecated: Use `capabilities/canEdit` instead. + "embedLink": "A String", # Output only. A link for embedding the file. + "etag": "A String", # Output only. ETag of the file. + "explicitlyTrashed": True or False, # Output only. Whether this file has been explicitly trashed, as opposed to recursively trashed. + "exportLinks": { # Output only. Links for exporting Docs Editors files to specific formats. + "a_key": "A String", + }, + "fileExtension": "A String", # Output only. The final component of `fullFileExtension` with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "fileSize": "A String", # Output only. Size in bytes of blobs and first party editor files. Won't be populated for files that have no size, like shortcuts and folders. "folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder or a shortcut to a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette. - "fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives. - "hasThumbnail": True or False, # 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": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "iconLink": "A String", # A link to the file's icon. + "fullFileExtension": "A String", # Output only. The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "hasAugmentedPermissions": True or False, # Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives. + "hasThumbnail": True or False, # Output only. 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": "A String", # Output only. The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "iconLink": "A String", # Output only. A link to the file's icon. "id": "A String", # The ID of the file. - "imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content. - "aperture": 3.14, # The aperture used to create the photo (f-number). - "cameraMake": "A String", # The make of the camera used to create the photo. - "cameraModel": "A String", # The model of the camera used to create the photo. - "colorSpace": "A String", # The color space of the photo. - "date": "A String", # The date and time the photo was taken (EXIF format timestamp). - "exposureBias": 3.14, # The exposure bias of the photo (APEX value). - "exposureMode": "A String", # The exposure mode used to create the photo. - "exposureTime": 3.14, # The length of the exposure, in seconds. - "flashUsed": True or False, # Whether a flash was used to create the photo. - "focalLength": 3.14, # The focal length used to create the photo, in millimeters. - "height": 42, # The height of the image in pixels. - "isoSpeed": 42, # The ISO speed used to create the photo. - "lens": "A String", # The lens used to create the photo. - "location": { # Geographic location information stored in the image. - "altitude": 3.14, # The altitude stored in the image. - "latitude": 3.14, # The latitude stored in the image. - "longitude": 3.14, # The longitude stored in the image. + "imageMediaMetadata": { # Output only. Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content. + "aperture": 3.14, # Output only. The aperture used to create the photo (f-number). + "cameraMake": "A String", # Output only. The make of the camera used to create the photo. + "cameraModel": "A String", # Output only. The model of the camera used to create the photo. + "colorSpace": "A String", # Output only. The color space of the photo. + "date": "A String", # Output only. The date and time the photo was taken (EXIF format timestamp). + "exposureBias": 3.14, # Output only. The exposure bias of the photo (APEX value). + "exposureMode": "A String", # Output only. The exposure mode used to create the photo. + "exposureTime": 3.14, # Output only. The length of the exposure, in seconds. + "flashUsed": True or False, # Output only. Whether a flash was used to create the photo. + "focalLength": 3.14, # Output only. The focal length used to create the photo, in millimeters. + "height": 42, # Output only. The height of the image in pixels. + "isoSpeed": 42, # Output only. The ISO speed used to create the photo. + "lens": "A String", # Output only. The lens used to create the photo. + "location": { # Output only. Geographic location information stored in the image. + "altitude": 3.14, # Output only. The altitude stored in the image. + "latitude": 3.14, # Output only. The latitude stored in the image. + "longitude": 3.14, # Output only. The longitude stored in the image. }, - "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value). - "meteringMode": "A String", # The metering mode used to create the photo. - "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation. - "sensor": "A String", # The type of sensor used to create the photo. - "subjectDistance": 42, # The distance to the subject of the photo, in meters. - "whiteBalance": "A String", # The white balance mode used to create the photo. - "width": 42, # The width of the image in pixels. - }, - "indexableText": { # Indexable text attributes for the file (can only be written). For more information, see Manage file metadata. + "maxApertureValue": 3.14, # Output only. The smallest f-number of the lens at the focal length used to create the photo (APEX value). + "meteringMode": "A String", # Output only. The metering mode used to create the photo. + "rotation": 42, # Output only. The number of clockwise 90 degree rotations applied from the image's original orientation. + "sensor": "A String", # Output only. The type of sensor used to create the photo. + "subjectDistance": 42, # Output only. The distance to the subject of the photo, in meters. + "whiteBalance": "A String", # Output only. The white balance mode used to create the photo. + "width": 42, # Output only. The width of the image in pixels. + }, + "indexableText": { # Indexable text attributes for the file (can only be written) "text": "A String", # The text to be indexed for this file. }, - "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. - "kind": "drive#file", # The type of file. This is always drive#file. - "labelInfo": { # An overview of the labels on the file. - "labels": [ # The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned. - { # Representation of a label and its fields. - "fields": { # A map of the label's fields keyed by the field ID. - "a_key": { # Representation of a label field. + "isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app. + "kind": "drive#file", # Output only. The type of file. This is always `drive#file`. + "labelInfo": { # Output only. An overview of the labels on the file. + "labels": [ # 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. + { # Representation of a label and label fields. + "fields": { # A map of the fields on the label, keyed by the field's ID. + "a_key": { # Representation of field, which is a typed key-value pair. "dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD. "A String", ], - "id": "A String", # The identifier of this field. - "integer": [ # Only present if valueType is integer. + "id": "A String", # The identifier of this label field. + "integer": [ # Only present if `valueType` is `integer`. "A String", ], - "kind": "drive#labelField", # This is always drive#labelField. - "selection": [ # Only present if valueType is selection. + "kind": "drive#labelField", # This is always `drive#labelField`. + "selection": [ # Only present if `valueType` is `selection` "A String", ], - "text": [ # Only present if valueType is text. + "text": [ # Only present if `valueType` is `text`. "A String", ], - "user": [ # Only present if valueType is user. + "user": [ # Only present if `valueType` is `user`. { # Information about a Drive user. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, ], - "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: - # - dateString - # - integer - # - selection - # - text - # - user + "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: * `dateString` * `integer` * `selection` * `text` * `user` }, }, "id": "A String", # The ID of the label. - "kind": "drive#label", # This is always drive#label + "kind": "drive#label", # This is always `drive#label` "revisionId": "A String", # The revision ID of the label. }, ], }, "labels": { # A group of labels for the file. - "hidden": True or False, # Deprecated. - "modified": True or False, # Whether the file has been modified by this user. - "restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead. + "hidden": True or False, # Output only. Deprecated. + "modified": True or False, # Output only. Whether the file has been modified by this user. + "restricted": True or False, # Output only. Deprecated: Use `copyRequiresWriterPermission` instead. "starred": True or False, # Whether this file is starred by the user. - "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may 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. + "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files. "viewed": True or False, # Whether this file has been viewed by this user. }, - "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "lastModifyingUserName": "A String", # Name of the last user to modify this file. + "lastModifyingUserName": "A String", # Output only. Name of the last user to modify this file. "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp). "linkShareMetadata": { # Contains details about the link URLs that clients are using to refer to this item. - "securityUpdateEligible": True or False, # Whether the file is eligible for security update. - "securityUpdateEnabled": True or False, # Whether the security update is enabled for this file. + "securityUpdateEligible": True or False, # Output only. Whether the file is eligible for security update. + "securityUpdateEnabled": True or False, # Output only. Whether the security update is enabled for this file. }, "markedViewedByMeDate": "A String", # Deprecated. - "md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. + "md5Checksum": "A String", # Output only. An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. "mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type. "modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date. "modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set. - "openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used. + "openWithLinks": { # Output only. A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used. "a_key": "A String", }, - "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Google Drive. - "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives. - "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives. + "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the `title` field. This is only available for files with binary content in Google Drive. + "ownedByMe": True or False, # Output only. Whether the file is owned by the current user. Not populated for items in shared drives. + "ownerNames": [ # Output only. Name(s) of the owner(s) of this file. Not populated for items in shared drives. "A String", ], - "owners": [ # 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. + "owners": [ # 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. { # Information about a Drive user. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, ], - "parents": [ # Collection of parent folders which contain this file. - # If not specified as part of an insert 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 can also use the addParents and removeParents parameters to modify the parents list. + "parents": [ # Collection of parent folders which contain this file. If not specified as part of an insert 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 can also use the `addParents` and `removeParents` parameters to modify the parents list. { # A reference to a file's parent. "id": "A String", # The ID of the parent. - "isRoot": True or False, # Whether or not the parent is the root folder. - "kind": "drive#parentReference", # This is always drive#parentReference. - "parentLink": "A String", # A link to the parent. - "selfLink": "A String", # A link back to this reference. + "isRoot": True or False, # Output only. Whether or not the parent is the root folder. + "kind": "drive#parentReference", # Output only. This is always `drive#parentReference`. + "parentLink": "A String", # Output only. A link to the parent. + "selfLink": "A String", # Output only. A link back to this reference. }, ], - "permissionIds": [ # List of permission IDs for users with access to this file. + "permissionIds": [ # Output only. List of permission IDs for users with access to this file. "A String", ], - "permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives. + "permissions": [ # Output only. The list of permissions for users with access to this file. Not populated for items in shared drives. { # A permission for a file. - "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. + "additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future. "A String", ], - "authKey": "A String", # Deprecated. - "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. - "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain. - "emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group. - "etag": "A String", # The ETag of the permission. - "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - # - They cannot be set on shared drive items - # - They can only be set on user and group permissions - # - The date must be in the future - # - The date cannot be more than a year in the future - "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "kind": "drive#permission", # This is always drive#permission. - "name": "A String", # The name for this permission. - "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive. - "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "authKey": "A String", # Output only. Deprecated. + "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. + "domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`. + "emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`. + "etag": "A String", # Output only. The ETag of the permission. + "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests + "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "kind": "drive#permission", # Output only. This is always `drive#permission`. + "name": "A String", # Output only. The name for this permission. + "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. + "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. { - "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. + "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. - "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: - # - file - # - member - "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: - # - organizer - # - fileOrganizer - # - writer - # - reader + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` + "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, ], - "photoLink": "A String", # A link to the profile photo, if available. - "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: - # - owner - # - organizer - # - fileOrganizer - # - writer - # - reader - "selfLink": "A String", # A link back to this permission. - "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. + "photoLink": "A String", # Output only. A link to the profile photo, if available. + "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader` + "selfLink": "A String", # Output only. A link back to this permission. + "teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead. { - "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. + "additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead. "A String", ], - "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. - "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. - "role": "A String", # Deprecated - use permissionDetails/role instead. - "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. + "inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead. + "inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead. + "role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead. + "teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead. }, ], - "type": "A String", # The account type. Allowed values are: - # - user - # - group - # - domain - # - anyone - "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value. + "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` + "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. "withLink": True or False, # Whether the link is required for this permission. }, ], "properties": [ # The list of properties. - { # A key-value pair attached to a file that is either public or private to an application. - # The following limits apply to file properties: - # - Maximum of 100 properties total per file - # - Maximum of 30 private properties per app - # - Maximum of 30 public properties - # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property. - "etag": "A String", # ETag of the property. + { # A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property + "etag": "A String", # Output only. ETag of the property. "key": "A String", # The key of this property. - "kind": "drive#property", # This is always drive#property. - "selfLink": "A String", # The link back to this property. + "kind": "drive#property", # Output only. This is always `drive#property`. + "selfLink": "A String", # Output only. The link back to this property. "value": "A String", # The value of this property. - "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE). Private 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. + "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. Private 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. }, ], - "quotaBytesUsed": "A String", # The number of quota bytes used by this file. - "resourceKey": "A String", # A key needed to access the item via a shared link. - "selfLink": "A String", # A link back to this file. - "sha1Checksum": "A String", # The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "sha256Checksum": "A String", # The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "shareable": True or False, # Deprecated: use capabilities/canShare. - "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives. + "quotaBytesUsed": "A String", # Output only. The number of quota bytes used by this file. + "resourceKey": "A String", # Output only. A key needed to access the item via a shared link. + "selfLink": "A String", # Output only. A link back to this file. + "sha1Checksum": "A String", # 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 is not populated for Docs Editors or shortcut files. + "sha256Checksum": "A String", # 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 is not populated for Docs Editors or shortcut files. + "shareable": True or False, # Output only. Deprecated: Use `capabilities/canShare` instead. + "shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives. "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp). - "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "sharingUser": { # Information about a Drive user. # Output only. User that shared the item with the current user, if available. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut. + "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. "targetId": "A String", # The ID of the file that this shortcut points to. - "targetMimeType": "A String", # 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": "A String", # The ResourceKey for the target file. + "targetMimeType": "A String", # 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": "A String", # Output only. The ResourceKey for the target file. }, - "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'. + "spaces": [ # Output only. The list of spaces which contain the file. Supported values are `drive`, `appDataFolder` and `photos`. "A String", ], - "teamDriveId": "A String", # Deprecated - use driveId instead. + "teamDriveId": "A String", # Output only. Deprecated: Use `driveId` instead. "thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated. "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5. "mimeType": "A String", # The MIME type of the thumbnail. }, - "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. 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": "A String", # The thumbnail version for use in thumbnail cache invalidation. + "thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content. + "thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation. "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant. "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives. - "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "trashingUser": { # Information about a Drive user. # Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file. - "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. + "userPermission": { # A permission for a file. # Output only. The permissions for the authenticated user on this file. + "additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future. "A String", ], - "authKey": "A String", # Deprecated. - "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. - "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain. - "emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group. - "etag": "A String", # The ETag of the permission. - "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - # - They cannot be set on shared drive items - # - They can only be set on user and group permissions - # - The date must be in the future - # - The date cannot be more than a year in the future - "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "kind": "drive#permission", # This is always drive#permission. - "name": "A String", # The name for this permission. - "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive. - "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "authKey": "A String", # Output only. Deprecated. + "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. + "domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`. + "emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`. + "etag": "A String", # Output only. The ETag of the permission. + "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests + "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "kind": "drive#permission", # Output only. This is always `drive#permission`. + "name": "A String", # Output only. The name for this permission. + "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. + "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. { - "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. + "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. - "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: - # - file - # - member - "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: - # - organizer - # - fileOrganizer - # - writer - # - reader + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` + "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, ], - "photoLink": "A String", # A link to the profile photo, if available. - "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: - # - owner - # - organizer - # - fileOrganizer - # - writer - # - reader - "selfLink": "A String", # A link back to this permission. - "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. + "photoLink": "A String", # Output only. A link to the profile photo, if available. + "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader` + "selfLink": "A String", # Output only. A link back to this permission. + "teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead. { - "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. + "additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead. "A String", ], - "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. - "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. - "role": "A String", # Deprecated - use permissionDetails/role instead. - "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. + "inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead. + "inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead. + "role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead. + "teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead. }, ], - "type": "A String", # The account type. Allowed values are: - # - user - # - group - # - domain - # - anyone - "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value. + "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` + "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. "withLink": True or False, # Whether the link is required for this permission. }, - "version": "A String", # 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 requesting user. - "videoMediaMetadata": { # Metadata about video media. This will only be present for video types. - "durationMillis": "A String", # The duration of the video in milliseconds. - "height": 42, # The height of the video in pixels. - "width": 42, # The width of the video in pixels. + "version": "A String", # 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 requesting user. + "videoMediaMetadata": { # Output only. Metadata about video media. This will only be present for video types. + "durationMillis": "A String", # Output only. The duration of the video in milliseconds. + "height": 42, # Output only. The height of the video in pixels. + "width": 42, # Output only. The width of the video in pixels. }, - "webContentLink": "A String", # A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials. - "webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting. + "webContentLink": "A String", # Output only. A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials. + "webViewLink": "A String", # Output only. A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting. "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives. } convert: boolean, Whether to convert this file to the corresponding Docs Editors format. - enforceSingleParent: boolean, Deprecated. Copying files into multiple folders is no longer supported. Use shortcuts instead. - includeLabels: string, A comma-separated list of IDs of labels to include in the labelInfo part of the response. - includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported. + enforceSingleParent: boolean, Deprecated: Copying files into multiple folders is no longer supported. Use shortcuts instead. + includeLabels: string, A comma-separated list of IDs of labels to include in the `labelInfo` part of the response. + includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only `published` is supported. ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads. - ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are BCP 47 codes. + ocrLanguage: string, If `ocr` is true, hints at the language to use. Valid values are BCP 47 codes. pinned: boolean, Whether to pin the head revision of the new copy. A file can have a maximum of 200 pinned revisions. supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. - supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead. + supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead. timedTextLanguage: string, The language of the timed text. timedTextTrackName: string, The timed text track name. visibility: string, The visibility of the new file. This parameter is only relevant when the source is not a native Google Doc and convert=false. Allowed values DEFAULT - The visibility of the new file is determined by the user's default visibility/sharing policies. PRIVATE - The new file will be visible to only the owner. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format Returns: An object of the form: { # The metadata for a file. - "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer. - "appDataContents": True or False, # Whether this file is in the Application Data folder. - "canComment": True or False, # Deprecated: use capabilities/canComment. - "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions. - "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. - "canAcceptOwnership": True or False, # Whether the current user is the pending owner of the file. Not populated for shared drive files. - "canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder. - "canAddFolderFromAnotherDrive": True or False, # 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 is not a folder. Only populated for items in shared drives. - "canAddMyDriveParent": True or False, # 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": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file. - "canChangeRestrictedDownload": True or False, # Deprecated - "canChangeSecurityUpdateEnabled": True or False, # Whether the current user can change the securityUpdateEnabled field on link share metadata. - "canComment": True or False, # Whether the current user can comment on this file. - "canCopy": True or False, # 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 is not a folder. - "canDelete": True or False, # Whether the current user can delete this file. - "canDeleteChildren": True or False, # Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. - "canDownload": True or False, # Whether the current user can download this file. - "canEdit": True or False, # 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. - "canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder. - "canModifyContent": True or False, # Whether the current user can modify the content of this file. - "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file. - "canModifyLabels": True or False, # Whether the current user can modify the labels on this file. - "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. - "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. - "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not 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. - "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead. - "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. - "canMoveItemOutOfDrive": True or False, # 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 is being added. - "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. - "canMoveItemWithinDrive": True or False, # 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 is being added and the parent that is being removed. - "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. - "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. - "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. - "canReadLabels": True or False, # Whether the current user can read the labels on this file. - "canReadRevisions": True or False, # 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 isn't a folder, can be read. - "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. - "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. - "canRemoveMyDriveParent": True or False, # 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": True or False, # Whether the current user can rename this file. - "canShare": True or False, # Whether the current user can modify the sharing settings for this file. - "canTrash": True or False, # Whether the current user can move this file to trash. - "canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. - "canUntrash": True or False, # Whether the current user can restore this file from trash. + "alternateLink": "A String", # Output only. A link for opening the file in a relevant Google editor or viewer. + "appDataContents": True or False, # Output only. Whether this file is in the Application Data folder. + "canComment": True or False, # Output only. Deprecated: Use `capabilities/canComment` instead. + "canReadRevisions": True or False, # Output only. Deprecated: Use `capabilities/canReadRevisions` instead. + "capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. + "canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files. + "canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always false when the item is not a folder. + "canAddFolderFromAnotherDrive": True or False, # 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 is not a folder. Only populated for items in shared drives. + "canAddMyDriveParent": True or False, # 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. + "canChangeCopyRequiresWriterPermission": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file. + "canChangeRestrictedDownload": True or False, # Output only. Deprecated. + "canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata. + "canComment": True or False, # Output only. Whether the current user can comment on this file. + "canCopy": True or False, # 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 itself if it is not a folder. + "canDelete": True or False, # Output only. Whether the current user can delete this file. + "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDownload": True or False, # Output only. Whether the current user can download this file. + "canEdit": True or False, # 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`. + "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. + "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. + "canModifyContentRestriction": True or False, # Output only. Whether the current user can modify restrictions on content of this file. + "canModifyLabels": True or False, # Output only. Whether the current user can modify the labels on the file. + "canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. + "canMoveChildrenOutOfTeamDrive": True or False, # Output only. Deprecated: Use `canMoveChildrenOutOfDrive` instead. + "canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is false when the item is not 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. + "canMoveChildrenWithinTeamDrive": True or False, # Output only. Deprecated: Use `canMoveChildrenWithinDrive` instead. + "canMoveItemIntoTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemOutOfDrive` instead. + "canMoveItemOutOfDrive": True or False, # 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 is being added. + "canMoveItemOutOfTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemOutOfDrive` instead. + "canMoveItemWithinDrive": True or False, # 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 is being added and the parent that is being removed. + "canMoveItemWithinTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemWithinDrive` instead. + "canMoveTeamDriveItem": True or False, # Output only. Deprecated: Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead. + "canReadDrive": True or False, # Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. + "canReadLabels": True or False, # Output only. Whether the current user can read the labels on the file. + "canReadRevisions": True or False, # 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 itself if it is not a folder, can be read. + "canReadTeamDrive": True or False, # Output only. Deprecated: Use `canReadDrive` instead. + "canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead. + "canRemoveMyDriveParent": True or False, # 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. + "canRename": True or False, # Output only. Whether the current user can rename this file. + "canShare": True or False, # Output only. Whether the current user can modify the sharing settings for this file. + "canTrash": True or False, # Output only. Whether the current user can move this file to trash. + "canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists. { # A restriction for accessing the content of the file. "readOnly": True or False, # 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": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true. - "restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`. + "restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly` is true. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, "restrictionDate": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true. - "type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction. + "type": "A String", # Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`. }, ], "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters. - "copyable": True or False, # Deprecated: use capabilities/canCopy. + "copyable": True or False, # Output only. Deprecated: Use `capabilities/canCopy` instead. "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp). - "defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used. + "defaultOpenWithLink": "A String", # Output only. A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used. "description": "A String", # A short description of the file. - "downloadUrl": "A String", # Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives. - "editable": True or False, # Deprecated: use capabilities/canEdit. - "embedLink": "A String", # A link for embedding the file. - "etag": "A String", # ETag of the file. - "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. - "exportLinks": { # Links for exporting Docs Editors files to specific formats. - "a_key": "A String", # A mapping from export format to URL - }, - "fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "fileSize": "A String", # 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 is not populated for shortcuts or folders. + "downloadUrl": "A String", # Output only. Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. + "driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives. + "editable": True or False, # Output only. Deprecated: Use `capabilities/canEdit` instead. + "embedLink": "A String", # Output only. A link for embedding the file. + "etag": "A String", # Output only. ETag of the file. + "explicitlyTrashed": True or False, # Output only. Whether this file has been explicitly trashed, as opposed to recursively trashed. + "exportLinks": { # Output only. Links for exporting Docs Editors files to specific formats. + "a_key": "A String", + }, + "fileExtension": "A String", # Output only. The final component of `fullFileExtension` with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "fileSize": "A String", # Output only. Size in bytes of blobs and first party editor files. Won't be populated for files that have no size, like shortcuts and folders. "folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder or a shortcut to a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette. - "fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives. - "hasThumbnail": True or False, # 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": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "iconLink": "A String", # A link to the file's icon. + "fullFileExtension": "A String", # Output only. The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "hasAugmentedPermissions": True or False, # Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives. + "hasThumbnail": True or False, # Output only. 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": "A String", # Output only. The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "iconLink": "A String", # Output only. A link to the file's icon. "id": "A String", # The ID of the file. - "imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content. - "aperture": 3.14, # The aperture used to create the photo (f-number). - "cameraMake": "A String", # The make of the camera used to create the photo. - "cameraModel": "A String", # The model of the camera used to create the photo. - "colorSpace": "A String", # The color space of the photo. - "date": "A String", # The date and time the photo was taken (EXIF format timestamp). - "exposureBias": 3.14, # The exposure bias of the photo (APEX value). - "exposureMode": "A String", # The exposure mode used to create the photo. - "exposureTime": 3.14, # The length of the exposure, in seconds. - "flashUsed": True or False, # Whether a flash was used to create the photo. - "focalLength": 3.14, # The focal length used to create the photo, in millimeters. - "height": 42, # The height of the image in pixels. - "isoSpeed": 42, # The ISO speed used to create the photo. - "lens": "A String", # The lens used to create the photo. - "location": { # Geographic location information stored in the image. - "altitude": 3.14, # The altitude stored in the image. - "latitude": 3.14, # The latitude stored in the image. - "longitude": 3.14, # The longitude stored in the image. + "imageMediaMetadata": { # Output only. Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content. + "aperture": 3.14, # Output only. The aperture used to create the photo (f-number). + "cameraMake": "A String", # Output only. The make of the camera used to create the photo. + "cameraModel": "A String", # Output only. The model of the camera used to create the photo. + "colorSpace": "A String", # Output only. The color space of the photo. + "date": "A String", # Output only. The date and time the photo was taken (EXIF format timestamp). + "exposureBias": 3.14, # Output only. The exposure bias of the photo (APEX value). + "exposureMode": "A String", # Output only. The exposure mode used to create the photo. + "exposureTime": 3.14, # Output only. The length of the exposure, in seconds. + "flashUsed": True or False, # Output only. Whether a flash was used to create the photo. + "focalLength": 3.14, # Output only. The focal length used to create the photo, in millimeters. + "height": 42, # Output only. The height of the image in pixels. + "isoSpeed": 42, # Output only. The ISO speed used to create the photo. + "lens": "A String", # Output only. The lens used to create the photo. + "location": { # Output only. Geographic location information stored in the image. + "altitude": 3.14, # Output only. The altitude stored in the image. + "latitude": 3.14, # Output only. The latitude stored in the image. + "longitude": 3.14, # Output only. The longitude stored in the image. }, - "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value). - "meteringMode": "A String", # The metering mode used to create the photo. - "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation. - "sensor": "A String", # The type of sensor used to create the photo. - "subjectDistance": 42, # The distance to the subject of the photo, in meters. - "whiteBalance": "A String", # The white balance mode used to create the photo. - "width": 42, # The width of the image in pixels. - }, - "indexableText": { # Indexable text attributes for the file (can only be written). For more information, see Manage file metadata. + "maxApertureValue": 3.14, # Output only. The smallest f-number of the lens at the focal length used to create the photo (APEX value). + "meteringMode": "A String", # Output only. The metering mode used to create the photo. + "rotation": 42, # Output only. The number of clockwise 90 degree rotations applied from the image's original orientation. + "sensor": "A String", # Output only. The type of sensor used to create the photo. + "subjectDistance": 42, # Output only. The distance to the subject of the photo, in meters. + "whiteBalance": "A String", # Output only. The white balance mode used to create the photo. + "width": 42, # Output only. The width of the image in pixels. + }, + "indexableText": { # Indexable text attributes for the file (can only be written) "text": "A String", # The text to be indexed for this file. }, - "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. - "kind": "drive#file", # The type of file. This is always drive#file. - "labelInfo": { # An overview of the labels on the file. - "labels": [ # The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned. - { # Representation of a label and its fields. - "fields": { # A map of the label's fields keyed by the field ID. - "a_key": { # Representation of a label field. + "isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app. + "kind": "drive#file", # Output only. The type of file. This is always `drive#file`. + "labelInfo": { # Output only. An overview of the labels on the file. + "labels": [ # 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. + { # Representation of a label and label fields. + "fields": { # A map of the fields on the label, keyed by the field's ID. + "a_key": { # Representation of field, which is a typed key-value pair. "dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD. "A String", ], - "id": "A String", # The identifier of this field. - "integer": [ # Only present if valueType is integer. + "id": "A String", # The identifier of this label field. + "integer": [ # Only present if `valueType` is `integer`. "A String", ], - "kind": "drive#labelField", # This is always drive#labelField. - "selection": [ # Only present if valueType is selection. + "kind": "drive#labelField", # This is always `drive#labelField`. + "selection": [ # Only present if `valueType` is `selection` "A String", ], - "text": [ # Only present if valueType is text. + "text": [ # Only present if `valueType` is `text`. "A String", ], - "user": [ # Only present if valueType is user. + "user": [ # Only present if `valueType` is `user`. { # Information about a Drive user. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, ], - "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: - # - dateString - # - integer - # - selection - # - text - # - user + "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: * `dateString` * `integer` * `selection` * `text` * `user` }, }, "id": "A String", # The ID of the label. - "kind": "drive#label", # This is always drive#label + "kind": "drive#label", # This is always `drive#label` "revisionId": "A String", # The revision ID of the label. }, ], }, "labels": { # A group of labels for the file. - "hidden": True or False, # Deprecated. - "modified": True or False, # Whether the file has been modified by this user. - "restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead. + "hidden": True or False, # Output only. Deprecated. + "modified": True or False, # Output only. Whether the file has been modified by this user. + "restricted": True or False, # Output only. Deprecated: Use `copyRequiresWriterPermission` instead. "starred": True or False, # Whether this file is starred by the user. - "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may 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. + "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files. "viewed": True or False, # Whether this file has been viewed by this user. }, - "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "lastModifyingUserName": "A String", # Name of the last user to modify this file. + "lastModifyingUserName": "A String", # Output only. Name of the last user to modify this file. "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp). "linkShareMetadata": { # Contains details about the link URLs that clients are using to refer to this item. - "securityUpdateEligible": True or False, # Whether the file is eligible for security update. - "securityUpdateEnabled": True or False, # Whether the security update is enabled for this file. + "securityUpdateEligible": True or False, # Output only. Whether the file is eligible for security update. + "securityUpdateEnabled": True or False, # Output only. Whether the security update is enabled for this file. }, "markedViewedByMeDate": "A String", # Deprecated. - "md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. + "md5Checksum": "A String", # Output only. An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. "mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type. "modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date. "modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set. - "openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used. + "openWithLinks": { # Output only. A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used. "a_key": "A String", }, - "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Google Drive. - "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives. - "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives. + "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the `title` field. This is only available for files with binary content in Google Drive. + "ownedByMe": True or False, # Output only. Whether the file is owned by the current user. Not populated for items in shared drives. + "ownerNames": [ # Output only. Name(s) of the owner(s) of this file. Not populated for items in shared drives. "A String", ], - "owners": [ # 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. + "owners": [ # 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. { # Information about a Drive user. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, ], - "parents": [ # Collection of parent folders which contain this file. - # If not specified as part of an insert 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 can also use the addParents and removeParents parameters to modify the parents list. + "parents": [ # Collection of parent folders which contain this file. If not specified as part of an insert 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 can also use the `addParents` and `removeParents` parameters to modify the parents list. { # A reference to a file's parent. "id": "A String", # The ID of the parent. - "isRoot": True or False, # Whether or not the parent is the root folder. - "kind": "drive#parentReference", # This is always drive#parentReference. - "parentLink": "A String", # A link to the parent. - "selfLink": "A String", # A link back to this reference. + "isRoot": True or False, # Output only. Whether or not the parent is the root folder. + "kind": "drive#parentReference", # Output only. This is always `drive#parentReference`. + "parentLink": "A String", # Output only. A link to the parent. + "selfLink": "A String", # Output only. A link back to this reference. }, ], - "permissionIds": [ # List of permission IDs for users with access to this file. + "permissionIds": [ # Output only. List of permission IDs for users with access to this file. "A String", ], - "permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives. + "permissions": [ # Output only. The list of permissions for users with access to this file. Not populated for items in shared drives. { # A permission for a file. - "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. + "additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future. "A String", ], - "authKey": "A String", # Deprecated. - "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. - "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain. - "emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group. - "etag": "A String", # The ETag of the permission. - "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - # - They cannot be set on shared drive items - # - They can only be set on user and group permissions - # - The date must be in the future - # - The date cannot be more than a year in the future - "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "kind": "drive#permission", # This is always drive#permission. - "name": "A String", # The name for this permission. - "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive. - "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "authKey": "A String", # Output only. Deprecated. + "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. + "domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`. + "emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`. + "etag": "A String", # Output only. The ETag of the permission. + "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests + "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "kind": "drive#permission", # Output only. This is always `drive#permission`. + "name": "A String", # Output only. The name for this permission. + "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. + "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. { - "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. + "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. - "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: - # - file - # - member - "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: - # - organizer - # - fileOrganizer - # - writer - # - reader + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` + "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, ], - "photoLink": "A String", # A link to the profile photo, if available. - "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: - # - owner - # - organizer - # - fileOrganizer - # - writer - # - reader - "selfLink": "A String", # A link back to this permission. - "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. + "photoLink": "A String", # Output only. A link to the profile photo, if available. + "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader` + "selfLink": "A String", # Output only. A link back to this permission. + "teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead. { - "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. + "additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead. "A String", ], - "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. - "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. - "role": "A String", # Deprecated - use permissionDetails/role instead. - "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. + "inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead. + "inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead. + "role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead. + "teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead. }, ], - "type": "A String", # The account type. Allowed values are: - # - user - # - group - # - domain - # - anyone - "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value. + "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` + "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. "withLink": True or False, # Whether the link is required for this permission. }, ], "properties": [ # The list of properties. - { # A key-value pair attached to a file that is either public or private to an application. - # The following limits apply to file properties: - # - Maximum of 100 properties total per file - # - Maximum of 30 private properties per app - # - Maximum of 30 public properties - # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property. - "etag": "A String", # ETag of the property. + { # A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property + "etag": "A String", # Output only. ETag of the property. "key": "A String", # The key of this property. - "kind": "drive#property", # This is always drive#property. - "selfLink": "A String", # The link back to this property. + "kind": "drive#property", # Output only. This is always `drive#property`. + "selfLink": "A String", # Output only. The link back to this property. "value": "A String", # The value of this property. - "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE). Private 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. + "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. Private 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. }, ], - "quotaBytesUsed": "A String", # The number of quota bytes used by this file. - "resourceKey": "A String", # A key needed to access the item via a shared link. - "selfLink": "A String", # A link back to this file. - "sha1Checksum": "A String", # The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "sha256Checksum": "A String", # The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "shareable": True or False, # Deprecated: use capabilities/canShare. - "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives. + "quotaBytesUsed": "A String", # Output only. The number of quota bytes used by this file. + "resourceKey": "A String", # Output only. A key needed to access the item via a shared link. + "selfLink": "A String", # Output only. A link back to this file. + "sha1Checksum": "A String", # 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 is not populated for Docs Editors or shortcut files. + "sha256Checksum": "A String", # 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 is not populated for Docs Editors or shortcut files. + "shareable": True or False, # Output only. Deprecated: Use `capabilities/canShare` instead. + "shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives. "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp). - "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "sharingUser": { # Information about a Drive user. # Output only. User that shared the item with the current user, if available. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut. + "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. "targetId": "A String", # The ID of the file that this shortcut points to. - "targetMimeType": "A String", # 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": "A String", # The ResourceKey for the target file. + "targetMimeType": "A String", # 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": "A String", # Output only. The ResourceKey for the target file. }, - "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'. + "spaces": [ # Output only. The list of spaces which contain the file. Supported values are `drive`, `appDataFolder` and `photos`. "A String", ], - "teamDriveId": "A String", # Deprecated - use driveId instead. + "teamDriveId": "A String", # Output only. Deprecated: Use `driveId` instead. "thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated. "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5. "mimeType": "A String", # The MIME type of the thumbnail. }, - "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. 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": "A String", # The thumbnail version for use in thumbnail cache invalidation. + "thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content. + "thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation. "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant. "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives. - "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "trashingUser": { # Information about a Drive user. # Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file. - "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. + "userPermission": { # A permission for a file. # Output only. The permissions for the authenticated user on this file. + "additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future. "A String", ], - "authKey": "A String", # Deprecated. - "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. - "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain. - "emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group. - "etag": "A String", # The ETag of the permission. - "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - # - They cannot be set on shared drive items - # - They can only be set on user and group permissions - # - The date must be in the future - # - The date cannot be more than a year in the future - "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "kind": "drive#permission", # This is always drive#permission. - "name": "A String", # The name for this permission. - "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive. - "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "authKey": "A String", # Output only. Deprecated. + "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. + "domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`. + "emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`. + "etag": "A String", # Output only. The ETag of the permission. + "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests + "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "kind": "drive#permission", # Output only. This is always `drive#permission`. + "name": "A String", # Output only. The name for this permission. + "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. + "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. { - "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. + "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. - "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: - # - file - # - member - "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: - # - organizer - # - fileOrganizer - # - writer - # - reader + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` + "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, ], - "photoLink": "A String", # A link to the profile photo, if available. - "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: - # - owner - # - organizer - # - fileOrganizer - # - writer - # - reader - "selfLink": "A String", # A link back to this permission. - "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. + "photoLink": "A String", # Output only. A link to the profile photo, if available. + "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader` + "selfLink": "A String", # Output only. A link back to this permission. + "teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead. { - "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. + "additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead. "A String", ], - "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. - "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. - "role": "A String", # Deprecated - use permissionDetails/role instead. - "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. + "inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead. + "inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead. + "role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead. + "teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead. }, ], - "type": "A String", # The account type. Allowed values are: - # - user - # - group - # - domain - # - anyone - "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value. + "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` + "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. "withLink": True or False, # Whether the link is required for this permission. }, - "version": "A String", # 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 requesting user. - "videoMediaMetadata": { # Metadata about video media. This will only be present for video types. - "durationMillis": "A String", # The duration of the video in milliseconds. - "height": 42, # The height of the video in pixels. - "width": 42, # The width of the video in pixels. + "version": "A String", # 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 requesting user. + "videoMediaMetadata": { # Output only. Metadata about video media. This will only be present for video types. + "durationMillis": "A String", # Output only. The duration of the video in milliseconds. + "height": 42, # Output only. The height of the video in pixels. + "width": 42, # Output only. The width of the video in pixels. }, - "webContentLink": "A String", # A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials. - "webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting. + "webContentLink": "A String", # Output only. A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials. + "webViewLink": "A String", # Output only. A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting. "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives. }
delete(fileId, enforceSingleParent=None, supportsAllDrives=None, supportsTeamDrives=None)
+ delete(fileId, enforceSingleParent=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None)
Permanently deletes a file by ID. Skips the trash. The currently authenticated user must own the file or be an organizer on the parent for shared drive files. Args: fileId: string, The ID of the file to delete. (required) - enforceSingleParent: boolean, 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. + enforceSingleParent: boolean, Deprecated: If an item is not in a shared drive and its last parent is deleted but the item itself is not, the item is placed under its owner's root. supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. - supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead. + supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format
emptyTrash(driveId=None, enforceSingleParent=None)
- Permanently deletes all trashed files of a user or shared drive. +emptyTrash(driveId=None, enforceSingleParent=None, x__xgafv=None)+Permanently deletes all of the user's trashed files. Args: driveId: string, If set, empties the trash of the provided shared drive. - enforceSingleParent: boolean, 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. + enforceSingleParent: boolean, Deprecated: If an item is not in a shared drive and its last parent is deleted but the item itself is not, the item is placed under its owner's root. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format
export(fileId, mimeType)
+ export(fileId, mimeType, x__xgafv=None)
Exports a Google Workspace document to the requested MIME type and returns exported byte content. Note that the exported content is limited to 10MB. Args: fileId: string, The ID of the file. (required) - mimeType: string, The MIME type of the format requested for this export. (required) + mimeType: string, Required. The MIME type of the format requested for this export. (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format
export_media(fileId, mimeType)
+ export_media(fileId, mimeType, x__xgafv=None)
Exports a Google Workspace document to the requested MIME type and returns exported byte content. Note that the exported content is limited to 10MB. Args: fileId: string, The ID of the file. (required) - mimeType: string, The MIME type of the format requested for this export. (required) + mimeType: string, Required. The MIME type of the format requested for this export. (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format
generateIds(maxResults=None, space=None, type=None)
+ generateIds(maxResults=None, space=None, type=None, x__xgafv=None)
Generates a set of file IDs which can be provided in insert or copy requests. Args: maxResults: integer, Maximum number of IDs to return. - space: string, The space in which the IDs can be used to create new files. Supported values are 'drive' and 'appDataFolder'. (Default: 'drive') - type: string, The type of items which the IDs can be used for. Supported values are 'files' and 'shortcuts'. Note that 'shortcuts' are only supported in the drive 'space'. (Default: 'files') + space: string, The space in which the IDs can be used to create new files. Supported values are `drive` and `appDataFolder`. (Default: `drive`) + type: string, The type of items which the IDs can be used for. Supported values are `files` and `shortcuts`. Note that `shortcuts` are only supported in the `drive` `space`. (Default: `files`) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format Returns: An object of the form: @@ -1081,474 +1004,433 @@Method Details
"ids": [ # The IDs generated for the requesting user in the specified space. "A String", ], - "kind": "drive#generatedIds", # This is always drive#generatedIds + "kind": "drive#generatedIds", # This is always `drive#generatedIds` "space": "A String", # The type of file that can be created with these IDs. }
get(fileId, acknowledgeAbuse=None, includeLabels=None, includePermissionsForView=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None)
- Gets a file's metadata or content by ID. +get(fileId, acknowledgeAbuse=None, includeLabels=None, includePermissionsForView=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None, x__xgafv=None)+Gets a file's metadata or content by ID. If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/drive/api/reference/rest/v2/files/export) instead. For more information, see [Download & export files](/drive/api/guides/manage-downloads). Args: fileId: string, The ID for the file in question. (required) acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. - includeLabels: string, A comma-separated list of IDs of labels to include in the labelInfo part of the response. - includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported. - projection: string, This parameter is deprecated and has no function. + includeLabels: string, A comma-separated list of IDs of labels to include in the `labelInfo` part of the response. + includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only `published` is supported. + projection: string, Deprecated: This parameter has no function. Allowed values - BASIC - Deprecated - FULL - Deprecated + BASIC - Deprecated. + FULL - Deprecated. revisionId: string, Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified. supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. - supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead. - updateViewedDate: boolean, Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body. + supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead. + updateViewedDate: boolean, Deprecated: Use `files.update` with `modifiedDateBehavior=noChange, updateViewedDate=true` and an empty request body. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format Returns: An object of the form: { # The metadata for a file. - "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer. - "appDataContents": True or False, # Whether this file is in the Application Data folder. - "canComment": True or False, # Deprecated: use capabilities/canComment. - "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions. - "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. - "canAcceptOwnership": True or False, # Whether the current user is the pending owner of the file. Not populated for shared drive files. - "canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder. - "canAddFolderFromAnotherDrive": True or False, # 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 is not a folder. Only populated for items in shared drives. - "canAddMyDriveParent": True or False, # 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": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file. - "canChangeRestrictedDownload": True or False, # Deprecated - "canChangeSecurityUpdateEnabled": True or False, # Whether the current user can change the securityUpdateEnabled field on link share metadata. - "canComment": True or False, # Whether the current user can comment on this file. - "canCopy": True or False, # 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 is not a folder. - "canDelete": True or False, # Whether the current user can delete this file. - "canDeleteChildren": True or False, # Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. - "canDownload": True or False, # Whether the current user can download this file. - "canEdit": True or False, # 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. - "canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder. - "canModifyContent": True or False, # Whether the current user can modify the content of this file. - "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file. - "canModifyLabels": True or False, # Whether the current user can modify the labels on this file. - "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. - "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. - "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not 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. - "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead. - "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. - "canMoveItemOutOfDrive": True or False, # 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 is being added. - "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. - "canMoveItemWithinDrive": True or False, # 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 is being added and the parent that is being removed. - "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. - "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. - "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. - "canReadLabels": True or False, # Whether the current user can read the labels on this file. - "canReadRevisions": True or False, # 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 isn't a folder, can be read. - "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. - "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. - "canRemoveMyDriveParent": True or False, # 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": True or False, # Whether the current user can rename this file. - "canShare": True or False, # Whether the current user can modify the sharing settings for this file. - "canTrash": True or False, # Whether the current user can move this file to trash. - "canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. - "canUntrash": True or False, # Whether the current user can restore this file from trash. + "alternateLink": "A String", # Output only. A link for opening the file in a relevant Google editor or viewer. + "appDataContents": True or False, # Output only. Whether this file is in the Application Data folder. + "canComment": True or False, # Output only. Deprecated: Use `capabilities/canComment` instead. + "canReadRevisions": True or False, # Output only. Deprecated: Use `capabilities/canReadRevisions` instead. + "capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. + "canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files. + "canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always false when the item is not a folder. + "canAddFolderFromAnotherDrive": True or False, # 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 is not a folder. Only populated for items in shared drives. + "canAddMyDriveParent": True or False, # 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. + "canChangeCopyRequiresWriterPermission": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file. + "canChangeRestrictedDownload": True or False, # Output only. Deprecated. + "canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata. + "canComment": True or False, # Output only. Whether the current user can comment on this file. + "canCopy": True or False, # 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 itself if it is not a folder. + "canDelete": True or False, # Output only. Whether the current user can delete this file. + "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDownload": True or False, # Output only. Whether the current user can download this file. + "canEdit": True or False, # 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`. + "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. + "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. + "canModifyContentRestriction": True or False, # Output only. Whether the current user can modify restrictions on content of this file. + "canModifyLabels": True or False, # Output only. Whether the current user can modify the labels on the file. + "canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. + "canMoveChildrenOutOfTeamDrive": True or False, # Output only. Deprecated: Use `canMoveChildrenOutOfDrive` instead. + "canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is false when the item is not 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. + "canMoveChildrenWithinTeamDrive": True or False, # Output only. Deprecated: Use `canMoveChildrenWithinDrive` instead. + "canMoveItemIntoTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemOutOfDrive` instead. + "canMoveItemOutOfDrive": True or False, # 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 is being added. + "canMoveItemOutOfTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemOutOfDrive` instead. + "canMoveItemWithinDrive": True or False, # 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 is being added and the parent that is being removed. + "canMoveItemWithinTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemWithinDrive` instead. + "canMoveTeamDriveItem": True or False, # Output only. Deprecated: Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead. + "canReadDrive": True or False, # Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. + "canReadLabels": True or False, # Output only. Whether the current user can read the labels on the file. + "canReadRevisions": True or False, # 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 itself if it is not a folder, can be read. + "canReadTeamDrive": True or False, # Output only. Deprecated: Use `canReadDrive` instead. + "canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead. + "canRemoveMyDriveParent": True or False, # 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. + "canRename": True or False, # Output only. Whether the current user can rename this file. + "canShare": True or False, # Output only. Whether the current user can modify the sharing settings for this file. + "canTrash": True or False, # Output only. Whether the current user can move this file to trash. + "canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists. { # A restriction for accessing the content of the file. "readOnly": True or False, # 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": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true. - "restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`. + "restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly` is true. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, "restrictionDate": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true. - "type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction. + "type": "A String", # Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`. }, ], "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters. - "copyable": True or False, # Deprecated: use capabilities/canCopy. + "copyable": True or False, # Output only. Deprecated: Use `capabilities/canCopy` instead. "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp). - "defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used. + "defaultOpenWithLink": "A String", # Output only. A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used. "description": "A String", # A short description of the file. - "downloadUrl": "A String", # Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives. - "editable": True or False, # Deprecated: use capabilities/canEdit. - "embedLink": "A String", # A link for embedding the file. - "etag": "A String", # ETag of the file. - "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. - "exportLinks": { # Links for exporting Docs Editors files to specific formats. - "a_key": "A String", # A mapping from export format to URL - }, - "fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "fileSize": "A String", # 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 is not populated for shortcuts or folders. + "downloadUrl": "A String", # Output only. Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. + "driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives. + "editable": True or False, # Output only. Deprecated: Use `capabilities/canEdit` instead. + "embedLink": "A String", # Output only. A link for embedding the file. + "etag": "A String", # Output only. ETag of the file. + "explicitlyTrashed": True or False, # Output only. Whether this file has been explicitly trashed, as opposed to recursively trashed. + "exportLinks": { # Output only. Links for exporting Docs Editors files to specific formats. + "a_key": "A String", + }, + "fileExtension": "A String", # Output only. The final component of `fullFileExtension` with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "fileSize": "A String", # Output only. Size in bytes of blobs and first party editor files. Won't be populated for files that have no size, like shortcuts and folders. "folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder or a shortcut to a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette. - "fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives. - "hasThumbnail": True or False, # 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": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "iconLink": "A String", # A link to the file's icon. + "fullFileExtension": "A String", # Output only. The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "hasAugmentedPermissions": True or False, # Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives. + "hasThumbnail": True or False, # Output only. 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": "A String", # Output only. The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "iconLink": "A String", # Output only. A link to the file's icon. "id": "A String", # The ID of the file. - "imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content. - "aperture": 3.14, # The aperture used to create the photo (f-number). - "cameraMake": "A String", # The make of the camera used to create the photo. - "cameraModel": "A String", # The model of the camera used to create the photo. - "colorSpace": "A String", # The color space of the photo. - "date": "A String", # The date and time the photo was taken (EXIF format timestamp). - "exposureBias": 3.14, # The exposure bias of the photo (APEX value). - "exposureMode": "A String", # The exposure mode used to create the photo. - "exposureTime": 3.14, # The length of the exposure, in seconds. - "flashUsed": True or False, # Whether a flash was used to create the photo. - "focalLength": 3.14, # The focal length used to create the photo, in millimeters. - "height": 42, # The height of the image in pixels. - "isoSpeed": 42, # The ISO speed used to create the photo. - "lens": "A String", # The lens used to create the photo. - "location": { # Geographic location information stored in the image. - "altitude": 3.14, # The altitude stored in the image. - "latitude": 3.14, # The latitude stored in the image. - "longitude": 3.14, # The longitude stored in the image. + "imageMediaMetadata": { # Output only. Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content. + "aperture": 3.14, # Output only. The aperture used to create the photo (f-number). + "cameraMake": "A String", # Output only. The make of the camera used to create the photo. + "cameraModel": "A String", # Output only. The model of the camera used to create the photo. + "colorSpace": "A String", # Output only. The color space of the photo. + "date": "A String", # Output only. The date and time the photo was taken (EXIF format timestamp). + "exposureBias": 3.14, # Output only. The exposure bias of the photo (APEX value). + "exposureMode": "A String", # Output only. The exposure mode used to create the photo. + "exposureTime": 3.14, # Output only. The length of the exposure, in seconds. + "flashUsed": True or False, # Output only. Whether a flash was used to create the photo. + "focalLength": 3.14, # Output only. The focal length used to create the photo, in millimeters. + "height": 42, # Output only. The height of the image in pixels. + "isoSpeed": 42, # Output only. The ISO speed used to create the photo. + "lens": "A String", # Output only. The lens used to create the photo. + "location": { # Output only. Geographic location information stored in the image. + "altitude": 3.14, # Output only. The altitude stored in the image. + "latitude": 3.14, # Output only. The latitude stored in the image. + "longitude": 3.14, # Output only. The longitude stored in the image. }, - "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value). - "meteringMode": "A String", # The metering mode used to create the photo. - "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation. - "sensor": "A String", # The type of sensor used to create the photo. - "subjectDistance": 42, # The distance to the subject of the photo, in meters. - "whiteBalance": "A String", # The white balance mode used to create the photo. - "width": 42, # The width of the image in pixels. - }, - "indexableText": { # Indexable text attributes for the file (can only be written). For more information, see Manage file metadata. + "maxApertureValue": 3.14, # Output only. The smallest f-number of the lens at the focal length used to create the photo (APEX value). + "meteringMode": "A String", # Output only. The metering mode used to create the photo. + "rotation": 42, # Output only. The number of clockwise 90 degree rotations applied from the image's original orientation. + "sensor": "A String", # Output only. The type of sensor used to create the photo. + "subjectDistance": 42, # Output only. The distance to the subject of the photo, in meters. + "whiteBalance": "A String", # Output only. The white balance mode used to create the photo. + "width": 42, # Output only. The width of the image in pixels. + }, + "indexableText": { # Indexable text attributes for the file (can only be written) "text": "A String", # The text to be indexed for this file. }, - "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. - "kind": "drive#file", # The type of file. This is always drive#file. - "labelInfo": { # An overview of the labels on the file. - "labels": [ # The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned. - { # Representation of a label and its fields. - "fields": { # A map of the label's fields keyed by the field ID. - "a_key": { # Representation of a label field. + "isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app. + "kind": "drive#file", # Output only. The type of file. This is always `drive#file`. + "labelInfo": { # Output only. An overview of the labels on the file. + "labels": [ # 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. + { # Representation of a label and label fields. + "fields": { # A map of the fields on the label, keyed by the field's ID. + "a_key": { # Representation of field, which is a typed key-value pair. "dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD. "A String", ], - "id": "A String", # The identifier of this field. - "integer": [ # Only present if valueType is integer. + "id": "A String", # The identifier of this label field. + "integer": [ # Only present if `valueType` is `integer`. "A String", ], - "kind": "drive#labelField", # This is always drive#labelField. - "selection": [ # Only present if valueType is selection. + "kind": "drive#labelField", # This is always `drive#labelField`. + "selection": [ # Only present if `valueType` is `selection` "A String", ], - "text": [ # Only present if valueType is text. + "text": [ # Only present if `valueType` is `text`. "A String", ], - "user": [ # Only present if valueType is user. + "user": [ # Only present if `valueType` is `user`. { # Information about a Drive user. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, ], - "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: - # - dateString - # - integer - # - selection - # - text - # - user + "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: * `dateString` * `integer` * `selection` * `text` * `user` }, }, "id": "A String", # The ID of the label. - "kind": "drive#label", # This is always drive#label + "kind": "drive#label", # This is always `drive#label` "revisionId": "A String", # The revision ID of the label. }, ], }, "labels": { # A group of labels for the file. - "hidden": True or False, # Deprecated. - "modified": True or False, # Whether the file has been modified by this user. - "restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead. + "hidden": True or False, # Output only. Deprecated. + "modified": True or False, # Output only. Whether the file has been modified by this user. + "restricted": True or False, # Output only. Deprecated: Use `copyRequiresWriterPermission` instead. "starred": True or False, # Whether this file is starred by the user. - "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may 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. + "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files. "viewed": True or False, # Whether this file has been viewed by this user. }, - "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "lastModifyingUserName": "A String", # Name of the last user to modify this file. + "lastModifyingUserName": "A String", # Output only. Name of the last user to modify this file. "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp). "linkShareMetadata": { # Contains details about the link URLs that clients are using to refer to this item. - "securityUpdateEligible": True or False, # Whether the file is eligible for security update. - "securityUpdateEnabled": True or False, # Whether the security update is enabled for this file. + "securityUpdateEligible": True or False, # Output only. Whether the file is eligible for security update. + "securityUpdateEnabled": True or False, # Output only. Whether the security update is enabled for this file. }, "markedViewedByMeDate": "A String", # Deprecated. - "md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. + "md5Checksum": "A String", # Output only. An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. "mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type. "modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date. "modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set. - "openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used. + "openWithLinks": { # Output only. A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used. "a_key": "A String", }, - "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Google Drive. - "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives. - "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives. + "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the `title` field. This is only available for files with binary content in Google Drive. + "ownedByMe": True or False, # Output only. Whether the file is owned by the current user. Not populated for items in shared drives. + "ownerNames": [ # Output only. Name(s) of the owner(s) of this file. Not populated for items in shared drives. "A String", ], - "owners": [ # 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. + "owners": [ # 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. { # Information about a Drive user. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, ], - "parents": [ # Collection of parent folders which contain this file. - # If not specified as part of an insert 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 can also use the addParents and removeParents parameters to modify the parents list. + "parents": [ # Collection of parent folders which contain this file. If not specified as part of an insert 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 can also use the `addParents` and `removeParents` parameters to modify the parents list. { # A reference to a file's parent. "id": "A String", # The ID of the parent. - "isRoot": True or False, # Whether or not the parent is the root folder. - "kind": "drive#parentReference", # This is always drive#parentReference. - "parentLink": "A String", # A link to the parent. - "selfLink": "A String", # A link back to this reference. + "isRoot": True or False, # Output only. Whether or not the parent is the root folder. + "kind": "drive#parentReference", # Output only. This is always `drive#parentReference`. + "parentLink": "A String", # Output only. A link to the parent. + "selfLink": "A String", # Output only. A link back to this reference. }, ], - "permissionIds": [ # List of permission IDs for users with access to this file. + "permissionIds": [ # Output only. List of permission IDs for users with access to this file. "A String", ], - "permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives. + "permissions": [ # Output only. The list of permissions for users with access to this file. Not populated for items in shared drives. { # A permission for a file. - "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. + "additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future. "A String", ], - "authKey": "A String", # Deprecated. - "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. - "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain. - "emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group. - "etag": "A String", # The ETag of the permission. - "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - # - They cannot be set on shared drive items - # - They can only be set on user and group permissions - # - The date must be in the future - # - The date cannot be more than a year in the future - "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "kind": "drive#permission", # This is always drive#permission. - "name": "A String", # The name for this permission. - "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive. - "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "authKey": "A String", # Output only. Deprecated. + "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. + "domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`. + "emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`. + "etag": "A String", # Output only. The ETag of the permission. + "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests + "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "kind": "drive#permission", # Output only. This is always `drive#permission`. + "name": "A String", # Output only. The name for this permission. + "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. + "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. { - "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. + "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. - "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: - # - file - # - member - "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: - # - organizer - # - fileOrganizer - # - writer - # - reader + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` + "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, ], - "photoLink": "A String", # A link to the profile photo, if available. - "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: - # - owner - # - organizer - # - fileOrganizer - # - writer - # - reader - "selfLink": "A String", # A link back to this permission. - "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. + "photoLink": "A String", # Output only. A link to the profile photo, if available. + "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader` + "selfLink": "A String", # Output only. A link back to this permission. + "teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead. { - "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. + "additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead. "A String", ], - "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. - "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. - "role": "A String", # Deprecated - use permissionDetails/role instead. - "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. + "inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead. + "inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead. + "role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead. + "teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead. }, ], - "type": "A String", # The account type. Allowed values are: - # - user - # - group - # - domain - # - anyone - "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value. + "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` + "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. "withLink": True or False, # Whether the link is required for this permission. }, ], "properties": [ # The list of properties. - { # A key-value pair attached to a file that is either public or private to an application. - # The following limits apply to file properties: - # - Maximum of 100 properties total per file - # - Maximum of 30 private properties per app - # - Maximum of 30 public properties - # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property. - "etag": "A String", # ETag of the property. + { # A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property + "etag": "A String", # Output only. ETag of the property. "key": "A String", # The key of this property. - "kind": "drive#property", # This is always drive#property. - "selfLink": "A String", # The link back to this property. + "kind": "drive#property", # Output only. This is always `drive#property`. + "selfLink": "A String", # Output only. The link back to this property. "value": "A String", # The value of this property. - "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE). Private 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. + "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. Private 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. }, ], - "quotaBytesUsed": "A String", # The number of quota bytes used by this file. - "resourceKey": "A String", # A key needed to access the item via a shared link. - "selfLink": "A String", # A link back to this file. - "sha1Checksum": "A String", # The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "sha256Checksum": "A String", # The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "shareable": True or False, # Deprecated: use capabilities/canShare. - "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives. + "quotaBytesUsed": "A String", # Output only. The number of quota bytes used by this file. + "resourceKey": "A String", # Output only. A key needed to access the item via a shared link. + "selfLink": "A String", # Output only. A link back to this file. + "sha1Checksum": "A String", # 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 is not populated for Docs Editors or shortcut files. + "sha256Checksum": "A String", # 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 is not populated for Docs Editors or shortcut files. + "shareable": True or False, # Output only. Deprecated: Use `capabilities/canShare` instead. + "shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives. "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp). - "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "sharingUser": { # Information about a Drive user. # Output only. User that shared the item with the current user, if available. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut. + "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. "targetId": "A String", # The ID of the file that this shortcut points to. - "targetMimeType": "A String", # 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": "A String", # The ResourceKey for the target file. + "targetMimeType": "A String", # 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": "A String", # Output only. The ResourceKey for the target file. }, - "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'. + "spaces": [ # Output only. The list of spaces which contain the file. Supported values are `drive`, `appDataFolder` and `photos`. "A String", ], - "teamDriveId": "A String", # Deprecated - use driveId instead. + "teamDriveId": "A String", # Output only. Deprecated: Use `driveId` instead. "thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated. "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5. "mimeType": "A String", # The MIME type of the thumbnail. }, - "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. 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": "A String", # The thumbnail version for use in thumbnail cache invalidation. + "thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content. + "thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation. "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant. "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives. - "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "trashingUser": { # Information about a Drive user. # Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file. - "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. + "userPermission": { # A permission for a file. # Output only. The permissions for the authenticated user on this file. + "additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future. "A String", ], - "authKey": "A String", # Deprecated. - "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. - "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain. - "emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group. - "etag": "A String", # The ETag of the permission. - "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - # - They cannot be set on shared drive items - # - They can only be set on user and group permissions - # - The date must be in the future - # - The date cannot be more than a year in the future - "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "kind": "drive#permission", # This is always drive#permission. - "name": "A String", # The name for this permission. - "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive. - "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "authKey": "A String", # Output only. Deprecated. + "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. + "domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`. + "emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`. + "etag": "A String", # Output only. The ETag of the permission. + "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests + "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "kind": "drive#permission", # Output only. This is always `drive#permission`. + "name": "A String", # Output only. The name for this permission. + "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. + "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. { - "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. + "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. - "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: - # - file - # - member - "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: - # - organizer - # - fileOrganizer - # - writer - # - reader + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` + "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, ], - "photoLink": "A String", # A link to the profile photo, if available. - "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: - # - owner - # - organizer - # - fileOrganizer - # - writer - # - reader - "selfLink": "A String", # A link back to this permission. - "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. + "photoLink": "A String", # Output only. A link to the profile photo, if available. + "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader` + "selfLink": "A String", # Output only. A link back to this permission. + "teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead. { - "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. + "additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead. "A String", ], - "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. - "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. - "role": "A String", # Deprecated - use permissionDetails/role instead. - "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. + "inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead. + "inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead. + "role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead. + "teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead. }, ], - "type": "A String", # The account type. Allowed values are: - # - user - # - group - # - domain - # - anyone - "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value. + "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` + "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. "withLink": True or False, # Whether the link is required for this permission. }, - "version": "A String", # 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 requesting user. - "videoMediaMetadata": { # Metadata about video media. This will only be present for video types. - "durationMillis": "A String", # The duration of the video in milliseconds. - "height": 42, # The height of the video in pixels. - "width": 42, # The width of the video in pixels. + "version": "A String", # 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 requesting user. + "videoMediaMetadata": { # Output only. Metadata about video media. This will only be present for video types. + "durationMillis": "A String", # Output only. The duration of the video in milliseconds. + "height": 42, # Output only. The height of the video in pixels. + "width": 42, # Output only. The width of the video in pixels. }, - "webContentLink": "A String", # A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials. - "webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting. + "webContentLink": "A String", # Output only. A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials. + "webViewLink": "A String", # Output only. A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting. "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives. }
get_media(fileId, acknowledgeAbuse=None, includeLabels=None, includePermissionsForView=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None)
- Gets a file's metadata or content by ID. +get_media(fileId, acknowledgeAbuse=None, includeLabels=None, includePermissionsForView=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None, x__xgafv=None)+Gets a file's metadata or content by ID. If you provide the URL parameter `alt=media`, then the response includes the file contents in the response body. Downloading content with `alt=media` only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use [`files.export`](/drive/api/reference/rest/v2/files/export) instead. For more information, see [Download & export files](/drive/api/guides/manage-downloads). Args: fileId: string, The ID for the file in question. (required) acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. - includeLabels: string, A comma-separated list of IDs of labels to include in the labelInfo part of the response. - includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported. - projection: string, This parameter is deprecated and has no function. + includeLabels: string, A comma-separated list of IDs of labels to include in the `labelInfo` part of the response. + includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only `published` is supported. + projection: string, Deprecated: This parameter has no function. Allowed values - BASIC - Deprecated - FULL - Deprecated + BASIC - Deprecated. + FULL - Deprecated. revisionId: string, Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified. supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. - supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead. - updateViewedDate: boolean, Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body. + supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead. + updateViewedDate: boolean, Deprecated: Use `files.update` with `modifiedDateBehavior=noChange, updateViewedDate=true` and an empty request body. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format Returns: The media object as a string. @@ -1557,448 +1439,399 @@Method Details
insert(body=None, convert=None, enforceSingleParent=None, includeLabels=None, includePermissionsForView=None, media_body=None, media_mime_type=None, ocr=None, ocrLanguage=None, pinned=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, useContentAsIndexableText=None, visibility=None)
- Insert a new file. +insert(body=None, convert=None, enforceSingleParent=None, includeLabels=None, includePermissionsForView=None, media_body=None, media_mime_type=None, ocr=None, ocrLanguage=None, pinned=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, useContentAsIndexableText=None, visibility=None, x__xgafv=None)+Inserts a new file. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/drive/api/guides/manage-uploads). Apps creating shortcuts with `files.insert` must specify the MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file extension in the `title` property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `"title": "cat.jpg"` in the metadata. Subsequent `GET` requests include the read-only `fileExtension` property populated with the extension originally specified in the `title` property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with extension) based on the title. In cases where the extension is missing, Drive attempts to determine the extension based on the file's MIME type. Args: body: object, The request body. The object takes the form of: { # The metadata for a file. - "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer. - "appDataContents": True or False, # Whether this file is in the Application Data folder. - "canComment": True or False, # Deprecated: use capabilities/canComment. - "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions. - "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. - "canAcceptOwnership": True or False, # Whether the current user is the pending owner of the file. Not populated for shared drive files. - "canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder. - "canAddFolderFromAnotherDrive": True or False, # 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 is not a folder. Only populated for items in shared drives. - "canAddMyDriveParent": True or False, # 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": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file. - "canChangeRestrictedDownload": True or False, # Deprecated - "canChangeSecurityUpdateEnabled": True or False, # Whether the current user can change the securityUpdateEnabled field on link share metadata. - "canComment": True or False, # Whether the current user can comment on this file. - "canCopy": True or False, # 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 is not a folder. - "canDelete": True or False, # Whether the current user can delete this file. - "canDeleteChildren": True or False, # Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. - "canDownload": True or False, # Whether the current user can download this file. - "canEdit": True or False, # 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. - "canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder. - "canModifyContent": True or False, # Whether the current user can modify the content of this file. - "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file. - "canModifyLabels": True or False, # Whether the current user can modify the labels on this file. - "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. - "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. - "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not 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. - "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead. - "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. - "canMoveItemOutOfDrive": True or False, # 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 is being added. - "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. - "canMoveItemWithinDrive": True or False, # 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 is being added and the parent that is being removed. - "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. - "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. - "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. - "canReadLabels": True or False, # Whether the current user can read the labels on this file. - "canReadRevisions": True or False, # 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 isn't a folder, can be read. - "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. - "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. - "canRemoveMyDriveParent": True or False, # 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": True or False, # Whether the current user can rename this file. - "canShare": True or False, # Whether the current user can modify the sharing settings for this file. - "canTrash": True or False, # Whether the current user can move this file to trash. - "canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. - "canUntrash": True or False, # Whether the current user can restore this file from trash. + "alternateLink": "A String", # Output only. A link for opening the file in a relevant Google editor or viewer. + "appDataContents": True or False, # Output only. Whether this file is in the Application Data folder. + "canComment": True or False, # Output only. Deprecated: Use `capabilities/canComment` instead. + "canReadRevisions": True or False, # Output only. Deprecated: Use `capabilities/canReadRevisions` instead. + "capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. + "canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files. + "canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always false when the item is not a folder. + "canAddFolderFromAnotherDrive": True or False, # 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 is not a folder. Only populated for items in shared drives. + "canAddMyDriveParent": True or False, # 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. + "canChangeCopyRequiresWriterPermission": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file. + "canChangeRestrictedDownload": True or False, # Output only. Deprecated. + "canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata. + "canComment": True or False, # Output only. Whether the current user can comment on this file. + "canCopy": True or False, # 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 itself if it is not a folder. + "canDelete": True or False, # Output only. Whether the current user can delete this file. + "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDownload": True or False, # Output only. Whether the current user can download this file. + "canEdit": True or False, # 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`. + "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. + "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. + "canModifyContentRestriction": True or False, # Output only. Whether the current user can modify restrictions on content of this file. + "canModifyLabels": True or False, # Output only. Whether the current user can modify the labels on the file. + "canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. + "canMoveChildrenOutOfTeamDrive": True or False, # Output only. Deprecated: Use `canMoveChildrenOutOfDrive` instead. + "canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is false when the item is not 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. + "canMoveChildrenWithinTeamDrive": True or False, # Output only. Deprecated: Use `canMoveChildrenWithinDrive` instead. + "canMoveItemIntoTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemOutOfDrive` instead. + "canMoveItemOutOfDrive": True or False, # 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 is being added. + "canMoveItemOutOfTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemOutOfDrive` instead. + "canMoveItemWithinDrive": True or False, # 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 is being added and the parent that is being removed. + "canMoveItemWithinTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemWithinDrive` instead. + "canMoveTeamDriveItem": True or False, # Output only. Deprecated: Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead. + "canReadDrive": True or False, # Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. + "canReadLabels": True or False, # Output only. Whether the current user can read the labels on the file. + "canReadRevisions": True or False, # 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 itself if it is not a folder, can be read. + "canReadTeamDrive": True or False, # Output only. Deprecated: Use `canReadDrive` instead. + "canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead. + "canRemoveMyDriveParent": True or False, # 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. + "canRename": True or False, # Output only. Whether the current user can rename this file. + "canShare": True or False, # Output only. Whether the current user can modify the sharing settings for this file. + "canTrash": True or False, # Output only. Whether the current user can move this file to trash. + "canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists. { # A restriction for accessing the content of the file. "readOnly": True or False, # 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": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true. - "restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`. + "restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly` is true. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, "restrictionDate": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true. - "type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction. + "type": "A String", # Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`. }, ], "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters. - "copyable": True or False, # Deprecated: use capabilities/canCopy. + "copyable": True or False, # Output only. Deprecated: Use `capabilities/canCopy` instead. "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp). - "defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used. + "defaultOpenWithLink": "A String", # Output only. A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used. "description": "A String", # A short description of the file. - "downloadUrl": "A String", # Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives. - "editable": True or False, # Deprecated: use capabilities/canEdit. - "embedLink": "A String", # A link for embedding the file. - "etag": "A String", # ETag of the file. - "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. - "exportLinks": { # Links for exporting Docs Editors files to specific formats. - "a_key": "A String", # A mapping from export format to URL - }, - "fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "fileSize": "A String", # 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 is not populated for shortcuts or folders. + "downloadUrl": "A String", # Output only. Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. + "driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives. + "editable": True or False, # Output only. Deprecated: Use `capabilities/canEdit` instead. + "embedLink": "A String", # Output only. A link for embedding the file. + "etag": "A String", # Output only. ETag of the file. + "explicitlyTrashed": True or False, # Output only. Whether this file has been explicitly trashed, as opposed to recursively trashed. + "exportLinks": { # Output only. Links for exporting Docs Editors files to specific formats. + "a_key": "A String", + }, + "fileExtension": "A String", # Output only. The final component of `fullFileExtension` with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "fileSize": "A String", # Output only. Size in bytes of blobs and first party editor files. Won't be populated for files that have no size, like shortcuts and folders. "folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder or a shortcut to a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette. - "fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives. - "hasThumbnail": True or False, # 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": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "iconLink": "A String", # A link to the file's icon. + "fullFileExtension": "A String", # Output only. The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "hasAugmentedPermissions": True or False, # Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives. + "hasThumbnail": True or False, # Output only. 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": "A String", # Output only. The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "iconLink": "A String", # Output only. A link to the file's icon. "id": "A String", # The ID of the file. - "imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content. - "aperture": 3.14, # The aperture used to create the photo (f-number). - "cameraMake": "A String", # The make of the camera used to create the photo. - "cameraModel": "A String", # The model of the camera used to create the photo. - "colorSpace": "A String", # The color space of the photo. - "date": "A String", # The date and time the photo was taken (EXIF format timestamp). - "exposureBias": 3.14, # The exposure bias of the photo (APEX value). - "exposureMode": "A String", # The exposure mode used to create the photo. - "exposureTime": 3.14, # The length of the exposure, in seconds. - "flashUsed": True or False, # Whether a flash was used to create the photo. - "focalLength": 3.14, # The focal length used to create the photo, in millimeters. - "height": 42, # The height of the image in pixels. - "isoSpeed": 42, # The ISO speed used to create the photo. - "lens": "A String", # The lens used to create the photo. - "location": { # Geographic location information stored in the image. - "altitude": 3.14, # The altitude stored in the image. - "latitude": 3.14, # The latitude stored in the image. - "longitude": 3.14, # The longitude stored in the image. + "imageMediaMetadata": { # Output only. Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content. + "aperture": 3.14, # Output only. The aperture used to create the photo (f-number). + "cameraMake": "A String", # Output only. The make of the camera used to create the photo. + "cameraModel": "A String", # Output only. The model of the camera used to create the photo. + "colorSpace": "A String", # Output only. The color space of the photo. + "date": "A String", # Output only. The date and time the photo was taken (EXIF format timestamp). + "exposureBias": 3.14, # Output only. The exposure bias of the photo (APEX value). + "exposureMode": "A String", # Output only. The exposure mode used to create the photo. + "exposureTime": 3.14, # Output only. The length of the exposure, in seconds. + "flashUsed": True or False, # Output only. Whether a flash was used to create the photo. + "focalLength": 3.14, # Output only. The focal length used to create the photo, in millimeters. + "height": 42, # Output only. The height of the image in pixels. + "isoSpeed": 42, # Output only. The ISO speed used to create the photo. + "lens": "A String", # Output only. The lens used to create the photo. + "location": { # Output only. Geographic location information stored in the image. + "altitude": 3.14, # Output only. The altitude stored in the image. + "latitude": 3.14, # Output only. The latitude stored in the image. + "longitude": 3.14, # Output only. The longitude stored in the image. }, - "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value). - "meteringMode": "A String", # The metering mode used to create the photo. - "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation. - "sensor": "A String", # The type of sensor used to create the photo. - "subjectDistance": 42, # The distance to the subject of the photo, in meters. - "whiteBalance": "A String", # The white balance mode used to create the photo. - "width": 42, # The width of the image in pixels. - }, - "indexableText": { # Indexable text attributes for the file (can only be written). For more information, see Manage file metadata. + "maxApertureValue": 3.14, # Output only. The smallest f-number of the lens at the focal length used to create the photo (APEX value). + "meteringMode": "A String", # Output only. The metering mode used to create the photo. + "rotation": 42, # Output only. The number of clockwise 90 degree rotations applied from the image's original orientation. + "sensor": "A String", # Output only. The type of sensor used to create the photo. + "subjectDistance": 42, # Output only. The distance to the subject of the photo, in meters. + "whiteBalance": "A String", # Output only. The white balance mode used to create the photo. + "width": 42, # Output only. The width of the image in pixels. + }, + "indexableText": { # Indexable text attributes for the file (can only be written) "text": "A String", # The text to be indexed for this file. }, - "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. - "kind": "drive#file", # The type of file. This is always drive#file. - "labelInfo": { # An overview of the labels on the file. - "labels": [ # The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned. - { # Representation of a label and its fields. - "fields": { # A map of the label's fields keyed by the field ID. - "a_key": { # Representation of a label field. + "isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app. + "kind": "drive#file", # Output only. The type of file. This is always `drive#file`. + "labelInfo": { # Output only. An overview of the labels on the file. + "labels": [ # 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. + { # Representation of a label and label fields. + "fields": { # A map of the fields on the label, keyed by the field's ID. + "a_key": { # Representation of field, which is a typed key-value pair. "dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD. "A String", ], - "id": "A String", # The identifier of this field. - "integer": [ # Only present if valueType is integer. + "id": "A String", # The identifier of this label field. + "integer": [ # Only present if `valueType` is `integer`. "A String", ], - "kind": "drive#labelField", # This is always drive#labelField. - "selection": [ # Only present if valueType is selection. + "kind": "drive#labelField", # This is always `drive#labelField`. + "selection": [ # Only present if `valueType` is `selection` "A String", ], - "text": [ # Only present if valueType is text. + "text": [ # Only present if `valueType` is `text`. "A String", ], - "user": [ # Only present if valueType is user. + "user": [ # Only present if `valueType` is `user`. { # Information about a Drive user. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, ], - "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: - # - dateString - # - integer - # - selection - # - text - # - user + "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: * `dateString` * `integer` * `selection` * `text` * `user` }, }, "id": "A String", # The ID of the label. - "kind": "drive#label", # This is always drive#label + "kind": "drive#label", # This is always `drive#label` "revisionId": "A String", # The revision ID of the label. }, ], }, "labels": { # A group of labels for the file. - "hidden": True or False, # Deprecated. - "modified": True or False, # Whether the file has been modified by this user. - "restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead. + "hidden": True or False, # Output only. Deprecated. + "modified": True or False, # Output only. Whether the file has been modified by this user. + "restricted": True or False, # Output only. Deprecated: Use `copyRequiresWriterPermission` instead. "starred": True or False, # Whether this file is starred by the user. - "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may 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. + "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files. "viewed": True or False, # Whether this file has been viewed by this user. }, - "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "lastModifyingUserName": "A String", # Name of the last user to modify this file. + "lastModifyingUserName": "A String", # Output only. Name of the last user to modify this file. "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp). "linkShareMetadata": { # Contains details about the link URLs that clients are using to refer to this item. - "securityUpdateEligible": True or False, # Whether the file is eligible for security update. - "securityUpdateEnabled": True or False, # Whether the security update is enabled for this file. + "securityUpdateEligible": True or False, # Output only. Whether the file is eligible for security update. + "securityUpdateEnabled": True or False, # Output only. Whether the security update is enabled for this file. }, "markedViewedByMeDate": "A String", # Deprecated. - "md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. + "md5Checksum": "A String", # Output only. An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. "mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type. "modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date. "modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set. - "openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used. + "openWithLinks": { # Output only. A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used. "a_key": "A String", }, - "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Google Drive. - "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives. - "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives. + "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the `title` field. This is only available for files with binary content in Google Drive. + "ownedByMe": True or False, # Output only. Whether the file is owned by the current user. Not populated for items in shared drives. + "ownerNames": [ # Output only. Name(s) of the owner(s) of this file. Not populated for items in shared drives. "A String", ], - "owners": [ # 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. + "owners": [ # 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. { # Information about a Drive user. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, ], - "parents": [ # Collection of parent folders which contain this file. - # If not specified as part of an insert 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 can also use the addParents and removeParents parameters to modify the parents list. + "parents": [ # Collection of parent folders which contain this file. If not specified as part of an insert 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 can also use the `addParents` and `removeParents` parameters to modify the parents list. { # A reference to a file's parent. "id": "A String", # The ID of the parent. - "isRoot": True or False, # Whether or not the parent is the root folder. - "kind": "drive#parentReference", # This is always drive#parentReference. - "parentLink": "A String", # A link to the parent. - "selfLink": "A String", # A link back to this reference. + "isRoot": True or False, # Output only. Whether or not the parent is the root folder. + "kind": "drive#parentReference", # Output only. This is always `drive#parentReference`. + "parentLink": "A String", # Output only. A link to the parent. + "selfLink": "A String", # Output only. A link back to this reference. }, ], - "permissionIds": [ # List of permission IDs for users with access to this file. + "permissionIds": [ # Output only. List of permission IDs for users with access to this file. "A String", ], - "permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives. + "permissions": [ # Output only. The list of permissions for users with access to this file. Not populated for items in shared drives. { # A permission for a file. - "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. + "additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future. "A String", ], - "authKey": "A String", # Deprecated. - "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. - "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain. - "emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group. - "etag": "A String", # The ETag of the permission. - "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - # - They cannot be set on shared drive items - # - They can only be set on user and group permissions - # - The date must be in the future - # - The date cannot be more than a year in the future - "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "kind": "drive#permission", # This is always drive#permission. - "name": "A String", # The name for this permission. - "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive. - "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "authKey": "A String", # Output only. Deprecated. + "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. + "domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`. + "emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`. + "etag": "A String", # Output only. The ETag of the permission. + "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests + "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "kind": "drive#permission", # Output only. This is always `drive#permission`. + "name": "A String", # Output only. The name for this permission. + "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. + "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. { - "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. + "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. - "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: - # - file - # - member - "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: - # - organizer - # - fileOrganizer - # - writer - # - reader + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` + "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, ], - "photoLink": "A String", # A link to the profile photo, if available. - "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: - # - owner - # - organizer - # - fileOrganizer - # - writer - # - reader - "selfLink": "A String", # A link back to this permission. - "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. + "photoLink": "A String", # Output only. A link to the profile photo, if available. + "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader` + "selfLink": "A String", # Output only. A link back to this permission. + "teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead. { - "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. + "additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead. "A String", ], - "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. - "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. - "role": "A String", # Deprecated - use permissionDetails/role instead. - "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. + "inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead. + "inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead. + "role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead. + "teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead. }, ], - "type": "A String", # The account type. Allowed values are: - # - user - # - group - # - domain - # - anyone - "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value. + "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` + "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. "withLink": True or False, # Whether the link is required for this permission. }, ], "properties": [ # The list of properties. - { # A key-value pair attached to a file that is either public or private to an application. - # The following limits apply to file properties: - # - Maximum of 100 properties total per file - # - Maximum of 30 private properties per app - # - Maximum of 30 public properties - # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property. - "etag": "A String", # ETag of the property. + { # A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property + "etag": "A String", # Output only. ETag of the property. "key": "A String", # The key of this property. - "kind": "drive#property", # This is always drive#property. - "selfLink": "A String", # The link back to this property. + "kind": "drive#property", # Output only. This is always `drive#property`. + "selfLink": "A String", # Output only. The link back to this property. "value": "A String", # The value of this property. - "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE). Private 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. + "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. Private 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. }, ], - "quotaBytesUsed": "A String", # The number of quota bytes used by this file. - "resourceKey": "A String", # A key needed to access the item via a shared link. - "selfLink": "A String", # A link back to this file. - "sha1Checksum": "A String", # The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "sha256Checksum": "A String", # The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "shareable": True or False, # Deprecated: use capabilities/canShare. - "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives. + "quotaBytesUsed": "A String", # Output only. The number of quota bytes used by this file. + "resourceKey": "A String", # Output only. A key needed to access the item via a shared link. + "selfLink": "A String", # Output only. A link back to this file. + "sha1Checksum": "A String", # 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 is not populated for Docs Editors or shortcut files. + "sha256Checksum": "A String", # 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 is not populated for Docs Editors or shortcut files. + "shareable": True or False, # Output only. Deprecated: Use `capabilities/canShare` instead. + "shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives. "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp). - "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "sharingUser": { # Information about a Drive user. # Output only. User that shared the item with the current user, if available. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut. + "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. "targetId": "A String", # The ID of the file that this shortcut points to. - "targetMimeType": "A String", # 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": "A String", # The ResourceKey for the target file. + "targetMimeType": "A String", # 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": "A String", # Output only. The ResourceKey for the target file. }, - "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'. + "spaces": [ # Output only. The list of spaces which contain the file. Supported values are `drive`, `appDataFolder` and `photos`. "A String", ], - "teamDriveId": "A String", # Deprecated - use driveId instead. + "teamDriveId": "A String", # Output only. Deprecated: Use `driveId` instead. "thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated. "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5. "mimeType": "A String", # The MIME type of the thumbnail. }, - "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. 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": "A String", # The thumbnail version for use in thumbnail cache invalidation. + "thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content. + "thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation. "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant. "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives. - "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "trashingUser": { # Information about a Drive user. # Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file. - "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. + "userPermission": { # A permission for a file. # Output only. The permissions for the authenticated user on this file. + "additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future. "A String", ], - "authKey": "A String", # Deprecated. - "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. - "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain. - "emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group. - "etag": "A String", # The ETag of the permission. - "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - # - They cannot be set on shared drive items - # - They can only be set on user and group permissions - # - The date must be in the future - # - The date cannot be more than a year in the future - "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "kind": "drive#permission", # This is always drive#permission. - "name": "A String", # The name for this permission. - "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive. - "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "authKey": "A String", # Output only. Deprecated. + "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. + "domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`. + "emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`. + "etag": "A String", # Output only. The ETag of the permission. + "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests + "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "kind": "drive#permission", # Output only. This is always `drive#permission`. + "name": "A String", # Output only. The name for this permission. + "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. + "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. { - "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. + "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. - "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: - # - file - # - member - "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: - # - organizer - # - fileOrganizer - # - writer - # - reader + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` + "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, ], - "photoLink": "A String", # A link to the profile photo, if available. - "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: - # - owner - # - organizer - # - fileOrganizer - # - writer - # - reader - "selfLink": "A String", # A link back to this permission. - "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. + "photoLink": "A String", # Output only. A link to the profile photo, if available. + "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader` + "selfLink": "A String", # Output only. A link back to this permission. + "teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead. { - "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. + "additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead. "A String", ], - "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. - "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. - "role": "A String", # Deprecated - use permissionDetails/role instead. - "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. + "inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead. + "inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead. + "role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead. + "teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead. }, ], - "type": "A String", # The account type. Allowed values are: - # - user - # - group - # - domain - # - anyone - "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value. + "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` + "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. "withLink": True or False, # Whether the link is required for this permission. }, - "version": "A String", # 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 requesting user. - "videoMediaMetadata": { # Metadata about video media. This will only be present for video types. - "durationMillis": "A String", # The duration of the video in milliseconds. - "height": 42, # The height of the video in pixels. - "width": 42, # The width of the video in pixels. + "version": "A String", # 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 requesting user. + "videoMediaMetadata": { # Output only. Metadata about video media. This will only be present for video types. + "durationMillis": "A String", # Output only. The duration of the video in milliseconds. + "height": 42, # Output only. The height of the video in pixels. + "width": 42, # Output only. The width of the video in pixels. }, - "webContentLink": "A String", # A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials. - "webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting. + "webContentLink": "A String", # Output only. A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials. + "webViewLink": "A String", # Output only. A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting. "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives. } convert: boolean, Whether to convert this file to the corresponding Docs Editors format. - enforceSingleParent: boolean, Deprecated. Creating files in multiple folders is no longer supported. - includeLabels: string, A comma-separated list of IDs of labels to include in the labelInfo part of the response. - includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported. + enforceSingleParent: boolean, Deprecated: Creating files in multiple folders is no longer supported. + includeLabels: string, A comma-separated list of IDs of labels to include in the `labelInfo` part of the response. + includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only `published` is supported. media_body: string, The filename of the media request body, or an instance of a MediaUpload object. media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object. ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads. ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are BCP 47 codes. pinned: boolean, Whether to pin the head revision of the uploaded file. A file can have a maximum of 200 pinned revisions. supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. - supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead. + supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead. timedTextLanguage: string, The language of the timed text. timedTextTrackName: string, The timed text track name. useContentAsIndexableText: boolean, Whether to use the content as indexable text. @@ -2006,462 +1839,421 @@Method Details
Allowed values DEFAULT - The visibility of the new file is determined by the user's default visibility/sharing policies. PRIVATE - The new file will be visible to only the owner. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format Returns: An object of the form: { # The metadata for a file. - "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer. - "appDataContents": True or False, # Whether this file is in the Application Data folder. - "canComment": True or False, # Deprecated: use capabilities/canComment. - "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions. - "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. - "canAcceptOwnership": True or False, # Whether the current user is the pending owner of the file. Not populated for shared drive files. - "canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder. - "canAddFolderFromAnotherDrive": True or False, # 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 is not a folder. Only populated for items in shared drives. - "canAddMyDriveParent": True or False, # 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": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file. - "canChangeRestrictedDownload": True or False, # Deprecated - "canChangeSecurityUpdateEnabled": True or False, # Whether the current user can change the securityUpdateEnabled field on link share metadata. - "canComment": True or False, # Whether the current user can comment on this file. - "canCopy": True or False, # 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 is not a folder. - "canDelete": True or False, # Whether the current user can delete this file. - "canDeleteChildren": True or False, # Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. - "canDownload": True or False, # Whether the current user can download this file. - "canEdit": True or False, # 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. - "canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder. - "canModifyContent": True or False, # Whether the current user can modify the content of this file. - "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file. - "canModifyLabels": True or False, # Whether the current user can modify the labels on this file. - "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. - "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. - "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not 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. - "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead. - "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. - "canMoveItemOutOfDrive": True or False, # 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 is being added. - "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. - "canMoveItemWithinDrive": True or False, # 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 is being added and the parent that is being removed. - "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. - "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. - "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. - "canReadLabels": True or False, # Whether the current user can read the labels on this file. - "canReadRevisions": True or False, # 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 isn't a folder, can be read. - "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. - "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. - "canRemoveMyDriveParent": True or False, # 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": True or False, # Whether the current user can rename this file. - "canShare": True or False, # Whether the current user can modify the sharing settings for this file. - "canTrash": True or False, # Whether the current user can move this file to trash. - "canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. - "canUntrash": True or False, # Whether the current user can restore this file from trash. + "alternateLink": "A String", # Output only. A link for opening the file in a relevant Google editor or viewer. + "appDataContents": True or False, # Output only. Whether this file is in the Application Data folder. + "canComment": True or False, # Output only. Deprecated: Use `capabilities/canComment` instead. + "canReadRevisions": True or False, # Output only. Deprecated: Use `capabilities/canReadRevisions` instead. + "capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. + "canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files. + "canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always false when the item is not a folder. + "canAddFolderFromAnotherDrive": True or False, # 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 is not a folder. Only populated for items in shared drives. + "canAddMyDriveParent": True or False, # 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. + "canChangeCopyRequiresWriterPermission": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file. + "canChangeRestrictedDownload": True or False, # Output only. Deprecated. + "canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata. + "canComment": True or False, # Output only. Whether the current user can comment on this file. + "canCopy": True or False, # 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 itself if it is not a folder. + "canDelete": True or False, # Output only. Whether the current user can delete this file. + "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDownload": True or False, # Output only. Whether the current user can download this file. + "canEdit": True or False, # 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`. + "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. + "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. + "canModifyContentRestriction": True or False, # Output only. Whether the current user can modify restrictions on content of this file. + "canModifyLabels": True or False, # Output only. Whether the current user can modify the labels on the file. + "canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. + "canMoveChildrenOutOfTeamDrive": True or False, # Output only. Deprecated: Use `canMoveChildrenOutOfDrive` instead. + "canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is false when the item is not 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. + "canMoveChildrenWithinTeamDrive": True or False, # Output only. Deprecated: Use `canMoveChildrenWithinDrive` instead. + "canMoveItemIntoTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemOutOfDrive` instead. + "canMoveItemOutOfDrive": True or False, # 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 is being added. + "canMoveItemOutOfTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemOutOfDrive` instead. + "canMoveItemWithinDrive": True or False, # 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 is being added and the parent that is being removed. + "canMoveItemWithinTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemWithinDrive` instead. + "canMoveTeamDriveItem": True or False, # Output only. Deprecated: Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead. + "canReadDrive": True or False, # Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. + "canReadLabels": True or False, # Output only. Whether the current user can read the labels on the file. + "canReadRevisions": True or False, # 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 itself if it is not a folder, can be read. + "canReadTeamDrive": True or False, # Output only. Deprecated: Use `canReadDrive` instead. + "canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead. + "canRemoveMyDriveParent": True or False, # 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. + "canRename": True or False, # Output only. Whether the current user can rename this file. + "canShare": True or False, # Output only. Whether the current user can modify the sharing settings for this file. + "canTrash": True or False, # Output only. Whether the current user can move this file to trash. + "canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists. { # A restriction for accessing the content of the file. "readOnly": True or False, # 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": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true. - "restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`. + "restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly` is true. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, "restrictionDate": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true. - "type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction. + "type": "A String", # Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`. }, ], "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters. - "copyable": True or False, # Deprecated: use capabilities/canCopy. + "copyable": True or False, # Output only. Deprecated: Use `capabilities/canCopy` instead. "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp). - "defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used. + "defaultOpenWithLink": "A String", # Output only. A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used. "description": "A String", # A short description of the file. - "downloadUrl": "A String", # Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives. - "editable": True or False, # Deprecated: use capabilities/canEdit. - "embedLink": "A String", # A link for embedding the file. - "etag": "A String", # ETag of the file. - "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. - "exportLinks": { # Links for exporting Docs Editors files to specific formats. - "a_key": "A String", # A mapping from export format to URL - }, - "fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "fileSize": "A String", # 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 is not populated for shortcuts or folders. + "downloadUrl": "A String", # Output only. Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. + "driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives. + "editable": True or False, # Output only. Deprecated: Use `capabilities/canEdit` instead. + "embedLink": "A String", # Output only. A link for embedding the file. + "etag": "A String", # Output only. ETag of the file. + "explicitlyTrashed": True or False, # Output only. Whether this file has been explicitly trashed, as opposed to recursively trashed. + "exportLinks": { # Output only. Links for exporting Docs Editors files to specific formats. + "a_key": "A String", + }, + "fileExtension": "A String", # Output only. The final component of `fullFileExtension` with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "fileSize": "A String", # Output only. Size in bytes of blobs and first party editor files. Won't be populated for files that have no size, like shortcuts and folders. "folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder or a shortcut to a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette. - "fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives. - "hasThumbnail": True or False, # 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": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "iconLink": "A String", # A link to the file's icon. + "fullFileExtension": "A String", # Output only. The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "hasAugmentedPermissions": True or False, # Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives. + "hasThumbnail": True or False, # Output only. 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": "A String", # Output only. The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "iconLink": "A String", # Output only. A link to the file's icon. "id": "A String", # The ID of the file. - "imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content. - "aperture": 3.14, # The aperture used to create the photo (f-number). - "cameraMake": "A String", # The make of the camera used to create the photo. - "cameraModel": "A String", # The model of the camera used to create the photo. - "colorSpace": "A String", # The color space of the photo. - "date": "A String", # The date and time the photo was taken (EXIF format timestamp). - "exposureBias": 3.14, # The exposure bias of the photo (APEX value). - "exposureMode": "A String", # The exposure mode used to create the photo. - "exposureTime": 3.14, # The length of the exposure, in seconds. - "flashUsed": True or False, # Whether a flash was used to create the photo. - "focalLength": 3.14, # The focal length used to create the photo, in millimeters. - "height": 42, # The height of the image in pixels. - "isoSpeed": 42, # The ISO speed used to create the photo. - "lens": "A String", # The lens used to create the photo. - "location": { # Geographic location information stored in the image. - "altitude": 3.14, # The altitude stored in the image. - "latitude": 3.14, # The latitude stored in the image. - "longitude": 3.14, # The longitude stored in the image. + "imageMediaMetadata": { # Output only. Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content. + "aperture": 3.14, # Output only. The aperture used to create the photo (f-number). + "cameraMake": "A String", # Output only. The make of the camera used to create the photo. + "cameraModel": "A String", # Output only. The model of the camera used to create the photo. + "colorSpace": "A String", # Output only. The color space of the photo. + "date": "A String", # Output only. The date and time the photo was taken (EXIF format timestamp). + "exposureBias": 3.14, # Output only. The exposure bias of the photo (APEX value). + "exposureMode": "A String", # Output only. The exposure mode used to create the photo. + "exposureTime": 3.14, # Output only. The length of the exposure, in seconds. + "flashUsed": True or False, # Output only. Whether a flash was used to create the photo. + "focalLength": 3.14, # Output only. The focal length used to create the photo, in millimeters. + "height": 42, # Output only. The height of the image in pixels. + "isoSpeed": 42, # Output only. The ISO speed used to create the photo. + "lens": "A String", # Output only. The lens used to create the photo. + "location": { # Output only. Geographic location information stored in the image. + "altitude": 3.14, # Output only. The altitude stored in the image. + "latitude": 3.14, # Output only. The latitude stored in the image. + "longitude": 3.14, # Output only. The longitude stored in the image. }, - "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value). - "meteringMode": "A String", # The metering mode used to create the photo. - "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation. - "sensor": "A String", # The type of sensor used to create the photo. - "subjectDistance": 42, # The distance to the subject of the photo, in meters. - "whiteBalance": "A String", # The white balance mode used to create the photo. - "width": 42, # The width of the image in pixels. - }, - "indexableText": { # Indexable text attributes for the file (can only be written). For more information, see Manage file metadata. + "maxApertureValue": 3.14, # Output only. The smallest f-number of the lens at the focal length used to create the photo (APEX value). + "meteringMode": "A String", # Output only. The metering mode used to create the photo. + "rotation": 42, # Output only. The number of clockwise 90 degree rotations applied from the image's original orientation. + "sensor": "A String", # Output only. The type of sensor used to create the photo. + "subjectDistance": 42, # Output only. The distance to the subject of the photo, in meters. + "whiteBalance": "A String", # Output only. The white balance mode used to create the photo. + "width": 42, # Output only. The width of the image in pixels. + }, + "indexableText": { # Indexable text attributes for the file (can only be written) "text": "A String", # The text to be indexed for this file. }, - "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. - "kind": "drive#file", # The type of file. This is always drive#file. - "labelInfo": { # An overview of the labels on the file. - "labels": [ # The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned. - { # Representation of a label and its fields. - "fields": { # A map of the label's fields keyed by the field ID. - "a_key": { # Representation of a label field. + "isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app. + "kind": "drive#file", # Output only. The type of file. This is always `drive#file`. + "labelInfo": { # Output only. An overview of the labels on the file. + "labels": [ # 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. + { # Representation of a label and label fields. + "fields": { # A map of the fields on the label, keyed by the field's ID. + "a_key": { # Representation of field, which is a typed key-value pair. "dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD. "A String", ], - "id": "A String", # The identifier of this field. - "integer": [ # Only present if valueType is integer. + "id": "A String", # The identifier of this label field. + "integer": [ # Only present if `valueType` is `integer`. "A String", ], - "kind": "drive#labelField", # This is always drive#labelField. - "selection": [ # Only present if valueType is selection. + "kind": "drive#labelField", # This is always `drive#labelField`. + "selection": [ # Only present if `valueType` is `selection` "A String", ], - "text": [ # Only present if valueType is text. + "text": [ # Only present if `valueType` is `text`. "A String", ], - "user": [ # Only present if valueType is user. + "user": [ # Only present if `valueType` is `user`. { # Information about a Drive user. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, ], - "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: - # - dateString - # - integer - # - selection - # - text - # - user + "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: * `dateString` * `integer` * `selection` * `text` * `user` }, }, "id": "A String", # The ID of the label. - "kind": "drive#label", # This is always drive#label + "kind": "drive#label", # This is always `drive#label` "revisionId": "A String", # The revision ID of the label. }, ], }, "labels": { # A group of labels for the file. - "hidden": True or False, # Deprecated. - "modified": True or False, # Whether the file has been modified by this user. - "restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead. + "hidden": True or False, # Output only. Deprecated. + "modified": True or False, # Output only. Whether the file has been modified by this user. + "restricted": True or False, # Output only. Deprecated: Use `copyRequiresWriterPermission` instead. "starred": True or False, # Whether this file is starred by the user. - "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may 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. + "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files. "viewed": True or False, # Whether this file has been viewed by this user. }, - "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "lastModifyingUserName": "A String", # Name of the last user to modify this file. + "lastModifyingUserName": "A String", # Output only. Name of the last user to modify this file. "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp). "linkShareMetadata": { # Contains details about the link URLs that clients are using to refer to this item. - "securityUpdateEligible": True or False, # Whether the file is eligible for security update. - "securityUpdateEnabled": True or False, # Whether the security update is enabled for this file. + "securityUpdateEligible": True or False, # Output only. Whether the file is eligible for security update. + "securityUpdateEnabled": True or False, # Output only. Whether the security update is enabled for this file. }, "markedViewedByMeDate": "A String", # Deprecated. - "md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. + "md5Checksum": "A String", # Output only. An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. "mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type. "modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date. "modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set. - "openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used. + "openWithLinks": { # Output only. A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used. "a_key": "A String", }, - "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Google Drive. - "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives. - "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives. + "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the `title` field. This is only available for files with binary content in Google Drive. + "ownedByMe": True or False, # Output only. Whether the file is owned by the current user. Not populated for items in shared drives. + "ownerNames": [ # Output only. Name(s) of the owner(s) of this file. Not populated for items in shared drives. "A String", ], - "owners": [ # 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. + "owners": [ # 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. { # Information about a Drive user. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, ], - "parents": [ # Collection of parent folders which contain this file. - # If not specified as part of an insert 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 can also use the addParents and removeParents parameters to modify the parents list. + "parents": [ # Collection of parent folders which contain this file. If not specified as part of an insert 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 can also use the `addParents` and `removeParents` parameters to modify the parents list. { # A reference to a file's parent. "id": "A String", # The ID of the parent. - "isRoot": True or False, # Whether or not the parent is the root folder. - "kind": "drive#parentReference", # This is always drive#parentReference. - "parentLink": "A String", # A link to the parent. - "selfLink": "A String", # A link back to this reference. + "isRoot": True or False, # Output only. Whether or not the parent is the root folder. + "kind": "drive#parentReference", # Output only. This is always `drive#parentReference`. + "parentLink": "A String", # Output only. A link to the parent. + "selfLink": "A String", # Output only. A link back to this reference. }, ], - "permissionIds": [ # List of permission IDs for users with access to this file. + "permissionIds": [ # Output only. List of permission IDs for users with access to this file. "A String", ], - "permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives. + "permissions": [ # Output only. The list of permissions for users with access to this file. Not populated for items in shared drives. { # A permission for a file. - "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. + "additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future. "A String", ], - "authKey": "A String", # Deprecated. - "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. - "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain. - "emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group. - "etag": "A String", # The ETag of the permission. - "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - # - They cannot be set on shared drive items - # - They can only be set on user and group permissions - # - The date must be in the future - # - The date cannot be more than a year in the future - "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "kind": "drive#permission", # This is always drive#permission. - "name": "A String", # The name for this permission. - "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive. - "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "authKey": "A String", # Output only. Deprecated. + "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. + "domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`. + "emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`. + "etag": "A String", # Output only. The ETag of the permission. + "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests + "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "kind": "drive#permission", # Output only. This is always `drive#permission`. + "name": "A String", # Output only. The name for this permission. + "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. + "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. { - "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. + "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. - "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: - # - file - # - member - "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: - # - organizer - # - fileOrganizer - # - writer - # - reader + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` + "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, ], - "photoLink": "A String", # A link to the profile photo, if available. - "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: - # - owner - # - organizer - # - fileOrganizer - # - writer - # - reader - "selfLink": "A String", # A link back to this permission. - "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. + "photoLink": "A String", # Output only. A link to the profile photo, if available. + "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader` + "selfLink": "A String", # Output only. A link back to this permission. + "teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead. { - "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. + "additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead. "A String", ], - "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. - "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. - "role": "A String", # Deprecated - use permissionDetails/role instead. - "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. + "inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead. + "inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead. + "role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead. + "teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead. }, ], - "type": "A String", # The account type. Allowed values are: - # - user - # - group - # - domain - # - anyone - "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value. + "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` + "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. "withLink": True or False, # Whether the link is required for this permission. }, ], "properties": [ # The list of properties. - { # A key-value pair attached to a file that is either public or private to an application. - # The following limits apply to file properties: - # - Maximum of 100 properties total per file - # - Maximum of 30 private properties per app - # - Maximum of 30 public properties - # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property. - "etag": "A String", # ETag of the property. + { # A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property + "etag": "A String", # Output only. ETag of the property. "key": "A String", # The key of this property. - "kind": "drive#property", # This is always drive#property. - "selfLink": "A String", # The link back to this property. + "kind": "drive#property", # Output only. This is always `drive#property`. + "selfLink": "A String", # Output only. The link back to this property. "value": "A String", # The value of this property. - "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE). Private 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. + "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. Private 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. }, ], - "quotaBytesUsed": "A String", # The number of quota bytes used by this file. - "resourceKey": "A String", # A key needed to access the item via a shared link. - "selfLink": "A String", # A link back to this file. - "sha1Checksum": "A String", # The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "sha256Checksum": "A String", # The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "shareable": True or False, # Deprecated: use capabilities/canShare. - "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives. + "quotaBytesUsed": "A String", # Output only. The number of quota bytes used by this file. + "resourceKey": "A String", # Output only. A key needed to access the item via a shared link. + "selfLink": "A String", # Output only. A link back to this file. + "sha1Checksum": "A String", # 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 is not populated for Docs Editors or shortcut files. + "sha256Checksum": "A String", # 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 is not populated for Docs Editors or shortcut files. + "shareable": True or False, # Output only. Deprecated: Use `capabilities/canShare` instead. + "shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives. "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp). - "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "sharingUser": { # Information about a Drive user. # Output only. User that shared the item with the current user, if available. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut. + "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. "targetId": "A String", # The ID of the file that this shortcut points to. - "targetMimeType": "A String", # 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": "A String", # The ResourceKey for the target file. + "targetMimeType": "A String", # 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": "A String", # Output only. The ResourceKey for the target file. }, - "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'. + "spaces": [ # Output only. The list of spaces which contain the file. Supported values are `drive`, `appDataFolder` and `photos`. "A String", ], - "teamDriveId": "A String", # Deprecated - use driveId instead. + "teamDriveId": "A String", # Output only. Deprecated: Use `driveId` instead. "thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated. "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5. "mimeType": "A String", # The MIME type of the thumbnail. }, - "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. 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": "A String", # The thumbnail version for use in thumbnail cache invalidation. + "thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content. + "thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation. "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant. "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives. - "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "trashingUser": { # Information about a Drive user. # Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file. - "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. + "userPermission": { # A permission for a file. # Output only. The permissions for the authenticated user on this file. + "additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future. "A String", ], - "authKey": "A String", # Deprecated. - "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. - "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain. - "emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group. - "etag": "A String", # The ETag of the permission. - "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - # - They cannot be set on shared drive items - # - They can only be set on user and group permissions - # - The date must be in the future - # - The date cannot be more than a year in the future - "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "kind": "drive#permission", # This is always drive#permission. - "name": "A String", # The name for this permission. - "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive. - "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "authKey": "A String", # Output only. Deprecated. + "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. + "domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`. + "emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`. + "etag": "A String", # Output only. The ETag of the permission. + "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests + "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "kind": "drive#permission", # Output only. This is always `drive#permission`. + "name": "A String", # Output only. The name for this permission. + "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. + "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. { - "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. + "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. - "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: - # - file - # - member - "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: - # - organizer - # - fileOrganizer - # - writer - # - reader + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` + "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, ], - "photoLink": "A String", # A link to the profile photo, if available. - "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: - # - owner - # - organizer - # - fileOrganizer - # - writer - # - reader - "selfLink": "A String", # A link back to this permission. - "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. + "photoLink": "A String", # Output only. A link to the profile photo, if available. + "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader` + "selfLink": "A String", # Output only. A link back to this permission. + "teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead. { - "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. + "additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead. "A String", ], - "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. - "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. - "role": "A String", # Deprecated - use permissionDetails/role instead. - "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. + "inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead. + "inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead. + "role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead. + "teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead. }, ], - "type": "A String", # The account type. Allowed values are: - # - user - # - group - # - domain - # - anyone - "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value. + "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` + "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. "withLink": True or False, # Whether the link is required for this permission. }, - "version": "A String", # 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 requesting user. - "videoMediaMetadata": { # Metadata about video media. This will only be present for video types. - "durationMillis": "A String", # The duration of the video in milliseconds. - "height": 42, # The height of the video in pixels. - "width": 42, # The width of the video in pixels. + "version": "A String", # 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 requesting user. + "videoMediaMetadata": { # Output only. Metadata about video media. This will only be present for video types. + "durationMillis": "A String", # Output only. The duration of the video in milliseconds. + "height": 42, # Output only. The height of the video in pixels. + "width": 42, # Output only. The width of the video in pixels. }, - "webContentLink": "A String", # A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials. - "webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting. + "webContentLink": "A String", # Output only. A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials. + "webViewLink": "A String", # Output only. A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting. "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives. }
list(corpora=None, corpus=None, driveId=None, includeItemsFromAllDrives=None, includeLabels=None, includePermissionsForView=None, includeTeamDriveItems=None, maxResults=None, orderBy=None, pageToken=None, projection=None, q=None, spaces=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)
- Lists the user's files. +list(corpora=None, corpus=None, driveId=None, includeItemsFromAllDrives=None, includeLabels=None, includePermissionsForView=None, includeTeamDriveItems=None, maxResults=None, orderBy=None, pageToken=None, projection=None, q=None, spaces=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None, x__xgafv=None)+Lists the user's files. This method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for files & folders](/drive/api/guides/search-files) guide. *Note:* This method returns *all* files by default, including trashed files. If you don't want trashed files to appear in the list, use the `trashed=false` query parameter to remove trashed files from the results. Args: - corpora: string, 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, The body of items (files/documents) to which the query applies. Deprecated: use 'corpora' instead. + corpora: string, Bodies of items (files/documents) to which the query applies. Supported bodies are `default`, `domain`, `drive` and `allDrives`. Prefer `default` or `drive` to `allDrives` for efficiency. + corpus: string, Deprecated: The body of items (files/documents) to which the query applies. Use `corpora` instead. Allowed values DEFAULT - The items that the user has accessed. DOMAIN - Items shared to the user's domain. driveId: string, ID of the shared drive to search. includeItemsFromAllDrives: boolean, Whether both My Drive and shared drive items should be included in results. - includeLabels: string, A comma-separated list of IDs of labels to include in the labelInfo part of the response. - includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported. - includeTeamDriveItems: boolean, Deprecated use includeItemsFromAllDrives instead. + includeLabels: string, A comma-separated list of IDs of labels to include in the `labelInfo` part of the response. + includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only `published` is supported. + includeTeamDriveItems: boolean, Deprecated: Use `includeItemsFromAllDrives` instead. maxResults: integer, 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. - orderBy: string, A comma-separated list of sort keys. Valid keys are 'createdDate', 'folder', 'lastViewedByMeDate', 'modifiedByMeDate', 'modifiedDate', 'quotaBytesUsed', 'recency', 'sharedWithMeDate', 'starred', 'title', and 'title_natural'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedDate desc,title. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored. + orderBy: string, A comma-separated list of sort keys. Valid keys are `createdDate`, `folder`, `lastViewedByMeDate`, `modifiedByMeDate`, `modifiedDate`, `quotaBytesUsed`, `recency`, `sharedWithMeDate`, `starred`, `title`, and `title_natural`. Each key sorts ascending by default, but may be reversed with the `desc` modifier. Example usage: ?orderBy=folder,modifiedDate desc,title. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored. pageToken: string, Page token for files. - projection: string, This parameter is deprecated and has no function. + projection: string, Deprecated: This parameter has no function. Allowed values - BASIC - Deprecated - FULL - Deprecated + BASIC - Deprecated. + FULL - Deprecated. q: string, Query string for searching files. - spaces: string, A comma-separated list of spaces to query. Supported values are 'drive' and 'appDataFolder'. + spaces: string, A comma-separated list of spaces to query. Supported values are `drive`, and `appDataFolder`. supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. - supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead. - teamDriveId: string, Deprecated use driveId instead. + supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead. + teamDriveId: string, Deprecated: Use `driveId` instead. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format Returns: An object of the form: @@ -2471,430 +2263,381 @@Method Details
"incompleteSearch": True or False, # Whether the search process was incomplete. If true, then some search results may be missing, since all documents were not searched. This may occur when searching multiple drives with the "allDrives" corpora, but all corpora could not be searched. When this happens, it is suggested that clients narrow their query by choosing a different corpus such as "default" or "drive". "items": [ # The list of files. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. { # The metadata for a file. - "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer. - "appDataContents": True or False, # Whether this file is in the Application Data folder. - "canComment": True or False, # Deprecated: use capabilities/canComment. - "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions. - "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. - "canAcceptOwnership": True or False, # Whether the current user is the pending owner of the file. Not populated for shared drive files. - "canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder. - "canAddFolderFromAnotherDrive": True or False, # 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 is not a folder. Only populated for items in shared drives. - "canAddMyDriveParent": True or False, # 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": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file. - "canChangeRestrictedDownload": True or False, # Deprecated - "canChangeSecurityUpdateEnabled": True or False, # Whether the current user can change the securityUpdateEnabled field on link share metadata. - "canComment": True or False, # Whether the current user can comment on this file. - "canCopy": True or False, # 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 is not a folder. - "canDelete": True or False, # Whether the current user can delete this file. - "canDeleteChildren": True or False, # Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. - "canDownload": True or False, # Whether the current user can download this file. - "canEdit": True or False, # 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. - "canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder. - "canModifyContent": True or False, # Whether the current user can modify the content of this file. - "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file. - "canModifyLabels": True or False, # Whether the current user can modify the labels on this file. - "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. - "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. - "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not 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. - "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead. - "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. - "canMoveItemOutOfDrive": True or False, # 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 is being added. - "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. - "canMoveItemWithinDrive": True or False, # 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 is being added and the parent that is being removed. - "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. - "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. - "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. - "canReadLabels": True or False, # Whether the current user can read the labels on this file. - "canReadRevisions": True or False, # 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 isn't a folder, can be read. - "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. - "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. - "canRemoveMyDriveParent": True or False, # 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": True or False, # Whether the current user can rename this file. - "canShare": True or False, # Whether the current user can modify the sharing settings for this file. - "canTrash": True or False, # Whether the current user can move this file to trash. - "canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. - "canUntrash": True or False, # Whether the current user can restore this file from trash. + "alternateLink": "A String", # Output only. A link for opening the file in a relevant Google editor or viewer. + "appDataContents": True or False, # Output only. Whether this file is in the Application Data folder. + "canComment": True or False, # Output only. Deprecated: Use `capabilities/canComment` instead. + "canReadRevisions": True or False, # Output only. Deprecated: Use `capabilities/canReadRevisions` instead. + "capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. + "canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files. + "canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always false when the item is not a folder. + "canAddFolderFromAnotherDrive": True or False, # 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 is not a folder. Only populated for items in shared drives. + "canAddMyDriveParent": True or False, # 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. + "canChangeCopyRequiresWriterPermission": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file. + "canChangeRestrictedDownload": True or False, # Output only. Deprecated. + "canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata. + "canComment": True or False, # Output only. Whether the current user can comment on this file. + "canCopy": True or False, # 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 itself if it is not a folder. + "canDelete": True or False, # Output only. Whether the current user can delete this file. + "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDownload": True or False, # Output only. Whether the current user can download this file. + "canEdit": True or False, # 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`. + "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. + "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. + "canModifyContentRestriction": True or False, # Output only. Whether the current user can modify restrictions on content of this file. + "canModifyLabels": True or False, # Output only. Whether the current user can modify the labels on the file. + "canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. + "canMoveChildrenOutOfTeamDrive": True or False, # Output only. Deprecated: Use `canMoveChildrenOutOfDrive` instead. + "canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is false when the item is not 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. + "canMoveChildrenWithinTeamDrive": True or False, # Output only. Deprecated: Use `canMoveChildrenWithinDrive` instead. + "canMoveItemIntoTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemOutOfDrive` instead. + "canMoveItemOutOfDrive": True or False, # 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 is being added. + "canMoveItemOutOfTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemOutOfDrive` instead. + "canMoveItemWithinDrive": True or False, # 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 is being added and the parent that is being removed. + "canMoveItemWithinTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemWithinDrive` instead. + "canMoveTeamDriveItem": True or False, # Output only. Deprecated: Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead. + "canReadDrive": True or False, # Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. + "canReadLabels": True or False, # Output only. Whether the current user can read the labels on the file. + "canReadRevisions": True or False, # 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 itself if it is not a folder, can be read. + "canReadTeamDrive": True or False, # Output only. Deprecated: Use `canReadDrive` instead. + "canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead. + "canRemoveMyDriveParent": True or False, # 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. + "canRename": True or False, # Output only. Whether the current user can rename this file. + "canShare": True or False, # Output only. Whether the current user can modify the sharing settings for this file. + "canTrash": True or False, # Output only. Whether the current user can move this file to trash. + "canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists. { # A restriction for accessing the content of the file. "readOnly": True or False, # 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": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true. - "restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`. + "restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly` is true. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, "restrictionDate": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true. - "type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction. + "type": "A String", # Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`. }, ], "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters. - "copyable": True or False, # Deprecated: use capabilities/canCopy. + "copyable": True or False, # Output only. Deprecated: Use `capabilities/canCopy` instead. "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp). - "defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used. + "defaultOpenWithLink": "A String", # Output only. A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used. "description": "A String", # A short description of the file. - "downloadUrl": "A String", # Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives. - "editable": True or False, # Deprecated: use capabilities/canEdit. - "embedLink": "A String", # A link for embedding the file. - "etag": "A String", # ETag of the file. - "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. - "exportLinks": { # Links for exporting Docs Editors files to specific formats. - "a_key": "A String", # A mapping from export format to URL + "downloadUrl": "A String", # Output only. Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. + "driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives. + "editable": True or False, # Output only. Deprecated: Use `capabilities/canEdit` instead. + "embedLink": "A String", # Output only. A link for embedding the file. + "etag": "A String", # Output only. ETag of the file. + "explicitlyTrashed": True or False, # Output only. Whether this file has been explicitly trashed, as opposed to recursively trashed. + "exportLinks": { # Output only. Links for exporting Docs Editors files to specific formats. + "a_key": "A String", }, - "fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "fileSize": "A String", # 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 is not populated for shortcuts or folders. + "fileExtension": "A String", # Output only. The final component of `fullFileExtension` with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "fileSize": "A String", # Output only. Size in bytes of blobs and first party editor files. Won't be populated for files that have no size, like shortcuts and folders. "folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder or a shortcut to a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette. - "fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives. - "hasThumbnail": True or False, # 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": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "iconLink": "A String", # A link to the file's icon. + "fullFileExtension": "A String", # Output only. The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "hasAugmentedPermissions": True or False, # Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives. + "hasThumbnail": True or False, # Output only. 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": "A String", # Output only. The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "iconLink": "A String", # Output only. A link to the file's icon. "id": "A String", # The ID of the file. - "imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content. - "aperture": 3.14, # The aperture used to create the photo (f-number). - "cameraMake": "A String", # The make of the camera used to create the photo. - "cameraModel": "A String", # The model of the camera used to create the photo. - "colorSpace": "A String", # The color space of the photo. - "date": "A String", # The date and time the photo was taken (EXIF format timestamp). - "exposureBias": 3.14, # The exposure bias of the photo (APEX value). - "exposureMode": "A String", # The exposure mode used to create the photo. - "exposureTime": 3.14, # The length of the exposure, in seconds. - "flashUsed": True or False, # Whether a flash was used to create the photo. - "focalLength": 3.14, # The focal length used to create the photo, in millimeters. - "height": 42, # The height of the image in pixels. - "isoSpeed": 42, # The ISO speed used to create the photo. - "lens": "A String", # The lens used to create the photo. - "location": { # Geographic location information stored in the image. - "altitude": 3.14, # The altitude stored in the image. - "latitude": 3.14, # The latitude stored in the image. - "longitude": 3.14, # The longitude stored in the image. + "imageMediaMetadata": { # Output only. Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content. + "aperture": 3.14, # Output only. The aperture used to create the photo (f-number). + "cameraMake": "A String", # Output only. The make of the camera used to create the photo. + "cameraModel": "A String", # Output only. The model of the camera used to create the photo. + "colorSpace": "A String", # Output only. The color space of the photo. + "date": "A String", # Output only. The date and time the photo was taken (EXIF format timestamp). + "exposureBias": 3.14, # Output only. The exposure bias of the photo (APEX value). + "exposureMode": "A String", # Output only. The exposure mode used to create the photo. + "exposureTime": 3.14, # Output only. The length of the exposure, in seconds. + "flashUsed": True or False, # Output only. Whether a flash was used to create the photo. + "focalLength": 3.14, # Output only. The focal length used to create the photo, in millimeters. + "height": 42, # Output only. The height of the image in pixels. + "isoSpeed": 42, # Output only. The ISO speed used to create the photo. + "lens": "A String", # Output only. The lens used to create the photo. + "location": { # Output only. Geographic location information stored in the image. + "altitude": 3.14, # Output only. The altitude stored in the image. + "latitude": 3.14, # Output only. The latitude stored in the image. + "longitude": 3.14, # Output only. The longitude stored in the image. }, - "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value). - "meteringMode": "A String", # The metering mode used to create the photo. - "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation. - "sensor": "A String", # The type of sensor used to create the photo. - "subjectDistance": 42, # The distance to the subject of the photo, in meters. - "whiteBalance": "A String", # The white balance mode used to create the photo. - "width": 42, # The width of the image in pixels. + "maxApertureValue": 3.14, # Output only. The smallest f-number of the lens at the focal length used to create the photo (APEX value). + "meteringMode": "A String", # Output only. The metering mode used to create the photo. + "rotation": 42, # Output only. The number of clockwise 90 degree rotations applied from the image's original orientation. + "sensor": "A String", # Output only. The type of sensor used to create the photo. + "subjectDistance": 42, # Output only. The distance to the subject of the photo, in meters. + "whiteBalance": "A String", # Output only. The white balance mode used to create the photo. + "width": 42, # Output only. The width of the image in pixels. }, - "indexableText": { # Indexable text attributes for the file (can only be written). For more information, see Manage file metadata. + "indexableText": { # Indexable text attributes for the file (can only be written) "text": "A String", # The text to be indexed for this file. }, - "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. - "kind": "drive#file", # The type of file. This is always drive#file. - "labelInfo": { # An overview of the labels on the file. - "labels": [ # The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned. - { # Representation of a label and its fields. - "fields": { # A map of the label's fields keyed by the field ID. - "a_key": { # Representation of a label field. + "isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app. + "kind": "drive#file", # Output only. The type of file. This is always `drive#file`. + "labelInfo": { # Output only. An overview of the labels on the file. + "labels": [ # 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. + { # Representation of a label and label fields. + "fields": { # A map of the fields on the label, keyed by the field's ID. + "a_key": { # Representation of field, which is a typed key-value pair. "dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD. "A String", ], - "id": "A String", # The identifier of this field. - "integer": [ # Only present if valueType is integer. + "id": "A String", # The identifier of this label field. + "integer": [ # Only present if `valueType` is `integer`. "A String", ], - "kind": "drive#labelField", # This is always drive#labelField. - "selection": [ # Only present if valueType is selection. + "kind": "drive#labelField", # This is always `drive#labelField`. + "selection": [ # Only present if `valueType` is `selection` "A String", ], - "text": [ # Only present if valueType is text. + "text": [ # Only present if `valueType` is `text`. "A String", ], - "user": [ # Only present if valueType is user. + "user": [ # Only present if `valueType` is `user`. { # Information about a Drive user. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, ], - "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: - # - dateString - # - integer - # - selection - # - text - # - user + "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: * `dateString` * `integer` * `selection` * `text` * `user` }, }, "id": "A String", # The ID of the label. - "kind": "drive#label", # This is always drive#label + "kind": "drive#label", # This is always `drive#label` "revisionId": "A String", # The revision ID of the label. }, ], }, "labels": { # A group of labels for the file. - "hidden": True or False, # Deprecated. - "modified": True or False, # Whether the file has been modified by this user. - "restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead. + "hidden": True or False, # Output only. Deprecated. + "modified": True or False, # Output only. Whether the file has been modified by this user. + "restricted": True or False, # Output only. Deprecated: Use `copyRequiresWriterPermission` instead. "starred": True or False, # Whether this file is starred by the user. - "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may 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. + "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files. "viewed": True or False, # Whether this file has been viewed by this user. }, - "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "lastModifyingUserName": "A String", # Name of the last user to modify this file. + "lastModifyingUserName": "A String", # Output only. Name of the last user to modify this file. "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp). "linkShareMetadata": { # Contains details about the link URLs that clients are using to refer to this item. - "securityUpdateEligible": True or False, # Whether the file is eligible for security update. - "securityUpdateEnabled": True or False, # Whether the security update is enabled for this file. + "securityUpdateEligible": True or False, # Output only. Whether the file is eligible for security update. + "securityUpdateEnabled": True or False, # Output only. Whether the security update is enabled for this file. }, "markedViewedByMeDate": "A String", # Deprecated. - "md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. + "md5Checksum": "A String", # Output only. An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. "mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type. "modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date. "modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set. - "openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used. + "openWithLinks": { # Output only. A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used. "a_key": "A String", }, - "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Google Drive. - "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives. - "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives. + "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the `title` field. This is only available for files with binary content in Google Drive. + "ownedByMe": True or False, # Output only. Whether the file is owned by the current user. Not populated for items in shared drives. + "ownerNames": [ # Output only. Name(s) of the owner(s) of this file. Not populated for items in shared drives. "A String", ], - "owners": [ # 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. + "owners": [ # 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. { # Information about a Drive user. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, ], - "parents": [ # Collection of parent folders which contain this file. - # If not specified as part of an insert 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 can also use the addParents and removeParents parameters to modify the parents list. + "parents": [ # Collection of parent folders which contain this file. If not specified as part of an insert 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 can also use the `addParents` and `removeParents` parameters to modify the parents list. { # A reference to a file's parent. "id": "A String", # The ID of the parent. - "isRoot": True or False, # Whether or not the parent is the root folder. - "kind": "drive#parentReference", # This is always drive#parentReference. - "parentLink": "A String", # A link to the parent. - "selfLink": "A String", # A link back to this reference. + "isRoot": True or False, # Output only. Whether or not the parent is the root folder. + "kind": "drive#parentReference", # Output only. This is always `drive#parentReference`. + "parentLink": "A String", # Output only. A link to the parent. + "selfLink": "A String", # Output only. A link back to this reference. }, ], - "permissionIds": [ # List of permission IDs for users with access to this file. + "permissionIds": [ # Output only. List of permission IDs for users with access to this file. "A String", ], - "permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives. + "permissions": [ # Output only. The list of permissions for users with access to this file. Not populated for items in shared drives. { # A permission for a file. - "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. + "additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future. "A String", ], - "authKey": "A String", # Deprecated. - "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. - "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain. - "emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group. - "etag": "A String", # The ETag of the permission. - "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - # - They cannot be set on shared drive items - # - They can only be set on user and group permissions - # - The date must be in the future - # - The date cannot be more than a year in the future - "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "kind": "drive#permission", # This is always drive#permission. - "name": "A String", # The name for this permission. - "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive. - "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "authKey": "A String", # Output only. Deprecated. + "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. + "domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`. + "emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`. + "etag": "A String", # Output only. The ETag of the permission. + "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests + "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "kind": "drive#permission", # Output only. This is always `drive#permission`. + "name": "A String", # Output only. The name for this permission. + "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. + "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. { - "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. + "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. - "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: - # - file - # - member - "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: - # - organizer - # - fileOrganizer - # - writer - # - reader + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` + "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, ], - "photoLink": "A String", # A link to the profile photo, if available. - "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: - # - owner - # - organizer - # - fileOrganizer - # - writer - # - reader - "selfLink": "A String", # A link back to this permission. - "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. + "photoLink": "A String", # Output only. A link to the profile photo, if available. + "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader` + "selfLink": "A String", # Output only. A link back to this permission. + "teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead. { - "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. + "additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead. "A String", ], - "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. - "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. - "role": "A String", # Deprecated - use permissionDetails/role instead. - "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. + "inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead. + "inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead. + "role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead. + "teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead. }, ], - "type": "A String", # The account type. Allowed values are: - # - user - # - group - # - domain - # - anyone - "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value. + "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` + "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. "withLink": True or False, # Whether the link is required for this permission. }, ], "properties": [ # The list of properties. - { # A key-value pair attached to a file that is either public or private to an application. - # The following limits apply to file properties: - # - Maximum of 100 properties total per file - # - Maximum of 30 private properties per app - # - Maximum of 30 public properties - # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property. - "etag": "A String", # ETag of the property. + { # A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property + "etag": "A String", # Output only. ETag of the property. "key": "A String", # The key of this property. - "kind": "drive#property", # This is always drive#property. - "selfLink": "A String", # The link back to this property. + "kind": "drive#property", # Output only. This is always `drive#property`. + "selfLink": "A String", # Output only. The link back to this property. "value": "A String", # The value of this property. - "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE). Private 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. + "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. Private 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. }, ], - "quotaBytesUsed": "A String", # The number of quota bytes used by this file. - "resourceKey": "A String", # A key needed to access the item via a shared link. - "selfLink": "A String", # A link back to this file. - "sha1Checksum": "A String", # The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "sha256Checksum": "A String", # The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "shareable": True or False, # Deprecated: use capabilities/canShare. - "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives. + "quotaBytesUsed": "A String", # Output only. The number of quota bytes used by this file. + "resourceKey": "A String", # Output only. A key needed to access the item via a shared link. + "selfLink": "A String", # Output only. A link back to this file. + "sha1Checksum": "A String", # 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 is not populated for Docs Editors or shortcut files. + "sha256Checksum": "A String", # 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 is not populated for Docs Editors or shortcut files. + "shareable": True or False, # Output only. Deprecated: Use `capabilities/canShare` instead. + "shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives. "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp). - "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "sharingUser": { # Information about a Drive user. # Output only. User that shared the item with the current user, if available. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut. + "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. "targetId": "A String", # The ID of the file that this shortcut points to. - "targetMimeType": "A String", # 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": "A String", # The ResourceKey for the target file. + "targetMimeType": "A String", # 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": "A String", # Output only. The ResourceKey for the target file. }, - "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'. + "spaces": [ # Output only. The list of spaces which contain the file. Supported values are `drive`, `appDataFolder` and `photos`. "A String", ], - "teamDriveId": "A String", # Deprecated - use driveId instead. + "teamDriveId": "A String", # Output only. Deprecated: Use `driveId` instead. "thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated. "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5. "mimeType": "A String", # The MIME type of the thumbnail. }, - "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. 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": "A String", # The thumbnail version for use in thumbnail cache invalidation. + "thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content. + "thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation. "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant. "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives. - "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "trashingUser": { # Information about a Drive user. # Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file. - "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. + "userPermission": { # A permission for a file. # Output only. The permissions for the authenticated user on this file. + "additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future. "A String", ], - "authKey": "A String", # Deprecated. - "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. - "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain. - "emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group. - "etag": "A String", # The ETag of the permission. - "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - # - They cannot be set on shared drive items - # - They can only be set on user and group permissions - # - The date must be in the future - # - The date cannot be more than a year in the future - "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "kind": "drive#permission", # This is always drive#permission. - "name": "A String", # The name for this permission. - "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive. - "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "authKey": "A String", # Output only. Deprecated. + "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. + "domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`. + "emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`. + "etag": "A String", # Output only. The ETag of the permission. + "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests + "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "kind": "drive#permission", # Output only. This is always `drive#permission`. + "name": "A String", # Output only. The name for this permission. + "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. + "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. { - "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. + "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. - "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: - # - file - # - member - "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: - # - organizer - # - fileOrganizer - # - writer - # - reader + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` + "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, ], - "photoLink": "A String", # A link to the profile photo, if available. - "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: - # - owner - # - organizer - # - fileOrganizer - # - writer - # - reader - "selfLink": "A String", # A link back to this permission. - "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. + "photoLink": "A String", # Output only. A link to the profile photo, if available. + "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader` + "selfLink": "A String", # Output only. A link back to this permission. + "teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead. { - "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. + "additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead. "A String", ], - "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. - "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. - "role": "A String", # Deprecated - use permissionDetails/role instead. - "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. + "inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead. + "inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead. + "role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead. + "teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead. }, ], - "type": "A String", # The account type. Allowed values are: - # - user - # - group - # - domain - # - anyone - "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value. + "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` + "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. "withLink": True or False, # Whether the link is required for this permission. }, - "version": "A String", # 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 requesting user. - "videoMediaMetadata": { # Metadata about video media. This will only be present for video types. - "durationMillis": "A String", # The duration of the video in milliseconds. - "height": 42, # The height of the video in pixels. - "width": 42, # The width of the video in pixels. + "version": "A String", # 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 requesting user. + "videoMediaMetadata": { # Output only. Metadata about video media. This will only be present for video types. + "durationMillis": "A String", # Output only. The duration of the video in milliseconds. + "height": 42, # Output only. The height of the video in pixels. + "width": 42, # Output only. The width of the video in pixels. }, - "webContentLink": "A String", # A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials. - "webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting. + "webContentLink": "A String", # Output only. A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials. + "webViewLink": "A String", # Output only. A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting. "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives. }, ], - "kind": "drive#fileList", # This is always drive#fileList. + "kind": "drive#fileList", # This is always `drive#fileList`. "nextLink": "A String", # A link to the next page of files. "nextPageToken": "A String", # The page token for the next page of files. This will be absent if the end of the files list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. "selfLink": "A String", # A link back to this list. @@ -2902,62 +2645,61 @@Method Details
listLabels(fileId, maxResults=None, pageToken=None)
+ listLabels(fileId, maxResults=None, pageToken=None, x__xgafv=None)
Lists the labels on a file.
Args:
- fileId: string, The ID of the file. (required)
- maxResults: integer, The maximum number of labels to return per page. When not set, this defaults to 100.
- pageToken: string, 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.
+ fileId: string, The ID for the file or shared drive. (required)
+ maxResults: integer, The maximum number of labels to return per page. When not set, defaults to 100.
+ pageToken: string, 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.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
- { # A list of labels.
+ { # A list of labels applied to a file.
"items": [ # The list of labels.
- { # Representation of a label and its fields.
- "fields": { # A map of the label's fields keyed by the field ID.
- "a_key": { # Representation of a label field.
+ { # Representation of a label and label fields.
+ "fields": { # A map of the fields on the label, keyed by the field's ID.
+ "a_key": { # Representation of field, which is a typed key-value pair.
"dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD.
"A String",
],
- "id": "A String", # The identifier of this field.
- "integer": [ # Only present if valueType is integer.
+ "id": "A String", # The identifier of this label field.
+ "integer": [ # Only present if `valueType` is `integer`.
"A String",
],
- "kind": "drive#labelField", # This is always drive#labelField.
- "selection": [ # Only present if valueType is selection.
+ "kind": "drive#labelField", # This is always `drive#labelField`.
+ "selection": [ # Only present if `valueType` is `selection`
"A String",
],
- "text": [ # Only present if valueType is text.
+ "text": [ # Only present if `valueType` is `text`.
"A String",
],
- "user": [ # Only present if valueType is user.
+ "user": [ # Only present if `valueType` is `user`.
{ # Information about a Drive user.
- "displayName": "A String", # A plain text displayable name for this user.
- "emailAddress": "A String", # The email address of the user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "kind": "drive#user", # This is always drive#user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
+ "displayName": "A String", # Output only. A plain text displayable name for this user.
+ "emailAddress": "A String", # Output only. The email address of the user.
+ "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
+ "kind": "drive#user", # Output only. This is always `drive#user`.
+ "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
+ "picture": { # Output only. The user's profile picture.
+ "url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
],
- "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed:
- # - dateString
- # - integer
- # - selection
- # - text
- # - user
+ "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: * `dateString` * `integer` * `selection` * `text` * `user`
},
},
"id": "A String", # The ID of the label.
- "kind": "drive#label", # This is always drive#label
+ "kind": "drive#label", # This is always `drive#label`
"revisionId": "A String", # The revision ID of the label.
},
],
- "kind": "drive#labelList", # This is always drive#labelList
+ "kind": "drive#labelList", # This is always `drive#labelList`
"nextPageToken": "A String", # The page token for the next page of labels. This field will be absent if the end of the list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.
}
modifyLabels(fileId, body=None)
- Modifies the set of labels on a file. +modifyLabels(fileId, body=None, x__xgafv=None)+Modifies the set of labels applied to a file. Returns a list of the labels that were added or modified. Args: - fileId: string, The ID of the file for which the labels are modified. (required) + fileId: string, The ID of the file to which the labels belong. (required) body: object, The request body. The object takes the form of: -{ # A request to modify the set of labels on a file. This request may contain many modifications that will either all succeed or all fail transactionally. - "kind": "drive#modifyLabelsRequest", # This is always drive#modifyLabelsRequest +{ # A request to modify the set of labels on a file. This request may contain many modifications that will either all succeed or all fail atomically. + "kind": "drive#modifyLabelsRequest", # This is always `drive#modifyLabelsRequest`. "labelModifications": [ # The list of modifications to apply to the labels on the file. { # A modification to a label on a file. A LabelModification can be used to apply a label to a file, update an existing label on a file, or remove a label from a file. "fieldModifications": [ # The list of modifications to this label's fields. { # A modification to a label's field. "fieldId": "A String", # The ID of the field to be modified. - "kind": "drive#labelFieldModification", # This is always drive#labelFieldModification. - "setDateValues": [ # Replaces a dateString field with these new values. The values must be strings in the RFC 3339 full-date format: YYYY-MM-DD. + "kind": "drive#labelFieldModification", # This is always `drive#labelFieldModification`. + "setDateValues": [ # Replaces the value of a dateString Field with these new values. The string must be in the RFC 3339 full-date format: YYYY-MM-DD. "A String", ], - "setIntegerValues": [ # Replaces an integer field with these new values. + "setIntegerValues": [ # Replaces the value of an `integer` field with these new values. "A String", ], - "setSelectionValues": [ # Replaces a selection field with these new values. + "setSelectionValues": [ # Replaces a `selection` field with these new values. "A String", ], - "setTextValues": [ # Replaces a text field with these new values. + "setTextValues": [ # Sets the value of a `text` field. "A String", ], - "setUserValues": [ # Replaces a user field with these new values. The values must be valid email addresses. + "setUserValues": [ # Replaces a `user` field with these new values. The values must be valid email addresses. "A String", ], "unsetValues": True or False, # Unsets the values for this field. }, ], - "kind": "drive#labelModification", # This is always drive#labelModification. + "kind": "drive#labelModification", # This is always `drive#labelModification`. "labelId": "A String", # The ID of the label to modify. "removeLabel": True or False, # If true, the label will be removed from the file. }, ], } + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format Returns: An object of the form: { # Response to a ModifyLabels request. This contains only those labels which were added or updated by the request. - "kind": "drive#modifyLabelsResponse", # This is always drive#modifyLabelsResponse + "kind": "drive#modifyLabelsResponse", # This is always `drive#modifyLabelsResponse` "modifiedLabels": [ # The list of labels which were added or updated by the request. - { # Representation of a label and its fields. - "fields": { # A map of the label's fields keyed by the field ID. - "a_key": { # Representation of a label field. + { # Representation of a label and label fields. + "fields": { # A map of the fields on the label, keyed by the field's ID. + "a_key": { # Representation of field, which is a typed key-value pair. "dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD. "A String", ], - "id": "A String", # The identifier of this field. - "integer": [ # Only present if valueType is integer. + "id": "A String", # The identifier of this label field. + "integer": [ # Only present if `valueType` is `integer`. "A String", ], - "kind": "drive#labelField", # This is always drive#labelField. - "selection": [ # Only present if valueType is selection. + "kind": "drive#labelField", # This is always `drive#labelField`. + "selection": [ # Only present if `valueType` is `selection` "A String", ], - "text": [ # Only present if valueType is text. + "text": [ # Only present if `valueType` is `text`. "A String", ], - "user": [ # Only present if valueType is user. + "user": [ # Only present if `valueType` is `user`. { # Information about a Drive user. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, ], - "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: - # - dateString - # - integer - # - selection - # - text - # - user + "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: * `dateString` * `integer` * `selection` * `text` * `user` }, }, "id": "A String", # The ID of the label. - "kind": "drive#label", # This is always drive#label + "kind": "drive#label", # This is always `drive#label` "revisionId": "A String", # The revision ID of the label. }, ], @@ -3085,7 +2826,7 @@Method Details
patch(fileId, addParents=None, body=None, convert=None, enforceSingleParent=None, includeLabels=None, includePermissionsForView=None, modifiedDateBehavior=None, newRevision=None, ocr=None, ocrLanguage=None, pinned=None, removeParents=None, setModifiedDate=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, updateViewedDate=None, useContentAsIndexableText=None)
+ patch(fileId, addParents=None, body=None, convert=None, enforceSingleParent=None, includeLabels=None, includePermissionsForView=None, modifiedDateBehavior=None, newRevision=None, ocr=None, ocrLanguage=None, pinned=None, removeParents=None, setModifiedDate=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, updateViewedDate=None, useContentAsIndexableText=None, x__xgafv=None)
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. Args: @@ -3094,2203 +2835,1974 @@Method Details
The object takes the form of: { # The metadata for a file. - "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer. - "appDataContents": True or False, # Whether this file is in the Application Data folder. - "canComment": True or False, # Deprecated: use capabilities/canComment. - "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions. - "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. - "canAcceptOwnership": True or False, # Whether the current user is the pending owner of the file. Not populated for shared drive files. - "canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder. - "canAddFolderFromAnotherDrive": True or False, # 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 is not a folder. Only populated for items in shared drives. - "canAddMyDriveParent": True or False, # 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": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file. - "canChangeRestrictedDownload": True or False, # Deprecated - "canChangeSecurityUpdateEnabled": True or False, # Whether the current user can change the securityUpdateEnabled field on link share metadata. - "canComment": True or False, # Whether the current user can comment on this file. - "canCopy": True or False, # 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 is not a folder. - "canDelete": True or False, # Whether the current user can delete this file. - "canDeleteChildren": True or False, # Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. - "canDownload": True or False, # Whether the current user can download this file. - "canEdit": True or False, # 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. - "canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder. - "canModifyContent": True or False, # Whether the current user can modify the content of this file. - "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file. - "canModifyLabels": True or False, # Whether the current user can modify the labels on this file. - "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. - "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. - "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not 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. - "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead. - "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. - "canMoveItemOutOfDrive": True or False, # 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 is being added. - "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. - "canMoveItemWithinDrive": True or False, # 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 is being added and the parent that is being removed. - "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. - "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. - "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. - "canReadLabels": True or False, # Whether the current user can read the labels on this file. - "canReadRevisions": True or False, # 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 isn't a folder, can be read. - "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. - "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. - "canRemoveMyDriveParent": True or False, # 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": True or False, # Whether the current user can rename this file. - "canShare": True or False, # Whether the current user can modify the sharing settings for this file. - "canTrash": True or False, # Whether the current user can move this file to trash. - "canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. - "canUntrash": True or False, # Whether the current user can restore this file from trash. + "alternateLink": "A String", # Output only. A link for opening the file in a relevant Google editor or viewer. + "appDataContents": True or False, # Output only. Whether this file is in the Application Data folder. + "canComment": True or False, # Output only. Deprecated: Use `capabilities/canComment` instead. + "canReadRevisions": True or False, # Output only. Deprecated: Use `capabilities/canReadRevisions` instead. + "capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. + "canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files. + "canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always false when the item is not a folder. + "canAddFolderFromAnotherDrive": True or False, # 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 is not a folder. Only populated for items in shared drives. + "canAddMyDriveParent": True or False, # 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. + "canChangeCopyRequiresWriterPermission": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file. + "canChangeRestrictedDownload": True or False, # Output only. Deprecated. + "canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata. + "canComment": True or False, # Output only. Whether the current user can comment on this file. + "canCopy": True or False, # 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 itself if it is not a folder. + "canDelete": True or False, # Output only. Whether the current user can delete this file. + "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDownload": True or False, # Output only. Whether the current user can download this file. + "canEdit": True or False, # 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`. + "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. + "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. + "canModifyContentRestriction": True or False, # Output only. Whether the current user can modify restrictions on content of this file. + "canModifyLabels": True or False, # Output only. Whether the current user can modify the labels on the file. + "canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. + "canMoveChildrenOutOfTeamDrive": True or False, # Output only. Deprecated: Use `canMoveChildrenOutOfDrive` instead. + "canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is false when the item is not 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. + "canMoveChildrenWithinTeamDrive": True or False, # Output only. Deprecated: Use `canMoveChildrenWithinDrive` instead. + "canMoveItemIntoTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemOutOfDrive` instead. + "canMoveItemOutOfDrive": True or False, # 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 is being added. + "canMoveItemOutOfTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemOutOfDrive` instead. + "canMoveItemWithinDrive": True or False, # 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 is being added and the parent that is being removed. + "canMoveItemWithinTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemWithinDrive` instead. + "canMoveTeamDriveItem": True or False, # Output only. Deprecated: Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead. + "canReadDrive": True or False, # Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. + "canReadLabels": True or False, # Output only. Whether the current user can read the labels on the file. + "canReadRevisions": True or False, # 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 itself if it is not a folder, can be read. + "canReadTeamDrive": True or False, # Output only. Deprecated: Use `canReadDrive` instead. + "canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead. + "canRemoveMyDriveParent": True or False, # 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. + "canRename": True or False, # Output only. Whether the current user can rename this file. + "canShare": True or False, # Output only. Whether the current user can modify the sharing settings for this file. + "canTrash": True or False, # Output only. Whether the current user can move this file to trash. + "canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists. { # A restriction for accessing the content of the file. "readOnly": True or False, # 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": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true. - "restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`. + "restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly` is true. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, "restrictionDate": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true. - "type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction. + "type": "A String", # Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`. }, ], "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters. - "copyable": True or False, # Deprecated: use capabilities/canCopy. + "copyable": True or False, # Output only. Deprecated: Use `capabilities/canCopy` instead. "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp). - "defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used. + "defaultOpenWithLink": "A String", # Output only. A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used. "description": "A String", # A short description of the file. - "downloadUrl": "A String", # Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives. - "editable": True or False, # Deprecated: use capabilities/canEdit. - "embedLink": "A String", # A link for embedding the file. - "etag": "A String", # ETag of the file. - "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. - "exportLinks": { # Links for exporting Docs Editors files to specific formats. - "a_key": "A String", # A mapping from export format to URL - }, - "fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "fileSize": "A String", # 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 is not populated for shortcuts or folders. + "downloadUrl": "A String", # Output only. Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. + "driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives. + "editable": True or False, # Output only. Deprecated: Use `capabilities/canEdit` instead. + "embedLink": "A String", # Output only. A link for embedding the file. + "etag": "A String", # Output only. ETag of the file. + "explicitlyTrashed": True or False, # Output only. Whether this file has been explicitly trashed, as opposed to recursively trashed. + "exportLinks": { # Output only. Links for exporting Docs Editors files to specific formats. + "a_key": "A String", + }, + "fileExtension": "A String", # Output only. The final component of `fullFileExtension` with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "fileSize": "A String", # Output only. Size in bytes of blobs and first party editor files. Won't be populated for files that have no size, like shortcuts and folders. "folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder or a shortcut to a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette. - "fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives. - "hasThumbnail": True or False, # 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": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "iconLink": "A String", # A link to the file's icon. + "fullFileExtension": "A String", # Output only. The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "hasAugmentedPermissions": True or False, # Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives. + "hasThumbnail": True or False, # Output only. 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": "A String", # Output only. The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "iconLink": "A String", # Output only. A link to the file's icon. "id": "A String", # The ID of the file. - "imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content. - "aperture": 3.14, # The aperture used to create the photo (f-number). - "cameraMake": "A String", # The make of the camera used to create the photo. - "cameraModel": "A String", # The model of the camera used to create the photo. - "colorSpace": "A String", # The color space of the photo. - "date": "A String", # The date and time the photo was taken (EXIF format timestamp). - "exposureBias": 3.14, # The exposure bias of the photo (APEX value). - "exposureMode": "A String", # The exposure mode used to create the photo. - "exposureTime": 3.14, # The length of the exposure, in seconds. - "flashUsed": True or False, # Whether a flash was used to create the photo. - "focalLength": 3.14, # The focal length used to create the photo, in millimeters. - "height": 42, # The height of the image in pixels. - "isoSpeed": 42, # The ISO speed used to create the photo. - "lens": "A String", # The lens used to create the photo. - "location": { # Geographic location information stored in the image. - "altitude": 3.14, # The altitude stored in the image. - "latitude": 3.14, # The latitude stored in the image. - "longitude": 3.14, # The longitude stored in the image. + "imageMediaMetadata": { # Output only. Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content. + "aperture": 3.14, # Output only. The aperture used to create the photo (f-number). + "cameraMake": "A String", # Output only. The make of the camera used to create the photo. + "cameraModel": "A String", # Output only. The model of the camera used to create the photo. + "colorSpace": "A String", # Output only. The color space of the photo. + "date": "A String", # Output only. The date and time the photo was taken (EXIF format timestamp). + "exposureBias": 3.14, # Output only. The exposure bias of the photo (APEX value). + "exposureMode": "A String", # Output only. The exposure mode used to create the photo. + "exposureTime": 3.14, # Output only. The length of the exposure, in seconds. + "flashUsed": True or False, # Output only. Whether a flash was used to create the photo. + "focalLength": 3.14, # Output only. The focal length used to create the photo, in millimeters. + "height": 42, # Output only. The height of the image in pixels. + "isoSpeed": 42, # Output only. The ISO speed used to create the photo. + "lens": "A String", # Output only. The lens used to create the photo. + "location": { # Output only. Geographic location information stored in the image. + "altitude": 3.14, # Output only. The altitude stored in the image. + "latitude": 3.14, # Output only. The latitude stored in the image. + "longitude": 3.14, # Output only. The longitude stored in the image. }, - "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value). - "meteringMode": "A String", # The metering mode used to create the photo. - "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation. - "sensor": "A String", # The type of sensor used to create the photo. - "subjectDistance": 42, # The distance to the subject of the photo, in meters. - "whiteBalance": "A String", # The white balance mode used to create the photo. - "width": 42, # The width of the image in pixels. - }, - "indexableText": { # Indexable text attributes for the file (can only be written). For more information, see Manage file metadata. + "maxApertureValue": 3.14, # Output only. The smallest f-number of the lens at the focal length used to create the photo (APEX value). + "meteringMode": "A String", # Output only. The metering mode used to create the photo. + "rotation": 42, # Output only. The number of clockwise 90 degree rotations applied from the image's original orientation. + "sensor": "A String", # Output only. The type of sensor used to create the photo. + "subjectDistance": 42, # Output only. The distance to the subject of the photo, in meters. + "whiteBalance": "A String", # Output only. The white balance mode used to create the photo. + "width": 42, # Output only. The width of the image in pixels. + }, + "indexableText": { # Indexable text attributes for the file (can only be written) "text": "A String", # The text to be indexed for this file. }, - "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. - "kind": "drive#file", # The type of file. This is always drive#file. - "labelInfo": { # An overview of the labels on the file. - "labels": [ # The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned. - { # Representation of a label and its fields. - "fields": { # A map of the label's fields keyed by the field ID. - "a_key": { # Representation of a label field. + "isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app. + "kind": "drive#file", # Output only. The type of file. This is always `drive#file`. + "labelInfo": { # Output only. An overview of the labels on the file. + "labels": [ # 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. + { # Representation of a label and label fields. + "fields": { # A map of the fields on the label, keyed by the field's ID. + "a_key": { # Representation of field, which is a typed key-value pair. "dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD. "A String", ], - "id": "A String", # The identifier of this field. - "integer": [ # Only present if valueType is integer. + "id": "A String", # The identifier of this label field. + "integer": [ # Only present if `valueType` is `integer`. "A String", ], - "kind": "drive#labelField", # This is always drive#labelField. - "selection": [ # Only present if valueType is selection. + "kind": "drive#labelField", # This is always `drive#labelField`. + "selection": [ # Only present if `valueType` is `selection` "A String", ], - "text": [ # Only present if valueType is text. + "text": [ # Only present if `valueType` is `text`. "A String", ], - "user": [ # Only present if valueType is user. + "user": [ # Only present if `valueType` is `user`. { # Information about a Drive user. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, ], - "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: - # - dateString - # - integer - # - selection - # - text - # - user + "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: * `dateString` * `integer` * `selection` * `text` * `user` }, }, "id": "A String", # The ID of the label. - "kind": "drive#label", # This is always drive#label + "kind": "drive#label", # This is always `drive#label` "revisionId": "A String", # The revision ID of the label. }, ], }, "labels": { # A group of labels for the file. - "hidden": True or False, # Deprecated. - "modified": True or False, # Whether the file has been modified by this user. - "restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead. + "hidden": True or False, # Output only. Deprecated. + "modified": True or False, # Output only. Whether the file has been modified by this user. + "restricted": True or False, # Output only. Deprecated: Use `copyRequiresWriterPermission` instead. "starred": True or False, # Whether this file is starred by the user. - "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may 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. + "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files. "viewed": True or False, # Whether this file has been viewed by this user. }, - "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "lastModifyingUserName": "A String", # Name of the last user to modify this file. + "lastModifyingUserName": "A String", # Output only. Name of the last user to modify this file. "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp). "linkShareMetadata": { # Contains details about the link URLs that clients are using to refer to this item. - "securityUpdateEligible": True or False, # Whether the file is eligible for security update. - "securityUpdateEnabled": True or False, # Whether the security update is enabled for this file. + "securityUpdateEligible": True or False, # Output only. Whether the file is eligible for security update. + "securityUpdateEnabled": True or False, # Output only. Whether the security update is enabled for this file. }, "markedViewedByMeDate": "A String", # Deprecated. - "md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. + "md5Checksum": "A String", # Output only. An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. "mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type. "modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date. "modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set. - "openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used. + "openWithLinks": { # Output only. A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used. "a_key": "A String", }, - "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Google Drive. - "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives. - "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives. + "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the `title` field. This is only available for files with binary content in Google Drive. + "ownedByMe": True or False, # Output only. Whether the file is owned by the current user. Not populated for items in shared drives. + "ownerNames": [ # Output only. Name(s) of the owner(s) of this file. Not populated for items in shared drives. "A String", ], - "owners": [ # 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. + "owners": [ # 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. { # Information about a Drive user. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, ], - "parents": [ # Collection of parent folders which contain this file. - # If not specified as part of an insert 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 can also use the addParents and removeParents parameters to modify the parents list. + "parents": [ # Collection of parent folders which contain this file. If not specified as part of an insert 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 can also use the `addParents` and `removeParents` parameters to modify the parents list. { # A reference to a file's parent. "id": "A String", # The ID of the parent. - "isRoot": True or False, # Whether or not the parent is the root folder. - "kind": "drive#parentReference", # This is always drive#parentReference. - "parentLink": "A String", # A link to the parent. - "selfLink": "A String", # A link back to this reference. + "isRoot": True or False, # Output only. Whether or not the parent is the root folder. + "kind": "drive#parentReference", # Output only. This is always `drive#parentReference`. + "parentLink": "A String", # Output only. A link to the parent. + "selfLink": "A String", # Output only. A link back to this reference. }, ], - "permissionIds": [ # List of permission IDs for users with access to this file. + "permissionIds": [ # Output only. List of permission IDs for users with access to this file. "A String", ], - "permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives. + "permissions": [ # Output only. The list of permissions for users with access to this file. Not populated for items in shared drives. { # A permission for a file. - "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. + "additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future. "A String", ], - "authKey": "A String", # Deprecated. - "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. - "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain. - "emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group. - "etag": "A String", # The ETag of the permission. - "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - # - They cannot be set on shared drive items - # - They can only be set on user and group permissions - # - The date must be in the future - # - The date cannot be more than a year in the future - "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "kind": "drive#permission", # This is always drive#permission. - "name": "A String", # The name for this permission. - "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive. - "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "authKey": "A String", # Output only. Deprecated. + "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. + "domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`. + "emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`. + "etag": "A String", # Output only. The ETag of the permission. + "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests + "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "kind": "drive#permission", # Output only. This is always `drive#permission`. + "name": "A String", # Output only. The name for this permission. + "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. + "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. { - "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. + "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. - "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: - # - file - # - member - "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: - # - organizer - # - fileOrganizer - # - writer - # - reader + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` + "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, ], - "photoLink": "A String", # A link to the profile photo, if available. - "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: - # - owner - # - organizer - # - fileOrganizer - # - writer - # - reader - "selfLink": "A String", # A link back to this permission. - "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. + "photoLink": "A String", # Output only. A link to the profile photo, if available. + "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader` + "selfLink": "A String", # Output only. A link back to this permission. + "teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead. { - "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. + "additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead. "A String", ], - "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. - "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. - "role": "A String", # Deprecated - use permissionDetails/role instead. - "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. + "inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead. + "inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead. + "role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead. + "teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead. }, ], - "type": "A String", # The account type. Allowed values are: - # - user - # - group - # - domain - # - anyone - "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value. + "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` + "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. "withLink": True or False, # Whether the link is required for this permission. }, ], "properties": [ # The list of properties. - { # A key-value pair attached to a file that is either public or private to an application. - # The following limits apply to file properties: - # - Maximum of 100 properties total per file - # - Maximum of 30 private properties per app - # - Maximum of 30 public properties - # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property. - "etag": "A String", # ETag of the property. + { # A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property + "etag": "A String", # Output only. ETag of the property. "key": "A String", # The key of this property. - "kind": "drive#property", # This is always drive#property. - "selfLink": "A String", # The link back to this property. + "kind": "drive#property", # Output only. This is always `drive#property`. + "selfLink": "A String", # Output only. The link back to this property. "value": "A String", # The value of this property. - "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE). Private 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. + "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. Private 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. }, ], - "quotaBytesUsed": "A String", # The number of quota bytes used by this file. - "resourceKey": "A String", # A key needed to access the item via a shared link. - "selfLink": "A String", # A link back to this file. - "sha1Checksum": "A String", # The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "sha256Checksum": "A String", # The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "shareable": True or False, # Deprecated: use capabilities/canShare. - "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives. + "quotaBytesUsed": "A String", # Output only. The number of quota bytes used by this file. + "resourceKey": "A String", # Output only. A key needed to access the item via a shared link. + "selfLink": "A String", # Output only. A link back to this file. + "sha1Checksum": "A String", # 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 is not populated for Docs Editors or shortcut files. + "sha256Checksum": "A String", # 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 is not populated for Docs Editors or shortcut files. + "shareable": True or False, # Output only. Deprecated: Use `capabilities/canShare` instead. + "shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives. "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp). - "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "sharingUser": { # Information about a Drive user. # Output only. User that shared the item with the current user, if available. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut. + "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. "targetId": "A String", # The ID of the file that this shortcut points to. - "targetMimeType": "A String", # 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": "A String", # The ResourceKey for the target file. + "targetMimeType": "A String", # 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": "A String", # Output only. The ResourceKey for the target file. }, - "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'. + "spaces": [ # Output only. The list of spaces which contain the file. Supported values are `drive`, `appDataFolder` and `photos`. "A String", ], - "teamDriveId": "A String", # Deprecated - use driveId instead. + "teamDriveId": "A String", # Output only. Deprecated: Use `driveId` instead. "thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated. "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5. "mimeType": "A String", # The MIME type of the thumbnail. }, - "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. 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": "A String", # The thumbnail version for use in thumbnail cache invalidation. + "thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content. + "thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation. "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant. "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives. - "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "trashingUser": { # Information about a Drive user. # Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file. - "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. + "userPermission": { # A permission for a file. # Output only. The permissions for the authenticated user on this file. + "additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future. "A String", ], - "authKey": "A String", # Deprecated. - "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. - "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain. - "emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group. - "etag": "A String", # The ETag of the permission. - "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - # - They cannot be set on shared drive items - # - They can only be set on user and group permissions - # - The date must be in the future - # - The date cannot be more than a year in the future - "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "kind": "drive#permission", # This is always drive#permission. - "name": "A String", # The name for this permission. - "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive. - "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "authKey": "A String", # Output only. Deprecated. + "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. + "domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`. + "emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`. + "etag": "A String", # Output only. The ETag of the permission. + "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests + "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "kind": "drive#permission", # Output only. This is always `drive#permission`. + "name": "A String", # Output only. The name for this permission. + "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. + "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. { - "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. + "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. - "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: - # - file - # - member - "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: - # - organizer - # - fileOrganizer - # - writer - # - reader + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` + "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, ], - "photoLink": "A String", # A link to the profile photo, if available. - "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: - # - owner - # - organizer - # - fileOrganizer - # - writer - # - reader - "selfLink": "A String", # A link back to this permission. - "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. + "photoLink": "A String", # Output only. A link to the profile photo, if available. + "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader` + "selfLink": "A String", # Output only. A link back to this permission. + "teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead. { - "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. + "additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead. "A String", ], - "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. - "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. - "role": "A String", # Deprecated - use permissionDetails/role instead. - "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. + "inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead. + "inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead. + "role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead. + "teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead. }, ], - "type": "A String", # The account type. Allowed values are: - # - user - # - group - # - domain - # - anyone - "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value. + "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` + "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. "withLink": True or False, # Whether the link is required for this permission. }, - "version": "A String", # 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 requesting user. - "videoMediaMetadata": { # Metadata about video media. This will only be present for video types. - "durationMillis": "A String", # The duration of the video in milliseconds. - "height": 42, # The height of the video in pixels. - "width": 42, # The width of the video in pixels. + "version": "A String", # 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 requesting user. + "videoMediaMetadata": { # Output only. Metadata about video media. This will only be present for video types. + "durationMillis": "A String", # Output only. The duration of the video in milliseconds. + "height": 42, # Output only. The height of the video in pixels. + "width": 42, # Output only. The width of the video in pixels. }, - "webContentLink": "A String", # A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials. - "webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting. + "webContentLink": "A String", # Output only. A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials. + "webViewLink": "A String", # Output only. A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting. "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives. } addParents: string, Comma-separated list of parent IDs to add. - convert: boolean, This parameter is deprecated and has no function. - enforceSingleParent: boolean, Deprecated. Adding files to multiple folders is no longer supported. Use shortcuts instead. - includeLabels: string, A comma-separated list of IDs of labels to include in the labelInfo part of the response. - includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported. - modifiedDateBehavior: string, Determines the behavior in which modifiedDate is updated. This overrides setModifiedDate. + convert: boolean, Deprecated: This parameter has no function. + enforceSingleParent: boolean, Deprecated: Adding files to multiple folders is no longer supported. Use `shortcuts` instead. + includeLabels: string, A comma-separated list of IDs of labels to include in the `labelInfo` part of the response. + includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only `published` is supported. + modifiedDateBehavior: string, Determines the behavior in which `modifiedDate` is updated. This overrides `setModifiedDate`. Allowed values - fromBody - Set modifiedDate to the value provided in the body of the request. No change if no value was provided. - fromBodyIfNeeded - Set modifiedDate to the value provided in the body of the request depending on other contents of the update. + fromBody - Set `modifiedDate` to the value provided in the body of the request. No change if no value was provided. + fromBodyIfNeeded - Set `modifiedDate` to the value provided in the body of the request depending on other contents of the update. fromBodyOrNow - Set modifiedDate to the value provided in the body of the request, or to the current time if no value was provided. - noChange - Maintain the previous value of modifiedDate. - now - Set modifiedDate to the current time. - nowIfNeeded - Set modifiedDate to the current time depending on contents of the update. - newRevision: boolean, Whether a blob upload should create a new revision. If false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous unpinned revisions are preserved for a short period of time. Pinned revisions are stored indefinitely, using additional storage quota, up to a maximum of 200 revisions. For details on how revisions are retained, see the Drive Help Center. Note that this field is ignored if there is no payload in the request. + noChange - Maintain the previous value of `modifiedDate`. + now - Set `modifiedDate` to the current time. + nowIfNeeded - Set `modifiedDate` to the current time depending on contents of the update. + newRevision: boolean, Whether a blob upload should create a new revision. If false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous unpinned revisions are preserved for a short period of time. Pinned revisions are stored indefinitely, using additional storage quota, up to a maximum of 200 revisions. For details on how revisions are retained, see the [Drive Help Center](https://support.google.com/drive/answer/2409045). Note that this field is ignored if there is no payload in the request. ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads. ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are BCP 47 codes. pinned: boolean, Whether to pin the new revision. A file can have a maximum of 200 pinned revisions. Note that this field is ignored if there is no payload in the request. removeParents: string, Comma-separated list of parent IDs to remove. - setModifiedDate: boolean, Whether to set the modified date using the value supplied in the request body. Setting this field to true is equivalent to modifiedDateBehavior=fromBodyOrNow, and false is equivalent to modifiedDateBehavior=now. To prevent any changes to the modified date set modifiedDateBehavior=noChange. + setModifiedDate: boolean, Whether to set the modified date using the value supplied in the request body. Setting this field to `true` is equivalent to `modifiedDateBehavior=fromBodyOrNow`, and `false` is equivalent to `modifiedDateBehavior=now`. To prevent any changes to the modified date set `modifiedDateBehavior=noChange`. supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. - supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead. + supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead. timedTextLanguage: string, The language of the timed text. timedTextTrackName: string, The timed text track name. updateViewedDate: boolean, Whether to update the view date after successfully updating the file. useContentAsIndexableText: boolean, Whether to use the content as indexable text. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format Returns: An object of the form: { # The metadata for a file. - "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer. - "appDataContents": True or False, # Whether this file is in the Application Data folder. - "canComment": True or False, # Deprecated: use capabilities/canComment. - "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions. - "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. - "canAcceptOwnership": True or False, # Whether the current user is the pending owner of the file. Not populated for shared drive files. - "canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder. - "canAddFolderFromAnotherDrive": True or False, # 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 is not a folder. Only populated for items in shared drives. - "canAddMyDriveParent": True or False, # 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": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file. - "canChangeRestrictedDownload": True or False, # Deprecated - "canChangeSecurityUpdateEnabled": True or False, # Whether the current user can change the securityUpdateEnabled field on link share metadata. - "canComment": True or False, # Whether the current user can comment on this file. - "canCopy": True or False, # 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 is not a folder. - "canDelete": True or False, # Whether the current user can delete this file. - "canDeleteChildren": True or False, # Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. - "canDownload": True or False, # Whether the current user can download this file. - "canEdit": True or False, # 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. - "canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder. - "canModifyContent": True or False, # Whether the current user can modify the content of this file. - "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file. - "canModifyLabels": True or False, # Whether the current user can modify the labels on this file. - "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. - "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. - "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not 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. - "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead. - "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. - "canMoveItemOutOfDrive": True or False, # 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 is being added. - "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. - "canMoveItemWithinDrive": True or False, # 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 is being added and the parent that is being removed. - "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. - "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. - "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. - "canReadLabels": True or False, # Whether the current user can read the labels on this file. - "canReadRevisions": True or False, # 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 isn't a folder, can be read. - "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. - "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. - "canRemoveMyDriveParent": True or False, # 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": True or False, # Whether the current user can rename this file. - "canShare": True or False, # Whether the current user can modify the sharing settings for this file. - "canTrash": True or False, # Whether the current user can move this file to trash. - "canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. - "canUntrash": True or False, # Whether the current user can restore this file from trash. + "alternateLink": "A String", # Output only. A link for opening the file in a relevant Google editor or viewer. + "appDataContents": True or False, # Output only. Whether this file is in the Application Data folder. + "canComment": True or False, # Output only. Deprecated: Use `capabilities/canComment` instead. + "canReadRevisions": True or False, # Output only. Deprecated: Use `capabilities/canReadRevisions` instead. + "capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. + "canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files. + "canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always false when the item is not a folder. + "canAddFolderFromAnotherDrive": True or False, # 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 is not a folder. Only populated for items in shared drives. + "canAddMyDriveParent": True or False, # 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. + "canChangeCopyRequiresWriterPermission": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file. + "canChangeRestrictedDownload": True or False, # Output only. Deprecated. + "canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata. + "canComment": True or False, # Output only. Whether the current user can comment on this file. + "canCopy": True or False, # 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 itself if it is not a folder. + "canDelete": True or False, # Output only. Whether the current user can delete this file. + "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDownload": True or False, # Output only. Whether the current user can download this file. + "canEdit": True or False, # 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`. + "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. + "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. + "canModifyContentRestriction": True or False, # Output only. Whether the current user can modify restrictions on content of this file. + "canModifyLabels": True or False, # Output only. Whether the current user can modify the labels on the file. + "canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. + "canMoveChildrenOutOfTeamDrive": True or False, # Output only. Deprecated: Use `canMoveChildrenOutOfDrive` instead. + "canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is false when the item is not 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. + "canMoveChildrenWithinTeamDrive": True or False, # Output only. Deprecated: Use `canMoveChildrenWithinDrive` instead. + "canMoveItemIntoTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemOutOfDrive` instead. + "canMoveItemOutOfDrive": True or False, # 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 is being added. + "canMoveItemOutOfTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemOutOfDrive` instead. + "canMoveItemWithinDrive": True or False, # 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 is being added and the parent that is being removed. + "canMoveItemWithinTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemWithinDrive` instead. + "canMoveTeamDriveItem": True or False, # Output only. Deprecated: Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead. + "canReadDrive": True or False, # Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. + "canReadLabels": True or False, # Output only. Whether the current user can read the labels on the file. + "canReadRevisions": True or False, # 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 itself if it is not a folder, can be read. + "canReadTeamDrive": True or False, # Output only. Deprecated: Use `canReadDrive` instead. + "canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead. + "canRemoveMyDriveParent": True or False, # 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. + "canRename": True or False, # Output only. Whether the current user can rename this file. + "canShare": True or False, # Output only. Whether the current user can modify the sharing settings for this file. + "canTrash": True or False, # Output only. Whether the current user can move this file to trash. + "canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists. { # A restriction for accessing the content of the file. "readOnly": True or False, # 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": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true. - "restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`. + "restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly` is true. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, "restrictionDate": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true. - "type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction. + "type": "A String", # Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`. }, ], "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters. - "copyable": True or False, # Deprecated: use capabilities/canCopy. + "copyable": True or False, # Output only. Deprecated: Use `capabilities/canCopy` instead. "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp). - "defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used. + "defaultOpenWithLink": "A String", # Output only. A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used. "description": "A String", # A short description of the file. - "downloadUrl": "A String", # Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives. - "editable": True or False, # Deprecated: use capabilities/canEdit. - "embedLink": "A String", # A link for embedding the file. - "etag": "A String", # ETag of the file. - "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. - "exportLinks": { # Links for exporting Docs Editors files to specific formats. - "a_key": "A String", # A mapping from export format to URL - }, - "fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "fileSize": "A String", # 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 is not populated for shortcuts or folders. + "downloadUrl": "A String", # Output only. Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. + "driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives. + "editable": True or False, # Output only. Deprecated: Use `capabilities/canEdit` instead. + "embedLink": "A String", # Output only. A link for embedding the file. + "etag": "A String", # Output only. ETag of the file. + "explicitlyTrashed": True or False, # Output only. Whether this file has been explicitly trashed, as opposed to recursively trashed. + "exportLinks": { # Output only. Links for exporting Docs Editors files to specific formats. + "a_key": "A String", + }, + "fileExtension": "A String", # Output only. The final component of `fullFileExtension` with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "fileSize": "A String", # Output only. Size in bytes of blobs and first party editor files. Won't be populated for files that have no size, like shortcuts and folders. "folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder or a shortcut to a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette. - "fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives. - "hasThumbnail": True or False, # 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": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "iconLink": "A String", # A link to the file's icon. + "fullFileExtension": "A String", # Output only. The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "hasAugmentedPermissions": True or False, # Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives. + "hasThumbnail": True or False, # Output only. 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": "A String", # Output only. The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "iconLink": "A String", # Output only. A link to the file's icon. "id": "A String", # The ID of the file. - "imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content. - "aperture": 3.14, # The aperture used to create the photo (f-number). - "cameraMake": "A String", # The make of the camera used to create the photo. - "cameraModel": "A String", # The model of the camera used to create the photo. - "colorSpace": "A String", # The color space of the photo. - "date": "A String", # The date and time the photo was taken (EXIF format timestamp). - "exposureBias": 3.14, # The exposure bias of the photo (APEX value). - "exposureMode": "A String", # The exposure mode used to create the photo. - "exposureTime": 3.14, # The length of the exposure, in seconds. - "flashUsed": True or False, # Whether a flash was used to create the photo. - "focalLength": 3.14, # The focal length used to create the photo, in millimeters. - "height": 42, # The height of the image in pixels. - "isoSpeed": 42, # The ISO speed used to create the photo. - "lens": "A String", # The lens used to create the photo. - "location": { # Geographic location information stored in the image. - "altitude": 3.14, # The altitude stored in the image. - "latitude": 3.14, # The latitude stored in the image. - "longitude": 3.14, # The longitude stored in the image. + "imageMediaMetadata": { # Output only. Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content. + "aperture": 3.14, # Output only. The aperture used to create the photo (f-number). + "cameraMake": "A String", # Output only. The make of the camera used to create the photo. + "cameraModel": "A String", # Output only. The model of the camera used to create the photo. + "colorSpace": "A String", # Output only. The color space of the photo. + "date": "A String", # Output only. The date and time the photo was taken (EXIF format timestamp). + "exposureBias": 3.14, # Output only. The exposure bias of the photo (APEX value). + "exposureMode": "A String", # Output only. The exposure mode used to create the photo. + "exposureTime": 3.14, # Output only. The length of the exposure, in seconds. + "flashUsed": True or False, # Output only. Whether a flash was used to create the photo. + "focalLength": 3.14, # Output only. The focal length used to create the photo, in millimeters. + "height": 42, # Output only. The height of the image in pixels. + "isoSpeed": 42, # Output only. The ISO speed used to create the photo. + "lens": "A String", # Output only. The lens used to create the photo. + "location": { # Output only. Geographic location information stored in the image. + "altitude": 3.14, # Output only. The altitude stored in the image. + "latitude": 3.14, # Output only. The latitude stored in the image. + "longitude": 3.14, # Output only. The longitude stored in the image. }, - "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value). - "meteringMode": "A String", # The metering mode used to create the photo. - "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation. - "sensor": "A String", # The type of sensor used to create the photo. - "subjectDistance": 42, # The distance to the subject of the photo, in meters. - "whiteBalance": "A String", # The white balance mode used to create the photo. - "width": 42, # The width of the image in pixels. - }, - "indexableText": { # Indexable text attributes for the file (can only be written). For more information, see Manage file metadata. + "maxApertureValue": 3.14, # Output only. The smallest f-number of the lens at the focal length used to create the photo (APEX value). + "meteringMode": "A String", # Output only. The metering mode used to create the photo. + "rotation": 42, # Output only. The number of clockwise 90 degree rotations applied from the image's original orientation. + "sensor": "A String", # Output only. The type of sensor used to create the photo. + "subjectDistance": 42, # Output only. The distance to the subject of the photo, in meters. + "whiteBalance": "A String", # Output only. The white balance mode used to create the photo. + "width": 42, # Output only. The width of the image in pixels. + }, + "indexableText": { # Indexable text attributes for the file (can only be written) "text": "A String", # The text to be indexed for this file. }, - "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. - "kind": "drive#file", # The type of file. This is always drive#file. - "labelInfo": { # An overview of the labels on the file. - "labels": [ # The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned. - { # Representation of a label and its fields. - "fields": { # A map of the label's fields keyed by the field ID. - "a_key": { # Representation of a label field. + "isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app. + "kind": "drive#file", # Output only. The type of file. This is always `drive#file`. + "labelInfo": { # Output only. An overview of the labels on the file. + "labels": [ # 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. + { # Representation of a label and label fields. + "fields": { # A map of the fields on the label, keyed by the field's ID. + "a_key": { # Representation of field, which is a typed key-value pair. "dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD. "A String", ], - "id": "A String", # The identifier of this field. - "integer": [ # Only present if valueType is integer. + "id": "A String", # The identifier of this label field. + "integer": [ # Only present if `valueType` is `integer`. "A String", ], - "kind": "drive#labelField", # This is always drive#labelField. - "selection": [ # Only present if valueType is selection. + "kind": "drive#labelField", # This is always `drive#labelField`. + "selection": [ # Only present if `valueType` is `selection` "A String", ], - "text": [ # Only present if valueType is text. + "text": [ # Only present if `valueType` is `text`. "A String", ], - "user": [ # Only present if valueType is user. + "user": [ # Only present if `valueType` is `user`. { # Information about a Drive user. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, ], - "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: - # - dateString - # - integer - # - selection - # - text - # - user + "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: * `dateString` * `integer` * `selection` * `text` * `user` }, }, "id": "A String", # The ID of the label. - "kind": "drive#label", # This is always drive#label + "kind": "drive#label", # This is always `drive#label` "revisionId": "A String", # The revision ID of the label. }, ], }, "labels": { # A group of labels for the file. - "hidden": True or False, # Deprecated. - "modified": True or False, # Whether the file has been modified by this user. - "restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead. + "hidden": True or False, # Output only. Deprecated. + "modified": True or False, # Output only. Whether the file has been modified by this user. + "restricted": True or False, # Output only. Deprecated: Use `copyRequiresWriterPermission` instead. "starred": True or False, # Whether this file is starred by the user. - "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may 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. + "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files. "viewed": True or False, # Whether this file has been viewed by this user. }, - "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "lastModifyingUserName": "A String", # Name of the last user to modify this file. + "lastModifyingUserName": "A String", # Output only. Name of the last user to modify this file. "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp). "linkShareMetadata": { # Contains details about the link URLs that clients are using to refer to this item. - "securityUpdateEligible": True or False, # Whether the file is eligible for security update. - "securityUpdateEnabled": True or False, # Whether the security update is enabled for this file. + "securityUpdateEligible": True or False, # Output only. Whether the file is eligible for security update. + "securityUpdateEnabled": True or False, # Output only. Whether the security update is enabled for this file. }, "markedViewedByMeDate": "A String", # Deprecated. - "md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. + "md5Checksum": "A String", # Output only. An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. "mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type. "modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date. "modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set. - "openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used. + "openWithLinks": { # Output only. A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used. "a_key": "A String", }, - "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Google Drive. - "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives. - "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives. + "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the `title` field. This is only available for files with binary content in Google Drive. + "ownedByMe": True or False, # Output only. Whether the file is owned by the current user. Not populated for items in shared drives. + "ownerNames": [ # Output only. Name(s) of the owner(s) of this file. Not populated for items in shared drives. "A String", ], - "owners": [ # 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. + "owners": [ # 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. { # Information about a Drive user. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, ], - "parents": [ # Collection of parent folders which contain this file. - # If not specified as part of an insert 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 can also use the addParents and removeParents parameters to modify the parents list. + "parents": [ # Collection of parent folders which contain this file. If not specified as part of an insert 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 can also use the `addParents` and `removeParents` parameters to modify the parents list. { # A reference to a file's parent. "id": "A String", # The ID of the parent. - "isRoot": True or False, # Whether or not the parent is the root folder. - "kind": "drive#parentReference", # This is always drive#parentReference. - "parentLink": "A String", # A link to the parent. - "selfLink": "A String", # A link back to this reference. + "isRoot": True or False, # Output only. Whether or not the parent is the root folder. + "kind": "drive#parentReference", # Output only. This is always `drive#parentReference`. + "parentLink": "A String", # Output only. A link to the parent. + "selfLink": "A String", # Output only. A link back to this reference. }, ], - "permissionIds": [ # List of permission IDs for users with access to this file. + "permissionIds": [ # Output only. List of permission IDs for users with access to this file. "A String", ], - "permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives. + "permissions": [ # Output only. The list of permissions for users with access to this file. Not populated for items in shared drives. { # A permission for a file. - "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. + "additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future. "A String", ], - "authKey": "A String", # Deprecated. - "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. - "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain. - "emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group. - "etag": "A String", # The ETag of the permission. - "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - # - They cannot be set on shared drive items - # - They can only be set on user and group permissions - # - The date must be in the future - # - The date cannot be more than a year in the future - "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "kind": "drive#permission", # This is always drive#permission. - "name": "A String", # The name for this permission. - "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive. - "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "authKey": "A String", # Output only. Deprecated. + "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. + "domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`. + "emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`. + "etag": "A String", # Output only. The ETag of the permission. + "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests + "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "kind": "drive#permission", # Output only. This is always `drive#permission`. + "name": "A String", # Output only. The name for this permission. + "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. + "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. { - "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. + "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. - "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: - # - file - # - member - "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: - # - organizer - # - fileOrganizer - # - writer - # - reader + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` + "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, ], - "photoLink": "A String", # A link to the profile photo, if available. - "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: - # - owner - # - organizer - # - fileOrganizer - # - writer - # - reader - "selfLink": "A String", # A link back to this permission. - "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. + "photoLink": "A String", # Output only. A link to the profile photo, if available. + "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader` + "selfLink": "A String", # Output only. A link back to this permission. + "teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead. { - "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. + "additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead. "A String", ], - "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. - "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. - "role": "A String", # Deprecated - use permissionDetails/role instead. - "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. + "inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead. + "inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead. + "role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead. + "teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead. }, ], - "type": "A String", # The account type. Allowed values are: - # - user - # - group - # - domain - # - anyone - "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value. + "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` + "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. "withLink": True or False, # Whether the link is required for this permission. }, ], "properties": [ # The list of properties. - { # A key-value pair attached to a file that is either public or private to an application. - # The following limits apply to file properties: - # - Maximum of 100 properties total per file - # - Maximum of 30 private properties per app - # - Maximum of 30 public properties - # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property. - "etag": "A String", # ETag of the property. + { # A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property + "etag": "A String", # Output only. ETag of the property. "key": "A String", # The key of this property. - "kind": "drive#property", # This is always drive#property. - "selfLink": "A String", # The link back to this property. + "kind": "drive#property", # Output only. This is always `drive#property`. + "selfLink": "A String", # Output only. The link back to this property. "value": "A String", # The value of this property. - "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE). Private 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. + "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. Private 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. }, ], - "quotaBytesUsed": "A String", # The number of quota bytes used by this file. - "resourceKey": "A String", # A key needed to access the item via a shared link. - "selfLink": "A String", # A link back to this file. - "sha1Checksum": "A String", # The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "sha256Checksum": "A String", # The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "shareable": True or False, # Deprecated: use capabilities/canShare. - "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives. + "quotaBytesUsed": "A String", # Output only. The number of quota bytes used by this file. + "resourceKey": "A String", # Output only. A key needed to access the item via a shared link. + "selfLink": "A String", # Output only. A link back to this file. + "sha1Checksum": "A String", # 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 is not populated for Docs Editors or shortcut files. + "sha256Checksum": "A String", # 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 is not populated for Docs Editors or shortcut files. + "shareable": True or False, # Output only. Deprecated: Use `capabilities/canShare` instead. + "shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives. "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp). - "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "sharingUser": { # Information about a Drive user. # Output only. User that shared the item with the current user, if available. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut. + "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. "targetId": "A String", # The ID of the file that this shortcut points to. - "targetMimeType": "A String", # 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": "A String", # The ResourceKey for the target file. + "targetMimeType": "A String", # 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": "A String", # Output only. The ResourceKey for the target file. }, - "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'. + "spaces": [ # Output only. The list of spaces which contain the file. Supported values are `drive`, `appDataFolder` and `photos`. "A String", ], - "teamDriveId": "A String", # Deprecated - use driveId instead. + "teamDriveId": "A String", # Output only. Deprecated: Use `driveId` instead. "thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated. "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5. "mimeType": "A String", # The MIME type of the thumbnail. }, - "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. 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": "A String", # The thumbnail version for use in thumbnail cache invalidation. + "thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content. + "thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation. "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant. "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives. - "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "trashingUser": { # Information about a Drive user. # Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file. - "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. + "userPermission": { # A permission for a file. # Output only. The permissions for the authenticated user on this file. + "additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future. "A String", ], - "authKey": "A String", # Deprecated. - "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. - "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain. - "emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group. - "etag": "A String", # The ETag of the permission. - "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - # - They cannot be set on shared drive items - # - They can only be set on user and group permissions - # - The date must be in the future - # - The date cannot be more than a year in the future - "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "kind": "drive#permission", # This is always drive#permission. - "name": "A String", # The name for this permission. - "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive. - "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "authKey": "A String", # Output only. Deprecated. + "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. + "domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`. + "emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`. + "etag": "A String", # Output only. The ETag of the permission. + "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests + "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "kind": "drive#permission", # Output only. This is always `drive#permission`. + "name": "A String", # Output only. The name for this permission. + "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. + "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. { - "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. + "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. - "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: - # - file - # - member - "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: - # - organizer - # - fileOrganizer - # - writer - # - reader + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` + "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, ], - "photoLink": "A String", # A link to the profile photo, if available. - "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: - # - owner - # - organizer - # - fileOrganizer - # - writer - # - reader - "selfLink": "A String", # A link back to this permission. - "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. + "photoLink": "A String", # Output only. A link to the profile photo, if available. + "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader` + "selfLink": "A String", # Output only. A link back to this permission. + "teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead. { - "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. + "additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead. "A String", ], - "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. - "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. - "role": "A String", # Deprecated - use permissionDetails/role instead. - "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. + "inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead. + "inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead. + "role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead. + "teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead. }, ], - "type": "A String", # The account type. Allowed values are: - # - user - # - group - # - domain - # - anyone - "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value. + "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` + "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. "withLink": True or False, # Whether the link is required for this permission. }, - "version": "A String", # 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 requesting user. - "videoMediaMetadata": { # Metadata about video media. This will only be present for video types. - "durationMillis": "A String", # The duration of the video in milliseconds. - "height": 42, # The height of the video in pixels. - "width": 42, # The width of the video in pixels. + "version": "A String", # 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 requesting user. + "videoMediaMetadata": { # Output only. Metadata about video media. This will only be present for video types. + "durationMillis": "A String", # Output only. The duration of the video in milliseconds. + "height": 42, # Output only. The height of the video in pixels. + "width": 42, # Output only. The width of the video in pixels. }, - "webContentLink": "A String", # A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials. - "webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting. + "webContentLink": "A String", # Output only. A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials. + "webViewLink": "A String", # Output only. A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting. "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives. }
touch(fileId, includeLabels=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None)
+ touch(fileId, includeLabels=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None)
Set the file's updated time to the current server time.
Args:
fileId: string, The ID of the file to update. (required)
- includeLabels: string, A comma-separated list of IDs of labels to include in the labelInfo part of the response.
- includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported.
+ includeLabels: string, A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.
+ includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only `published` is supported.
supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
- supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
+ supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
{ # The metadata for a file.
- "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer.
- "appDataContents": True or False, # Whether this file is in the Application Data folder.
- "canComment": True or False, # Deprecated: use capabilities/canComment.
- "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions.
- "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
- "canAcceptOwnership": True or False, # Whether the current user is the pending owner of the file. Not populated for shared drive files.
- "canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder.
- "canAddFolderFromAnotherDrive": True or False, # 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 is not a folder. Only populated for items in shared drives.
- "canAddMyDriveParent": True or False, # 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": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file.
- "canChangeRestrictedDownload": True or False, # Deprecated
- "canChangeSecurityUpdateEnabled": True or False, # Whether the current user can change the securityUpdateEnabled field on link share metadata.
- "canComment": True or False, # Whether the current user can comment on this file.
- "canCopy": True or False, # 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 is not a folder.
- "canDelete": True or False, # Whether the current user can delete this file.
- "canDeleteChildren": True or False, # Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
- "canDownload": True or False, # Whether the current user can download this file.
- "canEdit": True or False, # 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.
- "canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder.
- "canModifyContent": True or False, # Whether the current user can modify the content of this file.
- "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file.
- "canModifyLabels": True or False, # Whether the current user can modify the labels on this file.
- "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
- "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead.
- "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not 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.
- "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead.
- "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
- "canMoveItemOutOfDrive": True or False, # 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 is being added.
- "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead.
- "canMoveItemWithinDrive": True or False, # 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 is being added and the parent that is being removed.
- "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead.
- "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead.
- "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
- "canReadLabels": True or False, # Whether the current user can read the labels on this file.
- "canReadRevisions": True or False, # 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 isn't a folder, can be read.
- "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead.
- "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead.
- "canRemoveMyDriveParent": True or False, # 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": True or False, # Whether the current user can rename this file.
- "canShare": True or False, # Whether the current user can modify the sharing settings for this file.
- "canTrash": True or False, # Whether the current user can move this file to trash.
- "canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
- "canUntrash": True or False, # Whether the current user can restore this file from trash.
+ "alternateLink": "A String", # Output only. A link for opening the file in a relevant Google editor or viewer.
+ "appDataContents": True or False, # Output only. Whether this file is in the Application Data folder.
+ "canComment": True or False, # Output only. Deprecated: Use `capabilities/canComment` instead.
+ "canReadRevisions": True or False, # Output only. Deprecated: Use `capabilities/canReadRevisions` instead.
+ "capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
+ "canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files.
+ "canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always false when the item is not a folder.
+ "canAddFolderFromAnotherDrive": True or False, # 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 is not a folder. Only populated for items in shared drives.
+ "canAddMyDriveParent": True or False, # 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.
+ "canChangeCopyRequiresWriterPermission": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file.
+ "canChangeRestrictedDownload": True or False, # Output only. Deprecated.
+ "canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata.
+ "canComment": True or False, # Output only. Whether the current user can comment on this file.
+ "canCopy": True or False, # 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 itself if it is not a folder.
+ "canDelete": True or False, # Output only. Whether the current user can delete this file.
+ "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
+ "canDownload": True or False, # Output only. Whether the current user can download this file.
+ "canEdit": True or False, # 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`.
+ "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder.
+ "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file.
+ "canModifyContentRestriction": True or False, # Output only. Whether the current user can modify restrictions on content of this file.
+ "canModifyLabels": True or False, # Output only. Whether the current user can modify the labels on the file.
+ "canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.
+ "canMoveChildrenOutOfTeamDrive": True or False, # Output only. Deprecated: Use `canMoveChildrenOutOfDrive` instead.
+ "canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is false when the item is not 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.
+ "canMoveChildrenWithinTeamDrive": True or False, # Output only. Deprecated: Use `canMoveChildrenWithinDrive` instead.
+ "canMoveItemIntoTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemOutOfDrive` instead.
+ "canMoveItemOutOfDrive": True or False, # 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 is being added.
+ "canMoveItemOutOfTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemOutOfDrive` instead.
+ "canMoveItemWithinDrive": True or False, # 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 is being added and the parent that is being removed.
+ "canMoveItemWithinTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemWithinDrive` instead.
+ "canMoveTeamDriveItem": True or False, # Output only. Deprecated: Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead.
+ "canReadDrive": True or False, # Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.
+ "canReadLabels": True or False, # Output only. Whether the current user can read the labels on the file.
+ "canReadRevisions": True or False, # 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 itself if it is not a folder, can be read.
+ "canReadTeamDrive": True or False, # Output only. Deprecated: Use `canReadDrive` instead.
+ "canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead.
+ "canRemoveMyDriveParent": True or False, # 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.
+ "canRename": True or False, # Output only. Whether the current user can rename this file.
+ "canShare": True or False, # Output only. Whether the current user can modify the sharing settings for this file.
+ "canTrash": True or False, # Output only. Whether the current user can move this file to trash.
+ "canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives.
+ "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash.
},
"contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists.
{ # A restriction for accessing the content of the file.
"readOnly": True or False, # 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": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true.
- "restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true.
- "displayName": "A String", # A plain text displayable name for this user.
- "emailAddress": "A String", # The email address of the user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "kind": "drive#user", # This is always drive#user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
+ "reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`.
+ "restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly` is true.
+ "displayName": "A String", # Output only. A plain text displayable name for this user.
+ "emailAddress": "A String", # Output only. The email address of the user.
+ "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
+ "kind": "drive#user", # Output only. This is always `drive#user`.
+ "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
+ "picture": { # Output only. The user's profile picture.
+ "url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
"restrictionDate": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true.
- "type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction.
+ "type": "A String", # Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`.
},
],
"copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
- "copyable": True or False, # Deprecated: use capabilities/canCopy.
+ "copyable": True or False, # Output only. Deprecated: Use `capabilities/canCopy` instead.
"createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp).
- "defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
+ "defaultOpenWithLink": "A String", # Output only. A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
"description": "A String", # A short description of the file.
- "downloadUrl": "A String", # Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files.
- "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives.
- "editable": True or False, # Deprecated: use capabilities/canEdit.
- "embedLink": "A String", # A link for embedding the file.
- "etag": "A String", # ETag of the file.
- "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed.
- "exportLinks": { # Links for exporting Docs Editors files to specific formats.
- "a_key": "A String", # A mapping from export format to URL
- },
- "fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files.
- "fileSize": "A String", # 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 is not populated for shortcuts or folders.
+ "downloadUrl": "A String", # Output only. Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files.
+ "driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives.
+ "editable": True or False, # Output only. Deprecated: Use `capabilities/canEdit` instead.
+ "embedLink": "A String", # Output only. A link for embedding the file.
+ "etag": "A String", # Output only. ETag of the file.
+ "explicitlyTrashed": True or False, # Output only. Whether this file has been explicitly trashed, as opposed to recursively trashed.
+ "exportLinks": { # Output only. Links for exporting Docs Editors files to specific formats.
+ "a_key": "A String",
+ },
+ "fileExtension": "A String", # Output only. The final component of `fullFileExtension` with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
+ "fileSize": "A String", # Output only. Size in bytes of blobs and first party editor files. Won't be populated for files that have no size, like shortcuts and folders.
"folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder or a shortcut to a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.
- "fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files.
- "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives.
- "hasThumbnail": True or False, # 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": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files.
- "iconLink": "A String", # A link to the file's icon.
+ "fullFileExtension": "A String", # Output only. The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
+ "hasAugmentedPermissions": True or False, # Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives.
+ "hasThumbnail": True or False, # Output only. 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": "A String", # Output only. The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
+ "iconLink": "A String", # Output only. A link to the file's icon.
"id": "A String", # The ID of the file.
- "imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
- "aperture": 3.14, # The aperture used to create the photo (f-number).
- "cameraMake": "A String", # The make of the camera used to create the photo.
- "cameraModel": "A String", # The model of the camera used to create the photo.
- "colorSpace": "A String", # The color space of the photo.
- "date": "A String", # The date and time the photo was taken (EXIF format timestamp).
- "exposureBias": 3.14, # The exposure bias of the photo (APEX value).
- "exposureMode": "A String", # The exposure mode used to create the photo.
- "exposureTime": 3.14, # The length of the exposure, in seconds.
- "flashUsed": True or False, # Whether a flash was used to create the photo.
- "focalLength": 3.14, # The focal length used to create the photo, in millimeters.
- "height": 42, # The height of the image in pixels.
- "isoSpeed": 42, # The ISO speed used to create the photo.
- "lens": "A String", # The lens used to create the photo.
- "location": { # Geographic location information stored in the image.
- "altitude": 3.14, # The altitude stored in the image.
- "latitude": 3.14, # The latitude stored in the image.
- "longitude": 3.14, # The longitude stored in the image.
+ "imageMediaMetadata": { # Output only. Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
+ "aperture": 3.14, # Output only. The aperture used to create the photo (f-number).
+ "cameraMake": "A String", # Output only. The make of the camera used to create the photo.
+ "cameraModel": "A String", # Output only. The model of the camera used to create the photo.
+ "colorSpace": "A String", # Output only. The color space of the photo.
+ "date": "A String", # Output only. The date and time the photo was taken (EXIF format timestamp).
+ "exposureBias": 3.14, # Output only. The exposure bias of the photo (APEX value).
+ "exposureMode": "A String", # Output only. The exposure mode used to create the photo.
+ "exposureTime": 3.14, # Output only. The length of the exposure, in seconds.
+ "flashUsed": True or False, # Output only. Whether a flash was used to create the photo.
+ "focalLength": 3.14, # Output only. The focal length used to create the photo, in millimeters.
+ "height": 42, # Output only. The height of the image in pixels.
+ "isoSpeed": 42, # Output only. The ISO speed used to create the photo.
+ "lens": "A String", # Output only. The lens used to create the photo.
+ "location": { # Output only. Geographic location information stored in the image.
+ "altitude": 3.14, # Output only. The altitude stored in the image.
+ "latitude": 3.14, # Output only. The latitude stored in the image.
+ "longitude": 3.14, # Output only. The longitude stored in the image.
},
- "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
- "meteringMode": "A String", # The metering mode used to create the photo.
- "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation.
- "sensor": "A String", # The type of sensor used to create the photo.
- "subjectDistance": 42, # The distance to the subject of the photo, in meters.
- "whiteBalance": "A String", # The white balance mode used to create the photo.
- "width": 42, # The width of the image in pixels.
- },
- "indexableText": { # Indexable text attributes for the file (can only be written). For more information, see Manage file metadata.
+ "maxApertureValue": 3.14, # Output only. The smallest f-number of the lens at the focal length used to create the photo (APEX value).
+ "meteringMode": "A String", # Output only. The metering mode used to create the photo.
+ "rotation": 42, # Output only. The number of clockwise 90 degree rotations applied from the image's original orientation.
+ "sensor": "A String", # Output only. The type of sensor used to create the photo.
+ "subjectDistance": 42, # Output only. The distance to the subject of the photo, in meters.
+ "whiteBalance": "A String", # Output only. The white balance mode used to create the photo.
+ "width": 42, # Output only. The width of the image in pixels.
+ },
+ "indexableText": { # Indexable text attributes for the file (can only be written)
"text": "A String", # The text to be indexed for this file.
},
- "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app.
- "kind": "drive#file", # The type of file. This is always drive#file.
- "labelInfo": { # An overview of the labels on the file.
- "labels": [ # The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned.
- { # Representation of a label and its fields.
- "fields": { # A map of the label's fields keyed by the field ID.
- "a_key": { # Representation of a label field.
+ "isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app.
+ "kind": "drive#file", # Output only. The type of file. This is always `drive#file`.
+ "labelInfo": { # Output only. An overview of the labels on the file.
+ "labels": [ # 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.
+ { # Representation of a label and label fields.
+ "fields": { # A map of the fields on the label, keyed by the field's ID.
+ "a_key": { # Representation of field, which is a typed key-value pair.
"dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD.
"A String",
],
- "id": "A String", # The identifier of this field.
- "integer": [ # Only present if valueType is integer.
+ "id": "A String", # The identifier of this label field.
+ "integer": [ # Only present if `valueType` is `integer`.
"A String",
],
- "kind": "drive#labelField", # This is always drive#labelField.
- "selection": [ # Only present if valueType is selection.
+ "kind": "drive#labelField", # This is always `drive#labelField`.
+ "selection": [ # Only present if `valueType` is `selection`
"A String",
],
- "text": [ # Only present if valueType is text.
+ "text": [ # Only present if `valueType` is `text`.
"A String",
],
- "user": [ # Only present if valueType is user.
+ "user": [ # Only present if `valueType` is `user`.
{ # Information about a Drive user.
- "displayName": "A String", # A plain text displayable name for this user.
- "emailAddress": "A String", # The email address of the user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "kind": "drive#user", # This is always drive#user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
+ "displayName": "A String", # Output only. A plain text displayable name for this user.
+ "emailAddress": "A String", # Output only. The email address of the user.
+ "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
+ "kind": "drive#user", # Output only. This is always `drive#user`.
+ "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
+ "picture": { # Output only. The user's profile picture.
+ "url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
],
- "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed:
- # - dateString
- # - integer
- # - selection
- # - text
- # - user
+ "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: * `dateString` * `integer` * `selection` * `text` * `user`
},
},
"id": "A String", # The ID of the label.
- "kind": "drive#label", # This is always drive#label
+ "kind": "drive#label", # This is always `drive#label`
"revisionId": "A String", # The revision ID of the label.
},
],
},
"labels": { # A group of labels for the file.
- "hidden": True or False, # Deprecated.
- "modified": True or False, # Whether the file has been modified by this user.
- "restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead.
+ "hidden": True or False, # Output only. Deprecated.
+ "modified": True or False, # Output only. Whether the file has been modified by this user.
+ "restricted": True or False, # Output only. Deprecated: Use `copyRequiresWriterPermission` instead.
"starred": True or False, # Whether this file is starred by the user.
- "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may 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.
+ "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files.
"viewed": True or False, # Whether this file has been viewed by this user.
},
- "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file.
- "displayName": "A String", # A plain text displayable name for this user.
- "emailAddress": "A String", # The email address of the user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "kind": "drive#user", # This is always drive#user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
+ "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file.
+ "displayName": "A String", # Output only. A plain text displayable name for this user.
+ "emailAddress": "A String", # Output only. The email address of the user.
+ "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
+ "kind": "drive#user", # Output only. This is always `drive#user`.
+ "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
+ "picture": { # Output only. The user's profile picture.
+ "url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
- "lastModifyingUserName": "A String", # Name of the last user to modify this file.
+ "lastModifyingUserName": "A String", # Output only. Name of the last user to modify this file.
"lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp).
"linkShareMetadata": { # Contains details about the link URLs that clients are using to refer to this item.
- "securityUpdateEligible": True or False, # Whether the file is eligible for security update.
- "securityUpdateEnabled": True or False, # Whether the security update is enabled for this file.
+ "securityUpdateEligible": True or False, # Output only. Whether the file is eligible for security update.
+ "securityUpdateEnabled": True or False, # Output only. Whether the security update is enabled for this file.
},
"markedViewedByMeDate": "A String", # Deprecated.
- "md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files.
+ "md5Checksum": "A String", # Output only. An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
"mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
"modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.
- "openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
+ "openWithLinks": { # Output only. A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used.
"a_key": "A String",
},
- "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Google Drive.
- "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives.
- "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives.
+ "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the `title` field. This is only available for files with binary content in Google Drive.
+ "ownedByMe": True or False, # Output only. Whether the file is owned by the current user. Not populated for items in shared drives.
+ "ownerNames": [ # Output only. Name(s) of the owner(s) of this file. Not populated for items in shared drives.
"A String",
],
- "owners": [ # 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.
+ "owners": [ # 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.
{ # Information about a Drive user.
- "displayName": "A String", # A plain text displayable name for this user.
- "emailAddress": "A String", # The email address of the user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "kind": "drive#user", # This is always drive#user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
+ "displayName": "A String", # Output only. A plain text displayable name for this user.
+ "emailAddress": "A String", # Output only. The email address of the user.
+ "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
+ "kind": "drive#user", # Output only. This is always `drive#user`.
+ "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
+ "picture": { # Output only. The user's profile picture.
+ "url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
],
- "parents": [ # Collection of parent folders which contain this file.
- # If not specified as part of an insert 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 can also use the addParents and removeParents parameters to modify the parents list.
+ "parents": [ # Collection of parent folders which contain this file. If not specified as part of an insert 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 can also use the `addParents` and `removeParents` parameters to modify the parents list.
{ # A reference to a file's parent.
"id": "A String", # The ID of the parent.
- "isRoot": True or False, # Whether or not the parent is the root folder.
- "kind": "drive#parentReference", # This is always drive#parentReference.
- "parentLink": "A String", # A link to the parent.
- "selfLink": "A String", # A link back to this reference.
+ "isRoot": True or False, # Output only. Whether or not the parent is the root folder.
+ "kind": "drive#parentReference", # Output only. This is always `drive#parentReference`.
+ "parentLink": "A String", # Output only. A link to the parent.
+ "selfLink": "A String", # Output only. A link back to this reference.
},
],
- "permissionIds": [ # List of permission IDs for users with access to this file.
+ "permissionIds": [ # Output only. List of permission IDs for users with access to this file.
"A String",
],
- "permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives.
+ "permissions": [ # Output only. The list of permissions for users with access to this file. Not populated for items in shared drives.
{ # A permission for a file.
- "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
+ "additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future.
"A String",
],
- "authKey": "A String", # Deprecated.
- "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
- "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
- "emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
- "etag": "A String", # The ETag of the permission.
- "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:
- # - They cannot be set on shared drive items
- # - They can only be set on user and group permissions
- # - The date must be in the future
- # - The date cannot be more than a year in the future
- "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored.
- "kind": "drive#permission", # This is always drive#permission.
- "name": "A String", # The name for this permission.
- "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive.
- "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.
+ "authKey": "A String", # Output only. Deprecated.
+ "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
+ "domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`.
+ "emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`.
+ "etag": "A String", # Output only. The ETag of the permission.
+ "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests
+ "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
+ "kind": "drive#permission", # Output only. This is always `drive#permission`.
+ "name": "A String", # Output only. The name for this permission.
+ "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive.
+ "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.
{
- "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
+ "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future.
"A String",
],
- "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
- "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.
- "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
- # - file
- # - member
- "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
- # - organizer
- # - fileOrganizer
- # - writer
- # - reader
+ "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field.
+ "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field.
+ "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member`
+ "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader`
},
],
- "photoLink": "A String", # A link to the profile photo, if available.
- "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:
- # - owner
- # - organizer
- # - fileOrganizer
- # - writer
- # - reader
- "selfLink": "A String", # A link back to this permission.
- "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
+ "photoLink": "A String", # Output only. A link to the profile photo, if available.
+ "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader`
+ "selfLink": "A String", # Output only. A link back to this permission.
+ "teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead.
{
- "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.
+ "additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead.
"A String",
],
- "inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
- "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
- "role": "A String", # Deprecated - use permissionDetails/role instead.
- "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
+ "inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead.
+ "inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead.
+ "role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead.
+ "teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead.
},
],
- "type": "A String", # The account type. Allowed values are:
- # - user
- # - group
- # - domain
- # - anyone
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored.
- "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.
+ "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone`
+ "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
+ "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value.
"withLink": True or False, # Whether the link is required for this permission.
},
],
"properties": [ # The list of properties.
- { # A key-value pair attached to a file that is either public or private to an application.
- # The following limits apply to file properties:
- # - Maximum of 100 properties total per file
- # - Maximum of 30 private properties per app
- # - Maximum of 30 public properties
- # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.
- "etag": "A String", # ETag of the property.
+ { # A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property
+ "etag": "A String", # Output only. ETag of the property.
"key": "A String", # The key of this property.
- "kind": "drive#property", # This is always drive#property.
- "selfLink": "A String", # The link back to this property.
+ "kind": "drive#property", # Output only. This is always `drive#property`.
+ "selfLink": "A String", # Output only. The link back to this property.
"value": "A String", # The value of this property.
- "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE). Private 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.
+ "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. Private 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.
},
],
- "quotaBytesUsed": "A String", # The number of quota bytes used by this file.
- "resourceKey": "A String", # A key needed to access the item via a shared link.
- "selfLink": "A String", # A link back to this file.
- "sha1Checksum": "A String", # The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files.
- "sha256Checksum": "A String", # The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files.
- "shareable": True or False, # Deprecated: use capabilities/canShare.
- "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives.
+ "quotaBytesUsed": "A String", # Output only. The number of quota bytes used by this file.
+ "resourceKey": "A String", # Output only. A key needed to access the item via a shared link.
+ "selfLink": "A String", # Output only. A link back to this file.
+ "sha1Checksum": "A String", # 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 is not populated for Docs Editors or shortcut files.
+ "sha256Checksum": "A String", # 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 is not populated for Docs Editors or shortcut files.
+ "shareable": True or False, # Output only. Deprecated: Use `capabilities/canShare` instead.
+ "shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives.
"sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp).
- "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available.
- "displayName": "A String", # A plain text displayable name for this user.
- "emailAddress": "A String", # The email address of the user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "kind": "drive#user", # This is always drive#user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
+ "sharingUser": { # Information about a Drive user. # Output only. User that shared the item with the current user, if available.
+ "displayName": "A String", # Output only. A plain text displayable name for this user.
+ "emailAddress": "A String", # Output only. The email address of the user.
+ "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
+ "kind": "drive#user", # Output only. This is always `drive#user`.
+ "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
+ "picture": { # Output only. The user's profile picture.
+ "url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
- "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.
+ "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`.
"targetId": "A String", # The ID of the file that this shortcut points to.
- "targetMimeType": "A String", # 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": "A String", # The ResourceKey for the target file.
+ "targetMimeType": "A String", # 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": "A String", # Output only. The ResourceKey for the target file.
},
- "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'.
+ "spaces": [ # Output only. The list of spaces which contain the file. Supported values are `drive`, `appDataFolder` and `photos`.
"A String",
],
- "teamDriveId": "A String", # Deprecated - use driveId instead.
+ "teamDriveId": "A String", # Output only. Deprecated: Use `driveId` instead.
"thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
"image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5.
"mimeType": "A String", # The MIME type of the thumbnail.
},
- "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. 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": "A String", # The thumbnail version for use in thumbnail cache invalidation.
+ "thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content.
+ "thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation.
"title": "A String", # The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant.
"trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives.
- "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
- "displayName": "A String", # A plain text displayable name for this user.
- "emailAddress": "A String", # The email address of the user.
- "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
- "kind": "drive#user", # This is always drive#user.
- "permissionId": "A String", # The user's ID as visible in the permissions collection.
- "picture": { # The user's profile picture.
- "url": "A String", # A URL that points to a profile picture of this user.
+ "trashingUser": { # Information about a Drive user. # Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
+ "displayName": "A String", # Output only. A plain text displayable name for this user.
+ "emailAddress": "A String", # Output only. The email address of the user.
+ "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made.
+ "kind": "drive#user", # Output only. This is always `drive#user`.
+ "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection.
+ "picture": { # Output only. The user's profile picture.
+ "url": "A String", # Output Only. A URL that points to a profile picture of this user.
},
},
- "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file.
- "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
+ "userPermission": { # A permission for a file. # Output only. The permissions for the authenticated user on this file.
+ "additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future.
"A String",
],
- "authKey": "A String", # Deprecated.
- "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
- "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
- "emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
- "etag": "A String", # The ETag of the permission.
- "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions:
- # - They cannot be set on shared drive items
- # - They can only be set on user and group permissions
- # - The date must be in the future
- # - The date cannot be more than a year in the future
- "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored.
- "kind": "drive#permission", # This is always drive#permission.
- "name": "A String", # The name for this permission.
- "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive.
- "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.
+ "authKey": "A String", # Output only. Deprecated.
+ "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
+ "domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`.
+ "emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`.
+ "etag": "A String", # Output only. The ETag of the permission.
+ "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests
+ "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
+ "kind": "drive#permission", # Output only. This is always `drive#permission`.
+ "name": "A String", # Output only. The name for this permission.
+ "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive.
+ "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.
{
- "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future.
+ "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future.
"A String",
],
- "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
- "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field.
- "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
- # - file
- # - member
- "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
- # - organizer
- # - fileOrganizer
- # - writer
- # - reader
+ "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field.
+ "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field.
+ "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member`
+ "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader`
},
],
- "photoLink": "A String", # A link to the profile photo, if available.
- "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed:
- # - owner
- # - organizer
- # - fileOrganizer
- # - writer
- # - reader
- "selfLink": "A String", # A link back to this permission.
- "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
+ "photoLink": "A String", # Output only. A link to the profile photo, if available.
+ "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader`
+ "selfLink": "A String", # Output only. A link back to this permission.
+ "teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead.
{
- "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead.
+ "additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead.
"A String",
],
- "inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
- "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
- "role": "A String", # Deprecated - use permissionDetails/role instead.
- "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
+ "inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead.
+ "inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead.
+ "role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead.
+ "teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead.
},
],
- "type": "A String", # The account type. Allowed values are:
- # - user
- # - group
- # - domain
- # - anyone
- "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored.
- "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.
+ "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone`
+ "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored.
+ "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value.
"withLink": True or False, # Whether the link is required for this permission.
},
- "version": "A String", # 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 requesting user.
- "videoMediaMetadata": { # Metadata about video media. This will only be present for video types.
- "durationMillis": "A String", # The duration of the video in milliseconds.
- "height": 42, # The height of the video in pixels.
- "width": 42, # The width of the video in pixels.
+ "version": "A String", # 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 requesting user.
+ "videoMediaMetadata": { # Output only. Metadata about video media. This will only be present for video types.
+ "durationMillis": "A String", # Output only. The duration of the video in milliseconds.
+ "height": 42, # Output only. The height of the video in pixels.
+ "width": 42, # Output only. The width of the video in pixels.
},
- "webContentLink": "A String", # A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials.
- "webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
+ "webContentLink": "A String", # Output only. A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials.
+ "webViewLink": "A String", # Output only. A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting.
"writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives.
}
trash(fileId, includeLabels=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None)
- Moves a file to the trash. The currently authenticated user must own the file or be at least a fileOrganizer on the parent for shared drive files. Only the owner may 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. +trash(fileId, includeLabels=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None)+Moves a file to the trash. The currently authenticated user must own the file or be at least a `fileOrganizer` on the parent for shared drive files. Only the owner may trash a file. The trashed item is excluded from all `files.list` responses returned for any user who doesn't 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. *Note:* Files moved to the trash still appear by default in results from the `files.list` method. To permanently remove a file, use `files.delete`. Args: fileId: string, The ID of the file to trash. (required) - includeLabels: string, A comma-separated list of IDs of labels to include in the labelInfo part of the response. - includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported. + includeLabels: string, A comma-separated list of IDs of labels to include in the `labelInfo` part of the response. + includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only `published` is supported. supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. - supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead. + supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format Returns: An object of the form: { # The metadata for a file. - "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer. - "appDataContents": True or False, # Whether this file is in the Application Data folder. - "canComment": True or False, # Deprecated: use capabilities/canComment. - "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions. - "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. - "canAcceptOwnership": True or False, # Whether the current user is the pending owner of the file. Not populated for shared drive files. - "canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder. - "canAddFolderFromAnotherDrive": True or False, # 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 is not a folder. Only populated for items in shared drives. - "canAddMyDriveParent": True or False, # 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": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file. - "canChangeRestrictedDownload": True or False, # Deprecated - "canChangeSecurityUpdateEnabled": True or False, # Whether the current user can change the securityUpdateEnabled field on link share metadata. - "canComment": True or False, # Whether the current user can comment on this file. - "canCopy": True or False, # 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 is not a folder. - "canDelete": True or False, # Whether the current user can delete this file. - "canDeleteChildren": True or False, # Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. - "canDownload": True or False, # Whether the current user can download this file. - "canEdit": True or False, # 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. - "canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder. - "canModifyContent": True or False, # Whether the current user can modify the content of this file. - "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file. - "canModifyLabels": True or False, # Whether the current user can modify the labels on this file. - "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. - "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. - "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not 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. - "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead. - "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. - "canMoveItemOutOfDrive": True or False, # 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 is being added. - "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. - "canMoveItemWithinDrive": True or False, # 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 is being added and the parent that is being removed. - "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. - "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. - "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. - "canReadLabels": True or False, # Whether the current user can read the labels on this file. - "canReadRevisions": True or False, # 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 isn't a folder, can be read. - "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. - "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. - "canRemoveMyDriveParent": True or False, # 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": True or False, # Whether the current user can rename this file. - "canShare": True or False, # Whether the current user can modify the sharing settings for this file. - "canTrash": True or False, # Whether the current user can move this file to trash. - "canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. - "canUntrash": True or False, # Whether the current user can restore this file from trash. + "alternateLink": "A String", # Output only. A link for opening the file in a relevant Google editor or viewer. + "appDataContents": True or False, # Output only. Whether this file is in the Application Data folder. + "canComment": True or False, # Output only. Deprecated: Use `capabilities/canComment` instead. + "canReadRevisions": True or False, # Output only. Deprecated: Use `capabilities/canReadRevisions` instead. + "capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. + "canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files. + "canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always false when the item is not a folder. + "canAddFolderFromAnotherDrive": True or False, # 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 is not a folder. Only populated for items in shared drives. + "canAddMyDriveParent": True or False, # 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. + "canChangeCopyRequiresWriterPermission": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file. + "canChangeRestrictedDownload": True or False, # Output only. Deprecated. + "canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata. + "canComment": True or False, # Output only. Whether the current user can comment on this file. + "canCopy": True or False, # 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 itself if it is not a folder. + "canDelete": True or False, # Output only. Whether the current user can delete this file. + "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDownload": True or False, # Output only. Whether the current user can download this file. + "canEdit": True or False, # 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`. + "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. + "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. + "canModifyContentRestriction": True or False, # Output only. Whether the current user can modify restrictions on content of this file. + "canModifyLabels": True or False, # Output only. Whether the current user can modify the labels on the file. + "canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. + "canMoveChildrenOutOfTeamDrive": True or False, # Output only. Deprecated: Use `canMoveChildrenOutOfDrive` instead. + "canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is false when the item is not 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. + "canMoveChildrenWithinTeamDrive": True or False, # Output only. Deprecated: Use `canMoveChildrenWithinDrive` instead. + "canMoveItemIntoTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemOutOfDrive` instead. + "canMoveItemOutOfDrive": True or False, # 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 is being added. + "canMoveItemOutOfTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemOutOfDrive` instead. + "canMoveItemWithinDrive": True or False, # 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 is being added and the parent that is being removed. + "canMoveItemWithinTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemWithinDrive` instead. + "canMoveTeamDriveItem": True or False, # Output only. Deprecated: Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead. + "canReadDrive": True or False, # Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. + "canReadLabels": True or False, # Output only. Whether the current user can read the labels on the file. + "canReadRevisions": True or False, # 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 itself if it is not a folder, can be read. + "canReadTeamDrive": True or False, # Output only. Deprecated: Use `canReadDrive` instead. + "canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead. + "canRemoveMyDriveParent": True or False, # 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. + "canRename": True or False, # Output only. Whether the current user can rename this file. + "canShare": True or False, # Output only. Whether the current user can modify the sharing settings for this file. + "canTrash": True or False, # Output only. Whether the current user can move this file to trash. + "canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists. { # A restriction for accessing the content of the file. "readOnly": True or False, # 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": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true. - "restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`. + "restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly` is true. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, "restrictionDate": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true. - "type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction. + "type": "A String", # Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`. }, ], "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters. - "copyable": True or False, # Deprecated: use capabilities/canCopy. + "copyable": True or False, # Output only. Deprecated: Use `capabilities/canCopy` instead. "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp). - "defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used. + "defaultOpenWithLink": "A String", # Output only. A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used. "description": "A String", # A short description of the file. - "downloadUrl": "A String", # Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives. - "editable": True or False, # Deprecated: use capabilities/canEdit. - "embedLink": "A String", # A link for embedding the file. - "etag": "A String", # ETag of the file. - "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. - "exportLinks": { # Links for exporting Docs Editors files to specific formats. - "a_key": "A String", # A mapping from export format to URL - }, - "fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "fileSize": "A String", # 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 is not populated for shortcuts or folders. + "downloadUrl": "A String", # Output only. Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. + "driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives. + "editable": True or False, # Output only. Deprecated: Use `capabilities/canEdit` instead. + "embedLink": "A String", # Output only. A link for embedding the file. + "etag": "A String", # Output only. ETag of the file. + "explicitlyTrashed": True or False, # Output only. Whether this file has been explicitly trashed, as opposed to recursively trashed. + "exportLinks": { # Output only. Links for exporting Docs Editors files to specific formats. + "a_key": "A String", + }, + "fileExtension": "A String", # Output only. The final component of `fullFileExtension` with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "fileSize": "A String", # Output only. Size in bytes of blobs and first party editor files. Won't be populated for files that have no size, like shortcuts and folders. "folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder or a shortcut to a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette. - "fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives. - "hasThumbnail": True or False, # 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": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "iconLink": "A String", # A link to the file's icon. + "fullFileExtension": "A String", # Output only. The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "hasAugmentedPermissions": True or False, # Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives. + "hasThumbnail": True or False, # Output only. 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": "A String", # Output only. The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "iconLink": "A String", # Output only. A link to the file's icon. "id": "A String", # The ID of the file. - "imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content. - "aperture": 3.14, # The aperture used to create the photo (f-number). - "cameraMake": "A String", # The make of the camera used to create the photo. - "cameraModel": "A String", # The model of the camera used to create the photo. - "colorSpace": "A String", # The color space of the photo. - "date": "A String", # The date and time the photo was taken (EXIF format timestamp). - "exposureBias": 3.14, # The exposure bias of the photo (APEX value). - "exposureMode": "A String", # The exposure mode used to create the photo. - "exposureTime": 3.14, # The length of the exposure, in seconds. - "flashUsed": True or False, # Whether a flash was used to create the photo. - "focalLength": 3.14, # The focal length used to create the photo, in millimeters. - "height": 42, # The height of the image in pixels. - "isoSpeed": 42, # The ISO speed used to create the photo. - "lens": "A String", # The lens used to create the photo. - "location": { # Geographic location information stored in the image. - "altitude": 3.14, # The altitude stored in the image. - "latitude": 3.14, # The latitude stored in the image. - "longitude": 3.14, # The longitude stored in the image. + "imageMediaMetadata": { # Output only. Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content. + "aperture": 3.14, # Output only. The aperture used to create the photo (f-number). + "cameraMake": "A String", # Output only. The make of the camera used to create the photo. + "cameraModel": "A String", # Output only. The model of the camera used to create the photo. + "colorSpace": "A String", # Output only. The color space of the photo. + "date": "A String", # Output only. The date and time the photo was taken (EXIF format timestamp). + "exposureBias": 3.14, # Output only. The exposure bias of the photo (APEX value). + "exposureMode": "A String", # Output only. The exposure mode used to create the photo. + "exposureTime": 3.14, # Output only. The length of the exposure, in seconds. + "flashUsed": True or False, # Output only. Whether a flash was used to create the photo. + "focalLength": 3.14, # Output only. The focal length used to create the photo, in millimeters. + "height": 42, # Output only. The height of the image in pixels. + "isoSpeed": 42, # Output only. The ISO speed used to create the photo. + "lens": "A String", # Output only. The lens used to create the photo. + "location": { # Output only. Geographic location information stored in the image. + "altitude": 3.14, # Output only. The altitude stored in the image. + "latitude": 3.14, # Output only. The latitude stored in the image. + "longitude": 3.14, # Output only. The longitude stored in the image. }, - "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value). - "meteringMode": "A String", # The metering mode used to create the photo. - "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation. - "sensor": "A String", # The type of sensor used to create the photo. - "subjectDistance": 42, # The distance to the subject of the photo, in meters. - "whiteBalance": "A String", # The white balance mode used to create the photo. - "width": 42, # The width of the image in pixels. - }, - "indexableText": { # Indexable text attributes for the file (can only be written). For more information, see Manage file metadata. + "maxApertureValue": 3.14, # Output only. The smallest f-number of the lens at the focal length used to create the photo (APEX value). + "meteringMode": "A String", # Output only. The metering mode used to create the photo. + "rotation": 42, # Output only. The number of clockwise 90 degree rotations applied from the image's original orientation. + "sensor": "A String", # Output only. The type of sensor used to create the photo. + "subjectDistance": 42, # Output only. The distance to the subject of the photo, in meters. + "whiteBalance": "A String", # Output only. The white balance mode used to create the photo. + "width": 42, # Output only. The width of the image in pixels. + }, + "indexableText": { # Indexable text attributes for the file (can only be written) "text": "A String", # The text to be indexed for this file. }, - "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. - "kind": "drive#file", # The type of file. This is always drive#file. - "labelInfo": { # An overview of the labels on the file. - "labels": [ # The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned. - { # Representation of a label and its fields. - "fields": { # A map of the label's fields keyed by the field ID. - "a_key": { # Representation of a label field. + "isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app. + "kind": "drive#file", # Output only. The type of file. This is always `drive#file`. + "labelInfo": { # Output only. An overview of the labels on the file. + "labels": [ # 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. + { # Representation of a label and label fields. + "fields": { # A map of the fields on the label, keyed by the field's ID. + "a_key": { # Representation of field, which is a typed key-value pair. "dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD. "A String", ], - "id": "A String", # The identifier of this field. - "integer": [ # Only present if valueType is integer. + "id": "A String", # The identifier of this label field. + "integer": [ # Only present if `valueType` is `integer`. "A String", ], - "kind": "drive#labelField", # This is always drive#labelField. - "selection": [ # Only present if valueType is selection. + "kind": "drive#labelField", # This is always `drive#labelField`. + "selection": [ # Only present if `valueType` is `selection` "A String", ], - "text": [ # Only present if valueType is text. + "text": [ # Only present if `valueType` is `text`. "A String", ], - "user": [ # Only present if valueType is user. + "user": [ # Only present if `valueType` is `user`. { # Information about a Drive user. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, ], - "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: - # - dateString - # - integer - # - selection - # - text - # - user + "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: * `dateString` * `integer` * `selection` * `text` * `user` }, }, "id": "A String", # The ID of the label. - "kind": "drive#label", # This is always drive#label + "kind": "drive#label", # This is always `drive#label` "revisionId": "A String", # The revision ID of the label. }, ], }, "labels": { # A group of labels for the file. - "hidden": True or False, # Deprecated. - "modified": True or False, # Whether the file has been modified by this user. - "restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead. + "hidden": True or False, # Output only. Deprecated. + "modified": True or False, # Output only. Whether the file has been modified by this user. + "restricted": True or False, # Output only. Deprecated: Use `copyRequiresWriterPermission` instead. "starred": True or False, # Whether this file is starred by the user. - "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may 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. + "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files. "viewed": True or False, # Whether this file has been viewed by this user. }, - "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "lastModifyingUserName": "A String", # Name of the last user to modify this file. + "lastModifyingUserName": "A String", # Output only. Name of the last user to modify this file. "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp). "linkShareMetadata": { # Contains details about the link URLs that clients are using to refer to this item. - "securityUpdateEligible": True or False, # Whether the file is eligible for security update. - "securityUpdateEnabled": True or False, # Whether the security update is enabled for this file. + "securityUpdateEligible": True or False, # Output only. Whether the file is eligible for security update. + "securityUpdateEnabled": True or False, # Output only. Whether the security update is enabled for this file. }, "markedViewedByMeDate": "A String", # Deprecated. - "md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. + "md5Checksum": "A String", # Output only. An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. "mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type. "modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date. "modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set. - "openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used. + "openWithLinks": { # Output only. A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used. "a_key": "A String", }, - "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Google Drive. - "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives. - "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives. + "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the `title` field. This is only available for files with binary content in Google Drive. + "ownedByMe": True or False, # Output only. Whether the file is owned by the current user. Not populated for items in shared drives. + "ownerNames": [ # Output only. Name(s) of the owner(s) of this file. Not populated for items in shared drives. "A String", ], - "owners": [ # 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. + "owners": [ # 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. { # Information about a Drive user. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, ], - "parents": [ # Collection of parent folders which contain this file. - # If not specified as part of an insert 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 can also use the addParents and removeParents parameters to modify the parents list. + "parents": [ # Collection of parent folders which contain this file. If not specified as part of an insert 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 can also use the `addParents` and `removeParents` parameters to modify the parents list. { # A reference to a file's parent. "id": "A String", # The ID of the parent. - "isRoot": True or False, # Whether or not the parent is the root folder. - "kind": "drive#parentReference", # This is always drive#parentReference. - "parentLink": "A String", # A link to the parent. - "selfLink": "A String", # A link back to this reference. + "isRoot": True or False, # Output only. Whether or not the parent is the root folder. + "kind": "drive#parentReference", # Output only. This is always `drive#parentReference`. + "parentLink": "A String", # Output only. A link to the parent. + "selfLink": "A String", # Output only. A link back to this reference. }, ], - "permissionIds": [ # List of permission IDs for users with access to this file. + "permissionIds": [ # Output only. List of permission IDs for users with access to this file. "A String", ], - "permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives. + "permissions": [ # Output only. The list of permissions for users with access to this file. Not populated for items in shared drives. { # A permission for a file. - "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. + "additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future. "A String", ], - "authKey": "A String", # Deprecated. - "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. - "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain. - "emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group. - "etag": "A String", # The ETag of the permission. - "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - # - They cannot be set on shared drive items - # - They can only be set on user and group permissions - # - The date must be in the future - # - The date cannot be more than a year in the future - "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "kind": "drive#permission", # This is always drive#permission. - "name": "A String", # The name for this permission. - "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive. - "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "authKey": "A String", # Output only. Deprecated. + "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. + "domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`. + "emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`. + "etag": "A String", # Output only. The ETag of the permission. + "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests + "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "kind": "drive#permission", # Output only. This is always `drive#permission`. + "name": "A String", # Output only. The name for this permission. + "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. + "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. { - "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. + "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. - "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: - # - file - # - member - "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: - # - organizer - # - fileOrganizer - # - writer - # - reader + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` + "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, ], - "photoLink": "A String", # A link to the profile photo, if available. - "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: - # - owner - # - organizer - # - fileOrganizer - # - writer - # - reader - "selfLink": "A String", # A link back to this permission. - "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. + "photoLink": "A String", # Output only. A link to the profile photo, if available. + "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader` + "selfLink": "A String", # Output only. A link back to this permission. + "teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead. { - "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. + "additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead. "A String", ], - "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. - "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. - "role": "A String", # Deprecated - use permissionDetails/role instead. - "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. + "inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead. + "inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead. + "role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead. + "teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead. }, ], - "type": "A String", # The account type. Allowed values are: - # - user - # - group - # - domain - # - anyone - "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value. + "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` + "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. "withLink": True or False, # Whether the link is required for this permission. }, ], "properties": [ # The list of properties. - { # A key-value pair attached to a file that is either public or private to an application. - # The following limits apply to file properties: - # - Maximum of 100 properties total per file - # - Maximum of 30 private properties per app - # - Maximum of 30 public properties - # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property. - "etag": "A String", # ETag of the property. + { # A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property + "etag": "A String", # Output only. ETag of the property. "key": "A String", # The key of this property. - "kind": "drive#property", # This is always drive#property. - "selfLink": "A String", # The link back to this property. + "kind": "drive#property", # Output only. This is always `drive#property`. + "selfLink": "A String", # Output only. The link back to this property. "value": "A String", # The value of this property. - "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE). Private 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. + "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. Private 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. }, ], - "quotaBytesUsed": "A String", # The number of quota bytes used by this file. - "resourceKey": "A String", # A key needed to access the item via a shared link. - "selfLink": "A String", # A link back to this file. - "sha1Checksum": "A String", # The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "sha256Checksum": "A String", # The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "shareable": True or False, # Deprecated: use capabilities/canShare. - "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives. + "quotaBytesUsed": "A String", # Output only. The number of quota bytes used by this file. + "resourceKey": "A String", # Output only. A key needed to access the item via a shared link. + "selfLink": "A String", # Output only. A link back to this file. + "sha1Checksum": "A String", # 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 is not populated for Docs Editors or shortcut files. + "sha256Checksum": "A String", # 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 is not populated for Docs Editors or shortcut files. + "shareable": True or False, # Output only. Deprecated: Use `capabilities/canShare` instead. + "shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives. "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp). - "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "sharingUser": { # Information about a Drive user. # Output only. User that shared the item with the current user, if available. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut. + "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. "targetId": "A String", # The ID of the file that this shortcut points to. - "targetMimeType": "A String", # 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": "A String", # The ResourceKey for the target file. + "targetMimeType": "A String", # 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": "A String", # Output only. The ResourceKey for the target file. }, - "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'. + "spaces": [ # Output only. The list of spaces which contain the file. Supported values are `drive`, `appDataFolder` and `photos`. "A String", ], - "teamDriveId": "A String", # Deprecated - use driveId instead. + "teamDriveId": "A String", # Output only. Deprecated: Use `driveId` instead. "thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated. "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5. "mimeType": "A String", # The MIME type of the thumbnail. }, - "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. 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": "A String", # The thumbnail version for use in thumbnail cache invalidation. + "thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content. + "thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation. "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant. "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives. - "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "trashingUser": { # Information about a Drive user. # Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file. - "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. + "userPermission": { # A permission for a file. # Output only. The permissions for the authenticated user on this file. + "additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future. "A String", ], - "authKey": "A String", # Deprecated. - "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. - "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain. - "emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group. - "etag": "A String", # The ETag of the permission. - "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - # - They cannot be set on shared drive items - # - They can only be set on user and group permissions - # - The date must be in the future - # - The date cannot be more than a year in the future - "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "kind": "drive#permission", # This is always drive#permission. - "name": "A String", # The name for this permission. - "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive. - "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "authKey": "A String", # Output only. Deprecated. + "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. + "domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`. + "emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`. + "etag": "A String", # Output only. The ETag of the permission. + "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests + "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "kind": "drive#permission", # Output only. This is always `drive#permission`. + "name": "A String", # Output only. The name for this permission. + "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. + "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. { - "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. + "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. - "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: - # - file - # - member - "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: - # - organizer - # - fileOrganizer - # - writer - # - reader + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` + "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, ], - "photoLink": "A String", # A link to the profile photo, if available. - "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: - # - owner - # - organizer - # - fileOrganizer - # - writer - # - reader - "selfLink": "A String", # A link back to this permission. - "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. + "photoLink": "A String", # Output only. A link to the profile photo, if available. + "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader` + "selfLink": "A String", # Output only. A link back to this permission. + "teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead. { - "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. + "additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead. "A String", ], - "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. - "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. - "role": "A String", # Deprecated - use permissionDetails/role instead. - "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. + "inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead. + "inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead. + "role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead. + "teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead. }, ], - "type": "A String", # The account type. Allowed values are: - # - user - # - group - # - domain - # - anyone - "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value. + "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` + "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. "withLink": True or False, # Whether the link is required for this permission. }, - "version": "A String", # 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 requesting user. - "videoMediaMetadata": { # Metadata about video media. This will only be present for video types. - "durationMillis": "A String", # The duration of the video in milliseconds. - "height": 42, # The height of the video in pixels. - "width": 42, # The width of the video in pixels. + "version": "A String", # 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 requesting user. + "videoMediaMetadata": { # Output only. Metadata about video media. This will only be present for video types. + "durationMillis": "A String", # Output only. The duration of the video in milliseconds. + "height": 42, # Output only. The height of the video in pixels. + "width": 42, # Output only. The width of the video in pixels. }, - "webContentLink": "A String", # A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials. - "webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting. + "webContentLink": "A String", # Output only. A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials. + "webViewLink": "A String", # Output only. A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting. "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives. }
untrash(fileId, includeLabels=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None)
- Restores a file from the trash. The currently authenticated user must own the file or be at least a fileOrganizer on the parent for shared drive files. Only the owner may untrash a file. +untrash(fileId, includeLabels=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None)+Restores a file from the trash. The currently authenticated user must own the file or be at least a `fileOrganizer` on the parent for shared drive files. Only the owner may untrash a file. Args: fileId: string, The ID of the file to untrash. (required) - includeLabels: string, A comma-separated list of IDs of labels to include in the labelInfo part of the response. - includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported. + includeLabels: string, A comma-separated list of IDs of labels to include in the `labelInfo` part of the response. + includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only `published` is supported. supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. - supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead. + supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format Returns: An object of the form: { # The metadata for a file. - "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer. - "appDataContents": True or False, # Whether this file is in the Application Data folder. - "canComment": True or False, # Deprecated: use capabilities/canComment. - "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions. - "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. - "canAcceptOwnership": True or False, # Whether the current user is the pending owner of the file. Not populated for shared drive files. - "canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder. - "canAddFolderFromAnotherDrive": True or False, # 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 is not a folder. Only populated for items in shared drives. - "canAddMyDriveParent": True or False, # 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": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file. - "canChangeRestrictedDownload": True or False, # Deprecated - "canChangeSecurityUpdateEnabled": True or False, # Whether the current user can change the securityUpdateEnabled field on link share metadata. - "canComment": True or False, # Whether the current user can comment on this file. - "canCopy": True or False, # 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 is not a folder. - "canDelete": True or False, # Whether the current user can delete this file. - "canDeleteChildren": True or False, # Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. - "canDownload": True or False, # Whether the current user can download this file. - "canEdit": True or False, # 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. - "canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder. - "canModifyContent": True or False, # Whether the current user can modify the content of this file. - "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file. - "canModifyLabels": True or False, # Whether the current user can modify the labels on this file. - "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. - "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. - "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not 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. - "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead. - "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. - "canMoveItemOutOfDrive": True or False, # 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 is being added. - "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. - "canMoveItemWithinDrive": True or False, # 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 is being added and the parent that is being removed. - "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. - "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. - "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. - "canReadLabels": True or False, # Whether the current user can read the labels on this file. - "canReadRevisions": True or False, # 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 isn't a folder, can be read. - "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. - "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. - "canRemoveMyDriveParent": True or False, # 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": True or False, # Whether the current user can rename this file. - "canShare": True or False, # Whether the current user can modify the sharing settings for this file. - "canTrash": True or False, # Whether the current user can move this file to trash. - "canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. - "canUntrash": True or False, # Whether the current user can restore this file from trash. + "alternateLink": "A String", # Output only. A link for opening the file in a relevant Google editor or viewer. + "appDataContents": True or False, # Output only. Whether this file is in the Application Data folder. + "canComment": True or False, # Output only. Deprecated: Use `capabilities/canComment` instead. + "canReadRevisions": True or False, # Output only. Deprecated: Use `capabilities/canReadRevisions` instead. + "capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. + "canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files. + "canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always false when the item is not a folder. + "canAddFolderFromAnotherDrive": True or False, # 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 is not a folder. Only populated for items in shared drives. + "canAddMyDriveParent": True or False, # 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. + "canChangeCopyRequiresWriterPermission": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file. + "canChangeRestrictedDownload": True or False, # Output only. Deprecated. + "canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata. + "canComment": True or False, # Output only. Whether the current user can comment on this file. + "canCopy": True or False, # 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 itself if it is not a folder. + "canDelete": True or False, # Output only. Whether the current user can delete this file. + "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDownload": True or False, # Output only. Whether the current user can download this file. + "canEdit": True or False, # 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`. + "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. + "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. + "canModifyContentRestriction": True or False, # Output only. Whether the current user can modify restrictions on content of this file. + "canModifyLabels": True or False, # Output only. Whether the current user can modify the labels on the file. + "canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. + "canMoveChildrenOutOfTeamDrive": True or False, # Output only. Deprecated: Use `canMoveChildrenOutOfDrive` instead. + "canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is false when the item is not 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. + "canMoveChildrenWithinTeamDrive": True or False, # Output only. Deprecated: Use `canMoveChildrenWithinDrive` instead. + "canMoveItemIntoTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemOutOfDrive` instead. + "canMoveItemOutOfDrive": True or False, # 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 is being added. + "canMoveItemOutOfTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemOutOfDrive` instead. + "canMoveItemWithinDrive": True or False, # 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 is being added and the parent that is being removed. + "canMoveItemWithinTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemWithinDrive` instead. + "canMoveTeamDriveItem": True or False, # Output only. Deprecated: Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead. + "canReadDrive": True or False, # Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. + "canReadLabels": True or False, # Output only. Whether the current user can read the labels on the file. + "canReadRevisions": True or False, # 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 itself if it is not a folder, can be read. + "canReadTeamDrive": True or False, # Output only. Deprecated: Use `canReadDrive` instead. + "canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead. + "canRemoveMyDriveParent": True or False, # 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. + "canRename": True or False, # Output only. Whether the current user can rename this file. + "canShare": True or False, # Output only. Whether the current user can modify the sharing settings for this file. + "canTrash": True or False, # Output only. Whether the current user can move this file to trash. + "canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists. { # A restriction for accessing the content of the file. "readOnly": True or False, # 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": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true. - "restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`. + "restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly` is true. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, "restrictionDate": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true. - "type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction. + "type": "A String", # Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`. }, ], "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters. - "copyable": True or False, # Deprecated: use capabilities/canCopy. + "copyable": True or False, # Output only. Deprecated: Use `capabilities/canCopy` instead. "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp). - "defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used. + "defaultOpenWithLink": "A String", # Output only. A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used. "description": "A String", # A short description of the file. - "downloadUrl": "A String", # Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives. - "editable": True or False, # Deprecated: use capabilities/canEdit. - "embedLink": "A String", # A link for embedding the file. - "etag": "A String", # ETag of the file. - "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. - "exportLinks": { # Links for exporting Docs Editors files to specific formats. - "a_key": "A String", # A mapping from export format to URL - }, - "fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "fileSize": "A String", # 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 is not populated for shortcuts or folders. + "downloadUrl": "A String", # Output only. Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. + "driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives. + "editable": True or False, # Output only. Deprecated: Use `capabilities/canEdit` instead. + "embedLink": "A String", # Output only. A link for embedding the file. + "etag": "A String", # Output only. ETag of the file. + "explicitlyTrashed": True or False, # Output only. Whether this file has been explicitly trashed, as opposed to recursively trashed. + "exportLinks": { # Output only. Links for exporting Docs Editors files to specific formats. + "a_key": "A String", + }, + "fileExtension": "A String", # Output only. The final component of `fullFileExtension` with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "fileSize": "A String", # Output only. Size in bytes of blobs and first party editor files. Won't be populated for files that have no size, like shortcuts and folders. "folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder or a shortcut to a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette. - "fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives. - "hasThumbnail": True or False, # 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": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "iconLink": "A String", # A link to the file's icon. + "fullFileExtension": "A String", # Output only. The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "hasAugmentedPermissions": True or False, # Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives. + "hasThumbnail": True or False, # Output only. 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": "A String", # Output only. The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "iconLink": "A String", # Output only. A link to the file's icon. "id": "A String", # The ID of the file. - "imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content. - "aperture": 3.14, # The aperture used to create the photo (f-number). - "cameraMake": "A String", # The make of the camera used to create the photo. - "cameraModel": "A String", # The model of the camera used to create the photo. - "colorSpace": "A String", # The color space of the photo. - "date": "A String", # The date and time the photo was taken (EXIF format timestamp). - "exposureBias": 3.14, # The exposure bias of the photo (APEX value). - "exposureMode": "A String", # The exposure mode used to create the photo. - "exposureTime": 3.14, # The length of the exposure, in seconds. - "flashUsed": True or False, # Whether a flash was used to create the photo. - "focalLength": 3.14, # The focal length used to create the photo, in millimeters. - "height": 42, # The height of the image in pixels. - "isoSpeed": 42, # The ISO speed used to create the photo. - "lens": "A String", # The lens used to create the photo. - "location": { # Geographic location information stored in the image. - "altitude": 3.14, # The altitude stored in the image. - "latitude": 3.14, # The latitude stored in the image. - "longitude": 3.14, # The longitude stored in the image. + "imageMediaMetadata": { # Output only. Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content. + "aperture": 3.14, # Output only. The aperture used to create the photo (f-number). + "cameraMake": "A String", # Output only. The make of the camera used to create the photo. + "cameraModel": "A String", # Output only. The model of the camera used to create the photo. + "colorSpace": "A String", # Output only. The color space of the photo. + "date": "A String", # Output only. The date and time the photo was taken (EXIF format timestamp). + "exposureBias": 3.14, # Output only. The exposure bias of the photo (APEX value). + "exposureMode": "A String", # Output only. The exposure mode used to create the photo. + "exposureTime": 3.14, # Output only. The length of the exposure, in seconds. + "flashUsed": True or False, # Output only. Whether a flash was used to create the photo. + "focalLength": 3.14, # Output only. The focal length used to create the photo, in millimeters. + "height": 42, # Output only. The height of the image in pixels. + "isoSpeed": 42, # Output only. The ISO speed used to create the photo. + "lens": "A String", # Output only. The lens used to create the photo. + "location": { # Output only. Geographic location information stored in the image. + "altitude": 3.14, # Output only. The altitude stored in the image. + "latitude": 3.14, # Output only. The latitude stored in the image. + "longitude": 3.14, # Output only. The longitude stored in the image. }, - "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value). - "meteringMode": "A String", # The metering mode used to create the photo. - "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation. - "sensor": "A String", # The type of sensor used to create the photo. - "subjectDistance": 42, # The distance to the subject of the photo, in meters. - "whiteBalance": "A String", # The white balance mode used to create the photo. - "width": 42, # The width of the image in pixels. - }, - "indexableText": { # Indexable text attributes for the file (can only be written). For more information, see Manage file metadata. + "maxApertureValue": 3.14, # Output only. The smallest f-number of the lens at the focal length used to create the photo (APEX value). + "meteringMode": "A String", # Output only. The metering mode used to create the photo. + "rotation": 42, # Output only. The number of clockwise 90 degree rotations applied from the image's original orientation. + "sensor": "A String", # Output only. The type of sensor used to create the photo. + "subjectDistance": 42, # Output only. The distance to the subject of the photo, in meters. + "whiteBalance": "A String", # Output only. The white balance mode used to create the photo. + "width": 42, # Output only. The width of the image in pixels. + }, + "indexableText": { # Indexable text attributes for the file (can only be written) "text": "A String", # The text to be indexed for this file. }, - "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. - "kind": "drive#file", # The type of file. This is always drive#file. - "labelInfo": { # An overview of the labels on the file. - "labels": [ # The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned. - { # Representation of a label and its fields. - "fields": { # A map of the label's fields keyed by the field ID. - "a_key": { # Representation of a label field. + "isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app. + "kind": "drive#file", # Output only. The type of file. This is always `drive#file`. + "labelInfo": { # Output only. An overview of the labels on the file. + "labels": [ # 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. + { # Representation of a label and label fields. + "fields": { # A map of the fields on the label, keyed by the field's ID. + "a_key": { # Representation of field, which is a typed key-value pair. "dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD. "A String", ], - "id": "A String", # The identifier of this field. - "integer": [ # Only present if valueType is integer. + "id": "A String", # The identifier of this label field. + "integer": [ # Only present if `valueType` is `integer`. "A String", ], - "kind": "drive#labelField", # This is always drive#labelField. - "selection": [ # Only present if valueType is selection. + "kind": "drive#labelField", # This is always `drive#labelField`. + "selection": [ # Only present if `valueType` is `selection` "A String", ], - "text": [ # Only present if valueType is text. + "text": [ # Only present if `valueType` is `text`. "A String", ], - "user": [ # Only present if valueType is user. + "user": [ # Only present if `valueType` is `user`. { # Information about a Drive user. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, ], - "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: - # - dateString - # - integer - # - selection - # - text - # - user + "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: * `dateString` * `integer` * `selection` * `text` * `user` }, }, "id": "A String", # The ID of the label. - "kind": "drive#label", # This is always drive#label + "kind": "drive#label", # This is always `drive#label` "revisionId": "A String", # The revision ID of the label. }, ], }, "labels": { # A group of labels for the file. - "hidden": True or False, # Deprecated. - "modified": True or False, # Whether the file has been modified by this user. - "restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead. + "hidden": True or False, # Output only. Deprecated. + "modified": True or False, # Output only. Whether the file has been modified by this user. + "restricted": True or False, # Output only. Deprecated: Use `copyRequiresWriterPermission` instead. "starred": True or False, # Whether this file is starred by the user. - "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may 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. + "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files. "viewed": True or False, # Whether this file has been viewed by this user. }, - "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "lastModifyingUserName": "A String", # Name of the last user to modify this file. + "lastModifyingUserName": "A String", # Output only. Name of the last user to modify this file. "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp). "linkShareMetadata": { # Contains details about the link URLs that clients are using to refer to this item. - "securityUpdateEligible": True or False, # Whether the file is eligible for security update. - "securityUpdateEnabled": True or False, # Whether the security update is enabled for this file. + "securityUpdateEligible": True or False, # Output only. Whether the file is eligible for security update. + "securityUpdateEnabled": True or False, # Output only. Whether the security update is enabled for this file. }, "markedViewedByMeDate": "A String", # Deprecated. - "md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. + "md5Checksum": "A String", # Output only. An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. "mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type. "modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date. "modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set. - "openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used. + "openWithLinks": { # Output only. A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used. "a_key": "A String", }, - "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Google Drive. - "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives. - "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives. + "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the `title` field. This is only available for files with binary content in Google Drive. + "ownedByMe": True or False, # Output only. Whether the file is owned by the current user. Not populated for items in shared drives. + "ownerNames": [ # Output only. Name(s) of the owner(s) of this file. Not populated for items in shared drives. "A String", ], - "owners": [ # 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. + "owners": [ # 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. { # Information about a Drive user. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, ], - "parents": [ # Collection of parent folders which contain this file. - # If not specified as part of an insert 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 can also use the addParents and removeParents parameters to modify the parents list. + "parents": [ # Collection of parent folders which contain this file. If not specified as part of an insert 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 can also use the `addParents` and `removeParents` parameters to modify the parents list. { # A reference to a file's parent. "id": "A String", # The ID of the parent. - "isRoot": True or False, # Whether or not the parent is the root folder. - "kind": "drive#parentReference", # This is always drive#parentReference. - "parentLink": "A String", # A link to the parent. - "selfLink": "A String", # A link back to this reference. + "isRoot": True or False, # Output only. Whether or not the parent is the root folder. + "kind": "drive#parentReference", # Output only. This is always `drive#parentReference`. + "parentLink": "A String", # Output only. A link to the parent. + "selfLink": "A String", # Output only. A link back to this reference. }, ], - "permissionIds": [ # List of permission IDs for users with access to this file. + "permissionIds": [ # Output only. List of permission IDs for users with access to this file. "A String", ], - "permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives. + "permissions": [ # Output only. The list of permissions for users with access to this file. Not populated for items in shared drives. { # A permission for a file. - "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. + "additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future. "A String", ], - "authKey": "A String", # Deprecated. - "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. - "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain. - "emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group. - "etag": "A String", # The ETag of the permission. - "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - # - They cannot be set on shared drive items - # - They can only be set on user and group permissions - # - The date must be in the future - # - The date cannot be more than a year in the future - "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "kind": "drive#permission", # This is always drive#permission. - "name": "A String", # The name for this permission. - "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive. - "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "authKey": "A String", # Output only. Deprecated. + "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. + "domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`. + "emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`. + "etag": "A String", # Output only. The ETag of the permission. + "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests + "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "kind": "drive#permission", # Output only. This is always `drive#permission`. + "name": "A String", # Output only. The name for this permission. + "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. + "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. { - "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. + "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. - "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: - # - file - # - member - "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: - # - organizer - # - fileOrganizer - # - writer - # - reader + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` + "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, ], - "photoLink": "A String", # A link to the profile photo, if available. - "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: - # - owner - # - organizer - # - fileOrganizer - # - writer - # - reader - "selfLink": "A String", # A link back to this permission. - "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. + "photoLink": "A String", # Output only. A link to the profile photo, if available. + "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader` + "selfLink": "A String", # Output only. A link back to this permission. + "teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead. { - "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. + "additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead. "A String", ], - "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. - "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. - "role": "A String", # Deprecated - use permissionDetails/role instead. - "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. + "inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead. + "inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead. + "role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead. + "teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead. }, ], - "type": "A String", # The account type. Allowed values are: - # - user - # - group - # - domain - # - anyone - "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value. + "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` + "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. "withLink": True or False, # Whether the link is required for this permission. }, ], "properties": [ # The list of properties. - { # A key-value pair attached to a file that is either public or private to an application. - # The following limits apply to file properties: - # - Maximum of 100 properties total per file - # - Maximum of 30 private properties per app - # - Maximum of 30 public properties - # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property. - "etag": "A String", # ETag of the property. + { # A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property + "etag": "A String", # Output only. ETag of the property. "key": "A String", # The key of this property. - "kind": "drive#property", # This is always drive#property. - "selfLink": "A String", # The link back to this property. + "kind": "drive#property", # Output only. This is always `drive#property`. + "selfLink": "A String", # Output only. The link back to this property. "value": "A String", # The value of this property. - "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE). Private 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. + "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. Private 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. }, ], - "quotaBytesUsed": "A String", # The number of quota bytes used by this file. - "resourceKey": "A String", # A key needed to access the item via a shared link. - "selfLink": "A String", # A link back to this file. - "sha1Checksum": "A String", # The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "sha256Checksum": "A String", # The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "shareable": True or False, # Deprecated: use capabilities/canShare. - "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives. + "quotaBytesUsed": "A String", # Output only. The number of quota bytes used by this file. + "resourceKey": "A String", # Output only. A key needed to access the item via a shared link. + "selfLink": "A String", # Output only. A link back to this file. + "sha1Checksum": "A String", # 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 is not populated for Docs Editors or shortcut files. + "sha256Checksum": "A String", # 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 is not populated for Docs Editors or shortcut files. + "shareable": True or False, # Output only. Deprecated: Use `capabilities/canShare` instead. + "shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives. "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp). - "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "sharingUser": { # Information about a Drive user. # Output only. User that shared the item with the current user, if available. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut. + "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. "targetId": "A String", # The ID of the file that this shortcut points to. - "targetMimeType": "A String", # 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": "A String", # The ResourceKey for the target file. + "targetMimeType": "A String", # 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": "A String", # Output only. The ResourceKey for the target file. }, - "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'. + "spaces": [ # Output only. The list of spaces which contain the file. Supported values are `drive`, `appDataFolder` and `photos`. "A String", ], - "teamDriveId": "A String", # Deprecated - use driveId instead. + "teamDriveId": "A String", # Output only. Deprecated: Use `driveId` instead. "thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated. "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5. "mimeType": "A String", # The MIME type of the thumbnail. }, - "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. 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": "A String", # The thumbnail version for use in thumbnail cache invalidation. + "thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content. + "thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation. "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant. "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives. - "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "trashingUser": { # Information about a Drive user. # Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file. - "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. + "userPermission": { # A permission for a file. # Output only. The permissions for the authenticated user on this file. + "additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future. "A String", ], - "authKey": "A String", # Deprecated. - "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. - "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain. - "emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group. - "etag": "A String", # The ETag of the permission. - "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - # - They cannot be set on shared drive items - # - They can only be set on user and group permissions - # - The date must be in the future - # - The date cannot be more than a year in the future - "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "kind": "drive#permission", # This is always drive#permission. - "name": "A String", # The name for this permission. - "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive. - "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "authKey": "A String", # Output only. Deprecated. + "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. + "domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`. + "emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`. + "etag": "A String", # Output only. The ETag of the permission. + "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests + "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "kind": "drive#permission", # Output only. This is always `drive#permission`. + "name": "A String", # Output only. The name for this permission. + "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. + "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. { - "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. + "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. - "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: - # - file - # - member - "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: - # - organizer - # - fileOrganizer - # - writer - # - reader + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` + "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, ], - "photoLink": "A String", # A link to the profile photo, if available. - "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: - # - owner - # - organizer - # - fileOrganizer - # - writer - # - reader - "selfLink": "A String", # A link back to this permission. - "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. + "photoLink": "A String", # Output only. A link to the profile photo, if available. + "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader` + "selfLink": "A String", # Output only. A link back to this permission. + "teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead. { - "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. + "additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead. "A String", ], - "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. - "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. - "role": "A String", # Deprecated - use permissionDetails/role instead. - "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. + "inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead. + "inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead. + "role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead. + "teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead. }, ], - "type": "A String", # The account type. Allowed values are: - # - user - # - group - # - domain - # - anyone - "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value. + "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` + "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. "withLink": True or False, # Whether the link is required for this permission. }, - "version": "A String", # 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 requesting user. - "videoMediaMetadata": { # Metadata about video media. This will only be present for video types. - "durationMillis": "A String", # The duration of the video in milliseconds. - "height": 42, # The height of the video in pixels. - "width": 42, # The width of the video in pixels. + "version": "A String", # 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 requesting user. + "videoMediaMetadata": { # Output only. Metadata about video media. This will only be present for video types. + "durationMillis": "A String", # Output only. The duration of the video in milliseconds. + "height": 42, # Output only. The height of the video in pixels. + "width": 42, # Output only. The width of the video in pixels. }, - "webContentLink": "A String", # A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials. - "webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting. + "webContentLink": "A String", # Output only. A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials. + "webViewLink": "A String", # Output only. A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting. "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives. }
update(fileId, addParents=None, body=None, convert=None, enforceSingleParent=None, includeLabels=None, includePermissionsForView=None, media_body=None, media_mime_type=None, modifiedDateBehavior=None, newRevision=None, ocr=None, ocrLanguage=None, pinned=None, removeParents=None, setModifiedDate=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, updateViewedDate=None, useContentAsIndexableText=None)
- Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as modifiedDate. This method supports patch semantics. +update(fileId, addParents=None, body=None, convert=None, enforceSingleParent=None, includeLabels=None, includePermissionsForView=None, media_body=None, media_mime_type=None, modifiedDateBehavior=None, newRevision=None, ocr=None, ocrLanguage=None, pinned=None, removeParents=None, setModifiedDate=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, updateViewedDate=None, useContentAsIndexableText=None, x__xgafv=None)+Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as `modifiedDate`. This method supports patch semantics. This method supports an */upload* URI and accepts uploaded media with the following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media MIME types:*`*/*` Note: Specify a valid MIME type, rather than the literal `*/*` value. The literal `*/*` is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see [Upload file data](/drive/api/guides/manage-uploads). Args: fileId: string, The ID of the file to update. (required) @@ -5298,980 +4810,848 @@Method Details
The object takes the form of: { # The metadata for a file. - "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer. - "appDataContents": True or False, # Whether this file is in the Application Data folder. - "canComment": True or False, # Deprecated: use capabilities/canComment. - "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions. - "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. - "canAcceptOwnership": True or False, # Whether the current user is the pending owner of the file. Not populated for shared drive files. - "canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder. - "canAddFolderFromAnotherDrive": True or False, # 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 is not a folder. Only populated for items in shared drives. - "canAddMyDriveParent": True or False, # 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": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file. - "canChangeRestrictedDownload": True or False, # Deprecated - "canChangeSecurityUpdateEnabled": True or False, # Whether the current user can change the securityUpdateEnabled field on link share metadata. - "canComment": True or False, # Whether the current user can comment on this file. - "canCopy": True or False, # 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 is not a folder. - "canDelete": True or False, # Whether the current user can delete this file. - "canDeleteChildren": True or False, # Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. - "canDownload": True or False, # Whether the current user can download this file. - "canEdit": True or False, # 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. - "canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder. - "canModifyContent": True or False, # Whether the current user can modify the content of this file. - "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file. - "canModifyLabels": True or False, # Whether the current user can modify the labels on this file. - "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. - "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. - "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not 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. - "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead. - "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. - "canMoveItemOutOfDrive": True or False, # 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 is being added. - "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. - "canMoveItemWithinDrive": True or False, # 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 is being added and the parent that is being removed. - "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. - "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. - "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. - "canReadLabels": True or False, # Whether the current user can read the labels on this file. - "canReadRevisions": True or False, # 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 isn't a folder, can be read. - "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. - "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. - "canRemoveMyDriveParent": True or False, # 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": True or False, # Whether the current user can rename this file. - "canShare": True or False, # Whether the current user can modify the sharing settings for this file. - "canTrash": True or False, # Whether the current user can move this file to trash. - "canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. - "canUntrash": True or False, # Whether the current user can restore this file from trash. + "alternateLink": "A String", # Output only. A link for opening the file in a relevant Google editor or viewer. + "appDataContents": True or False, # Output only. Whether this file is in the Application Data folder. + "canComment": True or False, # Output only. Deprecated: Use `capabilities/canComment` instead. + "canReadRevisions": True or False, # Output only. Deprecated: Use `capabilities/canReadRevisions` instead. + "capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. + "canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files. + "canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always false when the item is not a folder. + "canAddFolderFromAnotherDrive": True or False, # 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 is not a folder. Only populated for items in shared drives. + "canAddMyDriveParent": True or False, # 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. + "canChangeCopyRequiresWriterPermission": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file. + "canChangeRestrictedDownload": True or False, # Output only. Deprecated. + "canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata. + "canComment": True or False, # Output only. Whether the current user can comment on this file. + "canCopy": True or False, # 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 itself if it is not a folder. + "canDelete": True or False, # Output only. Whether the current user can delete this file. + "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDownload": True or False, # Output only. Whether the current user can download this file. + "canEdit": True or False, # 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`. + "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. + "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. + "canModifyContentRestriction": True or False, # Output only. Whether the current user can modify restrictions on content of this file. + "canModifyLabels": True or False, # Output only. Whether the current user can modify the labels on the file. + "canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. + "canMoveChildrenOutOfTeamDrive": True or False, # Output only. Deprecated: Use `canMoveChildrenOutOfDrive` instead. + "canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is false when the item is not 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. + "canMoveChildrenWithinTeamDrive": True or False, # Output only. Deprecated: Use `canMoveChildrenWithinDrive` instead. + "canMoveItemIntoTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemOutOfDrive` instead. + "canMoveItemOutOfDrive": True or False, # 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 is being added. + "canMoveItemOutOfTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemOutOfDrive` instead. + "canMoveItemWithinDrive": True or False, # 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 is being added and the parent that is being removed. + "canMoveItemWithinTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemWithinDrive` instead. + "canMoveTeamDriveItem": True or False, # Output only. Deprecated: Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead. + "canReadDrive": True or False, # Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. + "canReadLabels": True or False, # Output only. Whether the current user can read the labels on the file. + "canReadRevisions": True or False, # 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 itself if it is not a folder, can be read. + "canReadTeamDrive": True or False, # Output only. Deprecated: Use `canReadDrive` instead. + "canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead. + "canRemoveMyDriveParent": True or False, # 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. + "canRename": True or False, # Output only. Whether the current user can rename this file. + "canShare": True or False, # Output only. Whether the current user can modify the sharing settings for this file. + "canTrash": True or False, # Output only. Whether the current user can move this file to trash. + "canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists. { # A restriction for accessing the content of the file. "readOnly": True or False, # 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": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true. - "restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`. + "restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly` is true. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, "restrictionDate": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true. - "type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction. + "type": "A String", # Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`. }, ], "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters. - "copyable": True or False, # Deprecated: use capabilities/canCopy. + "copyable": True or False, # Output only. Deprecated: Use `capabilities/canCopy` instead. "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp). - "defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used. + "defaultOpenWithLink": "A String", # Output only. A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used. "description": "A String", # A short description of the file. - "downloadUrl": "A String", # Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives. - "editable": True or False, # Deprecated: use capabilities/canEdit. - "embedLink": "A String", # A link for embedding the file. - "etag": "A String", # ETag of the file. - "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. - "exportLinks": { # Links for exporting Docs Editors files to specific formats. - "a_key": "A String", # A mapping from export format to URL - }, - "fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "fileSize": "A String", # 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 is not populated for shortcuts or folders. + "downloadUrl": "A String", # Output only. Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. + "driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives. + "editable": True or False, # Output only. Deprecated: Use `capabilities/canEdit` instead. + "embedLink": "A String", # Output only. A link for embedding the file. + "etag": "A String", # Output only. ETag of the file. + "explicitlyTrashed": True or False, # Output only. Whether this file has been explicitly trashed, as opposed to recursively trashed. + "exportLinks": { # Output only. Links for exporting Docs Editors files to specific formats. + "a_key": "A String", + }, + "fileExtension": "A String", # Output only. The final component of `fullFileExtension` with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "fileSize": "A String", # Output only. Size in bytes of blobs and first party editor files. Won't be populated for files that have no size, like shortcuts and folders. "folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder or a shortcut to a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette. - "fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives. - "hasThumbnail": True or False, # 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": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "iconLink": "A String", # A link to the file's icon. + "fullFileExtension": "A String", # Output only. The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "hasAugmentedPermissions": True or False, # Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives. + "hasThumbnail": True or False, # Output only. 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": "A String", # Output only. The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "iconLink": "A String", # Output only. A link to the file's icon. "id": "A String", # The ID of the file. - "imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content. - "aperture": 3.14, # The aperture used to create the photo (f-number). - "cameraMake": "A String", # The make of the camera used to create the photo. - "cameraModel": "A String", # The model of the camera used to create the photo. - "colorSpace": "A String", # The color space of the photo. - "date": "A String", # The date and time the photo was taken (EXIF format timestamp). - "exposureBias": 3.14, # The exposure bias of the photo (APEX value). - "exposureMode": "A String", # The exposure mode used to create the photo. - "exposureTime": 3.14, # The length of the exposure, in seconds. - "flashUsed": True or False, # Whether a flash was used to create the photo. - "focalLength": 3.14, # The focal length used to create the photo, in millimeters. - "height": 42, # The height of the image in pixels. - "isoSpeed": 42, # The ISO speed used to create the photo. - "lens": "A String", # The lens used to create the photo. - "location": { # Geographic location information stored in the image. - "altitude": 3.14, # The altitude stored in the image. - "latitude": 3.14, # The latitude stored in the image. - "longitude": 3.14, # The longitude stored in the image. + "imageMediaMetadata": { # Output only. Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content. + "aperture": 3.14, # Output only. The aperture used to create the photo (f-number). + "cameraMake": "A String", # Output only. The make of the camera used to create the photo. + "cameraModel": "A String", # Output only. The model of the camera used to create the photo. + "colorSpace": "A String", # Output only. The color space of the photo. + "date": "A String", # Output only. The date and time the photo was taken (EXIF format timestamp). + "exposureBias": 3.14, # Output only. The exposure bias of the photo (APEX value). + "exposureMode": "A String", # Output only. The exposure mode used to create the photo. + "exposureTime": 3.14, # Output only. The length of the exposure, in seconds. + "flashUsed": True or False, # Output only. Whether a flash was used to create the photo. + "focalLength": 3.14, # Output only. The focal length used to create the photo, in millimeters. + "height": 42, # Output only. The height of the image in pixels. + "isoSpeed": 42, # Output only. The ISO speed used to create the photo. + "lens": "A String", # Output only. The lens used to create the photo. + "location": { # Output only. Geographic location information stored in the image. + "altitude": 3.14, # Output only. The altitude stored in the image. + "latitude": 3.14, # Output only. The latitude stored in the image. + "longitude": 3.14, # Output only. The longitude stored in the image. }, - "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value). - "meteringMode": "A String", # The metering mode used to create the photo. - "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation. - "sensor": "A String", # The type of sensor used to create the photo. - "subjectDistance": 42, # The distance to the subject of the photo, in meters. - "whiteBalance": "A String", # The white balance mode used to create the photo. - "width": 42, # The width of the image in pixels. - }, - "indexableText": { # Indexable text attributes for the file (can only be written). For more information, see Manage file metadata. + "maxApertureValue": 3.14, # Output only. The smallest f-number of the lens at the focal length used to create the photo (APEX value). + "meteringMode": "A String", # Output only. The metering mode used to create the photo. + "rotation": 42, # Output only. The number of clockwise 90 degree rotations applied from the image's original orientation. + "sensor": "A String", # Output only. The type of sensor used to create the photo. + "subjectDistance": 42, # Output only. The distance to the subject of the photo, in meters. + "whiteBalance": "A String", # Output only. The white balance mode used to create the photo. + "width": 42, # Output only. The width of the image in pixels. + }, + "indexableText": { # Indexable text attributes for the file (can only be written) "text": "A String", # The text to be indexed for this file. }, - "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. - "kind": "drive#file", # The type of file. This is always drive#file. - "labelInfo": { # An overview of the labels on the file. - "labels": [ # The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned. - { # Representation of a label and its fields. - "fields": { # A map of the label's fields keyed by the field ID. - "a_key": { # Representation of a label field. + "isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app. + "kind": "drive#file", # Output only. The type of file. This is always `drive#file`. + "labelInfo": { # Output only. An overview of the labels on the file. + "labels": [ # 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. + { # Representation of a label and label fields. + "fields": { # A map of the fields on the label, keyed by the field's ID. + "a_key": { # Representation of field, which is a typed key-value pair. "dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD. "A String", ], - "id": "A String", # The identifier of this field. - "integer": [ # Only present if valueType is integer. + "id": "A String", # The identifier of this label field. + "integer": [ # Only present if `valueType` is `integer`. "A String", ], - "kind": "drive#labelField", # This is always drive#labelField. - "selection": [ # Only present if valueType is selection. + "kind": "drive#labelField", # This is always `drive#labelField`. + "selection": [ # Only present if `valueType` is `selection` "A String", ], - "text": [ # Only present if valueType is text. + "text": [ # Only present if `valueType` is `text`. "A String", ], - "user": [ # Only present if valueType is user. + "user": [ # Only present if `valueType` is `user`. { # Information about a Drive user. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, ], - "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: - # - dateString - # - integer - # - selection - # - text - # - user + "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: * `dateString` * `integer` * `selection` * `text` * `user` }, }, "id": "A String", # The ID of the label. - "kind": "drive#label", # This is always drive#label + "kind": "drive#label", # This is always `drive#label` "revisionId": "A String", # The revision ID of the label. }, ], }, "labels": { # A group of labels for the file. - "hidden": True or False, # Deprecated. - "modified": True or False, # Whether the file has been modified by this user. - "restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead. + "hidden": True or False, # Output only. Deprecated. + "modified": True or False, # Output only. Whether the file has been modified by this user. + "restricted": True or False, # Output only. Deprecated: Use `copyRequiresWriterPermission` instead. "starred": True or False, # Whether this file is starred by the user. - "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may 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. + "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files. "viewed": True or False, # Whether this file has been viewed by this user. }, - "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "lastModifyingUserName": "A String", # Name of the last user to modify this file. + "lastModifyingUserName": "A String", # Output only. Name of the last user to modify this file. "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp). "linkShareMetadata": { # Contains details about the link URLs that clients are using to refer to this item. - "securityUpdateEligible": True or False, # Whether the file is eligible for security update. - "securityUpdateEnabled": True or False, # Whether the security update is enabled for this file. + "securityUpdateEligible": True or False, # Output only. Whether the file is eligible for security update. + "securityUpdateEnabled": True or False, # Output only. Whether the security update is enabled for this file. }, "markedViewedByMeDate": "A String", # Deprecated. - "md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. + "md5Checksum": "A String", # Output only. An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. "mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type. "modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date. "modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set. - "openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used. + "openWithLinks": { # Output only. A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used. "a_key": "A String", }, - "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Google Drive. - "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives. - "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives. + "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the `title` field. This is only available for files with binary content in Google Drive. + "ownedByMe": True or False, # Output only. Whether the file is owned by the current user. Not populated for items in shared drives. + "ownerNames": [ # Output only. Name(s) of the owner(s) of this file. Not populated for items in shared drives. "A String", ], - "owners": [ # 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. + "owners": [ # 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. { # Information about a Drive user. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, ], - "parents": [ # Collection of parent folders which contain this file. - # If not specified as part of an insert 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 can also use the addParents and removeParents parameters to modify the parents list. + "parents": [ # Collection of parent folders which contain this file. If not specified as part of an insert 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 can also use the `addParents` and `removeParents` parameters to modify the parents list. { # A reference to a file's parent. "id": "A String", # The ID of the parent. - "isRoot": True or False, # Whether or not the parent is the root folder. - "kind": "drive#parentReference", # This is always drive#parentReference. - "parentLink": "A String", # A link to the parent. - "selfLink": "A String", # A link back to this reference. + "isRoot": True or False, # Output only. Whether or not the parent is the root folder. + "kind": "drive#parentReference", # Output only. This is always `drive#parentReference`. + "parentLink": "A String", # Output only. A link to the parent. + "selfLink": "A String", # Output only. A link back to this reference. }, ], - "permissionIds": [ # List of permission IDs for users with access to this file. + "permissionIds": [ # Output only. List of permission IDs for users with access to this file. "A String", ], - "permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives. + "permissions": [ # Output only. The list of permissions for users with access to this file. Not populated for items in shared drives. { # A permission for a file. - "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. + "additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future. "A String", ], - "authKey": "A String", # Deprecated. - "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. - "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain. - "emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group. - "etag": "A String", # The ETag of the permission. - "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - # - They cannot be set on shared drive items - # - They can only be set on user and group permissions - # - The date must be in the future - # - The date cannot be more than a year in the future - "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "kind": "drive#permission", # This is always drive#permission. - "name": "A String", # The name for this permission. - "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive. - "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "authKey": "A String", # Output only. Deprecated. + "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. + "domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`. + "emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`. + "etag": "A String", # Output only. The ETag of the permission. + "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests + "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "kind": "drive#permission", # Output only. This is always `drive#permission`. + "name": "A String", # Output only. The name for this permission. + "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. + "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. { - "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. + "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. - "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: - # - file - # - member - "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: - # - organizer - # - fileOrganizer - # - writer - # - reader + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` + "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, ], - "photoLink": "A String", # A link to the profile photo, if available. - "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: - # - owner - # - organizer - # - fileOrganizer - # - writer - # - reader - "selfLink": "A String", # A link back to this permission. - "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. + "photoLink": "A String", # Output only. A link to the profile photo, if available. + "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader` + "selfLink": "A String", # Output only. A link back to this permission. + "teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead. { - "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. + "additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead. "A String", ], - "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. - "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. - "role": "A String", # Deprecated - use permissionDetails/role instead. - "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. + "inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead. + "inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead. + "role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead. + "teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead. }, ], - "type": "A String", # The account type. Allowed values are: - # - user - # - group - # - domain - # - anyone - "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value. + "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` + "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. "withLink": True or False, # Whether the link is required for this permission. }, ], "properties": [ # The list of properties. - { # A key-value pair attached to a file that is either public or private to an application. - # The following limits apply to file properties: - # - Maximum of 100 properties total per file - # - Maximum of 30 private properties per app - # - Maximum of 30 public properties - # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property. - "etag": "A String", # ETag of the property. + { # A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property + "etag": "A String", # Output only. ETag of the property. "key": "A String", # The key of this property. - "kind": "drive#property", # This is always drive#property. - "selfLink": "A String", # The link back to this property. + "kind": "drive#property", # Output only. This is always `drive#property`. + "selfLink": "A String", # Output only. The link back to this property. "value": "A String", # The value of this property. - "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE). Private 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. + "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. Private 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. }, ], - "quotaBytesUsed": "A String", # The number of quota bytes used by this file. - "resourceKey": "A String", # A key needed to access the item via a shared link. - "selfLink": "A String", # A link back to this file. - "sha1Checksum": "A String", # The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "sha256Checksum": "A String", # The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "shareable": True or False, # Deprecated: use capabilities/canShare. - "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives. + "quotaBytesUsed": "A String", # Output only. The number of quota bytes used by this file. + "resourceKey": "A String", # Output only. A key needed to access the item via a shared link. + "selfLink": "A String", # Output only. A link back to this file. + "sha1Checksum": "A String", # 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 is not populated for Docs Editors or shortcut files. + "sha256Checksum": "A String", # 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 is not populated for Docs Editors or shortcut files. + "shareable": True or False, # Output only. Deprecated: Use `capabilities/canShare` instead. + "shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives. "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp). - "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "sharingUser": { # Information about a Drive user. # Output only. User that shared the item with the current user, if available. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut. + "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. "targetId": "A String", # The ID of the file that this shortcut points to. - "targetMimeType": "A String", # 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": "A String", # The ResourceKey for the target file. + "targetMimeType": "A String", # 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": "A String", # Output only. The ResourceKey for the target file. }, - "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'. + "spaces": [ # Output only. The list of spaces which contain the file. Supported values are `drive`, `appDataFolder` and `photos`. "A String", ], - "teamDriveId": "A String", # Deprecated - use driveId instead. + "teamDriveId": "A String", # Output only. Deprecated: Use `driveId` instead. "thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated. "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5. "mimeType": "A String", # The MIME type of the thumbnail. }, - "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. 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": "A String", # The thumbnail version for use in thumbnail cache invalidation. + "thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content. + "thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation. "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant. "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives. - "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "trashingUser": { # Information about a Drive user. # Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file. - "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. + "userPermission": { # A permission for a file. # Output only. The permissions for the authenticated user on this file. + "additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future. "A String", ], - "authKey": "A String", # Deprecated. - "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. - "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain. - "emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group. - "etag": "A String", # The ETag of the permission. - "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - # - They cannot be set on shared drive items - # - They can only be set on user and group permissions - # - The date must be in the future - # - The date cannot be more than a year in the future - "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "kind": "drive#permission", # This is always drive#permission. - "name": "A String", # The name for this permission. - "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive. - "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "authKey": "A String", # Output only. Deprecated. + "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. + "domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`. + "emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`. + "etag": "A String", # Output only. The ETag of the permission. + "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests + "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "kind": "drive#permission", # Output only. This is always `drive#permission`. + "name": "A String", # Output only. The name for this permission. + "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. + "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. { - "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. + "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. - "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: - # - file - # - member - "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: - # - organizer - # - fileOrganizer - # - writer - # - reader + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` + "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, ], - "photoLink": "A String", # A link to the profile photo, if available. - "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: - # - owner - # - organizer - # - fileOrganizer - # - writer - # - reader - "selfLink": "A String", # A link back to this permission. - "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. + "photoLink": "A String", # Output only. A link to the profile photo, if available. + "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader` + "selfLink": "A String", # Output only. A link back to this permission. + "teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead. { - "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. + "additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead. "A String", ], - "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. - "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. - "role": "A String", # Deprecated - use permissionDetails/role instead. - "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. + "inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead. + "inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead. + "role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead. + "teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead. }, ], - "type": "A String", # The account type. Allowed values are: - # - user - # - group - # - domain - # - anyone - "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value. + "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` + "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. "withLink": True or False, # Whether the link is required for this permission. }, - "version": "A String", # 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 requesting user. - "videoMediaMetadata": { # Metadata about video media. This will only be present for video types. - "durationMillis": "A String", # The duration of the video in milliseconds. - "height": 42, # The height of the video in pixels. - "width": 42, # The width of the video in pixels. + "version": "A String", # 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 requesting user. + "videoMediaMetadata": { # Output only. Metadata about video media. This will only be present for video types. + "durationMillis": "A String", # Output only. The duration of the video in milliseconds. + "height": 42, # Output only. The height of the video in pixels. + "width": 42, # Output only. The width of the video in pixels. }, - "webContentLink": "A String", # A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials. - "webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting. + "webContentLink": "A String", # Output only. A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials. + "webViewLink": "A String", # Output only. A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting. "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives. } addParents: string, Comma-separated list of parent IDs to add. - convert: boolean, This parameter is deprecated and has no function. - enforceSingleParent: boolean, Deprecated. Adding files to multiple folders is no longer supported. Use shortcuts instead. - includeLabels: string, A comma-separated list of IDs of labels to include in the labelInfo part of the response. - includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported. + convert: boolean, Deprecated: This parameter has no function. + enforceSingleParent: boolean, Deprecated: Adding files to multiple folders is no longer supported. Use `shortcuts` instead. + includeLabels: string, A comma-separated list of IDs of labels to include in the `labelInfo` part of the response. + includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only `published` is supported. media_body: string, The filename of the media request body, or an instance of a MediaUpload object. media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object. - modifiedDateBehavior: string, Determines the behavior in which modifiedDate is updated. This overrides setModifiedDate. + modifiedDateBehavior: string, Determines the behavior in which `modifiedDate` is updated. This overrides `setModifiedDate`. Allowed values - fromBody - Set modifiedDate to the value provided in the body of the request. No change if no value was provided. - fromBodyIfNeeded - Set modifiedDate to the value provided in the body of the request depending on other contents of the update. + fromBody - Set `modifiedDate` to the value provided in the body of the request. No change if no value was provided. + fromBodyIfNeeded - Set `modifiedDate` to the value provided in the body of the request depending on other contents of the update. fromBodyOrNow - Set modifiedDate to the value provided in the body of the request, or to the current time if no value was provided. - noChange - Maintain the previous value of modifiedDate. - now - Set modifiedDate to the current time. - nowIfNeeded - Set modifiedDate to the current time depending on contents of the update. - newRevision: boolean, Whether a blob upload should create a new revision. If false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous unpinned revisions are preserved for a short period of time. Pinned revisions are stored indefinitely, using additional storage quota, up to a maximum of 200 revisions. For details on how revisions are retained, see the Drive Help Center. Note that this field is ignored if there is no payload in the request. + noChange - Maintain the previous value of `modifiedDate`. + now - Set `modifiedDate` to the current time. + nowIfNeeded - Set `modifiedDate` to the current time depending on contents of the update. + newRevision: boolean, Whether a blob upload should create a new revision. If false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous unpinned revisions are preserved for a short period of time. Pinned revisions are stored indefinitely, using additional storage quota, up to a maximum of 200 revisions. For details on how revisions are retained, see the [Drive Help Center](https://support.google.com/drive/answer/2409045). ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads. ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are BCP 47 codes. - pinned: boolean, Whether to pin the new revision. A file can have a maximum of 200 pinned revisions. Note that this field is ignored if there is no payload in the request. + pinned: boolean, Whether to pin the new revision. A file can have a maximum of 200 pinned revisions. removeParents: string, Comma-separated list of parent IDs to remove. - setModifiedDate: boolean, Whether to set the modified date using the value supplied in the request body. Setting this field to true is equivalent to modifiedDateBehavior=fromBodyOrNow, and false is equivalent to modifiedDateBehavior=now. To prevent any changes to the modified date set modifiedDateBehavior=noChange. + setModifiedDate: boolean, Whether to set the modified date using the value supplied in the request body. Setting this field to `true` is equivalent to `modifiedDateBehavior=fromBodyOrNow`, and `false` is equivalent to `modifiedDateBehavior=now`. To prevent any changes to the modified date set `modifiedDateBehavior=noChange`. supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. - supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead. + supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead. timedTextLanguage: string, The language of the timed text. timedTextTrackName: string, The timed text track name. updateViewedDate: boolean, Whether to update the view date after successfully updating the file. useContentAsIndexableText: boolean, Whether to use the content as indexable text. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format Returns: An object of the form: { # The metadata for a file. - "alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer. - "appDataContents": True or False, # Whether this file is in the Application Data folder. - "canComment": True or False, # Deprecated: use capabilities/canComment. - "canReadRevisions": True or False, # Deprecated: use capabilities/canReadRevisions. - "capabilities": { # Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. - "canAcceptOwnership": True or False, # Whether the current user is the pending owner of the file. Not populated for shared drive files. - "canAddChildren": True or False, # Whether the current user can add children to this folder. This is always false when the item is not a folder. - "canAddFolderFromAnotherDrive": True or False, # 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 is not a folder. Only populated for items in shared drives. - "canAddMyDriveParent": True or False, # 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": True or False, # Whether the current user can change the copyRequiresWriterPermission restriction of this file. - "canChangeRestrictedDownload": True or False, # Deprecated - "canChangeSecurityUpdateEnabled": True or False, # Whether the current user can change the securityUpdateEnabled field on link share metadata. - "canComment": True or False, # Whether the current user can comment on this file. - "canCopy": True or False, # 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 is not a folder. - "canDelete": True or False, # Whether the current user can delete this file. - "canDeleteChildren": True or False, # Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. - "canDownload": True or False, # Whether the current user can download this file. - "canEdit": True or False, # 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. - "canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder. - "canModifyContent": True or False, # Whether the current user can modify the content of this file. - "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file. - "canModifyLabels": True or False, # Whether the current user can modify the labels on this file. - "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. - "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. - "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not 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. - "canMoveChildrenWithinTeamDrive": True or False, # Deprecated - use canMoveChildrenWithinDrive instead. - "canMoveItemIntoTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. - "canMoveItemOutOfDrive": True or False, # 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 is being added. - "canMoveItemOutOfTeamDrive": True or False, # Deprecated - use canMoveItemOutOfDrive instead. - "canMoveItemWithinDrive": True or False, # 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 is being added and the parent that is being removed. - "canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. - "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. - "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. - "canReadLabels": True or False, # Whether the current user can read the labels on this file. - "canReadRevisions": True or False, # 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 isn't a folder, can be read. - "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. - "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. - "canRemoveMyDriveParent": True or False, # 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": True or False, # Whether the current user can rename this file. - "canShare": True or False, # Whether the current user can modify the sharing settings for this file. - "canTrash": True or False, # Whether the current user can move this file to trash. - "canTrashChildren": True or False, # Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. - "canUntrash": True or False, # Whether the current user can restore this file from trash. + "alternateLink": "A String", # Output only. A link for opening the file in a relevant Google editor or viewer. + "appDataContents": True or False, # Output only. Whether this file is in the Application Data folder. + "canComment": True or False, # Output only. Deprecated: Use `capabilities/canComment` instead. + "canReadRevisions": True or False, # Output only. Deprecated: Use `capabilities/canReadRevisions` instead. + "capabilities": { # Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. + "canAcceptOwnership": True or False, # Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files. + "canAddChildren": True or False, # Output only. Whether the current user can add children to this folder. This is always false when the item is not a folder. + "canAddFolderFromAnotherDrive": True or False, # 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 is not a folder. Only populated for items in shared drives. + "canAddMyDriveParent": True or False, # 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. + "canChangeCopyRequiresWriterPermission": True or False, # Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction of this file. + "canChangeRestrictedDownload": True or False, # Output only. Deprecated. + "canChangeSecurityUpdateEnabled": True or False, # Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata. + "canComment": True or False, # Output only. Whether the current user can comment on this file. + "canCopy": True or False, # 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 itself if it is not a folder. + "canDelete": True or False, # Output only. Whether the current user can delete this file. + "canDeleteChildren": True or False, # Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canDownload": True or False, # Output only. Whether the current user can download this file. + "canEdit": True or False, # 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`. + "canListChildren": True or False, # Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. + "canModifyContent": True or False, # Output only. Whether the current user can modify the content of this file. + "canModifyContentRestriction": True or False, # Output only. Whether the current user can modify restrictions on content of this file. + "canModifyLabels": True or False, # Output only. Whether the current user can modify the labels on the file. + "canMoveChildrenOutOfDrive": True or False, # Output only. Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. + "canMoveChildrenOutOfTeamDrive": True or False, # Output only. Deprecated: Use `canMoveChildrenOutOfDrive` instead. + "canMoveChildrenWithinDrive": True or False, # Output only. Whether the current user can move children of this folder within this drive. This is false when the item is not 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. + "canMoveChildrenWithinTeamDrive": True or False, # Output only. Deprecated: Use `canMoveChildrenWithinDrive` instead. + "canMoveItemIntoTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemOutOfDrive` instead. + "canMoveItemOutOfDrive": True or False, # 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 is being added. + "canMoveItemOutOfTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemOutOfDrive` instead. + "canMoveItemWithinDrive": True or False, # 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 is being added and the parent that is being removed. + "canMoveItemWithinTeamDrive": True or False, # Output only. Deprecated: Use `canMoveItemWithinDrive` instead. + "canMoveTeamDriveItem": True or False, # Output only. Deprecated: Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead. + "canReadDrive": True or False, # Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. + "canReadLabels": True or False, # Output only. Whether the current user can read the labels on the file. + "canReadRevisions": True or False, # 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 itself if it is not a folder, can be read. + "canReadTeamDrive": True or False, # Output only. Deprecated: Use `canReadDrive` instead. + "canRemoveChildren": True or False, # Output only. Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use `canDeleteChildren` or `canTrashChildren` instead. + "canRemoveMyDriveParent": True or False, # 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. + "canRename": True or False, # Output only. Whether the current user can rename this file. + "canShare": True or False, # Output only. Whether the current user can modify the sharing settings for this file. + "canTrash": True or False, # Output only. Whether the current user can move this file to trash. + "canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. + "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists. { # A restriction for accessing the content of the file. "readOnly": True or False, # 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": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true. - "restrictingUser": { # Information about a Drive user. # The user who set the content restriction. Only populated if readOnly is true. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "reason": "A String", # Reason for why the content of the file is restricted. This is only mutable on requests that also set `readOnly=true`. + "restrictingUser": { # Information about a Drive user. # Output only. The user who set the content restriction. Only populated if `readOnly` is true. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, "restrictionDate": "A String", # The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true. - "type": "A String", # The type of the content restriction. Currently the only possible value is globalContentRestriction. + "type": "A String", # Output only. The type of the content restriction. Currently the only possible value is `globalContentRestriction`. }, ], "copyRequiresWriterPermission": True or False, # Whether the options to copy, print, or download this file, should be disabled for readers and commenters. - "copyable": True or False, # Deprecated: use capabilities/canCopy. + "copyable": True or False, # Output only. Deprecated: Use `capabilities/canCopy` instead. "createdDate": "A String", # Create time for this file (formatted RFC 3339 timestamp). - "defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used. + "defaultOpenWithLink": "A String", # Output only. A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used. "description": "A String", # A short description of the file. - "downloadUrl": "A String", # Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "driveId": "A String", # ID of the shared drive the file resides in. Only populated for items in shared drives. - "editable": True or False, # Deprecated: use capabilities/canEdit. - "embedLink": "A String", # A link for embedding the file. - "etag": "A String", # ETag of the file. - "explicitlyTrashed": True or False, # Whether this file has been explicitly trashed, as opposed to recursively trashed. - "exportLinks": { # Links for exporting Docs Editors files to specific formats. - "a_key": "A String", # A mapping from export format to URL - }, - "fileExtension": "A String", # The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "fileSize": "A String", # 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 is not populated for shortcuts or folders. + "downloadUrl": "A String", # Output only. Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files. + "driveId": "A String", # Output only. ID of the shared drive the file resides in. Only populated for items in shared drives. + "editable": True or False, # Output only. Deprecated: Use `capabilities/canEdit` instead. + "embedLink": "A String", # Output only. A link for embedding the file. + "etag": "A String", # Output only. ETag of the file. + "explicitlyTrashed": True or False, # Output only. Whether this file has been explicitly trashed, as opposed to recursively trashed. + "exportLinks": { # Output only. Links for exporting Docs Editors files to specific formats. + "a_key": "A String", + }, + "fileExtension": "A String", # Output only. The final component of `fullFileExtension` with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "fileSize": "A String", # Output only. Size in bytes of blobs and first party editor files. Won't be populated for files that have no size, like shortcuts and folders. "folderColorRgb": "A String", # Folder color as an RGB hex string if the file is a folder or a shortcut to a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette. - "fullFileExtension": "A String", # The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "hasAugmentedPermissions": True or False, # Whether there are permissions directly on this file. This field is only populated for items in shared drives. - "hasThumbnail": True or False, # 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": "A String", # The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "iconLink": "A String", # A link to the file's icon. + "fullFileExtension": "A String", # Output only. The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "hasAugmentedPermissions": True or False, # Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives. + "hasThumbnail": True or False, # Output only. 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": "A String", # Output only. The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. + "iconLink": "A String", # Output only. A link to the file's icon. "id": "A String", # The ID of the file. - "imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content. - "aperture": 3.14, # The aperture used to create the photo (f-number). - "cameraMake": "A String", # The make of the camera used to create the photo. - "cameraModel": "A String", # The model of the camera used to create the photo. - "colorSpace": "A String", # The color space of the photo. - "date": "A String", # The date and time the photo was taken (EXIF format timestamp). - "exposureBias": 3.14, # The exposure bias of the photo (APEX value). - "exposureMode": "A String", # The exposure mode used to create the photo. - "exposureTime": 3.14, # The length of the exposure, in seconds. - "flashUsed": True or False, # Whether a flash was used to create the photo. - "focalLength": 3.14, # The focal length used to create the photo, in millimeters. - "height": 42, # The height of the image in pixels. - "isoSpeed": 42, # The ISO speed used to create the photo. - "lens": "A String", # The lens used to create the photo. - "location": { # Geographic location information stored in the image. - "altitude": 3.14, # The altitude stored in the image. - "latitude": 3.14, # The latitude stored in the image. - "longitude": 3.14, # The longitude stored in the image. + "imageMediaMetadata": { # Output only. Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content. + "aperture": 3.14, # Output only. The aperture used to create the photo (f-number). + "cameraMake": "A String", # Output only. The make of the camera used to create the photo. + "cameraModel": "A String", # Output only. The model of the camera used to create the photo. + "colorSpace": "A String", # Output only. The color space of the photo. + "date": "A String", # Output only. The date and time the photo was taken (EXIF format timestamp). + "exposureBias": 3.14, # Output only. The exposure bias of the photo (APEX value). + "exposureMode": "A String", # Output only. The exposure mode used to create the photo. + "exposureTime": 3.14, # Output only. The length of the exposure, in seconds. + "flashUsed": True or False, # Output only. Whether a flash was used to create the photo. + "focalLength": 3.14, # Output only. The focal length used to create the photo, in millimeters. + "height": 42, # Output only. The height of the image in pixels. + "isoSpeed": 42, # Output only. The ISO speed used to create the photo. + "lens": "A String", # Output only. The lens used to create the photo. + "location": { # Output only. Geographic location information stored in the image. + "altitude": 3.14, # Output only. The altitude stored in the image. + "latitude": 3.14, # Output only. The latitude stored in the image. + "longitude": 3.14, # Output only. The longitude stored in the image. }, - "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value). - "meteringMode": "A String", # The metering mode used to create the photo. - "rotation": 42, # The number of clockwise 90 degree rotations applied from the image's original orientation. - "sensor": "A String", # The type of sensor used to create the photo. - "subjectDistance": 42, # The distance to the subject of the photo, in meters. - "whiteBalance": "A String", # The white balance mode used to create the photo. - "width": 42, # The width of the image in pixels. - }, - "indexableText": { # Indexable text attributes for the file (can only be written). For more information, see Manage file metadata. + "maxApertureValue": 3.14, # Output only. The smallest f-number of the lens at the focal length used to create the photo (APEX value). + "meteringMode": "A String", # Output only. The metering mode used to create the photo. + "rotation": 42, # Output only. The number of clockwise 90 degree rotations applied from the image's original orientation. + "sensor": "A String", # Output only. The type of sensor used to create the photo. + "subjectDistance": 42, # Output only. The distance to the subject of the photo, in meters. + "whiteBalance": "A String", # Output only. The white balance mode used to create the photo. + "width": 42, # Output only. The width of the image in pixels. + }, + "indexableText": { # Indexable text attributes for the file (can only be written) "text": "A String", # The text to be indexed for this file. }, - "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. - "kind": "drive#file", # The type of file. This is always drive#file. - "labelInfo": { # An overview of the labels on the file. - "labels": [ # The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned. - { # Representation of a label and its fields. - "fields": { # A map of the label's fields keyed by the field ID. - "a_key": { # Representation of a label field. + "isAppAuthorized": True or False, # Output only. Whether the file was created or opened by the requesting app. + "kind": "drive#file", # Output only. The type of file. This is always `drive#file`. + "labelInfo": { # Output only. An overview of the labels on the file. + "labels": [ # 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. + { # Representation of a label and label fields. + "fields": { # A map of the fields on the label, keyed by the field's ID. + "a_key": { # Representation of field, which is a typed key-value pair. "dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD. "A String", ], - "id": "A String", # The identifier of this field. - "integer": [ # Only present if valueType is integer. + "id": "A String", # The identifier of this label field. + "integer": [ # Only present if `valueType` is `integer`. "A String", ], - "kind": "drive#labelField", # This is always drive#labelField. - "selection": [ # Only present if valueType is selection. + "kind": "drive#labelField", # This is always `drive#labelField`. + "selection": [ # Only present if `valueType` is `selection` "A String", ], - "text": [ # Only present if valueType is text. + "text": [ # Only present if `valueType` is `text`. "A String", ], - "user": [ # Only present if valueType is user. + "user": [ # Only present if `valueType` is `user`. { # Information about a Drive user. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, ], - "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: - # - dateString - # - integer - # - selection - # - text - # - user + "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: * `dateString` * `integer` * `selection` * `text` * `user` }, }, "id": "A String", # The ID of the label. - "kind": "drive#label", # This is always drive#label + "kind": "drive#label", # This is always `drive#label` "revisionId": "A String", # The revision ID of the label. }, ], }, "labels": { # A group of labels for the file. - "hidden": True or False, # Deprecated. - "modified": True or False, # Whether the file has been modified by this user. - "restricted": True or False, # Deprecated - use copyRequiresWriterPermission instead. + "hidden": True or False, # Output only. Deprecated. + "modified": True or False, # Output only. Whether the file has been modified by this user. + "restricted": True or False, # Output only. Deprecated: Use `copyRequiresWriterPermission` instead. "starred": True or False, # Whether this file is starred by the user. - "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may 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. + "trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files. "viewed": True or False, # Whether this file has been viewed by this user. }, - "lastModifyingUser": { # Information about a Drive user. # The last user to modify this file. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "lastModifyingUserName": "A String", # Name of the last user to modify this file. + "lastModifyingUserName": "A String", # Output only. Name of the last user to modify this file. "lastViewedByMeDate": "A String", # Last time this file was viewed by the user (formatted RFC 3339 timestamp). "linkShareMetadata": { # Contains details about the link URLs that clients are using to refer to this item. - "securityUpdateEligible": True or False, # Whether the file is eligible for security update. - "securityUpdateEnabled": True or False, # Whether the security update is enabled for this file. + "securityUpdateEligible": True or False, # Output only. Whether the file is eligible for security update. + "securityUpdateEnabled": True or False, # Output only. Whether the security update is enabled for this file. }, "markedViewedByMeDate": "A String", # Deprecated. - "md5Checksum": "A String", # An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. + "md5Checksum": "A String", # Output only. An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files. "mimeType": "A String", # The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type. "modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date. "modifiedDate": "A String", # Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set. - "openWithLinks": { # A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used. + "openWithLinks": { # Output only. A map of the id of each of the user's apps to a link to open this file with that app. Only populated when the drive.apps.readonly scope is used. "a_key": "A String", }, - "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the title field. This is only available for files with binary content in Google Drive. - "ownedByMe": True or False, # Whether the file is owned by the current user. Not populated for items in shared drives. - "ownerNames": [ # Name(s) of the owner(s) of this file. Not populated for items in shared drives. + "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the `title` field. This is only available for files with binary content in Google Drive. + "ownedByMe": True or False, # Output only. Whether the file is owned by the current user. Not populated for items in shared drives. + "ownerNames": [ # Output only. Name(s) of the owner(s) of this file. Not populated for items in shared drives. "A String", ], - "owners": [ # 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. + "owners": [ # 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. { # Information about a Drive user. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, ], - "parents": [ # Collection of parent folders which contain this file. - # If not specified as part of an insert 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 can also use the addParents and removeParents parameters to modify the parents list. + "parents": [ # Collection of parent folders which contain this file. If not specified as part of an insert 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 can also use the `addParents` and `removeParents` parameters to modify the parents list. { # A reference to a file's parent. "id": "A String", # The ID of the parent. - "isRoot": True or False, # Whether or not the parent is the root folder. - "kind": "drive#parentReference", # This is always drive#parentReference. - "parentLink": "A String", # A link to the parent. - "selfLink": "A String", # A link back to this reference. + "isRoot": True or False, # Output only. Whether or not the parent is the root folder. + "kind": "drive#parentReference", # Output only. This is always `drive#parentReference`. + "parentLink": "A String", # Output only. A link to the parent. + "selfLink": "A String", # Output only. A link back to this reference. }, ], - "permissionIds": [ # List of permission IDs for users with access to this file. + "permissionIds": [ # Output only. List of permission IDs for users with access to this file. "A String", ], - "permissions": [ # The list of permissions for users with access to this file. Not populated for items in shared drives. + "permissions": [ # Output only. The list of permissions for users with access to this file. Not populated for items in shared drives. { # A permission for a file. - "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. + "additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future. "A String", ], - "authKey": "A String", # Deprecated. - "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. - "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain. - "emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group. - "etag": "A String", # The ETag of the permission. - "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - # - They cannot be set on shared drive items - # - They can only be set on user and group permissions - # - The date must be in the future - # - The date cannot be more than a year in the future - "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "kind": "drive#permission", # This is always drive#permission. - "name": "A String", # The name for this permission. - "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive. - "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "authKey": "A String", # Output only. Deprecated. + "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. + "domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`. + "emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`. + "etag": "A String", # Output only. The ETag of the permission. + "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests + "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "kind": "drive#permission", # Output only. This is always `drive#permission`. + "name": "A String", # Output only. The name for this permission. + "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. + "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. { - "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. + "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. - "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: - # - file - # - member - "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: - # - organizer - # - fileOrganizer - # - writer - # - reader + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` + "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, ], - "photoLink": "A String", # A link to the profile photo, if available. - "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: - # - owner - # - organizer - # - fileOrganizer - # - writer - # - reader - "selfLink": "A String", # A link back to this permission. - "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. + "photoLink": "A String", # Output only. A link to the profile photo, if available. + "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader` + "selfLink": "A String", # Output only. A link back to this permission. + "teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead. { - "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. + "additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead. "A String", ], - "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. - "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. - "role": "A String", # Deprecated - use permissionDetails/role instead. - "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. + "inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead. + "inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead. + "role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead. + "teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead. }, ], - "type": "A String", # The account type. Allowed values are: - # - user - # - group - # - domain - # - anyone - "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value. + "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` + "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. "withLink": True or False, # Whether the link is required for this permission. }, ], "properties": [ # The list of properties. - { # A key-value pair attached to a file that is either public or private to an application. - # The following limits apply to file properties: - # - Maximum of 100 properties total per file - # - Maximum of 30 private properties per app - # - Maximum of 30 public properties - # - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property. - "etag": "A String", # ETag of the property. + { # A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property + "etag": "A String", # Output only. ETag of the property. "key": "A String", # The key of this property. - "kind": "drive#property", # This is always drive#property. - "selfLink": "A String", # The link back to this property. + "kind": "drive#property", # Output only. This is always `drive#property`. + "selfLink": "A String", # Output only. The link back to this property. "value": "A String", # The value of this property. - "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE). Private 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. + "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. Private 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. }, ], - "quotaBytesUsed": "A String", # The number of quota bytes used by this file. - "resourceKey": "A String", # A key needed to access the item via a shared link. - "selfLink": "A String", # A link back to this file. - "sha1Checksum": "A String", # The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "sha256Checksum": "A String", # The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it isn't populated for Docs Editors or shortcut files. - "shareable": True or False, # Deprecated: use capabilities/canShare. - "shared": True or False, # Whether the file has been shared. Not populated for items in shared drives. + "quotaBytesUsed": "A String", # Output only. The number of quota bytes used by this file. + "resourceKey": "A String", # Output only. A key needed to access the item via a shared link. + "selfLink": "A String", # Output only. A link back to this file. + "sha1Checksum": "A String", # 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 is not populated for Docs Editors or shortcut files. + "sha256Checksum": "A String", # 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 is not populated for Docs Editors or shortcut files. + "shareable": True or False, # Output only. Deprecated: Use `capabilities/canShare` instead. + "shared": True or False, # Output only. Whether the file has been shared. Not populated for items in shared drives. "sharedWithMeDate": "A String", # Time at which this file was shared with the user (formatted RFC 3339 timestamp). - "sharingUser": { # Information about a Drive user. # User that shared the item with the current user, if available. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "sharingUser": { # Information about a Drive user. # Output only. User that shared the item with the current user, if available. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut. + "shortcutDetails": { # Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. "targetId": "A String", # The ID of the file that this shortcut points to. - "targetMimeType": "A String", # 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": "A String", # The ResourceKey for the target file. + "targetMimeType": "A String", # 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": "A String", # Output only. The ResourceKey for the target file. }, - "spaces": [ # The list of spaces which contain the file. Supported values are 'drive', 'appDataFolder' and 'photos'. + "spaces": [ # Output only. The list of spaces which contain the file. Supported values are `drive`, `appDataFolder` and `photos`. "A String", ], - "teamDriveId": "A String", # Deprecated - use driveId instead. + "teamDriveId": "A String", # Output only. Deprecated: Use `driveId` instead. "thumbnail": { # A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated. "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image. It should conform to RFC 4648 section 5. "mimeType": "A String", # The MIME type of the thumbnail. }, - "thumbnailLink": "A String", # A short-lived link to the file's thumbnail. 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": "A String", # The thumbnail version for use in thumbnail cache invalidation. + "thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content. + "thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation. "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the title is constant. "trashedDate": "A String", # The time that the item was trashed (formatted RFC 3339 timestamp). Only populated for items in shared drives. - "trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. - "displayName": "A String", # A plain text displayable name for this user. - "emailAddress": "A String", # The email address of the user. - "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. - "kind": "drive#user", # This is always drive#user. - "permissionId": "A String", # The user's ID as visible in the permissions collection. - "picture": { # The user's profile picture. - "url": "A String", # A URL that points to a profile picture of this user. + "trashingUser": { # Information about a Drive user. # Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. + "displayName": "A String", # Output only. A plain text displayable name for this user. + "emailAddress": "A String", # Output only. The email address of the user. + "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # Output only. This is always `drive#user`. + "permissionId": "A String", # Output only. The user's ID as visible in the permissions collection. + "picture": { # Output only. The user's profile picture. + "url": "A String", # Output Only. A URL that points to a profile picture of this user. }, }, - "userPermission": { # A permission for a file. # The permissions for the authenticated user on this file. - "additionalRoles": [ # Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. + "userPermission": { # A permission for a file. # Output only. The permissions for the authenticated user on this file. + "additionalRoles": [ # Additional roles for this user. Only `commenter` is currently allowed, though more may be supported in the future. "A String", ], - "authKey": "A String", # Deprecated. - "deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. - "domain": "A String", # The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain. - "emailAddress": "A String", # The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group. - "etag": "A String", # The ETag of the permission. - "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - # - They cannot be set on shared drive items - # - They can only be set on user and group permissions - # - The date must be in the future - # - The date cannot be more than a year in the future - "id": "A String", # The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "kind": "drive#permission", # This is always drive#permission. - "name": "A String", # The name for this permission. - "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive. - "permissionDetails": [ # Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. + "authKey": "A String", # Output only. Deprecated. + "deleted": True or False, # Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. + "domain": "A String", # Output only. The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is `user`, `group` or `domain`. + "emailAddress": "A String", # Output only. The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is `user` or `group`. + "etag": "A String", # Output only. The ETag of the permission. + "expirationDate": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests + "id": "A String", # The ID of the user this permission refers to, and identical to the `permissionId` in the About and Files resources. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "kind": "drive#permission", # Output only. This is always `drive#permission`. + "name": "A String", # Output only. The name for this permission. + "pendingOwner": True or False, # Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive. + "permissionDetails": [ # Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items. { - "additionalRoles": [ # Additional roles for this user. Only commenter is currently possible, though more may be supported in the future. + "additionalRoles": [ # Output only. Additional roles for this user. Only `commenter` is currently possible, though more may be supported in the future. "A String", ], - "inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field. - "inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field. - "permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible: - # - file - # - member - "role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible: - # - organizer - # - fileOrganizer - # - writer - # - reader + "inherited": True or False, # Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. + "inheritedFrom": "A String", # Output only. The ID of the item from which this permission is inherited. This is an output-only field. + "permissionType": "A String", # Output only. The permission type for this user. While new values may be added in future, the following are currently possible: * `file` * `member` + "role": "A String", # Output only. The primary role for this user. While new values may be added in the future, the following are currently possible: * `organizer` * `fileOrganizer` * `writer` * `reader` }, ], - "photoLink": "A String", # A link to the profile photo, if available. - "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: - # - owner - # - organizer - # - fileOrganizer - # - writer - # - reader - "selfLink": "A String", # A link back to this permission. - "teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead. + "photoLink": "A String", # Output only. A link to the profile photo, if available. + "role": "A String", # The primary role for this user. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `reader` + "selfLink": "A String", # Output only. A link back to this permission. + "teamDrivePermissionDetails": [ # Output only. Deprecated: Use `permissionDetails` instead. { - "additionalRoles": [ # Deprecated - use permissionDetails/additionalRoles instead. + "additionalRoles": [ # Output only. Deprecated: Use `permissionDetails/additionalRoles` instead. "A String", ], - "inherited": True or False, # Deprecated - use permissionDetails/inherited instead. - "inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead. - "role": "A String", # Deprecated - use permissionDetails/role instead. - "teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead. + "inherited": True or False, # Output only. Deprecated: Use `permissionDetails/inherited` instead. + "inheritedFrom": "A String", # Output only. Deprecated: Use `permissionDetails/inheritedFrom` instead. + "role": "A String", # Output only. Deprecated: Use `permissionDetails/role` instead. + "teamDrivePermissionType": "A String", # Output only. Deprecated: Use `permissionDetails/permissionType` instead. }, ], - "type": "A String", # The account type. Allowed values are: - # - user - # - group - # - domain - # - anyone - "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. - "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value. + "type": "A String", # The account type. Allowed values are: * `user` * `group` * `domain` * `anyone` + "value": "A String", # The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a `drive.permissions.insert` request, exactly one of the `id` or `value` fields must be specified unless the permission type is `anyone`, in which case both `id` and `value` are ignored. + "view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. `published` is the only supported value. "withLink": True or False, # Whether the link is required for this permission. }, - "version": "A String", # 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 requesting user. - "videoMediaMetadata": { # Metadata about video media. This will only be present for video types. - "durationMillis": "A String", # The duration of the video in milliseconds. - "height": 42, # The height of the video in pixels. - "width": 42, # The width of the video in pixels. + "version": "A String", # 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 requesting user. + "videoMediaMetadata": { # Output only. Metadata about video media. This will only be present for video types. + "durationMillis": "A String", # Output only. The duration of the video in milliseconds. + "height": 42, # Output only. The height of the video in pixels. + "width": 42, # Output only. The width of the video in pixels. }, - "webContentLink": "A String", # A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials. - "webViewLink": "A String", # A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting. + "webContentLink": "A String", # Output only. A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials. + "webViewLink": "A String", # Output only. A link only available on public folders for viewing their static web assets (HTML, CSS, JS, etc) via Google Drive's Website Hosting. "writersCanShare": True or False, # Whether writers can share the document with other users. Not populated for items in shared drives. }
watch(fileId, acknowledgeAbuse=None, body=None, includeLabels=None, includePermissionsForView=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None)
- Subscribe to changes on a file. +watch(fileId, acknowledgeAbuse=None, body=None, includeLabels=None, includePermissionsForView=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None, x__xgafv=None)+Subscribes to changes to a file. Args: fileId: string, The ID for the file in question. (required) body: object, The request body. The object takes the form of: -{ # An notification channel used to watch for resource changes. +{ # A notification channel used to watch for resource changes. "address": "A String", # The address where notifications are delivered for this channel. "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. "id": "A String", # A UUID or similar unique string that identifies this channel. - "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel". + "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is `api#channel`. "params": { # Additional parameters controlling delivery channel behavior. Optional. - "a_key": "A String", # Declares a new parameter by name. + "a_key": "A String", }, "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional. "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. "resourceUri": "A String", # A version-specific identifier for the watched resource. "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. - "type": "A String", # The type of delivery mechanism used for this channel. Valid values are "web_hook" (or "webhook"). Both values refer to a channel where Http requests are used to deliver messages. + "type": "A String", # The type of delivery mechanism used for this channel. } acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. - includeLabels: string, A comma-separated list of IDs of labels to include in the labelInfo part of the response. - includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported. - projection: string, This parameter is deprecated and has no function. + includeLabels: string, A comma-separated list of IDs of labels to include in the `labelInfo` part of the response. + includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only `published` is supported. + projection: string, Deprecated: This parameter has no function. Allowed values - BASIC - Deprecated - FULL - Deprecated + BASIC - Deprecated. + FULL - Deprecated. revisionId: string, Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified. supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. - supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead. + supportsTeamDrives: boolean, Deprecated: Use `supportsAllDrives` instead. updateViewedDate: boolean, Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format Returns: An object of the form: - { # An notification channel used to watch for resource changes. + { # A notification channel used to watch for resource changes. "address": "A String", # The address where notifications are delivered for this channel. "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. "id": "A String", # A UUID or similar unique string that identifies this channel. - "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel". + "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is `api#channel`. "params": { # Additional parameters controlling delivery channel behavior. Optional. - "a_key": "A String", # Declares a new parameter by name. + "a_key": "A String", }, "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional. "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. "resourceUri": "A String", # A version-specific identifier for the watched resource. "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. - "type": "A String", # The type of delivery mechanism used for this channel. Valid values are "web_hook" (or "webhook"). Both values refer to a channel where Http requests are used to deliver messages. + "type": "A String", # The type of delivery mechanism used for this channel. }
watch_media(fileId, acknowledgeAbuse=None, body=None, includeLabels=None, includePermissionsForView=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None)
- Subscribe to changes on a file.
-
-Args:
- fileId: string, The ID for the file in question. (required)
- body: object, The request body.
- The object takes the form of:
-
-{ # An notification channel used to watch for resource changes.
- "address": "A String", # The address where notifications are delivered for this channel.
- "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
- "id": "A String", # A UUID or similar unique string that identifies this channel.
- "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".
- "params": { # Additional parameters controlling delivery channel behavior. Optional.
- "a_key": "A String", # Declares a new parameter by name.
- },
- "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
- "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
- "resourceUri": "A String", # A version-specific identifier for the watched resource.
- "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
- "type": "A String", # The type of delivery mechanism used for this channel. Valid values are "web_hook" (or "webhook"). Both values refer to a channel where Http requests are used to deliver messages.
-}
-
- acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files.
- includeLabels: string, A comma-separated list of IDs of labels to include in the labelInfo part of the response.
- includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported.
- projection: string, This parameter is deprecated and has no function.
- Allowed values
- BASIC - Deprecated
- FULL - Deprecated
- revisionId: string, Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.
- supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
- supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
- updateViewedDate: boolean, Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body.
-
-Returns:
- The media object as a string.
-
-
-