Introducción a Android Studio y las notificaciones push

​

Información general

1. Google Play Services
2. Firebase Cloud Messaging Services (FCM, creado sobre el antiguo Google Cloud Messaging).
3. Servicios de PlayFab
4. Aplicaciones cliente

​

1. Google Play Services

​

2. Firebase Cloud Messaging (FCM)

​

3. Servicios de PlayFab

​

4. Servicios de cliente

​

División en cuatro partes

​

Requisitos previos

• Debe tener una cuenta de Google.
• Debe tener una cuenta de PlayFab.
• Un icono de notificación generado con el generador de iconos de notificación de Android Asset Studio.

​

Escenario

• Inicia sesión en PlayFab mediante un identificador de dispositivo Android.
• Recibe notificaciones push de PlayFab.

​

Capítulo 1: Configuración de Firebase

• Para ello, seleccione el área Add project, como se muestra en la imagen siguiente.

• Se le pedirá que proporcione un nombre de proyecto (en este tutorial usamos nuestra Foo PlayFab App, pero asegúrese de idear su propio nombre al seguir este tutorial).
• Seleccione el botón Create Project para avanzar al paso siguiente.

• Agregue una nueva aplicación Android al proyecto seleccionando el área que se muestra en la imagen siguiente.

1. En primer lugar, debe proporcionar un nombre de paquete de Android. Nosotros usamos com.foo.playfab.app, pero asegúrese de idear su propio nombre de paquete al seguir este tutorial.
2. Seleccione el botón Register App para pasar al paso siguiente.

• Después de descargarlo, seleccione el botón Continue para pasar al paso siguiente.

3. El paso final ofrece información sobre cómo configurar su proceso de compilación para conectar los SDK de Firebase y Google Play.

• Seleccione el botón Finish para continuar.

• Una vez agregada la aplicación, aparecerá en el panel.
• En este punto, la configuración está completa y necesitamos extraer la clave de servidor de FCM (que usaremos para conectar las notificaciones push de PlayFab).
• Vaya a Project settings, como se muestra en la imagen siguiente.

• En Project settings, vaya a la pestaña Cloud Messaging.
• Busque el área Server Key (el área en rojo de la imagen que se muestra a continuación).
• Copie esta clave y guárdela en un lugar seguro y de fácil acceso.

​

Capítulo 2: Configuración de Google Play Console

• Asigne el título.

• Seleccione el botón Create para continuar.

• Se abrirá la página del proyecto de Google Play Console.
• Seleccione Services & APIs en el menú lateral.

• Se abrirá la página Services configuration.
• Busque el panel Firebase Cloud Messaging.
• Seleccione el botón Link a Sender ID, como se muestra en la imagen siguiente.

• Use la clave de servidor de FCM que recibió (y guardó) al usar la consola de Firebase en el capítulo anterior.
• Cuando termine, seleccione el botón Link, como se muestra en nuestro ejemplo.

• Dedique un momento a comprobar que el identificador de remitente que se muestra en Google Play Console coincide con el de la consola de Firebase, como se muestra en el ejemplo siguiente.

​

Capítulo 3: Configuración del título de PlayFab

• En primer lugar, debe ir a Title settings en el menú de configuración de su título.
• Seleccione la pestaña Push Notifications.
• Para la opción de Android, seleccione el icono de configuración.

• Se le pedirá su clave de API de servidor de Google.
• Copie la que recibió a través de la consola de Firebase, como se muestra en el ejemplo proporcionado a continuación.

• Si todo es correcto, se le presentará una página que muestra las notificaciones push como activas.

​

Capítulo 4: Configuración del proyecto de Android Studio

• Descargue aquí la biblioteca JAR del JavaSDK de cliente de PlayFab.
• Busque client-sdk-*.jar y el Java Doc correspondiente si lo necesita.
• Descargue la versión más reciente de Google GSON.
• Busque gson-*.jar.
• Tenga a mano los archivos .jar mencionados anteriormente.

• Compruebe que el nombre de paquete coincide con el que ha usado a lo largo de este tutorial (en Firebase, por ejemplo).

• Seleccione el SDK mínimo de su elección.
• A continuación, seleccione el botón Next.

• Seleccione la plantilla que quiere usar.
• A continuación, seleccione el botón Next.

• Configure la plantilla como quiera.
• Seleccione el botón Finish.

