Guía de inicio rápido de JavaScript

Las guías de inicio rápido explican cómo configurar y ejecutar una app que llama a un API de Google Workspace.

Las guías de inicio rápido de Google Workspace usan las bibliotecas cliente de la API para controlar algunas los detalles del flujo de autenticación y autorización. Te recomendamos lo siguiente: usas las bibliotecas cliente para tus propias apps. En esta guía de inicio rápido, se usa un de autenticación simplificada que es adecuado para realizar pruebas en un entorno de nube. Para un entorno de producción, recomendamos conocer autenticación y autorización antes de elige las credenciales de acceso que sean adecuados para tu app.

Crear una aplicación web de JavaScript que realice solicitudes a la API del revendedor

Objetivos

• Configurar el entorno
• Configura la muestra.
• Ejecuta la muestra.

Requisitos previos

• Node.js y npm esté instalado.
• Un servicio de proyecto.

• Una instancia de dominio de revendedor de Google
• Un acuerdo de socio de Google Workspace plenamente ejecutado.

Configura tu entorno

Para completar esta guía de inicio rápido, configura tu entorno.

Habilita la API

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 revendedor.

  Habilitar la API

Cómo configurar la pantalla de consentimiento de OAuth

Si usas un proyecto de Google Cloud nuevo para completar esta guía de inicio rápido, configura la pantalla de consentimiento de OAuth y agrégate como usuario de prueba. Si ya has completaste este paso para tu proyecto de Cloud, ve a la siguiente sección.

1. En la consola de Google Cloud, ve a Menú menu > APIs y Servicios > Pantalla de consentimiento de OAuth.

   Ir a la pantalla de consentimiento de OAuth

2. En Tipo de usuario, selecciona Interno y, luego, haz clic en Crear.
3. Completa el formulario de registro de apps y, luego, haz clic en Guardar y continuar.

4. Por ahora, puedes omitir el paso de agregar permisos y hacer clic en Guardar y continuar. En el futuro, cuando crees una app para usarla fuera de tu organización de Google Workspace, debes cambiar el Tipo de usuario a Externo y, luego, agregar los permisos de autorización que requiere tu app.

5. Revisa el resumen del registro de tu app. Para realizar cambios, haz clic en Editar. Si la aplicación el registro parece estar bien, haz clic en Volver al panel.

Autoriza credenciales para una aplicación web

Para autenticar usuarios finales y acceder a sus datos en tu app, debes hacer lo siguiente: crear uno o más IDs de cliente de OAuth 2.0. Un ID de cliente se usa con el fin de identificar una sola app para los servidores de OAuth de Google. Si tu app se ejecuta en varias plataformas debes crear un ID de cliente diferente para cada plataforma.

1. En la consola de Google Cloud, ve a Menú menu > APIs y Servicios > Credenciales.

   Ir a Credenciales

2. Haz clic en Crear credenciales > ID de cliente de OAuth.
3. Haz clic en Tipo de aplicación > Aplicación web.
4. En el campo Nombre, escribe un nombre para la credencial. Este nombre solo se muestra en la consola de Google Cloud.
5. Agrega URI autorizados relacionados con tu aplicación:
   • Apps del cliente (JavaScript): En Orígenes autorizados de JavaScript, haz clic en Agregar URI. Luego, ingresa un URI para usar en las solicitudes del navegador. Esto identifica los dominios desde los cuales tu aplicación puede enviar solicitudes de API al servidor OAuth 2.0.
   • Apps del servidor (Java, Python y más): en Authorized redirect URIs, haz clic en Add URI. Luego, ingresa un URI de extremo al que el servidor de OAuth 2.0 pueda enviar respuestas.
6. Haz clic en Crear. Aparecerá la pantalla de creación del cliente de OAuth, en la que se mostrará tu nuevo ID de cliente y secreto del cliente.

   Anota el ID de cliente. Los secretos del cliente no se usan para las aplicaciones web.

7. Haz clic en Aceptar. La credencial creada recientemente aparece en ID de cliente de OAuth 2.0.

Toma nota de estas credenciales, ya que las necesitarás más adelante en esta guía de inicio rápido.

Crea una clave de API

1. En la consola de Google Cloud, ve a Menú menu > APIs y Servicios > Credenciales.

   Ir a Credenciales

2. Haz clic en Crear credenciales >. Clave de API.
3. Se mostrará tu nueva clave de API.
   • Haz clic en Copiar content_copy. para copiar tu clave de API y usarla en el código de tu app. La clave de API también se puede que se encuentran en la sección "Claves de API" de las credenciales de tu proyecto.
   • Haz clic en Restringir clave para actualizar la configuración avanzada y limitar el uso. de tu clave de API. Para obtener más detalles, consulta Aplica restricciones de clave de API.

Configura la muestra

1. En el directorio de trabajo, crea un archivo llamado index.html.

