Adicionar propriedades de arquivo personalizadas

As propriedades de arquivo personalizado são pares de chave-valor usados para armazenar metadados personalizados para um Arquivo do Google Drive (como tags), IDs de outros repositórios de dados, informações compartilhados entre aplicativos de fluxo de trabalho e assim por diante. Por exemplo, é possível adicionar arquivos propriedades a todos os documentos gerados pelo departamento de vendas no primeiro trimestre.

Para adicionar propriedades visíveis para todos os aplicativos, use o campo properties da files. Para adicionar propriedades restritas ao seu app, use o campo appProperties do recurso files.

As propriedades também podem ser usadas na pesquisa expressões regulares.

Essa é a estrutura de uma propriedade típica que pode ser usada para armazenar um ID do banco de dados do arquivo do Drive no arquivo.

"appProperties": {
  "additionalID": "ID",
}

{
  'key':        'additionalID',
  'value':      'ID',
  'visibility': 'PRIVATE'
}

Como trabalhar com propriedades de arquivos personalizadas

A seção explica como executar algumas tarefas relacionadas a propriedades de arquivos personalizados que que afetam todos os aplicativos.

Adicionar ou atualizar propriedades de arquivos personalizados

Para adicionar ou atualizar as propriedades visíveis para todos os aplicativos, use o Método files.update para definir o Campo properties do files recurso.

PATCH https://www.googleapis.com/drive/v3/files/FILE_ID

{
  "properties": {
    "name": "wrench",
    "mass": "1.3kg",
    "count": "3"
  }
}

Também é possível adicionar uma propriedade personalizada a um arquivo com a função serviço do Drive no Google Apps Script. Para mais informações, consulte Adição de personalizados do Terraform.

Receber ou listar propriedades personalizadas do arquivo

Para acessar as propriedades visíveis para todos os aplicativos, use o Método files.get para recuperar o propriedades de arquivo personalizadas para o arquivo.

GET https://www.googleapis.com/drive/v3/files/FILE_ID?fields=properties

A resposta consiste em um objeto properties que contém uma coleção de pares de chave-valor.

{
  "properties": {
    "name": "wrench",
    "mass": "1.3kg",
    "count": "3"
  }
}

Excluir propriedades de arquivo personalizadas

Para excluir valores de propriedade visíveis para todos os aplicativos, use o método Método files.update para definir o Campo properties do files recurso como nulo.

PATCH https://www.googleapis.com/drive/v3/files/FILE_ID

{
  "name": null
}

Para ver a alteração, chame o método Método files.get para recuperar o properties para o arquivo.

{
  "properties": {
    "mass": "1.3kg",
    "count": "3"
  }
}

Limites das propriedades de arquivo personalizadas

As propriedades personalizadas têm os seguintes limites:

• Máximo de 100 propriedades personalizadas por arquivo, totalizando de todas as origens.
• Máximo de 30 propriedades públicas por arquivo, totalizando de todas as origens.
• Máximo de 30 propriedades privadas por arquivo de qualquer aplicativo.
• Máximo de 124 bytes por string de propriedade (incluindo chave e valor) em Codificação UTF-8. Por exemplo, uma propriedade com uma chave que tem 10 caracteres pode ter apenas 114 caracteres no valor. Da mesma forma, uma propriedade que requer 100 caracteres para o valor pode usar até 24 caracteres para o de dados.

Para mais informações, consulte files recurso. Para a API Drive v2, consulte a properties.

Acessar propriedades de arquivos personalizados particulares

Só é possível recuperar propriedades particulares usando o campo appProperties por meio do uma solicitação autenticada que usa um token de acesso obtido com um OAuth 2.0 ID do cliente. Não é possível usar uma chave de API para recuperar propriedades privadas.