Node.js hızlı başlangıç kılavuzu

Hızlı başlangıç kılavuzlarında, Google Workspace API'yi çağıran bir uygulamanın nasıl oluşturulacağı ve çalıştırılacağı açıklanmaktadır.

Google Workspace hızlı başlangıç kılavuzları, kimlik doğrulama ve yetkilendirme akışının bazı ayrıntılarını işlemek için API istemci kitaplıklarını kullanır. Kendi uygulamalarınız için istemci kitaplıklarını kullanmanızı öneririz. Bu hızlı başlangıç kılavuzunda, test ortamı için uygun olan basitleştirilmiş bir kimlik doğrulama yaklaşımı kullanılmaktadır. Üretim ortamında, uygulamanız için uygun erişim kimlik bilgilerini seçmeden önce kimlik doğrulama ve yetkilendirme hakkında bilgi edinmenizi öneririz.

Google Chat API'ye istek gönderen bir Node.js komut satırı uygulaması oluşturun.

Hedefler

• Ortamınızı ayarlayın.
• İstemci kitaplığını yükleyin.
• Numuneyi ayarlayın.
• Örneği çalıştırın.

Ön koşullar

Bu hızlı başlangıç kılavuzunu çalıştırmak için aşağıdaki ön koşullara sahip olmanız gerekir:

• Node.js ve npm yüklü olmalıdır.
• Google Cloud projesi.

• Google Chat'e erişimi olan bir Business veya Enterprise Google Workspace hesabı.

Ortamınızı ayarlama

Bu hızlı başlangıç kılavuzunu tamamlamak için ortamınızı ayarlayın.

API'yi etkinleştirme

Google API'lerini kullanmadan önce bir Google Cloud projesinde etkinleştirmeniz gerekir. Tek bir Google Cloud projesinde bir veya daha fazla API'yi etkinleştirebilirsiniz.

• Google Cloud Console'da Google Chat API'yi etkinleştirin.

  API'yi etkinleştirme

OAuth izin ekranını yapılandırma

Bu hızlı başlangıç kılavuzunu tamamlamak için yeni bir Google Cloud projesi kullanıyorsanız OAuth izin ekranını yapılandırın ve kendinizi test kullanıcısı olarak ekleyin. Cloud projeniz için bu adımı zaten tamamladıysanız sonraki bölüme geçin.

1. Google Cloud Console'da Menü menu > API'ler ve Hizmetler > OAuth izin ekranı'na gidin.

   OAuth izin ekranına gidin

2. Kullanıcı türü için Dahili'yi seçin ve Oluştur'u tıklayın.
3. Uygulama kayıt formunu doldurup Kaydet ve Devam Et'i tıklayın.

4. Şimdilik kapsam eklemeyi atlayabilir ve Kaydet ve Devam Et'i tıklayabilirsiniz. Gelecekte, Google Workspace kuruluşunuzun dışında kullanım için bir uygulama oluşturduğunuzda, Kullanıcı türü'nü Harici olarak değiştirmeniz ve ardından uygulamanızın gerektirdiği yetkilendirme kapsamlarını eklemeniz gerekir.

5. Uygulama kaydı özetinizi inceleyin. Değişiklik yapmak için Düzenle'yi tıklayın. Uygulama kaydının sorunsuz görünmesi durumunda Kontrol paneline dön'ü tıklayın.

Masaüstü uygulaması için kimlik bilgilerini yetkilendirme

Son kullanıcıların kimliğini doğrulamak ve uygulamanızdaki kullanıcı verilerine erişmek için bir veya daha fazla OAuth 2.0 istemci kimliği oluşturmanız gerekir. İstemci kimliği, tek bir uygulamanın Google OAuth sunucularına tanıtılması için kullanılır. Uygulamanız birden fazla platformda çalışıyorsa her platform için ayrı bir istemci kimliği oluşturmanız gerekir.

1. Google Cloud konsolunda Menü menu > API'ler ve Hizmetler > Kimlik bilgileri'ne gidin.

   Kimlik Bilgileri'ne gidin

2. Kimlik Bilgileri Oluştur > OAuth istemci kimliği'ni tıklayın.
3. Uygulama türü > Masaüstü uygulaması'nı tıklayın.
4. Ad alanına, kimliğin adını yazın. Bu ad yalnızca Google Cloud konsolunda gösterilir.
5. Oluştur'u tıklayın. Yeni istemci kimliğinizi ve istemci gizli anahtarınızı gösteren OAuth istemcisi oluşturuldu ekranı gösterilir.
6. Tamam'ı tıklayın. Yeni oluşturulan kimlik bilgisi OAuth 2.0 İstemci Kimlikleri altında görünür.
7. İndirilen JSON dosyasını credentials.json olarak kaydedin ve dosyayı çalışma dizininize taşıyın.

Google Chat uygulamasını yapılandırma

Google Chat API'yi çağırmak için bir Google Chat uygulaması yapılandırmanız gerekir. Google Chat, yazma isteklerinde aşağıdaki bilgileri kullanarak kullanıcı arayüzündeki Google Chat uygulamasını ilişkilendirir.

