Class UrlFetchApp

UrlFetchApp

संसाधन फ़ेच करें और इंटरनेट पर अन्य होस्ट से संपर्क करें.

यह सेवा स्क्रिप्ट को अन्य ऐप्लिकेशन से संचार करने या यूआरएल फ़ेच करके वेब पर अन्य संसाधन ऐक्सेस करने देती है. स्क्रिप्ट, एचटीटीपी और एचटीटीपीएस अनुरोध जारी करने और जवाब पाने के लिए यूआरएल फ़ेच करने की सेवा का इस्तेमाल कर सकती है. यूआरएल फ़ेच करने की सेवा, कुशलता और स्केलिंग के लिए, Google की नेटवर्क इन्फ़्रास्ट्रक्चर का इस्तेमाल करती है.

इस सेवा का इस्तेमाल करके किए गए अनुरोध, आईपी रेंज के सेट पूल से आते हैं. अगर आप इन अनुरोधों को अनुमति देना चाहते हैं या इन अनुरोधों को स्वीकार करना चाहते हैं, तो आप आईपी पतों की पूरी सूची देख सकते हैं.

इस सेवा के लिए https://www.googleapis.com/auth/script.external_request दायरा ज़रूरी है. ज़्यादातर मामलों में, Apps Script अपने-आप पता लगाता है और उसमें वे दायरे शामिल होते हैं जिनकी स्क्रिप्ट को ज़रूरत है. हालांकि, अगर दायरे को साफ़ तौर पर सेट किया जा रहा है, तो UrlFetchApp का इस्तेमाल करने के लिए, आपको यह दायरा मैन्युअल तरीके से जोड़ना होगा.

इन्हें भी देंखे

तरीके

तरीकारिटर्न टाइपसंक्षिप्त विवरण
fetch(url)HTTPResponseयूआरएल फ़ेच करने का अनुरोध करता है.
fetch(url, params)HTTPResponseवैकल्पिक बेहतर पैरामीटर का इस्तेमाल करके, यूआरएल पाने का अनुरोध करता है.
fetchAll(requests)HTTPResponse[]वैकल्पिक बेहतर पैरामीटर का इस्तेमाल करके, कई यूआरएल पाने के लिए कई अनुरोध करता है.
getRequest(url)Objectअगर कार्रवाई शुरू की गई है, तो किया गया अनुरोध दिखाता है.
getRequest(url, params)Objectअगर कार्रवाई शुरू की गई है, तो किया गया अनुरोध दिखाता है.

ज़्यादा जानकारी वाले दस्तावेज़

fetch(url)

यूआरएल फ़ेच करने का अनुरोध करता है.

यह एचटीटीपी के साथ-साथ एचटीटीपीएस पर भी काम करता है.

// The code below logs the HTML code of the Google home page.
var response = UrlFetchApp.fetch("http://www.google.com/");
Logger.log(response.getContentText());

पैरामीटर

नामटाइपब्यौरा
urlStringफ़ेच किया जाने वाला यूआरएल.

Return

HTTPResponse — एचटीटीपी रिस्पॉन्स डेटा.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को नीचे दिए गए एक या ज़्यादा दायरे में अनुमति देनी होगी:

  • https://www.googleapis.com/auth/script.external_request

fetch(url, params)

वैकल्पिक बेहतर पैरामीटर का इस्तेमाल करके, यूआरएल पाने का अनुरोध करता है.

यह एचटीटीपी के साथ-साथ एचटीटीपीएस पर भी काम करता है.

