Las propiedades de archivos 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 compartidos entre aplicaciones de flujo de trabajo, etcétera. Por ejemplo, puedes agregar propiedades a todos los documentos generados por el departamento de ventas en el primer trimestre.
Para agregar propiedades visibles para todas las aplicaciones, usa el campo properties de la
files. Cómo agregar propiedades
restringido a tu app, usa el campo appProperties del recurso files.
Las propiedades también se pueden usar en la búsqueda con expresiones regulares.
Esta es la estructura de una propiedad típica que podría usarse para almacenar una El ID de la base de datos del archivo de Drive en el archivo.
API de Drive v3
"appProperties": {
"additionalID": "ID",
}
API de Drive v2
{
'key': 'additionalID',
'value': 'ID',
'visibility': 'PRIVATE'
}
Cómo trabajar con propiedades de archivos personalizados
En esta sección, se explica cómo realizar algunas tareas relacionadas con las propiedades de los archivos personalizados que afectará a todas las aplicaciones.
Agrega o actualiza propiedades de archivos personalizados
Para agregar o actualizar propiedades visibles para todas las aplicaciones, usa el
files.update para establecer la
Campo properties de 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 la función avanzada Servicio de Drive en Google Apps Script. Para obtener más información, consulta Agregado de campaña propiedades.
Cómo obtener o enumerar propiedades de archivos personalizados
Para ver las propiedades visibles para todas las aplicaciones, usa el
files.get para recuperar las
propiedades de archivo personalizadas del archivo.
GET https://www.googleapis.com/drive/v3/files/FILE_ID?fields=properties
La respuesta consta de un objeto properties que contiene una colección de
pares clave-valor.
{
"properties": {
"name": "wrench",
"mass": "1.3kg",
"count": "3"
}
}
Borrar propiedades del archivo personalizado
Para borrar valores de propiedad visibles para todas las aplicaciones, usa la
files.update para establecer la
Campo properties de files
resource a null.
PATCH https://www.googleapis.com/drive/v3/files/FILE_ID
{
"name": null
}
Para ver el cambio, llama al
files.get para recuperar las
properties para el archivo.
{
"properties": {
"mass": "1.3kg",
"count": "3"
}
}
Límites de las propiedades de los archivos personalizados
Las propiedades personalizadas tienen los siguientes límites:
- Un máximo de 100 propiedades personalizadas por archivo, en total de todas las fuentes.
- Se permite un máximo de 30 propiedades públicas por archivo, desde todas las fuentes.
- Se permite un máximo de 30 propiedades privadas por archivo desde cualquier aplicación.
- Un máximo de 124 bytes por cadena de propiedad (incluidos la clave y el valor) en Se debe utilizar la codificación UTF-8. Por ejemplo, una propiedad con una clave de 10 caracteres solo puede tener 114 caracteres en el valor. De manera similar, una propiedad que requiere 100 caracteres para el valor puede utilizar hasta 24 caracteres para el .
Para obtener más información, consulta la files.
recurso. Para la API de Drive v2, consulta la
Recurso properties.
Cómo acceder a propiedades de archivos personalizados privados
Solo puedes recuperar propiedades privadas mediante el campo appProperties a través de
una solicitud autenticada que usa un token de acceso obtenido con OAuth 2.0
ID de cliente. No puedes usar una clave de API para recuperar propiedades privadas.