Externe APIs

Google Apps Script kann mit APIs aus dem gesamten Web interagieren. Dieser Leitfaden zeigt, wie Sie mit verschiedenen API-Typen in Ihren Skripts arbeiten.

Mit öffentlichen APIs verbinden

Mit dem Dienst UrlFetch können Sie API-Anfragen direkt senden.

Im folgenden Beispiel wird die Methode GitHub API für Suchen Sie nach Repositories mit mindestens 100 Sternen, in denen „Apps Script“ erwähnt wird. Für diese API-Anfrage ist keine Autorisierung und kein API-Schlüssel erforderlich.

var query = '"Apps Script" stars:">=100"';
var url = 'https://api.github.com/search/repositories'
  + '?sort=stars'
  + '&q=' + encodeURIComponent(query);

var response = UrlFetchApp.fetch(url, {'muteHttpExceptions': true});
Logger.log(response);

Anfragen an Dienste mit OAuth senden

APIs, die im Auftrag eines Nutzers handeln, erfordern in der Regel eine Autorisierung und verwenden häufig das OAuth-Protokoll. Apps Script bietet keine integrierte unterstützt das Protokoll. Es gibt aber auch Open-Source-Bibliotheken, mit denen Sie OAuth-Vorgang ausführen und die Anmeldedaten zusammen mit Ihren Anfragen senden:

• OAuth1 für Apps Script: Kompatibel mit OAuth 1.0 und 1.0a.
• OAuth2 für Apps Script: Kompatibel mit OAuth2.

Mit JSON arbeiten

Die Arbeit mit JSON-Objekten ähnelt der Arbeit mit XML, mit der Ausnahme, dass ist die Codierung eines JSON-Objekts viel einfacher.

Wenn die angeforderte API eine JSON-Rohantwort auf eine Anfrage zurückgibt, kann über die Methode HTTPResponse.getContentText() Sobald dieser String abgerufen ist, rufen Sie einfach JSON.parse() für den String auf, um eine Darstellung nativer Objekte.

// Make request to API and get response before this point.
var json = response.getContentText();
var data = JSON.parse(json);
Logger.log(data.title);

Um ein JavaScript-Objekt in einer Zeichenfolge darzustellen, eine Anfrage stellen, verwenden Sie JSON.stringify().

var data = {
  'entry': {
    'group': {
      'title': 'Dog Skateboarding',
      'description': 'My dog gets some serious air'
    },
    'keywords': 'dog, skateboard'
  }
}
var payload = JSON.stringify(data);
// Make request to API with payload after this point.

XML parsen

Wenn eine externe API eine XML-Rohantwort für eine Anfrage zurückgibt, können Sie auf die XML-Antwort mit der Methode HTTPResponse.getContentText()

// Make request to API and get response before this point.
var xml = response.getContentText();
var doc = XmlService.parse(xml);

Wenn Sie XML-Anfragen an eine API senden, erstellen Sie die zu sendende XML-Datei mithilfe von die XmlService-Methoden.

var root = XmlService.createElement('entry')
    .setAttribute('keywords', 'dog, skateboard');
var group = XmlService.createElement('group')
    .setAttribute('title', 'Dog Skateboarding');
    .setAttribute('description', 'My dog gets some serious air');
root.addContent(group);
var document = XmlService.createDocument(root);
var payload = XmlService.getPrettyFormat().format(document);
// Make request to API with payload after this point.