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 extrair 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 é o ID da pasta de nível superior desse drive.

name

string

O nome do drive compartilhado.

colorRgb

string

A cor deste 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. É sempre drive#drive

capabilities

object

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

capabilities.canAddChildren

boolean

Apenas saída. Se o usuário atual pode adicionar crianças 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.

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

capabilities.canManageMembers

boolean

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

capabilities.canReadRevisions

boolean

Apenas saída. Indica 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 desse 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 desse drive compartilhado.

capabilities.canChangeDomainUsersOnlyRestriction

boolean

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

capabilities.canChangeDriveMembersOnlyRestriction

boolean

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

capabilities.canChangeSharingFoldersRequiresOrganizerPermissionRestriction

boolean

Apenas saída. Se o usuário atual pode mudar a restrição sharingFoldersRequiresOrganizerPermission desse 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. Indica se o usuário atual pode excluir itens das pastas nesse drive compartilhado.

capabilities.canTrashChildren

boolean

Apenas saída. Se o usuário atual pode enviar para a lixeira os itens filhos de pastas neste drive compartilhado.

themeId

string

O ID do tema em que a imagem e a cor de plano de fundo serão definidos. 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 é escolhido e a imagem e a cor do plano de fundo são definidas. Este é um campo somente leitura. 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 em que uma imagem de plano de fundo para esse drive compartilhado é definida. Este é um campo somente leitura. 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 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. 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 de toda a imagem.

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 do lado superior da imagem inteira até o lado 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 para 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. O horário em que o drive compartilhado foi criado (data e 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 aos itens dentro dele.

restrictions.copyRequiresWriterPermission

boolean

Se as opções de cópia, impressão ou download de arquivos neste drive compartilhado precisam ser desativadas para leitores e comentaristas. Quando essa restrição é definida como true, ela substitui o campo com nome semelhante a true em qualquer arquivo dentro desse drive compartilhado.

restrictions.domainUsersOnly

boolean

Se o acesso a esse drive compartilhado e aos itens nele é 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 são necessários privilégios administrativos neste drive compartilhado para modificar as restrições.

restrictions.sharingFoldersRequiresOrganizerPermission

boolean

Se verdadeiro, apenas os usuários com a função de organizador podem compartilhar pastas. Se for falso, os usuários com a função de organizador ou 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 está definido como true.

Métodos

delete

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

get

Recebe os metadados de um drive compartilhado por ID.

hide

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

insert

Cria um drive compartilhado.

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.