// Make a GET request and log the returned content.
var response = UrlFetchApp.fetch('http://www.google.com/');
Logger.log(response.getContentText());
// Make a POST request with form data.
var resumeBlob = Utilities.newBlob('Hire me!', 'text/plain', 'resume.txt');
var formData = {
  'name': 'Bob Smith',
  'email': 'bob@example.com',
  'resume': resumeBlob
};
// Because payload is a JavaScript object, it is interpreted as
// as form data. (No need to specify contentType; it automatically
// defaults to either 'application/x-www-form-urlencoded'
// or 'multipart/form-data')
var options = {
  'method' : 'post',
  'payload' : formData
};
UrlFetchApp.fetch('https://httpbin.org/post', options);
// Make a POST request with a JSON payload.
var data = {
  'name': 'Bob Smith',
  'age': 35,
  'pets': ['fido', 'fluffy']
};
var options = {
  'method' : 'post',
  'contentType': 'application/json',
  // Convert the JavaScript object to a JSON string.
  'payload' : JSON.stringify(data)
};
UrlFetchApp.fetch('https://httpbin.org/post', options);

पैरामीटर

नामटाइपब्यौरा
urlStringफ़ेच किया जाने वाला यूआरएल.
paramsObjectवैकल्पिक JavaScript ऑब्जेक्ट, जो नीचे दिए गए बेहतर पैरामीटर के बारे में बताता है.

उन्नत पैरामीटर

