Recurso: File
Os metadados de um arquivo.
Alguns métodos de recurso (como files.update
) exigem um fileId
. Use o método files.list
para recuperar o ID de um arquivo.
Representação JSON |
---|
{ "kind": string, "driveId": string, "fileExtension": string, "copyRequiresWriterPermission": boolean, "md5Checksum": string, "contentHints": { "indexableText": string, "thumbnail": { "image": string, "mimeType": string } }, "writersCanShare": boolean, "viewedByMe": boolean, "mimeType": string, "exportLinks": { string: string, ... }, "parents": [ string ], "thumbnailLink": string, "iconLink": string, "shared": boolean, "lastModifyingUser": { object ( |
Campos | |
---|---|
kind |
Apenas saída. Identifica o tipo de recurso. Valor: a string fixa |
driveId |
Apenas saída. ID do drive compartilhado em que o arquivo está Preenchido apenas para itens em drives compartilhados. |
fileExtension |
Apenas saída. O componente final de |
copyRequiresWriterPermission |
Se as opções de copiar, imprimir ou fazer o download do arquivo devem ser desativadas para leitores e comentadores. |
md5Checksum |
Apenas saída. A soma de verificação MD5 para o conteúdo do arquivo. Isso só é aplicável a arquivos com conteúdo binário no Google Drive. |
contentHints |
Informações adicionais sobre o conteúdo do arquivo. Esses campos nunca são preenchidos nas respostas. |
contentHints.indexableText |
Texto a ser indexado para o arquivo a fim de melhorar as consultas fullText. Isso é limitado a 128 KB e pode conter elementos HTML. |
contentHints.thumbnail |
Uma miniatura do arquivo. Isso só será usado se o Google Drive não puder gerar uma miniatura padrão. |
contentHints.thumbnail.image |
Os dados das miniaturas codificados com Base64 seguro para URL (RFC 4648, seção 5). Uma string codificada em base64. |
contentHints.thumbnail.mimeType |
O tipo MIME da miniatura. |
writersCanShare |
Se os usuários com apenas a permissão |
viewedByMe |
Apenas saída. Se o arquivo foi visualizado por este usuário. |
mimeType |
O tipo MIME do arquivo. O Google Drive tentará detectar automaticamente um valor apropriado no conteúdo enviado se nenhum valor for fornecido. O valor não pode ser alterado, a menos que uma nova revisão seja carregada. Se um arquivo for criado com o tipo MIME do Documentos Google, o conteúdo enviado será importado, se possível. Os formatos de importação compatíveis são publicados no recurso "Sobre". |
exportLinks |
Apenas saída. Links para exportar arquivos dos Editores de Documentos Google para formatos específicos. Um objeto com uma lista de pares |
parents[] |
Os IDs das pastas mãe que contêm o arquivo. Se não for especificado como parte de uma solicitação de criação, o arquivo será colocado diretamente na pasta "Meu Drive" do usuário. Se não for especificado como parte de uma solicitação de cópia, o arquivo herdará os pais detectáveis do arquivo de origem. As solicitações de files.update precisam usar os parâmetros |
thumbnailLink |
Apenas saída. Um link de curta duração para a miniatura do arquivo, se disponível. Normalmente, dura por hora. Preenchido apenas quando o app solicitante pode acessar o conteúdo do arquivo. Se o arquivo não for compartilhado publicamente, o URL retornado em |
iconLink |
Apenas saída. Um link estático e não autenticado para o ícone do arquivo. |
shared |
Apenas saída. Se o arquivo foi compartilhado Não preenchido para itens nos drives compartilhados. |
lastModifyingUser |
Apenas saída. O último usuário a modificar o arquivo. |
owners[] |
Apenas saída. O proprietário deste arquivo. Apenas alguns arquivos legados podem ter mais de um proprietário. Este campo não é preenchido para os itens nos drives compartilhados. |
headRevisionId |
Apenas saída. O ID da revisão do cabeçalho do arquivo. No momento, esse recurso só está disponível para arquivos com conteúdo binário no Google Drive. |
sharingUser |
Apenas saída. O usuário que compartilhou o arquivo com o usuário solicitante, se aplicável. |
webViewLink |
Apenas saída. Um link para abrir o arquivo em um editor ou visualizador relevante do Google em um navegador. |
webContentLink |
Apenas saída. Um link para fazer o download do conteúdo do arquivo em um navegador. Esse recurso só está disponível para arquivos com conteúdo binário no Google Drive. |
size |
Apenas saída. Tamanho em bytes de blobs e arquivos primários do editor. Não são preenchidos para arquivos que não têm tamanho, como atalhos e pastas. |
viewersCanCopyContent |
Obsoleto: use |
permissions[] |
Apenas saída. A lista completa de permissões do arquivo. Essa opção estará disponível somente se o usuário solicitante puder compartilhar o arquivo. Não preenchido para itens nos drives compartilhados. |
hasThumbnail |
Apenas saída. Se este arquivo tem uma miniatura. Isso não indica se o app solicitante tem acesso à miniatura. Para verificar o acesso, procure a presença do campo thumbnailLink. |
spaces[] |
Apenas saída. A lista de espaços que contêm o arquivo. No momento, os valores aceitos são "drive", "appDataFolder" e "photos". |
folderColorRgb |
A cor de uma pasta ou um atalho para uma pasta como uma string hexadecimal RGB. As cores compatíveis são publicadas no campo Se uma cor incompatível for especificada, a cor mais próxima na paleta será usada. |
id |
O ID do arquivo. |
name |
O nome do arquivo. Isso não é necessariamente exclusivo dentro de uma pasta. Para os itens imutáveis, como as pastas de nível superior dos drives compartilhados, a pasta raiz do Meu Drive e a pasta "Dados do aplicativo", o nome é constante. |
description |
Uma breve descrição do arquivo. |
starred |
Se o usuário marcou o arquivo com estrela. |
trashed |
Se o arquivo foi movido para a lixeira, explicitamente ou de uma pasta mãe na lixeira. Somente o proprietário pode mover um arquivo para a lixeira, e outros usuários não poderão ver o arquivo na lixeira do proprietário. |
explicitlyTrashed |
Apenas saída. Se o arquivo foi movido explicitamente para a lixeira, ao contrário de ser recursivamente de uma pasta pai. |
createdTime |
A hora em que o arquivo foi criado (data e hora RFC 3339). |
modifiedTime |
A última vez que o arquivo foi modificado por qualquer pessoa (data e hora RFC 3339). Observe que definir |
modifiedByMeTime |
Apenas saída. A última vez que o usuário modificou o arquivo (data e hora RFC 3339). |
viewedByMeTime |
A última vez que o arquivo foi visualizado pelo usuário (data e hora RFC 3339). |
sharedWithMeTime |
Apenas saída. O horário em que o arquivo foi compartilhado com o usuário, se aplicável (RFC de data e hora 3339). |
quotaBytesUsed |
Apenas saída. O número de bytes da cota de armazenamento usados pelo arquivo. Isso inclui a revisão principal e as anteriores com |
version |
Apenas saída. Um número de versão que aumenta constantemente para o arquivo. Isso reflete todas as alterações feitas no arquivo no servidor, mesmo as que não estão visíveis para o usuário. |
originalFilename |
O nome do arquivo original do conteúdo enviado, se disponível, ou o valor original do campo |
ownedByMe |
Apenas saída. Se o arquivo pertence ao usuário. Não preenchido para itens nos drives compartilhados. |
fullFileExtension |
Apenas saída. A extensão de arquivo completa extraída do campo Isso é atualizado automaticamente quando o campo |
properties |
Uma coleção de pares de chave-valor arbitrários que é visível para todos os apps. Entradas com valores nulos são limpas em solicitações de atualização e cópia. Um objeto com uma lista de pares |
appProperties |
Uma coleção de pares de chave-valor arbitrários que são particulares para o app solicitante. Entradas com valores nulos são limpas em solicitações de atualização e cópia. Essas propriedades só podem ser recuperadas usando uma solicitação autenticada. Uma solicitação autenticada usa um token de acesso obtido com um ID do cliente OAuth 2. Não é possível usar uma chave de API para recuperar propriedades particulares. Um objeto com uma lista de pares |
isAppAuthorized |
Apenas saída. Se o arquivo foi criado ou aberto pelo app solicitante. |
teamDriveId |
Obsoleto: somente saída. Use |
capabilities |
Apenas saída. Recursos do usuário atual neste arquivo. Cada recurso corresponde a uma ação específica que o usuário pode realizar. |
capabilities.canChangeViewersCanCopyContent |
Obsoleto: somente saída. |
capabilities.canMoveChildrenOutOfDrive |
Apenas saída. Se o usuário atual pode mover os filhos desta pasta para fora do drive compartilhado. Isso é falso quando o item não é uma pasta. Preenchido apenas para itens em drives compartilhados. |
capabilities.canReadDrive |
Apenas saída. Se o usuário atual pode ler o drive compartilhado a que o arquivo pertence. Preenchido apenas para itens em drives compartilhados. |
capabilities.canEdit |
Apenas saída. Se o usuário atual pode editar este arquivo. Outros fatores podem limitar o tipo de alterações que um usuário pode fazer em um arquivo. Por exemplo, consulte |
capabilities.canCopy |
Apenas saída. Se o usuário atual pode copiar este arquivo. Para um item em um drive compartilhado, se o usuário atual pode copiar descendentes que não sejam pastas deste item ou do próprio item, se ele não for uma pasta. |
capabilities.canComment |
Apenas saída. Se o usuário atual pode comentar neste arquivo. |
capabilities.canAddChildren |
Apenas saída. Se o usuário atual pode adicionar filhos a essa pasta. Isso é sempre falso quando o item não é uma pasta. |
capabilities.canDelete |
Apenas saída. Se o usuário atual pode excluir este arquivo. |
capabilities.canDownload |
Apenas saída. Se o usuário atual pode fazer o download do arquivo. |
capabilities.canListChildren |
Apenas saída. Se o usuário atual pode listar os filhos desta pasta. Isso é sempre falso quando o item não é uma pasta. |
capabilities.canRemoveChildren |
Apenas saída. Se o usuário atual pode remover filhos desta pasta. Isso é sempre falso quando o item não é uma pasta. Para uma pasta em um drive compartilhado, use |
capabilities.canRename |
Apenas saída. Se o usuário atual pode renomear este arquivo. |
capabilities.canTrash |
Apenas saída. Se o usuário atual pode mover este arquivo para a lixeira. |
capabilities.canReadRevisions |
Apenas saída. Se o usuário atual pode ler o recurso de revisões desse arquivo. No caso de um item do drive compartilhado, é possível ler as revisões de descendentes que não sejam de pastas do item ou o próprio item caso ele não seja uma pasta. |
capabilities.canReadTeamDrive |
Obsoleto: somente saída. Use |
capabilities.canMoveTeamDriveItem |
Obsoleto: somente saída. Use |
capabilities.canChangeCopyRequiresWriterPermission |
Apenas saída. Indica se o usuário atual pode mudar a restrição de |
capabilities.canMoveItemIntoTeamDrive |
Obsoleto: somente saída. Use |
capabilities.canUntrash |
Apenas saída. Se o usuário atual pode restaurar este arquivo da lixeira. |
capabilities.canModifyContent |
Apenas saída. Indica se o usuário atual pode modificar o conteúdo desse arquivo. |
capabilities.canMoveItemWithinTeamDrive |
Obsoleto: somente saída. Use |
capabilities.canMoveItemOutOfTeamDrive |
Obsoleto: somente saída. Use |
capabilities.canDeleteChildren |
Apenas saída. Se o usuário atual pode excluir filhos desta pasta. Isso é falso quando o item não é uma pasta. Preenchido apenas para itens em drives compartilhados. |
capabilities.canMoveChildrenOutOfTeamDrive |
Obsoleto: somente saída. Use |
capabilities.canMoveChildrenWithinTeamDrive |
Obsoleto: somente saída. Use |
capabilities.canTrashChildren |
Apenas saída. Se o usuário atual pode ou não enviar os filhos para esta pasta. Isso é falso quando o item não é uma pasta. Preenchido apenas para itens em drives compartilhados. |
capabilities.canMoveItemOutOfDrive |
Apenas saída. Define se o usuário atual pode mover este item para fora deste drive alterando o pai dele. Uma solicitação para alterar o pai do item ainda pode falhar, dependendo do novo pai que está sendo adicionado. |
capabilities.canAddMyDriveParent |
Apenas saída. Se o usuário atual pode adicionar um pai para o item sem remover um pai existente na mesma solicitação. Não preenchido para arquivos do drive compartilhado. |
capabilities.canRemoveMyDriveParent |
Apenas saída. Se o usuário atual pode remover um pai do item sem adicionar outro pai na mesma solicitação. Não preenchido para arquivos do drive compartilhado. |
capabilities.canMoveItemWithinDrive |
Apenas saída. Se o usuário atual pode mover este item dentro deste drive. Uma solicitação para alterar o pai do item ainda pode falhar, dependendo do novo pai que está sendo adicionado e do pai que está sendo removido. |
capabilities.canShare |
Apenas saída. Se o usuário atual pode modificar as configurações de compartilhamento do arquivo. |
capabilities.canMoveChildrenWithinDrive |
Apenas saída. Se o usuário atual pode mover filhos desta pasta dentro deste drive. Isso é falso quando o item não é uma pasta. Uma solicitação para mover o derivado ainda pode falhar, dependendo do acesso do usuário atual ao secundário e à pasta de destino. |
capabilities.canModifyContentRestriction |
Obsoleto: somente saída. Use uma destas opções: |
capabilities.canAddFolderFromAnotherDrive |
Apenas saída. Se o usuário atual pode adicionar uma pasta de outro drive (diferente do drive compartilhado ou do "Meu Drive") a essa pasta. Isso é falso quando o item não é uma pasta. Preenchido apenas para itens em drives compartilhados. |
capabilities.canChangeSecurityUpdateEnabled |
Apenas saída. Se o usuário atual pode alterar o campo securityUpdateEnabled nos metadados de compartilhamento de link. |
capabilities.canAcceptOwnership |
Apenas saída. Se o usuário atual é o proprietário pendente do arquivo. Não preenchido para arquivos do drive compartilhado. |
capabilities.canReadLabels |
Apenas saída. Se o usuário atual pode ler os marcadores no arquivo. |
capabilities.canModifyLabels |
Apenas saída. Se o usuário atual pode modificar os marcadores no arquivo. |
capabilities.canModifyEditorContentRestriction |
Apenas saída. Se o usuário atual pode adicionar ou modificar restrições de conteúdo no arquivo que são restritos pelo editor. |
capabilities.canModifyOwnerContentRestriction |
Apenas saída. Se o usuário atual pode adicionar ou modificar restrições de conteúdo que são restritas pelo proprietário. |
capabilities.canRemoveContentRestriction |
Apenas saída. Se há uma restrição de conteúdo no arquivo que pode ser removida pelo usuário atual. |
hasAugmentedPermissions |
Apenas saída. Se há permissões diretamente neste arquivo. Este campo só é preenchido para os itens nos drives compartilhados. |
trashingUser |
Apenas saída. Se o arquivo foi enviado para a lixeira explicitamente, isso significa o usuário que o enviou para a lixeira. Preenchido apenas para itens em drives compartilhados. |
thumbnailVersion |
Apenas saída. A versão da miniatura a ser usada na invalidação de cache da miniatura. |
trashedTime |
Apenas saída. A hora em que o item foi enviado para a lixeira (data e hora RFC 3339). Preenchido apenas para itens em drives compartilhados. |
modifiedByMe |
Apenas saída. Se o arquivo foi modificado por este usuário. |
permissionIds[] |
Somente saída. files.list de IDs de permissão para usuários com acesso a este arquivo. |
imageMediaMetadata |
Apenas saída. Metadados adicionais sobre mídia de imagem, se disponíveis. |
imageMediaMetadata.flashUsed |
Apenas saída. Se um flash foi usado para criar a foto. |
imageMediaMetadata.meteringMode |
Apenas saída. O modo de medição usado para criar a foto. |
imageMediaMetadata.sensor |
Apenas saída. É o tipo de sensor usado para criar a foto. |
imageMediaMetadata.exposureMode |
Apenas saída. O modo de exposição usado para criar a foto. |
imageMediaMetadata.colorSpace |
Apenas saída. O espaço de cor da foto. |
imageMediaMetadata.whiteBalance |
Apenas saída. O modo de balanço de branco usado para criar a foto. |
imageMediaMetadata.width |
Apenas saída. A largura da imagem, em pixels. |
imageMediaMetadata.height |
Apenas saída. A altura da imagem, em pixels. |
imageMediaMetadata.location |
Apenas saída. Informações de localização geográfica armazenadas na imagem. |
imageMediaMetadata.location.latitude |
Apenas saída. A latitude armazenada na imagem. |
imageMediaMetadata.location.longitude |
Apenas saída. A longitude armazenada na imagem. |
imageMediaMetadata.location.altitude |
Apenas saída. A altitude armazenada na imagem. |
imageMediaMetadata.rotation |
Apenas saída. O número de rotações de 90 graus no sentido horário aplicadas a partir da orientação original da imagem. |
imageMediaMetadata.time |
Apenas saída. A data e a hora em que a foto foi tirada (EXIF DateTime). |
imageMediaMetadata.cameraMake |
Apenas saída. A marca da câmera usada para criar a foto. |
imageMediaMetadata.cameraModel |
Apenas saída. O modelo da câmera usado para criar a foto. |
imageMediaMetadata.exposureTime |
Apenas saída. A duração da exposição, em segundos. |
imageMediaMetadata.aperture |
Apenas saída. A abertura usada para criar a foto (número f). |
imageMediaMetadata.focalLength |
Apenas saída. A distância focal usada para criar a foto, em milímetros. |
imageMediaMetadata.isoSpeed |
Apenas saída. A velocidade ISO usada para criar a foto. |
imageMediaMetadata.exposureBias |
Apenas saída. O viés de exposição da foto (valor APEX). |
imageMediaMetadata.maxApertureValue |
Apenas saída. O menor número f da lente na distância focal usada para criar a foto (valor APEX). |
imageMediaMetadata.subjectDistance |
Apenas saída. A distância até o objeto da foto, em metros. |
imageMediaMetadata.lens |
Apenas saída. A lente usada para criar a foto. |
videoMediaMetadata |
Apenas saída. Metadados adicionais sobre mídia de vídeo. Esse recurso pode não estar disponível imediatamente após o upload. |
videoMediaMetadata.width |
Apenas saída. A largura do vídeo em pixels. |
videoMediaMetadata.height |
Apenas saída. A altura do vídeo em pixels. |
videoMediaMetadata.durationMillis |
Apenas saída. A duração do vídeo em milissegundos. |
shortcutDetails |
Detalhes do arquivo de atalho. Preenchido apenas para arquivos de atalho com o campo mimeType definido como |
shortcutDetails.targetId |
O ID do arquivo para o qual esse atalho aponta. |
shortcutDetails.targetMimeType |
Apenas saída. O tipo MIME do arquivo para onde esse atalho aponta. O valor desse campo é um instantâneo do tipo MIME do destino, capturado quando o atalho é criado. |
shortcutDetails.targetResourceKey |
Apenas saída. A ResourceKey do arquivo de destino. |
contentRestrictions[] |
Restrições para acessar o conteúdo do arquivo. Preenchido apenas se essa restrição existir. |
resourceKey |
Apenas saída. É necessária uma chave para acessar o item por meio de um link compartilhado. |
linkShareMetadata |
Apenas saída. Detalhes relacionados ao LinkShare. Contém detalhes sobre os URLs de links que os clientes estão usando para se referir a este item. |
linkShareMetadata.securityUpdateEligible |
Apenas saída. Se o arquivo está qualificado para atualização de segurança. |
linkShareMetadata.securityUpdateEnabled |
Apenas saída. Indica se a atualização de segurança está ativada para o arquivo. |
labelInfo |
Apenas saída. Uma visão geral dos rótulos no arquivo. |
labelInfo.labels[] |
Apenas saída. O conjunto de rótulos no arquivo conforme solicitado pelos IDs de rótulo no parâmetro |
sha1Checksum |
Apenas saída. A soma de verificação SHA1 associada a este arquivo, se disponível. Esse campo só é preenchido para os arquivos com conteúdo armazenado no Google Drive. Ele não é preenchido para os Editores de Documentos Google ou os arquivos de atalho. |
sha256Checksum |
Apenas saída. A soma de verificação SHA256 associada a este arquivo, se disponível. Esse campo só é preenchido para os arquivos com conteúdo armazenado no Google Drive. Ele não é preenchido para os Editores de Documentos Google ou os arquivos de atalho. |
Restrição de conteúdo
Uma restrição para acessar o conteúdo do arquivo.
Representação JSON |
---|
{
"readOnly": boolean,
"reason": string,
"type": string,
"restrictingUser": {
object ( |
Campos | |
---|---|
readOnly |
Se o conteúdo do arquivo é somente leitura. Se um arquivo for somente leitura, uma nova revisão do arquivo não poderá ser adicionada, os comentários não poderão ser adicionados ou modificados, e o título do arquivo não poderá ser modificado. |
reason |
Motivo da restrição do conteúdo do arquivo Isso só pode ser modificado em solicitações que também definem |
type |
Apenas saída. O tipo de restrição de conteúdo. Atualmente, o único valor possível é |
restrictingUser |
Apenas saída. O usuário que definiu a restrição de conteúdo. Preenchido apenas se |
restrictionTime |
Apenas saída. O horário em que a restrição de conteúdo foi definida (marcação de data e hora RFC 3339 formatada). Preenchido apenas se |
ownerRestricted |
Se a restrição de conteúdo só pode ser modificada ou removida por um usuário que seja o proprietário do arquivo. Nos arquivos em drives compartilhados, qualquer usuário com recursos do |
Métodos |
|
---|---|
|
Cria uma cópia de um arquivo e aplica todas as atualizações solicitadas com semântica de patch. |
|
Cria um novo arquivo. |
|
Exclui permanentemente um arquivo que pertence ao usuário sem movê-lo para a lixeira. |
|
Exclui permanentemente todos os arquivos do usuário na lixeira. |
|
Exporta um documento do Google Workspace para o tipo MIME solicitado e retorna o conteúdo de bytes exportado. |
|
Gera um conjunto de IDs de arquivos que podem ser fornecidos em solicitações de criação ou cópia. |
|
Recebe os metadados ou o conteúdo de um arquivo por ID. |
|
Lista os arquivos do usuário. |
|
Lista os rótulos em um arquivo. |
|
Modifica o conjunto de rótulos aplicados a um arquivo. |
|
Atualiza os metadados e/ou o conteúdo de um arquivo. |
|
Inscreve as alterações feitas em um arquivo. |