Recurso: File
Os metadados de um arquivo.
Alguns métodos de recursos (como files.update
) exigem um fileId
. Use o método files.list
para recuperar o ID de um arquivo.
Representação JSON |
---|
{ "exportLinks": { string: string, ... }, "parents": [ string ], "owners": [ { object ( |
Campos | |
---|---|
exportLinks |
Apenas saída. Links para exportar arquivos dos editores de documentos para formatos específicos. Um objeto com uma lista de pares |
parents[] |
O ID da pasta mãe que contém o arquivo. Um arquivo só pode ter uma pasta mãe. Não é possível especificar várias pastas mãe. 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 vai herdar qualquer pai detectável do arquivo de origem. As solicitações "files.update" precisam usar os parâmetros |
owners[] |
Apenas saída. O proprietário do arquivo. Somente alguns arquivos legados podem ter mais de um proprietário. Esse campo não é preenchido para itens em drives compartilhados. |
permissions[] |
Apenas saída. A lista completa de permissões do arquivo. Isso só está disponível se o usuário solicitante puder compartilhar o arquivo. Não é preenchido para itens em drives compartilhados. |
spaces[] |
Apenas saída. A lista de espaços que contêm o arquivo. Os valores aceitos no momento são "drive", "appDataFolder" e "photos". |
properties |
Uma coleção de pares de chave-valor arbitrários visíveis para todos os apps. As 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 ao app solicitante. As 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 |
permissionIds[] |
Somente saída. "files.list" de IDs de permissão para usuários com acesso a esse arquivo. |
contentRestrictions[] |
Restrições para acessar o conteúdo do arquivo. Preenchido apenas se houver uma restrição. |
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 em drives compartilhados. |
fileExtension |
Apenas saída. O componente final de |
copyRequiresWriterPermission |
Se as opções de copiar, imprimir ou fazer o download deste arquivo devem ser desativadas para leitores e comentaristas. |
md5Checksum |
Apenas saída. A soma de verificação MD5 do conteúdo do arquivo. Isso só se aplica 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 que o arquivo melhore as consultas fullText. O limite é de 128 KB de comprimento, e ele pode conter elementos HTML. |
contentHints.thumbnail |
Uma miniatura do arquivo. Isso só será usado se o Google Drive não conseguir gerar uma miniatura padrão. |
contentHints.thumbnail.image |
Os dados da miniatura codificados com Base64 seguro para URL (seção 5 da RFC 4648). Uma string codificada em base64. |
contentHints.thumbnail.mimeType |
O tipo MIME da miniatura. |
writersCanShare |
Se os usuários com permissão apenas de |
viewedByMe |
Apenas saída. Indica se o arquivo foi visualizado pelo usuário. |
mimeType |
O tipo MIME do arquivo. O Google Drive tenta detectar automaticamente um valor adequado do conteúdo enviado, caso nenhum valor seja 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 dos Documentos Google, o conteúdo enviado será importado, se possível. Os formatos de importação compatíveis são publicados no recurso "Sobre". |
thumbnailLink |
Apenas saída. Um link de curta duração para a miniatura do arquivo, se disponível. Geralmente dura algumas horas. Não é destinado ao uso direto em aplicativos da Web devido às políticas de Compartilhamento de recursos entre origens (CORS). 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 foi feita por um usuário conectado. |
headRevisionId |
Apenas saída. O ID da revisão principal do arquivo. No momento, isso 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 baixar o conteúdo do arquivo em um navegador. Essa opção 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 do editor próprios. Não será preenchido para arquivos sem tamanho, como atalhos e pastas. |
viewersCanCopyContent |
Descontinuado: use |
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 a presença do campo "thumbnailLink". |
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 sem suporte for especificada, a cor mais próxima na paleta será usada. |
id |
O ID do arquivo. |
name |
O nome do arquivo. Isso não precisa ser exclusivo em uma pasta. Para itens imutáveis, como as pastas de nível superior dos drives compartilhados, a pasta raiz do Meu Drive e a pasta "Dados de aplicativos", o nome é constante. |
description |
Uma breve descrição do arquivo. |
starred |
Se o usuário adicionou o arquivo aos favoritos. |
trashed |
Se o arquivo foi movido para a lixeira, explicitamente ou de uma pasta mãe movida para a lixeira. Somente o proprietário pode mover um arquivo para a lixeira, e outros usuários não podem ver os arquivos na lixeira do proprietário. |
explicitlyTrashed |
Apenas saída. Se o arquivo foi movido explicitamente para a lixeira, em vez de ter sido movido recursivamente de uma pasta mãe. |
createdTime |
O horário em que o arquivo foi criado (data e hora RFC 3339). |
modifiedTime |
A última vez que o arquivo foi modificado por alguém (data e hora RFC 3339). Definir |
modifiedByMeTime |
Apenas saída. A última vez que o arquivo foi modificado pelo usuário (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 (data e hora RFC 3339). |
quotaBytesUsed |
Apenas saída. O número de bytes da cota de armazenamento usados pelo arquivo. Isso inclui a revisão do cabeçalho, bem como as revisões anteriores com o |
version |
Apenas saída. Um número de versão monotonicamente crescente para o arquivo. Isso reflete todas as mudanças feitas no arquivo no servidor, mesmo as que não estão visíveis para o usuário. |
originalFilename |
O nome original do conteúdo enviado, se disponível, ou o valor original do campo |
ownedByMe |
Apenas saída. Indica se o usuário é proprietário do arquivo. Não é preenchido para itens em drives compartilhados. |
fullFileExtension |
Apenas saída. A extensão completa do arquivo extraída do campo Ele é atualizado automaticamente quando o campo |
isAppAuthorized |
Apenas saída. Se o arquivo foi criado ou aberto pelo app solicitante. |
teamDriveId |
Descontinuado: somente saída. Use |
capabilities |
Apenas saída. Capacidades que o usuário atual tem neste arquivo. Cada funcionalidade corresponde a uma ação refinada que um usuário pode realizar. |
capabilities.canChangeViewersCanCopyContent |
Descontinuado: somente saída. |
capabilities.canMoveChildrenOutOfDrive |
Apenas saída. Se o usuário atual pode mover filhos desta pasta para fora do drive compartilhado. É "false" 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 este 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 mudanças 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 são pastas desse item 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. Se o usuário atual pode adicionar filhos a esta pasta. Isso é sempre falso quando o item não é uma pasta. |
capabilities.canDelete |
Apenas saída. Indica se o usuário atual pode excluir o arquivo. |
capabilities.canDownload |
Apenas saída. Se o usuário atual pode baixar este 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 itens 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 esse arquivo. |
capabilities.canTrash |
Apenas saída. Indica 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, indica se é possível ler as revisões de descendentes que não são pastas desse item ou o próprio item, se ele não for uma pasta. |
capabilities.canReadTeamDrive |
Descontinuado: somente saída. Use |
capabilities.canMoveTeamDriveItem |
Descontinuado: somente saída. Use |
capabilities.canChangeCopyRequiresWriterPermission |
Apenas saída. Se o usuário atual pode mudar a restrição |
capabilities.canMoveItemIntoTeamDrive |
Descontinuado: 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. Se o usuário atual pode modificar o conteúdo deste arquivo. |
capabilities.canMoveItemWithinTeamDrive |
Descontinuado: somente saída. Use |
capabilities.canMoveItemOutOfTeamDrive |
Descontinuado: somente saída. Use |
capabilities.canDeleteChildren |
Apenas saída. Se o usuário atual pode excluir filhos desta pasta. É "false" quando o item não é uma pasta. Preenchido apenas para itens em drives compartilhados. |
capabilities.canMoveChildrenOutOfTeamDrive |
Descontinuado: somente saída. Use |
capabilities.canMoveChildrenWithinTeamDrive |
Descontinuado: somente saída. Use |
capabilities.canTrashChildren |
Apenas saída. Indica se o usuário atual pode excluir os itens desta pasta. É "false" quando o item não é uma pasta. Preenchido apenas para itens em drives compartilhados. |
capabilities.canMoveItemOutOfDrive |
Apenas saída. Se o usuário atual pode mover o item para fora do drive mudando o pai dele. Uma solicitação para mudar 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 ao item sem remover um pai existente na mesma solicitação. Não é preenchido para arquivos de drives compartilhados. |
capabilities.canRemoveMyDriveParent |
Apenas saída. Se o usuário atual pode remover um familiar responsável do item sem adicionar outro na mesma solicitação. Não é preenchido para arquivos de drives compartilhados. |
capabilities.canMoveItemWithinDrive |
Apenas saída. Indica se o usuário atual pode mover este item no drive. Uma solicitação para mudar 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. Indica se o usuário atual pode modificar as configurações de compartilhamento deste arquivo. |
capabilities.canMoveChildrenWithinDrive |
Apenas saída. Se o usuário atual pode mover os filhos desta pasta dentro desta unidade. É "false" quando o item não é uma pasta. Uma solicitação para mover a criança ainda pode falhar, dependendo do acesso do usuário atual à criança e à pasta de destino. |
capabilities.canModifyContentRestriction |
Descontinuado: somente saída. Use um dos seguintes: |
capabilities.canAddFolderFromAnotherDrive |
Apenas saída. Se o usuário atual pode adicionar uma pasta de outro drive (drive compartilhado diferente ou Meu Drive) a esta pasta. É "false" 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 mudar o campo "securityUpdateEnabled" nos metadados de compartilhamento de link. |
capabilities.canAcceptOwnership |
Apenas saída. Indica 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 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 restritas ao editor. |
capabilities.canModifyOwnerContentRestriction |
Apenas saída. Indica se o usuário atual pode adicionar ou modificar restrições de conteúdo que são 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. |
capabilities.canDisableInheritedPermissions |
Se um usuário pode desativar as permissões herdadas. |
capabilities.canEnableInheritedPermissions |
Se um usuário pode reativar as permissões herdadas. |
capabilities.canChangeItemDownloadRestriction |
Apenas saída. Se o usuário atual pode mudar o proprietário ou as restrições de download aplicadas pelo organizador do arquivo. |
hasAugmentedPermissions |
Apenas saída. Se há permissões diretamente neste arquivo. Esse campo só é preenchido para itens em drives compartilhados. |
trashingUser |
Apenas saída. Se o arquivo foi movido para a lixeira, o usuário que fez isso. Preenchido apenas para itens em drives compartilhados. |
thumbnailVersion |
Apenas saída. A versão da miniatura para uso na invalidação do cache de miniaturas. |
trashedTime |
Apenas saída. O horário em que o item foi movido para a lixeira (data e hora RFC 3339). Preenchido apenas para itens em drives compartilhados. |
modifiedByMe |
Apenas saída. Indica se o arquivo foi modificado por este usuário. |
imageMediaMetadata |
Apenas saída. Outros metadados 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 equilíbrio 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 da orientação original da imagem. |
imageMediaMetadata.time |
Apenas saída. A data e a hora em que a foto foi tirada (DateTime 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. A distância focal usada para criar a foto, em milímetros. |
imageMediaMetadata.isoSpeed |
Apenas saída. A sensibilidade ISO usada para criar a foto. |
imageMediaMetadata.exposureBias |
Apenas saída. A compensação da 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. Essa opção pode não estar disponível imediatamente após o envio. |
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 a que o atalho aponta. Só pode ser definido em solicitações |
shortcutDetails.targetMimeType |
Apenas saída. O tipo MIME do arquivo a que este atalho aponta. O valor desse campo é um snapshot do tipo MIME do destino, capturado quando o atalho é criado. |
shortcutDetails.targetResourceKey |
Apenas saída. O ResourceKey do arquivo de destino. |
resourceKey |
Apenas saída. Uma chave necessária para acessar o item por um link compartilhado. |
linkShareMetadata |
Apenas saída. Detalhes relacionados ao LinkShare. Contém detalhes sobre os URLs de link 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 este 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 esse arquivo, se disponível. Esse campo só é preenchido para arquivos com conteúdo armazenado no Google Drive, não para editores do Documentos 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, não para editores do Documentos ou arquivos de atalho. |
inheritedPermissionsDisabled |
Se este arquivo tem permissões herdadas desativadas. As permissões herdadas são ativadas por padrão. |
downloadRestrictions |
Restrições de download aplicadas ao arquivo. |
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, nem mudar o título. |
reason |
Motivo da restrição do conteúdo do arquivo. Isso só pode ser alterado em solicitações que também definem |
type |
Apenas saída. O tipo de restrição de conteúdo. No momento, 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 (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 proprietário do arquivo. Para 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. |
DownloadRestrictionsMetadata
Restrições de download aplicadas ao arquivo.
Representação JSON |
---|
{ "itemDownloadRestriction": { object ( |
Campos | |
---|---|
itemDownloadRestriction |
A restrição de download do arquivo aplicada diretamente pelo proprietário ou organizador. Isso não considera as configurações do drive compartilhado nem as regras de DLP. |
effectiveDownloadRestrictionWithContext |
Apenas saída. A restrição de download efetiva aplicada a este arquivo. Isso considera todas as configurações de restrição e regras da DLP. |
DownloadRestriction
Uma restrição para cópia e download do arquivo.
Representação JSON |
---|
{ "restrictedForReaders": boolean, "restrictedForWriters": boolean } |
Campos | |
---|---|
restrictedForReaders |
Se o download e a cópia estão restritos para leitores. |
restrictedForWriters |
Se o download e a cópia são restritos para gravadores. Se for verdadeiro, o download também será restrito para os leitores. |
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. |
|
Faz o download do conteúdo de um arquivo. |
|
Exclui permanentemente todos os arquivos movidos para a lixeira do usuário. |
|
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 arquivo 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. |
|
Inscreve-se para receber notificações sobre mudanças em um arquivo. |