csharp

プッシュ通知 (Unity)¶

プッシュ通知の設定¶

APNs証明書の設定 (iOS) と FCMの設定 (Android) を参照し、設定してください。

Firebase Unity SDKを導入する¶

Firebaseの公式ドキュメントを参照し FirebaseMessaging.unitypackage をインポートしてください。

警告

Repro Unity Package 6.5.0 以下、あるいは Firebase Cloud Messaging for Unity 7.2.0 以下を使用される場合には FirebaseInstanceId.unitypackage を追加でインポートしてください。

警告

Firebaseのパッケージをインポートした後、導入時に修正したAndroidManifest.xml がFirebaseの設定で上書きされることがあります。そのため、インポート後にもう一度 AndroidManifest.xml を修正してください。

iOSプラットフォーム¶

iOSプラットフォームでは、ご使用のUnityのバージョンによって実装方法が異なります。 Unityのバージョンをご確認の上、実装方法を選択してください。

デバイストークンをReproに送信 (Unity 2019.4 未満の場合)¶

ここではUnityの公式APIを利用して実装を行います。公式APIの詳細はこちらを参照してください。

XcodeのCapabilitiesにてPush NotificationsをONにします。

MonoBehaviour を継承したクラスの Start() メソッドにてAPNsへの端末登録処理を行います。また同じクラスの Update() メソッドにてReproにデバイストークンをセットします。

using UnityEngine;

#if UNITY_IOS
using NotificationServices = UnityEngine.iOS.NotificationServices;
using NotificationType = UnityEngine.iOS.NotificationType;
#endif

public class MyBehaviour : MonoBehaviour {

  bool tokenSent;

  void Start () {
    ...

#if UNITY_IOS
    tokenSent = false;
    NotificationServices.RegisterForNotifications(
        NotificationType.Alert |
        NotificationType.Badge |
        NotificationType.Sound);
#endif

    ...
  }

  void Update () {
#if UNITY_IOS
    // Send device token to Repro
    if (!tokenSent) {
      byte[] token = NotificationServices.deviceToken;
      if (token != null) {
        string hexToken = System.BitConverter.ToString(token).Replace("-", "");
        Repro.SetPushDeviceToken(hexToken);
        tokenSent = true;
      }
    }
#endif
  }
}

デバイストークンをReproに送信 (Unity 2019.4 以上の場合)¶

ここでは Mobile Notifications package を用いてプッシュ通知の実装を行います。

まず、Unity Package Manager を用いてプロジェクトに Mobile Notifications package を導入してください。導入方法はこちらを参照してください。

次に、Unity Editorの Project Settings > Mobile Notifications にて Enable Push Notifications を有効にしてください。

最後に、以下のように MonoBehavior を継承したクラスで Repro.SetPushDeviceToken() にデバイストークンをセットします。

#if UNITY_IOS
using Unity.Notifications.iOS;
#endif
...

public class MyBehaviour : MonoBehaviour {

    public void Start()
    {
        ...
#if UNITY_IOS
        StartCoroutine(RequestAuthorization());
#endif
    }

#if UNITY_IOS
    IEnumerator RequestAuthorization()
    {
        var authorizationOption = AuthorizationOption.Alert | AuthorizationOption.Badge | AuthorizationOption.Sound;
        using (var req = new AuthorizationRequest(authorizationOption, true))
        {
            while (!req.IsFinished)
            {
                yield return null;
            };
            Repro.SetPushDeviceToken(req.DeviceToken);
        }
    }
#endif
}

設定の詳細はこちらを参照してください。

Androidプラットフォーム¶

`AndroidManifest.xml` ファイルを編集する¶

Receiverの登録¶

以下のXML中の "YOUR_PACKAGE_NAME" をアプリケーションのパッケージ名に置き換え、AndroidManifest.xmlの <application> タグの中に追加してください。

<receiver
    android:name="io.repro.android.ReproReceiver"
    android:exported="true"
    android:permission="com.google.android.c2dm.permission.SEND">
    <intent-filter>
        <action android:name="com.google.android.c2dm.intent.RECEIVE" />
        <category android:name="YOUR_PACKAGE_NAME" />
    </intent-filter>
