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 Typ des benötigten API-Schlüssels ist ein Android API-Schlüssel.

Alle Android-Apps sind mit einem digitalen Zertifikat signiert, für das Sie den privaten Schlüssel haben. Weitere Informationen zu digitalen Zertifikaten findest du im Android-Leitfaden zum Signieren deiner App.

Android API-Schlüssel sind mit bestimmten Zertifikatpaketpaaren verknüpft. Sie benötigen nur einen Schlüssel für jedes Zertifikat, unabhängig von der Anzahl der Nutzer für die Anwendung.

Sie müssen mehrere Schritte ausführen, um einen Schlüssel für Ihre App zu erhalten. Diese werden in diesem Leitfaden ausführlich beschrieben und so zusammengefasst:

  1. Informationen zum Zertifikat Ihrer App abrufen
  2. Registrieren Sie ein Projekt in der Google Developers Console und fügen Sie die User Context API als Dienst für das Projekt hinzu.
  3. Fordern Sie einen Schlüssel an.
  4. Füge deiner App den Schlüssel hinzu. Füge dazu ein Element in dein App-Manifest ein.

Zertifikatsinformationen Ihrer App abrufen

Der API-Schlüssel basiert auf einer Kurzform des digitalen Zertifikats Ihrer App, auch bekannt als SHA-1-Fingerabdruck. Achte darauf, dass du das richtige Zertifikat verwendest, damit der SHA-1-Fingerabdruck für dein Zertifikat angezeigt werden kann. Ihnen stehen möglicherweise die beiden folgenden Zertifikate zur Auswahl:

  • Debug-Zertifikat: Die Android SDK-Tools generieren dieses Zertifikat automatisch, wenn du ein Debug-Build ausführst. Verwende dieses Zertifikat nur bei Apps, die du testest. Versuchen Sie nicht, eine App zu veröffentlichen, die mit einem Debug-Zertifikat signiert ist. Das Debug-Zertifikat wird im Abschnitt Debug-Build signieren in der Android-Entwicklerdokumentation ausführlicher beschrieben.
  • Freigabezertifikat: Die Android SDK-Tools generieren dieses Zertifikat automatisch, wenn du ein Releasebuild ausführst. Sie können dieses Zertifikat auch mit dem Programm keytool generieren. Verwenden Sie dieses Zertifikat, wenn Ihre App veröffentlicht werden soll.

Weitere Informationen zu keytool findest du in der Oracle-Dokumentation.

Debug-Zertifikat

Fingerabdruck des Debug-Zertifikats anzeigen

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

  1. Suche nach deiner Debug-Schlüsselspeicherdatei. Der Dateiname lautet debug.keystore. Sie wurde beim ersten Erstellen des Projekts erstellt. Standardmäßig sind sie im selben Verzeichnis wie deine AVD-Dateien gespeichert:

    • 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 für Windows Vista und Windows 7 folgenden Befehl 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

Fingerabdruck des Freigabezertifikats anzeigen

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

  1. Suche nach der Schlüsselspeicherdatei deines Freigabezertifikats. Es gibt keinen Standardspeicherort oder -namen für den Schlüsselspeicher der Veröffentlichung. Wenn Sie beim Erstellen der App keine Version angeben, bleibt der .apk im Build unsigniert und muss vor der Veröffentlichung signiert werden. Für das Release-Zertifikat benötigst du außerdem den Alias des Zertifikats, die Passwörter für den Schlüsselspeicher und das Zertifikat.
  2. Geben Sie Folgendes ein, um die Aliasse 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 Erweiterung .keystore ein. Geben Sie das Passwort des Schlüsselspeichers ein, wenn Sie dazu aufgefordert werden. Anschließend zeigt keytool alle Aliasse im Schlüsselspeicher an.
  4. Gib 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 Erweiterung .keystore ein.
  6. Ersetzen Sie your_alias_name durch den Alias, den Sie dem Zertifikat beim Erstellen 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 über die Google Developers Console abrufen

Klicken Sie auf die Schaltfläche Schlüssel anfordern, um die Google Awareness API zu starten. Es ist mit der Google Developers Console verknüpft, die Sie durch den Prozess führt und die Awareness API automatisch aktiviert.

Schlüssel anfordern

Du hast auch die Möglichkeit, die folgenden Schritte auszuführen, um einen API-Schlüssel zu erhalten:

  1. Rufen Sie die Google Developers Console auf.
  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 der App wie im folgenden Beispiel ein:

    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. Ihr neuer Android API-Schlüssel wird in der Liste der API-Schlüssel für Ihr Projekt angezeigt. Ein API-Schlüssel ist ein String, der wie folgt aussieht:

    AIzaSyBdVl-cTICSwYKrZ95LoVuw7dbMuDt1KG0
    

Nachdem du einen API-Schlüssel hast, kannst du ihn dem Manifest deiner App hinzufügen, wie im Startleitfaden beschrieben.

Zusätzliche APIs aktivieren

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

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