नामटाइपब्यौरा
contentTypeStringकॉन्टेंट टाइप (डिफ़ॉल्ट तौर पर, और #39;application/x-www-form-urlencoded' डिफ़ॉल्ट). कॉन्टेंट टाइप का एक और उदाहरण है ##39;application/xml; charset=utf-8'.
headersObjectअनुरोध के लिए, एचटीटीपी हेडर की JavaScript कुंजी/वैल्यू मैप
methodStringअनुरोध के लिए एचटीटीपी तरीका: get, delete, patch, post या put. डिफ़ॉल्ट वैल्यू get है.
payloadStringअनुरोध के लिए पेलोड (यानी, POST बॉडी). कुछ एचटीटीपी तरीके (उदाहरण के लिए, जीईटी) पेलोड स्वीकार नहीं करते. यह स्ट्रिंग, बाइट कलेक्शन, ब्लॉब या JavaScript ऑब्जेक्ट हो सकता है. JavaScript ऑब्जेक्ट को वैल्यू के साथ मैप किए गए फ़ॉर्म फ़ील्ड के मैप के तौर पर समझा जाता है. इसमें वैल्यू, स्ट्रिंग या ब्लॉब हो सकती हैं.
useIntranetBooleanसमर्थन नहीं होना या रुकना. यह निर्देश SDC का इस्तेमाल करके आपके डोमेन से जुड़े इंट्रानेट में मौजूद यूआरएल के समाधान का निर्देश देता है.
validateHttpsCertificatesBooleanअगर false, एचटीटीपीएस अनुरोधों के लिए किसी भी अमान्य सर्टिफ़िकेट को अनदेखा कर देता है. डिफ़ॉल्ट वैल्यू true है.
followRedirectsBooleanअगर false, एचटीटीपी रीडायरेक्ट को अपने-आप फ़ॉलो नहीं करता है, तो यह मूल एचटीटीपी रिस्पॉन्स दिखाता है. डिफ़ॉल्ट वैल्यू true है.
muteHttpExceptionsBooleanअगर true फ़ेच करता है, तो अपवाद के तौर पर कोई रिस्पॉन्स नहीं मिलता, अगर रिस्पॉन्स कोड फ़ेल हो जाता है और HTTPResponse दिखाता है. डिफ़ॉल्ट वैल्यू false है.
escapingBooleanअगर यूआरएल में false रिज़र्व किए गए वर्ण हैं, तो इन्हें एस्केप नहीं किया जाता. डिफ़ॉल्ट वैल्यू true है.

Return

HTTPResponse — एचटीटीपी रिस्पॉन्स डेटा.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को नीचे दिए गए एक या ज़्यादा दायरे में अनुमति देनी होगी:

  • https://www.googleapis.com/auth/script.external_request

fetchAll(requests)

वैकल्पिक बेहतर पैरामीटर का इस्तेमाल करके, कई यूआरएल पाने के लिए कई अनुरोध करता है.

यह एचटीटीपी के साथ-साथ एचटीटीपीएस पर भी काम करता है.

// Make both a POST request with form data, and a GET request.
var resumeBlob = Utilities.newBlob('Hire me!', 'text/plain', 'resume.txt');
var formData = {
  'name': 'Bob Smith',
  'email': 'bob@example.com',
  'resume': resumeBlob
};
// Because payload is a JavaScript object, it is interpreted as
// as form data. (No need to specify contentType; it defaults to either
// 'application/x-www-form-urlencoded' or 'multipart/form-data')
var request1 = {
  'url': 'https://httpbin.org/post',
  'method' : 'post',
  'payload' : formData
};
// A request may also just be a URL.
var request2 = 'https://httpbin.org/get?key=value';
UrlFetchApp.fetchAll([request1, request2]);

पैरामीटर

नामटाइपब्यौरा
requestsObject[]यूआरएल या JavaScript ऑब्जेक्ट की कैटगरी, जिसमें नीचे दिए गए अनुरोधों के बारे में बताया गया है.

उन्नत पैरामीटर

नामटाइपब्यौरा
urlStringफ़ेच किया जाने वाला यूआरएल
contentTypeStringकॉन्टेंट टाइप (डिफ़ॉल्ट तौर पर, और #39;application/x-www-form-urlencoded' डिफ़ॉल्ट). कॉन्टेंट टाइप का एक और उदाहरण है ##39;application/xml; charset=utf-8'.
headersObjectअनुरोध के लिए, एचटीटीपी हेडर की JavaScript कुंजी/वैल्यू मैप
methodStringअनुरोध के लिए एचटीटीपी तरीका: get, delete, patch, post या put. डिफ़ॉल्ट वैल्यू get है.
payloadStringअनुरोध के लिए पेलोड (यानी, POST बॉडी). कुछ एचटीटीपी तरीके (उदाहरण के लिए, जीईटी) पेलोड स्वीकार नहीं करते. यह स्ट्रिंग, बाइट कलेक्शन, ब्लॉब या JavaScript ऑब्जेक्ट हो सकता है. JavaScript ऑब्जेक्ट को वैल्यू के साथ मैप किए गए फ़ॉर्म फ़ील्ड के मैप के तौर पर समझा जाता है. इसमें वैल्यू, स्ट्रिंग या ब्लॉब हो सकती हैं.
useIntranetBooleanसमर्थन नहीं होना या रुकना. यह निर्देश SDC का इस्तेमाल करके आपके डोमेन से जुड़े इंट्रानेट में मौजूद यूआरएल के समाधान का निर्देश देता है.
validateHttpsCertificatesBooleanअगर false, एचटीटीपीएस अनुरोधों के लिए किसी भी अमान्य सर्टिफ़िकेट को अनदेखा कर देता है. डिफ़ॉल्ट वैल्यू true है.
followRedirectsBooleanअगर false, एचटीटीपी रीडायरेक्ट को अपने-आप फ़ॉलो नहीं करता है, तो यह मूल एचटीटीपी रिस्पॉन्स दिखाता है. डिफ़ॉल्ट वैल्यू true है.
muteHttpExceptionsBooleanअगर true है, तो फ़ेच की मदद से गड़बड़ी का पता चलने पर, फ़ेच अपवाद के तौर पर HTTPResponse नहीं दिखाता है. डिफ़ॉल्ट वैल्यू false है.
escapingBooleanअगर false है, तो यूआरएल में रिज़र्व किए गए वर्णों को एस्केप नहीं किया जाता है. डिफ़ॉल्ट वैल्यू true है.

Return

HTTPResponse[] — हर इनपुट अनुरोध से मिले एचटीटीपी रिस्पॉन्स डेटा की कैटगरी.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को नीचे दिए गए एक या ज़्यादा दायरे में अनुमति देनी होगी:

  • https://www.googleapis.com/auth/script.external_request

getRequest(url)

अगर कार्रवाई शुरू की गई है, तो किया गया अनुरोध दिखाता है.

इस तरीके से असल में अनुरोध जारी नहीं होता है.

// The code below logs the value for every key of the returned map.
var response = UrlFetchApp.getRequest("http://www.google.com/");
for(i in response) {
  Logger.log(i + ": " + response[i]);
}

पैरामीटर

नामटाइपब्यौरा
urlStringदेखने के लिए यूआरएल.

Return

Object — वैल्यू के फ़ील्ड नाम का मैप. मैप में कम से कम ये कुंजियां हैं: url, method, contentType, payload, और headers.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को नीचे दिए गए एक या ज़्यादा दायरे में अनुमति देनी होगी:

  • https://www.googleapis.com/auth/script.external_request

getRequest(url, params)

अगर कार्रवाई शुरू की गई है, तो किया गया अनुरोध दिखाता है.

इस तरीके से असल में अनुरोध जारी नहीं होता है.

पैरामीटर

नामटाइपब्यौरा
urlStringदेखने के लिए यूआरएल.
paramsObjectएक वैकल्पिक JavaScript ऑब्जेक्ट है, जो नीचे दिए गए बेहतर पैरामीटर के बारे में बताता है.

उन्नत पैरामीटर

नामटाइपब्यौरा
contentTypeStringकॉन्टेंट टाइप (डिफ़ॉल्ट तौर पर, और #39;application/x-www-form-urlencoded' डिफ़ॉल्ट). कॉन्टेंट टाइप का एक और उदाहरण है ##39;application/xml; charset=utf-8'.
headersObjectअनुरोध के लिए, एचटीटीपी हेडर की JavaScript कुंजी/वैल्यू मैप
methodStringअनुरोध के लिए एचटीटीपी तरीका: get, delete, patch, post या put. डिफ़ॉल्ट वैल्यू get है.
payloadStringअनुरोध के लिए पेलोड (यानी, POST बॉडी). कुछ एचटीटीपी तरीके (उदाहरण के लिए, जीईटी) पेलोड स्वीकार नहीं करते. यह स्ट्रिंग, बाइट कलेक्शन, ब्लॉब या JavaScript ऑब्जेक्ट हो सकता है. JavaScript ऑब्जेक्ट को वैल्यू के साथ मैप किए गए फ़ॉर्म फ़ील्ड के मैप के तौर पर समझा जाता है. इसमें वैल्यू, स्ट्रिंग या ब्लॉब हो सकती हैं.
useIntranetBooleanसमर्थन नहीं होना या रुकना. यह निर्देश SDC का इस्तेमाल करके आपके डोमेन से जुड़े इंट्रानेट में मौजूद यूआरएल के समाधान का निर्देश देता है.
validateHttpsCertificatesBooleanअगर false, एचटीटीपीएस अनुरोधों के लिए किसी भी अमान्य सर्टिफ़िकेट को अनदेखा कर देता है. डिफ़ॉल्ट वैल्यू true है.
followRedirectsBooleanअगर false, एचटीटीपी रीडायरेक्ट को अपने-आप फ़ॉलो नहीं करता है, तो यह मूल एचटीटीपी रिस्पॉन्स दिखाता है. डिफ़ॉल्ट वैल्यू true है.
muteHttpExceptionsBooleanअगर true फ़ेच करता है, तो अपवाद के तौर पर कोई रिस्पॉन्स नहीं मिलता, अगर रिस्पॉन्स कोड फ़ेल हो जाता है और HTTPResponse दिखाता है. डिफ़ॉल्ट वैल्यू false है.
escapingBooleanअगर यूआरएल में false रिज़र्व किए गए वर्ण हैं, तो उन्हें एस्केप नहीं किया जाता. डिफ़ॉल्ट वैल्यू true है.

Return

Object — वैल्यू के फ़ील्ड नाम का मैप. मैप में कम से कम ये कुंजियां हैं: url, method, contentType, payload, और headers.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को नीचे दिए गए एक या ज़्यादा दायरे में अनुमति देनी होगी:

  • https://www.googleapis.com/auth/script.external_request