Paketnamen mit der Android Developer Console API registrieren

Die Android Developer Console API ist eine öffentliche Schnittstelle, mit der App-Vertreiber und einzelne Entwickler Paketnamen programmatisch in der Android Developer Console registrieren können.

Ihre Server-zu-Server-Funktionen als:

App-Vertreiber	Einzelner Entwickler
Paketnamen-Schlüssel im Namen des Entwicklers registrieren, der eine App im Store veröffentlicht Paketnamen mit einem vom Store verwalteten Schlüssel registrieren Eigentümerschaft eines Schlüssels nachweisen, der mit einem Paketnamen verknüpft ist	Paketnamen-Schlüssel in Ihren Workflows für die kontinuierliche Bereitstellung registrieren Eigentümerschaft eines Schlüssels nachweisen, der mit einem Paketnamen verknüpft ist

Hinweis

Bevor Sie beginnen, sollten Sie Folgendes haben:

1. Administratorzugriff auf ein Google Cloud-Projekt
2. Grundkenntnisse in folgenden Bereichen:
   • RESTful APIs
   • APK-Struktur
   • Android-App-Signierung
   • SHA-256-Digests generieren

Sie sollten auch mit den folgenden Begriffen vertraut sein:

Begriff	Definition
Entwicklerkonto	Stellt ein Android Developer Console-Konto dar, das Inhaber eines oder mehrerer Paketnamen sein kann. Es enthält einen Bestätigungsstatus (NOT_VERIFIED oder VERIFIED).
Paketname	Ein bestimmter Android-Paketname (z. B. com.example.app) in einem Entwicklerkonto, der mit einem oder mehreren Schlüsseln verknüpft sein kann. Er enthält einen Registrierungsstatus (DRAFT, IN_REVIEW, REGISTERED oder PENDING_TRANSFER).
Schlüssel	Das spezifische öffentliche Zertifikat/der spezifische Schlüssel, das/der zum Signieren eines Android-Paketnamens verwendet wird. Enthält den SHA-256-Hash und den aktuellen Registrierungsstatus (DRAFT, OWNERSHIP_VERIFIED, IN_REVIEW, REGISTERED oder PENDING_TRANSFER).

Jetzt starten

Führen Sie die folgenden Schritte aus, um auf die Android Developer Console API zuzugreifen:

Google Cloud-Projekt erstellen

1. Erstellen Sie ein Google Cloud-Konto, falls Sie noch keines haben.
2. Öffnen Sie die Google Cloud Console.
3. Erstellen Sie ein Google Cloud-Projekt.

API in Ihrem Google Cloud-Projekt aktivieren

1. Öffnen Sie die Google Cloud Console.
2. Wählen Sie im Navigationsmenü (☰) APIs und Dienste > Bibliothek aus.
3. Wählen Sie im Drop-down-Menü „Projekt“ das Google Cloud-Projekt aus, in dem Sie die API aktivieren möchten.
4. Wählen Sie in der Suchleiste APIs und Dienste die Option Android Developer Console API aus.
5. Aktivieren Sie die API:
   1. Wählen Sie die API in den Suchergebnissen aus, um die Übersichtsseite der API aufzurufen.
   2. Klicken Sie auf die blaue Schaltfläche „Aktivieren“. Google Cloud aktiviert die API für das ausgewählte Projekt. Das dauert in der Regel nur einen Moment. Sobald die API aktiviert ist, können Sie sie verwenden.

API authentifizieren

Wenn Sie Aufrufe an die Android Developer Console API senden möchten, müssen Sie Ihre Anfragen mit OAuth 2.0 authentifizieren.

Authentifizieren mit OAuth 2.0

Die Android Developer Console API erfordert die OAuth 2.0-Authentifizierung, um den Zugriff auf Entwicklerkontoressourcen und Paketnamen zu autorisieren. Da Entwicklerkontodaten mit dem Google-Konto eines Nutzers und nicht mit einem Google Cloud-Projekt verknüpft sind, können Dienstkonten, die Workload Identity Federation und API-Schlüssel nicht zur Authentifizierung von API-Anfragen verwendet werden.

OAuth 2.0-Bereich

Der folgende Bereich ist für alle Vorgänge erforderlich:

OAuth 2.0-Bereich	Beschreibung
https://www.googleapis.com/auth/androiddeveloperconsole	Paketnamen und Daten in Ihren Android Developer Console-Konten ansehen und verwalten

OAuth 2.0-Webserverablauf implementieren

