Cómo agregar propiedades de archivos personalizadas

Las propiedades de archivo personalizadas son pares clave-valor que se usan para almacenar metadatos personalizados de un archivo de Google Drive (como etiquetas), IDs de otros almacenes de datos, información compartida entre aplicaciones de flujo de trabajo, etcétera. Por ejemplo, puedes agregar propiedades de archivo a todos los documentos que genera el departamento de Ventas en el primer trimestre.

Para agregar propiedades visibles para todas las aplicaciones, usa el properties campo del files recurso. Para agregar propiedades restringidas a tu app, usa el campo appProperties del recurso files.

Las propiedades también se pueden usar en expresiones de búsqueda.

Esta es la estructura de una propiedad típica que se podría usar para almacenar el ID de la base de datos de un archivo de Drive en el archivo.

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

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

Trabaja con propiedades de archivo personalizadas

En esta sección, se explica cómo realizar algunas tareas relacionadas con las propiedades de archivo personalizadas que afectan a todas las aplicaciones.

Agrega o actualiza propiedades de archivo personalizadas

Para agregar o actualizar propiedades visibles para todas las aplicaciones, usa el files.update método para configurar el properties campo del files recurso.

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

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

También puedes agregar una propiedad personalizada a un archivo con el servicio avanzado de Drive en Google Apps Script. Para obtener más información, consulta Agrega propiedades personalizadas.

Obtén o enumera propiedades de archivo personalizadas

Para ver las propiedades visibles para todas las aplicaciones, usa el files.get método para recuperar las propiedades de archivo personalizadas del archivo.

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

La respuesta consiste en un objeto properties que contiene una colección de pares clave-valor.

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

Borra propiedades de archivo personalizadas

Para borrar los valores de las propiedades visibles para todas las aplicaciones, usa el files.update método para establecer el properties campo del files recurso como nulo.

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

{
  "name": null
}

Para ver el cambio, llama al files.get método para recuperar el properties objeto del archivo.

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

Límites de las propiedades de archivo personalizadas

Las propiedades personalizadas tienen los siguientes límites:

• Un máximo de 100 propiedades personalizadas por archivo, sumadas de todas las fuentes
• Un máximo de 30 propiedades públicas por archivo, sumadas de todas las fuentes
• Un máximo de 30 propiedades privadas por archivo de cualquier aplicación
• Un máximo de 124 bytes por cadena de propiedad (incluidas la clave y el valor) en codificación UTF-8 Por ejemplo, una propiedad con una clave de 10 caracteres solo puede tener 114 caracteres en el valor. Del mismo modo, una propiedad que requiere 100 caracteres para el valor puede usar hasta 24 caracteres para la clave.

Para obtener más información, consulta el files recurso. Para la API de Drive v2, consulta el properties recurso.

Accede a propiedades de archivo personalizadas privadas

Solo puedes recuperar propiedades privadas con el campo appProperties a través de una solicitud autenticada que usa un token de acceso obtenido con un ID de cliente de OAuth 2.0. No puedes usar una clave de API para recuperar propiedades privadas.