Class UrlFetchApp

קל לארגן דפים בעזרת אוספים אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
UrlFetchApp

אחזור משאבים ויצירת קשר עם מארחים אחרים באינטרנט.

השירות הזה מאפשר לסקריפטים לתקשר עם אפליקציות אחרות או לגשת למשאבים אחרים באינטרנט על ידי אחזור של כתובות URL. סקריפט יכול להשתמש בשירות 'אחזור כתובת URL' כדי לשלוח בקשות HTTP ו-HTTPS ולקבל תגובות. השירות של אחזור כתובות URL משתמש בתשתית הרשת של Google למטרות יעילות והתאמה לעומס.

בקשות שהוגשו באמצעות השירות הזה מגיעות ממאגר מוגדר של טווחי IP. תוכלו לחפש את הרשימה המלאה של כתובות ה-IP אם ברצונכם להוסיף לרשימת ההיתרים או לאשר את הבקשות האלה.

כדי להשתמש בשירות הזה צריך את ההיקף של https://www.googleapis.com/auth/script.external_request. ברוב המקרים, Apps Script מזהה באופן אוטומטי את ההיקפים הנחוצים לסקריפט וכולל אותו. עם זאת, אם אתם מגדירים את ההיקפים באופן מפורש, עליכם להוסיף את ההיקף הזה באופן ידני כדי להשתמש ב-UrlFetchApp.

למידע נוסף

שיטות

שיטהסוג הערך המוחזרתיאור קצר
fetch(url)HTTPResponseשולח בקשה לאחזור כתובת URL.
fetch(url, params)HTTPResponseמבקש לאחזר כתובת URL באמצעות פרמטרים מתקדמים אופציונליים.
fetchAll(requests)HTTPResponse[]מבצע בקשות מרובות לאחזור כתובות URL מרובות באמצעות פרמטרים אופציונליים אופציונליים.
getRequest(url)Objectמחזירה את הבקשה שבוצעה אם הפעולה הופעלה.
getRequest(url, params)Objectמחזירה את הבקשה שבוצעה אם הפעולה הופעלה.

תיעוד מפורט

fetch(url)

שולח בקשה לאחזור כתובת URL.

האפשרות הזו פועלת גם ב-HTTP וגם ב-HTTPS.

// 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כתובת ה-URL לאחזור.

מקש Return

HTTPResponse — נתוני התגובה ל-HTTP.

הרשאה

סקריפטים שמשתמשים בשיטה זו מחייבים הרשאה באמצעות אחד או יותר מההיקפים הבאים:

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

fetch(url, params)

מבקש לאחזר כתובת URL באמצעות פרמטרים מתקדמים אופציונליים.

האפשרות הזו פועלת גם ב-HTTP וגם ב-HTTPS.

// 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כתובת ה-URL לאחזור.
paramsObjectאובייקט ה-JavaScript האופציונלי המציין פרמטרים מתקדמים כפי שמוגדר בהמשך.

פרמטרים מתקדמים

שםסוגתיאור
contentTypeStringסוג התוכן (ברירת המחדל היא 'application/x-www-form-url-encoded'). דוגמה נוספת לסוג התוכן היא 'application/xml; charset=utf-8'.
headersObjectמפתח/ערך JavaScript של כותרות HTTP עבור הבקשה
methodStringשיטת ה-HTTP עבור הבקשה: get, delete, patch, post או put. ברירת המחדל היא get.
payloadStringהמטען הייעודי (כלומר, גוף ה-POST) של הבקשה. שיטות HTTP מסוימות (לדוגמה, GET) לא מקבלות מטען ייעודי (payload). היא יכולה להיות מחרוזת, מערך בייט, blob או אובייקט JavaScript. אובייקט JavaScript מפורש כמפה של שמות שדות בערכים, כאשר הערכים יכולים להיות מחרוזות או blobs.
useIntranetBooleanהוּצא משימוש. פעולה זו מורה לאחזור כתובת ה-URL שצוינה באינטראנט של הדומיין שלך (הוצאה משימוש) SDC
validateHttpsCertificatesBooleanאם המזהה false מתעלם מאישורים לא חוקיים של בקשות HTTPS. ברירת המחדל היא true.
followRedirectsBooleanאם false לא מאחזר אוטומטית את הפניה אוטומטית של HTTP, הוא יחזיר את תגובת HTTP המקורית. ברירת המחדל היא true.
muteHttpExceptionsBooleanאם הפרמטר true לא מאחזר חריג אם קוד התגובה מצביע על כשל, ובמקום זאת מחזיר את HTTPResponse. ברירת המחדל היא false.
escapingBooleanאם false תווים שמורים בכתובת ה-URL לא מסומנים בתווי בריחה (escape) ברירת המחדל היא true.

מקש Return

HTTPResponse — נתוני התגובה ל-HTTP.

הרשאה

סקריפטים שמשתמשים בשיטה זו מחייבים הרשאה באמצעות אחד או יותר מההיקפים הבאים:

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

fetchAll(requests)

מבצע בקשות מרובות לאחזור כתובות URL מרובות באמצעות פרמטרים אופציונליים אופציונליים.

האפשרות הזו פועלת גם ב-HTTP וגם ב-HTTPS.

