ここでは、SDKをAndroidプロジェクト内で使用可能な状態にするためのセットアップ作業について解説します。

0. ECHOサイトアカウントを開設

本SDKを使用してアプリケーション開発を行うには、まずECHOサイトアカウントの開設と初期設定が必要です。

サイトアカウントの開設や初期設定の方法は、ECHO基本ガイドをご参照ください。

1. APIアプリケーション登録

外部のアプリケーションからECHOへアクセスするには、予め管理画面よりAPIアプリケーション登録が必要です。

アプリケーションの登録が完了すると、アプリケーションIDアプリケーションキーが発行されます。
この情報は、後ほどSDKの初期化の際に使用します。

 2. SDKを取得する

以下のリンクよりSDKをダウンロードできます。

ダウンロードしたzipファイル内にある「ECHO.jar」を、Androidプロジェクトのlibsディレクトリにコピーしてください。

3. パーミッションの設定

SDKの使用にあたり、プロジェクトにて必要なパーミッションの設定を行います。

以下のパーミッションタグを、プロジェクトのAndroidManifest.xml内<application>タグの直前に追加してください。

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

4. SDK初期化

メインのActivityクラス内で以下のメソッドを呼び出すことで、SDKが使用できるようになります。

ECHO.initialize(this, "アカウントドメイン", "アプリケーションID", "アプリケーションキー");

第1引数にはActivityのコンテキスト(this)、第2引数にはアカウントのドメイン名、第3・第4引数には先ほど取得したアプリケーションIDアプリケーションキーを渡します。

5. プッシュ通知配信機能セットアップ(オプション)

本SDKでプッシュ通知配信を行うには、追加でセットアップ作業を行ってください。

Google Cloud Messaging(GCM)との連携設定

Android端末に対してプッシュ通知を配信するには、あらかじめGoogle Cloud Messaging(GCM)との連携設定が必要です。
連携設定の方法は以下をご参照ください。

依存ライブラリのインストール

プッシュ通知配信機能では、以下のライブラリを使用するため、インストール作業を行ってください。

AndroidManifest.xmlの拡張

以下のパーミッションを、AndroidManifest.xmlへ追記します。

<!-- 追加パーミッション -->
<uses-permission android:name="android.permission.GET_ACCOUNTS" />
<uses-permission android:name="android.permission.WAKE_LOCK" />
<uses-permission android:name="com.google.android.c2dm.permission.RECEIVE" />
<uses-permission android:name="android.permission.VIBRATE" /> <!-- 受診時のバイブレーションが不要な場合は削除 -->
<permission android:name="パッケージ名.permission.C2D_MESSAGE" android:protectionLevel="signature" />
<uses-permission android:name="パッケージ名.permission.C2D_MESSAGE" />

以下を<application>内に追記します。

<!-- GCM Sender IDの登録 -->
<meta-data android:name="com.echopf.push.gcm_sender_id" android:value="id:プロジェクトNo*" />

<!-- プッシュ通知開封時に表示するActivityを指定 -->
<meta-data android:name="com.echopf.push.open_activity" android:value="パッケージ名.MainActivity" />
<!-- 通知の複数表示設定:最新の通知のみ表示する場合はtrue、それ以外はfalse -->
<meta-data android:name="com.echopf.push.notify_only_latest" android:value="true/false" />

<!-- レシーバー登録 -->
<receiver android:name="com.google.android.gms.gcm.GcmReceiver"
          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="パッケージ名" />
          </intent-filter>
</receiver>

<!-- サービス登録 -->
<service android:name="com.echopf.ECHOGcmListenerService"
         android:exported="false">
         <intent-filter>
             <action android:name="com.google.android.c2dm.intent.RECEIVE" />
         </intent-filter>
</service>

※ プロジェクトNoの確認方法は、こちらをご参照ください。