Mendaftarkan nama paket dengan Android Developer Console API

Android Developer Console API adalah antarmuka publik yang dirancang untuk memungkinkan distributor aplikasi dan developer perorangan mendaftarkan nama paket secara terprogram di Konsol Developer Android.

Kemampuan server-ke-server Anda sebagai:

Distributor aplikasi	Developer perorangan
Daftarkan nama paket - kunci atas nama developer yang memublikasikan aplikasi ke Play Store. Daftarkan nama paket dengan kunci yang dikelola oleh Play. Membuktikan kepemilikan kunci yang terkait dengan nama paket.	Mendaftarkan nama paket - kunci dalam alur kerja continuous deployment Anda. Membuktikan kepemilikan kunci yang terkait dengan nama paket.

Sebelum memulai

Sebelum memulai, Anda harus memiliki:

1. Akses administratif ke project Google Cloud.
2. Pemahaman dasar tentang:
   • API
   • Struktur APK
   • Penandatanganan aplikasi Android
   • Membuat ringkasan SHA-256

Anda juga harus memahami istilah-istilah berikut:

Istilah	Definisi
Akun developer	Mewakili akun Konsol Developer Android yang dapat memiliki satu atau beberapa nama paket. Atribut ini berisi status verifikasi (NOT_VERIFIED atau VERIFIED).
Nama paket	Nama paket Android tertentu (misalnya, com.example.app) dalam akun developer, yang dapat dikaitkan dengan satu atau beberapa kunci. Objek ini berisi status pendaftaran (DRAFT, IN_REVIEW, REGISTERED, atau PENDING_TRANSFER).
Kunci	Sertifikat/kunci publik spesifik yang digunakan untuk menandatangani nama paket Android. Mencakup hash SHA-256 dan status pendaftaran saat ini (DRAFT, OWNERSHIP_VERIFIED, IN_REVIEW, REGISTERED, atau PENDING_TRANSFER).

Mulai

Selesaikan langkah-langkah berikut untuk mengakses Android Developer Console API:

Membuat project Google Cloud

1. Buat akun Google Cloud jika Anda belum memilikinya.
2. Buka Konsol Google Cloud.
3. Buat project Google Cloud.

Mengaktifkan API di project Google Cloud Anda

1. Buka Konsol Google Cloud.
2. Di menu navigasi (☰), pilih APIs & Services > Library.
3. Pilih project Google Cloud tempat Anda ingin mengaktifkan API dari menu drop-down project.
4. Gunakan kotak penelusuran APIs & Services untuk memilih Konsol Developer Android API.
5. Aktifkan API:
   1. Buka halaman ringkasan API dengan memilihnya dari hasil penelusuran.
   2. Klik tombol Aktifkan berwarna biru. Google Cloud mengaktifkan API untuk project yang Anda pilih, yang biasanya hanya memerlukan waktu beberapa saat. Setelah diaktifkan, Anda dapat mulai menggunakannya.

Mengautentikasi API

Untuk melakukan panggilan ke Konsol Developer Android API, Anda harus mengautentikasi permintaan menggunakan OAuth 2.0.

Melakukan autentikasi dengan OAuth 2.0

Android Developer Console API memerlukan autentikasi OAuth 2.0 untuk memberikan otorisasi akses ke nama paket dan resource akun developer. Karena data akun developer terikat ke Akun Google pengguna, bukan project Google Cloud, Akun Layanan, Workload Identity Federation, dan kunci API tidak dapat digunakan untuk mengautentikasi permintaan API.

Cakupan OAuth 2.0

Cakupan berikut diperlukan untuk semua operasi:

Cakupan OAuth 2.0	Deskripsi
https://www.googleapis.com/auth/androiddeveloperconsole	Melihat dan mengelola nama paket dan data di akun Konsol Developer Android Anda

Menerapkan alur Server Web OAuth 2.0