Für die Integration mit der Android Developer Console API müssen Anwendungen den OAuth 2.0-Webserverablauf verwenden. Je nach Anwendungstyp und Automatisierungsanforderungen können Sie zwischen zwei Hauptstrategien für die Anmeldedatenverwaltung wählen:

Option A (empfohlen): Offline-/automatisierter Zugriff (CI/CD- und Serverintegration)

Option B: Sitzungsspezifischer / interaktiver Zugriff

Mit dieser Strategie können automatisierte Prozesse (z. B. CI/CD-Pipelines) im Hintergrund ohne menschliches Eingreifen ausgeführt werden: Einmalige Einrichtung der Nutzereinwilligung: Bei der ersten Einrichtung führt ein Entwickler oder Kontoinhaber einmalig den Einwilligungsablauf in seinem Browser aus. Ihre Anwendung fordert Offlinezugriff (access_type=offline) zusammen mit dem API-Bereich an. Google gibt einen Autorisierungscode zurück, den Ihre Anwendung gegen ein anfängliches Zugriffstoken und ein langlebiges Aktualisierungstoken austauscht. Hintergrundausführung:Speichern Sie das refresh_token sicher in Ihrer Bereitstellungsumgebung oder im Secret Manager (z. B. GitHub Actions Secrets, Google Secret Manager). Bei nachfolgenden API-Aufrufen verwendet Ihr automatisierter Workflow das gespeicherte Aktualisierungstoken, um bei Bedarf ein neues kurzlebiges Zugriffstoken abzurufen. Manuelle Anmeldungen oder 2FA-Aufforderungen werden dabei umgangen.

Wenn Sie langlebige Aktualisierungstokens nicht in Ihrer Umgebung speichern möchten oder wenn Ihre Anwendung in einem interaktiven Nutzerkontext ausgeführt wird: Aufforderung bei der Ausführung: Fordern Sie keinen Offlinezugriff an und speichern Sie kein Aktualisierungstoken. Jedes Mal, wenn das Tool oder die Anwendung ausgeführt wird, fordern Sie den Nutzer auf, sich zu authentifizieren, indem Sie ihn in seinem Browser zur Google OAuth-Zustimmungsseite weiterleiten. Kurzlebiger Zugriff:Der Nutzer meldet sich an und gibt seine Einwilligung. Die Anwendung erhält direkt ein kurzlebiges Zugriffstoken (oder über den Austausch des Autorisierungscodes). Dieses Zugriffstoken wird für API-Aufrufe verwendet und nach der Ausführung verworfen. Bei zukünftigen Ausführungen muss sich der Nutzer erneut authentifizieren.

Paketnamen registrieren

Bei der Paketnamensregistrierung wird ein Schlüssel mit einem Paketnamen verknüpft. Wie ein Schlüssel registriert wird, hängt davon ab, ob Sie einen Schlüssel für einen neuen oder vorhandenen Paketnamen in Android registrieren.

Neuen Paketnamen registrieren

Für einen neuen Paketnamen, der noch nie auf Android verwendet wurde, können Sie das Public-Key-Zertifikat aus dem Signaturschlüsselpaar der App angeben.

Vorhandenen Paketnamen registrieren

Wenn Sie einen vorhandenen Paketnamen registrieren möchten, müssen Sie die Eigentümerschaft eines bekannten privaten Signaturschlüssels nachweisen. Im Gegensatz zur Neuregistrierung gibt die API eine Liste bekannter öffentlicher Zertifikat-Fingerabdrücke zurück, die für die Registrierung infrage kommen. Diese Schlüssel können für die direkte Registrierung verwendet werden.

Wenn der Schlüssel, den Sie registrieren, als „Begründung erforderlich“ aufgeführt ist, können Sie ihn trotzdem registrieren. Zusätzlich zum Nachweis der Eigentümerschaft muss der Entwickler jedoch auch eine Begründung für die Verwendung des Paketnamens einreichen.

Regeln für die Berechtigung von Schlüsseln

Die Liste der berechtigten Schlüssel wird durch die Berechtigungsregeln für Paketnamen bestimmt, die darauf ausgelegt sind, die gemeinsame Nutzung von Paketnamen zu minimieren (eingeführt im Rahmen der Bestätigung für Android-Entwickler).

Für Szenarien, bei denen ein Paketname von mehreren Entwicklern verwendet wird oder mehrere Signaturschlüssel hat, wird die Berechtigung so ermittelt:

Szenario	Regel für die direkte Registrierung	Regel für andere Entwickler
Schlüssel mit Mehrheit	Der Schlüssel, zu dem über 50% der bekannten Gesamtinstallationen gehören, hat Priorität.	Alle anderen Entwickler müssen eine Begründung einreichen.
Mehr als 50 Installationen	Wenn zu keinem einzelnen Schlüssel über 50% der Installationen gehören, kommen alle Schlüssel mit mindestens 50 Installationen infrage.	Entwickler mit Schlüsseln, zu denen weniger als 50 Installationen gehören, müssen eine Begründung einreichen.
Weniger als 50 Installationen	Wenn kein Schlüssel die Mindestanzahl von 50 Installationen erreicht, kann jeder Schlüssel nach dem Windhundprinzip verwendet werden.	Sobald sich eine Entwicklerin oder ein Entwickler registriert hat, müssen andere eine Begründung einreichen.

Schlüsselinhaberschaft bestätigen

Wenn Sie die Bestätigung für einen vorhandenen Paketnamen abschließen möchten, stellt die API einen Bestätigungsstring bereit. Dieser Bestätigungsstring muss in eine neue Datei mit dem Namen adi-registration.properties im Assets-Ordner der App eingefügt werden. Anschließend müssen Sie das APK mit dem privaten Schlüssel signieren und hochladen, der dem öffentlichen Schlüssel entspricht, den Sie registrieren.

Schlüsselregistrierung begründen

Wenn für eine Schlüsselregistrierung eine Begründung erforderlich ist, müssen Entwickler eine detaillierte geschäftliche Begründung einreichen. Google prüft diese Begründung. Die Genehmigung für die Paketnamensregistrierung kann bis zu 24 Stunden dauern.

Best Practices für die Nutzererfahrung

Anwendungen, die die Android Developer Console API verwenden, sollten diese Muster befolgen, um eine nahtlose Integration zu gewährleisten.

Eindeutigen OAuth-Autorisierungskontext festlegen

Wenn Sie expliziten Kontext angeben, bevor Sie die OAuth-Autorisierung anfordern, können Entwickler besser nachvollziehen, warum der Kontozugriff erforderlich ist. Um Nutzer effektiv zu unterstützen, sollten Sie eine klare Erklärung der erwarteten Funktionen präsentieren, bevor Sie den OAuth-Zustimmungsbildschirm starten.

Strukturieren Sie den Autorisierungskontext im folgenden Format:

• Titel : „Android Developer Console-Konto verknüpfen“
• Zusammenfassung : „Paketnamensregistrierung für die Bestätigung für Android-Entwickler in [Anwendungsname] verwalten“
• Aktionsschaltfläche:Schaltfläche „Mit Google fortfahren“ oder „Über Google anmelden“

Entwicklerkonten identifizieren

1. Integrieren Sie die ListDeveloperAccounts API-Methode, um alle Entwicklerkonten abzurufen und aufzulisten, für die der Zugriff autorisiert wurde.
2. Stellen Sie eine Kontoauswahl zur Verfügung, damit der Entwickler sein bevorzugtes Entwicklerkonto auswählen kann.
3. Heben Sie den displayName des Kontos hervor und verwenden Sie die Kontonummer aus dem Feld name als sekundäre Information.
4. Zeigen Sie die Kontobestätigungsstatus (verificationState) an:
   • VERIFIED: Bestätigen Sie die bestätigte Entwickleridentität mit einem positiven visuellen Hinweis (z.B. einem grünen Häkchen).
   • NOT_VERIFIED: Geben Sie an, dass die Bestätigung nicht abgeschlossen ist, und beschränken Sie die Paketregistrierung für das Konto. Optional können Sie eine primäre CTA-Schaltfläche bereitstellen, die Entwickler nach der Auswahl des Kontos zur Android Developer Console weiterleitet.

Wenn eine leere Antwort empfangen wird, weil keine Entwicklerkonten mit dem Google-Konto verknüpft sind, leiten Sie Entwickler über eine primäre CTA-Schaltfläche zur Android Developer Console weiter.

Paketnamen verwalten

1. Integrieren Sie den ListAndroidPackages API-Endpunkt, um alle Paketnamen abzurufen, die mit dem Entwicklerkonto verknüpft sind. Stellen Sie Entwicklern eine zentrale Benutzeroberfläche zur Verfügung, z. B. eine Liste oder Tabelle, um den Paketstatus effektiv zu überwachen.
2. Zeigen Sie den packageName zusammen mit dem aktuellen Registrierungsstatus (DRAFT, IN_REVIEW, REGISTERED oder PENDING_TRANSFER) an und verwenden Sie für jeden Status unterschiedliche visuelle Hinweise. Wenn bei der Erstellung ein „freundlicher Name“ angegeben und gespeichert wurde, können Sie ihn optional in der Anzeige verwenden.

