サーバー構築不要!スマートフォンアプリ向けの新クラウド

トップ >ドキュメント >ドキュメント:移行対応について

ドキュメント

共通ドキュメント

移行対応について

概要

ニフクラ mobile backendの新ドメイン対応やAndroid pushのGCMからFCMに移行する対応をまとめました。

新ドメインAPI

REST API
項目 内容
新ドメイン mbaas.api.nifcloud.com
新ドメイン提供日 2018年7月2日
旧ドメイン mb.api.cloud.nifty.com
旧ドメイン廃止日 2019年9月予定
影響ユーザー REST APIを用いているユーザー
  • 旧ドメインが稼働している期間中に、REST APIを利用していて直接ドメインを入力しているユーザーは新ドメインへ移行をお願いいたします。
  • 2018年7月2日時点では管理画面上のREST APIツールでは旧ドメインのAPIが表示されます。こちらは後日管理画面の新ドメイン対応を行う際に更新される予定です。
  • 新ドメインのTLSは1.2になります。Android 4.1〜4.4.4を使用している場合は、TLS1.2は無効になっていますので、有効にする対応を行う必要があります。
    • 2018年8月14日から以前の旧ドメインと同じくTLSのバージョンを1.0〜1.2にいたしました。
  • 新ドメイン対応版のSDKは9月4日にリリースされました。SDKを使用しているユーザーは旧ドメイン廃止日まで新ドメインへ移行をお願いいたします。
スクリプト REST API
項目 内容
新ドメイン script.mbaas.api.nifcloud.com
新ドメイン提供日 2018年7月2日
旧ドメイン script.mb.api.cloud.nifty.com
旧ドメイン廃止日 2019年9月予定
影響ユーザー REST APIを用いてスクリプトを利用しているユーザー
  • 旧ドメインが稼働している期間中に、REST APIを利用していて直接ドメインを入力しているユーザーは新ドメインへ移行をお願いいたします。
  • スクリプト REST APIの新ドメイン対応版のSDKも9月4日にリリースされました。SDKを使用しているユーザーは旧ドメイン廃止日まで新ドメインへ移行をお願いいたします。
カスタムページの独自URL設定
項目 内容
影響ユーザー カスタムページの独自URL設定を行っているユーザー
  • 独自URLを設定した方は設定方法が書いてあるリポジトリを参考に設定していただいたと思います。このリポジトリのappディレクトリ配下にあるテンプレートですが、system/config.jsのBASE_URLやindex.phpのコードの一部に旧ドメインのREST APIが使われていました。
  • もし、カスタムページの独自URLを割り当てているサーバー内に旧ドメインREST APIのコードがある場合は、旧ドメインAPI廃止予定日の2019年9月までに新ドメインの mbaas.api.nifcloud.com に変更していただくようお願いいたします。

新ドメイン管理画面

項目 内容
新ドメイン console.mbaas.nifcloud.com
新ドメイン提供日 2018年7月24日
旧ドメイン console.mb.cloud.nifty.com
旧ドメイン廃止日 2019年9月予定
影響ユーザー 管理画面を使用している全ユーザー
  • 新ドメインが提供された後、旧ドメインにアクセスすると新ドメインへアクセスをお願いする専用のページが出ます。
  • 7月23日〜24日付近で旧ドメインの管理画面のリンクが記載されているメールを受け取ったお客様は、お手数をおかけいたしますがもう一度メールを送信する処理を実行していただきますようお願いいたします。
    • 旧ドメインの管理画面のリンクが記載されているメールは利用者登録時やコラボレータ登録時、エクスポート完了通知時などのメールになります。

新ドメインカスタムページ

