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

Hızlı başlangıç kılavuzlarında, Google Workspace API.

Google Workspace hızlı başlangıç kılavuzları, bazı ve kimlik doğrulama ve yetkilendirme akışıyla ilgili ayrıntılara dikkat edin. Önerilerimiz: istemci kitaplıklarını kullanmayı tercih edebilirsiniz. Bu hızlı başlangıç kılavuzunda, test için uygun olan basitleştirilmiş kimlik doğrulama yaklaşımı bahsedeceğim. Üretim ortamı için şu hakkında bilgi edinmenizi öneririz: kimlik doğrulama ve yetkilendirme önce erişim kimlik bilgilerini seçme seçmeniz gerekir.

Gmail API'si.

Hedefler

• Ortamınızı ayarlayın.
• İstemci kitaplığını yükleyin.
• Örneği 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üklenmiş olmalıdır.
• Bir Google Cloud projesi.

• Gmail'in etkin olduğu bir Google 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 konsolunda Gmail API'yi etkinleştirin.

  API'yi etkinleştirme

OAuth izin ekranını yapılandırın

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

1. Google Cloud konsolunda Menü'ye gidin > API'lar ve Hizmetler > OAuth izin ekranı.

   OAuth izin ekranına gidin.

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

4. Şimdilik kapsam eklemeyi atlayıp Kaydet ve Devam Et'i tıklayabilirsiniz. Gelecekte Google Workspace kuruluşu kullanıyorsanız Kullanıcı türü'nü Harici olarak değiştirmeniz ve ardından Uygulamanızın gerektirdiği yetkilendirme kapsamlarını ekleyin.

5. Uygulama kaydı özetinizi inceleyin. Değişiklik yapmak için Düzenle'yi tıklayın. Uygulama 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 şunları yapmanız gerekir: En az bir OAuth 2.0 İstemci Kimliği oluşturun. Client-ID, bir tek bir uygulamayı Google'ın OAuth sunucularına göndermesini sağlar. 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 bir tarayıcıya erişimle çalıştırılmalıdır. Google Cloud Shell gibi uzak bir terminalde veya SSH üzerinden çalıştırıldığında çalışmaz.

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

   Kimlik bilgilerine git

2. Kimlik Bilgisi 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 kimlik bilgisi için bir ad yazın. Bu ad yalnızca Google Cloud konsolunda gösterilir.
5. Oluştur'u tıklayın. Yeni İstemci Kimliğiniz ve İstemci sırrınızın gösterildiği, OAuth istemcisi oluşturuldu ekranı görüntülenir.
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 çalışma dizininize eklemeniz gerekir.

İstemci kitaplığını yükleme

• npm kullanarak kitaplıkları yükleyin:

  npm install googleapis@105 @google-cloud/local-auth@2.1.0 --save
  

Örneği ayarlayın

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

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

   gmail/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 {google} = require('googleapis');
   
   // If modifying these scopes, delete token.json.
   const SCOPES = ['https://www.googleapis.com/auth/gmail.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 google.auth.fromJSON(credentials);
     } catch (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.
    *
    */
   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 the labels in the user's account.
    *
    * @param {google.auth.OAuth2} auth An authorized OAuth2 client.
    */
   async function listLabels(auth) {
     const gmail = google.gmail({version: 'v1', auth});
     const res = await gmail.users.labels.list({
       userId: 'me',
     });
     const labels = res.data.labels;
     if (!labels || labels.length === 0) {
       console.log('No labels found.');
       return;
     }
     console.log('Labels:');
     labels.forEach((label) => {
       console.log(`- ${label.name}`);
     });
   }
   
   authorize().then(listLabels).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 sizden erişimi yetkilendirmeniz istenir:
   1. Google Hesabınızda henüz oturum açmadıysanız istendiğinde oturum açın. Eğer Birden fazla hesapta oturum açtıysanız yetkilendirme için kullanmak üzere bir hesap seçin.
   2. Kabul et'i tıklayın.

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

   Yetkilendirme bilgileri dosya sisteminde depolanır. Bu nedenle, örneği çalıştırdığınızda yetkilendirmeniz istenmez.

Sonraki adımlar

• Kimlik doğrulama ve yetkilendirme sorunlarını giderme
• Gmail API referans dokümanları
• GitHub'ın google-api-nodejs-client bölümü