Class UrlFetchApp

addOAuthService(serviceName)

Registers the given service name with the OAuth configuration and returns the newly created OAuthConfig object for an OAuth service with the given name.

 

 var oAuthConfig = UrlFetchApp.addOAuthService("twitter");
 oAuthConfig.setAccessTokenUrl("https://api.twitter.com/oauth/access_token");
 oAuthConfig.setRequestTokenUrl("https://api.twitter.com/oauth/request_token");
 oAuthConfig.setAuthorizationUrl("https://api.twitter.com/oauth/authorize");
 oAuthConfig.setConsumerKey(ScriptProperties.getProperty("twitterConsumerKey"));
 oAuthConfig.setConsumerSecret(ScriptProperties.getProperty("twitterConsumerSecret"));
 

Parameters

Return

OAuthConfig — a configuration object

fetch(url)

Makes a request to fetch a URL. This works over HTTP as well as 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());
 

Parameters

Return

HTTPResponse — the HTTP response data

fetch(url, params)

Makes a request to fetch a URL using optional advanced parameters. This works over HTTP as well as 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());
 

 

 // This sample pulls in your tweets from Twitter and puts them in a spreadsheet.
 //
 //  First: set up Script Properties "twitterConsumerKey" and
 // "twitterConsumerSecret" with values provided to you by Twitter.

 var fields = {'in_reply_to_screen_name':true,'created_at':true,'text':true};

 function tweet() {
   // Setup OAuthServiceConfig
   var oAuthConfig = UrlFetchApp.addOAuthService("twitter");
   oAuthConfig.setAccessTokenUrl("https://api.twitter.com/oauth/access_token");
   oAuthConfig.setRequestTokenUrl("https://api.twitter.com/oauth/request_token");
   oAuthConfig.setAuthorizationUrl("https://api.twitter.com/oauth/authorize");
   oAuthConfig.setConsumerKey(ScriptProperties.getProperty("twitterConsumerKey"));
   oAuthConfig.setConsumerSecret(ScriptProperties.getProperty("twitterConsumerSecret"));

   // Setup optional parameters to point request at OAuthConfigService.  The "twitter"
   // value matches the argument to "addOAuthService" above.
   var options =
     {
       "oAuthServiceName" : "twitter",
       "oAuthUseToken" : "always"
     };

   var result = UrlFetchApp.fetch("https://api.twitter.com/1.1/statuses/user_timeline.json",
       options);
   var o  = Utilities.jsonParse(result.getContentText());
   var doc = SpreadsheetApp.getActiveSpreadsheet();
   var cell = doc.getRange('a1');
   var index = 0;
   for (var i in o) {
     var row = o[i];
     var col = 0;
     for (var j in row) {
       if (fields[j]) {
         cell.offset(index, col).setValue(row[j]);
         col++;
       }
     }
     index++;
   }
 }
 

 

 // This sample sends POST payload data in the style of an HTML form, including
 // a file.

 function sendHttpPost() {

   // Download a file now (GET), so we can upload it in the HTTP POST below.
   var response = UrlFetchApp.fetch("http://example.com/image_to_download.jpg");
   var fileBlob = response.getBlob();

   var payload =
   {
     "fieldOne" : "value for field one",
     "fieldTwo" : "value for field two",
     "fileAttachment": fileBlob
   };

   // Because payload is a JavaScript object, it will be interpreted as
   // an HTML form. (We do not need to specify contentType; it will
   // automatically default to either 'application/x-www-form-urlencoded'
   // or 'multipart/form-data')

   var options =
   {
     "method" : "post",
     "payload" : payload
   };

   UrlFetchApp.fetch("http://example.com/upload_form.cgi", options);
 }
 

Parameters

Advanced parameters

Return

HTTPResponse — the http response data

getRequest(url)

Returns the request that would be made if the operation was invoked. This method does not actually issue the request.

 

 // 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]);
 }
 

Parameters

Return

Object — a map of Field Name to Value. The map has at least the following keys: url, method, contentType, useIntranet, payload, headers, oAuthServiceName, oAuthUseToken.

getRequest(url, params)

Returns the request that would be made if the operation were invoked. This method does not actually issue the request.

 

 // The code below logs the value for every key of the returned map.
 var fields = {'in_reply_to_screen_name': true, 'created_at': true, 'text': true};

 function tweet() {
   // Setup OAuthServiceConfig
   var oAuthConfig = UrlFetchApp.addOAuthService("twitter");
   oAuthConfig.setAccessTokenUrl("https://api.twitter.com/oauth/access_token");
   oAuthConfig.setRequestTokenUrl("https://api.twitter.com/oauth/request_token");
   oAuthConfig.setAuthorizationUrl("https://api.twitter.com/oauth/authorize");
   oAuthConfig.setConsumerKey(ScriptProperties.getProperty("twitterConsumerKey"));
   oAuthConfig.setConsumerSecret(ScriptProperties.getProperty("twitterConsumerSecret"));

   // Setup optional parameters to point request at OAuthConfigService.  The "twitter"
   // value matches the argument to "addOAuthService" above.
   var options =
     {
       "oAuthServiceName" : "twitter",
       "oAuthUseToken" : "always"
     };

   var result = UrlFetchApp.getRequest("https://api.twitter.com/1.1/statuses/user_timeline.json",
       options);
   for(i in result) {
     Logger.log(i + ": " + result[i]);
   }
 }
 

Parameters

Advanced parameters

Return

Object — a map of Field Name to Value. The map has at least the following keys: url, method, contentType, useIntranet, payload, headers, oAuthServiceName, oAuthUseToken.

removeOAuthService(serviceName)

Removes the OAuthConfig for the given service name.

 

 var oAuthConfig = UrlFetchApp.addOAuthService("twitter");
 // some useful code here...
 UrlFetchApp.removeOAuthService(oAuthConfig.getServiceName());
 

Parameters