REST Resource: drives

Recurso: Drive

Representação de um drive compartilhado.

Alguns métodos de recurso (como drives.update) exigem um driveId. Use o método drives.list para recuperar o ID de um drive compartilhado.

Representação JSON
{
  "id": string,
  "name": string,
  "colorRgb": string,
  "kind": string,
  "backgroundImageLink": string,
  "capabilities": {
    "canAddChildren": boolean,
    "canComment": boolean,
    "canCopy": boolean,
    "canDeleteDrive": boolean,
    "canDownload": boolean,
    "canEdit": boolean,
    "canListChildren": boolean,
    "canManageMembers": boolean,
    "canReadRevisions": boolean,
    "canRename": boolean,
    "canRenameDrive": boolean,
    "canChangeDriveBackground": boolean,
    "canShare": boolean,
    "canChangeCopyRequiresWriterPermissionRestriction": boolean,
    "canChangeDomainUsersOnlyRestriction": boolean,
    "canChangeDriveMembersOnlyRestriction": boolean,
    "canChangeSharingFoldersRequiresOrganizerPermissionRestriction": boolean,
    "canResetDriveRestrictions": boolean,
    "canDeleteChildren": boolean,
    "canTrashChildren": boolean
  },
  "themeId": string,
  "backgroundImageFile": {
    "id": string,
    "xCoordinate": number,
    "yCoordinate": number,
    "width": number
  },
  "createdDate": string,
  "hidden": boolean,
  "restrictions": {
    "copyRequiresWriterPermission": boolean,
    "domainUsersOnly": boolean,
    "driveMembersOnly": boolean,
    "adminManagedRestrictions": boolean,
    "sharingFoldersRequiresOrganizerPermission": boolean
  },
  "orgUnitId": string
}
Campos
id

string

Apenas saída. O ID do drive compartilhado, que também é a pasta de nível superior da pasta.

name

string

O nome deste drive compartilhado.

colorRgb

string

A cor deste drive compartilhado como uma string hexadecimal RGB. Só pode ser definido em uma solicitação drive.drives.update que não defina themeId.

kind

string

Apenas saída. É sempre drive#drive

capabilities

object

Apenas saída. Recursos que o usuário atual tem neste drive compartilhado.

capabilities.canAddChildren

boolean

Apenas saída. Se o usuário atual pode adicionar filhos a pastas neste drive compartilhado.

capabilities.canComment

boolean

Apenas saída. Se o usuário atual pode comentar nos arquivos deste drive compartilhado.

capabilities.canCopy

boolean

Apenas saída. Se o usuário atual pode copiar arquivos neste drive compartilhado.

capabilities.canDeleteDrive

boolean

Apenas saída. Se o usuário atual pode excluir este drive compartilhado. A tentativa de excluir o drive compartilhado ainda poderá falhar se houver itens fora da lixeira.

capabilities.canDownload

boolean

Apenas saída. Se o usuário atual pode fazer o download de arquivos neste drive compartilhado.

capabilities.canEdit

boolean

Apenas saída. Se o usuário atual pode editar arquivos neste drive compartilhado

capabilities.canListChildren

boolean

Apenas saída. Se o usuário atual pode listar os filhos de pastas neste drive compartilhado.

capabilities.canManageMembers

boolean

Apenas saída. Se o usuário atual pode adicionar participantes a este drive compartilhado, removê-los ou alterar a função deles.

capabilities.canReadRevisions

boolean

Apenas saída. Se o usuário atual pode ler o recurso de revisões de arquivos neste drive compartilhado.

capabilities.canRename

boolean

Apenas saída. Se o usuário atual pode renomear arquivos ou pastas neste drive compartilhado.

capabilities.canRenameDrive

boolean

Apenas saída. Se o usuário atual pode renomear este drive compartilhado.

capabilities.canChangeDriveBackground

boolean

Apenas saída. Se o usuário atual pode alterar o plano de fundo deste drive compartilhado.

capabilities.canShare

boolean

Apenas saída. Se o usuário atual pode compartilhar arquivos ou pastas neste drive compartilhado.

capabilities.canChangeCopyRequiresWriterPermissionRestriction

boolean

Apenas saída. Se o usuário atual pode alterar a restrição de copyRequiresWriterPermission deste drive compartilhado.

capabilities.canChangeDomainUsersOnlyRestriction

boolean

Apenas saída. Se o usuário atual pode alterar a restrição de domainUsersOnly deste drive compartilhado.

capabilities.canChangeDriveMembersOnlyRestriction

boolean

Apenas saída. Se o usuário atual pode alterar a restrição de driveMembersOnly deste drive compartilhado.