Schlüssel verwalten

1. Rufen Sie den ListAndroidPackageKeys API-Endpunkt auf, um alle Schlüssel abzurufen, die mit einem Paketnamen verknüpft sind. So erhalten Entwickler eine strukturierte Übersicht (z. B. eine Tabelle oder Liste), um den Registrierungsstatus zu überwachen.
2. Präsentieren Sie den certificateFingerprintSha256 für jeden Schlüssel zusammen mit dem Registrierungsstatus (DRAFT, OWNERSHIP_VERIFIED, IN_REVIEW, REGISTERED_ACTIVE oder PENDING_TRANSFER) und verwenden Sie unterschiedliche visuelle Hinweise, um zwischen den Status zu unterscheiden.

1. Ermöglichen Sie Entwicklern, zusätzliche Schlüssel unter einem vorhandenen Paketnamen zu registrieren, indem Sie die CreateAndroidPackageKey API-Methode einbinden.

Paketnamen registrieren

1. Verwenden Sie ein formularbasiertes Layout, in dem Entwickler ihren Paketnamen in ein Textfeld eingeben. Dies ist jedoch nur erforderlich, wenn diese Informationen nicht bereits von Ihrer Anwendung erfasst wurden (z. B. durch eine frühere Aufforderung).
2. Rufen Sie die CreateAndroidPackage API-Methode auf, um einen Paketnamen unter dem Entwicklerkonto zu registrieren, und rufen Sie die GetAndroidPackageRegistrationPolicy API Methode auf, um die geltenden Regeln für die Berechtigung von Schlüsseln zu ermitteln.
3. Fordern Sie den Entwickler basierend auf der festgelegten keySelectionStrategy für den Paketnamen auf, einen der folgenden Schritte auszuführen:
   • Wenn keySelectionStrategy auf SELECT_KEY_FROM_LIST festgelegt ist, muss der Entwickler einen Schlüssel für die Registrierung aus der bereitgestellten knownKeys-Liste (mit SHA-256-Zertifikat-Fingerabdrücken) auswählen, z. B. mithilfe von Optionsfeldern. Für diesen Ablauf ist eine Bestätigung der Schlüsselinhaberschaft erforderlich (siehe unten unter Inhaberschaft eines Schlüssels bestätigen).
   • Wenn keySelectionStrategy auf USE_ANY_KEY festgelegt ist, fordern Sie den Entwickler auf, direkt einen Schlüssel anzugeben. In diesem Fall ist keine Bestätigung der Schlüsselinhaberschaft erforderlich.
4. Rufen Sie die CreateAndroidPackageKey API-Methode auf, um den ausgewählten Schlüssel mit dem neuen Paketnamen zu verknüpfen.

Alternativ kann Ihre Anwendung den Paketnamen oder Schlüssel automatisch direkt aus einer hochgeladenen App erkennen und extrahieren.

Inhaberschaft eines Schlüssels bestätigen

Wenn keySelectionStrategy auf SELECT_KEY_FROM_LIST festgelegt ist, müssen Entwickler die Inhaberschaft ihres privaten Signaturschlüssels nachweisen. Für den Nachweis der Inhaberschaft muss ein signiertes APK eingereicht werden, das das von der API generierte verificationToken enthält.

Um die Bestätigung der Schlüsselinhaberschaft zu unterstützen, binden Sie die VerifyAndroidPackageKeyOwnership API-Methode ein und erstellen Sie die folgenden Benutzeroberflächenkomponenten:

• Komponente zur Tokenanzeige:Zeigen Sie das verificationToken gut sichtbar in einem Code-Snippet-Block an, einschließlich einer praktischen Schaltfläche „In die Zwischenablage kopieren“.
• Einrichtungsanleitung für Entwickler:Geben Sie eine detaillierte Anleitung, in der der Entwickler aufgefordert wird, eine adi-registration.properties-Datei mit dem verificationToken im Assets-Ordner der App zu platzieren.
• Dropzone für die APK-Einreichung:Bieten Sie eine spezielle Dropzone für den Dateiupload an, um das signierte APK zu empfangen.

Registrierung eines Schlüssels begründen

Wenn für einen bekannten Schlüssel das Feld justificationRequired auf REQUIRED festgelegt ist, müssen Entwickler eine detaillierte geschäftliche Begründung einreichen, um diesen Schlüssel zusammen mit dem Paketnamen zu registrieren.

