Se usó la API de Cloud Translation para traducir esta página.

Class UrlFetchApp

Recupera recursos y comunícate con otros hosts a través de Internet.

Este servicio permite que las secuencias de comandos se comuniquen con otras aplicaciones o accedan a otros recursos en la Web mediante la recuperación de URL. Una secuencia de comandos puede usar el servicio de recuperación de URL para emitir solicitudes HTTP y HTTPS y recibir respuestas. El servicio de recuperación de URL usa la infraestructura de red de Google para fines de eficiencia y escalamiento.

Las solicitudes realizadas con este servicio se originan en un grupo establecido de rangos de IP. Puedes buscar la lista completa de direcciones IP si necesitas incluir en la lista de entidades permitidas o aprobar estas solicitudes.

Este servicio requiere el alcance https://www.googleapis.com/auth/script.external_request. En la mayoría de los casos, Apps Script detecta y, además, incluye los alcances que necesita una secuencia de comandos de forma automática, pero si configuras los permisos de forma explícita, debes agregar este permiso de forma manual para usar UrlFetchApp.

Consulta también

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`fetch(url)`	`HTTPResponse`	Realiza una solicitud para recuperar una URL.
`fetch(url, params)`	`HTTPResponse`	Realiza una solicitud para recuperar una URL mediante parámetros avanzados opcionales.
`fetchAll(requests)`	`HTTPResponse[]`	Realiza varias solicitudes para recuperar múltiples URLs con parámetros avanzados opcionales.
`getRequest(url)`	`Object`	Muestra la solicitud que se realiza si se invocó la operación.
`getRequest(url, params)`	`Object`	Muestra la solicitud que se realiza si se invocó la operación.

Documentación detallada

`fetch(url)`

Realiza una solicitud para recuperar una URL.

Esto funciona tanto en HTTP como en 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());

Parámetros

Nombre	Tipo	Descripción
`url`	`String`	La URL que se recuperará. La URL puede tener hasta 2,082 caracteres.

Volver

HTTPResponse: los datos de la respuesta HTTP.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

`fetch(url, params)`

Realiza una solicitud para recuperar una URL mediante parámetros avanzados opcionales.

Esto funciona tanto en HTTP como en HTTPS.

// Make a GET request and log the returned content.
var response = UrlFetchApp.fetch('http://www.google.com/');
Logger.log(response.getContentText());

// Make a POST request with form data.
var resumeBlob = Utilities.newBlob('Hire me!', 'text/plain', 'resume.txt');
var 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')
var options = {
  'method' : 'post',
  'payload' : formData
};
UrlFetchApp.fetch('https://httpbin.org/post', options);

// Make a POST request with a JSON payload.
var data = {
  'name': 'Bob Smith',
  'age': 35,
  'pets': ['fido', 'fluffy']
};
var 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);

Parámetros

Nombre	Tipo	Descripción
`url`	`String`	La URL que se recuperará. La URL puede tener hasta 2,082 caracteres.
`params`	`Object`	El objeto opcional de JavaScript que especifica los parámetros avanzados como se define a continuación.

Parámetros avanzados

Nombre	Tipo	Descripción
`contentType`	`String`	el tipo de contenido (el valor predeterminado es "application/x-www-form-urlencoded"). Otro ejemplo de tipo de contenido es "application/xml; charset=utf-8".
`headers`	`Object`	un mapa de clave-valor de JavaScript de los encabezados HTTP para la solicitud
`method`	`String`	El método HTTP para la solicitud: `get`, `delete`, `patch`, `post` o `put`. El valor predeterminado es `get`.
`payload`	`String`	la carga útil (es decir, el cuerpo de POST) para la solicitud. Algunos métodos HTTP (por ejemplo, GET) no aceptan una carga útil. Puede ser una string, un array de bytes, un BLOB o un objeto JavaScript. Un objeto JavaScript se interpreta como un mapa de nombres de campos de formulario con valores, en el que los valores pueden ser strings o BLOB.
`useIntranet`	`Boolean`	Ya no está disponible. Esta acción indica a la recuperación que se debe resolver la URL especificada dentro de la intranet vinculada a tu dominio a través de la SDC (obsoleta)
`validateHttpsCertificates`	`Boolean`	Si es `false`, la recuperación ignora los certificados no válidos para las solicitudes HTTPS. El valor predeterminado es `true`.
`followRedirects`	`Boolean`	Si es `false`, la recuperación no sigue automáticamente los redireccionamientos HTTP; muestra la respuesta HTTP original. El valor predeterminado es `true`.
`muteHttpExceptions`	`Boolean`	Si es `true`, la recuperación no muestra una excepción si el código de respuesta indica un error y, en su lugar, muestra `HTTPResponse`. El valor predeterminado es `false`.
`escaping`	`Boolean`	Si `false` caracteres reservados en la URL no tienen escape El valor predeterminado es `true`.

Volver

HTTPResponse: los datos de la respuesta HTTP.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

`fetchAll(requests)`

Realiza varias solicitudes para recuperar múltiples URLs con parámetros avanzados opcionales.

Esto funciona tanto en HTTP como en HTTPS.

