ご注意 この資料料は 日本アイ ビー エム株式会社および 日本アイ ビー エムシステムズ エンジニアリング株式会社の正式なレビューを受けておりません 資料料の内容には正確を期するよう注意しておりますが この資料料の内容は 2014 年年 09 月現在の情報であり 製品の新しいリリース 修正などによっ

Transcription

1 IBM Mobile Push Notification 導 入ガイド (Android)

2 ご注意 この資料料は 日本アイ ビー エム株式会社および 日本アイ ビー エムシステムズ エンジニアリング株式会社の正式なレビューを受けておりません 資料料の内容には正確を期するよう注意しておりますが この資料料の内容は 2014 年年 09 月現在の情報であり 製品の新しいリリース 修正などによって動作 / 仕様が変わる可能性があります 当資料料は 資料料内で説明されている製品の仕様を保証するものではありません 従って この情報の利利 用またはこれらの技法の実施はひとえに使 用者の責任において為されるものであり 資料料の内容によって受けたいかなる被害に関しても 一切切の補償をするものではありません Google Google ロゴ Google Play Google Play ロゴ Android Android ロゴ は Google Inc. の商標または登録商標です また IBM IBM ロゴおよび ibm.com は 世界の多くの国で登録された International Business Machines Corporation の商標です 他の製品名およびサービス名等は それぞれ IBM または各社の商標である場合があります 現時点での IBM の商標リストについては copytrade.shtml をご覧ください 2

3 目次 1. はじめに 2. サンプルアプリ (Android) 導 入 手順 3. 既存のアプリへの SDK の組み込み 手順 3

4 1. はじめに 4

5 はじめに 当資料料は IBM Mobile Push Notification の機能を確認できるように以下の 手順を 示したものです - Android 用 SDK に同梱されているサンプル アプリケーションの導 入 手順 - 既存アプリに Android 用 SDK を組み込む 手順 基本的には以下の URL に記載されている内容ベースに 画 面キャプチャを交えて 手順化したものです - +Google+Cloud+Messaging 手順を実施するには 以下の物が必要となります - Android SDK, ADT(Android Developer Tools) が導 入された Eclipse および Web ブラウザ - Google アカウント - Xtify ID - Android デバイス ( 実機での確認が必要な場合 ) 5

6 はじめに ( 続き ) 以下のことは範囲外としています - Google アカウントの取得 方法 - Xtify の ID の取得 方法 用語について - IBM は Xtify を 2013/10 に買収し Xtify の Mobile Push の機能を IBM Mobile Push Notification として提供しています わかりやすいよう資料料上では Xtify という表現も残しております 当資料料の Web サイトの画 面キャプチャは 2014/09 時点の物であり それぞれのデザイン変更更により変更更されることがありますのでご留留意ください 6

7 2. サンプルアプリ (Android) 導 入 手順 7

8 全体の流流れ SDK のダウンロード IBM Push Notification SDK ダウンロードサイトより Android 向け SDK をダウンロード 新規 Google API プロジェクトの作成 にて Project の APIs & Credentials 設定 Xtify コンソールから Android アプリを登録 でのアプリケーション登録 開発環境の準備 ( 必要な 方のみ ) ADT のインストール サンプルアプリの Build ADT でのサンプルアプリの Build アプリ稼動確認 用エミュレーターのセットアップ ADT での AVD 作成 8 通知のテスト ( エミュレーター使 用 ) Xtify のコンソールからテスト通知 通知のテスト ( 実機使 用 ) Xtify のコンソールからテスト通知

9 SDK のダウンロード 以下リンクより Android 用の SDK をダウンロードします - mobile- push- notification/sdks/download- ibm- push- notification- sdk- android/ 9

10 新規 Google API プロジェクトの作成 以下の Google APIs Console にログインします - API Project を作成します - はじめて API Project を作成する場合 Project の作成を促すメッセージが表 示されますので メッセージにしたがって作成ください - 既に Project を作成したことがある場合 Dashboard の画 面が初期表 示されますので 左上の Projects のリンクより 新たに Project を作成ください 10

11 新規 Google API プロジェクトの作成 APIS & AUTH > APIs のメニューをクリックし Google Cloud Messaging for Android を有効にしてください 11

12 新規 Google API プロジェクトの作成 続いて APIS & AUTH > Credentials のメニューをクリックし Create new Key > Server key よりキーを作成します IP アドレスの制約は何も指定せずに Create をクリックします 12

13 新規 Google API プロジェクトの作成 Key が 生成されます - この API key の情報は 後の Xtify コンソールでの Android アプリの登録 手順にて使 用します - 開発 用と本番 用の Project は分けて作成することをお勧めいたします 13

14 新規 Google API プロジェクトの作成 プロジェクト名 > Overview にアクセスし Project Number を確認しておきます - この Project Number は 後のサンプルアプリの Build 手順で使 用します 14

15 Xtify コンソールから Android アプリを登録 以下にログインします - ログインするには Xtify ID が必要です - Add or Manage your Applications のリンクをクリックし ADD NEW APPLICATION をクリックします 15

16 Xtify コンソールから Android アプリを登録 以下の必須項 目を 入 力力後 SAVE をクリックします - Application Name: 任意のアプリケーション名 - Application Key Type: Development / Testing を選択 ( サンプルのため ) - Application OS: Android GCM を選択 - Google API Key: 先の 手順で確認した Google の API Key の値を指定 16

17 Xtify コンソールから Android アプリを登録 アプリケーションが登録されます - この Application key の情報を 後のサンプルアプリの Build 手順で使 用します 17

18 開発環境の準備 ( 必要な 方のみ ) 以下は Android アプリケーション開発ツールである Android Development Tools (ADT) の導 入 手順です - 既に開発環境をお持ちの 方はスキップしてください Android SDK を以下よりダウンロードし インストールします Eclipse に ADT Plugin をインストールする 手順もありますが ここでは Eclipse も 一緒にインストールする 手順を 示します 18

19 開発環境の準備 ( 必要な 方のみ ) ダウンロードしたファイルを展開し < 展開後のフォルダ >\eclipse \eclipse.exe を実 行行します 任意のワークスペースを指定して Eclipse を開きます - ( 必要に応じて ) 最新の ADT では Window メニュー内に Android SDK Manager, Android Virtual Device Manager のメニューが表 示されません これらは SDK をインストールしたフォルダから個別に直接起動することも可能ですが 以降降の操作の利利便便性向上のため Window メニューからの起動が可能なように設定を変更更しておきます Window > Customize Perspective を開く Command Groups Availability タブを開き Android SDK and AVD Manager にチェックを 入れる 19

20 サンプルアプリの Build ダウンロードした SDK に含まれるサンプルアプリを ADT にインポートします - File > Import をクリックし Import メニューを開く - Android > Existing Android Code Into Workspace を選択し Next をクリックする - Root Directory で <SDK の展開先 >\Samples を指定し Xtify Rich Samples にチェックを 入れ Finish をクリックする 20

21 サンプルアプリの Build MainActivity > src > com.xtify.samples.gcm > MainActivity.java を開き 以下の定数を設定します - XTIFY_ APP_ KEY の YOUR_ XTIFY_ APP_ KEY の箇所を 先の 手順 (p17) で確認した IBM Mobile Push Notification の appkey に変更更 - PROJECT_ NUM の YOUR_ PROJECT_ NUM の箇所を 先の 手順 (p14) で確認した Google API の Project Number に変更更 21

22 アプリ稼動確認 用エミュレーターのセットアップ プッシュ通知 用アプリのテストを 行行うためのエミュレーターをセットアップします - プッシュ通知の確認を 行行うためには Google Messaging APIs をベースとした Android Virtual Device (AVD) が必要です 以下の 手順に沿って AVD が適切切に構成されていることを確認ください Window > Android SDK Manager より サポートされるバージョンの Google APIs が導 入済みであることを確認します ( 導 入されてない場合 対象の項 目のチェックを ON にし 導 入を実施ください ) 22

23 アプリ稼動確認 用エミュレーターのセットアップ Windos > Android Virtual Device Manager > Create より 新規に AVD を作成します - Target では Google APIs を選択ください - その他の項 目は テストしたいデバイス情報に沿った任意の情報を設定ください 23

24 アプリ稼動確認 用エミュレーターのセットアップ 作成した AVD を選択し Start ボタンより AVD を起動します 24

