API Android Developer Console

L'API Android Developer Console est un service RESTful qui permet aux développeurs validés d'automatiser les workflows de validation des développeurs Android dans l'Android Developer Console, y compris la récupération des comptes de développeur, la vérification des critères d'éligibilité des clés, l'enregistrement des noms de packages Android, l'enregistrement des clés de signature d'application et la validation de la propriété des clés.

Présentation, cas d'utilisation et contexte de mise en œuvre

Principaux cas d'utilisation et fonctionnalités

• Enregistrement automatisé des noms de packages CI/CD : enregistrez des dizaines ou des centaines de noms de packages Android de manière programmatique (CreateAndroidPackage).
• Inspection préalable de l'historique des règles de clé : vérifiez de manière programmatique si Google a déjà observé un nom de package dans l'écosystème et si l'enregistrement d'un certificat de signature spécifique nécessite la validation de la propriété de la clé (GetAndroidPackageRegistrationPolicy).
• Enregistrement automatisé de la clé de signature d'application et validation de la propriété : enregistrez les empreintes SHA-256 du certificat de signature public (CreateAndroidPackageKey), récupérez des jetons de vérification uniques (verificationToken) et automatisez la preuve de possession de la clé privée à l'aide d'importations d'APK signés à requête unique ou réutilisables (VerifyAndroidPackageKeyOwnership).
• Envoi de justifications par programmation : envoyez des justifications de propriété (JustifyAndroidPackageKeyRegistration).
• Surveillance de l'état : surveillez l'état de l'enregistrement sur les comptes de développeur, les noms de package et les clés de signature d'application (GetDeveloperAccount, ListDeveloperAccounts, GetAndroidPackage, ListAndroidPackages, GetAndroidPackageKey, ListAndroidPackageKeys).

Workflow d'implémentation de bout en bout

1. Valider l'identité du développeur une fois dans l'UI : validez l'identité du développeur (INDIVIDUAL ou ORGANIZATION) dans la Android Developer Console pour que verificationState soit VERIFIED.
2. Activez l'API et authentifiez-vous : activez androiddeveloperconsole.googleapis.com dans votre projet Google Cloud et obtenez un jeton d'accès Bearer OAuth 2.0 délégué par l'utilisateur avec le champ d'application https://www.googleapis.com/auth/androiddeveloperconsole.
3. Découvrez le nom de ressource de votre compte de développeur : appelez GET /v1/developerAccounts (ListDeveloperAccounts) pour récupérer developerAccounts/{developer_account} et vérifier que verificationState est VERIFIED.
4. Vérifier la règle d'enregistrement pour le nom du package : appelez GET /v1/developerAccounts/{id}/androidPackages/{pkg}/registrationPolicy (GetAndroidPackageRegistrationPolicy) pour inspecter keySelectionStrategy (SELECT_KEY_FROM_LIST ou USE_ANY_KEY) et toutes les clés de signature historiques connues (knownKeys).
5. Créer la ressource de package Android : appelez POST /v1/developerAccounts/{id}/androidPackages?androidPackageId={pkg} (CreateAndroidPackage) avec le corps {"name": ""} (crée la ressource à l'état DRAFT).
6. Enregistrez l'empreinte de votre clé de signature d'application : appelez POST /v1/developerAccounts/{id}/androidPackages/{pkg}/keys (CreateAndroidPackageKey) avec le corps JSON {"certificateFingerprintSha256": "..."}. Inspectez l'état renvoyé :
   • DRAFT : une preuve de propriété de la clé privée est requise, et la réponse inclut un verificationToken unique pour l'étape 7.
   • IN_REVIEW : la preuve de propriété et la justification sont ignorées automatiquement (par exemple, lors de l'enregistrement d'un nouveau nom de package qui n'a jamais été vu sur Android, ou lorsque vous avez déjà validé la propriété de cette clé de signature pour un autre nom de package dans le même DeveloperAccount). Ignorez l'étape 7 et l'appel de justification à l'étape 8, puis passez directement à l'interrogation de GetAndroidPackage et GetAndroidPackageKey.
7. Créer et importer l'APK de validation (si l'état est DRAFT) : intégrez la chaîne verificationToken renvoyée dans assets/adi-registration.properties dans un APK minimal correspondant à packageName, signez-le avec votre clé de signature d'application privée, puis importez-le à l'aide de POST /upload/v1/developerAccounts/{id}/androidPackages/{pkg}/keys/{sha256}:verify (VerifyAndroidPackageKeyOwnership).
8. Envoyer la justification (si nécessaire) et interroger l'état d'enregistrement : si la clé est à l'état OWNERSHIP_VERIFIED et que registrationJustificationRequired est défini sur true, appelez POST /v1/developerAccounts/{id}/androidPackages/{pkg}/keys/{sha256}:justifyAndroidPackageKeyRegistration (JustifyAndroidPackageKeyRegistration). Interrogez GetAndroidPackage et GetAndroidPackageKey jusqu'à ce que state atteigne REGISTERED.

Commandes CLI locales pour préparer les empreintes de clé et les APK de validation

• Extraire l'empreinte du certificat SHA-256 d'un keystore (keytool) :

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

• Vérifier le condensé du certificat de signature SHA-256 sur un APK compilé (apksigner) :

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

• Inspectez le nom du package APK et le fichier de jeton intégré avant l'importation (aapt2 et unzip) :

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

Fonctionnalités de l'UI et de l'API Android Developer Console

Configuration et authentification du service

Toutes les requêtes API doivent utiliser HTTPS et inclure un en-tête Authorization: Bearer ACCESS_TOKEN obtenu à l'aide du flux de serveur Web OAuth 2.0 pour un compte Google ayant validé l'identité du développeur dans la Android Developer Console.

Ressources et points de terminaison de l'API

L'API Android Developer Console organise les ressources selon la hiérarchie suivante :

• 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})

