Guía de inicio rápido de Google Apps Script

Crea una secuencia de comandos de Google Apps Script que realice solicitudes a la API de Google Chat.

En las guías de inicio rápido, se explica cómo configurar y ejecutar una app que llama a una API de Google Workspace. En esta guía de inicio rápido, se usa un enfoque de autenticación simplificado que es adecuado para un entorno de pruebas. Para un entorno de producción, te recomendamos que obtengas información sobre la autenticación y la autorización antes de elegir las credenciales de acceso que sean adecuadas para tu app.

En Apps Script, las guías de inicio rápido de Google Workspace usan los servicios avanzados de Google para llamar a las APIs de Google Workspace y controlar algunos detalles del flujo de autenticación y autorización.

Objetivos

  • Configurar el entorno
  • Crear y configurar la secuencia de comandos
  • Ejecutar la secuencia de comandos

Requisitos previos

Configura tu proyecto de Cloud

Si usas un proyecto nuevo de Google Cloud para completar esta guía de inicio rápido, debes configurarlo y agregarte como usuario de prueba. Si ya completaste estos pasos para tu proyecto de Cloud, ve a la siguiente sección.

Abre tu proyecto de Cloud en la consola de Google Cloud

Si aún no está abierto, abre el proyecto de Cloud que deseas usar para esta muestra:

  1. En la consola de Google Cloud, ve a la página Seleccionar un proyecto.

    Selecciona un proyecto de Cloud

  2. Selecciona el proyecto de Google Cloud que deseas usar. O bien, haz clic en Crear proyecto y sigue las instrucciones en pantalla. Si creas un proyecto de Google Cloud, es posible que debas activar la facturación para el proyecto.

Activa la API de Chat

Antes de usar las APIs de Google, debes activarlas en un proyecto de Google Cloud. Puedes activar una o más APIs en un solo proyecto de Google Cloud.

  • En la consola de Google Cloud, habilita la API de Google Chat.

    Habilitar la API

  1. En la Consola de APIs de Google, ve a Menú > Plataforma de autenticación de Google > Branding.

    Ir a Branding

  2. Si ya configuraste la plataforma de autenticación de Google, puedes configurar los siguientes parámetros de configuración de la pantalla de consentimiento de OAuth en Branding, Público y Acceso a los datos. Si ves un mensaje que dice Aún no se configuró la plataforma de autenticación de Google, haz clic en Comenzar:
    1. En Información de la app, en Nombre de la app, ingresa un nombre para la app.
    2. En Correo electrónico de asistencia al usuario, elige una dirección de correo electrónico de asistencia en la que los usuarios puedan comunicarse contigo si tienen preguntas sobre su consentimiento.
    3. Haz clic en Siguiente.
    4. En Público, selecciona Interno.
    5. Haz clic en Siguiente.
    6. En Información de contacto, ingresa una Dirección de correo electrónico en la que puedas recibir notificaciones sobre cualquier cambio en tu proyecto.
    7. Haz clic en Siguiente.
    8. En Finalizar, revisa la Política de Datos del Usuario de los Servicios de las APIs de Google y, si estás de acuerdo, selecciona Acepto la Política de Datos del Usuario de los Servicios de las APIs de Google.
    9. Haz clic en Continuar.
    10. Haz clic en Crear.
  3. Por ahora, puedes omitir la adición de permisos. En el futuro, cuando crees una app para usar fuera de tu organización de Google Workspace, debes cambiar el Tipo de usuario a Externo. Luego, agrega los permisos de autorización que requiere tu app. Para obtener más información, consulta la guía completa Configura el consentimiento de OAuth guide.

Configura la app de Google Chat

Para llamar a la API de Google Chat, debes configurar una app de Google Chat. Para cualquier solicitud de escritura, Google Chat atribuye la app de Google Chat en la IU con la siguiente información.

  1. En la Consola de APIs de Google, ve a la página Configuración de la API de Chat:

    Ir a la página de configuración de la API de Chat

  2. En Información de la aplicación, ingresa la siguiente información:

    1. En el campo Nombre de la app, ingresa Chat API quickstart app.
    2. En el campo URL del avatar, ingresa https://developers.google.com/chat/images/quickstart-app-avatar.png.
    3. En el campo Descripción, ingresa Quickstart for calling the Chat API.

  3. En Funciones interactivas, haz clic en el botón de activación Habilitar funciones interactivas para desactivar las funciones interactivas de la app de Chat.

  4. Haz clic en Guardar.

Crea la secuencia de comandos

  1. Para crear una secuencia de comandos nueva en el editor de Apps Script, ve a script.google.com/create.
  2. Reemplaza el contenido del editor de secuencias de comandos por el siguiente código:

chat/quickstart/Code.gs
/**
 * This quickstart sample shows how to list spaces with user credential
 *
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.spaces.readonly'
 * referenced in the manifest file (appsscript.json).
 */
function listSpaces() {
  // Initialize request argument(s)
  // Filter spaces by space type (SPACE or GROUP_CHAT or DIRECT_MESSAGE)
  const filter = 'space_type = "SPACE"';

  // Iterate through the response pages using page tokens
  let responsePage;
  let pageToken = null;
  do {
    // Request response pages
    responsePage = Chat.Spaces.list({
      filter: filter,
      pageToken: pageToken,
    });
    // Handle response pages
    if (responsePage.spaces) {
      for (const space of responsePage.spaces) {
        console.log(space);
      }
    }
    // Update the page token to the next one
    pageToken = responsePage.nextPageToken;
  } while (pageToken);
}

  1. Haz clic en Guardar .
  2. Haz clic en Proyecto sin título, escribe Guía de inicio rápido y haz clic en Cambiar nombre.

Configura la secuencia de comandos

Copia el número del proyecto de Cloud

  1. En la Consola de APIs de Google, ve a Menú > IAM y administración > Configuración.

    Ir a Configuración de IAM y administrador

  2. En el campo Número de proyecto, copia el valor.
  1. Abre el proyecto de Apps Script.
  2. Haz clic en Configuración del proyecto .
  3. En Proyecto de Google Cloud Platform (GCP), haz clic en Cambiar proyecto.
  4. En Número de proyecto de GCP, pega el número del proyecto de Google Cloud.
  5. Haz clic en Establecer el proyecto.

Habilita la API de Google Chat

Abre el proyecto de Apps Script.

  1. Haz clic en Configuración del proyecto .
  2. En Configuración general, habilita Mostrar el archivo de manifiesto "appsscript.json" en el editor.
  3. Haz clic en Editor , selecciona el archivo appscript.json y reemplaza el contenido por el siguiente código:

chat/quickstart/appsscript.json
{
  "timeZone": "America/New_York",
  "exceptionLogging": "STACKDRIVER",
  "runtimeVersion": "V8",
  "oauthScopes": ["https://www.googleapis.com/auth/chat.spaces.readonly"],
  "chat": {},
  "dependencies": {
    "enabledAdvancedServices": [
      {
        "userSymbol": "Chat",
        "version": "v1",
        "serviceId": "chat"
      }
    ]
  }
}

Ejecuta la muestra

En el editor de Apps Script, haz clic en Ejecutar.

La primera vez que ejecutes la muestra, se te solicitará que autorices el acceso:

  1. Haz clic en Revisar permisos.
  2. Elige una cuenta.
  3. Haz clic en Permitir.

El registro de ejecución de la secuencia de comandos aparece en la parte inferior de la ventana.

Próximos pasos