25 参考 AVD の起動エラーへの対処法 Intel の CPU を選択した際 AVD の起動時に以下のようなエラーが表 示される場合があります Starting emulator for AVD xxxxxxxx' emulator: Failed to open the HAX device! HAX is not working and emulator runs in emulation mode emulator: Open HAX device failed 対処法は以下の通りです 1. Android SDK Manager にて Intel x86 Emulator Accelerator (HAXM Installer) を導 入 2. <Android SDK の展開先 >\extras\intel\hardware_ Acceleated_ Execution_ manager \IntelHaxm.exe より HAXM を導 入 VT- x が無効な環境ではインストールに失敗するため BIOS メニューより VT- x を有効化した後にインストールを実施ください

26 通知のテスト ( エミュレーター使 用 ) セットアップした AVD にて 通知のテストを 行行います - プロジェクトを右クリックし Run As > Run Configurations を選択します - Target タブにて 先ほどセットアップしたAVDを選択し Run をクリックします - Xtifyのサンプル アプリケーションが起動した状態にてAVDが起動されます 26

27 通知のテスト ( エミュレーター使 用 ) GCM プッシュ通知を受け取るには Google アカウントに接続する必要があるため Setting > Accounts より Google アカウントの追加を実施します 27

28 通知のテスト ( エミュレーター使 用 ) Xtify の Push Point を使って通知のテストを 行行います - 次の URL へアクセスしてください point.html - 値を 入 力力して Send Push Notification をクリックしてください AVD に指定した通知メッセージが表 示されれば成功です 28

29 通知のテスト ( 実機使 用 ) Android デバイスの実機にてテストを実施します ビルドした Android アプリケーションを実機に配布する 方法はいくつかありますが 今回は直接 apk ファイルをデバイスに転送してインストールを実施します - 事前にデバイス側で 設定 セキュリティ 提供元不不明のアプリ にチェックを 入れて有効化しておく必要があります この設定が無効になっていると Android Market 経由以外から apk ファイルを端末にインストールできません - apk ファイルはプロジェクト直下の bin フォルダ下に 生成されますので そちらのファイルをデバイスへ転送しインストールください その後のテスト 手順はエミュレーター使 用時と同様です - Google アカウントを追加し Xtify の Push Point より通知のテストを実施ください 29

30 3. 既存のアプリへの SDK の組み込み 手順 30

31 全体の流流れ アプリへ IBM Push Notification SDK を組み込み 以外の 手順はサンプルアプリのセットアップ 手順と同様です - 以降降 アプリへ IBM Push Notification SDK を組み込み の 手順のみ記載します SDK のダウンロード IBM Push Notification SDK ダウンロードサイトより Android 向け SDK をダウンロード 新規 Google API プロジェクトの作成 にて Project の APIs & Credentials 設定 Xtify コンソールから Android アプリを登録 でのアプリケーション登録 アプリへ IBM Push Notification SDK を組み込み ADT でのサンプルアプリの Build アプリ稼動確認 用エミュレーターのセットアップ ADT での AVD 作成 31 通知のテスト ( エミュレーター使 用 ) Xtify のコンソールからテスト通知 通知のテスト ( 実機使 用 ) Xtify のコンソールからテスト通知

32 jar ファイルの配置 既存のプロジェクトの libs フォルダ ( ない場合には作成する ) に IBM Push Notification SDK for Android の jar ファイルをコピーします - jar ファイルはダウンロードした SDK のルートディレクトリにあります jar ファイル名は xtify- android- sdk jar(2014/9 月時点 ) 32

33 jar ファイルをライブラリに追加 プロジェクトを選択し 右クリックします [Build Path]- [Configure Build Path] を選択します [Libraries] タブを開き [Add JARs] を選択します さきの 手順でコピーした jar ファイルを選択し [OK] を押します 33

34 AndroidManifest.xml の修正 AndroidManifest.xml を開き 修正します - minimum Android SDK の項 目 ( 下記 ) を編集または追記し バージョンを 8 とします <uses- sdk android:minsdkversion="8" /> Ø The IBM Push Notification SDK for Android は 8 未満のバージョンでは動作しません すでに設定されている場合はスキップします 34

35 AndroidManifest.xml の修正 AndroidManifest.xml を開き 修正します ( 続き ) - IBM Push Notification に必要なパーミッションを許可します 35 - 下記のパーミッションを追記します 親の要素は manifest です Ø <manifest></manifest> 内に記述します [YOUR_ APP_ PACKAGE_ NAME] はプロジェクトのパッケージ名で置き換えます <permission android:name="your_ APP_ PACKAGE_ NAME.permission.C2D_ MESSAGE" android:protectionlevel="signature" /> <uses- permission android:name="your_ APP_ PACKAGE_ NAME.permission.C2D_ MESSAGE" /> <uses- permission android:name="com.google.android.c2dm.permission.receive" /> <uses- permission android:name="android.permission.internet" /> <uses- permission android:name="android.permission.wake_ LOCK" /> <uses- permission android:name="android.permission.receive_ BOOT_ COMPLETED" /> - もし通知からのアクションで電話をかける (Dial Action) を 行行う場合 下記のパーミッションも追加します <uses- permission android:name="android.permission.call_ PHONE" />

