API リファレンス

Android Developer ID Status API リファレンス

公式のサーバー間 API は、パッケージ名またはパッケージと証明書の組み合わせに対し、小さく安定した登録状態を返します。IDE や CI/CD に利用できますが、Google Cloud API キーを保護し、割り当てと一時障害を明示的に処理する必要があります。

概要

Android Developer ID Status API でパッケージ名と SHA-256 証明書を照会し、すべての登録状態を安全に処理します。

対象: 公式ステータス サービスを組み込む開発ツール作者、リリース基盤チーム、Android エンジニア。

確認手順

  1. 専用 Google Cloud プロジェクトで Android Developer ID Status API を有効にする。
  2. API キーを制限し、サーバーまたは CI のシークレット ストアに保存する。
  3. パッケージ名と任意の正規化 SHA-256 証明書を送る。
  4. state で分岐し、HTTP と割り当てエラーは別に扱う。

要点

メソッドGET packageRegistrationStatus:check
認証X-Goog-Api-Key header
安定した結果state field
注意点

Google の人向けエラー文を機械契約として解析しないでください。HTTP status と canonical error status を使い、ブラウザ JavaScript に API キーを公開しません。

詳しい解説

リクエストとレスポンスの契約

エンドポイントはパスにパッケージ名、任意の certificateFingerprint クエリを受け付けます。信頼できるサーバーまたは CI から X-Goog-Api-Key に API キーを設定します。

HTTP 200 の成功レスポンスには state が含まれます。INVALID_ARGUMENT と PERMISSION_DENIED は設定失敗として扱い、RESOURCE_EXHAUSTED、INTERNAL、UNAVAILABLE だけを上限付き指数バックオフで再試行します。

  • API キーをクエリ文字列へ入れない。
  • 人向けエラー文で分岐しない。
  • 最近の結果をキャッシュし確認時刻を付ける。
パッケージと証明書のリクエスト
curl --fail --silent \
  -H "X-Goog-Api-Key: $ANDROID_DEVELOPER_ID_API_KEY" \
  "https://androiddeveloperidstatus.googleapis.com/v1/packages/com.example.app/packageRegistrationStatus:check?certificateFingerprint=64_HEX_CHARACTERS"

製品版のパッケージ名を入力し、署名も照合する場合は配布 APK の証明書 SHA-256 を追加します。ストア審査やアプリの安全性とは別の確認です。

ステータスを確認 →

よくある質問

Status API に OAuth は必要ですか?

現行の公式ガイドは、このステータス照会エンドポイントに API キー認証を案内しています。

ブラウザ JavaScript から直接呼べますか?

再利用可能な Google API キーを公開すべきではありません。保護されたサーバーまたは CI から呼び出してください。

出典と更新情報

最終確認日: