Android Developer Console API

Android Developer Console API – это RESTful-сервис, который позволяет подтвержденным разработчикам автоматизировать рабочие процессы, связанные с проверкой разработчиков Android, в Android Developer Console. В частности, с помощью этого API можно получать информацию об аккаунтах разработчиков, проверять соответствие ключевым требованиям, регистрировать названия пакетов Android и ключи подписи приложений, а также подтверждать право собственности на ключи.

Обзор, примеры использования и контекст реализации

Основные примеры использования и функции

• Автоматическая регистрация названий пакетов CI/CD. Вы можете программно зарегистрировать десятки или сотни названий пакетов Android (CreateAndroidPackage).
• Предварительная проверка ключей. Программная проверка того, встречалось ли название пакета в экосистеме Google и требуется ли подтверждение права собственности на ключ для регистрации определенного сертификата подписи (GetAndroidPackageRegistrationPolicy).
• Автоматическая регистрация ключа подписи приложения и подтверждение права собственности. Регистрируйте цифровые отпечатки SHA-256 общедоступных сертификатов подписи (CreateAndroidPackageKey), получайте уникальные токены подтверждения (verificationToken) и автоматически подтверждайте владение закрытым ключом, загружая подписанные APK-файлы с помощью одного запроса или возобновляемой загрузки (VerifyAndroidPackageKeyOwnership).
• Автоматическая отправка обоснований. Отправьте обоснования права собственности (JustifyAndroidPackageKeyRegistration).
• Отслеживание статуса. Отслеживайте статус регистрации в аккаунтах разработчиков, названиях пакетов и ключах подписи приложений (GetDeveloperAccount, ListDeveloperAccounts, GetAndroidPackage, ListAndroidPackages, GetAndroidPackageKey, ListAndroidPackageKeys).

Полный рабочий процесс реализации

1. Подтвердите личность разработчика в интерфейсе. Подтвердите личность разработчика (INDIVIDUAL или ORGANIZATION) в Android Developer Console, чтобы значение verificationState изменилось на VERIFIED.
2. Включите API и выполните аутентификацию. Включите androiddeveloperconsole.googleapis.com в облачном проекте Google Cloud и получите токен доступа Bearer OAuth 2.0, делегированный пользователем, с областью действия https://www.googleapis.com/auth/androiddeveloperconsole.
3. Узнайте название ресурса аккаунта разработчика. Вызовите GET /v1/developerAccounts (ListDeveloperAccounts), чтобы получить developerAccounts/{developer_account} и убедиться, что verificationState – это VERIFIED.
4. Проверьте правила регистрации для названия пакета. Вызовите GET /v1/developerAccounts/{id}/androidPackages/{pkg}/registrationPolicy (GetAndroidPackageRegistrationPolicy), чтобы проверить keySelectionStrategy (SELECT_KEY_FROM_LIST или USE_ANY_KEY) и все известные ключи подписи (knownKeys).
5. Создайте ресурс пакета Android. Вызовите POST /v1/developerAccounts/{id}/androidPackages?androidPackageId={pkg} (CreateAndroidPackage) с телом {"name": ""} (создает ресурс в состоянии DRAFT).
6. Зарегистрируйте цифровой отпечаток ключа подписи приложения. Вызовите POST /v1/developerAccounts/{id}/androidPackages/{pkg}/keys (CreateAndroidPackageKey) с телом JSON {"certificateFingerprintSha256": "..."}. Проверьте возвращенное состояние:
   • DRAFT – требуется подтверждение права собственности на закрытый ключ. Ответ включает уникальный параметр verificationToken для шага 7.
   • IN_REVIEW – подтверждение права собственности и обоснование пропускаются автоматически (например, при регистрации нового названия пакета, которое никогда не использовалось в Android, или если вы уже подтвердили право собственности на этот ключ подписи для другого названия пакета в том же DeveloperAccount). Пропустите шаг 7 и вызов обоснования на шаге 8 и перейдите непосредственно к опросу GetAndroidPackage и GetAndroidPackageKey.
