Bir Google Chat alanındaki etkinlikleri listeleme

Bu kılavuzda, list özelliğinin nasıl kullanılacağı açıklanmaktadır. SpaceEvent kaynağındaki yöntemi .

SpaceEvent kaynağı Alanın alt kaynakları da dahil olmak üzere hedef alanda yapılan bir değişikliği temsil eder gibi performans metriklerine göz atabilirsiniz. Daha fazla bilgi için Desteklenen etkinlik türlerinin ve etkinlik yüklerinin listesini görmek için eventType ve SpaceEvent kaynağının payload alanı referans belgeler.

İstek zamanından en fazla 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, alanın yeni üyeleriyle ilgili etkinlikleri listelerseniz sunucu En güncel üyelik ayrıntılarını içeren Membership kaynak. Yeni ise talep edilen dönemde üyeler kaldırıldıysa etkinlik yükü bir boş Membership kaynağı var.

Bu yöntemi çağırmak için user kimlik doğrulama. Kime bir alana ait etkinlik görüntüleme işlemi için, kimliği doğrulanan kullanıcı alanın bir üyesi olmalıdır.

Ön koşullar

Python

  • Python 3.6 veya sonraki sürümler
  • pip paket yönetim aracı
  • En yeni Google istemci kitaplıkları. Bu uygulamaları yüklemek veya güncellemek için komut satırı arayüzünüzde aşağıdaki komutu çalıştırın:
    pip3 install --upgrade google-api-python-client google-auth-oauthlib
    

Alan etkinliklerini listeleyin

Bir Chat alanındaki alan etkinliklerini listelemek için aşağıdakileri yapın:

Aşağıdaki kod örneğinde yeni üyeliklerle ilgili etkinlikleri listeleyecek ve mesaj gönderebilir.

Python

  1. Çalışma dizininizde chat_space_event_list.py adlı bir dosya oluşturun.
  2. Aşağıdaki kodu chat_space_event_list.py bölümüne ekleyin:

    """Lists SpaceEvent resources from the Chat API."""
    
    from google_auth_oauthlib.flow import InstalledAppFlow
    from googleapiclient.discovery import build
    
    # Define your app's authorization scopes.
    # When modifying these scopes, delete the file token.json, if it exists.
    SCOPES = ["https://www.googleapis.com/auth/chat.memberships.readonly",
    "https://www.googleapis.com/auth/chat.messages.readonly"]
    
    # Authenticate with Google Workspace
    # and get user authorization.
    flow = InstalledAppFlow.from_client_secrets_file(
                'client_secrets.json', SCOPES)
    creds = flow.run_local_server()
    
    # Build a service endpoint for Chat API.
    chat = build(
      'chat',
      'v1',
      credentials=creds,
    )
    
    # Use the service endpoint to call Chat API.
    result = chat.spaces().spaceEvents().list(
    
        # The space from which to list events.
        #
        # Replace SPACE with a space name.
        # Obtain the space name from the spaces resource of Chat API,
        # or from a space's URL.
        parent='spaces/SPACE',
    
        # A required filter. Filters and returns events about new memberships and messages
        filter='event_types:"google.workspace.chat.membership.v1.created" OR event_types:"google.workspace.chat.message.v1.created"'
    
    ).execute()
    
    # Prints details about the created space events.
    print(result)
    
  3. Bu kodda, aşağıdakini değiştirin:

    • SPACE: şuradan alabileceğiniz bir alan adı: spaces.list yöntemi API'den veya bir alanın URL'sinden.
  4. Çalışma dizininizde örneği derleyin ve çalıştırın:

    python3 chat_space_event_list.py
    

Chat API, SpaceEvent kaynak Yeni üyelikler ve mesajlarla ilgili etkinlikler.

Sayfalara ayırma işlemini özelleştirin

İsteğe bağlı olarak, sayfalara ayırma işlemini özelleştirmek için aşağıdaki sorgu parametrelerini iletin:

  • pageSize: Döndürülecek maksimum SpaceEvent kaynak sayısı. Hizmet bu değerden daha az değer döndürebilir. Negatif değerler, INVALID_ARGUMENT hata.
  • pageToken: Önceki bir liste alanı etkinlikleri çağrısından alınan bir sayfa jetonu. Sonraki sayfayı almak için bu jetonu sağlayın. Sayfalara ayırırken filtre değerinin, sayfa jetonunu sağlayan çağrıyla eşleşmesi gerekir. Doğru cevap beklenmedik sonuçlara yol açabilir.