O Google usa tecnologia de IA na tradução de conteúdos para seu idioma de preferência. As traduções com IA podem ter erros.

Guia de início rápido do JavaScript

Crie um aplicativo da Web em JavaScript que faça solicitações à API Gmail.

Os guias de início rápido explicam como configurar e executar um app que chama uma API do Google Workspace. Este guia de início rápido usa uma abordagem de autenticação simplificada que é adequada para um ambiente de teste. Para um ambiente de produção, recomendamos que você aprenda sobre autenticação e autorização antes de escolher as credenciais de acesso adequadas para seu app.

Este guia de início rápido usa as bibliotecas de cliente de API recomendadas do Google Workspace para processar alguns detalhes do fluxo de autenticação e autorização.

Objetivos

Prepare o ambiente.
Configure a amostra.
Execute o exemplo.

Pré-requisitos

Node.js e npm instalados.
Um projeto do Google Cloud.

Uma Conta do Google com o Gmail ativado.

Configurar o ambiente

Para concluir este guia de início rápido, configure seu ambiente.

Ativar a API

Antes de usar as APIs do Google, é preciso ativá-las em um projeto do Google Cloud. É possível ativar uma ou mais APIs em um único projeto do Google Cloud.

No console do Google Cloud, ative a API Gmail.

Ativar a API

Configurar a tela de permissão OAuth

Se você estiver usando um novo projeto na nuvem do Google Cloud para concluir este guia de início rápido, configure a tela de permissão OAuth. Se você já concluiu essa etapa para seu projeto na nuvem, pule para a próxima seção.

No console de APIs do Google, acesse Menu > Plataforma do Google Auth > Branding.
Acessar Branding
Se você já configurou a plataforma de autenticação do Google, pode definir as seguintes configurações da tela de permissão OAuth em Branding, Público e Acesso a dados. Se aparecer a mensagem A plataforma de autenticação do Google ainda não está configurada, clique em Começar:

Em Informações do app, em Nome do app, insira um nome para o app.
Em E-mail para suporte do usuário, escolha um endereço de e-mail para que os usuários entrem em contato com você se tiverem dúvidas sobre o consentimento deles.
Clique em Próxima.
Em Público-alvo, selecione Interno.
Clique em Próxima.
Em Dados de contato, insira um endereço de e-mail para receber notificações sobre mudanças no projeto.
Clique em Próxima.
Em Concluir, leia a Política de dados do usuário dos serviços de API do Google e, se concordar, selecione Concordo com a Política de dados do usuário dos serviços de API do Google.
Clique em Continuar.
Clique em Criar.

Por enquanto, você pode pular essa etapa. No futuro, ao criar um app para uso fora da sua organização do Google Workspace, mude o Tipo de usuário para Externo. Em seguida, adicione os escopos de autorização necessários para o app. Para saber mais, consulte o guia completo Configurar o consentimento do OAuth.

Autorizar credenciais para um aplicativo da Web

Para autenticar usuários finais e acessar os dados do usuário no app, crie um ou mais IDs do cliente OAuth 2.0. Um ID do cliente é usado para identificar um único app nos servidores OAuth do Google. Se o app for executado em várias plataformas, crie um ID do cliente separado para cada uma delas.

No console do Google Cloud, acesse Menu > Plataforma do Google Auth > Clientes.
Acessar Clientes
Clique em Criar cliente.
Clique em Tipo de aplicativo > Aplicativo da Web.
No campo Nome, digite um nome para a credencial. Esse nome é mostrado apenas no console do Google Cloud.
Adicione URIs autorizados relacionados ao seu app:
- Apps do lado do cliente (JavaScript): em Origens JavaScript autorizadas, clique em Adicionar URI. Em seguida, insira um URI para usar nas solicitações do navegador. Identifica os domínios de onde o aplicativo pode enviar solicitações de API ao servidor OAuth 2.0.
- Apps do lado do servidor (Java, Python e outros): em URIs de redirecionamento autorizados, clique em Adicionar URI. Em seguida, insira um URI de endpoint para o qual o servidor OAuth 2.0 possa enviar respostas.
Opcional: se o app for um agente de IA que realiza ações em nome dos usuários, selecione Usar este cliente para um agente com tecnologia de IA. Se o app for compatível com fluxos de trabalho de agentes de IA e recursos de usuário padrão, crie clientes OAuth separados para cada um. Não é possível mudar essa configuração depois de criar o cliente.
Clique em Criar.
A credencial recém-criada aparece em IDs do cliente OAuth 2.0.

