Android Developer Console API

Android Developer Console API adalah layanan RESTful yang memungkinkan developer terverifikasi mengotomatiskan alur kerja verifikasi developer Android di Konsol Developer Android, termasuk mengambil akun developer, memeriksa persyaratan kelayakan utama, mendaftarkan nama paket Android, mendaftarkan kunci penandatanganan aplikasi, dan memverifikasi kepemilikan kunci.

Ringkasan, kasus penggunaan, dan konteks penerapan

Kasus penggunaan dan fitur utama

• Pendaftaran nama paket CI/CD otomatis: Daftarkan puluhan atau ratusan nama paket Android secara terprogram (CreateAndroidPackage).
• Pemeriksaan kebijakan kunci historis sebelum peluncuran: Memeriksa secara terprogram apakah Google telah mengamati nama paket dalam ekosistem dan apakah mendaftarkan sertifikat penandatanganan tertentu memerlukan verifikasi kepemilikan kunci (GetAndroidPackageRegistrationPolicy).
• Pendaftaran kunci penandatanganan aplikasi dan verifikasi kepemilikan otomatis: Daftarkan sidik jari SHA-256 sertifikat penandatanganan publik (CreateAndroidPackageKey), ambil token verifikasi unik (verificationToken), dan otomatiskan bukti kepemilikan kunci pribadi menggunakan upload APK bertanda tangan yang dapat dilanjutkan atau permintaan tunggal (VerifyAndroidPackageKeyOwnership).
• Pengiriman justifikasi terprogram: Kirim justifikasi kepemilikan (JustifyAndroidPackageKeyRegistration).
• Pemantauan status: Pantau status pendaftaran di seluruh akun developer, nama paket, dan kunci penandatanganan aplikasi (GetDeveloperAccount, ListDeveloperAccounts, GetAndroidPackage, ListAndroidPackages, GetAndroidPackageKey, ListAndroidPackageKeys).

Alur kerja penerapan menyeluruh

1. Verifikasi identitas developer sekali di UI: Selesaikan verifikasi identitas developer (INDIVIDUAL atau ORGANIZATION) di Konsol Developer Android sehingga verificationState adalah VERIFIED.
2. Aktifkan API dan lakukan autentikasi: Aktifkan androiddeveloperconsole.googleapis.com di project Google Cloud Anda dan dapatkan token akses Bearer OAuth 2.0 yang didelegasikan pengguna dengan cakupan https://www.googleapis.com/auth/androiddeveloperconsole.
3. Temukan nama resource akun developer Anda: Panggil GET /v1/developerAccounts (ListDeveloperAccounts) untuk mengambil developerAccounts/{developer_account} dan verifikasi verificationState adalah VERIFIED.
4. Periksa kebijakan pendaftaran untuk nama paket: Panggil GET /v1/developerAccounts/{id}/androidPackages/{pkg}/registrationPolicy (GetAndroidPackageRegistrationPolicy) untuk memeriksa keySelectionStrategy (SELECT_KEY_FROM_LIST atau USE_ANY_KEY) dan kunci penandatanganan historis yang diketahui (knownKeys).
5. Membuat resource paket Android: Panggil POST /v1/developerAccounts/{id}/androidPackages?androidPackageId={pkg} (CreateAndroidPackage) dengan isi {"name": ""} (membuat resource dalam status DRAFT).
6. Daftarkan sidik jari kunci penandatanganan aplikasi Anda: Panggil POST /v1/developerAccounts/{id}/androidPackages/{pkg}/keys (CreateAndroidPackageKey) dengan isi JSON {"certificateFingerprintSha256": "..."}. Periksa status yang ditampilkan:
   • DRAFT: Bukti kepemilikan kunci pribadi diperlukan, dan responsnya mencakup verificationToken unik untuk Langkah 7.
   • IN_REVIEW: Bukti kepemilikan dan justifikasi akan otomatis dilewati (misalnya, saat mendaftarkan nama paket baru yang belum pernah terlihat di Android, atau saat Anda telah memverifikasi kepemilikan kunci penandatanganan ini untuk nama paket lain di DeveloperAccount yang sama). Lewati Langkah 7 dan panggilan justifikasi di Langkah 8, lalu lanjutkan langsung ke polling GetAndroidPackage dan GetAndroidPackageKey.
