Внешние API

Скрипт Google Apps может взаимодействовать с API по всему интернету. В этом руководстве показано, как работать с различными типами API в ваших скриптах.

Подключайтесь к публичным API

Вы можете использовать службу UrlFetch для прямого выполнения запросов API.

В следующем примере API GitHub используется для поиска репозиториев со 100 и более звёздами, в которых упоминается «Apps Script». Этот запрос к API не требует авторизации или API-ключа.

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);

Делайте запросы к сервисам с OAuth

API, действующие от имени пользователя, обычно требуют авторизации, часто с использованием протокола OAuth . Apps Script не предоставляет встроенной поддержки этого протокола, но существуют библиотеки с открытым исходным кодом, которые можно использовать для реализации процесса OAuth и отправки учётных данных вместе с запросами:

Работа с JSON

Работа с объектами JSON похожа на работу с XML, за исключением того, что анализ или кодирование объекта JSON намного проще.

Если запрашиваемый API возвращает необработанный ответ JSON, доступ к строке ответа JSON можно получить с помощью метода HTTPResponse.getContentText() . После получения этой строки просто вызовите метод JSON.parse() для строки, чтобы получить представление исходного объекта.

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

Аналогично, чтобы создать строковое представление объекта JavaScript для выполнения запроса, используйте 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

Если внешний API возвращает необработанный XML-ответ на запрос, вы можете получить доступ к XML-ответу с помощью метода HTTPResponse.getContentText() .

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

При выполнении XML-запросов к API сформируйте XML для отправки с помощью методов XmlService .

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.