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

capabilities.canAddChildren

boolean

Apenas saída. Define se o usuário atual pode adicionar crianças a pastas deste drive compartilhado.

capabilities.canComment

boolean

Apenas saída. Define 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 pode falhar se houver itens fora da lixeira.

capabilities.canDownload

boolean

Apenas saída. Define 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. Define se o usuário atual pode listar os filhos das pastas deste drive compartilhado.

capabilities.canManageMembers

boolean

Apenas saída. Define 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. Define se o usuário atual pode ler o recurso de revisões dos 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. Se o usuário atual pode alterar o plano de fundo deste drive compartilhado.

capabilities.canShare

boolean

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

capabilities.canChangeCopyRequiresWriterPermissionRestriction

boolean

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

capabilities.canChangeDomainUsersOnlyRestriction

boolean

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

capabilities.canChangeDriveMembersOnlyRestriction

boolean

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

capabilities.canChangeSharingFoldersRequiresOrganizerPermissionRestriction

boolean

Apenas saída. Define 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 das pastas deste drive compartilhado.

capabilities.canTrashChildren

boolean

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

themeId

string

O ID do tema a partir do qual 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.insert, um tema aleatório é escolhido para definir a imagem e a cor do 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 que definem uma imagem de plano de fundo para este drive compartilhado. Este é um campo somente de gravação. Ele só pode ser definido em solicitações drive.drives.update que não definem themeId. Quando especificado, todos os campos de backgroundImageFile precisam ser definidos.

backgroundImageFile.id

string

O código 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 da imagem ao 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 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 da imagem inteira. A altura é calculada aplicando uma proporção entre largura e 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 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

As opções para copiar, imprimir ou fazer o download de arquivos neste drive compartilhado precisam ser desativadas para leitores e comentadores. Quando essa restrição for definida como true, o campo com nome semelhante vai ser substituído por true em qualquer arquivo no drive compartilhado.

restrictions.domainUsersOnly

boolean

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

restrictions.driveMembersOnly

boolean

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

restrictions.adminManagedRestrictions

boolean

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

restrictions.sharingFoldersRequiresOrganizerPermission

boolean

Se verdadeiro, apenas os usuários com a função de organizador poderão compartilhar pastas. Se for definido como 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 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 é um organizer.

get

Recebe os metadados de um drive compartilhado pelo ID.

hide

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

insert

Cria um novo 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.