ממשקי API חיצוניים

‫Google Apps Script יכול ליצור אינטראקציה עם ממשקי API מכל רחבי האינטרנט. במדריך הזה מוסבר איך לעבוד עם סוגים שונים של ממשקי API בסקריפטים.

חיבור לממשקי API ציבוריים

אתם יכולים להשתמש בשירות UrlFetch כדי לשלוח בקשות API באופן ישיר.

בדוגמה הבאה נשתמש ב-GitHub API כדי לחפש מאגרים עם 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 ולשלוח את פרטי הכניסה עם הבקשות:

• ‫OAuth1 ל-Apps Script: תואם ל-OAuth 1.0 ול-OAuth 1.0a.
• ‫OAuth2 ל-Apps Script: תואם ל-OAuth2.

עבודה עם JSON

העבודה עם אובייקטים מסוג JSON דומה לעבודה עם XML, אבל קל יותר לנתח או לקודד אובייקט JSON.

אם ה-API שאליו נשלחת הבקשה מחזיר תגובה בפורמט JSON גולמי, אפשר לגשת לתגובה של מחרוזת JSON באמצעות ה-method 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.