Android の実装

次の例は、Android クライアントにインスタンス ID を実装する際に役立ちます。これらの例では GCM スコープを使用しています。これは、 Google Cloud Messaging が廃止されているため、デモ目的でのみ使用できます。

Google Play 開発者サービスを設定する

クライアント アプリケーションを作成するには、Google Play 開発者サービス SDK を使用します。 Google Play 開発者サービス SDK の設定で説明されています。Google Play 開発者サービス ライブラリには、インスタンス ID ライブラリが含まれています。

インスタンス ID を取得する

次のコード行は、インスタンス ID を返します。

String iid = InstanceID.getInstance(context).getId();

トークンを生成する

トークンを生成するには、 Google Developers Consoleで生成されたプロジェクト ID が必要です。

String authorizedEntity = PROJECT_ID; // Project id from Google Developer Console
String scope = "GCM"; // e.g. communicating using GCM, but you can use any
                      // URL-safe characters up to a maximum of 1000, or
                      // you can also leave it blank.
String token = InstanceID.getInstance(context).getToken(authorizedEntity,scope);

トークンとインスタンス ID を管理する

インスタンス ID を使用すると、トークンを削除して更新できます。

トークンとインスタンス ID を削除する

String authorizedEntity = PROJECT_ID;
String scope = "GCM";
InstanceID.getInstance(context).deleteToken(authorizedEntity,scope);

関連するすべてのトークンを含め、インスタンス ID 自体を削除することもできます。次に getInstance() を呼び出すと、新しいインスタンス ID が返されます。

InstanceID.getInstance(context).deleteInstanceID();
String newIID = InstanceID.getInstance(context).getId();

トークンを更新する

インスタンス ID サービスは、定期的に（たとえば 6 か月ごとに）コールバックを開始し、アプリにトークンの更新をリクエストします。次の場合にもコールバックを開始することがあります。

  • セキュリティの問題がある場合（SSL やプラットフォームの問題など）。
  • デバイス情報が無効になった場合（バックアップと復元など）。
  • インスタンス ID サービスが影響を受けている場合。

これらのコールバックを受信するには、アプリにインスタンス ID リスナー サービスを実装します。

public class MyInstanceIDService extends InstanceIDListenerService {
  public void onTokenRefresh() {
    refreshAllTokens();
  }

  private void refreshAllTokens() {
    // assuming you have defined TokenList as
    // some generalized store for your tokens
    ArrayList<TokenList> tokenList = TokensList.get();
    InstanceID iid = InstanceID.getInstance(this);
    for(tokenItem : tokenList) {
      tokenItem.token =
        iid.getToken(tokenItem.authorizedEntity,tokenItem.scope,tokenItem.options);
      // send this tokenItem.token to your server
    }
  }
};

また、プロジェクトのマニフェスト ファイルでこのサービスを構成する必要があります。

<service android:name=".MyInstanceIDService" android:exported="false">
  <intent-filter>
        <action android:name="com.google.android.gms.iid.InstanceID"/>
  </intent-filter>
</service>