Untuk berintegrasi dengan Konsol Developer Android API, aplikasi harus menggunakan alur Server Web OAuth 2.0. Bergantung pada jenis aplikasi dan kebutuhan otomatisasi, Anda dapat memilih antara dua strategi pengelolaan kredensial utama:

Opsi A (Direkomendasikan): Akses offline / otomatis (integrasi CI/CD & server)

Opsi B: Akses sementara / interaktif

Strategi ini memungkinkan proses otomatis (seperti pipeline CI/CD) berjalan di latar belakang tanpa intervensi manusia: Penyiapan izin pengguna satu kali: Selama penyiapan awal, developer atau pemilik akun menyelesaikan alur izin satu kali di browser mereka. Aplikasi Anda meminta akses offline (access_type=offline) bersama dengan cakupan API. Google akan menampilkan kode otorisasi, yang ditukarkan oleh aplikasi Anda dengan token akses awal dan token refresh yang memiliki masa aktif lama. Eksekusi di latar belakang: Simpan refresh_token dengan aman di lingkungan deployment atau pengelola secret Anda (misalnya, Secret GitHub Actions, Google Secret Manager). Untuk panggilan API berikutnya, alur kerja otomatis Anda menggunakan token refresh yang disimpan untuk mendapatkan token akses baru yang memiliki masa aktif singkat sesuai permintaan, sehingga melewati perintah login manual atau 2FA.

Jika Anda lebih memilih untuk tidak menyimpan token refresh yang berlaku lama di lingkungan Anda, atau jika aplikasi Anda berjalan dalam konteks pengguna interaktif: Minta izin saat eksekusi: Jangan meminta akses offline atau menyimpan token refresh. Setiap kali alat atau aplikasi dijalankan, minta pengguna untuk melakukan autentikasi dengan mengalihkan mereka ke halaman izin OAuth Google di browser mereka. Akses berjangka pendek: Pengguna login dan memberikan izin, lalu aplikasi menerima token akses berjangka pendek secara langsung (atau menggunakan pertukaran kode otorisasi). Token akses ini digunakan untuk melakukan panggilan API dan dihapus setelah eksekusi. Eksekusi mendatang mengharuskan pengguna untuk melakukan autentikasi ulang.

Mendaftarkan nama paket

Pendaftaran nama paket adalah proses mengaitkan kunci dengan nama paket. Cara kunci didaftarkan bergantung pada apakah Anda mendaftarkan kunci ke nama paket baru atau yang sudah ada di Android.

Mendaftarkan nama paket baru

Untuk nama paket baru yang belum pernah terlihat di Android, Anda dapat memberikan public key certificate dari pasangan kunci penandatanganan aplikasi.

Mendaftarkan nama paket yang sudah ada

Untuk mendaftarkan nama paket yang sudah ada, Anda harus membuktikan kepemilikan kunci penandatanganan pribadi yang diketahui. Tidak seperti pendaftaran baru, API menampilkan daftar sidik jari sertifikat publik yang diketahui dan memenuhi syarat untuk pendaftaran. Kunci ini dapat digunakan untuk pendaftaran langsung.

Jika kunci yang Anda daftarkan tercantum sebagai "memerlukan justifikasi", Anda masih dapat mendaftarkannya, tetapi selain menyelesaikan bukti kepemilikan, developer juga diwajibkan untuk mengirimkan justifikasi penggunaan nama paket tersebut.

Aturan kelayakan utama

Daftar kunci yang memenuhi syarat ditentukan oleh aturan kelayakan nama paket yang dirancang untuk meminimalkan berbagi nama paket (diperkenalkan sebagai bagian dari verifikasi developer Android).

Dalam skenario ketika nama paket digunakan oleh beberapa developer atau memiliki beberapa kunci penandatanganan, kelayakan ditentukan sebagai berikut:

Skenario	Aturan untuk pendaftaran langsung	Aturan untuk developer lain
Pemegang kunci mayoritas	Kunci yang menyumbang lebih dari 50% dari total penginstalan yang diketahui memiliki prioritas.	Semua developer lainnya harus memberikan alasan.
50+ penginstalan	Jika tidak ada satu kunci yang memiliki >50% penginstalan, semua kunci dengan 50 penginstalan atau lebih memenuhi syarat.	Developer dengan kunci yang memiliki kurang dari 50 penginstalan harus memberikan alasan.
Kurang dari 50 penginstalan	Jika tidak ada kunci yang memenuhi batas 50 penginstalan, kunci apa pun dapat digunakan berdasarkan prinsip siapa cepat dia dapat	Setelah satu developer mendaftar, developer lain harus memberikan alasan.

Memverifikasi kepemilikan kunci

Untuk menyelesaikan verifikasi nama paket yang sudah ada, API menyediakan string verifikasi. String verifikasi ini harus disertakan dalam file baru bernama adi-registration.properties di dalam folder aset aplikasi. Kemudian, Anda harus menandatangani dan mengupload APK menggunakan kunci pribadi yang sesuai dengan kunci publik yang Anda daftarkan.

Membenarkan pendaftaran kunci

Jika pendaftaran kunci memerlukan justifikasi, developer harus mengirimkan alasan bisnis yang mendetail. Google akan meninjau alasan ini, dan persetujuan untuk pendaftaran nama paket dapat memerlukan waktu hingga 24 jam.

Praktik terbaik pengalaman pengguna

Sebaiknya aplikasi yang menggunakan Android Developer Console API mengikuti pola ini untuk memastikan integrasi yang lancar.

Menetapkan konteks otorisasi OAuth yang jelas

Memberikan konteks eksplisit sebelum meminta otorisasi OAuth akan membantu developer memahami alasan akses akun diperlukan. Untuk memandu pengguna secara efektif, berikan penjelasan yang jelas tentang fungsi yang diharapkan sebelum meluncurkan layar izin OAuth.

Strukturkan konteks otorisasi menggunakan format berikut:

• Judul: "Tautkan akun Konsol Developer Android Anda"
• Ringkasan: "Kelola pendaftaran nama paket untuk verifikasi developer Android dalam [nama-aplikasi]"
• Tombol Tindakan: Tombol "Lanjutkan dengan Google" atau "Login dengan Google"

Mengidentifikasi akun developer

1. Lakukan integrasi dengan metode API ListDeveloperAccounts untuk mengambil dan mencantumkan semua akun developer yang aksesnya telah diizinkan.
2. Menyediakan pemilih akun untuk memungkinkan developer memilih akun developer yang diinginkan.
3. Tampilkan akun displayName dengan jelas, menggunakan nomor akun dari kolom name sebagai informasi sekunder.
4. Menampilkan status verifikasi akun (verificationState):
   • VERIFIED: Mengonfirmasi identitas developer terverifikasi dengan isyarat visual positif (misalnya, tanda centang hijau).
   • NOT_VERIFIED: Menunjukkan bahwa verifikasi belum selesai dan membatasi pendaftaran paket untuk akun. Secara opsional, berikan tombol CTA utama yang mengarahkan developer ke Konsol Developer Android setelah memilih akun.

Jika respons kosong diterima karena tidak ada akun developer yang dikaitkan dengan Akun Google, arahkan developer ke Konsol Developer Android menggunakan tombol CTA utama.

Mengelola nama paket

1. Lakukan integrasi dengan endpoint API ListAndroidPackages untuk mengambil semua nama paket yang terkait dengan akun developer. Menyediakan antarmuka terpusat, seperti daftar atau tabel, bagi developer untuk memantau status paket mereka secara efektif.
2. Tampilkan packageName bersama status pendaftarannya saat ini (DRAFT, IN_REVIEW, REGISTERED, atau PENDING_TRANSFER), dengan menerapkan indikator visual yang berbeda untuk setiap status. Jika "nama mudah diingat" diberikan dan disimpan selama pembuatan, Anda dapat menyertakannya secara opsional dalam tampilan.