</receiver>

通知チャンネルの設定¶

Android Oにて、ユーザーが通知を管理できるように通知チャンネルが導入されました。

Repro SDKで利用する通知チャンネルの設定を行うには、「ID」「名前」「ユーザー向けの説明」「badgeの表示有無」を指定する必要があります。以下のXML中の value, resource を設定したい値に書き換え、AndroidManifest.xmlの <application> タグの中に追加してください。 IDと名前の指定は必須、その他は省略可能です。「ユーザー向けの説明」省略時は空文字列、「badgeの表示有無」省略時はbadgeの表示有りとなります。

警告

アプリのtargetSDKVersionが26以上かつAndroid O以降の機種で動作させる場合、IDと名前が指定されていなければSDKはReproからのプッシュ通知を表示いたしませんのでご注意ください。
ChannelId に指定する値は、整数や小数ではなく test ID のような文字列を指定してください。文字列以外の値を指定するとチャンネルIDの指定がうまく動作せず、プッシュ通知が表示されません。
ChannelName と ChannelDescription の設定は android:resource 属性を使用してください。

<meta-data
    android:name="io.repro.android.PushNotification.ChannelId"
    android:value="YOUR_CHANNEL_ID">
</meta-data>

<meta-data
    android:name="io.repro.android.PushNotification.ChannelName"
    android:resource="@string/YOUR_CHANNEL_NAME">
</meta-data>

<meta-data
    android:name="io.repro.android.PushNotification.ChannelDescription"
    android:resource="@string/YOUR_CHANNEL_DESCRIPTION">
</meta-data>

<meta-data
    android:name="io.repro.android.PushNotification.ShowBadge"
    android:value="true">
</meta-data>

指定されたIDの通知チャンネルが存在しない場合はAndroidManifest.xmlの指定を基にSDKが自動で作成し、指定されたIDの通知チャンネルが存在する場合は既存のものを利用します。

既存のものを利用する場合、SDKは「名前」、「ユーザー向けの説明」及び「チャンネルの重要度」を更新します。

また、アプリのtargetSDKVersionが25以下の場合、あるいは、Android O未満の機種の場合は、SDKは上記の通知チャンネルに関する設定を無視します。

注釈

通知チャンネルはAndroid Oで導入されたAndroidの標準機能です。通知チャンネルの詳細はこちらをご覧ください。

アイコンと背景色のカスタマイズ¶

Android5.0以降の機種で、通知エリアに表示されるアイコンとその背景色をカスタマイズする場合は、以下のXMLをAndroidManifest.xmlの <application> タグの中に追加してください。Android5.0未満の機種では以下の設定は無視され、通知エリアにはアプリケーションのアイコンおよびシステムデフォルトの背景色が使用されます。

<meta-data
    android:name="io.repro.android.PushNotification.SmallIcon"
    android:resource="@drawable/YOUR_ICON_ID">
</meta-data>

<meta-data
    android:name="io.repro.android.PushNotification.AccentColor"
    android:resource="@color/YOUR_COLOR_ID">
</meta-data>

Registration IDをReproに送信¶

MonoBehaviour を継承したクラスの Start() メソッドにて、 Repro.EnablePushNotification() を呼び出してください。

Registration IDが更新された時はこちらの方法で取得可能です。取得したRegistration IDを Repro.SetPushRegistrationID() でセットしてください。

using UnityEngine;

public class MyBehaviour : MonoBehaviour {

  void Start () {
    ...

#if UNITY_ANDROID
    Repro.EnablePushNotification();
#endif

#if UNITY_ANDROID
    Firebase.Messaging.FirebaseMessaging.TokenReceived += OnTokenReceived;
    Firebase.Messaging.FirebaseMessaging.MessageReceived += OnMessageReceived;
#endif

    ...
  }

#if UNITY_ANDROID
  public void OnTokenReceived(object sender, Firebase.Messaging.TokenReceivedEventArgs token) {
    Repro.SetPushRegistrationID(token.Token);
  }

  public void OnMessageReceived(object sender, Firebase.Messaging.MessageReceivedEventArgs e) {
    ...
  }
#endif
}

上記の実装が終わったら、プッシュ通知作成画面をご覧ください。

