Usa metadatos de archivos con Cloud Storage en la Web

Después de subir un archivo a la referencia de Cloud Storage, también puedes obtener o actualizar los metadatos del archivo, por ejemplo, para actualizar el tipo de contenido. Los archivos también pueden almacenar pares clave-valor personalizados con metadatos de archivo adicionales.

Obtén metadatos de archivos

Los metadatos de archivos contienen propiedades comunes, como name, size y contentType (a menudo, denominado tipo de MIME), además de otros menos comunes, como contentDisposition y timeCreated. Estos metadatos se pueden recuperar de una referencia de Cloud Storage con el método getMetadata(). getMetadata() muestra una Promise que contiene los metadatos completos, o bien un error si se rechaza la Promise.

Web

import { getStorage, ref, getMetadata } from "firebase/storage";

// Create a reference to the file whose metadata we want to retrieve
const storage = getStorage();
const forestRef = ref(storage, 'images/forest.jpg');

// Get metadata properties
getMetadata(forestRef)
  .then((metadata) => {
    // Metadata now contains the metadata for 'images/forest.jpg'
  })
  .catch((error) => {
    // Uh-oh, an error occurred!
  });
storage_get_metadata.js

Web

// Create a reference to the file whose metadata we want to retrieve
var forestRef = storageRef.child('images/forest.jpg');

// Get metadata properties
forestRef.getMetadata()
  .then((metadata) => {
    // Metadata now contains the metadata for 'images/forest.jpg'
  })
  .catch((error) => {
    // Uh-oh, an error occurred!
  });
file-metadata.js

Actualiza metadatos de archivos

Para actualizar los metadatos de un archivo en cualquier momento después de haberlo subido, puedes usar el método updateMetadata(). Consulta la lista completa para obtener más información sobre qué propiedades se pueden actualizar. Solo se actualizan las propiedades especificadas en los metadatos; todas las demás quedan sin cambios. updateMetadata() muestra una Promise que contiene los metadatos completos, o bien un error si se rechaza la Promise.

Web

import { getStorage, ref, updateMetadata } from "firebase/storage";

// Create a reference to the file whose metadata we want to change
const storage = getStorage();
const forestRef = ref(storage, 'images/forest.jpg');

// Create file metadata to update
const newMetadata = {
  cacheControl: 'public,max-age=300',
  contentType: 'image/jpeg'
};

// Update metadata properties
updateMetadata(forestRef, newMetadata)
  .then((metadata) => {
    // Updated metadata for 'images/forest.jpg' is returned in the Promise
  }).catch((error) => {
    // Uh-oh, an error occurred!
  });
storage_update_metadata.js

Web

// Create a reference to the file whose metadata we want to change
var forestRef = storageRef.child('images/forest.jpg');

// Create file metadata to update
var newMetadata = {
  cacheControl: 'public,max-age=300',
  contentType: 'image/jpeg'
};

// Update metadata properties
forestRef.updateMetadata(newMetadata)
  .then((metadata) => {
    // Updated metadata for 'images/forest.jpg' is returned in the Promise
  }).catch((error) => {
    // Uh-oh, an error occurred!
  });
file-metadata.js

Para borrar una propiedad de los metadatos, configúrala como null:

Web

import { getStorage, ref, updateMetadata } from "firebase/storage";

const storage = getStorage();
const forestRef = ref(storage, 'images/forest.jpg');

// Create file metadata with property to delete
const deleteMetadata = {
  contentType: null
};

// Delete the metadata property
updateMetadata(forestRef, deleteMetadata)
  .then((metadata) => {
    // metadata.contentType should be null
  }).catch((error) => {
    // Uh-oh, an error occurred!
  });
storage_delete_metadata.js

Web

// Create file metadata with property to delete
var deleteMetadata = {
  contentType: null
};

// Delete the metadata property
forestRef.updateMetadata(deleteMetadata)
  .then((metadata) => {
    // metadata.contentType should be null
  }).catch((error) => {
    // Uh-oh, an error occurred!
  });
file-metadata.js

Soluciona errores

Existen diferentes motivos por los que pueden producirse errores cuando se quieren obtener o actualizar metadatos. Por ejemplo, es posible que el archivo no exista o que el usuario no tenga permiso para acceder al archivo deseado. Para obtener más información sobre los errores, consulta la sección de los documentos denominada Soluciona errores.

Metadatos personalizados

Puedes especificar metadatos personalizados como un objeto que contenga propiedades String.

Web

const metadata = {
  customMetadata: {
    'location': 'Yosemite, CA, USA',
    'activity': 'Hiking'
  }
};
storage_custom_metadata.js

Web

var metadata = {
  customMetadata: {
    'location': 'Yosemite, CA, USA',
    'activity': 'Hiking'
  }
};
file-metadata.js

Puedes usar metadatos personalizados a fin de almacenar datos específicos adicionales de la app para cada archivo, pero te recomendamos que uses una base de datos (como Firebase Realtime Database) para almacenar y sincronizar este tipo de datos.

Propiedades de los metadatos de archivos

A continuación, puedes ver una lista completa de las propiedades de metadatos de un archivo:

Propiedad Tipo Admite escritura
bucket string NO
generation string NO
metageneration string NO
fullPath string NO
name string NO
size número NO
timeCreated string NO
updated string NO
md5Hash string SÍ en una carga, NO con updateMetadata
cacheControl string SÍ
contentDisposition string SÍ
contentEncoding string SÍ
contentLanguage string SÍ
contentType string SÍ
customMetadata Objeto que contiene asignaciones string->string SÍ

Es importante subir, descargar y actualizar archivos, pero también lo es poder quitarlos. Veamos cómo borrar archivos desde Cloud Storage.