Ir a la consola

Primeros pasos con Firebase Realtime Database para Unity

Firebase Realtime Database almacena y sincroniza datos con nuestra base de datos NoSQL en la nube. Los datos se sincronizan con todos los clientes en tiempo real y se mantiene disponible cuando tu app está sin conexión.

Antes de comenzar

Para usar Firebase Realtime Database, debes crear un proyecto de Firebase y agregar los paquetes del SDK de Firebase Unity al proyecto de Unity.

Configuración:

Requisitos previos

Android

  • Unity 5.0 o una versión más reciente
  • NDK de Android 10d o una versión más reciente

iOS

  • Unity 5.0 o una versión más reciente
  • Xcode 8.0 o una versión más reciente

Si todavía no tienes un proyecto de Unity, puedes descargar uno de los ejemplos de inicio rápido para probar una función de Firebase específica. Si usas un ejemplo de inicio rápido, recuerda consultar el identificador de paquete en la configuración del proyecto, ya que lo necesitarás en el próximo paso.

Configura la app en Firebase console

Para agregar Firebase a la app, debes tener un proyecto y un archivo de configuración de Firebase.

Para crear un proyecto de Firebase:

  1. Dirígete a Firebase console.

  2. Haz clic en Agregar proyecto, luego selecciona o ingresa un Nombre del proyecto.

    • Si hay un proyecto de Google existente asociado con tu app, selecciónalo desde el menú desplegable Nombre del proyecto.
    • Si no hay un proyecto de Google existente, ingresa un nuevo Nombre del proyecto.
  3. (Opcional) Edita el ID del proyecto.

    Firebase asignará de manera automática un ID único a tu proyecto de Firebase. Este identificador se muestra en los servicios de Firebase visibles de forma pública, por ejemplo:

    • URL predeterminada para la base de datos: your-project-id.firebaseio.com
    • Subdominio de hosting predeterminado: your-project-id.firebaseapp.com
  4. Sigue los pasos de configuración restantes y, luego, haz clic en Crear proyecto (o Agregar Firebase si usas un proyecto de Google existente).

Firebase aprovisiona los recursos para tu proyecto de forma automática. Este proceso suele tardar algunos minutos. Cuando finalice, verás la página descripción general del proyecto en Firebase console.

Android

  1. Haz clic en Agrega Firebase a tu app para Android y sigue los pasos de la configuración. Si importas un proyecto de Google existente, es posible que esto ocurra de forma automática y solo tengas que descargar el archivo de configuración.
  2. Ingresa el nombre del paquete de la app cuando se te solicite. Es importante que ingreses el nombre de paquete que usa la app. Esta configuración solo puede hacerse cuando agregas una app al proyecto de Firebase.
  3. Durante el proceso, descargarás un archivo google-services.json. Puedes volver a descargarlo en cualquier momento.
  4. Después de agregar el código de inicialización, ejecuta la app para verificar con Firebase console que instalaste Firebase correctamente.

iOS

  1. Haz clic en Agrega Firebase a la app para iOS y sigue los pasos de configuración. Si importas un proyecto de Google existente, es posible que esto ocurra de forma automática y solo tengas que descargar el archivo de configuración.
  2. Ingresa el ID del paquete de la app cuando se te solicite. Es importante que ingreses el ID del paquete que usa la app. Esta configuración solo puede hacerse cuando agregas una app al proyecto de Firebase.
  3. Durante el proceso, descargarás un archivo GoogleService-Info.plist. Puedes volver a descargarlo en cualquier momento.
  4. Después de agregar el código de inicialización, ejecuta la app para verificar con Firebase console que instalaste Firebase correctamente.
  5. Arrastra el archivo GoogleService-Info.plist que se descargó de Firebase console a cualquier carpeta del proyecto de Unity.

Agrega el SDK de Firebase Unity a la app

  1. Descarga el SDK de Firebase Unity.
  2. Selecciona el elemento de menú Activos > Importar paquete > Paquete personalizado.
  3. Importa FirebaseDatabase.unitypackage desde el directorio que coincide con la versión de Unity que usas:
    • Unity 5.x y las versiones anteriores usan .NET Framework 3.x, de modo que debes importar el paquete dotnet3/FirebaseDatabase.unitypackage .
    • Unity 2017.x y las versiones posteriores usan .NET Framework 4.x. Si tu proyecto está configurado para usar .NET 4.x, importa el paquete dotnet4/FirebaseDatabase.unitypackage .
  4. Cuando aparezca la ventana Importar paquete de Unity, haz clic en el botón Importar.

Inicializa el SDK

El SDK de Firebase Unity en Android requiere los Servicios de Google Play actualizados. Se debe agregar el siguiente código al inicio de la aplicación para buscar y, de forma opcional, actualizar los Servicios de Google Play a la versión que requiera el SDK de Firebase Unity a fin de que sea posible llamar a otros métodos en el SDK.

