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, "userPermission": { object ( |
Campos | |
---|---|
kind |
Apenas saída. O tipo de arquivo. É sempre |
userPermission |
Apenas saída. As permissões do usuário autenticado neste arquivo. |
fileExtension |
Apenas saída. O componente final de |
md5Checksum |
Apenas saída. Uma soma de verificação MD5 para o conteúdo desse arquivo. 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. |
selfLink |
Apenas saída. Um link para este arquivo. |
ownerNames[] |
Apenas saída. Nomes dos proprietários deste arquivo. Não preenchido para itens em drives compartilhados. |
lastModifyingUserName |
Apenas saída. O nome do último usuário que modificou o arquivo. |
editable |
Apenas saída. Obsoleto: use |
writersCanShare |
Se os autores podem compartilhar o documento com outros usuários. Não preenchido para itens em drives compartilhados. |
downloadUrl |
Apenas saída. URL de download de curta duração do arquivo. Esse campo só é preenchido para arquivos com conteúdo armazenado no Google Drive. não é preenchido para documentos do Google ou arquivos de atalho. |
mimeType |
O tipo MIME do arquivo. Isso só pode ser modificado na atualização ao enviar conteúdo novo. Este campo pode ser deixado em branco e o mimetype será determinado a partir do tipo MIME do conteúdo enviado. |
exportLinks |
Apenas saída. Links para exportar arquivos dos Editores de arquivos Google em formatos específicos. Um objeto com uma lista de pares |
driveId |
Apenas saída. ID do drive compartilhado em que o arquivo está localizado. Preenchido apenas para itens nos drives compartilhados. |
parents[] |
Coleção de pastas mãe que contém este arquivo. Se não for especificado como parte de uma solicitação de inserçã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 elemento pai detectável do arquivo de origem. As solicitações files.update também podem 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. 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 |
appDataContents |
Apenas saída. Indica se esse arquivo está na pasta "Dados do aplicativo". |
webViewLink |
Apenas saída. Um link disponível apenas em pastas públicas para a visualização dos recursos estáticos da Web (HTML, CSS, JS etc.) pela hospedagem de sites do Google Drive. |
iconLink |
Apenas saída. Um link 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 este 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 itens em drives compartilhados. |
openWithLinks |
Apenas saída. Um mapa do ID de cada app do usuário para um link para abrir o arquivo com esse app. Preenchido somente quando o escopo drive.apps.readonly é usado. Um objeto com uma lista de pares |
defaultOpenWithLink |
Apenas saída. Um link para abrir este arquivo com o app padrão do usuário. Preenchido somente quando o escopo drive.apps.readonly é usado. |
headRevisionId |
Apenas saída. O ID da revisão principal do arquivo. 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. |
properties[] |
A lista de propriedades. |
copyable |
Apenas saída. Obsoleto: use |
etag |
Apenas saída. ETag do arquivo. |
sharingUser |
Apenas saída. Usuário que compartilhou o item com o usuário atual, se disponível. |
alternateLink |
Apenas saída. Um link para abrir o arquivo em um editor ou visualizador relevante do Google. |
embedLink |
Apenas saída. Um link para incorporar o arquivo. |
webContentLink |
Apenas saída. Um link para fazer o download do conteúdo do arquivo em um navegador usando a autenticação com base em cookie. Nos casos em que o conteúdo é compartilhado publicamente, é possível fazer o download sem precisar de credenciais. |
fileSize |
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. |
copyRequiresWriterPermission |
Se as opções para copiar, imprimir ou fazer o download deste arquivo devem ser desativadas para leitores e comentadores. |
permissions[] |
Apenas saída. A lista de permissões dos usuários com acesso ao 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 aceitos são |
folderColorRgb |
Cor da pasta como uma string hexadecimal RGB se o arquivo for uma pasta ou um atalho para uma pasta. A lista de cores permitidas está disponível no campo folderColorPalette do recurso Sobre. Se uma cor não compatível for especificada, ela será alterada para a cor mais próxima na paleta. |
id |
O ID do arquivo. |
title |
O título deste arquivo. Para 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 título é constante. |
description |
Uma breve descrição do arquivo. |
labels |
Um grupo de rótulos para o arquivo. |
labels.viewed |
Indica se este arquivo foi visualizado por este usuário. |
labels.restricted |
Apenas saída. Obsoleto: use |
labels.starred |
Indica se este arquivo foi marcado com estrela pelo usuário. |
labels.hidden |
Apenas saída. Obsoleto. |
labels.trashed |
Indica se este arquivo foi para a lixeira. Esse marcador se aplica a todos os usuários que acessam o arquivo. No entanto, apenas os proprietários podem ver e remover os arquivos da lixeira. |
labels.modified |
Apenas saída. Indica se o arquivo foi modificado por esse usuário. |
explicitlyTrashed |
Apenas saída. Indica se este arquivo foi enviado para a lixeira explicitamente, ou não de modo recursivo. |
createdDate |
Apenas saída. Hora de criação para este arquivo (carimbo de data/hora RFC 3339 formatado). |
modifiedDate |
A última vez que este arquivo foi modificado por alguém (carimbo de data/hora RFC 3339 formatado). Só é mutável na atualização quando o parâmetro setModifiedDate está definido. |
modifiedByMeDate |
Apenas saída. A última vez que o arquivo foi modificado pelo usuário (carimbo de data/hora RFC 3339 formatado). Observe que a configuração "modifyDate" também vai atualizar a data de "modifyByMe" para o usuário que a definiu. |
lastViewedByMeDate |
A última vez que este arquivo foi visualizado pelo usuário (carimbo de data/hora RFC 3339 formatado). |
markedViewedByMeDate |
Apenas saída. Obsoleto. |
sharedWithMeDate |
Apenas saída. Hora em que o arquivo foi compartilhado com o usuário (carimbo de data/hora RFC 3339 formatado). |
quotaBytesUsed |
Apenas saída. O número de bytes de cota usados por esse arquivo. |
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 solicitante. |
indexableText |
Atributos de texto indexáveis para o arquivo (só podem ser gravados) |
indexableText.text |
O texto a ser indexado para este arquivo. |
originalFilename |
O nome de arquivo original do conteúdo enviado por upload, se disponível, ou o valor original do campo |
ownedByMe |
Apenas saída. Se o arquivo pertence ao usuário atual. Não preenchido para itens em drives compartilhados. |
canComment |
Apenas saída. Obsoleto: use |
shareable |
Apenas saída. Obsoleto: use |
fullFileExtension |
Apenas saída. A extensão completa do arquivo extraídos do título. Pode conter várias extensões concatenadas, como "tar.gz". Remover uma extensão do título não limpa esse campo. No entanto, alterar a extensão no título atualiza esse campo. 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. |
isAppAuthorized |
Apenas saída. Se o arquivo foi criado ou aberto pelo app solicitante. |
teamDriveId |
Apenas saída. Obsoleto: 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.canChangeRestrictedDownload |
Apenas saída. Obsoleto. |
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 |
Apenas saída. Obsoleto: use |
capabilities.canMoveTeamDriveItem |
Apenas saída. Obsoleto: use |
capabilities.canChangeCopyRequiresWriterPermission |
Apenas saída. Define se o usuário atual pode mudar a restrição |
capabilities.canMoveItemIntoTeamDrive |
Apenas saída. Obsoleto: 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 |
Apenas saída. Obsoleto: use |
capabilities.canMoveItemOutOfTeamDrive |
Apenas saída. Obsoleto: 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 |
Apenas saída. Obsoleto: use |
capabilities.canMoveChildrenWithinTeamDrive |
Apenas saída. Obsoleto: 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 em 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. |
canReadRevisions |
Apenas saída. Obsoleto: use |
thumbnailVersion |
Apenas saída. A versão em miniatura para uso na invalidação do cache de miniaturas. |
trashedDate |
Apenas saída. O horário em que o item foi enviado para a lixeira (carimbo de data/hora RFC 3339 formatado). Preenchido apenas para itens nos drives compartilhados. |
permissionIds[] |
Apenas saída. files.list de IDs de permissão dos usuários com acesso ao arquivo. |
thumbnail |
Uma miniatura do arquivo. Isso será usado apenas se uma miniatura padrão não puder ser gerada. |
thumbnail.image |
Os bytes codificados em Base64 seguros para URL da imagem em miniatura. Ele precisa estar em conformidade com a seção 5 do RFC 4648. Uma string codificada em base64. |
thumbnail.mimeType |
O tipo MIME da miniatura. |
imageMediaMetadata |
Apenas saída. Metadados sobre mídia de imagem. Ele só vai estar presente para tipos de imagem, e o conteúdo vai depender do que pode ser analisado. |
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.date |
Apenas saída. Data e hora em que a foto foi tirada (carimbo de data/hora no formato EXIF). |
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 sobre mídia de vídeo. Essa opção só estará presente para tipos de vídeo. |
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 |
restrictionDate |
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 do |
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 do arquivo especificado. |
|
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 inserção ou cópia. |
|
Recebe os metadados ou o conteúdo de um arquivo por ID. |
|
Insere um novo arquivo. |
|
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. |
|
Defina a hora de atualização do arquivo como a hora atual do servidor. |
|
Move um arquivo para a lixeira. |
|
Restaura um arquivo da lixeira. |
|
Atualiza os metadados e/ou o conteúdo de um arquivo. |
|
Faz a inscrição nas alterações de um arquivo. |