1. Google Cloud Console'da Chat API Yapılandırma sayfasına gidin:

   Chat API Yapılandırması sayfasına gidin

2. Application info (Uygulama bilgileri) altında aşağıdaki bilgileri girin:

   1. Uygulama adı alanına Chat API quickstart app girin.
   2. Avatar URL'si alanına https://developers.google.com/chat/images/quickstart-app-avatar.png yazın.
   3. Açıklama alanına Quickstart for calling the Chat API yazın.

3. Etkileşimli özellikler bölümünde, Etkileşimli özellikleri etkinleştir açma/kapatma düğmesini kapalı konuma getirerek Chat uygulamasının etkileşimli özelliklerini devre dışı bırakın.

4. Kaydet'i tıklayın.

İstemci kitaplığını yükleme

• Kitaplıkları npm kullanarak yükleyin:

  npm install @google-apps/chat @google-cloud/local-auth@2.1.0 --save
  

Örneği ayarlama

1. Çalışma dizininizde index.js adlı bir dosya oluşturun.

2. Aşağıdaki kodu dosyaya yapıştırın:

   sohbet/quickstart/index.js

   GitHub'da göster
   const fs = require('fs').promises;
   const path = require('path');
   const process = require('process');
   const {authenticate} = require('@google-cloud/local-auth');
   const {ChatServiceClient} = require('@google-apps/chat');
   const {auth} = require('google-auth-library');
   
   // If modifying these scopes, delete token.json.
   const SCOPES = ['https://www.googleapis.com/auth/chat.spaces.readonly'];
   
   // The file token.json stores the user's access and refresh tokens, and is
   // created automatically when the authorization flow completes for the first
   // time.
   const TOKEN_PATH = path.join(process.cwd(), 'token.json');
   const CREDENTIALS_PATH = path.join(process.cwd(), 'credentials.json');
   
   /**
    * Reads previously authorized credentials from the save file.
    *
    * @return {Promise<OAuth2Client|null>}
    */
   async function loadSavedCredentialsIfExist() {
     try {
       const content = await fs.readFile(TOKEN_PATH);
       const credentials = JSON.parse(content);
       return auth.fromJSON(credentials);
     } catch (err) {
       console.log(err);
       return null;
     }
   }
   
   /**
    * Serializes credentials to a file compatible with GoogleAuth.fromJSON.
    *
    * @param {OAuth2Client} client
    * @return {Promise<void>}
    */
   async function saveCredentials(client) {
     const content = await fs.readFile(CREDENTIALS_PATH);
     const keys = JSON.parse(content);
     const key = keys.installed || keys.web;
     const payload = JSON.stringify({
       type: 'authorized_user',
       client_id: key.client_id,
       client_secret: key.client_secret,
       refresh_token: client.credentials.refresh_token,
     });
     await fs.writeFile(TOKEN_PATH, payload);
   }
   
   /**
    * Load or request or authorization to call APIs.
    *
    * @return {Promise<OAuth2Client>}
    */
   async function authorize() {
     let client = await loadSavedCredentialsIfExist();
     if (client) {
       return client;
     }
     client = await authenticate({
       scopes: SCOPES,
       keyfilePath: CREDENTIALS_PATH,
     });
     if (client.credentials) {
       await saveCredentials(client);
     }
     return client;
   }
   
   /**
    * Lists spaces with user credential.
    * @param {OAuth2Client} authClient An authorized OAuth2 client.
    */
   async function listSpaces(authClient) {
     // Create a client
     const chatClient = new ChatServiceClient({
       authClient: authClient,
       scopes: SCOPES,
     });
   
     // Initialize request argument(s)
     const request = {
       // Filter spaces by space type (SPACE or GROUP_CHAT or DIRECT_MESSAGE)
       filter: 'space_type = "SPACE"'
     };
   
     // Make the request
     const pageResult = chatClient.listSpacesAsync(request);
   
     // Handle the response. Iterating over pageResult will yield results and
     // resolve additional pages automatically.
     for await (const response of pageResult) {
       console.log(response);
     }
   }
   
   authorize().then(listSpaces).catch(console.error);

Sana Özel'i çalıştırma

1. Çalışma dizininizde örneği çalıştırın:

   node .
   

2. Sana Özel örneğini ilk kez çalıştırdığınızda erişim için yetki vermenizi ister:
   1. Google Hesabınızda henüz oturum açmadıysanız istendiğinde oturum açın. Birden fazla hesapta oturum açtıysanız yetkilendirme için kullanılacak bir hesap seçin.
   2. Kabul et'i tıklayın.

   Nodejs uygulamanız Google Chat API'yi çalıştırır ve çağırır.

   Yetkilendirme bilgileri dosya sisteminde depolanır. Bu nedenle, örnek kodu bir sonraki çalıştırmanızda yetkilendirme istenmez.

Sonraki adımlar

• GitHub'daki Google Chat API İstemcisi