7. Buat dan upload APK verifikasi (jika statusnya DRAFT): Sematkan string verificationToken yang ditampilkan ke dalam assets/adi-registration.properties di dalam APK minimal yang cocok dengan packageName, tanda tangani dengan kunci penandatanganan aplikasi pribadi Anda, lalu upload menggunakan POST /upload/v1/developerAccounts/{id}/androidPackages/{pkg}/keys/{sha256}:verify (VerifyAndroidPackageKeyOwnership).
8. Kirimkan justifikasi (jika diperlukan) dan status pendaftaran polling: Jika kunci berada dalam status OWNERSHIP_VERIFIED dan registrationJustificationRequired adalah true, panggil POST /v1/developerAccounts/{id}/androidPackages/{pkg}/keys/{sha256}:justifyAndroidPackageKeyRegistration (JustifyAndroidPackageKeyRegistration). Polling GetAndroidPackage dan GetAndroidPackageKey hingga state mencapai REGISTERED.

Perintah CLI lokal untuk menyiapkan sidik jari kunci dan APK verifikasi

• Mengekstrak sidik jari sertifikat SHA-256 dari keystore (keytool):

  keytool -list -v -keystore release-key.jks -alias my-key-alias

• Memverifikasi ringkasan sertifikat penandatanganan SHA-256 pada APK yang di-build (apksigner):

  apksigner verify --print-certs app-release.apk

• Periksa nama paket APK dan file token tersemat sebelum mengupload (aapt2 dan unzip):

  aapt2 dump badging app-release.apk | head -n 1
  unzip -p app-release.apk assets/adi-registration.properties

Kemampuan UI dan API Konsol Developer Android

Konfigurasi dan autentikasi layanan

Semua permintaan API harus menggunakan HTTPS dan menyertakan header Authorization: Bearer ACCESS_TOKEN yang diperoleh menggunakan alur Server Web OAuth 2.0 untuk Akun Google yang telah menyelesaikan verifikasi identitas developer di Konsol Developer Android.

Resource dan endpoint API

API Konsol Developer Android mengatur resource dalam hierarki berikut:

• DeveloperAccount (developerAccounts/{developer_account})
  • AndroidPackage (developerAccounts/{developer_account}/androidPackages/{android_package})
    • AndroidPackageRegistrationPolicy (developerAccounts/{developer_account}/androidPackages/{android_package}/registrationPolicy)
    • AndroidPackageKey (developerAccounts/{developer_account}/androidPackages/{android_package}/keys/{key})

Resource: DeveloperAccount

Mewakili akun di Konsol Developer Android yang terkait dengan identitas developer.

Enum: DeveloperAccount.VerificationState

Metode: DeveloperAccount

Resource: AndroidPackage

Merepresentasikan nama paket Android yang terdaftar atau sedang didaftarkan di DeveloperAccount.

Enum: AndroidPackage.State

Resource: AndroidPackageRegistrationPolicy

Resource singleton yang ditampilkan oleh GetAndroidPackageRegistrationPolicy yang menjelaskan kunci penandatanganan publik historis yang terdeteksi untuk nama paket dan apakah mendaftarkan nama paket dengan kunci penandatanganan tertentu memerlukan justifikasi tertulis.

Enum: KnownKey.JustificationRequirement

Enum: AndroidPackageRegistrationPolicy.KeySelectionStrategy

Metode: AndroidPackage

Resource: AndroidPackageKey

Merepresentasikan sidik jari sertifikat penandatanganan aplikasi publik yang terkait dengan AndroidPackage dan melacak status verifikasi kepemilikan dan peninjauan pendaftaran.

Enum: AndroidPackageKey.State

Metode: AndroidPackageKey

Penanganan error

Jika permintaan API gagal, Konsol Developer Android API akan menampilkan kode status HTTP 4xx atau 5xx dan isi error JSON google.rpc.Status standar:

{
  "error": {
    "code": 400,
    "message": "Invalid certificate fingerprint SHA256 format.",
    "status": "INVALID_ARGUMENT",
    "details": []
  }
}