capabilities.canChangeSharingFoldersRequiresOrganizerPermissionRestriction

boolean

Apenas saída. Se o usuário atual pode alterar a restrição de sharingFoldersRequiresOrganizerPermission deste drive compartilhado.

capabilities.canResetDriveRestrictions

boolean

Apenas saída. Se o usuário atual pode redefinir as restrições do drive compartilhado para o padrão.

capabilities.canDeleteChildren

boolean

Apenas saída. Se o usuário atual pode excluir filhos de pastas neste drive compartilhado.

capabilities.canTrashChildren

boolean

Apenas saída. Se o usuário atual pode mover arquivos das pastas neste drive compartilhado para a lixeira

themeId

string

O código do tema a partir do qual a imagem de plano de fundo e a cor serão definidas. O conjunto de driveThemes possíveis pode ser recuperado de uma resposta drive.about.get. Quando não especificado em uma solicitação drive.drives.insert, um tema aleatório será escolhido, a partir do qual a imagem de plano de fundo e a cor serão definidas. Este é um campo somente gravação. Ele só pode ser definido em solicitações que não definem colorRgb ou backgroundImageFile.

backgroundImageFile

object

Um arquivo de imagem e os parâmetros de corte a partir dos quais uma imagem de plano de fundo deste drive compartilhado foi definida. Este é um campo somente gravação. Ele só pode ser definido em solicitações drive.drives.update que não definem themeId. Quando especificado, todos os campos do backgroundImageFile precisam ser definidos.

backgroundImageFile.id

string

O código de um arquivo de imagem no Google Drive para ser usado na imagem de plano de fundo.

backgroundImageFile.xCoordinate

number

A coordenada X do canto superior esquerdo da área de corte na imagem de plano de fundo. Este é um valor no intervalo fechado de 0 a 1. Esse valor representa a distância horizontal do lado esquerdo da imagem inteira para o lado esquerdo da área de corte dividido pela largura da imagem inteira.

backgroundImageFile.yCoordinate

number

A coordenada Y do canto superior esquerdo da área de corte na imagem de plano de fundo. Este é um valor no intervalo fechado de 0 a 1. Esse valor representa a distância vertical entre o lado superior da imagem inteira e o lado superior da área de corte dividido pela altura da imagem inteira.

backgroundImageFile.width

number

A largura da imagem cortada no intervalo fechado de 0 a 1. Esse valor representa a largura da imagem cortada dividida pela largura da imagem inteira. A altura é calculada aplicando uma proporção largura x altura de 80 para 9. A imagem resultante precisa ter pelo menos 1.280 pixels de largura e 144 pixels de altura.

createdDate

string

Apenas saída. A hora em que o drive compartilhado foi criado (data/hora RFC 3339).

hidden

boolean

Se o drive compartilhado está oculto da visualização padrão.

restrictions

object

Um conjunto de restrições que se aplicam a este drive compartilhado ou aos itens dentro dele.

restrictions.copyRequiresWriterPermission

boolean

Se as opções de copiar, imprimir ou fazer o download de arquivos neste drive compartilhado devem ser desativadas para leitores e comentadores. Quando essa restrição é definida como true, ela substitui o campo com nome semelhante a true em qualquer arquivo dentro deste drive compartilhado.

restrictions.domainUsersOnly

boolean

Se o acesso a este drive compartilhado e aos itens dele é restrito aos usuários do domínio a que o drive compartilhado pertence. Essa restrição pode ser modificada por outras políticas de compartilhamento controladas fora do drive compartilhado.

restrictions.driveMembersOnly

boolean

Se o acesso aos itens neste drive compartilhado é restrito aos participantes.

restrictions.adminManagedRestrictions

boolean

Se os privilégios administrativos deste drive compartilhado são obrigatórios para modificar restrições.

restrictions.sharingFoldersRequiresOrganizerPermission

boolean

Se verdadeiro, somente usuários com a função de organizador poderão compartilhar pastas. Se for falso, os usuários com a função de organizador ou de organizador de arquivos poderão compartilhar pastas.

orgUnitId

string

Apenas saída. A unidade organizacional deste drive compartilhado. Esse campo só é preenchido nas respostas de drives.list quando o parâmetro useDomainAdminAccess é definido como true.

Métodos

delete

Exclui permanentemente um drive compartilhado em que o usuário é um organizer.

get

Recebe os metadados de um drive compartilhado por ID.

hide

Oculta um drive compartilhado na visualização padrão.

insert

Cria um novo drive compartilhado.

list

Lista os drives compartilhados do usuário.

unhide

Restaura um drive compartilhado na visualização padrão.

update

Atualiza os metadados de um drive compartilhado.