プッシュ通知受信時の動作をカスタマイズする¶

Repro Unity Packageはオプション：プッシュ通知受信時の動作をカスタマイズするに示すプッシュ通知受信時の動作のカスタマイズには対応しておりません。ご了承ください。

オプション：ユニバーサルリンク/アプリリンクを使用する¶

端末に表示されたプッシュ通知およびアプリ内メッセージに設定されたリンクをタップした際に実行されるURLには、ユニバーサルリンク（またはアプリリンクと呼ばれる）を指定することが可能です。（簡単のため、以下ではこれらをユニバーサルリンクと呼びます）

アプリにてユニバーサルリンクの実行時の処理を追加するには、以下の通り実装を行う必要があります。（ここで設定された動作は、プッシュ通知およびアプリ内メッセージ対し有効となります。）

ユニバーサルリンクのURLパターンを登録する¶

ユニバーサルリンクを利用するためには、まずユニバーサルリンクのURLのパターン（正規表現）を指定する必要があります。

注釈

パターン（正規表現）に合致すると、プッシュ通知の開封時や、アプリ内メッセージの遷移先に設定されたURLに対して、後述のコールバック処理をキックします。

また、アプリ内メッセージでHTMLコンテンツを表示するとき、そのコンテンツ内で発生したリクエストに対してもユニバーサルリンクの判定が行われます。

この指定は、iOSの場合は AppDelegate または .plist ファイル、Androidの場合は Application 継承クラスまたは AndroidManifest.xml ファイルのどちらか一方に記述することで行うことができます。

// AppDelegate.m

#import <Repro/Repro.h>

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
    [Repro addOpenUrlFilterRegEx:@"https://example\\.com/page/"];
    [Repro addOpenUrlFilterRegEx:@"your-domain\\.com/.+\?universal=true"];
    ...
}


// .plist file
/*
<dict>
    <key>RPROpenUrlFilterRegExList</key>
    <array>
        <string>https://example\.com/page/</string>
        <string>your-domain\.com/.+\?universal=true</string>
    </array>
    ...
</dict>
*/

// MyApplication.java

import io.repro.android.Repro;

public class MyApplication extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        Repro.addOpenUrlFilterRegEx("https://example\\.com/page/");
        Repro.addOpenUrlFilterRegEx("your-domain\\.com/.+\\?universal=true");
        ...
    }
...
}


// AndroidManifest.xml
// To specify multiple URL patterns, enter them separated by commas.
<application>
    ...
    <meta-data
        android:name="io.repro.android.OpenUrlFilterRegExList"
        android:value="https://example\\.com/page/;your-domain\\.com/.+\\?universal=true">
    </meta-data>
</application>

// AppDelegate.swift

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool
{
    Repro.add(openUrlFilterRegEx: "https://example\\.com/page/")
    Repro.add(openUrlFilterRegEx: "your-domain\\.com/.+\\?universal=true")
    ...
}

// .plist file
/*
<dict>
    <key>RPROpenUrlFilterRegExList</key>
    <array>
        <string>https://example\.com/page/</string>
        <string>your-domain\.com/.+\?universal=true</string>
    </array>
    ...
</dict>
*/

Please follow native iOS and Android instructions in order to add the filters
to the plist/AndroidManifest files or the main AppDelegate/Application classes.

Please follow native iOS and Android instructions in order to add the filters
to the plist/AndroidManifest files or the main AppDelegate/Application classes.

// YourAppNameScene.cpp

bool YourAppName::init() {
    ReproCpp::addOpenUrlFilterRegEx("https://example\\.com/page/");
    ReproCpp::addOpenUrlFilterRegEx("your-domain\\.com/.+\\?universal=true");
    ...
}

Please follow native iOS and Android instructions in order to add the filters
to the plist/AndroidManifest files or the main AppDelegate/Application classes.

Please follow native iOS and Android instructions in order to add the filters
to the plist/AndroidManifest files or the main AppDelegate/Application classes.

警告

ユニバーサルリンクとして設定するURLパターンは、可能な限り ドメインとパスまで含めて具体的に指定 し、 全て小文字で指定 してください。

