Bu sayfa, Cloud Translation API ile çevrilmiştir.

Google Chat uygulaması olarak kimlik doğrulama

Bu kılavuzda, Chat uygulaması adına Google Chat API'ye erişmek için bir hizmet hesabının nasıl oluşturulacağı ve kullanılacağı açıklanmaktadır. İlk olarak, hizmet hesabı oluşturma konusunda size yol gösterir. Ardından, Chat API ile kimlik doğrulamak için hizmet hesabını kullanan bir komut dosyasının nasıl yazılacağı ve Chat alanında mesaj nasıl yayınlanacağı gösterilmektedir.

Chat uygulamaları, Google Chat API'yi eşzamansız olarak çağırırken kimlik doğrulaması yapmak için hizmet hesaplarını kullanabilir. Böylece:

spaces.messages.create ile Google Chat'e mesaj göndererek:
- Uzun süreli arka plan işinin çalışması tamamlandığında kullanıcıları bilgilendirin.
- Bir sunucunun çevrimdışı olduğu konusunda kullanıcıları uyarın.
- Müşteri desteği ekibinden yeni açılan bir müşteri destek kaydına ilgi göstermesini isteyin.
Daha önce spaces.messages.update ile gönderilmiş mesajları şu şekilde güncelleyin:
- Devam eden işlemde durumunun durumunu değiştirin.
- Görevin atandığı kişiyi veya son tarihini güncelleme.
Alandaki kullanıcıları spaces.members.list kullanarak listeleyerek:
- Bir alanda kimlerin olduğunu görün.
- Alan üyeliğinin bir ekipteki herkesi içerdiğini doğrulayın.

Bir hizmet hesabıyla kimliği doğrulandığında, Chat alanında veri almak veya alanda işlem gerçekleştirmek için Chat uygulamalarının alana üye olması gerekir. Örneğin, bir alanın üyelerini listelemek veya bir alanda mesaj oluşturmak için Chat uygulamasının alanın üyesi olması gerekir.

Chat uygulamanızın kullanıcı verilerine erişmesi veya kullanıcı adına işlem yapması gerekiyorsa bunun yerine kullanıcı olarak kimlik doğrulaması yapın.

Alan yöneticisiyseniz bir uygulamanın hizmet hesabına, her kullanıcıdan izin vermesi gerekmeden kullanıcılarınızın verilerine erişmesi için alan genelinde yetki verebilirsiniz. Alan genelinde yetkiyi yapılandırdıktan sonra kullanıcı hesabının kimliğine bürünmek için hizmet hesabınızı kullanarak API çağrıları yapabilirsiniz. Bir hizmet hesabı kimlik doğrulama için kullanılsa da alan genelinde yetki, bir kullanıcının kimliğine bürünür ve bu nedenle kullanıcı kimlik doğrulaması olarak kabul edilir. Kullanıcı kimlik doğrulaması gerektiren tüm işlevler için alan genelinde yetkiyi kullanabilirsiniz.

Chat uygulamalarının ne zaman kimlik doğrulama gerektirdiği ve ne tür kimlik doğrulaması kullanılacağı hakkında daha fazla bilgi edinmek için Chat API kimlik doğrulama ve yetkilendirmeye genel bakıştaki Gerekli kimlik doğrulama türleri bölümüne bakın.

Ön koşullar

Bu kılavuzdaki örneği çalıştırmak için aşağıdaki ön koşulları karşılamanız gerekir:

Google Chat 'e erişimi olan bir Google Workspace hesabı.
Chat API'nin etkin olduğu bir Google Cloud projesi Proje oluşturmak ve API'yi etkinleştirmek için Proje oluşturma ve API'yi etkinleştirme bölümünü inceleyin.
Chat alanı üyeliğiyle yayınlanmış bir Chat uygulaması:
- Chat uygulaması oluşturmak ve yayınlamak için Cloud Functions ile Google Chat uygulaması derleme başlıklı makaleyi inceleyin.
- Chat alanına Chat uygulaması eklemek için Google Chat'te alanlara veya görüşmelere uygulama ekleme başlıklı makaleyi inceleyin.

Ayrıca, dile özgü aşağıdaki önkoşullara ihtiyacınız vardır:

Java

JDK 1.7 veya üzeri
Maven paket yönetimi aracı

Başlatılmış bir Maven projesi. Yeni bir projeyi başlatmak için komut satırı arayüzünüzde aşağıdaki komutu çalıştırın:

