gas-types-detailed
Version:
Enhanced Google Apps Script Type Definitions with detailed documentation. Includes type definitions plus code snippets, return values, required authorization scopes, and other details not found in @types/google-apps-script.
307 lines (290 loc) • 13.5 kB
TypeScript
// Type definitions for Google Apps Script 2025-11-10
// Project: https://developers.google.com/apps-script/
// Definitions by: motemen <https://github.com/motemen/>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
/// <reference path="google-apps-script.types.d.ts" />
/// <reference path="google-apps-script.base.d.ts" />
declare namespace GoogleAppsScript {
namespace URL_Fetch {
/**
* This class allows users to access specific information on HTTP responses.
* See also
*
* UrlFetchApp
*/
interface HTTPResponse {
/**
* Returns an attribute/value map of headers for the HTTP response, with headers that have multiple values returned as arrays.
*
* // The code below logs the HTTP headers from the response
* // received when fetching the Google home page.
* const response = UrlFetchApp.fetch('http://www.google.com/');
* Logger.log(response.getAllHeaders());
*
* Return:
* - Object — a JavaScript key/value map of HTTP headers
*
* https://developers.google.com/apps-script/reference/url-fetch/http-response#getAllHeaders()
*/
getAllHeaders(): any;
/**
* Return the data inside this object as a blob converted to the specified content type. This method adds the appropriate extension to the filename—for example, "myfile.pdf". However, it assumes that the part of the filename that follows the last period (if any) is an existing extension that should be replaced. Consequently, "ShoppingList.12.25.2014" becomes "ShoppingList.12.25.pdf".
* To view the daily quotas for conversions, see Quotas for Google Services. Newly created Google Workspace domains might be temporarily subject to stricter quotas.
*
* Return:
* - Blob — The data as a blob.
*
* https://developers.google.com/apps-script/reference/url-fetch/http-response#getAs(String)
* @param contentType The MIME type to convert to. For most blobs, 'application/pdf' is the only valid option. For images in BMP, GIF, JPEG, or PNG format, any of 'image/bmp', 'image/gif', 'image/jpeg', or 'image/png' are also valid. For a Google Docs document, 'text/markdown' is also valid.
*/
getAs(contentType: string): Base.Blob;
/**
* Return the data inside this object as a blob.
*
* Return:
* - Blob — The data as a blob.
*
* https://developers.google.com/apps-script/reference/url-fetch/http-response#getBlob()
*/
getBlob(): Base.Blob;
/**
* Gets the raw binary content of an HTTP response.
*
* // The code below logs the value of the first byte of the Google home page.
* const response = UrlFetchApp.fetch('http://www.google.com/');
* Logger.log(response.getContent()[0]);
*
* Return:
* - Byte[] — the content as a raw binary array
*
* https://developers.google.com/apps-script/reference/url-fetch/http-response#getContent()
*/
getContent(): Byte[];
/**
* Gets the content of an HTTP response encoded as a string.
*
* // The code below logs the HTML code of the Google home page.
* const response = UrlFetchApp.fetch('http://www.google.com/');
* Logger.log(response.getContentText());
*
* Return:
* - String — the content of the HTTP response, as a string
*
* https://developers.google.com/apps-script/reference/url-fetch/http-response#getContentText()
*/
getContentText(): string;
/**
* Returns the content of an HTTP response encoded as a string of the given charset.
*
* // The code below logs the HTML code of the Google home page with the UTF-8
* // charset.
* const response = UrlFetchApp.fetch('http://www.google.com/');
* Logger.log(response.getContentText('UTF-8'));
*
* Return:
* - String — the content of the HTTP response, encoded using the given charset
*
* https://developers.google.com/apps-script/reference/url-fetch/http-response#getContentText(String)
* @param charset a string representing the charset to be used for encoding the HTTP response content
*/
getContentText(charset: string): string;
/**
* Returns an attribute/value map of headers for the HTTP response.
*
* // The code below logs the HTTP headers from the response
* // received when fetching the Google home page.
* const response = UrlFetchApp.fetch('http://www.google.com/');
* Logger.log(response.getHeaders());
*
* Return:
* - Object — a JavaScript key/value map of HTTP headers
*
* https://developers.google.com/apps-script/reference/url-fetch/http-response#getHeaders()
*/
getHeaders(): any;
/**
* Get the HTTP status code (200 for OK, etc.) of an HTTP response.
*
* // The code below logs the HTTP status code from the response received
* // when fetching the Google home page.
* // It should be 200 if the request succeeded.
* const response = UrlFetchApp.fetch('http://www.google.com/');
* Logger.log(response.getResponseCode());
*
* Return:
* - Integer — The HTTP response code (for example, 200 for OK).
*
* https://developers.google.com/apps-script/reference/url-fetch/http-response#getResponseCode()
*/
getResponseCode(): Integer;
}
/**
* Fetch resources and communicate with other hosts over the Internet.
*
* This service allows scripts to communicate with other applications or access other resources
* on the web by fetching URLs. A script can use the URL Fetch service to issue HTTP and HTTPS
* requests and receive responses. The URL Fetch service uses Google's network infrastructure for
* efficiency and scaling purposes.
*
* Requests made using this service originate from a set pool of IP ranges. You can look up the full list of IP addresses if
* you need to allowlist or approve these requests.
*
* This service requires the https://www.googleapis.com/auth/script.external_request
* scope. In most cases Apps Script automatically detects and includes the scopes a script needs,
* but if you are setting your scopes
* explicitly you must manually add this scope to use UrlFetchApp.
* See also
*
* HTTPResponse
*
* Setting explicit scopes
*/
interface UrlFetchApp {
/**
* 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.
* const response = UrlFetchApp.fetch('http://www.google.com/');
* Logger.log(response.getContentText());
*
* Return:
* - HTTPResponse — The HTTP response data.
*
* Authorization:
*
* Scripts that use this method require authorization with one or more of the following scopes:
* - https://www.googleapis.com/auth/script.external_request
*
* https://developers.google.com/apps-script/reference/url-fetch/url-fetch-app#fetch(String)
* @param url The URL to fetch. The URL can have up to 2,082 characters.
*/
fetch(url: string): HTTPResponse;
/**
* Makes a request to fetch a URL using optional advanced parameters.
* This works over HTTP as well as 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);
*
* Return:
* - HTTPResponse — The HTTP response data.
*
* Authorization:
*
* Scripts that use this method require authorization with one or more of the following scopes:
* - https://www.googleapis.com/auth/script.external_request
*
* https://developers.google.com/apps-script/reference/url-fetch/url-fetch-app#fetch(String,Object)
* @param url The URL to fetch. The URL can have up to 2,082 characters.
* @param params The optional JavaScript object specifying advanced parameters as defined below.
*/
fetch(url: string, params: any): HTTPResponse;
/**
* Makes multiple requests to fetch multiple URLs using optional advanced parameters.
* This works over HTTP as well as 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]);
*
* Return:
* - HTTPResponse[] — An array of HTTP response data from each input request.
*
* Authorization:
*
* Scripts that use this method require authorization with one or more of the following scopes:
* - https://www.googleapis.com/auth/script.external_request
*
* https://developers.google.com/apps-script/reference/url-fetch/url-fetch-app#fetchAll(Object)
* @param requests An array of either URLs or JavaScript objects specifying requests as defined below.
*/
fetchAll(requests: any[]): HTTPResponse[];
/**
* Returns the request that is 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.
* const response = UrlFetchApp.getRequest('http://www.google.com/');
* for (const i in response) {
* Logger.log(`${i}: ${response[i]}`);
* }
*
* Return:
* - Object — A map of Field Name to Value. The map has at least the following keys: url, method, contentType, payload, and headers.
*
* Authorization:
*
* Scripts that use this method require authorization with one or more of the following scopes:
* - https://www.googleapis.com/auth/script.external_request
*
* https://developers.google.com/apps-script/reference/url-fetch/url-fetch-app#getRequest(String)
* @param url The URL to look up. The URL can have up to 2,082 characters.
*/
getRequest(url: string): any;
/**
* Returns the request that is made if the operation were invoked.
* This method does not actually issue the request.
*
* Return:
* - Object — A map of Field Name to Value. The map has at least the following keys: url, method, contentType, payload, and headers.
*
* Authorization:
*
* Scripts that use this method require authorization with one or more of the following scopes:
* - https://www.googleapis.com/auth/script.external_request
*
* https://developers.google.com/apps-script/reference/url-fetch/url-fetch-app#getRequest(String,Object)
* @param url The URL to look up. The URL can have up to 2,082 characters.
* @param params An optional JavaScript object specifying advanced parameters as defined below.
*/
getRequest(url: string, params: any): any;
}
}
}
declare var UrlFetchApp: GoogleAppsScript.URL_Fetch.UrlFetchApp;