項目 内容
新ドメイン user.mbaas.nifcloud.com
新ドメイン提供日 2018年7月23日
旧ドメイン user.mb.cloud.nifty.com
旧ドメイン廃止日 2018年9月予定
影響ユーザー 会員管理のメールアドレス認証機能を使用しているユーザー
  • パスワード変更画面や、無効リンクページなど、アプリの会員がアクセスするWebページのリンク先のドメインが変更されます。(独自URLを設定している人は影響されません)
  • カスタムページの新ドメインのTLSもREST APIと同じく1.2のみにする予定です。こちらは 2019年1月 に対応する予定です。Android 4.1〜4.4.4を使用している場合は、TLS1.2は無効になっていますので、有効にする対応を行う必要があります。
    • こちらの2019年1月の実施は中止となりました。再開する際は別途informationブログにてご案内いたします。

新ドメインSDK

項目 内容
新ドメインSDK提供日 2018年9月4日
SDK 対応バージョン
iOS v3.0.0~
Android v3.0.0~
Unity v4.0.0~
javascript v3.0.0~
Monaca push plugin v3.0.0~
  • 新ドメインに対応した各SDKがリリースされています。
    • 新ドメイン対応した全てのSDKには、新ペイロードが受け取れるように設定されています。
    • Android SDK・Unity SDK・Monaca push pluginの新SDKにはFCMの対応も含まれています。
    • Monaca push pluginを利用する際、「Cordovaプラグインの管理」で表示される「NIFCloudMB (ncmb-push-monaca-plugin )」が2種類表示されます。v2.0.11は旧ドメインのpluginとなりますので、v3.0.0以上のpluginをお使いください。v2.0.11のpluginは「Cordovaプラグインの管理」上からは今後削除される予定です。
    • 上記の表がリリースされた各SDKのバージョン対応表になります。今後SDKを入れ替える際は、表に記載されてあるバージョン以上のSDKをご使用ください。
    • 各SDKのドキュメント内に今回のFCM対応や新ペイロードの内容を反映させました。しかし、サンプル&チュートリアルに関しては順次更新いたしますので、お待ちください。
    • Androidのinstallationの取り扱いについて、Android SDK v3から変更になりました。(2018/9/18更新)
      • FCMへの変更に伴い、Sender ID(送信者ID)を使用するgetRegistrationIdInBackgroundがv3から廃止になりました。
      • 詳しくはプッシュ通知のドキュメントの基本的な使い方絞込み配信をご確認ください。

新ドメインメールアドレス

詳細内容は後日公開します。

ペイロードの変更

項目 内容
新ペイロード com.nifcloud.mbaas.*
新ペイロード提供日 2018年8月27日
旧ペイロード com.nifty.* (com.nifty.PushId 等)
旧ペイロード廃止日 2019年9月予定
影響ユーザー プッシュ通知機能でペイロードを使用しているユーザー
  • 以下のペイロードが2019年9月から使用できなくなります。
    • iOSの場合
      • com.nifty.PushId
      • com.nifty.RichUrl
    • Androidの場合
      • com.nifty.PushId
      • com.nifty.Data
      • com.nifty.Channel
      • com.nifty.Dialog
      • com.nifty.RichUrl
  • 新ペイロードは以下のようになります。
    • iOSの場合
      • com.nifcloud.mbaas.PushId
      • com.nifcloud.mbaas.RichUrl
    • Androidの場合
      • com.nifcloud.mbaas.PushId
      • com.nifcloud.mbaas.Data
      • com.nifcloud.mbaas.Channel
      • com.nifcloud.mbaas.Dialog
      • com.nifcloud.mbaas.RichUrl
  • 旧ペイロードと新ペイロードが並行して使用できる期間は、プッシュ通知から送信されるペイロードに新旧どちらの値も入るようになります。
    • そのため、並行して使用できる期間内では、プッシュ通知のメッセージサイズを新旧ペイロード分使用していることになります。
  • SDKを使用してプッシュ通知を受信しているユーザーは、2018年9月4日にリリースされたFCM対応した各SDKを使用すると新ペイロードを受信できるようになります。

GCMからFCMの移行対応

