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. Listelenecek bir alana ait etkinlikleri görüntülemesi için kimliği doğrulanan kullanıcı alanın bir üyesi olmalıdır.
Ön koşullar
Python
- İşletme veya Kuruluş Şuna erişimi olan Google Workspace hesabı: Google Chat.
- Ortamınızı ayarlayın:
- Bir Google Cloud projesi oluşturun.
- OAuth izin ekranını yapılandırın.
- Google Chat API'yi etkinleştirin ve yapılandırın. Bunun için bir ad girin, Chat uygulamanızın simgesi ve açıklaması.
-
Bir masaüstü uygulaması için OAuth istemci kimliği kimlik bilgileri oluşturun. Örneği bu
yoksa, kimlik bilgilerini
client_secrets.json
adlı bir JSON dosyası olarak yerel dizini oluşturun.
- Kullanıcı kimlik doğrulamasını destekleyen bir yetkilendirme kapsamı seçin.
Alan etkinliklerini listeleyin
Bir Chat alanındaki alan etkinliklerini listelemek için aşağıdakileri yapın:
list
yöntemini çağırınSpaceEvent
üzerinde bakın.-
filter
girin. En az bir etkinlik türü belirtmeniz gerekir. Şu ölçüte göre de filtreleyebilirsiniz: tarihi. Desteklenen etkinlik türlerinin listesi içineventType
sayfasına göz atın. alanına dokunun. - kullanıcı ile kimlik doğrulaması kullanıyorsanız İsteğinizdeki her etkinlik türünü desteklemek için bir veya daha fazla yetkilendirme kapsamı. En iyi uygulama olarak, GA4 Çevrimiçi Kitleler'i kullanmaya devam eden uygulamanızın çalışmasına olanak tanır. Kapsam seçmek için Kimlik doğrulama ve yetkilendirmeye genel bakış.
Aşağıdaki kod örneğinde yeni üyeliklerle ilgili etkinlikleri listeleyecek ve mesaj gönderebilir.
Python
- Çalışma dizininizde
chat_space_event_list.py
adlı bir dosya oluşturun. 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)
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.
Ç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 maksimumSpaceEvent
kaynak sayısı. Hizmet bu değerden daha az değer döndürebilir. Negatif değerlerINVALID_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.