mvn archetype:generate -DgroupId=com.google.chat.app.authsample -DartifactId=auth-sample-app -DarchetypeArtifactId=maven-archetype-quickstart -DarchetypeVersion=1.4 -DinteractiveMode=false

Python

Python 3.6 veya sonraki sürümler
pip paket yönetimi aracı

Node.js

Node.js
npm paket yönetim aracı
Başlatılmış bir Node.js projesi. Yeni bir projeyi başlatmak için yeni bir klasör oluşturup bu klasöre geçin, ardından komut satırı arayüzünüzde aşağıdaki komutu çalıştırın:
```
npm init
```

Apps Komut Dosyası

Google Cloud projenize bağlı bir Apps Komut Dosyası projesi. Bir Apps Komut Dosyası projesini başlatmak için Google Apps Komut Dosyası Sohbet uygulaması hızlı başlangıç kılavuzunu inceleyin.

1. Adım: Google Cloud Console'da bir hizmet hesabı oluşturun

Chat uygulamanızın Google API'lerine erişmek için kullanabileceği bir hizmet hesabı oluşturun.

Hizmet hesabı oluşturma

Hizmet hesabı oluşturmak için şu adımları uygulayın:

Google Cloud Console

Google Cloud konsolunda Menü > IAM ve Yönetici > Hizmet Hesapları'na gidin.
Hizmet Hesapları'na git
Hizmet hesabı oluştur'u tıklayın.
Hizmet hesabı ayrıntılarını doldurun, ardından Oluştur ve devam et'i tıklayın.
Not: Google varsayılan olarak benzersiz bir hizmet hesabı kimliği oluşturur. Kimliği değiştirmek isterseniz hizmet hesabı kimliği alanındaki kimliği değiştirin.
İsteğe bağlı: Google Cloud projenizin kaynaklarına erişim izni vermek için hizmet hesabınıza roller atayın. Daha ayrıntılı bilgi için Kaynaklara erişim izni verme, erişimi değiştirme ve iptal etme başlıklı makaleyi inceleyin.
Devam'ı tıklayın.
İsteğe bağlı: Bu hizmet hesabıyla işlemleri yönetebilen ve gerçekleştirebilen kullanıcıları veya grupları girin. Daha fazla bilgi için Hizmet hesabı kimliğine bürünmeyi yönetme başlıklı makaleye bakın.
Done'ı (Bitti) tıklayın. Hizmet hesabının e-posta adresini not edin.

gcloud CLI

Hizmet hesabını oluşturun:

gcloud iam service-accounts create SERVICE_ACCOUNT_NAME \
  --display-name="SERVICE_ACCOUNT_NAME"

İsteğe bağlı: Google Cloud projenizin kaynaklarına erişim izni vermek için hizmet hesabınıza roller atayın. Daha ayrıntılı bilgi için Kaynaklara erişim izni verme, erişimi değiştirme ve iptal etme başlıklı makaleyi inceleyin.

Hizmet hesabı, hizmet hesabı sayfasında görünür. Sonra, hizmet hesabı için bir özel anahtar oluşturun.

Özel anahtar oluşturun

Hizmet hesabı için özel anahtar oluşturmak ve indirmek üzere şu adımları uygulayın:

Google Cloud konsolunda Menü > IAM ve Yönetici > Hizmet Hesapları'na gidin.
Hizmet Hesapları'na git
Hizmet hesabınızı seçin.
Anahtarlar > Anahtar ekle > Yeni anahtar oluştur'u tıklayın.
JSON'yi seçip Oluştur'u tıklayın.
Yeni herkese açık/özel anahtar çiftiniz oluşturulur ve yeni bir dosya olarak makinenize indirilir. İndirilen JSON dosyasını çalışma dizininize credentials.json olarak kaydedin. Bu dosya, bu anahtarın tek kopyasıdır. Anahtarınızı güvenli bir şekilde nasıl saklayacağınız hakkında bilgi edinmek için Hizmet hesabı anahtarlarını yönetme konusuna bakın.
Close'u (Kapat) tıklayın.

Hizmet hesapları hakkında daha fazla bilgi için Google Cloud IAM belgelerindeki hizmet hesapları bölümüne bakın.

2. Adım: Google istemci kitaplığını ve diğer bağımlılıkları yükleyin

Google istemci kitaplığını ve proje için gereken diğer bağımlılıkları yükleyin.

Java

Google istemci kitaplıklarını ve diğer gerekli bağımlılıkları Maven projenize eklemek için projenizin dizininde pom.xml dosyasını düzenleyin ve aşağıdaki bağımlılıkları ekleyin:

<dependencies>
  <!-- ... existing dependencies ... -->
  <dependency>
    <groupId>com.google.apis</groupId>
    <artifactId>google-api-services-chat</artifactId>
    <version>v1-rev20230905-2.0.0</version>
  </dependency>
  <dependency>
    <groupId>com.google.auth</groupId>
    <artifactId>google-auth-library-oauth2-http</artifactId>
    <version>1.19.0</version>
  </dependency>
  <dependency>
      <groupId>com.google.code.gson</groupId>
      <artifactId>gson</artifactId>
      <version>2.10.1</version>
  </dependency>
</dependencies>

Python

Python için Google istemci kitaplıklarını henüz yüklemediyseniz komut satırı arayüzünüzde aşağıdaki komutu çalıştırın:

pip3 install --upgrade google-api-python-client google-auth

Node.js

Google istemci kitaplıklarını Node.js projenize eklemek için projenizin dizinine geçiş yapın ve komut satırı arayüzünüzde aşağıdaki komutu çalıştırın:

npm install "@googleapis/chat"

Apps Komut Dosyası

Bu örnekte, hizmet hesabı kimlik doğrulaması için bir JWT jetonu oluşturmak amacıyla Apps Komut Dosyası kitaplığı için OAuth2 kullanılmaktadır. Kitaplığı Apps Komut Dosyası projenize eklemek için:

Sol kısımdan Düzenleyici'yi tıklayın.
Solda, Kitaplıklar'ın yanındaki Kitaplık ekle'yi tıklayın.
1B7FSrk5Zi6L1rSxxTDgDEUsPzlukDsi4KGuTMorsTQHhGBzBkMun4iDF komut dosyası kimliğini girin.
Ara'yı ve ardından Ekle'yi tıklayın.

Bu örnekte, Google Chat API'yi çağırmak için Advanced Chat hizmeti kullanılmaktadır. Apps Komut Dosyası projenizde hizmeti etkinleştirmek için:

Sol kısımdan Düzenleyici'yi tıklayın.
Solda, Hizmetler'in yanındaki Hizmet ekle'yi tıklayın.
Google Chat API'yi seçin.
Sürüm bölümünde v1'i seçin.
Ekle'yi tıklayın.

İstemci kitaplıklarımızın desteklediği herhangi bir dili kullanabilirsiniz.

3. Adım: Chat API ile kimlik doğrulamak için hizmet hesabını kullanan bir komut dosyası yazın

Aşağıdaki kod, bir hizmet hesabı kullanarak Chat API ile kimlik doğrular ve ardından bir Chat alanında mesaj yayınlar:

Java

Projenizin dizininde src/main/java/com/google/chat/app/authsample/App.java dosyasını açın.

App.java içindeki içeriği aşağıdaki kodla değiştirin:

package com.google.chat.app.authsample;

import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
import com.google.api.client.http.HttpRequestInitializer;
import com.google.api.client.json.gson.GsonFactory;
import com.google.api.services.chat.v1.HangoutsChat;
import com.google.api.services.chat.v1.model.Message;
import com.google.auth.http.HttpCredentialsAdapter;
import com.google.auth.oauth2.GoogleCredentials;

/**
 * Authenticates with Chat API via service account credentials,
 * then creates a Chat message.
 */
public class App {
    // Specify required scopes.
    private static final String CHAT_SCOPE = "https://www.googleapis.com/auth/chat.bot";

    // Specify service account details.
    private static final String PRIVATE_KEY_RESOURCE_URI = "/credentials.json";