• Cambie a la pestaña Project (1).

• Compruebe que este archivo se encuentra en la carpeta App (2).
• A continuación, vaya a Tools (3).
• Seleccione Firebase (4), como se muestra en el ejemplo proporcionado a continuación.

• Busque la carpeta Cloud Messaging y seleccione Set up Firebase Cloud Messaging, como se muestra a continuación.

• En el Asistente de notificaciones de Firebase, seleccione el botón Add FCM to your app (1), como se muestra en la imagen siguiente.
• Se abrirá un cuadro de diálogo que indica que se agregarán nuevas dependencias mediante Gradle.
• Seleccione Accept Changes (2) para aceptar los cambios.

• Para configurar las dependencias correctamente, reemplace las líneas agregadas automáticamente por las siguientes: implementation 'com.google.firebase:firebase-core:16.0.3
implementation 'com.google.firebase:firebase-messaging:17.0.0

• Compruebe que el Asistente de notificaciones de Firebase indica que las dependencias ahora están configuradas correctamente (1).

• Para asegurarse de que estos archivos JAR aparecen en la carpeta app/libs (2), seleccione todos los archivos y haga clic con el botón derecho en ellos.
• A continuación, elija Add as library… (3), como se muestra en el ejemplo proporcionado a continuación.

• Con el generador de iconos de notificación de Android Asset Studio, prepare los iconos y colóquelos dentro de app/src/main/res.
• En el ejemplo que se muestra a continuación, el icono se denomina ic_stat_blur_on.

• Por último, seleccione Rebuild Project.

1. app/src/main/AndroidManifest.xml
2. app/src/main/java/..packagePath../MainActivity.java
3. app/src/main/java/..packagePath../FooAppFirebaseInstanceIdService.java
4. app/src/main/java/..packagePath../FooAppFirebaseMessagingService.java

​

AndroidManifest.xml

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="MY_PACKAGE_IDENTIFIER">
    <uses-permission android:name="android.permission.INTERNET" />

    <application
        android:allowBackup="true"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:supportsRtl="true"
        android:theme="@style/AppTheme">
        <activity android:name=".MainActivity">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />
                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>

        <!-- The following block enables our custom Firebase Instance ID Service-->
        <service android:name=".FooAppFirebaseInstanceIdService" android:exported="true">
            <intent-filter>
                <action android:name="com.google.firebase.INSTANCE_ID_EVENT"/>
            </intent-filter>
        </service>

        <service
            android:name=".FooAppFirebaseMessagingService" android:exported="true">
            <intent-filter>
                <action android:name="com.google.firebase.MESSAGING_EVENT"/>
            </intent-filter>
        </service>

    </application>

</manifest>

​

MainActivity.java

• PLAYFAB_TITLE_ID
  • Use el identificador de su título que recibió en Game Manager de PlayFab.
• PACKAGE_IDENTIFIER
  • Use el identificador de paquete de Java que coincida con su configuración.

package PACKAGE_IDENTIFIER;

import android.os.AsyncTask;
import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.util.Log;
import com.playfab.PlayFabClientAPI;
import com.playfab.PlayFabClientModels.*;
import com.playfab.PlayFabErrors;
import com.playfab.PlayFabSettings;
import java.util.List;
import java.util.Map;

public class MainActivity extends AppCompatActivity {

    // Invoked when activity is started
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        // Set PlayFab title
        PlayFabSettings.TitleId = "PLAYFAB_TITLE_ID";

        // Start login operation
        AsyncTask.execute(new Runnable() {
            @Override
            public void run() {
                if(login()) FooAppFirebaseInstanceIdService.setAllowRegisterForPush(true); // Ready to register for push notifications
            }
        });
    }

    public boolean login(){
        LoginWithAndroidDeviceIDRequest request = new LoginWithAndroidDeviceIDRequest();
        request.CreateAccount = true;

        // There are several approaches on getting unique android device id.
        // https://stackoverflow.com/questions/2785485/is-there-a-unique-android-device-id
        request.AndroidDeviceId = "qwerty";

        PlayFabErrors.PlayFabResult<LoginResult> response = PlayFabClientAPI.LoginWithAndroidDeviceID(request);
        if(response.Error != null){
            Log.d("Foo PlayFab App",CompileErrorsFromResult(response.Error));
            return false;
        }
        return true;
    }

    // Utility method to compose an error message out of PlayFab result.
    private static String CompileErrorsFromResult(PlayFabErrors.PlayFabError error) {
        if (error == null)
            return null;

        String errorMessage = "";
        if (error.errorMessage != null)
            errorMessage += error.errorMessage;
        if (error.errorDetails != null)
            for (Map.Entry<String, List<String>> pair : error.errorDetails.entrySet())
                for (String msg : pair.getValue())
                    errorMessage += "\n" + pair.getKey() + ": " + msg;
        return errorMessage;
    }
}

