このページは Cloud Translation API によって翻訳されました。

Class UrlFetchApp

リソースを取得し、インターネット経由で他のホストと通信します。

このサービスを使用すると、スクリプトは URL を取得して他のアプリケーションと通信したり、ウェブ上の他のリソースにアクセスしたりできます。スクリプトは、URL 取得サービスを使用して HTTP と HTTPS リクエストを送信し、レスポンスを受信できます。URL 取得サービスは、効率性とスケーリングのために Google のネットワークインフラストラクチャを使用します。

このサービスを使用して送信されるリクエストは、設定された IP 範囲のプールから送信されます。これらのリクエストを許可リストに登録または承認する必要がある場合は、IP アドレスの完全なリストを検索できます。

このサービスには https://www.googleapis.com/auth/script.external_request スコープが必要です。ほとんどの場合、スクリプトに必要なスコープは自動的に検出され、含まれますが、スコープを明示的に設定している場合は、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.
const response = UrlFetchApp.fetch('http://www.google.com/');
Logger.log(response.getContentText());

パラメータ

名前	型	説明
`url`	`String`	取得する URL。URL の文字数は 2,082 文字までです。

戻る

HTTPResponse - HTTP レスポンスデータ。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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`	リクエストの HTTP ヘッダーの JavaScript キー/値マップ
`method`	`String`	リクエストの HTTP メソッド: `get`、`delete`、`patch`、`post`、`put`。デフォルトは `get` です。
`payload`	`String`	リクエストのペイロード（POST 本文）。特定の HTTP メソッド（GET など）はペイロードを受け入れません。文字列、バイト配列、BLOB、JavaScript オブジェクトのいずれかです。JavaScript オブジェクトは、フォームフィールド名と値のマップとして解釈されます。値は文字列または blob のいずれかです。
`useIntranet`	`Boolean`	非推奨です。これにより、（非推奨の）SDC を介してドメインにリンクされたイントラネット内の指定された URL を解決するようにフェッチに指示します。
`validateHttpsCertificates`	`Boolean`	`false` の場合、フェッチは HTTPS リクエストの無効な証明書を無視します。デフォルトは `true` です。
`followRedirects`	`Boolean`	`false` の場合、取得は HTTP リダイレクトに自動的に従わず、元の HTTP レスポンスを返します。デフォルトは `true` です。
`muteHttpExceptions`	`Boolean`	`true` の場合、レスポンスコードが失敗を示しても、取得は例外をスローせず、代わりに `HTTPResponse` を返します。デフォルトは `false` です。
`escaping`	`Boolean`	URL 内の `false` 予約文字がエスケープされていない場合。デフォルトは `true` です。

戻る

HTTPResponse - HTTP レスポンスデータ。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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`	リクエストの HTTP ヘッダーの JavaScript キー/値マップ
`method`	`String`	リクエストの HTTP メソッド: `get`、`delete`、`patch`、`post`、`put`。デフォルトは `get` です。
`payload`	`String`	リクエストのペイロード（POST 本文）。特定の HTTP メソッド（GET など）はペイロードを受け入れません。文字列、バイト配列、BLOB、JavaScript オブジェクトのいずれかです。JavaScript オブジェクトは、フォームフィールド名と値のマップとして解釈されます。値は文字列または blob のいずれかです。
`useIntranet`	`Boolean`	非推奨です。これにより、（非推奨の）SDC を介してドメインにリンクされたイントラネット内の指定された URL を解決するようにフェッチに指示します。
`validateHttpsCertificates`	`Boolean`	`false` の場合、フェッチは HTTPS リクエストの無効な証明書を無視します。デフォルトは `true` です。
`followRedirects`	`Boolean`	`false` の場合、取得は HTTP リダイレクトに自動的に従わず、元の HTTP レスポンスを返します。デフォルトは `true` です。
`muteHttpExceptions`	`Boolean`	`true` の場合、レスポンスコードが失敗を示している場合、取得は例外をスローせず、代わりに `HTTPResponse` を返します。デフォルトは `false` です。
`escaping`	`Boolean`	`false` の場合、URL 内の予約文字はエスケープされません。デフォルトは `true` です。

戻る

HTTPResponse[] - 各入力リクエストの HTTP レスポンスデータの配列。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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 のキーがあります。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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`	リクエストの HTTP ヘッダーの JavaScript キー/値マップ
`method`	`String`	リクエストの HTTP メソッド: `get`、`delete`、`patch`、`post`、`put`。デフォルトは `get` です。
`payload`	`String`	リクエストのペイロード（POST 本文）。特定の HTTP メソッド（GET など）はペイロードを受け入れません。文字列、バイト配列、BLOB、JavaScript オブジェクトのいずれかです。JavaScript オブジェクトは、フォームフィールド名と値のマップとして解釈されます。値は文字列または blob のいずれかです。
`useIntranet`	`Boolean`	非推奨です。これにより、（非推奨の）SDC を介してドメインにリンクされたイントラネット内の指定された URL を解決するようにフェッチに指示します。
`validateHttpsCertificates`	`Boolean`	`false` の場合、フェッチは HTTPS リクエストの無効な証明書を無視します。デフォルトは `true` です。
`followRedirects`	`Boolean`	`false` の場合、取得は HTTP リダイレクトに自動的に従わず、元の HTTP レスポンスを返します。デフォルトは `true` です。
`muteHttpExceptions`	`Boolean`	`true` の場合、レスポンスコードが失敗を示しても、取得は例外をスローせず、代わりに `HTTPResponse` を返します。デフォルトは `false` です。
`escaping`	`Boolean`	URL 内の `false` 予約文字がエスケープされていない場合。デフォルトは `true` です。

戻る

Object - フィールド名と値のマップ。マップには、少なくとも url、method、contentType、payload、headers のキーがあります。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

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

Class UrlFetchApp

関連情報

メソッド

詳細なドキュメント

fetch(url)

パラメータ

戻る

承認

fetch(url, params)

パラメータ

拡張パラメータ

戻る

承認

fetchAll(requests)

パラメータ

拡張パラメータ

戻る

承認

getRequest(url)

パラメータ

戻る

承認

getRequest(url, params)

パラメータ

拡張パラメータ

戻る

承認

`fetch(url)`

`fetch(url, params)`

`fetchAll(requests)`

`getRequest(url)`

`getRequest(url, params)`