Servicios avanzados de Google

Los servicios avanzados de Apps Script permiten a los desarrolladores experimentados conectarse a ciertas APIs públicas de Google con menos configuración que con las interfaces HTTP. Básicamente, los servicios avanzados son wrappers ligeros para esas APIs de Google. Funcionan de manera muy similar a los servicios integrados de Apps Script, por ejemplo, ofrecen autocompletado y Apps Script controla el flujo de autorización automáticamente. Sin embargo, debes habilitar un servicio avanzado antes de poder usarlo en una secuencia de comandos.

Para ver qué APIs de Google están disponibles como servicios avanzados, busca la sección Servicios avanzados de Google en la Referencia. Si quieres usar una API de Google que no está disponible como servicio avanzado, solo debes conectarte a ella como a cualquier otra API externa.

¿Servicios avanzados o HTTP?

Cada uno de los servicios avanzados de Google está asociado con una API pública de Google. En Apps Script, puedes acceder a estas APIs a través de servicios avanzados o simplemente realizando las solicitudes a la API directamente con UrlFetch.

Si usas el método de servicio avanzado, Apps Script controla el flujo de autorización y ofrece compatibilidad con el autocompletado. Sin embargo, debes habilitar el servicio avanzado antes de poder usarlo. Además, algunos servicios avanzados solo proporcionan un subconjunto de la funcionalidad disponible en la API.

Si usas el método UrlFetch para acceder directamente a la API, en esencia, tratas a la API de Google como una API externa. Con este método, se pueden usar todos los aspectos de la API. Sin embargo, debes controlar la autorización de la API por tu cuenta. También debes construir los encabezados necesarios y analizar las respuestas de la API.

En general, es más fácil usar un servicio avanzado cuando es posible y solo usar el método UrlFetch cuando el servicio avanzado no proporciona la funcionalidad que necesitas.

Requisitos

Para poder usar un servicio avanzado, debes cumplir con los siguientes requisitos:

  1. Debes habilitar el servicio avanzado en tu proyecto de secuencia de comandos.

  2. Debes asegurarte de que la API correspondiente al servicio avanzado esté habilitada en el proyecto de Cloud Platform (GCP) que usa la secuencia de comandos.

    Si tu proyecto de secuencia de comandos usa un proyecto de GCP predeterminado creado a partir del 8 de abril de 2019, la API se habilita automáticamente después de que habilites el servicio avanzado y guardes el proyecto de secuencia de comandos. Si aún no lo has hecho, es posible que también se te solicite que aceptes las Condiciones del Servicio de Google Cloud y las API de Google.

    Si tu proyecto de secuencia de comandos usa un proyecto de GCP estándar o un proyecto de GCP predeterminado anterior, debes habilitar la API correspondiente del servicio avanzado de forma manual en el proyecto de GCP. Debes tener acceso de edición al proyecto de GCP para realizar este cambio.

Consulta los proyectos de Cloud Platform para obtener más información.

Habilitar servicios avanzados

Para usar un servicio avanzado de Google, sigue estas instrucciones:

  1. Abre el proyecto Apps Script.
  2. A la izquierda, haz clic en Editor .
  3. A la izquierda, junto a Servicios, haz clic en Agregar un servicio .
  4. Selecciona un servicio avanzado de Google y haz clic en Agregar.

Una vez que habilites un servicio avanzado, estará disponible en Autocompletar.

Cómo se determinan las firmas del método

Por lo general, los servicios avanzados usan los mismos objetos, nombres de métodos y parámetros que las APIs públicas correspondientes, aunque las firmas de métodos se traducen para usarse en Apps Script. Por lo general, la función de autocompletado del editor de secuencia de comandos proporciona suficiente información para comenzar, pero las siguientes reglas explican cómo Apps Script genera una firma de método desde una API de Google pública.

Las solicitudes a las APIs de Google pueden aceptar una variedad de tipos de datos, incluidos parámetros de ruta de acceso, parámetros de consulta, un cuerpo de solicitud o un archivo adjunto de carga de contenido multimedia. Algunos servicios avanzados también pueden aceptar encabezados de solicitud HTTP específicos (por ejemplo, el servicio avanzado de Calendario).

La firma del método correspondiente en Google Apps Script tiene los siguientes argumentos:

  1. El cuerpo de la solicitud (por lo general, un recurso), como un objeto de JavaScript.
  2. Ruta de acceso o parámetros obligatorios, como argumentos individuales.
  3. El archivo adjunto de carga de contenido multimedia, como un argumento Blob.
  4. Parámetros opcionales, como un objeto JavaScript que asigna nombres de parámetros a valores.
  5. Encabezados de solicitud HTTP, como un objeto JavaScript que asigna nombres de encabezado a valores de encabezado.

Si el método no tiene ningún elemento en una categoría determinada, se omite esa parte de la firma.

Debes tener en cuenta algunas excepciones especiales:

  • Para los métodos que aceptan una carga de contenido multimedia, el parámetro uploadType se establece automáticamente.
  • Los métodos llamados delete en la API de Google se denominan remove en Apps Script, ya que delete es una palabra reservada en JavaScript.
  • Si un servicio avanzado está configurado para aceptar encabezados de solicitudes HTTP y estableces un objeto JavaScript de encabezados de solicitud, también debes configurar el objeto de JavaScript de parámetros opcionales (en un objeto vacío si no usas parámetros opcionales).

Asistencia para servicios avanzados

Los servicios avanzados son solo wrappers livianos que permiten el uso de una API de Google dentro de Apps Script. Por lo tanto, cualquier problema que se encuentre mientras se usan suele ser un problema con la API subyacente, no con Apps Script en sí.

Si encuentras un problema mientras usas un servicio avanzado, debes informarlo con las instrucciones de asistencia de la API subyacente. En la sección Referencia de Apps Script, se proporcionan vínculos a estas instrucciones de asistencia en cada guía de servicio avanzada.