もし、 https のようにスキームのみを指定した場合、アプリ内メッセージで表示された画面内で実行されたスクリプトなどによるリクエストもユニバーサルリンクと誤って判定され、意図しないタイミングでコールバック処理が実行される可能性があります。

また、URLパターンのスキーム/ドメイン部分に大文字を使用した場合、HTMLアプリ内メッセージで表示したボタンからユニバーサルリンクを使って遷移させようとするときに、スキーム/ドメイン部分が自動的に小文字に変換されて処理されます。パターン（正規表現）に一致せず、意図したタイミングでコールバック処理が実行されない可能性があります。

ユニバーサルリンク実行時の処理を登録する¶

次に、ユニバーサルリンクが実行された際に動作するコールバック処理を実装します。処理内には、例えばURLのパターンに応じて画面遷移を行う動作などを記述します。

#import <Repro/Repro.h>

...

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
    [Repro setOpenUrlCallback:^(NSURL *url) {
        if ([url.host isEqualToString:@"example.com"]) {
            // In case of your universal link perform navigation, present content, ...
            handleUniversalLink(url);
        }
    }];

    ...
    [Repro setup:@"YOUR_APP_TOKEN"];
    ...
}

// Set a callback that is executed everytime an URL is about to be opened
Repro.setOpenUrlCallback { url in
    if url.host == "example.com" {
        // In case of your universal link perform navigation, present content, ...
        handleUniversalLink(url)
    }
}
...
Repro.setup(token: "YOUR_APP_TOKEN")
...

import io.repro.android.Repro;

public class MyApplication extends Application {

    @Override
    public void onCreate() {
        super.onCreate();

        // In order to execute a callback when a push notification is tapped,
        // the callback must be set in Application, not Activity.
        Repro.setOpenUrlCallback(new Repro.OpenUrlCallback() {
            // ** This callback method is executed in the main thread **
            @Override
            public void onOpened(Uri uri) {
                if ("example.com".equals(uri.getHost())) {
                    // In case of your universal link perform navigation, present content, ...
                }
            }
        });

        ...
        Repro.setup(this, YOUR_APP_TOKEN);
        ...
    }
    ...
}

Repro.setOpenUrlCallback((uri) { // uri is of type Uri
   debugPrint("Universal Link Callback Handler received: " + uri.toString());
});

// Somewhere before Repro.Setup(...)
Repro.SetOpenUrlCallback(uri => // uri is of type Uri
{
    Debug.Log("Universal Link Callback Handler received: " + uri.ToString());
});

bool YourAppName::init() {
    ReproCpp::addOpenUrlFilterRegEx(...);

    ReproCpp::setOpenUrlCallback([](const char *url) {
        if (strcmp(url, "example.com") == 0) {
            // In case of your universal link perform navigation, present content, ...
        }
    });

    ReproCpp::setup("YOUR_APP_TOKEN")
    ...
}

Repro.setOpenUrlCallback(function(url) { // url is of type String
    alert('Universal Link Callback Handler received: ' + url);
    if (url.includes("http://example.org")) {
        // In case of your universal link perform navigation, present content, ...
    }
});

Repro.setOpenUrlCallback( (url) => {  // url is of type String
    console.log('Universal Link Callback Handler received: ' + url);
    if (url.includes("http://example.org")) {
        // In case of your universal link perform navigation, present content, ...
    }
});

プッシュ通知 (Unity)¶

プッシュ通知の設定¶

Firebase Unity SDKを導入する¶

iOSプラットフォーム¶

デバイストークンをReproに送信 (Unity 2019.4 未満の場合)¶

デバイストークンをReproに送信 (Unity 2019.4 以上の場合)¶

Androidプラットフォーム¶

AndroidManifest.xml ファイルを編集する¶

Receiverの登録¶

通知チャンネルの設定¶

アイコンと背景色のカスタマイズ¶

Registration IDをReproに送信¶

プッシュ通知受信時の動作をカスタマイズする¶

オプション：ユニバーサルリンク/アプリリンクを使用する¶

ユニバーサルリンクのURLパターンを登録する¶

ユニバーサルリンク実行時の処理を登録する¶

`AndroidManifest.xml` ファイルを編集する¶