Close httplib2 connections.
Creates a permission for a file or shared drive.
Deletes a permission.
Gets a permission by ID.
Lists a file's or shared drive's permissions.
list_next(previous_request, previous_response)
Retrieves the next page of results.
Updates a permission with patch semantics.
close()
Close httplib2 connections.
create(fileId, body=None, emailMessage=None, enforceSingleParent=None, moveToNewOwnersRoot=None, sendNotificationEmail=None, supportsAllDrives=None, supportsTeamDrives=None, transferOwnership=None, useDomainAdminAccess=None)
Creates a permission for a file or shared drive.
Args:
fileId: string, The ID of the file or shared drive. (required)
body: object, The request body.
The object takes the form of:
{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"displayName": "A String", # The "pretty" name of the value of the permission. The following is a list of examples for each type of permission:
# - user - User's full name, as defined for their Google account, such as "Joe Smith."
# - group - Name of the Google Group, such as "The Company Administrators."
# - domain - String domain name, such as "thecompany.com."
# - anyone - No displayName is present.
"domain": "A String", # The domain to which this permission refers.
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions:
# - They can only be set on user and group permissions
# - The time must be in the future
# - The time cannot be more than a year in the future
"id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values.
"kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#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.
{
"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
# - commenter
# - reader
},
],
"photoLink": "A String", # A link to the user's profile photo, if available.
"role": "A String", # The role granted by this permission. While new values may be supported in the future, the following are currently allowed:
# - owner
# - organizer
# - fileOrganizer
# - writer
# - commenter
# - reader
"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
{
"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.
},
],
"type": "A String", # The type of the grantee. Valid values are:
# - user
# - group
# - domain
# - anyone When creating a permission, if type is user or group, you must provide an emailAddress for the user or group. When type is domain, you must provide a domain. There isn't extra information required for a anyone type.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.
}
emailMessage: string, A plain text custom message to include in the notification email.
enforceSingleParent: boolean, Deprecated. See moveToNewOwnersRoot for details.
moveToNewOwnersRoot: boolean, This parameter will only take effect if the item is not in a shared drive and the request is attempting to transfer the ownership of the item. If set to true, the item will be moved to the new owner's My Drive root folder and all prior parents removed. If set to false, parents are not changed.
sendNotificationEmail: boolean, Whether to send a notification email when sharing to users or groups. This defaults to true for users and groups, and is not allowed for other requests. It must not be disabled for ownership transfers.
supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
transferOwnership: boolean, Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. File owners can only transfer ownership of files existing on My Drive. Files existing in a shared drive are owned by the organization that owns that shared drive. Ownership transfers are not supported for files and folders in shared drives. Organizers of a shared drive can move items from that shared drive into their My Drive which transfers the ownership to them.
useDomainAdminAccess: boolean, Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.
Returns:
An object of the form:
{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"displayName": "A String", # The "pretty" name of the value of the permission. The following is a list of examples for each type of permission:
# - user - User's full name, as defined for their Google account, such as "Joe Smith."
# - group - Name of the Google Group, such as "The Company Administrators."
# - domain - String domain name, such as "thecompany.com."
# - anyone - No displayName is present.
"domain": "A String", # The domain to which this permission refers.
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions:
# - They can only be set on user and group permissions
# - The time must be in the future
# - The time cannot be more than a year in the future
"id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values.
"kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#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.
{
"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
# - commenter
# - reader
},
],
"photoLink": "A String", # A link to the user's profile photo, if available.
"role": "A String", # The role granted by this permission. While new values may be supported in the future, the following are currently allowed:
# - owner
# - organizer
# - fileOrganizer
# - writer
# - commenter
# - reader
"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
{
"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.
},
],
"type": "A String", # The type of the grantee. Valid values are:
# - user
# - group
# - domain
# - anyone When creating a permission, if type is user or group, you must provide an emailAddress for the user or group. When type is domain, you must provide a domain. There isn't extra information required for a anyone type.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.
}
delete(fileId, permissionId, supportsAllDrives=None, supportsTeamDrives=None, useDomainAdminAccess=None)
Deletes a permission. Args: fileId: string, The ID of the file or shared drive. (required) permissionId: string, The ID of the permission. (required) supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead. useDomainAdminAccess: boolean, Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.
get(fileId, permissionId, supportsAllDrives=None, supportsTeamDrives=None, useDomainAdminAccess=None)
Gets a permission by ID.
Args:
fileId: string, The ID of the file. (required)
permissionId: string, The ID of the permission. (required)
supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
useDomainAdminAccess: boolean, Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.
Returns:
An object of the form:
{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"displayName": "A String", # The "pretty" name of the value of the permission. The following is a list of examples for each type of permission:
# - user - User's full name, as defined for their Google account, such as "Joe Smith."
# - group - Name of the Google Group, such as "The Company Administrators."
# - domain - String domain name, such as "thecompany.com."
# - anyone - No displayName is present.
"domain": "A String", # The domain to which this permission refers.
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions:
# - They can only be set on user and group permissions
# - The time must be in the future
# - The time cannot be more than a year in the future
"id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values.
"kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#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.
{
"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
# - commenter
# - reader
},
],
"photoLink": "A String", # A link to the user's profile photo, if available.
"role": "A String", # The role granted by this permission. While new values may be supported in the future, the following are currently allowed:
# - owner
# - organizer
# - fileOrganizer
# - writer
# - commenter
# - reader
"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
{
"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.
},
],
"type": "A String", # The type of the grantee. Valid values are:
# - user
# - group
# - domain
# - anyone When creating a permission, if type is user or group, you must provide an emailAddress for the user or group. When type is domain, you must provide a domain. There isn't extra information required for a anyone type.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.
}
list(fileId, includePermissionsForView=None, pageSize=None, pageToken=None, supportsAllDrives=None, supportsTeamDrives=None, useDomainAdminAccess=None)
Lists a file's or shared drive's permissions.
Args:
fileId: string, The ID of the file or shared drive. (required)
includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported.
pageSize: integer, The maximum number of permissions to return per page. When not set for files in a shared drive, at most 100 results will be returned. When not set for files that are not in a shared drive, the entire list will be returned.
pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.
supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
useDomainAdminAccess: boolean, Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.
Returns:
An object of the form:
{ # A list of permissions for a file.
"kind": "drive#permissionList", # Identifies what kind of resource this is. Value: the fixed string "drive#permissionList".
"nextPageToken": "A String", # The page token for the next page of permissions. This field will be absent if the end of the permissions 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.
"permissions": [ # The list of permissions. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"displayName": "A String", # The "pretty" name of the value of the permission. The following is a list of examples for each type of permission:
# - user - User's full name, as defined for their Google account, such as "Joe Smith."
# - group - Name of the Google Group, such as "The Company Administrators."
# - domain - String domain name, such as "thecompany.com."
# - anyone - No displayName is present.
"domain": "A String", # The domain to which this permission refers.
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions:
# - They can only be set on user and group permissions
# - The time must be in the future
# - The time cannot be more than a year in the future
"id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values.
"kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#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.
{
"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
# - commenter
# - reader
},
],
"photoLink": "A String", # A link to the user's profile photo, if available.
"role": "A String", # The role granted by this permission. While new values may be supported in the future, the following are currently allowed:
# - owner
# - organizer
# - fileOrganizer
# - writer
# - commenter
# - reader
"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
{
"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.
},
],
"type": "A String", # The type of the grantee. Valid values are:
# - user
# - group
# - domain
# - anyone When creating a permission, if type is user or group, you must provide an emailAddress for the user or group. When type is domain, you must provide a domain. There isn't extra information required for a anyone type.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.
},
],
}
list_next(previous_request, previous_response)
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
update(fileId, permissionId, body=None, removeExpiration=None, supportsAllDrives=None, supportsTeamDrives=None, transferOwnership=None, useDomainAdminAccess=None)
Updates a permission with patch semantics.
Args:
fileId: string, The ID of the file or shared drive. (required)
permissionId: string, The ID of the permission. (required)
body: object, The request body.
The object takes the form of:
{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"displayName": "A String", # The "pretty" name of the value of the permission. The following is a list of examples for each type of permission:
# - user - User's full name, as defined for their Google account, such as "Joe Smith."
# - group - Name of the Google Group, such as "The Company Administrators."
# - domain - String domain name, such as "thecompany.com."
# - anyone - No displayName is present.
"domain": "A String", # The domain to which this permission refers.
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions:
# - They can only be set on user and group permissions
# - The time must be in the future
# - The time cannot be more than a year in the future
"id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values.
"kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#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.
{
"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
# - commenter
# - reader
},
],
"photoLink": "A String", # A link to the user's profile photo, if available.
"role": "A String", # The role granted by this permission. While new values may be supported in the future, the following are currently allowed:
# - owner
# - organizer
# - fileOrganizer
# - writer
# - commenter
# - reader
"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
{
"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.
},
],
"type": "A String", # The type of the grantee. Valid values are:
# - user
# - group
# - domain
# - anyone When creating a permission, if type is user or group, you must provide an emailAddress for the user or group. When type is domain, you must provide a domain. There isn't extra information required for a anyone type.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.
}
removeExpiration: boolean, Whether to remove the expiration date.
supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
transferOwnership: boolean, Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. File owners can only transfer ownership of files existing on My Drive. Files existing in a shared drive are owned by the organization that owns that shared drive. Ownership transfers are not supported for files and folders in shared drives. Organizers of a shared drive can move items from that shared drive into their My Drive which transfers the ownership to them.
useDomainAdminAccess: boolean, Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.
Returns:
An object of the form:
{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"displayName": "A String", # The "pretty" name of the value of the permission. The following is a list of examples for each type of permission:
# - user - User's full name, as defined for their Google account, such as "Joe Smith."
# - group - Name of the Google Group, such as "The Company Administrators."
# - domain - String domain name, such as "thecompany.com."
# - anyone - No displayName is present.
"domain": "A String", # The domain to which this permission refers.
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"expirationTime": "A String", # The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions:
# - They can only be set on user and group permissions
# - The time must be in the future
# - The time cannot be more than a year in the future
"id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values.
"kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#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.
{
"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
# - commenter
# - reader
},
],
"photoLink": "A String", # A link to the user's profile photo, if available.
"role": "A String", # The role granted by this permission. While new values may be supported in the future, the following are currently allowed:
# - owner
# - organizer
# - fileOrganizer
# - writer
# - commenter
# - reader
"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
{
"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.
},
],
"type": "A String", # The type of the grantee. Valid values are:
# - user
# - group
# - domain
# - anyone When creating a permission, if type is user or group, you must provide an emailAddress for the user or group. When type is domain, you must provide a domain. There isn't extra information required for a anyone type.
"view": "A String", # Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.
}