Registrierung und API-Schlüssel

Wenn Sie die Google Awareness API verwenden möchten, müssen Sie Ihrer App einen Google API-Schlüssel hinzufügen. Der benötigte API-Schlüssel ist ein Android-API-Schlüssel.

Alle Android-Apps sind mit einem digitalen Zertifikat signiert, für das Sie den privaten Schlüssel besitzen. Weitere Informationen zu digitalen Zertifikaten finden Sie im Android-Leitfaden zum Signieren von Apps.

Android-API-Schlüssel sind mit bestimmten Zertifikat-Paket-Paaren verknüpft. Sie benötigen nur einen Schlüssel pro Zertifikat, unabhängig davon, wie viele Nutzer die App haben.

Es sind mehrere Schritte erforderlich, um einen Schlüssel für Ihre App zu erhalten. Sie werden in diesem Leitfaden ausführlich beschrieben und sind wie folgt zusammengefasst:

  1. Informationen zum Zertifikat Ihrer App abrufen
  2. Ein Projekt in der Google Developers Console registrieren und die User Context API als Dienst für das Projekt hinzufügen
  3. Einen Schlüssel anfordern
  4. Den Schlüssel Ihrer App hinzufügen. Fügen Sie dazu dem App-Manifest ein Element hinzu.

Zertifikatsinformationen für Ihre App finden

Der API-Schlüssel basiert auf einer Kurzform des digitalen Zertifikats Ihrer App, auch bekannt als SHA-1-Fingerabdruck. Wenn Sie den SHA-1 Fingerabdruck für Ihr Zertifikat aufrufen möchten, müssen Sie zuerst sicherstellen, dass Sie das richtige Zertifikat verwenden. Sie haben möglicherweise die folgenden beiden Zertifikate zur Auswahl:

  • Debug-Zertifikat: Die Android SDK-Tools generieren dieses Zertifikat automatisch, wenn Sie ein Debug-Build ausführen. Verwenden Sie dieses Zertifikat nur bei Apps, die Sie testen. Veröffentlichen Sie keine Apps, die mit einem Debug-Zertifikat signiert sind. Das Debug-Zertifikat wird im Abschnitt zum Signieren von Debug-Builds in der Android-Entwicklerdokumentation näher beschrieben.
  • Freigabezertifikat: Die Android SDK-Tools generieren dieses Zertifikat automatisch, wenn Sie ein Release-Build ausführen. Sie können dieses Zertifikat auch mit dem keytool Programm generieren. Verwenden Sie dieses Zertifikat, wenn Sie Ihre App veröffentlichen möchten.

Weitere Informationen zu keytool finden Sie in der Oracle-Dokumentation.

Debug-Zertifikat

Zertifikat-Fingerabdruck des Debug-Zertifikats anzeigen

Verwenden Sie das keytool Programm mit dem -v Parameter, um den SHA-1-Fingerabdruck eines Zertifikats aufzurufen. Führen Sie dazu folgende Schritte aus:

  1. Suchen Sie nach Ihrer Debug-Schlüsselspeicherdatei. Der Dateiname ist debug.keystore und wird beim ersten Erstellen Ihres Projekts erstellt. Standardmäßig befindet sich die Datei in demselben Verzeichnis wie Ihre Android Virtual Device (AVD)-Dateien:

    • OS X und Linux: ~/.android/
    • Windows Vista und Windows 7: C:\Users\your_user_name\.android\

  2. SHA-1-Fingerabdruck auflisten:

    • Öffnen Sie unter Linux oder OS X ein Terminalfenster und geben Sie Folgendes ein:

      keytool -list -v -keystore ~/.android/debug.keystore -alias androiddebugkey -storepass android -keypass android

    • Führen Sie unter Windows Vista und Windows 7 Folgendes aus:

      keytool -list -v -keystore "%USERPROFILE%\.android\debug.keystore" -alias androiddebugkey -storepass android -keypass android

Die Ausgabe sollte in etwa so aussehen:

Alias name: androiddebugkey
Creation date: Jan 01, 2013
Entry type: PrivateKeyEntry
Certificate chain length: 1
Certificate[1]:
Owner: CN=Android Debug, O=Android, C=US
Issuer: CN=Android Debug, O=Android, C=US
Serial number: 4aa9b300
Valid from: Mon Jan 01 08:04:04 UTC 2013 until: Mon Jan 01 18:04:04 PST 2033
Certificate fingerprints:
     MD5:  AE:9F:95:D0:A6:86:89:BC:A8:70:BA:34:FF:6A:AC:F9
     SHA1: BB:0D:AC:74:D3:21:E1:43:07:71:9B:62:90:AF:A1:66:6E:44:5D:75
     Signature algorithm name: SHA1withRSA
     Version: 3
Release-Zertifikat

Zertifikat-Fingerabdruck des Release-Zertifikats anzeigen

