サーバー リファレンス

サーバーの実装は省略可能です。次の操作を行う場合は、インスタンス ID サービスを使用します。

• アプリ インスタンスに関する情報を取得する。 アプリトークンを確認する、またはトークンを作成したアプリ インスタンスの詳細情報を取得する。
• アプリ インスタンスの関係マッピングを作成する。アプリ インスタンスとエンティティ間の関係を作成する。
• APNs トークンの登録トークンを作成する。この API を使用すると、既存の APNs トークンを一括でインポートして、FCM の有効な登録トークンにマッピングできます。

アプリ インスタンスに関する情報を取得する

アプリ インスタンスに関する情報を取得するには、次の例のように、アプリ インスタンスのトークンを指定して、このエンドポイントでインスタンス ID サービスを呼び出します。

 https://iid.googleapis.com/iid/info/IID_TOKEN

パラメータ

• Authorization: Bearer <access_token>。このパラメータをヘッダーに設定します。 有効期間の短い OAuth2 トークンを Authorization ヘッダーの値として追加します。 このトークンの取得方法について詳しくは、 認証情報を手動で指定するをご覧ください。
• access_token_auth: true。このパラメータをヘッダーに設定します。
• [省略可] boolean details：このクエリ パラメータを true に設定すると、このトークンに関連付けられている FCM トピックの登録情報（存在する場合）を取得できます。指定しない場合は、デフォルトの false になります。

結果

呼び出しが成功すると、HTTP ステータス 200 と、次の情報を含む JSON オブジェクトが返されます。

• application - トークンに関連付けられたパッケージ名。
• authorizedEntity - トークンへの送信を許可された projectId。
• applicationVersion - アプリケーションのバージョン。
• platform - トークンが属するデバイス プラットフォームを示す ANDROID、IOS、CHROME のいずれかを返します。

details フラグが設定されている場合:

• rel - トークンに関連付けられた関係。たとえば、トピック登録のリストなどです。

GET リクエストの例

https://iid.googleapis.com/iid/info/nKctODamlM4:CKrh_PC8kIb7O...clJONHoA
Content-Type:application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
access_token_auth: true

結果の例

HTTP 200 OK
{
  "application":"com.iid.example",
  "authorizedEntity":"123456782354",
  "platform":"Android",
  "rel":{
    "topics":{
      "topicname1":{"addDate":"2015-07-30"},
      "topicname2":{"addDate":"2015-07-30"},
      "topicname3":{"addDate":"2015-07-30"},
      "topicname4":{"addDate":"2015-07-30"}
    }
  }
}

アプリ インスタンスの関係マッピングを作成する

インスタンス ID API を使用すると、アプリ インスタンスの関係マッピングを作成できます。 たとえば、登録トークンを FCM トピックにマッピングして、アプリ インスタンスをトピックに登録できます。この API には、このような関係を個別に作成する方法と一括で作成する方法の両方が用意されています。

アプリ インスタンスのリレーション マッピングを作成する

登録トークンとサポートされている関係を指定すると、マッピングを作成できます。 たとえば、次の例のように、アプリ インスタンスのトークンを指定して、このエンドポイントでインスタンス ID サービスを呼び出すことで、アプリ インスタンスを FCM トピックに登録できます。

 https://iid.googleapis.com/iid/v1/IID_TOKEN/rel/topics/TOPIC_NAME

パラメータ

• Authorization: Bearer <access_token>。このパラメータをヘッダーに設定します。 有効期間の短い OAuth2 トークンを Authorization ヘッダーの値として追加します。 このトークンの取得方法について詳しくは、 認証情報を手動で指定するをご覧ください。
• access_token_auth: true。このパラメータをヘッダーに設定します。

結果

呼び出しが成功すると、HTTP ステータス 200 が返されます。

POST リクエストの例

https://iid.googleapis.com/iid/v1/nKctODamlM4:CKrh_PC8kIb7O...clJONHoA/rel/topics/movies
Content-Type:application/json
Content-Length: 0
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
access_token_auth: true

結果の例

HTTP 200 OK
{}

複数のアプリ インスタンスの関係マッピングを管理する

インスタンス ID サービスのバッチメソッドを使用すると、アプリ インスタンスのバッチ管理を行うことができます。たとえば、FCM トピックへのアプリ インスタンスの一括追加や削除を行うことができます。 API 呼び出しごとに最大 1,000 個のアプリ インスタンスを更新するには、次の例のように、JSON 本文にアプリ インスタンスのトークンを指定して、このエンドポイントでインスタンス ID サービスを呼び出します。

 https://iid.googleapis.com/iid/v1:batchAdd

 https://iid.googleapis.com/iid/v1:batchRemove

パラメータ

