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

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

ドキュメント

共通ドキュメント

移行対応について

概要

ドメイン変更およびAndroidプッシュ通知配信におけるFCM移行は、 すべてのお客様において作業必須となります。
お手数をおかけいたしますが、下記ドキュメントに沿ってご対応ください。

新ドメインAPI

REST API
項目 内容
新ドメイン mbaas.api.nifcloud.com
新ドメイン提供日 2018年7月2日
旧ドメイン mb.api.cloud.nifty.com
旧ドメイン廃止日 2019年10月1日
影響ユーザー REST APIを用いているユーザー
  • REST APIを利用していて直接ドメインを指定しているユーザーは新ドメインへ移行をお願いいたします。
  • SDKを使用しているユーザーは旧ドメイン廃止日までに新ドメインSDKへ移行をお願いいたします。
スクリプト REST API
項目 内容
新ドメイン script.mbaas.api.nifcloud.com
新ドメイン提供日 2018年7月2日
旧ドメイン script.mb.api.cloud.nifty.com
旧ドメイン廃止日 2019年10月1日
影響ユーザー REST APIを用いてスクリプトを利用しているユーザー
  • REST APIを利用していて直接ドメインを指定しているユーザーは新ドメインへ移行をお願いいたします。
  • SDKを使用しているユーザーは旧ドメイン廃止日までに新ドメイン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年10月1日
影響ユーザー 管理画面を使用している全ユーザー
  • 移行期間中、旧ドメインにアクセスすると新ドメインへアクセスをお願いするページが表示されます。

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

項目 内容
新ドメイン user.mbaas.nifcloud.com
新ドメイン提供日 2018年7月23日
旧ドメイン user.mb.cloud.nifty.com
旧ドメイン廃止日 2018年9月28日
影響ユーザー 会員管理・認証機能のメールアドレス認証を使用しているユーザー
  • パスワード変更画面や、無効リンクページなど、アプリの会員がアクセスするWebページのリンク先のドメインが変更されます。(独自URLを設定している人は影響されません)
  • 移行にあたり、お客様にて作業いただく項目はありません。

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

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

項目 内容
旧ドメインメールアドレス no-reply@mb.cloud.nifty.com
新ドメインメールアドレス no-reply@mbaas.nifcloud.com
新ドメインメールアドレス提供日 2018年11月27日
  • 新ドメインに対応したメールアドレスが11月27日(火)にリリースされました。
    • エクスポート機能等をご利用の際に、システムから届くメールアドレスが、no-reply@mb.cloud.nifty.comからno-reply@mbaas.nifcloud.comに変更されています。
    • 会員管理・認証機能を使用して、会員認証時の確認メールを送信する際の送信元もno-reply@mb.cloud.nifty.comからno-reply@mbaas.nifcloud.comに変更されています。
      • 確認メールに独自のメールアドレスを設定しているお客様については影響ございません。
    • 旧ドメインメールアドレスから新ドメインメールアドレスへの切り替えにあたり、お客様がニフクラ mobile backend上で作業していただく項目はないため、並行期間はございません。
    • アプリ利用者などにno-reply@mb.cloud.nifty.comの受信を許可してもらうようにお願いしているお客様は、no-reply@mbaas.nifcloud.comの受信を許可してもらうようお願いいたします。

ペイロードの変更

項目 内容
新ペイロード com.nifcloud.mbaas.*
新ペイロード提供日 2018年8月27日
旧ペイロード com.nifty.* (com.nifty.PushId 等)
旧ペイロード廃止日 2020年3月23日
影響ユーザー プッシュ通知機能でペイロードを使用しているユーザー
  • 以下のペイロードが2020年3月23日に廃止となりました。
    • 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月19日 2019年4月8日
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)を使用するように変更いたします。 Androidへのプッシュ通知を利用しているすべてのお客様において移行が必要となります。
  • FCMの送信結果詳細はこちらをご覧ください。
  • Push通知リクエストをする際、REST APIやSDKの書き方は以前と変わりません。
  • GCM対応したプッシュ通知機能が廃止されるまではFCM対応したプッシュ通知機能のみを使う場合でもAPIキーを登録する必要があります。(2018/9/4更新)
  • Android端末でプッシュ通知を受け取る際、省電力モードの設定により、プッシュ通知が端末に届かない場合があります。テストされる際には端末の設定をご確認ください。(2018/9/4更新)
  • GCM対応アプリにつきましても 後述の FCM APIの有効化、Firebase秘密鍵を mobile backend への設定を行うことによって GCM廃止以降もプッシュ通知を利用することが可能です。(2019/3/12更新)

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

  • FCM APIの有効化(2019/5/9更新)

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

    • GCMにて利用した Google Cloud Platform プロジェクト または Firebase プロジェクトから以下の2点を取得し、FCMに使用いたします。
      • google-services.json (アプリに配置していただく必要があります。)
      • Firebaseの秘密鍵 (mobile backendにアップロードしていただく必要があります)
    • 詳細な手順はこちらをご参照ください。
      • 注意: リンク先では新規に Firebase プロジェクトを作成するように記載していますが、移行する場合はGCMにて利用したプロジェクトをそのまま使用してください
    • 各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を変更する必要があります。
    • GCM対応したプッシュ通知機能の廃止日までに新ドメインSDKに移行をお願いいたします。
  • installationクラスへの対応

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

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

GCMアプリへGCM廃止以降も可能な限りGCMプッシュを送る場合(2019/5/9更新)

