Google Apps Script

URL Fetch Service

This service allows scripts to access other resources on the web by fetching URLs. A script can use the UrlFetch service to issue HTTP and HTTPS requests and receive responses. The UrlFetch service uses Google's network infrastructure for efficiency and scaling purposes.

Classes

NameBrief description
HTTPResponseThis class allows users to access specific information on HTTP responses.
OAuthConfigRepresents configuration settings for an OAuth-enabled remote service.
UrlFetchAppFetch resources and communicate with other hosts over the Internet.

Class HTTPResponse

Methods

MethodReturn typeBrief description
getAllHeaders()ObjectReturns an attribute/value map of headers for the HTTP response, with headers that have multiple values returned as arrays.
getAs(contentType)BlobReturn the data inside this object as a blob converted to the specified content type.
getBlob()BlobReturn the data inside this object as a blob.
getContent()Byte[]Gets the raw binary content of an HTTP response.
getContentText()StringGets the content of an HTTP response encoded as a string.
getContentText(charset)StringReturns the content of an HTTP response encoded as a string of the given charset.
getHeaders()ObjectReturns an attribute/value map of headers for the HTTP response.
getResponseCode()IntegerGet the HTTP status code (200 for OK, etc.) of an HTTP response.

Class OAuthConfig

Methods

MethodReturn typeBrief description
getAccessTokenUrl()StringReturns the URL used to get the access token from.
getAuthorizationUrl()StringReturns the authorization URL.
getMethod()StringReturns the HTTP method used to complete the OAuth protocol.
getParamLocation()StringReturns the location of the parameters in the request when retreiving the request token.
getRequestTokenUrl()StringReturns the URL used to get the request token.
getServiceName()StringReturns the name used to reference this service.
setAccessTokenUrl(url)voidSets the URL to get an OAuth access token from.
setAuthorizationUrl(url)voidSets the URL for the OAuth authorization service.
setConsumerKey(consumerKey)voidSets the consumer key (provided when you register with an OAuth service).
setConsumerSecret(consumerSecret)voidSets the consumer secret (provided when you register with an OAuth service).
setMethod(method)voidSets the HTTP method used to complete the OAuth protocol.
setParamLocation(location)voidSets the parameter location in OAuth protocol requests.
setRequestTokenUrl(url)voidSets the request URL for the OAuth service.

Class UrlFetchApp

Methods

MethodReturn typeBrief description
addOAuthService(serviceName)OAuthConfigRegisters the given service name with the OAuth configuration and returns the newly created OAuthConfig object for an OAuth service with the given name.
fetch(url)HTTPResponseMakes a request to fetch a URL.
fetch(url, params)HTTPResponseMakes a request to fetch a URL using optional advanced parameters.
getRequest(url)ObjectReturns the request that would be made if the operation was invoked.
getRequest(url, params)ObjectReturns the request that would be made if the operation were invoked.
removeOAuthService(serviceName)voidRemoves the OAuthConfig for the given service name.

Authentication required

You need to be signed in with Google+ to do that.

Signing you in...

Google Developers needs your permission to do that.