REST Resource: drives

Recurso: Drive

Representação de um drive compartilhado.

Alguns métodos de recursos (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,
    "canChangeDownloadRestriction": 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,
    "downloadRestriction": {
      object (DownloadRestriction)
    }
  },
  "orgUnitId": string
}
Campos
id

string

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

name

string

O nome deste drive compartilhado.

colorRgb

string

A cor do drive compartilhado como uma string hexadecimal RGB. Ele só pode ser definido em uma solicitação drive.drives.update que não define themeId.

kind

string

Apenas saída. Identifica o tipo de recurso. Valor: a string fixa "drive#drive".

capabilities

object

Apenas saída. Capacidades do usuário atual 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 em arquivos neste 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 pode falhar se houver itens não excluídos na lixeira dentro dele.

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 das pastas neste drive compartilhado.

capabilities.canManageMembers

boolean

Apenas saída. Se o usuário atual pode adicionar ou remover participantes deste drive compartilhado ou mudar a função deles.

capabilities.canReadRevisions

boolean

Apenas saída. Se o usuário atual pode ler o recurso de revisões dos 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 mudar 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. Se o usuário atual pode redefinir as restrições do drive compartilhado para os padrões.

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 itens para a lixeira de pastas neste drive compartilhado.

capabilities.canChangeDownloadRestriction

boolean

Apenas saída. Indica se o usuário atual pode mudar as restrições de download aplicadas pelo organizador 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. Ele só pode ser definido em solicitações que não definem colorRgb ou backgroundImageFile.

backgroundImageFile

object

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

backgroundImageFile.id

string

O ID de um arquivo de imagem no Google Drive para usar como 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. É 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 de toda a imagem.

backgroundImageFile.yCoordinate

number

A coordenada Y do canto superior esquerdo da área de corte na imagem de plano de fundo. É um valor no intervalo fechado de 0 a 1. Esse valor representa a distância vertical da parte superior de toda a imagem até a parte superior da área de corte dividida pela altura de toda a imagem.

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/altura de 80 para 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 em que o drive compartilhado foi criado (data e 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. 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 de copiar, imprimir ou baixar arquivos dentro deste drive compartilhado devem ser desativadas para leitores e comentadores. Quando essa restrição é definida como true, ela substitui o campo de nome semelhante por true para qualquer arquivo dentro desse drive compartilhado.

restrictions.domainUsersOnly

boolean

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 desse drive compartilhado.

restrictions.driveMembersOnly

boolean

Se o acesso aos itens dentro deste drive compartilhado é restrito aos participantes.

restrictions.adminManagedRestrictions

boolean

Se privilégios administrativos nesse drive compartilhado são necessários para modificar as restrições.

restrictions.sharingFoldersRequiresOrganizerPermission

boolean

Se for "true", apenas usuários com a função de organizador poderão compartilhar pastas. Se for "false", os usuários com a função de organizador ou organizador de arquivos poderão compartilhar pastas.

restrictions.downloadRestriction

object (DownloadRestriction)

Restrições de download aplicadas pelos administradores do drive compartilhado.

orgUnitId

string

Apenas saída. A unidade organizacional deste drive compartilhado. Esse campo só é preenchido em respostas drives.list quando o parâmetro useDomainAdminAccess está 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.