דף זה תורגם על ידי Cloud Translation API.

Class UrlFetchApp

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

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

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

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

ראה גם

Methods

שיטה	סוג הערך המוחזר	תיאור קצר
`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.
const response = UrlFetchApp.fetch('http://www.google.com/');
Logger.log(response.getContentText());

פרמטרים

שם	סוג	תיאור
`url`	`String`	כתובת ה-URL לאחזור. כתובת ה-URL יכולה להכיל עד 2,082 תווים.

חזרה

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.
const response = UrlFetchApp.fetch('http://www.google.com/');
Logger.log(response.getContentText());

// Make a POST request with form data.
const resumeBlob = Utilities.newBlob('Hire me!', 'text/plain', 'resume.txt');
const 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')
const options = {
  method: 'post',
  payload: formData,
};
UrlFetchApp.fetch('https://httpbin.org/post', options);

// Make a POST request with a JSON payload.
const data = {
  name: 'Bob Smith',
  age: 35,
  pets: ['fido', 'fluffy'],
};
const 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);

פרמטרים

שם	סוג	תיאור
`url`	`String`	כתובת ה-URL לאחזור. כתובת ה-URL יכולה להכיל עד 2,082 תווים.
`params`	`Object`	אובייקט JavaScript אופציונלי שצוין בו פרמטרים מתקדמים כפי שמוגדר בהמשך.

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

שם	סוג	תיאור
`contentType`	`String`	סוג התוכן (ברירת המחדל היא 'application/x-www-form-urlencoded'). דוגמה נוספת לסוג תוכן היא 'application/xml; charset=utf-8'.
`headers`	`Object`	מפת מפתח/ערך של JavaScript של כותרות HTTP לבקשה
`method`	`String`	שיטת ה-HTTP של הבקשה: `get`,‏ `delete`,‏ `patch`,‏ `post` או `put`. ערך ברירת המחדל הוא `get`.
`payload`	`String`	עומס העבודה (כלומר גוף ה-POST) של הבקשה. שיטות HTTP מסוימות (לדוגמה, GET) לא מקבלות עומס שימושי. הוא יכול להיות מחרוזת, מערך בייטים, blob או אובייקט JavaScript. אובייקט JavaScript מפורש כמפה של שמות שדות טופס לערכים, כאשר הערכים יכולים להיות מחרוזות או blobs.
`useIntranet`	`Boolean`	הוצא משימוש. הפקודה הזו מורה על פתרון של כתובת ה-URL שצוינה בתוך הרשת הפנימית המקושרת לדומיין שלכם דרך SDC (הוצא משימוש)
`validateHttpsCertificates`	`Boolean`	אם `false`, האחזור מתעלם מאישורים לא תקינים לבקשות HTTPS. ערך ברירת המחדל הוא `true`.
`followRedirects`	`Boolean`	אם `false` האחזור לא עוקב באופן אוטומטי אחרי הפניות HTTP, הוא מחזיר את התגובה המקורית של HTTP. ערך ברירת המחדל הוא `true`.
`muteHttpExceptions`	`Boolean`	אם `true` האחזור לא יגרום להשלכת חריג אם קוד התגובה מציין כישלון, ובמקום זאת יחזיר את `HTTPResponse`. ערך ברירת המחדל הוא `false`.
`escaping`	`Boolean`	אם תווים `false` שמורים בכתובת ה-URL לא מסומנים בתווי בריחה (escape). ערך ברירת המחדל הוא `true`.

חזרה

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.
const resumeBlob = Utilities.newBlob('Hire me!', 'text/plain', 'resume.txt');
const 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')
const request1 = {
  url: 'https://httpbin.org/post',
  method: 'post',
  payload: formData,
};
// A request may also just be a URL.
const request2 = 'https://httpbin.org/get?key=value';
UrlFetchApp.fetchAll([request1, request2]);

פרמטרים

שם	סוג	תיאור
`requests`	`Object[]`	מערך של כתובות URL או אובייקטים של JavaScript שמציינים בקשות כפי שמתואר בהמשך.

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

שם	סוג	תיאור
`url`	`String`	כתובת ה-URL לאחזור. כתובת ה-URL יכולה להכיל עד 2,082 תווים.
`contentType`	`String`	סוג התוכן (ברירת המחדל היא 'application/x-www-form-urlencoded'). דוגמה נוספת לסוג תוכן היא 'application/xml; charset=utf-8'.
`headers`	`Object`	מפת מפתח/ערך של JavaScript של כותרות HTTP לבקשה
`method`	`String`	שיטת ה-HTTP של הבקשה: `get`,‏ `delete`,‏ `patch`,‏ `post` או `put`. ערך ברירת המחדל הוא `get`.
`payload`	`String`	עומס העבודה (כלומר גוף ה-POST) של הבקשה. שיטות HTTP מסוימות (לדוגמה, GET) לא מקבלות עומס שימושי. הוא יכול להיות מחרוזת, מערך בייטים, blob או אובייקט JavaScript. אובייקט JavaScript מפורש כמפה של שמות שדות טופס לערכים, כאשר הערכים יכולים להיות מחרוזות או blobs.
`useIntranet`	`Boolean`	הוצא משימוש. הפקודה הזו מורה על פתרון של כתובת ה-URL שצוינה בתוך הרשת הפנימית המקושרת לדומיין שלכם באמצעות SDC (הוצא משימוש)
`validateHttpsCertificates`	`Boolean`	אם `false`, האחזור מתעלם מאישורים לא תקינים לבקשות HTTPS. ערך ברירת המחדל הוא `true`.
`followRedirects`	`Boolean`	אם `false` האחזור לא עוקב באופן אוטומטי אחרי הפניות HTTP, הוא מחזיר את תגובת ה-HTTP המקורית. ערך ברירת המחדל הוא `true`.
`muteHttpExceptions`	`Boolean`	אם הערך הוא `true`, האחזור לא יגרום להשלכת חריגה אם קוד התגובה מציין כישלון, ובמקום זאת יוחזר הערך `HTTPResponse`. ערך ברירת המחדל הוא `false`.
`escaping`	`Boolean`	אם הערך הוא `false`, תווים שמורים בכתובת ה-URL לא מסומנים בתווי בריחה. ערך ברירת המחדל הוא `true`.

חזרה

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.
const response = UrlFetchApp.getRequest('http://www.google.com/');
for (const i in response) {
  Logger.log(`${i}: ${response[i]}`);
}

פרמטרים

שם	סוג	תיאור
`url`	`String`	כתובת ה-URL לחיפוש. כתובת ה-URL יכולה להכיל עד 2,082 תווים.

חזרה

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

אישור

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

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

`getRequest(url, params)`

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

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

פרמטרים

שם	סוג	תיאור
`url`	`String`	כתובת ה-URL לחיפוש. כתובת ה-URL יכולה להכיל עד 2,082 תווים.
`params`	`Object`	אובייקט JavaScript אופציונלי שצוין בו פרמטרים מתקדמים כפי שמוגדר בהמשך.

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

שם	סוג	תיאור
`contentType`	`String`	סוג התוכן (ברירת המחדל היא 'application/x-www-form-urlencoded'). דוגמה נוספת לסוג תוכן היא 'application/xml; charset=utf-8'.
`headers`	`Object`	מפת מפתח/ערך של JavaScript של כותרות HTTP לבקשה
`method`	`String`	שיטת ה-HTTP של הבקשה: `get`,‏ `delete`,‏ `patch`,‏ `post` או `put`. ערך ברירת המחדל הוא `get`.
`payload`	`String`	עומס העבודה (כלומר גוף ה-POST) של הבקשה. שיטות HTTP מסוימות (לדוגמה, GET) לא מקבלות עומס שימושי. הוא יכול להיות מחרוזת, מערך בייטים, blob או אובייקט JavaScript. אובייקט JavaScript מפורש כמפה של שמות שדות טופס לערכים, כאשר הערכים יכולים להיות מחרוזות או blobs.
`useIntranet`	`Boolean`	הוצא משימוש. הפקודה הזו מורה על פתרון של כתובת ה-URL שצוינה בתוך הרשת הפנימית המקושרת לדומיין שלכם דרך SDC (הוצא משימוש)
`validateHttpsCertificates`	`Boolean`	אם `false`, האחזור מתעלם מאישורים לא תקינים לבקשות HTTPS. ערך ברירת המחדל הוא `true`.
`followRedirects`	`Boolean`	אם `false` האחזור לא עוקב באופן אוטומטי אחרי הפניות HTTP, הוא מחזיר את התגובה המקורית של HTTP. ערך ברירת המחדל הוא `true`.
`muteHttpExceptions`	`Boolean`	אם `true`, האחזור לא יגרום להשלכה של חריג אם קוד התגובה מציין כישלון, ובמקום זאת יחזיר את `HTTPResponse`. ערך ברירת המחדל הוא `false`.
`escaping`	`Boolean`	אם התווים השמורים `false` בכתובת ה-URL לא מסומנים בתווי בריחה. ערך ברירת המחדל הוא `true`.

חזרה

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

אישור

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

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