Verwenden Sie das keytool Programm mit dem -v Parameter, um den SHA-1-Fingerabdruck eines Zertifikats aufzurufen. Führen Sie dazu folgende Schritte aus:

  1. Suchen Sie nach der Schlüsselspeicherdatei Ihres Freigabezertifikats. Es gibt keinen Standardspeicherort oder -namen für den Freigabeschlüsselspeicher. Wenn Sie beim Erstellen Ihrer App für die Veröffentlichung keinen angeben, bleibt die .apk unsigniert und Sie müssen sie signieren, bevor Sie sie veröffentlichen können. Für das Freigabezertifikat benötigen Sie auch den Zertifikats alias und die Kennwörter für den Schlüsselspeicher und das Zertifikat.

  2. Geben Sie Folgendes ein, um die Aliasnamen für alle Schlüssel in einem Schlüsselspeicher aufzulisten:

    keytool -list -keystore your_keystore_name
  3. Ersetzen Sie your_keystore_name durch den voll qualifizierten Pfad und Namen des Schlüsselspeichers. Fügen Sie die .keystore Erweiterung hinzu. Geben Sie bei Aufforderung das Kennwort des Schlüsselspeichers ein. Dann keytool werden alle Aliasnamen im Schlüsselspeicher angezeigt.

  4. Geben Sie Folgendes in einem Terminal oder bei einer Eingabeaufforderung ein:

          keytool -list -v -keystore your_keystore_name -alias your_alias_name
  5. Ersetzen Sie your_keystore_name durch den voll qualifizierten Pfad und Namen des Schlüsselspeichers. Fügen Sie die .keystore Erweiterung hinzu.
  6. Ersetzen Sie your_alias_name durch den Alias, den Sie dem Zertifikat bei dessen Erstellung zugewiesen haben.

Die Ausgabe sollte in etwa so aussehen:

Alias name: <alias_name>
Creation date: Feb 02, 2013
Entry type: PrivateKeyEntry
Certificate chain length: 1
Certificate[1]:
Owner: CN=Android Debug, O=Android, C=US
Issuer: CN=Android Debug, O=Android, C=US
Serial number: 4cc9b300
Valid from: Mon Feb 02 08:01:04 UTC 2013 until: Mon Feb 02 18:05:04 PST 2033
Certificate fingerprints:
    MD5:  AE:9F:95:D0:A6:86:89:BC:A8:70:BA:34:FF:6B:AC:F9
    SHA1: BB:0D:AC:74:D3:21:E1:43:67:71:9B:62:90:AF:A1:66:6E:44:5D:75
    Signature algorithm name: SHA1withRSA
    Version: 3

Die Zeile, die mit SHA1 beginnt, enthält den SHA-1 Fingerabdruck des Zertifikats. Der Fingerabdruck ist eine Abfolge aus 20 zweistelligen Hexadezimalzahlen, die durch Doppelpunkte getrennt sind.

API-Schlüssel aus der Google Developers Console abrufen

Klicken Sie auf die Schaltfläche Schlüssel anfordern, um mit der Google Awareness API zu beginnen. Sie werden zur Google Developers Console weitergeleitet, die Sie durch den Prozess führt und die Awareness API automatisch aktiviert.

Schlüssel anfordern

Alternativ können Sie auch wie folgt einen API-Schlüssel anfordern:

  1. Wechseln Sie zur Google Developers Console.
  2. Wählen Sie ein Projekt aus oder erstellen Sie ein neues.
  3. Klicken Sie auf Weiter , um die Awareness API zu aktivieren.

  4. Erstellen Sie auf der Seite „Anmeldedaten“ einen Android-Schlüssel und legen Sie die API-Anmeldedaten fest.

  5. Im Dialogfeld „Schlüssel erstellen“ müssen Sie die Nutzung auf Android-Apps beschränken. Geben Sie dazu den SHA-1-Fingerabdruck und den Paketnamen Ihrer App ein, wie im folgenden Beispiel:

    BB:0D:AC:74:D3:21:E1:43:67:71:9B:62:91:AF:A1:66:6E:44:5D:75

com.example.android.awareness-example

  6. Klicken Sie auf Erstellen. Der neue Android-API-Schlüssel wird in der Liste der API-Schlüssel für Ihr Projekt angezeigt. Ein API-Schlüssel ist eine Zeichenfolge wie die folgende:

    AIzaSyBdVl-cTICSwYKrZ95LoVuw7dbMuDt1KG0

Nachdem Sie einen API-Schlüssel haben, können Sie ihn dem Manifest Ihrer App hinzufügen, wie im Leitfaden Erste Schritte beschrieben.

Zusätzliche APIs aktivieren

Mit der Awareness API können Sie auf verschiedene Arten von Kontextdaten zugreifen, z. B. auf Beacons. Wenn Sie diese Typen verwenden möchten, müssen Sie die entsprechenden APIs in der Google Developers Console aktivieren.

Dienst Awareness API-Methoden Zu aktivierende API
Beacons SnapshotApi.getBeaconState(), FenceApi.BeaconFence Nearby Messages API