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

Directory API'ye istek gönderen 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ına uygun, 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 önerilen API istemci kitaplıkları kullanılmaktadır.

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ıcı çalıştırmak için aşağıdaki ön koşulları karşılamanız gerekir:

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.

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

  1. Google API Konsolu'nda Menü > Google Auth platform > Markalama'ya gidin.

    Markalama'ya gidin

  2. Google Auth platformunu zaten yapı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 not configured yet (Google Auth platformu henüz yapılandırılmadı) mesajını görürseniz Get Started'ı (Başlayın) tıklayın:
    1. Uygulama Bilgileri bölümündeki Uygulama adı alanına uygulama için bir ad girin.
    2. Kullanıcı destek e-postası bölümünde, kullanıcıların izinleriyle 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 Şirket içi'ni seçin.
    5. İleri'yi tıklayın.
    6. İletişim Bilgileri bölümünde, projenizle ilgili değişiklikler hakkında 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 ekleme adımını 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 edinmek için OAuth iznini yapılandırma kılavuzunun tamamını inceleyin.

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, Google'ın OAuth sunucularına tek bir uygulamayı tanımlamak 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 Console'da Menü > Google Auth platform > Clients'a (İstemciler) 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. Name (Ad) alanına kimlik bilgisi için bir ad yazın. Bu ad yalnızca Google Cloud Console'da gösterilir.
  5. İsteğe bağlı: Uygulamanız, kullanıcılar adına harekete geçen bir yapay zeka aracısıysa Bu istemciyi yapay zeka destekli bir aracı için kullan'ı seçin. Uygulamanız hem yapay zeka ajanı iş akışlarını hem de standart kullanıcı özelliklerini destekliyorsa her biri için ayrı OAuth istemcileri oluşturun. Müşteriyi oluşturduktan sonra bu ayarı değiştiremezsiniz.
  6. Oluştur'u tıklayın.

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

  7. İndirilen JSON dosyasını credentials.json olarak kaydedin ve dosyayı çalışma dizininize taşıyın.

İ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 ayarlama

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

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

    adminSDK/directory/index.js
    import path from 'node:path';
import process from 'node:process';
import {authenticate} from '@google-cloud/local-auth';
import {google} from 'googleapis';

// The scope for the Admin SDK Directory API.
const SCOPES = ['https://www.googleapis.com/auth/admin.directory.user'];
// The path to the credentials file.
const CREDENTIALS_PATH = path.join(process.cwd(), 'credentials.json');

/**
 * Lists the first 10 users in the domain.
 */
async function listUsers() {
  // Authenticate with Google and get an authorized client.
  const auth = await authenticate({
    scopes: SCOPES,
    keyfilePath: CREDENTIALS_PATH,
  });

  // Create a new Admin SDK Directory API client.
  const service = google.admin({version: 'directory_v1', auth});
  // Get the list of users.
  const result = await service.users.list({
    customer: 'my_customer',
    maxResults: 10,
    orderBy: 'email',
  });

  const users = result.data.users;
  if (!users || users.length === 0) {
    console.log('No users found.');
    return;
  }

  // Print the primary email and full name of each user.
  console.log('Users:');
  users.forEach((user) => {
    console.log(`${user.primaryEmail} (${user.name?.fullName})`);
  });
}

await listUsers();

Örneği çalıştırma

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

    node .
  1. Örneği ilk kez çalıştırdığınızda erişim yetkisi vermeniz 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.

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

    Yetkilendirme bilgileri dosya sisteminde depolandığı için örnek kodu bir sonraki çalıştırışınızda yetkilendirme istemiyle karşılaşmazsınız.

Sonraki adımlar