Bir Google Chat alanındaki etkinlikleri listeleme

Bu kılavuzda, bir alandaki kaynaklarda yapılan değişiklikleri listelemek için Google Chat API'nin SpaceEvent kaynağında list() yönteminin nasıl kullanılacağı açıklanmaktadır.

SpaceEvent kaynağı, mesajlar, tepkiler ve üyelikler gibi alanın alt kaynakları da dahil olmak üzere hedef alanda yapılan bir değişikliği temsil eder. Desteklenen etkinlik türleri ve etkinlik yükleri listesi hakkında daha fazla bilgi için SpaceEvent kaynak referans dokümanının eventType ve payload alanlarına bakın.

İstek zamanından 28 gün öncesine kadar olan etkinlikleri listeleyebilirsiniz. Sunucu, etkilenen kaynağın en son sürümünü içeren etkinlikleri döndürür. Örneğin, yeni alan üyeleriyle ilgili etkinlikleri listelerseniz sunucu, en son üyelik ayrıntılarını içeren Membership kaynaklarını döndürür. İstenen dönemde yeni üyeler kaldırıldıysa etkinlik yükü boş bir Membership kaynağı içerir.

Bir alandaki etkinlikleri listelemek için kimliği doğrulanmış kullanıcının veya Chat uygulamasının alanın üyesi olması gerekir.

Ön koşullar

Node.js

Python

Alan etkinliklerini listeleme (kullanıcı kimlik doğrulaması)

Bir Chat alanındaki alan etkinliklerini listelemek için isteğinizde aşağıdakileri iletin:

  • İsteğinizdeki her etkinlik türünü desteklemek için bir veya daha fazla yetkilendirme kapsamı belirtin. En iyi uygulama olarak, uygulamanızın çalışmasına izin veren en kısıtlayıcı kapsamı seçin. Kapsam seçme hakkında bilgi edinmek için Kimlik doğrulama ve yetkilendirmeye genel bakış başlıklı makaleyi inceleyin.

  • Listelenecek etkinlik türlerinin filter değerini ileterek ListSpaceEvents() yöntemini çağırın. En az bir etkinlik türü belirtmeniz gerekir. Ayrıca tarihe göre de filtreleme yapabilirsiniz. Desteklenen etkinlik türlerinin listesi için SpaceEvent kaynağının eventType alanıyla ilgili referans belgelerine bakın.

Aşağıdaki örnekte, bir alandaki yeni üyelikler ve mesajlarla ilgili etkinlikler listelenmiştir:

Node.js

chat/client-libraries/cloud/list-space-events-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';

// Authorization scopes based on the event types
const USER_AUTH_OAUTH_SCOPES = [
  'https://www.googleapis.com/auth/chat.memberships.readonly',
  'https://www.googleapis.com/auth/chat.messages.readonly',
];

// This sample shows how to list space events with user credential
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(
    USER_AUTH_OAUTH_SCOPES,
  );

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME here
    parent: 'spaces/SPACE_NAME',
    // A required filter. Filters events about new memberships and messages.
    filter:
      'eventTypes:"google.workspace.chat.membership.v1.created" OR eventTypes:"google.workspace.chat.message.v1.created"',
  };

  // Make the request
  const pageResult = chatClient.listSpaceEventsAsync(request);

  // Handle the response. Iterating over pageResult will yield results and
  // resolve additional pages automatically.
  for await (const response of pageResult) {
    console.log(response);
  }
}

await main();

Bu örneği çalıştırmak için SPACE_NAME yerine alanın name kimliğini girin. Kimliği ListSpaces() yöntemini çağırarak veya alanın URL'sinden alabilirsiniz.

Chat API, yeni üyelikler ve mesajlarla ilgili sayfalandırılmış alan etkinlikleri listesi döndürür.

Alan etkinliklerini listeleme (Chat uygulaması kimlik doğrulaması)

Uygulama kimlik doğrulaması için tek seferlik yönetici onayı gerekir.