Kode status HTTP dan penyelesaian umum

Contoh permintaan dan respons HTTP

Ganti nilai placeholder seperti ACCESS_TOKEN, 1234567890, com.example.myapp, dan 60e860e8... dengan nilai Anda sendiri.

1. GetDeveloperAccount

curl -X GET \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  "https://androiddeveloperconsole.googleapis.com/v1/developerAccounts/1234567890"

Respons:

{
  "name": "developerAccounts/1234567890",
  "displayName": "Example Developer",
  "verificationState": "VERIFIED"
}

2. ListDeveloperAccounts

curl -X GET \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  "https://androiddeveloperconsole.googleapis.com/v1/developerAccounts"

Respons:

{
  "developerAccounts": [
    {
      "name": "developerAccounts/1234567890",
      "displayName": "Example Developer",
      "verificationState": "VERIFIED"
    }
  ]
}

3. GetAndroidPackageRegistrationPolicy

curl -X GET \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  "https://androiddeveloperconsole.googleapis.com/v1/developerAccounts/1234567890/androidPackages/com.example.myapp/registrationPolicy"

Respons:

{
  "name": "developerAccounts/1234567890/androidPackages/com.example.myapp/registrationPolicy",
  "knownKeys": [
    {
      "certificateFingerprintSha256": "60e860e8d77251234567890abcdef1234567890abcdef1234567890abcdef123",
      "justificationRequirement": "NOT_REQUIRED"
    }
  ],
  "keySelectionStrategy": "SELECT_KEY_FROM_LIST"
}

4. CreateAndroidPackage

curl -X POST \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json; charset=utf-8" \
  -d '{"name": ""}' \
  "https://androiddeveloperconsole.googleapis.com/v1/developerAccounts/1234567890/androidPackages?androidPackageId=com.example.myapp"

Respons:

{
  "name": "developerAccounts/1234567890/androidPackages/com.example.myapp",
  "packageName": "com.example.myapp",
  "state": "DRAFT",
  "registeredAppStore": false
}

5. GetAndroidPackage

curl -X GET \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  "https://androiddeveloperconsole.googleapis.com/v1/developerAccounts/1234567890/androidPackages/com.example.myapp"

Respons:

{
  "name": "developerAccounts/1234567890/androidPackages/com.example.myapp",
  "packageName": "com.example.myapp",
  "state": "REGISTERED",
  "registeredAppStore": false
}

6. ListAndroidPackages

curl -X GET \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  "https://androiddeveloperconsole.googleapis.com/v1/developerAccounts/1234567890/androidPackages?pageSize=100"

Respons:

{
  "androidPackages": [
    {
      "name": "developerAccounts/1234567890/androidPackages/com.example.myapp",
      "packageName": "com.example.myapp",
      "state": "REGISTERED",
      "registeredAppStore": false
    }
  ],
  "nextPageToken": ""
}

7. CreateAndroidPackageKey

curl -X POST \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json; charset=utf-8" \
  -d '{
    "certificateFingerprintSha256": "60e860e8d77251234567890abcdef1234567890abcdef1234567890abcdef123"
  }' \
  "https://androiddeveloperconsole.googleapis.com/v1/developerAccounts/1234567890/androidPackages/com.example.myapp/keys"

Respons:

{
  "name": "developerAccounts/1234567890/androidPackages/com.example.myapp/keys/60e860e8d77251234567890abcdef1234567890abcdef1234567890abcdef123",
  "certificateFingerprintSha256": "60e860e8d77251234567890abcdef1234567890abcdef1234567890abcdef123",
  "state": "DRAFT",
  "verificationToken": "token_xyz987654321"
}

8. GetAndroidPackageKey

curl -X GET \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  "https://androiddeveloperconsole.googleapis.com/v1/developerAccounts/1234567890/androidPackages/com.example.myapp/keys/60e860e8d77251234567890abcdef1234567890abcdef1234567890abcdef123"

Respons:

{
  "name": "developerAccounts/1234567890/androidPackages/com.example.myapp/keys/60e860e8d77251234567890abcdef1234567890abcdef1234567890abcdef123",
  "certificateFingerprintSha256": "60e860e8d77251234567890abcdef1234567890abcdef1234567890abcdef123",
  "state": "REGISTERED"
}

