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
  },
  "createdTime": string,
  "hidden": boolean,
  "restrictions": {
    "copyRequiresWriterPermission": boolean,
    "domainUsersOnly": boolean,
    "driveMembersOnly": boolean,
    "adminManagedRestrictions": boolean,
    "sharingFoldersRequiresOrganizerPermission": boolean
  },
  "orgUnitId": string
}
Campos
id

string

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

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. Identifica o tipo de recurso. Valor: a string fixa "drive#drive".

capabilities

object

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

capabilities.canAddChildren

boolean

Apenas saída. Define se o usuário atual pode adicionar filhos às pastas deste 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. Define 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 exclusão do 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 dos arquivos neste drive compartilhado.

capabilities.canEdit

boolean

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

capabilities.canListChildren

boolean

Apenas saída. Define se o usuário atual pode listar os filhos das pastas neste drive compartilhado.

capabilities.canManageMembers

boolean

Apenas saída. Define se o usuário atual pode adicionar membros 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. Define se o usuário atual pode renomear arquivos ou pastas neste drive compartilhado.

capabilities.canRenameDrive

boolean

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

capabilities.canChangeDriveBackground

boolean

Apenas saída. Define 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 mudar a restrição copyRequiresWriterPermission deste drive compartilhado.

capabilities.canChangeDomainUsersOnlyRestriction

boolean

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

capabilities.canChangeDriveMembersOnlyRestriction

boolean

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

capabilities.canChangeSharingFoldersRequiresOrganizerPermissionRestriction

boolean

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

capabilities.canResetDriveRestrictions

boolean

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

capabilities.canDeleteChildren

boolean

Apenas saída. Define se o usuário atual pode excluir filhos das pastas deste drive compartilhado.

capabilities.canTrashChildren

boolean

Apenas saída. Define se o usuário atual pode enviar os filhos para a lixeira das pastas deste drive compartilhado.

themeId

string

O ID do tema em que a imagem e a cor de plano de fundo serão definidas. O conjunto de possíveis driveThemes pode ser recuperado de uma resposta drive.about.get. Quando não especificado em uma solicitação drive.drives.create, um tema aleatório é escolhido para definir a imagem e a cor de plano de fundo. Este é um campo somente gravação; ela só pode ser definida em solicitações que não definem colorRgb ou backgroundImageFile.

backgroundImageFile

object

Um arquivo de imagem e parâmetros de corte que geram uma imagem de plano de fundo definida para este drive compartilhado. Este é um campo somente gravação; Ela só pode ser definida 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 que será usado para a 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. Esse é um valor no intervalo fechado de 0 a 1. Esse valor representa a distância horizontal do lado esquerdo de toda a imagem até o lado esquerdo da área de corte dividida 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. Esse é um valor no intervalo fechado de 0 a 1. Esse valor representa a distância vertical da parte superior da imagem inteira até a parte superior da área de corte dividida 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 de toda a imagem. A altura é calculada aplicando uma proporção de largura por altura de 80 a 9. A imagem resultante precisa ter pelo menos 1.280 pixels de largura e 144 pixels de altura.

createdTime

string

Apenas saída. O horário de criação do drive compartilhado (data-hora RFC 3339).

hidden

boolean

Indica se o drive compartilhado está oculto na visualização padrão.

restrictions

object

Um conjunto de restrições que se aplicam a este drive compartilhado ou a itens dentro dele. Não é possível definir restrições ao criar um drive compartilhado. Para adicionar uma restrição, primeiro crie um drive compartilhado e use drives.update.

restrictions.copyRequiresWriterPermission

boolean

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

restrictions.domainUsersOnly

boolean

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

restrictions.driveMembersOnly

boolean

Indica se o acesso aos itens neste drive compartilhado é restrito aos participantes.

restrictions.adminManagedRestrictions

boolean

Define se os privilégios de administrador neste drive compartilhado são necessários para modificar restrições.

restrictions.sharingFoldersRequiresOrganizerPermission

boolean

Se verdadeiro, apenas os usuários com a função de organizador poderão compartilhar pastas. Se ela for definida como falsa, 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 em respostas drives.list quando o parâmetro useDomainAdminAccess é definido como true.

Métodos

create

Cria um drive compartilhado.

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 da visualização padrão.

list

Lista os drives compartilhados do usuário.

unhide

Restaura um drive compartilhado para a visualização padrão.

update

Atualiza os metadados de um drive compartilhado.