    public static void main( String[] args ) {
        try {
            // Run app.
            Message response = App.createChatMessage();
            // Print details about the created message.
            System.out.println(response);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    private static Message createChatMessage() throws Exception {
        // Build the Chat API client and authenticate with the service account.
        GoogleCredentials credentials = GoogleCredentials.fromStream(
            App.class.getResourceAsStream(PRIVATE_KEY_RESOURCE_URI))
            .createScoped(CHAT_SCOPE);
        HttpRequestInitializer requestInitializer = new HttpCredentialsAdapter(credentials);
        HangoutsChat chatService = new HangoutsChat.Builder(
            GoogleNetHttpTransport.newTrustedTransport(),
            GsonFactory.getDefaultInstance(),
            requestInitializer)
            .setApplicationName("auth-sample-app")
            .build();

        // The space to create the message in.
        //
        // Replace SPACE_NAME with a space name.
        // Obtain the space name from the spaces resource of Chat API,
        // or from a space's URL.
        String spaceName = "spaces/SPACE_NAME";

        // Create a Chat message.
        Message message = new Message().setText("Hello, world!");
        return chatService.spaces().messages().create(spaceName, message).execute();
    }
}

Kodda SPACE_NAME yerine bir alan adı girin. Bu adı Chat API'deki spaces.list yönteminden veya bir alanın URL'sinden alabilirsiniz.
Projenizin dizininde resources adlı yeni bir alt dizin oluşturun.
Hizmet hesabınız için özel anahtar dosyasının credentials.json olarak adlandırıldığından emin olun ve dosyayı resources alt dizinine kopyalayın.
Maven'i özel anahtar dosyasını proje paketine dahil edecek şekilde yapılandırmak için projenizin dizininde pom.xml dosyasını düzenleyin ve <build> bölümüne aşağıdaki yapılandırmayı ekleyin:
```
<build>
  
  <resources>
    <resource>
      <directory>resources</directory>
    </resource>
  </resources>
</build>
```

Maven'i bağımlılıkları proje paketine dahil edecek şekilde yapılandırmak ve uygulamanızın ana sınıfını yürütmek için projenizin dizininde pom.xml dosyasını düzenleyin ve aşağıdaki yapılandırmayı <plugins> bölümüne ekleyin:

<plugins>
  <!-- ... existing configurations ... -->
  <plugin>
    <artifactId>maven-assembly-plugin</artifactId>
    <configuration>
      <archive>
        <manifest>
          <mainClass>com.google.chat.app.authsample.App</mainClass>
        </manifest>
      </archive>
      <descriptorRefs>
        <descriptorRef>jar-with-dependencies</descriptorRef>
      </descriptorRefs>
    </configuration>
  </plugin>
</plugins>

Python

Çalışma dizininizde chat_app_auth.py adlı bir dosya oluşturun.

Aşağıdaki kodu chat_app_auth.py bölümüne ekleyin:

from apiclient.discovery import build
from google.oauth2 import service_account

# Specify required scopes.
SCOPES = ['https://www.googleapis.com/auth/chat.bot']

# Specify service account details.
CREDENTIALS = service_account.Credentials.from_service_account_file(
    'credentials.json', scopes=SCOPES)

# Build the URI and authenticate with the service account.
chat = build('chat', 'v1', credentials=CREDENTIALS)

# Create a Chat message.
result = chat.spaces().messages().create(

    # The space to create the message in.
    #
    # Replace SPACE_NAME with a space name.
    # Obtain the space name from the spaces resource of Chat API,
    # or from a space's URL.
    parent='spaces/SPACE_NAME',

    # The message to create.
    body={'text': 'Hello, world!'}

).execute()

# Prints details about the created message.
print(result)

Kodda SPACE_NAME yerine bir alan adı girin. Bu adı Chat API'deki spaces.list yönteminden veya bir alanın URL'sinden alabilirsiniz. Hizmet hesabınızın özel anahtar dosyasının credentials.json olarak adlandırıldığından emin olun.

Node.js

Projenizin dizininde chat_app_auth.js adlı bir dosya oluşturun.

Aşağıdaki kodu chat_app_auth.js bölümüne ekleyin:

const chat = require('@googleapis/chat');

async function createMessage() {
  const auth = new chat.auth.GoogleAuth({

    // Specify service account details.
    keyFilename: 'credentials.json',

    // Specify required scopes.
    scopes: ['https://www.googleapis.com/auth/chat.bot']

  });
  const authClient = await auth.getClient();

  // Create the Chat API client and authenticate with the service account.
  const chatClient = await chat.chat({
    version: 'v1',
    auth: authClient
  });

  // Create a Chat message.
  const result = await chatClient.spaces.messages.create({

    // The space to create the message in.
    //
    // Replace SPACE_NAME with a space name.
    // Obtain the space name from the spaces resource of Chat API,
    // or from a space's URL.
    parent: 'spaces/SPACE_NAME',

    // The message to create.
    requestBody: { 'text': 'Hello, world!' }

  });
  return result;
}

// Execute function then print details about the created message.
createMessage().then(console.log);

Kodda SPACE_NAME yerine bir alan adı girin. Bu adı Chat API'deki spaces.list yönteminden veya bir alanın URL'sinden alabilirsiniz. Hizmet hesabınızın özel anahtar dosyasının credentials.json olarak adlandırıldığından emin olun.

Apps Komut Dosyası

Apps Komut Dosyası düzenleyicisinde appsscript.json dosyasını düzenleyin ve hizmet hesabı OAuth jetonunu almak üzere harici isteklerde bulunmak için gereken OAuth kapsamını ekleyin:
```
  "oauthScopes": [
    "https://www.googleapis.com/auth/script.external_request"
  ]
```

Aşağıdaki kodu, Apps Komut Dosyası projenizde ChatAppAuth.gs adlı bir dosyaya kaydedin:

// Specify the contents of the file credentials.json.
const CREDENTIALS = CREDENTIALS;

const SCOPE = 'https://www.googleapis.com/auth/chat.bot';

// The space to create the message in.
//
// Replace SPACE_NAME with a space name.
// Obtain the space name from the spaces resource of Chat API,
// or from a space's URL.
const PARENT = 'spaces/SPACE_NAME'

/**
 * Authenticates with Chat API via app credentials, then posts a message.
 */
function createMessageWithAppCredentials() {
  try {
    const service = getService_();
    if (!service.hasAccess()) {
      console.error(service.getLastError());
      return;
    }

    // Specify the message to create.
    const message = {'text': 'Hello world!'};

    // Call Chat API with a service account to create a message.
    const result = Chat.Spaces.Messages.create(
        message,
        PARENT,
        {},
        // Authenticate with the service account token.
        {'Authorization': 'Bearer ' + service.getAccessToken()});

    // Log details about the created message.
    console.log(result);

  } catch (err) {
    // TODO (developer) - Handle exception.
    console.log('Failed to create message with error %s', err.message);
  }
}

/**
 * Configures the OAuth library to authenticate with the service account.
 */
function getService_() {
  return OAuth2.createService(CREDENTIALS.client_email)
      .setTokenUrl('https://oauth2.googleapis.com/token')
      .setPrivateKey(CREDENTIALS.private_key)
      .setIssuer(CREDENTIALS.client_email)
      .setSubject(CREDENTIALS.client_email)
      .setScope(SCOPE)
      .setPropertyStore(PropertiesService.getScriptProperties());
}

Kodda, CREDENTIALS öğesini credentials.json dosyasının içeriğiyle değiştirin.
Kodda SPACE_NAME yerine bir alan adı girin. Bu adı Chat API'deki spaces.list yönteminden veya bir alanın URL'sinden alabilirsiniz.

4. Adım: Örneğin tamamını çalıştırın

Çalışma dizininizde örneği derleyin ve çalıştırın:

Java

mvn compile assembly:single
java -jar target/auth-sample-app-1.0-SNAPSHOT-jar-with-dependencies.jar

Python

python3 chat_app_auth.py

Node.js

node chat_app_auth.js

Apps Komut Dosyası

Apps Komut Dosyası Düzenleyicisi'nde ChatAppAuth.gs dosyasını açın ve Çalıştır'ı tıklayın.

Komut dosyanız, Chat API'ye kimliği doğrulanmış istek gönderir. API, Chat alanında bir mesajı Chat uygulaması olarak yayınlayarak yanıt verir.

Örnekteki sorunları giderin

Bu bölümde, bu örneği çalıştırmaya çalışırken karşılaşabileceğiniz yaygın sorunlar açıklanmaktadır.

Bu uygulamayı kullanma izniniz yok

Komut dosyasını çalıştırırken şu hata mesajını alabilirsiniz:

<HttpError 403 when requesting https://chat.googleapis.com/v1/spaces/{space}/messages?alt=json returned "You are not permitted to use this app". Details: "You are not permitted to use this app">

Bu hata mesajı, Chat uygulamasının, belirtilen Chat alanında Chat mesajı oluşturma izni olmadığı anlamına gelir.

Hatayı gidermek için Chat uygulamasını komut dosyasında belirtilen Chat alanına ekleyin.

Chat API referans belgelerini inceleyerek Chat API'nin başka neler yapabileceğini öğrenin.

Google Chat uygulaması olarak kimlik doğrulama

Ön koşullar

Java

Python

Node.js

Apps Komut Dosyası

1. Adım: Google Cloud Console'da bir hizmet hesabı oluşturun

Hizmet hesabı oluşturma

Google Cloud Console

gcloud CLI

Özel anahtar oluşturun

2. Adım: Google istemci kitaplığını ve diğer bağımlılıkları yükleyin

Java

Python

Node.js

Apps Komut Dosyası

3. Adım: Chat API ile kimlik doğrulamak için hizmet hesabını kullanan bir komut dosyası yazın

Java

Python

Node.js

Apps Komut Dosyası

4. Adım: Örneğin tamamını çalıştırın

Java

Python

Node.js

Apps Komut Dosyası

Örnekteki sorunları giderin

Bu uygulamayı kullanma izniniz yok

İlgili konular