Method: spaces.spaceEvents.list

Bir Google Chat alanındaki etkinlikleri listeler. Her etkinlik için payload, Chat kaynağının en son sürümünü içerir. Örneğin, alanın yeni üyeleriyle ilgili etkinlikleri listelerseniz sunucu, en güncel üyelik ayrıntılarını içeren Membership kaynaklarını döndürür. İstenen dönemde yeni üyeler kaldırılırsa etkinlik yükü boş bir Membership kaynağı içerir.

Kullanıcı kimlik doğrulaması gerekir. Etkinlikleri listelemek için, kimliği doğrulanmış kullanıcının alanın bir üyesi olması gerekir.

Örnek için Bir Google Chat alanındaki etkinlikleri listeleme başlıklı makaleyi inceleyin.

HTTP isteği

GET https://chat.googleapis.com/v1/{parent=spaces/*}/spaceEvents

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Yol parametreleri

Parametreler
parent

string

Zorunlu. Etkinliklerin gerçekleştiği Google Chat alanının kaynak adı.

Biçim: spaces/{space}.

Sorgu parametreleri

Parametreler
pageSize

integer

İsteğe bağlı. Döndürülen maksimum alan etkinliği sayısı. Hizmet bu değerden daha az değer döndürebilir.

Negatif değerler INVALID_ARGUMENT hatası döndürür.

pageToken

string

Önceki bir liste alanı etkinlikleri çağrısından alınan bir sayfa jetonu. Sonraki sayfayı almak için bunu sağlayın.

Sayfalara ayırma işlemi sırasında alan etkinliklerini listelemek için sağlanan diğer tüm parametreler, sayfa jetonunu sağlayan çağrıyla eşleşmelidir. Diğer parametrelere farklı değerler aktarmak beklenmedik sonuçlara yol açabilir.

filter

string

Zorunlu. Sorgu filtresi.

Sahip : operatörünü kullanarak en az bir etkinlik türü (eventType) belirtmelisiniz. Birden çok etkinlik türüne göre filtrelemek için OR operatörünü kullanın. Filtrenizde toplu etkinlik türlerini atlayın. İstek, ilgili tüm toplu etkinlikleri otomatik olarak döndürür. Örneğin, yeni tepkilere göre filtreleme yaparsanız (google.workspace.chat.reaction.v1.created) sunucu, yeni tepkileri toplu olarak da (google.workspace.chat.reaction.v1.batchCreated) döndürür. Desteklenen etkinlik türlerinin listesi için SpaceEvents referans belgelerine göz atın.

Dilerseniz başlangıç zamanı (startTime) ve bitiş zamanı (endTime) temelinde de filtreleme yapabilirsiniz:

  • startTime: Alan etkinliklerinin listelenmeye başlaması için kullanılacak özel zaman damgası. 28 gün öncesine kadar gerçekleşmiş etkinlikleri listeleyebilirsiniz. Belirtilmemişse son 28 gündeki alan etkinlikleri listelenir.
  • endTime: Alan etkinliklerinin listelendiğine kadar olan kapsayıcı zaman damgası. Belirtilmemişse istek zamanına kadar olan etkinlikler listelenir.

Bir başlangıç veya bitiş zamanı belirtmek için eşittir = operatörünü ve RFC-3339'daki biçimini kullanın. Hem startTime hem de endTime ölçütüne göre filtrelemek için AND operatörünü kullanın.

Örneğin, aşağıdaki sorgular geçerlidir:

startTime="2023-08-23T19:20:33+00:00" AND
endTime="2023-08-23T19:21:54+00:00"
startTime="2023-08-23T19:20:33+00:00" AND
(eventTypes:"google.workspace.chat.space.v1.updated" OR
eventTypes:"google.workspace.chat.message.v1.created")

Şu sorgular geçersizdir:

startTime="2023-08-23T19:20:33+00:00" OR
endTime="2023-08-23T19:21:54+00:00"
eventTypes:"google.workspace.chat.space.v1.updated" AND
eventTypes:"google.workspace.chat.message.v1.created"

Geçersiz sorgular INVALID_ARGUMENT hatasıyla sunucu tarafından reddedilir.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

Alan etkinliklerinin listelenmesi için yanıt mesajı.

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi
{
  "spaceEvents": [
    {
      object (SpaceEvent)
    }
  ],
  "nextPageToken": string
}
Alanlar
spaceEvents[]

object (SpaceEvent)

Sonuçlar kronolojik sırada (önce en eski etkinlik) döndürülür.

nextPageToken

string

Daha fazla etkinlik getirmek için kullanılan devam jetonu. Bu alan atlanırsa sonraki sayfa olmaz.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

Daha fazla bilgi için Yetkilendirme kılavuzunu inceleyin.