// Make both a POST request with form data, and a GET request.
var resumeBlob = Utilities.newBlob('Hire me!', 'text/plain', 'resume.txt');
var 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')
var request1 = {
  'url': 'https://httpbin.org/post',
  'method' : 'post',
  'payload' : formData
};
// A request may also just be a URL.
var request2 = 'https://httpbin.org/get?key=value';
UrlFetchApp.fetchAll([request1, request2]);

Parámetros

Nombre	Tipo	Descripción
`requests`	`Object[]`	Un array de URL o de objetos JavaScript que especifican solicitudes según se define a continuación.

Parámetros avanzados

Nombre	Tipo	Descripción
`url`	`String`	la URL que se recuperará. La URL puede tener hasta 2,082 caracteres.
`contentType`	`String`	el tipo de contenido (el valor predeterminado es "application/x-www-form-urlencoded"). Otro ejemplo de tipo de contenido es "application/xml; charset=utf-8".
`headers`	`Object`	un mapa de clave-valor de JavaScript de los encabezados HTTP para la solicitud
`method`	`String`	El método HTTP para la solicitud: `get`, `delete`, `patch`, `post` o `put`. El valor predeterminado es `get`.
`payload`	`String`	la carga útil (es decir, el cuerpo de POST) para la solicitud. Algunos métodos HTTP (por ejemplo, GET) no aceptan una carga útil. Puede ser una string, un array de bytes, un BLOB o un objeto JavaScript. Un objeto JavaScript se interpreta como un mapa de nombres de campos de formulario con valores, en el que los valores pueden ser strings o BLOB.
`useIntranet`	`Boolean`	Ya no está disponible. Esta acción indica a la recuperación que se debe resolver la URL especificada dentro de la intranet vinculada a tu dominio a través de la SDC (obsoleta)
`validateHttpsCertificates`	`Boolean`	Si es `false`, la recuperación ignora los certificados no válidos para las solicitudes HTTPS. El valor predeterminado es `true`.
`followRedirects`	`Boolean`	Si es `false`, la recuperación no sigue automáticamente los redireccionamientos HTTP; muestra la respuesta HTTP original. El valor predeterminado es `true`.
`muteHttpExceptions`	`Boolean`	Si es `true`, la recuperación no muestra una excepción si el código de respuesta indica un error y, en su lugar, muestra `HTTPResponse`. El valor predeterminado es `false`.
`escaping`	`Boolean`	Si es `false`, los caracteres reservados en la URL no tienen escape El valor predeterminado es `true`.

Volver

HTTPResponse[]: Es un array de datos de respuesta HTTP de cada solicitud de entrada.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

`getRequest(url)`

Muestra la solicitud que se realiza si se invocó la operación.

En realidad, este método no emite la solicitud.

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

Parámetros

Nombre	Tipo	Descripción
`url`	`String`	La URL que se debe buscar. La URL puede tener hasta 2,082 caracteres.

Volver

Object: Es un mapa de nombre del campo al valor. El mapa tiene, como mínimo, las siguientes claves: url, method, contentType, payload y headers.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

`getRequest(url, params)`

Muestra la solicitud que se realiza si se invocó la operación.

En realidad, este método no emite la solicitud.

Parámetros

Nombre	Tipo	Descripción
`url`	`String`	La URL que se debe buscar. La URL puede tener hasta 2,082 caracteres.
`params`	`Object`	Un objeto opcional de JavaScript que especifica los parámetros avanzados como se define a continuación.

Parámetros avanzados

Nombre	Tipo	Descripción
`contentType`	`String`	el tipo de contenido (el valor predeterminado es "application/x-www-form-urlencoded"). Otro ejemplo de tipo de contenido es "application/xml; charset=utf-8".
`headers`	`Object`	un mapa de clave-valor de JavaScript de los encabezados HTTP para la solicitud
`method`	`String`	El método HTTP para la solicitud: `get`, `delete`, `patch`, `post` o `put`. El valor predeterminado es `get`.
`payload`	`String`	la carga útil (es decir, el cuerpo de POST) para la solicitud. Algunos métodos HTTP (por ejemplo, GET) no aceptan una carga útil. Puede ser una string, un array de bytes, un BLOB o un objeto JavaScript. Un objeto JavaScript se interpreta como un mapa de nombres de campos de formulario con valores, en el que los valores pueden ser strings o BLOB.
`useIntranet`	`Boolean`	Ya no está disponible. Esta acción indica a la recuperación que se debe resolver la URL especificada dentro de la intranet vinculada a tu dominio a través de la SDC (obsoleta)
`validateHttpsCertificates`	`Boolean`	Si es `false`, la recuperación ignora los certificados no válidos para las solicitudes HTTPS. El valor predeterminado es `true`.
`followRedirects`	`Boolean`	Si es `false`, la recuperación no sigue automáticamente los redireccionamientos HTTP; muestra la respuesta HTTP original. El valor predeterminado es `true`.
`muteHttpExceptions`	`Boolean`	Si es `true`, la recuperación no muestra una excepción si el código de respuesta indica un error y, en su lugar, muestra `HTTPResponse`. El valor predeterminado es `false`.
`escaping`	`Boolean`	Si `false` caracteres reservados en la URL no tienen escape El valor predeterminado es `true`.

Volver

Object: Es un mapa de nombre del campo al valor. El mapa tiene, como mínimo, las siguientes claves: url, method, contentType, payload y headers.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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