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

Google Chat API'ye istekte bulunan bir Node.js komut satırı uygulaması oluşturun.

Hızlı başlangıç kılavuzlarında, Google Workspace API'sini çağıran bir uygulamanın nasıl ayarlanacağı ve çalıştırılacağı açıklanır. 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ı için, uygulamanıza uygun erişim kimlik bilgilerini seçmeden önce kimlik doğrulama ve yetkilendirme hakkında bilgi edinmenizi öneririz.

Bu hızlı başlangıç kılavuzunda, kimlik doğrulama ve yetkilendirme akışının bazı ayrıntılarını işlemek için Google Workspace'in önerdiği API istemci kitaplıkları kullanılır.

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ıcı çalıştırmak için aşağıdaki ön koşulları karşılamanı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ıcı 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 onay ekranını yapılandırma

Bu hızlı başlangıcı tamamlamak için yeni bir Google Cloud projesi kullanıyorsanız OAuth izin ekranını yapılandırın. Cloud projeniz için bu adımı daha önce tamamladıysanız sonraki bölüme geçin.

1. Google Cloud Console'da Menü > Google Auth platform > Markalama'ya gidin.

   Markalama'ya gidin

2. Google Auth platformyapılandırdıysanız Markalama, Kitle ve Veri Erişimi'nde aşağıdaki OAuth kullanıcı rızası ekranı ayarlarını yapılandırabilirsiniz. Google Auth platform henüz yapılandırılmadı mesajını görürseniz Başlayın'ı tıklayın:
1. Uygulama Bilgileri bölümündeki Uygulama adı alanına uygulamanın adını girin.
2. Kullanıcı destek e-postası bölümünde, kullanıcıların rızalarıyla ilgili soruları olduğunda sizinle iletişime geçebileceği bir destek e-posta adresi seçin.
3. İleri'yi tıklayın.
4. Kitle bölümünde Dahili'yi seçin.
5. İleri'yi tıklayın.
6. İletişim bilgileri bölümünde, projenizde yapılan değişikliklerle ilgili bildirim alabileceğiniz bir e-posta adresi girin.
7. İleri'yi tıklayın.
8. Bitir bölümünde Google API Hizmetleri Kullanıcı Verileri Politikası'nı inceleyin ve kabul ediyorsanız Google API Hizmetleri: Kullanıcı Verileri Politikası'nı kabul ediyorum'u seçin.
9. Devam'ı tıklayın.
10. Oluştur'u tıklayın.
3. Şimdilik kapsam eklemeyi atlayabilirsiniz. Gelecekte Google Workspace kuruluşunuzun dışında kullanılacak bir uygulama oluşturduğunuzda Kullanıcı türü'nü Harici olarak değiştirmeniz gerekir. Ardından, uygulamanızın gerektirdiği yetkilendirme kapsamlarını ekleyin. Daha fazla bilgi için OAuth iznini yapılandırma başlıklı kılavuzun tamamını inceleyin.

Bir masaüstü uygulaması için kimlik bilgilerini yetkilendirme

Uygulamanızda son kullanıcıların kimliğini doğrulamak ve 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.

Dikkat: Bu hızlı başlangıç, yerel olarak ve tarayıcı erişimiyle çalıştırılmalıdır. Cloud Shell gibi uzak bir terminalde veya SSH üzerinden çalıştırılırsa çalışmaz.

1. Google Cloud Console'da Menü > Google Auth platform > İstemciler'e gidin.

   Müşteriler'e gidin.

2. Create Client'ı (İstemci Oluştur) 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 Console'da gösterilir.
5. Oluştur'u tıklayın.

   Yeni oluşturulan kimlik bilgisi, "OAuth 2.0 İstemci Kimlikleri" bölümünde görünür.

6. İ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, tüm yazma istekleri için kullanıcı arayüzünde Google Chat uygulamasını aşağıdaki bilgileri kullanarak ilişkilendirir.

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

   Chat API Yapılandırma sayfasına gidin

2. Application info (Uygulama bilgileri) bölümünde 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 girin.
   3. Açıklama alanına Quickstart for calling the Chat API girin.

3. Etkileşimli özellikler bölümünde, Etkileşimli özellikleri etkinleştir açma/kapatma düğmesini kapalı konuma getirerek Chat uygulamasında etkileşimli özellikleri 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
  

Numuneyi ayarlama

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

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

   chat/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);

Örneği çalıştırma

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

   node .
   

2. Örneği ilk kez çalıştırdığınızda erişimi yetkilendirmeniz istenir:
   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.

   Node.js uygulamanız çalışıyor ve Google Chat API'yi çağırıyor.

   Yetkilendirme bilgileri dosya sisteminde depolandığı için örnek kodu bir sonraki çalıştırmanızda yetkilendirme istenmez.

Sonraki adımlar

• API Gezgini'nde Google Workspace API'lerini deneme
• GitHub'da Google Chat API istemcisi