Grundlegende Einrichtung

Führen Sie zuerst die Schritte unter Voraussetzungen aus und prüfen Sie, ob Ihrem Projekt Zugriff auf die Business Profile APIs gewährt wurde.

APIs aktivieren

Es gibt acht Business Profile APIs, die in der Google API Console aktiviert werden müssen:

  • Google My Business API
  • My Business Account Management API
  • My Business Lodging API
  • My Business Place Actions API
  • My Business Notifications API
  • My Business Verifications API
  • My Business Business Information API
  • My Business Q&A API

API aktivieren

Sie haben alle Voraussetzungen erfüllt und Ihnen wurde Zugriff auf die API gewährt, aber die Verknüpfung funktioniert trotzdem nicht? Dann können Sie die API wie nachfolgend beschrieben manuell aktivieren.

So aktivieren Sie eine API für Ihr Projekt:

  1. Öffnen Sie die API-Bibliothek in der Google API Console. Wählen Sie ein Projekt aus oder erstellen Sie ein neues, wenn Sie dazu aufgefordert werden. In der API-Bibliothek finden Sie alle verfügbaren APIs nach Produktfamilie und Beliebtheit gruppiert.
  2. Wenn die API, die Sie aktivieren möchten, nicht in der Liste angezeigt wird, können Sie die Suchfunktion verwenden.
  3. Wählen Sie die gewünschte API aus und klicken Sie dann auf die Schaltfläche Aktivieren.
  4. Aktivieren Sie die Abrechnung, wenn Sie dazu aufgefordert werden.
  5. Akzeptieren Sie die Nutzungsbedingungen der API, wenn Sie dazu aufgefordert werden.

Als Google Workspace-Nutzer sollten Sie prüfen, ob in Ihrer Google Workspace-Organisation Google Unternehmensprofil für Ihr Konto aktiviert ist. Andernfalls wird der „Fehler 403 – BERECHTIGUNG VERWEIGERT“ angezeigt.

OAuth 2.0-Client-ID anfordern

Ihre Anwendung greift auf geschützte, nicht öffentliche Daten zu. Aus diesem Grund ist eine OAuth 2.0-Client-ID erforderlich. Damit kann Ihre Anwendung die Autorisierung anfordern, um im Namen der Nutzer Ihrer Anwendung auf die Standortdaten Ihrer Organisation zuzugreifen.

Ihre Anwendung muss mit jeder Business Profile APIs-Anfrage zum Zugriff auf private Nutzerdaten ein OAuth 2.0-Token senden.

Falls noch nicht geschehen, gehen Sie in der Google API Console zum Bereich „Anmeldedaten“ und klicken Sie auf Anmeldedaten erstellen > OAuth-Client-ID, um Ihre OAuth 2.0-Anmeldedaten zu erstellen. Danach wird Ihre Client-ID auf der Seite Anmeldedaten angezeigt. Klicken Sie auf die Client-ID, um Details wie Clientschlüssel, Weiterleitungs-URIs, JavaScript-Quellen und E-Mail-Adresse zu sehen.

Informationen zu REST-Grundlagen

Es gibt zwei Möglichkeiten, die APIs aufzurufen:

Wenn Sie keine Clientbibliotheken verwenden möchten, müssen Sie mit den Grundlagen von REST vertraut sein.

REST ist ein Architekturstil für Software, der einen praktischen und einheitlichen Ansatz zum Anfordern und Ändern von Daten bietet.

REST steht für Representational State Transfer. Im Kontext von Google APIs bezieht sich das auf die Nutzung von HTTP-Verben zum Abrufen und Ändern der Darstellung von Daten, die von Google gespeichert wurden.

In einem RESTful-System werden Ressourcen in einem Datenspeicher abgelegt. Ein Client sendet eine Anfrage an den Server, damit eine bestimmte Aktion ausgeführt wird und z. B. eine Ressource erstellt, abgerufen, aktualisiert oder gelöscht wird. Der Server führt die Aktion aus und sendet eine Antwort. Die Antwort erfolgt häufig in Form einer Darstellung der angegebenen Ressource.

In den RESTful APIs von Google gibt der Client eine Aktion mit einem HTTP-Verb wie GET, POST, PUT oder DELETE an. Der Client gibt eine Ressource durch eine global eindeutige einheitliche Ressourcenkennung (uniform resource identifier – URI) in der folgenden Form an:

https://apiName.googleapis.com/apiVersion/resourcePath?parameters