2. En el archivo index.html, pega el siguiente código de muestra:

   adminSDK/reseller/index.html

   Ver en GitHub
   <!DOCTYPE html>
   <html>
     <head>
       <title>Google Workspace Reseller API Quickstart</title>
       <meta charset="utf-8" />
     </head>
     <body>
       <p>Google WOrkspace Reseller API Quickstart</p>
   
       <!--Add buttons to initiate auth sequence and sign out-->
       <button id="authorize_button" onclick="handleAuthClick()">Authorize</button>
       <button id="signout_button" onclick="handleSignoutClick()">Sign Out</button>
   
       <pre id="content" style="white-space: pre-wrap;"></pre>
   
       <script type="text/javascript">
         /* exported gapiLoaded */
         /* exported gisLoaded */
         /* exported handleAuthClick */
         /* exported handleSignoutClick */
   
         // TODO(developer): Set to client ID and API key from the Developer Console
         const CLIENT_ID = '<YOUR_CLIENT_ID>';
         const API_KEY = '<YOUR_API_KEY>';
   
         // Discovery doc URL for APIs used by the quickstart
         const DISCOVERY_DOC = 'https://www.googleapis.com/discovery/v1/apis/reseller/v1/rest';
   
         // Authorization scopes required by the API; multiple scopes can be
         // included, separated by spaces.
         const SCOPES = 'https://www.googleapis.com/auth/apps.order';
   
         let tokenClient;
         let gapiInited = false;
         let gisInited = false;
   
         document.getElementById('authorize_button').style.visibility = 'hidden';
         document.getElementById('signout_button').style.visibility = 'hidden';
   
         /**
          * Callback after api.js is loaded.
          */
         function gapiLoaded() {
           gapi.load('client', initializeGapiClient);
         }
   
         /**
          * Callback after the API client is loaded. Loads the
          * discovery doc to initialize the API.
          */
         async function initializeGapiClient() {
           await gapi.client.init({
             apiKey: API_KEY,
             discoveryDocs: [DISCOVERY_DOC],
           });
           gapiInited = true;
           maybeEnableButtons();
         }
   
         /**
          * Callback after Google Identity Services are loaded.
          */
         function gisLoaded() {
           tokenClient = google.accounts.oauth2.initTokenClient({
             client_id: CLIENT_ID,
             scope: SCOPES,
             callback: '', // defined later
           });
           gisInited = true;
           maybeEnableButtons();
         }
   
         /**
          * Enables user interaction after all libraries are loaded.
          */
         function maybeEnableButtons() {
           if (gapiInited && gisInited) {
             document.getElementById('authorize_button').style.visibility = 'visible';
           }
         }
   
         /**
          *  Sign in the user upon button click.
          */
         function handleAuthClick() {
           tokenClient.callback = async (resp) => {
             if (resp.error !== undefined) {
               throw (resp);
             }
             document.getElementById('signout_button').style.visibility = 'visible';
             document.getElementById('authorize_button').innerText = 'Refresh';
             await listSubscriptions();
           };
   
           if (gapi.client.getToken() === null) {
             // Prompt the user to select a Google Account and ask for consent to share their data
             // when establishing a new session.
             tokenClient.requestAccessToken({prompt: 'consent'});
           } else {
             // Skip display of account chooser and consent dialog for an existing session.
             tokenClient.requestAccessToken({prompt: ''});
           }
         }
   
         /**
          *  Sign out the user upon button click.
          */
         function handleSignoutClick() {
           const token = gapi.client.getToken();
           if (token !== null) {
             google.accounts.oauth2.revoke(token.access_token);
             gapi.client.setToken('');
             document.getElementById('content').innerText = '';
             document.getElementById('authorize_button').innerText = 'Authorize';
             document.getElementById('signout_button').style.visibility = 'hidden';
           }
         }
   
         /**
          * Print first ten subscriptions.
          */
         async function listSubscriptions() {
           let response;
           try {
             response = await gapi.client.reseller.subscriptions.list({
               'maxResults': 10,
             });
           } catch (err) {
             document.getElementById('content').innerText = err.message;
             return;
           }
   
           const subscriptions = response.result.subscriptions;
           if (!subscriptions || subscriptions.length == 0) {
             document.getElementById('content').innerText = 'No subscriptions found.';
             return;
           }
           // Flatten to string to display
           const output = subscriptions.reduce(
               (str, subscription) => {
                 const customer = subscription.customerId;
                 const sku = subscription.skuId;
                 const plan = subscription.plan.planName;
                 return `${str}${customer} (${sku},${plan})\n`;
               },
               'Subscriptions:\n');
           document.getElementById('content').innerText = output;
         }
       </script>
       <script async defer src="https://apis.google.com/js/api.js" onload="gapiLoaded()"></script>
       <script async defer src="https://accounts.google.com/gsi/client" onload="gisLoaded()"></script>
     </body>
   </html>

   Reemplaza lo siguiente:

   • YOUR_CLIENT_ID: Es el ID de cliente que creaste. cuando credenciales autorizadas para una aplicación web.
   • YOUR_API_KEY: La clave de API que creaste como un requisito previo.

Ejecuta la muestra

1. En el directorio de trabajo, instala el paquete http-server:

   npm install http-server
   

2. En el directorio de trabajo, inicia un servidor web:

   npx http-server -p 8000
   

3. En tu navegador, ve a http://localhost:8000.
4. Verás un mensaje para autorizar el acceso:
   1. Si aún no accediste a tu Cuenta de Google, hazlo cuando se te solicite. Si accediste a varias cuentas, selecciona una para usar la autorización.
   2. Haz clic en Aceptar.

Tu aplicación de JavaScript se ejecuta y llama a la API de revendedor.

Próximos pasos

• Codelab de la API de Google Workspace para revendedores
• Documentación de referencia de la API de Google Workspace para revendedores
• Sección google-api-javascript-client de GitHub