Der Google APIs Explorer generiert dynamisch Codebeispiele. Diese Codebeispiele sind so konzipiert, dass sie kopiert und lokal ausgeführt werden. Klicken Sie in der Seitenleiste von APIs Explorer auf „Vollbild“
, um sich die Beispiele anzusehen. Die folgende Abbildung zeigt den erweiterten Vollbild-APIs Explorer:Standardmäßig wird im APIs Explorer gezeigt, wie Sie Ihre Anfrage mit cURL ausführen. Einige APIs zeigen möglicherweise auch Beispiele für andere Sprachen wie JavaScript, Java und Python an.
Codebeispiele lokal ausführen
Auf den folgenden Tabs werden die Voraussetzungen und Schritte zum Ausführen von Codebeispielen erläutert. Zum Ausführen der Codebeispiele müssen Sie Ihre eigenen Autorisierungsanmeldedaten generieren und verwenden. Eine Erläuterung zum Erstellen eines Projekts und zum Generieren von Anmeldedaten finden Sie in der Dokumentation Ihrer jeweiligen Google API.
Je nachdem, auf welche Art von Daten (öffentlich oder privat) die Methode zugreift, sind die Anmeldedaten verfügbar:
- Bei öffentlichen Daten sind die Anmeldedaten ein API-Schlüssel.
Die Anmeldedaten für private Daten sind entweder eine
client_secret.json
-Datei mit Ihrer OAuth 2.0-Client-ID und Ihrem Clientschlüssel oder ein OAuth 2.0-Zugriffstoken.
cURL
Einrichten
- Folgen Sie der Anleitung in der API-Dokumentation, um ein Projekt für Ihre Anwendung zu erstellen oder auszuwählen und die API zu aktivieren.
- Erstellen Sie in der Cloud Console einen API-Schlüssel.
- Erstellen Sie in der Cloud Console eine OAuth-Client-ID für eine Webanwendung und verwenden Sie
https://developers.google.com/oauthplayground
als Weiterleitungs-URI. - Klicken Sie im OAuth 2.0 Playground auf OAuth 2.0 Configuration .
- Setzen Sie ein Häkchen bei Use your own credentials (Eigene Anmeldedaten verwenden).
- Geben Sie die in Schritt 3 generierte Client-ID und den Clientschlüssel ein.
- Geben Sie im Feld „Bereiche“ den Bereich ein, den Sie für Ihre Methode verwenden möchten, und klicken Sie auf APIs autorisieren.
- Optional: Wenn ein Anmeldebildschirm angezeigt wird, wählen Sie das Konto aus, das verwendet werden soll.
- Optional: Wenn ein Autorisierungsbildschirm angezeigt wird, klicken Sie auf Accept (Akzeptieren).
- Klicken Sie auf Autorisierungscode für Tokens austauschen. Ein Token wird zurückgegeben.
- Ersetze
[YOUR_API_KEY]
im cURL-Codebeispiel durch den API-Schlüssel, der in Schritt 2 generiert wurde:'https://www.googleapis.com/drive/v3/files?key=[YOUR_API_KEY]' \
- Ersetzen Sie im cURL-Codebeispiel
[YOUR_ACCESS_TOKEN]
durch das Zugriffstoken, das in Schritt 10 generiert wurde:--header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \
Codebeispiel ausführen
Führen Sie in der Befehlszeile den Befehl „cURL“ aus. Der Befehl sollte in etwa so aussehen:
curl \
'https://www.googleapis.com/drive/v3/files?key=AIzaSyBiKcaoXmVApwnT24hitQG_dwjGvAj6Ddw' \
--header 'Authorization: Bearer ya29.a0ARrdaM_yQn9MWBpJgKPx880BSnRYIizRYIDz0JN9e66nSliIYpqNXmPsvv2ccfplCTG_U4b1' \
--header 'Accept: application/json' \
--compressed
JavaScript
Einrichten
- Folgen Sie der Anleitung in der API-Dokumentation, um ein Projekt für Ihre Anwendung zu erstellen oder auszuwählen und die API zu aktivieren.
- Erstellen Sie in der Cloud Console einen API-Schlüssel.
- Erstellen Sie in der Cloud Console OAuth-Client-ID-Anmeldedaten für eine Webanwendung und legen Sie die autorisierten JavaScript-Quellen fest, um die URL zu identifizieren, von der Anfragen gesendet werden, z. B.
http://localhost
. - Kopieren Sie das vollständige Codebeispiel in eine lokale Datei, auf die Ihr Webserver zugreifen kann, z. B.
/var/www/html/example.html
. Suchen Sie im Codebeispiel die Zeile, in der der API-Schlüssel oder die Client-ID festgelegt ist, und ersetzen Sie den Wert durch die in Schritt 2 und 3 generierten Werte:
- API-Schlüssel:
gapi.client.setApiKey(YOUR_API_KEY);
- OAuth 2.0-Client-ID:
gapi.client.init({ 'clientId': 'YOUR_CLIENT_ID',
- API-Schlüssel:
Codebeispiel ausführen
- Öffnen Sie die Datei in Ihrem Browser, z. B.
http://localhost/example.html
. Wir empfehlen die Verwendung eines Browsers mit einer Debugging-Konsole wie Google Chrome. - Optional: Wenn ein Anmeldebildschirm angezeigt wird, wählen Sie das Konto aus, das verwendet werden soll.
- Optional: Wenn ein Autorisierungsbildschirm angezeigt wird, klicken Sie auf Accept (Akzeptieren). In der Debugging-Konsole sollte die Methodenantwort als JSON-Objekt angezeigt werden.
Java
Voraussetzungen
- Java 1.7 oder höher.
- Gradle 7 oder höher.
Einrichten
- Folgen Sie der Anleitung in der API-Dokumentation, um ein Projekt für Ihre Anwendung zu erstellen oder auszuwählen und die API zu aktivieren.
- Abhängig davon, auf welche Art von Daten die Methode zugreift, erstellen Sie einen API-Schlüssel (öffentliche Daten) oder eine OAuth 2.0-Client-ID (private Daten).
- Wählen Sie als Anwendungstyp Desktop-App aus.
- Wenn Sie eine OAuth 2.0-Client-ID erstellt haben, laden Sie die JSON-Datei mit Ihren OAuth 2.0-Anmeldedaten herunter. Diese Datei hat einen Namen wie
client_secret_CLIENTID.json
, wobeiCLIENTID
die Client-ID für Ihr Projekt ist. Führen Sie in Ihrem Arbeitsverzeichnis die folgenden Befehle aus, um eine neue Projektstruktur zu erstellen:
$ gradle init --type basic $ mkdir -p src/main/java src/main/resources
Wenn Sie in Schritt 2 eine OAuth 2.0-Client-ID erstellt haben, benennen Sie die heruntergeladene JSON-Datei in
client_secret.json
um.Speichern Sie die umbenannte Datei im Verzeichnis
src/main/resources
, das Sie in Schritt 5 erstellt haben.Öffnen Sie in Ihrem Arbeitsverzeichnis die Datei
build.gradle
und ersetzen Sie ihren Inhalt durch Folgendes:apply plugin: 'java' apply plugin: 'application' mainClassName = 'ApiExample' sourceCompatibility = 1.7 targetCompatibility = 1.7 version = '1.0' repositories { mavenCentral() } dependencies { compile 'com.google.api-client:google-api-client:1.23.0' compile 'com.google.oauth-client:google-oauth-client-jetty:1.23.0' API_SPECIFIC_DEPENDENCY }
Ersetzen Sie in der Datei
build.gradle
die ZeileAPI_SPECIFIC_DEPENDENCY
durch eine Anweisung zum Kompilieren von Code für die API, die Sie aufrufen. Hier ein Beispiel für die YouTube Analytics API:compile 'com.google.apis:google-api-services-youtubeAnalytics:v2-rev16-1.23.0'
Die Anleitung folgt dieser Vorlage:
compile 'com.google.apis:google-api-services-API_NAME:API_VERSION- revREVISION-CL_VERSION'
Dabei gilt:
API_NAME
ist der auf GitHub für die API aufgeführte API-Name. Klicken Sie auf der Seite Unterstützte Google APIs auf den Versionslink neben Ihrer API, um den Namen aufzurufen. Über den Versionslink wird GitHub aufgerufen. Der API-Name befindet sich in der oberen Mitte der Seite und ihm istgoogleapis/google-apis-services-
vorangestellt. Für Version 3 der Drive API ist beispielsweiseAPI_NAME
drive
.API_VERSION
ist die API-Version, die auf der Seite „Unterstützte Google APIs“ unter dem API-Namen aufgeführt ist.REVISION
ist die Überarbeitungsnummer, die in der JavaDoc-Referenz für die API aufgeführt ist. Die JavaDoc-Referenz finden Sie unterhttps://googleapis.dev/java/google-api-services-API_NAME/latest/index.html
.CL_VERSION
ist die Version der Clientbibliothek. Dieser Wert ist auch in der JavaDoc-Referenz enthalten.- Kopieren Sie aus Ihrem Arbeitsverzeichnis das Codebeispiel aus APIs Explorer in
src/main/java/ApiExample.java
. Der Klassenname in jeder Stichprobe lautetApiExample
, sodass Sie die Dateibuild.gradle
nicht ändern müssen, um verschiedene Stichproben auszuführen.
Codebeispiel ausführen
Verwenden Sie den folgenden Befehl, um das Beispiel auszuführen:
gradle -q run
Im Beispiel sollte Ihre API-Anfrage ausgeführt und die Antwort an STDOUT
ausgegeben werden.
Sie können auch den Dienst aufrufen, den Sie aufrufen, um die Auswirkungen von Anfragen zu sehen, bei denen Daten geschrieben werden.
Node.js
Voraussetzungen
- Node.js
Die Google APIs-Clientbibliothek für Node.js:
- Wenn Sie die Clientbibliothek noch nicht installiert haben, führen Sie den folgenden Befehl aus:
npm install googleapis --save
- Wenn Sie die Clientbibliothek bereits installiert haben, sollten Sie darauf achten, dass Sie die aktuellen Klassen für die zu testende Bibliothek verwenden. Führen Sie den folgenden Befehl aus, um die Clientbibliothek zu aktualisieren:
npm update googleapis --save
Einrichten
- Folgen Sie der Anleitung in der API-Dokumentation, um ein Projekt für Ihre Anwendung zu erstellen oder auszuwählen und die API zu aktivieren.
- Abhängig davon, auf welche Art von Daten die Methode zugreift, erstellen Sie einen API-Schlüssel (öffentliche Daten) oder eine OAuth 2.0-Client-ID (private Daten).
- Wählen Sie als Anwendungstyp Desktop-App aus.
- Wenn Sie eine OAuth 2.0-Client-ID erstellt haben, laden Sie die JSON-Datei mit Ihren OAuth 2.0-Anmeldedaten herunter. Diese Datei hat einen Namen wie
client_secret_CLIENTID.json
, wobeiCLIENTID
die Client-ID für Ihr Projekt ist. - Kopieren Sie das Codebeispiel in eine lokale Datei und ändern Sie das Beispiel so, dass der API-Schlüssel oder die Clientschlüsseldatei richtig identifiziert wird. Im Beispiel lautet der Wert des API-Schlüssels
YOUR_API_KEY
und der Speicherort der ClientschlüsseldateiYOUR_CLIENT_SECRET_FILE.json
.
Codebeispiel ausführen
Verwenden Sie den folgenden Befehl, um das Beispiel auszuführen:
node sample.js
In den meisten Beispielen wird eine API-Antwort (oder etwas anderes) an STDOUT
ausgegeben.
PHP
Voraussetzungen
- PHP 5.4 oder höher mit der Befehlszeile und der JSON-Erweiterung.
- Das Composer-Abhängigkeitsmanagement-Tool, das weltweit installiert ist.
Die Google APIs-Clientbibliothek für PHP:
Wenn Sie die Clientbibliothek noch nicht installiert haben, führen Sie den folgenden Befehl aus:
composer require google/apiclient:^2.0
Wenn Sie die Clientbibliothek zuvor installiert haben, sollten Sie darauf achten, dass Sie die aktuellen Klassen für die zu testende Bibliothek haben. Führen Sie den folgenden Befehl aus, um die Clientbibliothek zu aktualisieren:
composer update google/apiclient --with-dependencies
Codebeispiel ausführen
Verwenden Sie den folgenden Befehl, um das Beispiel auszuführen:
php sample.php
In den meisten Beispielen wird eine API-Antwort (oder etwas anderes) an STDOUT
ausgegeben.
Python
Voraussetzungen
- Python 2.7 oder Python 3.5+
- Paketverwaltungstool „pip“
Die Google APIs-Clientbibliothek für Python:
pip install --upgrade google-api-python-client
Die Bibliotheken
google-auth-oauthlib
undgoogle-auth-httplib2
zur Nutzerautorisierung:pip install --upgrade google-auth-oauthlib google-auth-httplib2
Einrichten
- Folgen Sie der Anleitung in der API-Dokumentation, um ein Projekt für Ihre Anwendung zu erstellen oder auszuwählen und die API zu aktivieren.
- Abhängig davon, auf welche Art von Daten die Methode zugreift, erstellen Sie einen API-Schlüssel (öffentliche Daten) oder eine OAuth 2.0-Client-ID (private Daten).
- Wählen Sie als Anwendungstyp Desktop-App aus.
- Wenn Sie eine OAuth 2.0-Client-ID erstellt haben, laden Sie die JSON-Datei mit Ihren OAuth 2.0-Anmeldedaten herunter. Diese Datei hat einen Namen wie
client_secret_CLIENTID.json
, wobeiCLIENTID
die Client-ID für Ihr Projekt ist. - Kopieren Sie das Codebeispiel in eine lokale Datei und ändern Sie das Beispiel so, dass der API-Schlüssel oder die Clientschlüsseldatei richtig identifiziert wird. Im Beispiel lautet der Wert des API-Schlüssels
YOUR_API_KEY
und der Speicherort der ClientschlüsseldateiYOUR_CLIENT_SECRET_FILE.json
.
Codebeispiel ausführen
Verwenden Sie den folgenden Befehl, um das Beispiel auszuführen:
python sample.py
In den meisten Beispielen wird eine API-Antwort (oder etwas anderes) an STDOUT
ausgegeben.
Ruby
Voraussetzungen
- Ruby 2.0 oder höher
Die Google APIs-Clientbibliothek für Ruby:
gem install google-api-client`
Einrichten
- Folgen Sie der Anleitung in der API-Dokumentation, um ein Projekt für Ihre Anwendung zu erstellen oder auszuwählen und die API zu aktivieren.
- Abhängig davon, auf welche Art von Daten die Methode zugreift, erstellen Sie einen API-Schlüssel (öffentliche Daten) oder eine OAuth 2.0-Client-ID (private Daten).
- Wählen Sie als Anwendungstyp Desktop-App aus.
- Wenn Sie eine OAuth 2.0-Client-ID erstellt haben, laden Sie die JSON-Datei mit Ihren OAuth 2.0-Anmeldedaten herunter. Diese Datei hat einen Namen wie
client_secret_CLIENTID.json
, wobeiCLIENTID
die Client-ID für Ihr Projekt ist. - Kopieren Sie das Codebeispiel in eine lokale Datei und ändern Sie das Beispiel so, dass der API-Schlüssel oder die Clientschlüsseldatei richtig identifiziert wird. Im Beispiel lautet der Wert des API-Schlüssels
YOUR_API_KEY
und der Speicherort der ClientschlüsseldateiYOUR_CLIENT_SECRET_FILE.json
.
Codebeispiel ausführen
Verwenden Sie den folgenden Befehl, um das Beispiel auszuführen:
ruby sample.rb
In den meisten Beispielen wird eine API-Antwort (oder etwas anderes) an STDOUT
ausgegeben.
Beispielprobleme beheben
Dialogfeld für die Autorisierung wird nicht angezeigt
APIs Explorer verwendet ein Pop-up, um Zugriff auf Ihre privaten Daten zu gewähren. Wenn Ihr Browser Pop-ups blockiert, werden diese nicht angezeigt und Sie können den Zugriff nicht gewähren.
Wenn Sie auf dem Autorisierungsbildschirm auf „Zulassen“ klicken und nichts passiert, ändern Sie die Pop-up-Einstellungen Ihres Browsers, um Pop-ups zu aktivieren.
Fehler 401 oder 403 erhalten
Wenn beim Testen einer Stichprobe ein 401- oder 403-Fehler angezeigt wird, liegt wahrscheinlich ein Problem mit einer der folgenden Optionen vor:
- Die API ist für Ihr Projekt nicht aktiviert. Lesen Sie in der Anleitung für Ihre API nach, wie Sie ein Projekt erstellen und eine API aktivieren.
- Sie verwenden den falschen Autorisierungstyp (API-Schlüssel anstelle von OAuth 2.0).
- Sie verwenden OAuth 2.0, aber den Umfang ist zu eng gefasst.
- Wenn Sie Ihren API-Schlüssel einrichten, legen Sie Einschränkungen fest, um eine nicht autorisierte Nutzung Ihrer Anmeldedaten zu verhindern. Die Anforderung erfüllt diese Einschränkungen jedoch nicht. Weitere Informationen finden Sie unter Einschränkungen von API-Schlüsseln verwenden.
Warnung zu gemischtem Inhalt erhalten
Wenn Sie Google Cloud Endpoints verwenden und Ihren Endpunkt auf einem Entwicklungsserver ausführen, gibt Ihr Browser möglicherweise eine Warnung zu gemischten Inhalten aus. Diese Warnung wird angezeigt, da APIs Explorer über HTTPS geladen wird. Wenn Ihre API jedoch lokal ausgeführt wird, wird sie auf HTTP gehostet.
Wenn Sie diese Warnung in Chrome ausblenden möchten, starten Sie eine Chrome-Sitzung mit speziellen Flags:
path/to/chrome --user-data-dir=test --unsafely-treat-insecure-origin-as-secure=http://localhost:port
Beispiel:
/usr/bin/google-chrome-stable --user-data-dir=test --unsafely-treat-insecure-origin-as-secure=http://localhost:8080
Diese Warnung sollte nur für lokale Tests ausgeblendet werden.
Nur JavaScript: gapi ist nicht definiert.
Ein „>“-Fehler ist nicht definiert, wenn der JavaScript-Code versucht, die Google API-Clientbibliothek für JavaScript aufzurufen, bevor die Bibliothek geladen wurde. Achten Sie darauf, dass der Code, der auf die Variable gapi
verweist, erst nach dem Laden der Clientbibliothek aufgerufen wird.