Weil alle API-Ressourcen eindeutige, über HTTP zugängliche URIs haben, ermöglicht REST das Caching von Daten und ist optimal geeignet, mit der verteilten Infrastruktur des Webs zu arbeiten.

In der Dokumentation zu den HTTP 1.1-Standards finden Sie auch Methodendefinitionen. Sie enthalten Spezifikationen für GET, POST, PUT und DELETE.

REST in den Business Profile APIs

Die Business Profile APIs-Vorgänge sind REST-HTTP-Verben direkt zugeordnet.

Das spezifische Format für die Business Profile APIs ist im folgenden URI ersichtlich:

https://apiName.googleapis.com/apiVersion/resourcePath?parameters

In der Dokumentation zu den Business Profile APIs finden Sie unter Reference (Referenz) alle URIs für die unterstützten Vorgänge.

Die Ressourcenpfade variieren je nach Endpunkt.

Der Ressourcenpfad zu einem Konto sieht wie im folgenden Beispiel aus:

accounts/accountId

Der Ressourcenpfad für einen Standort sieht so aus:

locations/locationId

Informationen zu JSON-Grundlagen

Die Business Profile APIs geben Daten im JSON-Format zurück.

JavaScript Object Notation (JSON) ist ein gängiges, sprachunabhängiges Datenformat in einer einfach lesbaren Textform. Weitere Informationen finden Sie unter json.org.

OAuth Playground verwenden, um eine einfache HTTP-Anfrage zu stellen

Sie können den OAuth 2.0 Playground verwenden, um mit den Google Unternehmensprofil-APIs zu experimentieren. Da es sich nicht um öffentliche APIs handelt, sind einige zusätzliche Schritte erforderlich, um sie im Playground zu verwenden. Sie benötigen dafür eine Client-ID für eine Webanwendung.

  1. Rufen Sie die Google API Console auf und öffnen Sie Ihr Projekt. Wenn Sie keine OAuth-Client-ID für Webanwendungen haben, erstellen Sie eine:
    1. Wählen Sie in der Drop-down-Liste Anmeldedaten erstellen die Option OAuth-Client-ID aus.
    2. Klicken Sie unter Anwendungstyp auf Webanwendung.
    3. Fügen Sie Folgendes als gültigen Weiterleitungs-URI hinzu:

       https://developers.google.com/oauthplayground
       
    4. Klicken Sie auf Erstellen.
  2. Kopieren Sie die Client-ID in die Zwischenablage.
  3. Rufen Sie OAuth 2.0 Playground auf.
  4. Klicken Sie auf das Zahnradsymbol, um die Konfigurationsoptionen zu öffnen, und nehmen Sie folgende Änderungen vor:
    1. Setzen Sie OAuth flow (OAuth-Ablauf) auf Client-side (Clientseitig).
    2. Wählen Sie Use your own OAuth credentials (Eigene OAuth-Anmeldedaten verwenden) aus.
    3. Fügen Sie Ihre OAuth-Client-ID ein.
  5. Schließen Sie die Konfigurationsoptionen.
  6. Fügen Sie unter „Step 1 – Select & authorize APIs“ (Schritt 1 – APIs auswählen und autorisieren) den folgenden Bereich für die Business Profile APIs in das Feld Input your own scopes (Eigene Bereiche eingeben) ein:

    https://www.googleapis.com/auth/business.manage
    
  7. Klicken Sie auf Authorize APIs (APIs autorisieren).
  8. Klicken Sie auf Accept (Akzeptieren), wenn Sie dazu aufgefordert werden.
  9. Fügen Sie unter "Step 2 – Configure request to API" (Schritt 2 – API-Anfrage konfigurieren) den folgenden URI in das Feld Request URI (Anfrage-URI) ein:

    https://mybusinessaccountmanagement.googleapis.com/v1/accounts
    
  10. Klicken Sie auf Send the request (Anfrage senden). Die Antwort sollte den Status 200 OK haben.

Weitere Informationen zum Senden verschiedener Arten von Anfragen finden Sie in der Dokumentation zu den Business Profile APIs unter Reference (Referenz).

Clientbibliotheken

Die Business Profile APIs-Clientbibliotheken unterstützen die Funktionen der Business Profile APIs. Sie bieten gängige Funktionen aller Google-APIs, wie HTTP-Transport, Fehlerbearbeitung, Authentifizierung und JSON-Parsing.

Informationen zum Herunterladen von Clientbibliotheken finden Sie hier.