// 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[]מערך של כתובות URL או אובייקטים של JavaScript, המציינים בקשות כפי שמוגדר בהמשך.

פרמטרים מתקדמים

שםסוגתיאור
urlStringכתובת ה-URL לאחזור
contentTypeStringסוג התוכן (ברירת המחדל היא 'application/x-www-form-url-encoded'). דוגמה נוספת לסוג התוכן היא 'application/xml; charset=utf-8'.
headersObjectמפתח/ערך JavaScript של כותרות HTTP עבור הבקשה
methodStringשיטת ה-HTTP עבור הבקשה: get, delete, patch, post או put. ברירת המחדל היא get.
payloadStringהמטען הייעודי (כלומר, גוף ה-POST) של הבקשה. שיטות HTTP מסוימות (לדוגמה, GET) לא מקבלות מטען ייעודי (payload). היא יכולה להיות מחרוזת, מערך בייט, blob או אובייקט JavaScript. אובייקט JavaScript מפורש כמפה של שמות שדות בערכים, כאשר הערכים יכולים להיות מחרוזות או blobs.
useIntranetBooleanהוּצא משימוש. פעולה זו מורה לאחזור כתובת ה-URL שצוינה באינטראנט של הדומיין שלך (הוצאה משימוש) SDC
validateHttpsCertificatesBooleanאם המזהה false מתעלם מאישורים לא חוקיים של בקשות HTTPS. ברירת המחדל היא true.
followRedirectsBooleanאם false לא מאחזר אוטומטית את הפניה אוטומטית של HTTP, הוא יחזיר את תגובת HTTP המקורית. ברירת המחדל היא true.
muteHttpExceptionsBooleanאם הפרמטר true, האחזור לא יגרום לחריג אם קוד התגובה מעיד על כשל, ובמקום זאת מחזיר את HTTPResponse. ברירת המחדל היא false.
escapingBooleanאם מזינים false, תווים שמורים בכתובת ה-URL לא מסומנים בתווי בריחה (escape). ברירת המחדל היא true.

מקש Return

HTTPResponse[] — מערך של נתוני תגובות HTTP מכל בקשת קלט.

הרשאה

סקריפטים שמשתמשים בשיטה זו מחייבים הרשאה באמצעות אחד או יותר מההיקפים הבאים:

  • 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כתובת ה-URL לחיפוש.

מקש Return

Object — מפה של שם השדה לערך. המפה כוללת לפחות את המפתחות הבאים: url, method, contentType, payload ו-headers.

הרשאה

סקריפטים שמשתמשים בשיטה זו מחייבים הרשאה באמצעות אחד או יותר מההיקפים הבאים:

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

getRequest(url, params)

מחזירה את הבקשה שבוצעה אם הפעולה הופעלה.

שיטה זו לא שולחת את הבקשה בפועל.

פרמטרים

שםסוגתיאור
urlStringכתובת ה-URL לחיפוש.
paramsObjectאובייקט אופציונלי של JavaScript המציין פרמטרים מתקדמים, כפי שמוגדר בהמשך.

פרמטרים מתקדמים

שםסוגתיאור
contentTypeStringסוג התוכן (ברירת המחדל היא 'application/x-www-form-url-encoded'). דוגמה נוספת לסוג התוכן היא 'application/xml; charset=utf-8'.
headersObjectמפתח/ערך JavaScript של כותרות HTTP עבור הבקשה
methodStringשיטת ה-HTTP עבור הבקשה: get, delete, patch, post או put. ברירת המחדל היא get.
payloadStringהמטען הייעודי (כלומר, גוף ה-POST) של הבקשה. שיטות HTTP מסוימות (לדוגמה, GET) לא מקבלות מטען ייעודי (payload). היא יכולה להיות מחרוזת, מערך בייט, blob או אובייקט JavaScript. אובייקט JavaScript מפורש כמפה של שמות שדות בערכים, כאשר הערכים יכולים להיות מחרוזות או blobs.
useIntranetBooleanהוּצא משימוש. פעולה זו מורה לאחזור כתובת ה-URL שצוינה באינטראנט של הדומיין שלך (הוצאה משימוש) SDC
validateHttpsCertificatesBooleanאם המזהה false מתעלם מאישורים לא חוקיים של בקשות HTTPS. ברירת המחדל היא true.
followRedirectsBooleanאם false לא מאחזר אוטומטית את הפניה אוטומטית של HTTP, הוא יחזיר את תגובת HTTP המקורית. ברירת המחדל היא true.
muteHttpExceptionsBooleanאם הפרמטר true לא מאחזר חריג אם קוד התגובה מצביע על כשל, ובמקום זאת מחזיר את HTTPResponse. ברירת המחדל היא false.
escapingBooleanאם התווים false השמורים בכתובת ה-URL לא מסומנים בתווי בריחה (escape) ברירת המחדל היא true.

מקש Return

Object — מפה של שם השדה לערך. המפה כוללת לפחות את המפתחות הבאים: url, method, contentType, payload ו-headers.

הרשאה

סקריפטים שמשתמשים בשיטה זו מחייבים הרשאה באמצעות אחד או יותר מההיקפים הבאים:

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