बाहरी एपीआई

Google Apps Script पूरे वेब के एपीआई के साथ इंटरैक्ट कर सकती है. इस गाइड में बताया गया है कि अपनी स्क्रिप्ट में मौजूद अलग-अलग तरह के एपीआई के साथ कैसे काम करें.

सार्वजनिक एपीआई से कनेक्ट करना

एपीआई अनुरोधों को सीधे तौर पर करने के लिए, UrlFetch सेवा का इस्तेमाल किया जा सकता है.

इस उदाहरण में, GitHub API का इस्तेमाल करके, डेटा स्टोर करने की ऐसी जगहें खोजी जा सकती हैं जिनमें 100 या उससे ज़्यादा स्टार हों. साथ ही, जिनमें "Apps Script" का ज़िक्र किया गया हो. इस एपीआई अनुरोध के लिए, अनुमति या एपीआई पासकोड की ज़रूरत नहीं है.

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 की मदद से सेवाओं को अनुरोध भेजना

उपयोगकर्ता की ओर से काम करने वाले एपीआई के लिए आम तौर पर अनुमति की ज़रूरत होती है. इसके लिए अक्सर OAuth प्रोटोकॉल का इस्तेमाल किया जाता है. Apps Script प्रोटोकॉल के लिए पहले से मौजूद सहायता नहीं देती. हालांकि, कुछ ओपन सोर्स लाइब्रेरी हैं, जिनका इस्तेमाल OAuth फ़्लो को पूरा करने और अपने अनुरोधों के साथ क्रेडेंशियल भेजने के लिए किया जा सकता है:

JSON के साथ काम करें

JSON ऑब्जेक्ट के साथ काम करना, एक्सएमएल के साथ काम करने जैसा ही है. हालांकि, इसमें JSON ऑब्जेक्ट के साथ काम करना ज़्यादा आसान है.

अगर जिस एपीआई का अनुरोध किया गया है उससे किसी अनुरोध का रॉ JSON रिस्पॉन्स मिलता है, तो HTTPResponse.getContentText() तरीके का इस्तेमाल करके, JSON स्ट्रिंग रिस्पॉन्स को ऐक्सेस किया जा सकता है. इस स्ट्रिंग को फ़ेच करने के बाद, नेटिव ऑब्जेक्ट दिखाने के लिए, बस 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 पार्स करें

अगर कोई बाहरी एपीआई किसी अनुरोध के लिए रॉ एक्सएमएल रिस्पॉन्स देता है, तो HTTPResponse.getContentText() तरीके का इस्तेमाल करके एक्सएमएल रिस्पॉन्स को ऐक्सेस किया जा सकता है.

// Make request to API and get response before this point.
var xml = response.getContentText();
var doc = XmlService.parse(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.