Uygulama kimlik doğrulaması ve Chat REST API'nin kullanıldığı bir alandaki alan etkinliklerini listelemek için isteğinizde aşağıdakileri iletin:

  • İsteğinizdeki her etkinlik türünü desteklemek için bir veya daha fazla yetkilendirme kapsamı belirtin. En iyi uygulama olarak, uygulamanızın çalışmasına izin veren en kısıtlayıcı kapsamı seçin. Kapsam seçme hakkında daha fazla bilgi edinmek için Kimlik doğrulama ve yetkilendirmeye genel bakış başlıklı makaleyi inceleyin.
    • https://www.googleapis.com/auth/chat.app.memberships
    • https://www.googleapis.com/auth/chat.app.messages.readonly
    • https://www.googleapis.com/auth/chat.app.spaces
  • list yöntemini spaceEvents kaynağında çağırın.
  • Mesajların listeleneceği alanın name değerini iletin.
  • Belirli etkinlik türlerini sorgulamak için filter iletin.

API anahtarı oluşturma

Bir geliştirici önizlemesi API yöntemini çağırmak için API bulma belgesinin herkese açık olmayan bir geliştirici önizlemesi sürümünü kullanmanız gerekir. İsteğin kimliğini doğrulamak için bir API anahtarı iletmeniz gerekir.

API anahtarı oluşturmak için uygulamanızın Google Cloud projesini açın ve aşağıdakileri yapın:

  1. Google Cloud Console'da Menü > API'ler ve Hizmetler > Kimlik Bilgileri'ne gidin.

    Kimlik Bilgileri'ne git

  2. Kimlik bilgileri oluştur > API anahtarı'nı tıklayın.
  3. Yeni API anahtarınız gösterilir.
    • Uygulamanızın kodunda kullanmak üzere API anahtarınızı kopyalamak için Kopyala'yı tıklayın. API anahtarını, projenizin kimlik bilgilerinin "API Anahtarları" bölümünde de bulabilirsiniz.
    • Yetkisiz kullanımı önlemek için API anahtarının nerede ve hangi API'ler için kullanılabileceğini kısıtlamanızı öneririz. Daha fazla bilgi için API kısıtlamaları ekleme başlıklı makaleyi inceleyin.

Chat API'yi çağıran bir komut dosyası yazma

Uygulama kimlik doğrulaması ve Chat REST API ile alan etkinliklerini listeleme adımları aşağıda verilmiştir:

Python

  1. Çalışma dizininizde chat_spaceevents_list_app.py adlı bir dosya oluşturun.
  2. chat_spaceevents_list_app.py'ya aşağıdaki kodu ekleyin:

    from google.oauth2 import service_account
    from apiclient.discovery import build
    
    # Define your app's authorization scopes.
    # Set authorization scopes based on the
    # event type. For example, if you are getting a space event
    # about a new membership, use the `chat.app.memberships.readonly` scope.
    #
    # When modifying these scopes, delete the file token.json, if it exists.
    SCOPES = ["https://www.googleapis.com/auth/chat.app.memberships",
              "https://www.googleapis.com/auth/chat.app.messages.readonly",
              "https://www.googleapis.com/auth/chat.app.spaces"]
    
    def main():
        '''
        Authenticates with Chat API using app authentication,
        then lists space events from a specified space.
        '''
    
        # Specify service account details.
        creds = (
            service_account.Credentials.from_service_account_file('credentials.json')
            .with_scopes(SCOPES)
        )
    
        # Build a service endpoint for Chat API.
        chat = build('chat', 'v1', credentials=creds, discoveryServiceUrl='https://chat.googleapis.com/$discovery/rest?version=v1&labels=DEVELOPER_PREVIEW&key=API_KEY')
    
        # Use the service endpoint to call Chat API.
        result = chat.spaces().spaceEvents().list(
    
            # The space to list events from.
            #
            # 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',
    
            # A required filter. Filters events by event type.
            #
            # Update this filter to match your requirements.
            filter='eventTypes:"google.workspace.chat.message.v1.created"'
    
        ).execute()
    
        # Print Chat API's response in your command line interface.
        print(result)
    
    if __name__ == '__main__':
        main()
    
  3. Koddaki aşağıdaki yerleri değiştirin:

    • API_KEY: Chat API için hizmet uç noktası oluşturmak üzere oluşturduğunuz API anahtarı.
    • SPACE_NAME: Chat API'deki spaces.list yöntemiyle veya bir alanın URL'sinden alabileceğiniz alan adı.
  4. Çalışma dizininizde örneği oluşturun ve çalıştırın:

    python3 chat_spaceevents_list_app.py

Chat API, yeni üyelikler ve mesajlarla ilgili sayfalandırılmış alan etkinlikleri listesi döndürür.