Ressource : DeveloperAccount

Représente un compte dans la Android Developer Console associé à une identité de développeur.

Énumération : DeveloperAccount.VerificationState

Méthodes : DeveloperAccount

Ressource : AndroidPackage

Représente un nom de package Android enregistré ou en cours d'enregistrement sous un DeveloperAccount.

Énumération : AndroidPackage.State

Ressource : AndroidPackageRegistrationPolicy

Ressource singleton renvoyée par GetAndroidPackageRegistrationPolicy qui décrit les clés de signature publiques historiques détectées pour un nom de package et indique si l'enregistrement du nom de package avec une clé de signature donnée nécessite une justification écrite.

Énumération : KnownKey.JustificationRequirement

Énumération : AndroidPackageRegistrationPolicy.KeySelectionStrategy

Méthodes : AndroidPackage

Ressource : AndroidPackageKey

Représente l'empreinte d'un certificat public de signature d'application associé à un AndroidPackage et suit l'état de la validation de la propriété et de l'examen de l'enregistrement.

Énumération : AndroidPackageKey.State

Méthodes : AndroidPackageKey

Gestion des exceptions

Lorsqu'une requête API échoue, l'API Android Developer Console renvoie un code d'état HTTP 4xx ou 5xx et un corps d'erreur JSON google.rpc.Status standard :

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

Codes d'état HTTP et solutions courantes

Exemples de requêtes et de réponses HTTP

Remplacez les valeurs d'espace réservé telles que ACCESS_TOKEN, 1234567890, com.example.myapp et 60e860e8... par vos propres valeurs.

1. GetDeveloperAccount

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

Réponse :

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

2. ListDeveloperAccounts

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

Réponse :

{
  "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"

Réponse :

{
  "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"

Réponse :

{
  "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"

Réponse :

{
  "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"

Réponse :

{
  "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"

Réponse :

{
  "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"

Réponse :

{
  "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"

Réponse :

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

10. VerifyAndroidPackageKeyOwnership

Option A : Importation de contenus multimédias via une requête unique

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"

Option B : Protocole d'importation avec reprise (recommandé pour les fichiers APK volumineux ou l'intégration/le déploiement continus)

Étape 1 : Démarrez la session d'importation avec reprise et extrayez l'en-tête X-Goog-Upload-URL renvoyé :

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"
  }'

Étape 2 : Importez le binaire APK signé dans UPLOAD_SESSION_URI et finalisez la session :

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"

Réponse :

{
  "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"

Réponse :

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

Ressources supplémentaires

• Enregistrer des noms de packages avec l'API Android Developer Console
• Vérifier l'état d'enregistrement d'une application avec l'API Android Developer ID Status
• S'enregistrer sur Android Developer Console
• S'inscrire sur la Google Play Console