36 AndroidManifest.xml の修正 AndroidManifest.xml を開き 修正します ( 続き ) - IBM Push Notification に必要なアプリケーションコンポーネントを追加します - 次ページ以降降に掲載しているアプリケーションコンポーネントを追記します 親の要素は application です Ø <application></application> 内に記述します [YOUR_ APP_ PACKAGE_ NAME] はプロジェクトのパッケージ名で置き換えます 36

37 AndroidManifest.xml の修正 追加するアプリケーションコンポーネント ( 次ページに続く ) <provider android:name="com.xtify.sdk.db.provider" android:authorities="your_ APP_ PACKAGE_ NAME.XTIFY_ PROVIDER" android:exported="false" /> <receiver android:name="com.xtify.sdk.c2dm.c2dmbroadcastreceiver" > <intent- filter android:permission="com.google.android.c2dm.permission.send" > <action android:name="com.google.android.c2dm.intent.receive" /> <category android:name="your_ APP_ PACKAGE_ NAME" /> </intent- filter> <intent- filter android:permission="com.google.android.c2dm.permission.send" > <action android:name="com.google.android.c2dm.intent.registration" /> <category android:name="your_ APP_ PACKAGE_ NAME" /> </intent- filter> </receiver> 37

38 AndroidManifest.xml の修正 追加するアプリケーションコンポーネント ( 続き ) <receiver android:name="com.xtify.sdk.notifactionreceiver" /> <receiver android:name="com.xtify.sdk.wi.alarmreceiver" > <intent- filter> <action android:name="android.intent.action.boot_ COMPLETED" /> </intent- filter> <intent- filter> <action android:name="android.intent.action.timezone_ CHANGED" /> </intent- filter> <intent- filter> <action android:name="android.intent.action.package_ REPLACED" /> <data android:scheme="package" /> </intent- filter> </receiver> <service android:name="com.xtify.sdk.location.locationupdateservice" /> <service android:name="com.xtify.sdk.c2dm.c2dmintentservice" /> <service android:name="com.xtify.sdk.alarm.metricsintentservice" /> <service android:name="com.xtify.sdk.alarm.tagintentservice" /> <service android:name="com.xtify.sdk.alarm.registrationintentservice" /> <service android:name="com.xtify.sdk.alarm.locationintentservice" /> 38

39 Main Activity の修正 プロジェクトの Main Activity( アプリを開いたときに最初に起動するアクティビティ ) を編集します - 下記をインポートします import com.xtify.sdk.api.xtifysdk; 39

40 Main Activity の修正 プロジェクトの Main Activity を編集します ( 続き ) - Activity の onstart メソッドを追加または修正し XtifySDK.start を呼び出します YOUR_ XTIFY_ APP_ KEY は Xtify の AppKey に (p17 参照 ) YOUR_ PROJECT_ NUM は Google API Project Number に置き換えます (p13 参照 ) final String XTIFY_ APP_ KEY = "YOUR_ XTIFY_ APP_ KEY"; final String PROJECT_ NUM = "YOUR_ PROJECT_ NUM"; // This is the Google Project Number XtifySDK.start(getApplicationContext(), XTIFY_ APP_ KEY, PROJECT_ NUM); - 例例えば 下記のようなコードになります 40 public class MainActivity extends Activity { private static final String XTIFY_ APP_ KEY = " abcd- efgh- ijkl- 25d2389b0178"; private static final String PROJECT_ NUM = protected void onstart() { super.onstart(); XtifySDK.start(getApplicationContext(), XTIFY_ APP_ KEY, PROJECT_ NUM); } }

41 アプリケーションのテスト サンプルの 手順の 通知のテスト を参照ください - アプリケーションは外部ストレージカードに保存することは推奨されていません 内部ストレージにインストールする事が推奨されています 詳細は Google の下記のサイトを参照ください Ø App Install Location Ø location.html 41

42 42