項目 内容
GCM対応したプッシュ通知機能の廃止日 2019年3月予定
FCM対応したプッシュ通知機能の提供日 2018年8月27日
影響ユーザー プッシュ通知機能を使用してAndroidにプッシュ通知を送信しているユーザー
※Android SDK・Unity SDK・Javascript SDK(Monaca push pluginを使用しているユーザー)をご利用のユーザーも対象となります。
  • GoogleのGoogle Cloud Messaging 廃止告知に伴い、現在プッシュ通知でGoogle Cloud Messaging (以下GCM)を使用している部分をFirebase Cloud Messaging (以下FCM)を使用するように変更いたします。
  • FCMの送信結果詳細はこちらをご覧ください。
  • Push通知リクエストをする際、REST APIやSDKの書き方は以前と変わりません。
  • FCM対応したプッシュ通知機能のみを使用する場合、APIキーをmobile backendに登録する必要はありません。
    • GCM対応したプッシュ通知機能が廃止されるまではFCM対応したプッシュ通知機能のみを使う場合でもAPIキーを登録する必要があります。(2018/9/4更新)
    • APIキーの登録方法
  • Android端末でプッシュ通知を受け取る際、省電力モードの設定により、プッシュが端末に届かない場合があります。(2018/9/4更新)

【ユーザー側で対応していただく内容】

  • FCM APIの有効化(2018/9/11更新)

    • FCM対応したプッシュ通知を使用する際、Google側のFCM APIを有効にする必要があります。
    • FCM APIの管理画面を開き、「有効にする」をクリックしてAPIを有効にしてください。
    • ※新規でFirebaseプロジェクトを作成した際は、作成した時点でFCM APIが有効になります。 FCM_API_console
  • google-services.jsonとFirebase秘密鍵の設定

    • google-services.jsonをアプリに配置していただくのと、Firebaseの秘密鍵をmobile backendにアップロードしていただく必要があります。詳細な手順はこちらをご参照ください。
    • 各SDKのgoogle-services.jsonの配置場所は以下になります。(2018/9/13更新)
      • android: プロジェクト内のアプリケーション名/app/ 直下
      • Unity: プロジェクト内のAssets/Plugin/Android/ 直下
      • Monaca: ルートディレクトリ(config.xmlなどがある場所)
  • SDKの入れ替え

    • FCM対応したプッシュ通知をAndroid SDK・Unity SDK・Monaca push pluginで作成したアプリで受け取る場合は、SDKを変更する必要があります。
    • FCM対応したプッシュ通知を受け取れるSDKは2018年9月4日にリリースされました。GCM対応したプッシュ通知機能の廃止日までに新しいSDKに移行をお願いいたします。
  • installationクラスへの対応

    • installationクラスに「pushType」フィールドを作成してください。その後、FCM対応したプッシュ通知を送りたいAndroid端末のレコードの「pushType」フィールドに「fcm」と入力してください。このフィールドに「fcm」と入力されたAndroid端末のみ、FCM対応したプッシュ通知を送信します。 fcm対応されたinstallation画面
    • 2018年9月4日にリリースされたFCM対応されてある各SDKを使用すると、installationクラスを更新する際、「pushType」フィールドに「fcm」が入力されるようになります。
    • 2019年3月にGCM対応したプッシュ通知機能が廃止された後は、「pushType」に「fcm」と書かれていない場合でも、「deviceType」が「Android」の端末にはFCM対応したプッシュ通知で送信されるようになります。
  • ペイロードの制限値

    • FCM対応したプッシュ通知を送信する際、メッセージの上限サイズが合計2Kバイトになりました。この2Kバイトはmobile backendから送信されるペイロードのサイズを除いた値となります。
    • 今までのメッセージの上限サイズは合計4Kだったため、FCM対応したプッシュ通知を送信する際は、サイズにご注意ください。

お探しの内容が見つからなかった場合はユーザーコミュニティ もご活用ください。(回答保証はいたしかねます)
なお、 Expertプラン以上のお客様はテクニカルサポートにてご質問を承らせて頂きます。

推奨画面サイズ1024×768px以上

ページの先頭へ