​

FooAppFirebaseInstanceIdService.java

• PACKAGE_IDENTIFIER
  • El identificador de paquete de Java que coincida con su configuración.

package PACKAGE_IDENTIFIER;

import android.text.TextUtils;
import android.util.Log;
import com.google.firebase.iid.FirebaseInstanceId;
import com.google.firebase.iid.FirebaseInstanceIdService;
import com.playfab.PlayFabClientAPI;
import com.playfab.PlayFabClientModels;
import com.playfab.PlayFabErrors;
import java.util.List;
import java.util.Map;

public class FooAppFirebaseInstanceIdService extends FirebaseInstanceIdService {

    private static String _token;

    private static boolean _allowRegistration;

    // This is invoked from activity that performs authentication.
    // Once login is complete this method is invoked.
    // If we have a pending token, we use it to register for push notifications
    public static void setAllowRegisterForPush(boolean isAllowed) {
        _allowRegistration = isAllowed;
        if (_allowRegistration && !TextUtils.isEmpty(_token)) {
            registerForPush(_token);
        }
    }

    // Invoked when firebase has fetched a token
    // If we already have logged in, we use new token to register for push
    @Override
    public void onTokenRefresh() {
        _token = FirebaseInstanceId.getInstance().getToken();
        if (_allowRegistration && !TextUtils.isEmpty(_token)) {
            registerForPush(_token);
        }
    }

    private static void registerForPush(String token) {
        PlayFabClientModels.AndroidDevicePushNotificationRegistrationRequest request = new PlayFabClientModels.AndroidDevicePushNotificationRegistrationRequest();
        request.DeviceToken = token;

        PlayFabErrors.PlayFabResult<PlayFabClientModels.AndroidDevicePushNotificationRegistrationResult> response = PlayFabClientAPI.AndroidDevicePushNotificationRegistration(request);

        if (response.Error != null) {
            Log.d("Foo PlayFab App", CompileErrorsFromResult(response.Error));
        }
    }

    // Utility method to compose an error message out of PlayFab result.
    private static String CompileErrorsFromResult(PlayFabErrors.PlayFabError error) {
        if (error == null)
            return null;

        String errorMessage = "";
        if (error.errorMessage != null)
            errorMessage += error.errorMessage;
        if (error.errorDetails != null)
            for (Map.Entry<String, List<String>> pair : error.errorDetails.entrySet())
                for (String msg : pair.getValue())
                    errorMessage += "\n" + pair.getKey() + ": " + msg;
        return errorMessage;
    }

}

​

FooAppFirebaseMessagingService.java

• PACKAGE_IDENTIFIER
  • El identificador de paquete de Java que coincida con su configuración.

package com.foo.playfab.app;

import android.util.Log;
import com.google.firebase.messaging.FirebaseMessagingService;
import com.google.firebase.messaging.RemoteMessage;

public class FooAppFirebaseMessagingService extends FirebaseMessagingService {

    @Override
    public void onMessageReceived(RemoteMessage message) {
        // Intercept the message here
        Log.d("Foo PlayFab App","Message received: "+message.getNotification().getBody());
    }
}

​

Pruebas

• Una vez que inicie la aplicación, esta iniciará sesión automáticamente y se registrará para las notificaciones push.
• Seleccione el botón Inicio de su dispositivo para minimizar la aplicación. Esto es importante, ya que nos permite probar la notificación que llega a la bandeja del sistema.
• A continuación, vaya a la página de Game Manager de su título de PlayFab y use el panel para localizar el registro push más reciente.
• Seleccione el identificador del jugador (1).

• Seleccione el botón Send Push Notification (1).
• Escriba el título (2).
• Escriba el cuerpo de su mensaje (3).
• Confirme los cambios seleccionando el botón Send Push Notification (4).

• Compruebe que el mensaje llega a su dispositivo.