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á localizado Preenchido apenas para itens nos drives compartilhados. |
fileExtension |
Apenas saída. O componente final de |
copyRequiresWriterPermission |
Se as opções para copiar, imprimir ou fazer o download deste 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. Ele está limitado a 128 KB de comprimento e pode conter elementos HTML. |
contentHints.thumbnail |
Uma miniatura do arquivo. Essa opção será usada apenas se o Google Drive não puder gerar uma miniatura padrão. |
contentHints.thumbnail.image |
Os dados de miniatura codificados com Base64 seguro para URL (seção 5 do RFC 4648). Uma string codificada em base64. |
contentHints.thumbnail.mimeType |
O tipo MIME da miniatura. |
writersCanShare |
Define se os usuários com apenas a permissão |
viewedByMe |
Apenas saída. Indica se o arquivo foi visualizado por este usuário. |
mimeType |
O tipo MIME do arquivo. O Google Drive tenta detectar automaticamente um valor apropriado no conteúdo enviado por upload, se nenhum valor for fornecido. O valor não pode ser alterado, a menos que uma nova revisão seja enviada. Se um arquivo for criado com um tipo MIME do Documentos Google, o conteúdo enviado por upload 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 arquivos Google em formatos específicos. Um objeto com uma lista de pares |
parents[] |
O ID da pasta principal que contém o arquivo. Um arquivo só pode ter uma pasta principal. não é possível especificar vários pais. 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á qualquer pai detectável do arquivo de origem. As solicitações 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 cerca de horas. Não se destina ao uso direto em aplicativos da Web devido às políticas de Compartilhamento de recursos entre origens (CORS, na sigla em inglês). Considere usar um servidor proxy. 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 em drives compartilhados. |
lastModifyingUser |
Apenas saída. O último usuário a modificar o arquivo. Esse campo só é preenchido quando a última modificação é realizada por um usuário conectado. |
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 itens em drives compartilhados. |
headRevisionId |
Apenas saída. O ID da revisão principal 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 de editor próprios. Não são preenchidas 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 só estará disponível se o usuário solicitante puder compartilhar o arquivo. Não preenchido para itens em drives compartilhados. |
hasThumbnail |
Apenas saída. Indica se o arquivo tem uma miniatura. Isso não indica se o app solicitante tem acesso à miniatura. Para verificar o acesso, procure o campothumbnailLink. |
spaces[] |
Apenas saída. A lista de espaços que contém o arquivo. Os valores compatíveis no momento são "drive" e "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 não compatível for especificada, será usada a cor mais próxima na paleta. |
id |
O ID do arquivo. |
name |
O nome do arquivo. Ele não é necessariamente único dentro de uma pasta. No caso de 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 enviado para a lixeira, explicitamente ou de uma pasta principal movida para a lixeira. Somente o proprietário pode enviar um arquivo para a lixeira, e os outros usuários não podem vê-lo. |
explicitlyTrashed |
Apenas saída. Se o arquivo foi enviado para a lixeira explicitamente, ou não de uma pasta mãe de maneira recorrente. |
createdTime |
A hora em que o arquivo foi criado (data-hora RFC 3339). |
modifiedTime |
A última vez que o arquivo foi modificado por alguém (data-hora RFC 3339). A definição de |
modifiedByMeTime |
Apenas saída. A última vez que o arquivo foi modificado pelo usuário (data-hora RFC 3339). |
viewedByMeTime |
A última vez que o arquivo foi visualizado pelo usuário (data-hora RFC 3339). |
sharedWithMeTime |
Apenas saída. A hora em que o arquivo foi compartilhado com o usuário, se aplicável (data-hora RFC 3339). |
quotaBytesUsed |
Apenas saída. O número de bytes da cota de armazenamento usados pelo arquivo. Isso inclui a revisão principal, bem como revisões anteriores com |
version |
Apenas saída. Um número de versão monotonicamente crescente do 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 por upload, se disponível, ou o valor original do campo |
ownedByMe |
Apenas saída. Se o usuário é o proprietário do arquivo. Não preenchido para itens em 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 são visíveis para todos os apps. Entradas com valores nulos são apagadas 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 do app solicitante. Entradas com valores nulos são apagadas 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 privadas. 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 que o usuário atual tem nesse arquivo. Cada recurso corresponde a uma ação específica que um usuário pode realizar. |
capabilities.canChangeViewersCanCopyContent |
Obsoleto: somente saída. |
capabilities.canMoveChildrenOutOfDrive |
Apenas saída. Define 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 nos drives compartilhados. |
capabilities.canReadDrive |
Apenas saída. Define se o usuário atual pode ler o drive compartilhado a que o arquivo pertence. Preenchido apenas para itens nos drives compartilhados. |
capabilities.canEdit |
Apenas saída. Se o usuário atual pode editar o arquivo. Outros fatores podem limitar os tipos 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 o arquivo. Para um item em um drive compartilhado, se o usuário atual pode copiar os descendentes deste item que não são pastas ou o 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. Define se o usuário atual pode adicionar filhos à pasta. Esse atributo é sempre "false" quando o item não é uma pasta. |
capabilities.canDelete |
Apenas saída. Se o usuário atual pode excluir o arquivo. |
capabilities.canDownload |
Apenas saída. Se o usuário atual pode fazer o download desse arquivo. |
capabilities.canListChildren |
Apenas saída. Define se o usuário atual pode listar os filhos desta pasta. Esse atributo é sempre "false" quando o item não é uma pasta. |
capabilities.canRemoveChildren |
Apenas saída. Define se o usuário atual pode remover filhos desta pasta. Esse atributo é sempre "false" 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 o arquivo. |
capabilities.canTrash |
Apenas saída. Se o usuário atual pode mover o arquivo para a lixeira. |
capabilities.canReadRevisions |
Apenas saída. Se o usuário atual pode ler o recurso de revisões deste arquivo. Para um item do drive compartilhado, é possível ler se revisões de descendentes deste item (ou do item em si, se não for uma pasta) podem ser lidas. |
capabilities.canReadTeamDrive |
Obsoleto: somente saída. Use |
capabilities.canMoveTeamDriveItem |
Obsoleto: somente saída. Use |
capabilities.canChangeCopyRequiresWriterPermission |
Apenas saída. Define se o usuário atual pode mudar a restrição |
capabilities.canMoveItemIntoTeamDrive |
Obsoleto: somente saída. Use |
capabilities.canUntrash |
Apenas saída. Indica se o usuário atual pode restaurar o arquivo da lixeira. |
capabilities.canModifyContent |
Apenas saída. 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. Define se o usuário atual pode excluir filhos desta pasta. Isso é falso quando o item não é uma pasta. Preenchido apenas para itens nos drives compartilhados. |
capabilities.canMoveChildrenOutOfTeamDrive |
Obsoleto: somente saída. Use |
capabilities.canMoveChildrenWithinTeamDrive |
Obsoleto: somente saída. Use |
capabilities.canTrashChildren |
Apenas saída. Indica se o usuário atual pode enviar os filhos desta pasta para a lixeira. Isso é falso quando o item não é uma pasta. Preenchido apenas para itens nos drives compartilhados. |
capabilities.canMoveItemOutOfDrive |
Apenas saída. Define se o usuário atual pode mover o item para fora deste drive alterando o elemento pai. Uma solicitação para alterar o pai do item ainda pode falhar, dependendo do novo pai que estiver sendo adicionado. |
capabilities.canAddMyDriveParent |
Apenas saída. Define se o usuário atual pode adicionar um pai ao item sem remover um pai existente na mesma solicitação. Não preenchido para arquivos de drives compartilhados. |
capabilities.canRemoveMyDriveParent |
Apenas saída. Define se o usuário atual pode remover um pai do item sem adicionar outro pai na mesma solicitação. Não preenchido para arquivos de drives compartilhados. |
capabilities.canMoveItemWithinDrive |
Apenas saída. Define se o usuário atual pode mover o 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 deste arquivo. |
capabilities.canMoveChildrenWithinDrive |
Apenas saída. Define se o usuário atual pode mover filhos desta pasta neste drive. Isso é falso quando o item não é uma pasta. Observe que uma solicitação para mover o filho ainda poderá falhar, dependendo do acesso do usuário atual ao filho e à pasta de destino. |
capabilities.canModifyContentRestriction |
Obsoleto: somente saída. Use |
capabilities.canAddFolderFromAnotherDrive |
Apenas saída. Indica se o usuário atual pode adicionar uma pasta de outro drive (outro drive compartilhado ou "Meu Drive") a essa pasta. Isso é falso quando o item não é uma pasta. Preenchido apenas para itens nos drives compartilhados. |
capabilities.canChangeSecurityUpdateEnabled |
Apenas saída. Define se o usuário atual pode alterar o campo securityUpdateEnabled nos metadados do compartilhamento de link. |
capabilities.canAcceptOwnership |
Apenas saída. Se o usuário atual é o proprietário pendente do arquivo. Não preenchido para arquivos de drives compartilhados. |
capabilities.canReadLabels |
Apenas saída. Se o usuário atual pode ler os rótulos no arquivo. |
capabilities.canModifyLabels |
Apenas saída. Se o usuário atual pode modificar os rótulos no arquivo. |
capabilities.canModifyEditorContentRestriction |
Apenas saída. Define se o usuário atual pode adicionar ou modificar restrições de conteúdo no arquivo que têm restrição para editores. |
capabilities.canModifyOwnerContentRestriction |
Apenas saída. Se o usuário atual pode adicionar ou modificar restrições de conteúdo restritas ao 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. Indica se há permissões diretamente neste arquivo. Esse campo só é preenchido para itens nos drives compartilhados. |
trashingUser |
Apenas saída. Se o arquivo foi explicitamente enviado para a lixeira, o usuário que o moveu para a lixeira. Preenchido apenas para itens nos drives compartilhados. |
thumbnailVersion |
Apenas saída. A versão em miniatura para uso na invalidação do cache de miniaturas. |
trashedTime |
Apenas saída. O horário em que o item foi enviado para a lixeira (data-hora RFC 3339). Preenchido apenas para itens nos drives compartilhados. |
modifiedByMe |
Apenas saída. Indica se o arquivo foi modificado por esse usuário. |
permissionIds[] |
Apenas saída. files.list de IDs de permissão dos usuários com acesso ao arquivo. |
imageMediaMetadata |
Apenas saída. Metadados adicionais sobre mídia de imagem, se disponíveis. |
imageMediaMetadata.flashUsed |
Apenas saída. Indica se o 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 usada 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. É o comprimento focal usado 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. Talvez ele não apareça 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, que têm o campo mimeType definido como |
shortcutDetails.targetId |
O ID do arquivo para o qual esse atalho aponta. Só pode ser definido em solicitações |
shortcutDetails.targetMimeType |
Apenas saída. O tipo MIME do arquivo para o qual esse atalho aponta. O valor desse campo é um resumo do tipo MIME do destino, capturado quando o atalho é criado. |
shortcutDetails.targetResourceKey |
Apenas saída. A ResourceKey do arquivo de destino. |
contentRestrictions[] |
Restrições de acesso ao conteúdo do arquivo. Preenchido apenas se essa restrição existir. |
resourceKey |
Apenas saída. Uma chave necessária 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 ao 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 marcadores 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 arquivos com conteúdo armazenado no Google Drive. ele não é preenchido para Editores de arquivos Google ou 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 arquivos com conteúdo armazenado no Google Drive. ele não é preenchido para Editores de arquivos Google ou arquivos de atalho. |
ContentRestriction
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, não será possível adicionar uma nova revisão nem adicionar ou modificar comentários, e o título do arquivo não poderá ser modificado. |
reason |
Motivo pelo qual o conteúdo do arquivo está restrito. Só é mutável 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. A hora em que a restrição de conteúdo foi definida (carimbo de data/hora RFC 3339 formatado). Preenchido apenas se |
ownerRestricted |
Se a restrição de conteúdo só pode ser modificada ou removida por um usuário que é proprietário do arquivo. Nos arquivos em drives compartilhados, qualquer usuário com recursos de |
systemRestricted |
Apenas saída. Se a restrição de conteúdo foi aplicada pelo sistema, por exemplo, devido a uma assinatura eletrônica. Os usuários não podem modificar ou remover restrições de conteúdo restrito pelo sistema. |
Métodos |
|
---|---|
|
Cria uma cópia de um arquivo e aplica as atualizações solicitadas com semântica de patch. |
|
Cria um novo arquivo. |
|
Exclui permanentemente um arquivo de propriedade do 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 marcadores aplicados a um arquivo. |
|
Atualiza os metadados e/ou o conteúdo de um arquivo. |
|
Faz a inscrição nas alterações de um arquivo. |