Mengelola kunci

1. Panggil endpoint API ListAndroidPackageKeys untuk mengambil semua kunci yang terkait dengan nama paket, sehingga developer dapat memperoleh ringkasan terstruktur (seperti tabel atau daftar) untuk memantau status pendaftaran mereka.
2. Tampilkan certificateFingerprintSha256 untuk setiap kunci bersama dengan status pendaftarannya (DRAFT, OWNERSHIP_VERIFIED, IN_REVIEW, REGISTERED_ACTIVE, atau PENDING_TRANSFER), dengan menggunakan indikator visual yang berbeda untuk membedakan status.

1. Memungkinkan developer mendaftarkan kunci tambahan dengan nama paket yang sudah ada dengan mengintegrasikan metode API CreateAndroidPackageKey.

Mendaftarkan nama paket

1. Gunakan tata letak berbasis formulir tempat developer memasukkan nama paket mereka ke dalam kolom teks, asalkan informasi ini belum dikumpulkan oleh aplikasi Anda (misalnya, melalui perintah sebelumnya).
2. Panggil metode API CreateAndroidPackage untuk mendaftarkan nama paket di akun developer, dan panggil metode API GetAndroidPackageRegistrationPolicy untuk menentukan aturan kelayakan kunci yang berlaku.
3. Berdasarkan keySelectionStrategy yang ditetapkan untuk nama paket, minta developer untuk melakukan salah satu tindakan berikut:
   • Jika keySelectionStrategy disetel ke SELECT_KEY_FROM_LIST: Minta developer memilih kunci untuk pendaftaran dari daftar knownKeys yang diberikan (berisi sidik jari sertifikat SHA-256), seperti menggunakan tombol radio. Alur ini memerlukan verifikasi kepemilikan kunci (lihat Verifikasi kepemilikan kunci di bawah).
   • Jika keySelectionStrategy disetel ke USE_ANY_KEY: Minta developer untuk memberikan kunci secara langsung. Verifikasi kepemilikan kunci tidak diperlukan dalam kasus ini.
4. Panggil metode API CreateAndroidPackageKey untuk mengaitkan kunci yang dipilih dengan nama paket baru.

Atau, aplikasi Anda dapat otomatis mendeteksi dan mengekstrak nama paket atau kunci langsung dari aplikasi yang diupload.

Memverifikasi kepemilikan kunci

Jika keySelectionStrategy disetel ke SELECT_KEY_FROM_LIST, developer harus membuktikan kepemilikan kunci penandatanganan pribadi mereka. Bukti kepemilikan memerlukan pengiriman APK bertanda tangan yang menggabungkan verificationToken yang dihasilkan API.

Untuk mendukung verifikasi kepemilikan kunci, integrasikan metode API VerifyAndroidPackageKeyOwnership dan buat komponen antarmuka pengguna berikut:

• Komponen tampilan token: Menampilkan verificationToken secara jelas di dalam blok cuplikan kode, termasuk tombol "Salin ke Papan Klip" yang praktis.
• Petunjuk penyiapan developer: Berikan petunjuk mendetail yang mengarahkan developer untuk menempatkan file adi-registration.properties yang berisi verificationToken ke dalam folder aset aplikasi.
• Area pelepasan pengiriman APK: Menawarkan area pelepasan upload file khusus untuk menerima APK yang ditandatangani.

Memberikan alasan pendaftaran kunci

Jika kolom justificationRequired kunci yang diketahui ditetapkan ke REQUIRED, developer harus mengirimkan alasan bisnis yang komprehensif untuk mendaftarkan kunci tersebut bersama nama paket.

