サーバー リファレンス

サーバーの実装は任意です。次のオペレーションを実行する場合は、インスタンス ID サービスを使用してください。

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

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

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

パラメータ

  • Authorization: Bearer <access_token>。このパラメータはヘッダーで設定します。有効期間の短い OAuth2 トークンを Authorization ヘッダーの値として追加します。このトークンの取得方法については、認証情報を手動で指定するをご覧ください。
  • access_token_auth: true。このパラメータはヘッダーで設定します。
  • [省略可] ブール値 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"}
    }
  }
}

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

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

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

登録トークンとサポートされている関係に基づいて、マッピングを作成できます。たとえば、このエンドポイントで Instance 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
{}

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

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

 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 に対して有効ではありません。
  • 内部 - 不明な理由でバックエンド サーバーが失敗しました。リクエストを再試行します。
  • 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"},
    {},
  ]
}

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

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

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

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

パラメータ

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

結果

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

  • APN トークン。
  • ステータス。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) - サービスを利用できません。指数バックオフでリクエストを再試行します。