Usa metadatos de archivos con Cloud Storage en Android

Después de subir un archivo a la referencia de Cloud Storage, también puedes obtener y actualizar los metadatos de archivos; por ejemplo, para ver o 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().

Kotlin+KTX

// Create a storage reference from our app
val storageRef = storage.reference

// Get reference to the file
val forestRef = storageRef.child("images/forest.jpg")

forestRef.metadata.addOnSuccessListener { metadata ->
    // Metadata now contains the metadata for 'images/forest.jpg'
}.addOnFailureListener {
    // Uh-oh, an error occurred!
}StorageActivity.kt

Java

// Create a storage reference from our app
StorageReference storageRef = storage.getReference();

// Get reference to the file
StorageReference forestRef = storageRef.child("images/forest.jpg");

forestRef.getMetadata().addOnSuccessListener(new OnSuccessListener<StorageMetadata>() {
    @Override
    public void onSuccess(StorageMetadata storageMetadata) {
        // Metadata now contains the metadata for 'images/forest.jpg'
    }
}).addOnFailureListener(new OnFailureListener() {
    @Override
    public void onFailure(@NonNull Exception exception) {
        // Uh-oh, an error occurred!
    }
});StorageActivity.java

Actualiza metadatos de archivo

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.

Kotlin+KTX

// Create a storage reference from our app
val storageRef = storage.reference

// Get reference to the file
val forestRef = storageRef.child("images/forest.jpg")

// Create file metadata including the content type
val metadata = storageMetadata {
    contentType = "image/jpg"
    setCustomMetadata("myCustomProperty", "myValue")
}

// Update metadata properties
forestRef.updateMetadata(metadata).addOnSuccessListener { updatedMetadata ->
    // Updated metadata is in updatedMetadata
}.addOnFailureListener {
    // Uh-oh, an error occurred!
}StorageActivity.kt

Java

// Create a storage reference from our app
StorageReference storageRef = storage.getReference();

// Get reference to the file
StorageReference forestRef = storageRef.child("images/forest.jpg");

// Create file metadata including the content type
StorageMetadata metadata = new StorageMetadata.Builder()
        .setContentType("image/jpg")
        .setCustomMetadata("myCustomProperty", "myValue")
        .build();

// Update metadata properties
forestRef.updateMetadata(metadata)
        .addOnSuccessListener(new OnSuccessListener<StorageMetadata>() {
            @Override
            public void onSuccess(StorageMetadata storageMetadata) {
                // Updated metadata is in storageMetadata
            }
        })
        .addOnFailureListener(new OnFailureListener() {
            @Override
            public void onFailure(@NonNull Exception exception) {
                // Uh-oh, an error occurred!
            }
        });StorageActivity.java

Para borrar propiedades de los metadatos que admiten escritura, puedes pasar null:

Kotlin+KTX

// Create file metadata with property to delete
val metadata = storageMetadata {
    contentType = null
}

// Delete the metadata property
forestRef.updateMetadata(metadata).addOnSuccessListener { updatedMetadata ->
    // updatedMetadata.contentType should be null
}.addOnFailureListener {
    // Uh-oh, an error occurred!
}StorageActivity.kt

Java

// Create file metadata with property to delete
StorageMetadata metadata = new StorageMetadata.Builder()
        .setContentType(null)
        .build();

// Delete the metadata property
forestRef.updateMetadata(metadata)
        .addOnSuccessListener(new OnSuccessListener<StorageMetadata>() {
            @Override
            public void onSuccess(StorageMetadata storageMetadata) {
                // metadata.contentType should be null
            }
        })
        .addOnFailureListener(new OnFailureListener() {
            @Override
            public void onFailure(@NonNull Exception exception) {
                // Uh-oh, an error occurred!
            }
        });StorageActivity.java

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.

Personaliza metadatos

Puedes especificar metadatos personalizados con el método setCustomMetadata() de la clase StorageMetadata.Builder.

Kotlin+KTX

val metadata = storageMetadata {
    setCustomMetadata("location", "Yosemite, CA, USA")
    setCustomMetadata("activity", "Hiking")
}StorageActivity.kt

Java

StorageMetadata metadata = new StorageMetadata.Builder()
        .setCustomMetadata("location", "Yosemite, CA, USA")
        .setCustomMetadata("activity", "Hiking")
        .build();StorageActivity.java

Puedes almacenar datos específicos de tu app para cada archivo en forma de metadatos personalizados, 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:

Método get de la propiedad	Tipo	Existe método set
`getBucket`	`String`	NO
`getGeneration`	`String`	NO
`getMetadataGeneration`	`String`	NO
`getPath`	`String`	NO
`getName`	`String`	NO
`getSizeBytes`	`long`	NO
`getCreationTimeMillis`	`long`	NO
`getUpdatedTimeMillis`	`long`	NO
`getMd5Hash`	`String`	NO
`getCacheControl`	`String`	SÍ
`getContentDisposition`	`String`	SÍ
`getContentEncoding`	`String`	SÍ
`getContentLanguage`	`String`	SÍ
`getContentType`	`String`	SÍ
`getCustomMetadata`	`String`	SÍ
`getCustomMetadataKeys`	`Set<String>`	NO

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