Tìm nạp tài nguyên và giao tiếp với các máy chủ lưu trữ khác qua Internet.
Dịch vụ này cho phép tập lệnh giao tiếp với các ứng dụng khác hoặc truy cập vào các tài nguyên khác trên web bằng cách tìm nạp URL. Tập lệnh có thể sử dụng dịch vụ Tìm nạp URL để đưa ra các yêu cầu HTTP và HTTPS, đồng thời nhận phản hồi. Dịch vụ Tìm nạp URL sử dụng cơ sở hạ tầng mạng của Google để tăng hiệu quả và khả năng mở rộng.
Các yêu cầu được thực hiện bằng dịch vụ này bắt nguồn từ một nhóm dải IP cố định. Bạn có thể tra cứu danh sách đầy đủ các địa chỉ IP nếu cần đưa các yêu cầu này vào danh sách cho phép hoặc phê duyệt.
Dịch vụ này yêu cầu phạm vi https://www.googleapis.com/auth/script.external_request. Trong hầu hết các trường hợp, Apps Script sẽ tự động phát hiện và đưa các phạm vi mà một tập lệnh cần vào, nhưng nếu đặt phạm vi một cách rõ ràng, bạn phải thêm phạm vi này theo cách thủ công để sử dụng UrlFetchApp.
Xem thêm
Phương thức
| Phương thức | Kiểu dữ liệu trả về | Mô tả ngắn |
|---|---|---|
fetch(url) | HTTPResponse | Đưa ra yêu cầu tìm nạp một URL. |
fetch(url, params) | HTTPResponse | Đưa ra yêu cầu tìm nạp một URL bằng các tham số nâng cao không bắt buộc. |
fetch | HTTPResponse[] | Đưa ra nhiều yêu cầu để tìm nạp nhiều URL bằng các tham số nâng cao không bắt buộc. |
get | Object | Trả về yêu cầu được thực hiện nếu thao tác được gọi. |
get | Object | Trả về yêu cầu được thực hiện nếu thao tác được gọi. |
Tài liệu chi tiết
fetch(url)
Đưa ra yêu cầu tìm nạp một URL.
Điều này hoạt động trên cả HTTP và 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());
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
url | String | URL cần tìm nạp. URL có thể có tối đa 2.082 ký tự. |
Cầu thủ trả bóng
HTTPResponse – Dữ liệu phản hồi HTTP.
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/script.external_request
fetch(url, params)
Đưa ra yêu cầu tìm nạp một URL bằng các tham số nâng cao không bắt buộc.
Điều này hoạt động trên cả HTTP và 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);
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
url | String | URL cần tìm nạp. URL có thể có tối đa 2.082 ký tự. |
params | Object | Đối tượng JavaScript không bắt buộc chỉ định các tham số nâng cao như được xác định bên dưới. |
Thông số nâng cao
| Tên | Loại | Mô tả |
|---|---|---|
content | String | loại nội dung (mặc định là "application/x-www-form-urlencoded"). Một ví dụ khác về loại nội dung là "application/xml; charset=utf-8". |
headers | Object | một bản đồ khoá/giá trị JavaScript của tiêu đề HTTP cho yêu cầu |
method | String | phương thức HTTP cho yêu cầu: get, delete, patch, post hoặc put. Giá trị mặc định là get. |
payload | String | tải trọng (tức là nội dung POST) cho yêu cầu. Một số phương thức HTTP (ví dụ: GET) không chấp nhận tải trọng. Đây có thể là một chuỗi, một mảng byte, một blob hoặc một đối tượng JavaScript. Đối tượng JavaScript được diễn giải dưới dạng bản đồ tên trường biểu mẫu thành giá trị, trong đó giá trị có thể là chuỗi hoặc blob. |
use | Boolean | Không dùng nữa. Thao tác này hướng dẫn lệnh tìm nạp phân giải URL được chỉ định trong mạng nội bộ được liên kết với miền của bạn thông qua SDC (không dùng nữa) |
validate | Boolean | Nếu false, quá trình tìm nạp sẽ bỏ qua mọi chứng chỉ không hợp lệ cho các yêu cầu HTTPS. Giá trị mặc định là true. |
follow | Boolean | Nếu false, lệnh tìm nạp sẽ không tự động tuân theo các lệnh chuyển hướng HTTP; lệnh này sẽ trả về phản hồi HTTP ban đầu. Giá trị mặc định là true. |
mute | Boolean | Nếu true, lệnh tìm nạp sẽ không gửi một ngoại lệ nếu mã phản hồi cho biết lỗi, mà thay vào đó sẽ trả về HTTPResponse. Giá trị mặc định là false. |
escaping | Boolean | Nếu false ký tự dành riêng trong URL không được thoát. Giá trị mặc định là true. |
Cầu thủ trả bóng
HTTPResponse – Dữ liệu phản hồi HTTP.
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/script.external_request
fetchAll(requests)
Đưa ra nhiều yêu cầu để tìm nạp nhiều URL bằng các tham số nâng cao không bắt buộc.
Điều này hoạt động trên cả HTTP và 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]);
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
requests | Object[] | Một mảng gồm các URL hoặc đối tượng JavaScript chỉ định các yêu cầu như được xác định bên dưới. |
Thông số nâng cao
| Tên | Loại | Mô tả |
|---|---|---|
url | String | URL cần tìm nạp. URL có thể có tối đa 2.082 ký tự. |
content | String | loại nội dung (mặc định là "application/x-www-form-urlencoded"). Một ví dụ khác về loại nội dung là "application/xml; charset=utf-8". |
headers | Object | một bản đồ khoá/giá trị JavaScript của tiêu đề HTTP cho yêu cầu |
method | String | phương thức HTTP cho yêu cầu: get, delete, patch, post hoặc put. Giá trị mặc định là get. |
payload | String | tải trọng (tức là nội dung POST) cho yêu cầu. Một số phương thức HTTP (ví dụ: GET) không chấp nhận tải trọng. Đây có thể là một chuỗi, một mảng byte, một blob hoặc một đối tượng JavaScript. Đối tượng JavaScript được diễn giải dưới dạng bản đồ tên trường biểu mẫu thành giá trị, trong đó giá trị có thể là chuỗi hoặc blob. |
use | Boolean | Không dùng nữa. Thao tác này hướng dẫn lệnh tìm nạp phân giải URL được chỉ định trong mạng nội bộ được liên kết với miền của bạn thông qua SDC (không dùng nữa) |
validate | Boolean | Nếu false, quá trình tìm nạp sẽ bỏ qua mọi chứng chỉ không hợp lệ cho các yêu cầu HTTPS. Giá trị mặc định là true. |
follow | Boolean | Nếu false, lệnh tìm nạp sẽ không tự động tuân theo các lệnh chuyển hướng HTTP; lệnh này sẽ trả về phản hồi HTTP ban đầu. Giá trị mặc định là true. |
mute | Boolean | Nếu true, lệnh tìm nạp sẽ không gửi một ngoại lệ nếu mã phản hồi cho biết lỗi, mà thay vào đó sẽ trả về HTTPResponse. Giá trị mặc định là false. |
escaping | Boolean | Nếu false, các ký tự dành riêng trong URL sẽ không được thoát. Giá trị mặc định là true. |
Cầu thủ trả bóng
HTTPResponse[] – Một mảng dữ liệu phản hồi HTTP từ mỗi yêu cầu đầu vào.
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/script.external_request
getRequest(url)
Trả về yêu cầu được thực hiện nếu thao tác được gọi.
Phương thức này không thực sự đưa ra yêu cầu.
// 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]}`); }
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
url | String | URL cần tra cứu. URL có thể có tối đa 2.082 ký tự. |
Cầu thủ trả bóng
Object – Bản đồ Tên trường đến Giá trị. Bản đồ có ít nhất các khoá sau: url, method, contentType, payload và headers.
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/script.external_request
getRequest(url, params)
Trả về yêu cầu được thực hiện nếu thao tác được gọi.
Phương thức này không thực sự đưa ra yêu cầu.
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
url | String | URL cần tra cứu. URL có thể có tối đa 2.082 ký tự. |
params | Object | Một đối tượng JavaScript không bắt buộc, chỉ định các tham số nâng cao như được xác định bên dưới. |
Thông số nâng cao
| Tên | Loại | Mô tả |
|---|---|---|
content | String | loại nội dung (mặc định là "application/x-www-form-urlencoded"). Một ví dụ khác về loại nội dung là "application/xml; charset=utf-8". |
headers | Object | một bản đồ khoá/giá trị JavaScript của tiêu đề HTTP cho yêu cầu |
method | String | phương thức HTTP cho yêu cầu: get, delete, patch, post hoặc put. Giá trị mặc định là get. |
payload | String | tải trọng (tức là nội dung POST) cho yêu cầu. Một số phương thức HTTP (ví dụ: GET) không chấp nhận tải trọng. Đây có thể là một chuỗi, một mảng byte, một blob hoặc một đối tượng JavaScript. Đối tượng JavaScript được diễn giải dưới dạng bản đồ tên trường biểu mẫu thành giá trị, trong đó giá trị có thể là chuỗi hoặc blob. |
use | Boolean | Không dùng nữa. Thao tác này hướng dẫn lệnh tìm nạp phân giải URL được chỉ định trong mạng nội bộ được liên kết với miền của bạn thông qua SDC (không dùng nữa) |
validate | Boolean | Nếu false, quá trình tìm nạp sẽ bỏ qua mọi chứng chỉ không hợp lệ cho các yêu cầu HTTPS. Giá trị mặc định là true. |
follow | Boolean | Nếu false, lệnh tìm nạp sẽ không tự động tuân theo các lệnh chuyển hướng HTTP; lệnh này sẽ trả về phản hồi HTTP ban đầu. Giá trị mặc định là true. |
mute | Boolean | Nếu true, lệnh tìm nạp sẽ không gửi một ngoại lệ nếu mã phản hồi cho biết lỗi, mà thay vào đó sẽ trả về HTTPResponse. Giá trị mặc định là false. |
escaping | Boolean | Nếu false ký tự dành riêng trong URL không được thoát. Giá trị mặc định là true. |
Cầu thủ trả bóng
Object – Bản đồ Tên trường đến Giá trị. Bản đồ có ít nhất các khoá sau: url, method, contentType, payload và headers.
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/script.external_request