Firebase.FirebaseApp.CheckAndFixDependenciesAsync().ContinueWith(task => {
  var dependencyStatus = task.Result;
  if (dependencyStatus == Firebase.DependencyStatus.Available) {
    // Create and hold a reference to your FirebaseApp, i.e.
    //   app = Firebase.FirebaseApp.DefaultInstance;
    // where app is a Firebase.FirebaseApp property of your application class.

    // Set a flag here indicating that Firebase is ready to use by your
    // application.
  } else {
    UnityEngine.Debug.LogError(System.String.Format(
      "Could not resolve all Firebase dependencies: {0}", dependencyStatus));
    // Firebase Unity SDK is not safe to use here.
  }
});

Compila la app

Android

  1. Selecciona la opción de menú Archivo > Configuración de compilación.
  2. Selecciona Android en la lista Plataforma.
  3. Haz clic en Cambiar plataforma para establecer Android como plataforma seleccionada.
  4. Espera a que se detenga el ícono giratorio (de compilación en proceso) que se encuentra en la esquina inferior derecha de la barra de estado de Unity.
  5. Haz clic en Compilar y ejecutar.

iOS

  1. Selecciona la opción de menú Archivo > Configuración de compilación.
  2. Selecciona iOS en la lista Plataforma.
  3. Haz clic en Cambiar plataforma para establecer iOS como plataforma seleccionada.
  4. Espera a que se detenga el ícono giratorio (de compilación en proceso) que se encuentra en la esquina inferior derecha de la barra de estado de Unity.
  5. Haz clic en Compilar y ejecutar.

Cómo configurar el acceso público

Realtime Database proporciona un lenguaje de reglas declarativas que te permite definir cómo se deben estructurar tus datos, cómo se deben indexar y cuándo se pueden leer y escribir. Según la configuración predeterminada, el acceso de lectura y escritura a tu base de datos es restringido, por lo que solo los usuarios autenticados pueden leer o escribir datos. Para comenzar sin configurar Authentication, puedes definir tus reglas de acceso público. Esto hace que tus datos estén abiertos para todo el mundo, incluso las personas que no usan tu app, así que asegúrate de volver a restringir tu base de datos cuando configures la autenticación.

Cómo configurar el SDK para Unity Editor

Cuando pruebes tu escena en Unity Editor, puedes usar Realtime Database. Debes configurar el SDK con la URL de la base de datos apropiada. Llama a SetEditorDatabaseUrl con la URL de tu base de datos.

using Firebase;
using Firebase.Unity.Editor;

public class MyScript: MonoBehaviour {
  void Start() {
    // Set this before calling into the realtime database.
    FirebaseApp.DefaultInstance.SetEditorDatabaseUrl("https://YOUR-FIREBASE-APP.firebaseio.com/");
  }
}

Si decidiste usar el acceso público para tus reglas y estableciste la URL de la base de datos, puedes seguir con las secciones sobre el guardado y la recuperación de datos.

Opcional: Configuración de Editor para el acceso restringido

Si decides usar reglas que no permiten el acceso público, deberás configurar el SDK para usar una cuenta de servicio en la ejecución de Unity Editor. Esto te permitirá suplantar usuarios finales cuando hagas pruebas. Para esto, primero crea un archivo p12 nuevo a través de

https://console.cloud.google.com/iam-admin/serviceaccounts/project?project=YOUR-FIREBASE-APP

Registra el correo electrónico y la contraseña generados de la cuenta de servicio.

Ubica el archivo p12 en "Editor Default Resources" dentro de tu proyecto de Unity. A continuación, agrega el siguiente código para iniciar el uso de la cuenta de servicio.

using Firebase;
using Firebase.Unity.Editor;

public class MyScript: MonoBehaviour {
  void Start() {
    // Set these values before calling into the realtime database.
    FirebaseApp.DefaultInstance.SetEditorDatabaseUrl("https://YOUR-FIREBASE-APP.firebaseio.com/");
    FirebaseApp.DefaultInstance.SetEditorP12FileName("YOUR-FIREBASE-APP-P12.p12");
    FirebaseApp.DefaultInstance.SetEditorServiceAccountEmail("SERVICE-ACCOUNT-ID@YOUR-FIREBASE-APP.iam.gserviceaccount.com");
    FirebaseApp.DefaultInstance.SetEditorP12Password("notasecret");
  }
}

Pasos siguientes

Problemas conocidos

  • Cuando se usa el marco de trabajo experimental .NET 4.6, Realtime Database no se puede ejecutar en macOS con Unity 2017.2 debido a una regresión que se presentó en la versión 2017.2.0 y que desactivó SslStream en esa configuración. La regresión se solucionó en Unity 2017.3.0 y Realtime Database es compatible con esa versión.