• Authorization: Bearer <access_token>。このパラメータをヘッダーに設定します。 有効期間の短い OAuth2 トークンを Authorization ヘッダーの値として追加します。 このトークンの取得方法について詳しくは、 認証情報を手動で指定するをご覧ください。
• access_token_auth: true。このパラメータをヘッダーに設定します。
• to : トピック名。
• registration_tokens : 追加または削除するアプリ インスタンスの IID トークンの配列。

結果

呼び出しが成功すると、HTTP ステータス 200 が返されます。結果が空の場合は、トークンの登録が成功したことを示します。登録に失敗した場合、結果には次のいずれかのエラーコードが含まれます。

• NOT_FOUND - 登録トークンが削除されたか、アプリがアンインストールされています。
• INVALID_ARGUMENT - 指定された登録トークンは送信者 ID に対して有効ではありません。
• INTERNAL - 不明な理由でバックエンド サーバーが失敗しました。リクエストを再試行します。
• TOO_MANY_TOPICS - アプリ インスタンスあたりのトピック数が多すぎます。
• RESOURCE_EXHAUSTED - 短期間に登録または登録解除のリクエストが多すぎます。指数バックオフを使用して再試行します。

POST リクエストの例

https://iid.googleapis.com/iid/v1:batchAdd
Content-Type:application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
access_token_auth: true
{
   "to": "/topics/movies",
   "registration_tokens": ["nKctODamlM4:CKrh_PC8kIb7O...", "1uoasi24:9jsjwuw...", "798aywu:cba420..."],
}

結果の例

HTTP 200 OK
{
  "results":[
    {},
    {"error":"NOT_FOUND"},
    {},
  ]
}

APNs トークンの登録トークンを作成する

インスタンス ID サービスの batchImport メソッドを使用すると、既存の iOS APNs トークンを Firebase Cloud Messaging に一括でインポートして、有効な登録トークンにマッピングできます。次の例のように、JSON 本文に APNs トークンのリストを指定して、このエンドポイントでインスタンス ID サービスを呼び出します。

 https://iid.googleapis.com/iid/v1:batchImport

レスポンス本文には、対応する APNs デバイス トークンに FCM メッセージを送信するために使用できるインスタンス ID 登録トークンの配列が含まれています。

**注:** 各リクエストの APNs トークンのリストは 100 個以下にする必要があります。

パラメータ

• Authorization: Bearer <access_token>。このパラメータをヘッダーに設定します。 有効期間の短い OAuth2 トークンを Authorization ヘッダーの値として追加します。 このトークンの取得方法について詳しくは、 認証情報を手動で指定するをご覧ください。
• access_token_auth: true。このパラメータをヘッダーに設定します。
• application : アプリのバンドル ID。
• sandbox : サンドボックス環境（TRUE）または本番環境（FALSE）を示すブール値
• apns_tokens : 追加または削除するアプリ インスタンスの APNs トークンの配列。リクエストごとに最大 100 個のトークン。

結果

呼び出しが成功すると、HTTP ステータス 200 と JSON 結果本文が返されます。リクエストで指定された APNs トークンごとに、結果リストには次の情報が含まれます。

• APNs トークン。
• ステータス。OK、または失敗を説明するエラー メッセージ。
• 成功した結果については、FCM が APNs トークンにマッピングする登録トークン。

POST リクエストの例

https://iid.googleapis.com/iid/v1:batchImport
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
access_token_auth:true
{
  "application": "com.google.FCMTestApp",
  "sandbox":false,
  "apns_tokens":[
      "368dde283db539abc4a6419b1795b6131194703b816e4f624ffa12",
      "76b39c2b2ceaadee8400b8868c2f45325ab9831c1998ed70859d86"
   ]
}

結果の例

HTTP 200 OK
{
 "results":[
       {
        "apns_token": "368dde283db539abc4a6419b1795b6131194703b816e4f624ffa12",
         "status": "OK",
         "registration_token":"nKctODamlM4:CKrh_PC8kIb7O...clJONHoA"
       },
       {
         "apns_token": "76b39c2b2ceaadee8400b8868c2f45325ab9831c1998ed70859d86",
         "status":"Internal Server Error"
        },
     ]
  }

エラー レスポンス

インスタンス ID サーバー API の呼び出しでは、次の HTTP エラーコードが返されます。

• HTTP status 400 (Bad request) - リクエスト パラメータがないか、無効です。 詳細については、エラー メッセージをご確認ください。
• HTTP status 401 (Unauthorized) - 認証ヘッダーが無効です。
• HTTP status 403 (Forbidden) - 認証ヘッダーが authorizedEntityと一致しません。
• HTTP status 404 (Not found) - HTTP パスが無効か、IID トークンが見つかりません。 詳細については、エラー メッセージをご確認ください。
• HTTP status 503 (Service unavailable) - サービスを利用できません。指数バックオフを使用してリクエストを再試行します。