As chaves secretas do cliente não são usadas em aplicativos da Web.
Salve o ID do cliente para uso posterior neste guia de início rápido.

Criar uma chave de API

No console do Google Cloud, acesse Menu > APIs e serviços > Credenciais.
Ir para Credenciais
Clique em Criar credenciais > Chave de API.
Sua nova chave de API será exibida.
- Clique em Copiar para copiar a chave de API e usá-la no código do app. A chave de API também pode ser encontrada na seção "Chaves de API" das credenciais do seu projeto.
- Para evitar o uso não autorizado, recomendamos restringir os locais e as APIs em que a chave de API pode ser usada. Para mais detalhes, consulte Adicionar restrições de API.

Configure a amostra

No diretório de trabalho, crie um arquivo chamado index.html.

No arquivo index.html, cole o seguinte exemplo de código:

gmail/quickstart/index.html

Ver no GitHub

<!DOCTYPE html>
<html>
  <head>
    <title>Gmail API Quickstart</title>
    <meta charset="utf>-8&<quot;> /
<  /h>ead
 < >body
    pGmail API <Qu>icksta<rt/p

    !--Add buttons to initiate auth sequence and >sign <out--
    button id="authorize_button" onclick>="ha<ndleAut>hClic<k()"Authorize/button
    button id="signout_but>ton"<; oncli>ck=&qu<ot;handleSignoutClick()"Sign Out/button

 ><   p>re id=<"content" style=&qu>ot;white-space: pre-wrap;"/pre

    script type="text/javascript"
      /* exported gapiLoaded */
      /* exported gisLoaded */
      /* exported handleAuthClick */
      /* exported handleSignoutClick */

      // TODO(developer): S<et to client I>D and API key from the Dev<eloper Conso>le
      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/gmail/v1/rest';

      // Authorization scopes required by the API; multiple scopes can be
      // included, separated by spaces.
      const SCOPES = 'https://www.googleapis.com/auth/gmail.readonly';

      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 = 'vis>ible';
        }
      }

      /**
       *  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 listLabels();
        };

        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 all Labels in the authorized user's inbox. If no labels
       * are found an appropriate message is printed.
       */
      async function listLabels() {
        let response;
        try {
          response = await gapi.client.gmail.users.labels.list({
            'userId': 'me',
          });
        } catch (err) {
          document.getElementById('content').innerText = err.message;
          return;
   >     }
        const labels = response.result.labels;
        if (!labels || labels.length == 0) {
          document.getElemen<tById(&>#39;c<ontent').innerText = 'No labels found.';
          return;
        }><
      >  // <Flatten to string to display
        const output = labels.reduce(
            (str,>< label)> = <`${st>r<}${la>bel.name}\n`,
            'Labels:\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

Substitua:

YOUR_CLIENT_ID: o ID do cliente que você criou quando autorizou as credenciais para um aplicativo da Web.
YOUR_API_KEY: a chave de API que você criou.

Executar a amostra

No diretório de trabalho, instale o pacote http-server:
```
npm install http-server
```
No diretório de trabalho, inicie um servidor da Web:
```
npx http-server -p 8000
```

No navegador, acesse http://localhost:8000.
Você verá uma solicitação para autorizar o acesso:
1. Se você ainda não estiver conectado à sua Conta do Google, faça login quando solicitado. Se você tiver feito login em várias contas, selecione uma para usar na autorização.
2. Clique em Aceitar.

O aplicativo JavaScript é executado e chama a API Gmail.

Próximas etapas

Teste as APIs do Google Workspace no APIs Explorer

Guia de início rápido do JavaScript Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.