Reichen Sie diese Begründung ein, indem Sie die JustifyAndroidPackageKeyRegistration API-Methode aufrufen. Achten Sie darauf, dass die Benutzeroberfläche Ihrer Anwendung einen speziellen Bereich für die Texteingabe enthält, um die Begründung vom Entwickler zu erfassen. Informieren Sie ihn außerdem darüber, dass eine Begründung erforderlich ist, bevor die Schlüsselregistrierungsanfrage eingereicht werden kann. Google prüft die eingereichte Begründung. Die Genehmigung kann bis zu 24 Stunden dauern, bevor die Paketnamensregistrierung abgeschlossen ist.

Schlüsselbestätigung für verwaltete Schlüssel automatisieren

Wenn Ihre Anwendung den Signaturschlüssel eines Entwicklers verwaltet, kann der Entwickler kein APK manuell zur Bestätigung der Inhaberschaft signieren. Stattdessen müssen Sie den VerifyAndroidPackageKeyOwnership API-Aufruf automatisch in seinem Namen ausführen.

Indem Sie die Tokeneinbindung und den APK-Upload automatisch verarbeiten, werden diese manuellen Schritte von Ihrer Anwendung entfernt. Informieren Sie Entwickler darüber, dass die Bestätigung der Schlüsselinhaberschaft nahtlos von Ihrer Anwendung mit dem in Ihrem System gespeicherten Schlüssel verwaltet wird.

Markenrichtlinien einhalten

Um das Vertrauen der Nutzer zu wahren und für Transparenz zu sorgen, müssen alle Anwendungen, die in die Android Developer Console API eingebunden sind, die folgenden Markenrichtlinien einhalten.

Terminologie und Großschreibung

Wenn Sie in nutzerorientierten Materialien oder in der Dokumentation auf das Produkt verweisen, verwenden Sie immer den vollständigen Namen „Android Developer Console“. Verwenden Sie nicht die Abkürzung „ADC“.

Das Programm muss als „Bestätigung für Android-Entwickler“ bezeichnet werden. Achten Sie in allen Kontexten auf die genaue Großschreibung und Schreibweise.

Um Unklarheiten mit APKs oder AABs zu vermeiden, verwenden Sie den Begriff „Paketname“ anstelle von „Paket“.

Wenn Sie den Vorgang zum Hinzufügen eines Paketnamens beschreiben, verwenden Sie den Ausdruck „Paketnamen registrieren“ anstelle von „Paketnamen beanspruchen“.

Call-to-Action „Anmelden“ verwenden

Die OAuth 2.0-Authentifizierung mit der Android Developer Console basiert auf Google Identity Services. Um die Markenrichtlinien von Google Identity Services einzuhalten, müssen Sie auf der Autorisierungsschaltfläche den Call-to-Action „Mit Google fortfahren“ oder „Über Google anmelden“ verwenden. Dieser Text ist obligatorisch und kann nicht geändert werden, da er dafür sorgt, dass Nutzer verstehen, dass sie ihre Google-Anmeldedaten verwenden, um Ihrer Anwendung den Zugriff auf ihr Google-Konto zu autorisieren.

Markenidentität und -integrität wahren

Wenn Sie das Android Developer Console-Logo in die Benutzeroberfläche Ihrer Anwendung einbinden, müssen Sie diese Spezifikationen einhalten, um die visuelle Identität und Markenintegrität zu wahren:

• Logoplatzierung und -hierarchie:Verwenden Sie nur das offizielle, genehmigte Android Developer Console-Logo. Das Logo muss immer sekundär zu den primären Branding-Elementen Ihrer eigenen Anwendung sein, um zu vermeiden, dass die Anwendung als offizielles Google-Produkt dargestellt wird.

• Visueller Stil und Verzerrungen:Das Asset muss immer mit vollständig eingeschränktem Seitenverhältnis gerendert werden. Sie dürfen die Komponenten des Logos niemals verzerren, dehnen, verzerren, zuschneiden, spiegeln oder ändern. Ändern Sie nicht die offizielle Farbpalette, tauschen Sie nicht die Vorder- oder Hintergrundfarben aus und wenden Sie keine Schlagschatten, Glüheffekte oder dekorative Farbverläufe an.
• Nutzungsbeschränkungen:Binden Sie keine Branding-Elemente von Google in Ihre eigenen Anwendungsassets ein. Das Android Developer Console-Logo darf nur im Layoutkontext der Anwendung verwendet werden, um eine aktive Integration explizit zu kennzeichnen.

Zusätzliche Ressourcen

• App-Registrierungsstatus mit der Android Developer ID Status API prüfen
• In der Android Developer Console registrieren
• In der Google Play Console registrieren
• App signieren