7. Создайте и загрузите APK-файл для подтверждения (если статус – DRAFT). Встройте возвращенную строку verificationToken в assets/adi-registration.properties в минимальном APK-файле, соответствующем packageName, подпишите его закрытым ключом подписи приложения и загрузите с помощью POST /upload/v1/developerAccounts/{id}/androidPackages/{pkg}/keys/{sha256}:verify (VerifyAndroidPackageKeyOwnership).
8. Отправьте обоснование (если требуется) и проверьте статус регистрации. Если ключ находится в состоянии OWNERSHIP_VERIFIED, а registrationJustificationRequired имеет значение true, вызовите POST /v1/developerAccounts/{id}/androidPackages/{pkg}/keys/{sha256}:justifyAndroidPackageKeyRegistration (JustifyAndroidPackageKeyRegistration). Проверяйте GetAndroidPackage и GetAndroidPackageKey, пока state не достигнет REGISTERED.

Локальные команды CLI для подготовки цифровых отпечатков ключей и APK для проверки

• Извлеките цифровой отпечаток сертификата SHA-256 из хранилища ключей (keytool):

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

• Проверьте дайджест сертификата подписи SHA-256 в созданном APK-файле (apksigner):

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

• Проверьте название пакета APK и встроенный файл токена перед загрузкой (aapt2 и unzip):

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

Возможности интерфейса и API Android Developer Console

Настройка сервиса и аутентификация

Все запросы к API должны использовать HTTPS и включать заголовок Authorization: Bearer ACCESS_TOKEN, полученный с помощью OAuth 2.0 Web Server flow для аккаунта Google, который прошел подтверждение личности разработчика в Android Developer Console.

Ресурсы и конечные точки API

В Android Developer Console API ресурсы организованы в следующую иерархию:

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

Ресурс: DeveloperAccount

Представляет аккаунт в Android Developer Console, связанный с идентификационными данными разработчика.

Enum: DeveloperAccount.VerificationState

Методы: DeveloperAccount

Ресурс: AndroidPackage

Представляет название пакета Android, зарегистрированное или регистрируемое в DeveloperAccount.

Перечисление: AndroidPackage.State

Ресурс: AndroidPackageRegistrationPolicy

Ресурс-одиночка, возвращаемый методом GetAndroidPackageRegistrationPolicy. Он описывает обнаруженные ранее открытые ключи подписи для названия пакета и указывает, требуется ли письменное обоснование для регистрации названия пакета с определенным ключом подписи.

Enum: KnownKey.JustificationRequirement

Enum: AndroidPackageRegistrationPolicy.KeySelectionStrategy

Методы: AndroidPackage

Ресурс: AndroidPackageKey

Представляет цифровой отпечаток сертификата подписи приложения, связанный с AndroidPackage, и отслеживает статус подтверждения права собственности и проверки регистрации.

Перечисление: AndroidPackageKey.State

Методы: AndroidPackageKey

Обработка ошибок

Если запрос к API не удается выполнить, Android Developer Console API возвращает код статуса HTTP 4xx или 5xx и стандартный текст ошибки JSON google.rpc.Status:

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

Коды статуса HTTP и способы устранения неполадок

Примеры HTTP-запросов и ответов

Замените значения-плейсхолдеры, такие как ACCESS_TOKEN, 1234567890, com.example.myapp и 60e860e8..., собственными значениями.

1. GetDeveloperAccount

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

Ответ.

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

2. ListDeveloperAccounts

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

Ответ.

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

Ответ.

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

Ответ.

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

Ответ.

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

Ответ.

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

Ответ.

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

Ответ.

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

Ответ.

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

10. VerifyAndroidPackageKeyOwnership

Вариант А. Загрузка медиафайлов с помощью одного запроса

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"

Вариант Б. Протокол возобновляемой загрузки (рекомендуется для больших APK-файлов или CI/CD)

Шаг 1. Начните сеанс возобновляемой загрузки и извлеките возвращенный заголовок X-Goog-Upload-URL.

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

Шаг 2. Загрузите подписанный двоичный APK-файл в UPLOAD_SESSION_URI и завершите сеанс.

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"

Ответ.

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

Ответ.

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

Дополнительные ресурсы

• Как регистрировать названия пакетов с помощью Android Developer Console API
• Как проверить статус регистрации приложения с помощью Android Developer ID Status API
• Как зарегистрироваться в Android Developer Console
• Регистрация в Google Play Console