9. ListAndroidPackageKeys

curl -X GET \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  "https://androiddeveloperconsole.googleapis.com/v1/developerAccounts/1234567890/androidPackages/com.example.myapp/keys?pageSize=100"

Respons:

{
  "androidPackageKeys": [
    {
      "name": "developerAccounts/1234567890/androidPackages/com.example.myapp/keys/60e860e8d77251234567890abcdef1234567890abcdef1234567890abcdef123",
      "certificateFingerprintSha256": "60e860e8d77251234567890abcdef1234567890abcdef1234567890abcdef123",
      "state": "REGISTERED"
    }
  ],
  "nextPageToken": ""
}

10. VerifyAndroidPackageKeyOwnership

Opsi A: Upload media permintaan tunggal

curl -X POST \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/octet-stream" \
  --data-binary @app-release.apk \
  "https://androiddeveloperconsole.googleapis.com/upload/v1/developerAccounts/1234567890/androidPackages/com.example.myapp/keys/60e860e8d77251234567890abcdef1234567890abcdef1234567890abcdef123:verify?uploadType=media"

Opsi B: Protokol upload yang dapat dilanjutkan (direkomendasikan untuk APK besar atau CI/CD)

Langkah 1: Mulai sesi upload yang dapat dilanjutkan dan ekstrak header X-Goog-Upload-URL yang ditampilkan:

curl -i -X POST \
  "https://androiddeveloperconsole.googleapis.com/upload/v1/developerAccounts/1234567890/androidPackages/com.example.myapp/keys/60e860e8d77251234567890abcdef1234567890abcdef1234567890abcdef123:verify" \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "X-Goog-Upload-Protocol: resumable" \
  -H "X-Goog-Upload-Command: start" \
  -H "X-Goog-Upload-Header-Content-Length: FILE_SIZE_IN_BYTES" \
  -H "X-Goog-Upload-Header-Content-Type: application/vnd.android.package-archive" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "developerAccounts/1234567890/androidPackages/com.example.myapp/keys/60e860e8d77251234567890abcdef1234567890abcdef1234567890abcdef123"
  }'

Langkah 2: Upload biner APK yang ditandatangani ke UPLOAD_SESSION_URI dan selesaikan sesi:

curl -X PUT \
  "UPLOAD_SESSION_URI" \
  -H "Content-Length: FILE_SIZE_IN_BYTES" \
  -H "X-Goog-Upload-Offset: 0" \
  -H "X-Goog-Upload-Command: upload, finalize" \
  --data-binary "@app-release.apk"

Respons:

{
  "name": "developerAccounts/1234567890/androidPackages/com.example.myapp/keys/60e860e8d77251234567890abcdef1234567890abcdef1234567890abcdef123",
  "certificateFingerprintSha256": "60e860e8d77251234567890abcdef1234567890abcdef1234567890abcdef123",
  "state": "IN_REVIEW"
}

11. JustifyAndroidPackageKeyRegistration

curl -X POST \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json; charset=utf-8" \
  -d '{
    "justification": "We previously distributed com.example.myapp directly from https://downloads.example.com and are migrating to our rotated production key."
  }' \
  "https://androiddeveloperconsole.googleapis.com/v1/developerAccounts/1234567890/androidPackages/com.example.myapp/keys/60e860e8d77251234567890abcdef1234567890abcdef1234567890abcdef123:justifyAndroidPackageKeyRegistration"

Respons:

{
  "name": "developerAccounts/1234567890/androidPackages/com.example.myapp/keys/60e860e8d77251234567890abcdef1234567890abcdef1234567890abcdef123",
  "certificateFingerprintSha256": "60e860e8d77251234567890abcdef1234567890abcdef1234567890abcdef123",
  "state": "IN_REVIEW",
  "registrationJustificationRequired": true
}

Referensi lainnya

• Mendaftarkan nama paket dengan Android Developer Console API
• Memeriksa status pendaftaran aplikasi dengan Android Developer ID Status API
• Mendaftar di Konsol Developer Android
• Mendaftar di Konsol Google Play