Kirimkan alasan ini dengan memanggil metode API JustifyAndroidPackageKeyRegistration. Pastikan antarmuka pengguna aplikasi Anda memiliki area input teks khusus untuk mengumpulkan alasan dari developer, dan memberi tahu mereka bahwa alasan harus diberikan sebelum mengirimkan permintaan pendaftaran kunci. Google akan meninjau alasan yang dikirimkan, sebuah proses yang dapat memerlukan waktu hingga 24 jam untuk disetujui sebelum pendaftaran nama paket selesai.

Mengotomatiskan verifikasi kunci untuk kunci terkelola

Jika aplikasi Anda mengelola kunci penandatanganan developer, developer tidak dapat menandatangani APK secara manual untuk verifikasi kepemilikan. Sebagai gantinya, Anda harus mengeksekusi panggilan API VerifyAndroidPackageKeyOwnership secara otomatis atas nama mereka.

Dengan menangani proses penyertaan token dan upload APK secara otomatis, aplikasi Anda menghilangkan langkah-langkah manual ini. Pastikan untuk memberi tahu developer bahwa verifikasi kepemilikan kunci dikelola dengan lancar oleh aplikasi Anda menggunakan kunci yang disimpan dalam sistem Anda.

Mengikuti pedoman merek

Untuk mempertahankan kepercayaan pengguna dan memastikan transparansi, semua aplikasi yang terintegrasi dengan Konsol Developer Android API diwajibkan untuk mematuhi pedoman merek berikut.

Terminologi dan kapitalisasi

Saat mereferensikan produk dalam materi atau dokumentasi yang ditampilkan kepada pengguna, selalu gunakan nama lengkap Konsol Developer Android. Jangan gunakan singkatan "ADC".

Program ini harus disebut sebagai verifikasi developer Android. Ikuti kapitalisasi dan ejaan yang sama persis ini dalam semua konteks.

Untuk mencegah ambiguitas dengan APK atau AAB, gunakan istilah "nama paket" secara khusus, bukan hanya "paket".

Saat menjelaskan proses penambahan nama paket, gunakan frasa "mendaftarkan nama paket" dan bukan "mengklaim nama paket".

Menggunakan pesan ajakan "Login"

Autentikasi OAuth 2.0 dengan Konsol Developer Android mengandalkan Google Identity Services. Agar tetap mematuhi panduan branding Layanan Identitas Google, Anda harus menggunakan pesan ajakan "Lanjutkan dengan Google" atau "Login dengan Google" pada tombol otorisasi. Teks ini wajib ada dan tidak dapat diubah, karena memastikan pengguna memahami bahwa mereka menggunakan kredensial Google mereka untuk mengizinkan aplikasi Anda mengakses Akun Google mereka.

Mempertahankan identitas dan integritas merek

Saat mengintegrasikan logo Konsol Developer Android ke antarmuka aplikasi, Anda harus mengikuti spesifikasi berikut untuk mempertahankan identitas visual dan integritas merek:

• Penempatan dan hierarki logo: Hanya gunakan logo Konsol Developer Android resmi yang disetujui. Logo harus selalu menjadi elemen sekunder dari elemen branding utama aplikasi Anda sendiri untuk menghindari kesalahan representasi aplikasi sebagai produk resmi Google.

• Gaya visual dan distorsi: Aset harus selalu dirender dengan rasio aspek yang sepenuhnya dibatasi. Anda tidak boleh mendistorsi, meregangkan, memiringkan, memangkas, membalikkan, atau mengubah komponen logo. Jangan mengubah palet warna resmi, menukar warna latar depan atau latar belakang, atau menerapkan drop shadow, efek cahaya, atau gradien dekoratif.
• Batasan penggunaan: Jangan memasukkan elemen branding milik Google ke dalam aset aplikasi Anda sendiri. Aset logo Konsol Developer Android hanya boleh digunakan dalam konteks tata letak aplikasi untuk menandakan integrasi aktif secara eksplisit.

Referensi lainnya

• Memeriksa status pendaftaran aplikasi dengan Android Developer ID Status API
• Mendaftar di Konsol Developer Android
• Mendaftar di Konsol Google Play
• Menandatangani aplikasi