以下の対応を行うことでGCM対応アプリでのプッシュ通知の受信が可能となります。

  • FCM APIの有効化

    • FCM対応したプッシュ通知を使用する際、Google側のFCM APIを有効にする必要があります。
    • GCMにて利用していた Google Cloud Platform プロジェクトについて、FCM APIの管理画面を開き、「有効にする」をクリックしてAPIを有効にしてください。 FCM_API_console
  • Firebaseプロジェクトが不明な場合(2019/3/19追加)

    • 利用されているFirebaseに複数のプロジェクトが存在しGCMで使用しているプロジェクトが分からない場合、以下の方法で調査することができます。
    • GCMアプリで使用されている送信者ID(sender ID)、もしくは管理画面にて設定されていたAPIキーを用意します。
    • Firebaseにログインし、Firebase コンソールよりGCMで使用しているプロジェクトの候補を1つづつ以下の手順で確認します。
      • 左メニューの設定アイコンから「プロジェクトの設定」を開きます。 プロジェクトの設定
      • 設定画面で「クラウドメッセージング」をクリックすると、「サーバーキー」と「送信者ID」が確認できます。こちらがGCMアプリで使用されているものと一致するものを探します。 サーバーキーと送信者ID
    • GCMアプリで利用されている送信者IDは、アプリ内ソースコードに記載されています。
    • APIキーは3月19日以降はmobile backend管理画面より確認することができません。お問い合わせにて回答いたします。
    • google-services.jsonとFirebase秘密鍵の設定(2019/5/9更新)
    • GCMにて利用した Google Cloud Platform プロジェクト または Firebase プロジェクトから以下の2点を取得し、FCMに使用いたします。
      • google-services.json (アプリに配置していただく必要があります。)
      • Firebaseの秘密鍵 (mobile backendにアップロードしていただく必要があります)
    • 詳細な手順はこちらをご参照ください。
      • 注意: リンク先では新規に Firebase プロジェクトを作成するように記載していますが、移行する場合はGCMにて利用したプロジェクトをそのまま使用してください
  • 注意点

    • GCM自身が終了するために、4月10日5月29日以降はデバイストークンの取得が行えなくなると考えられます。取得が行えない場合、「4月10日5月29日以降、新規に旧SDK(GCM対応)アプリをインストールした」ユーザーへ向けてはプッシュ通知の配信が行えなくなります。
    • ※2019年4月、Google社からのメールおよび開発ドキュメント等にて、GCMドメインは2019年5月29日(現地時間)まで利用可能である旨の記載がなされました。そのため、4月10日以降も継続して利用できる可能性があります。(2019/4/9追加)

変更履歴

本ページ公開当初から変更・削除になった点・すでに対応依頼が終了した点などについて、下記に記載いたします。

REST API

  • 新ドメインのTLSは1.2になります。Android 4.1〜4.4.4を使用している場合は、TLS1.2は無効になっていますので、有効にする対応を行う必要があります。
    • 2018年8月14日から以前の旧ドメインと同じくTLSのバージョンを1.0〜1.2にいたしました。
    • 2020年6月30日から、REST APIのTLSは1.2のみになりました。

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

  • カスタムページの新ドメインのTLSもREST APIと同じく1.2のみにする予定です。こちらは 2019年1月 に対応する予定です。Android 4.1〜4.4.4を使用している場合は、TLS1.2は無効になっていますので、有効にする対応を行う必要があります。
    • こちらの2019年1月の実施は中止となりました。再開する際は別途informationブログにてご案内いたします。
    • 2020年6月30日から、カスタムページのTLSは1.2のみになりました。

REST API・スクリプト REST API・新ドメイン管理画面・ペイロードの変更(2019/9/10一部変更)

  • 旧ドメイン・旧ペイロード廃止日を更新

GCMからFCMの移行対応(2019/5/9一部変更)

GCMからFCMの移行対応(2019/4/8一部変更)

  • GCM閉塞日を 2019年4月8日 に変更

GCMからFCMの移行対応(2019/3/19一部追加)

  • Firebaseプロジェクトが不明な場合

GCMからFCMの移行対応(2019/3/12一部追加)

  • GCM対応アプリにつきましても 後述の FCM APIの有効化、Firebase秘密鍵を mobile backend への設定を行うことによってGCM廃止以降もプッシュ通知を利用することが可能です。

GCMアプリへGCM廃止以降も可能な限りGCMプッシュを送る場合(2019/3/12追加)

  • GCM自身が終了するために、4月10日5月29日以降はデバイストークンの取得が行えなくなると考えられます。
    • ※2019年4月、Google社からのメールおよび開発ドキュメント等にて、GCMドメインは2019年5月29日(現地時間)まで利用可能である旨の記載がなされました。そのため、4月10日以降も継続して利用できる可能性があります。(2019/4/9追加)

新ドメイン管理画面

  • 7月23日〜24日付近で旧ドメインの管理画面のリンクが記載されているメールを受け取ったお客様は、お手数をおかけいたしますがもう一度メールを送信する処理を実行していただきますようお願いいたします。
    • 旧ドメインの管理画面のリンクが記載されているメールは利用者登録時やコラボレータ登録時、エクスポート完了通知時などのメールになります。

GCMからFCMの移行対応

  • FCM対応したプッシュ通知機能のみを使用する場合、APIキーをmobile backendに登録する必要はありません。

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

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

ページの先頭へ