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, yeni alan üyeleriyle ilgili etkinlikleri listelerseniz sunucu, en son üyelik ayrıntılarını içeren Membership kaynakları döndürür. İstenen dönemde yeni üyeler kaldırıldıysa etkinlik yükü boş bir Membership kaynağı içerir.

Kullanıcı kimlik doğrulaması gerektirir. Etkinlikleri listelemek için kimliği doğrulanmış kullanıcının alanın ü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 sonuç döndürebilir.

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

pageToken

string

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

Sayfalandırma yaparken, 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 göndermek beklenmedik sonuçlara neden olabilir.

filter

string

Zorunlu. Sorgu filtresi.

": operatörünü kullanarak en az bir etkinlik türü (eventType) belirtmeniz gerekir. Birden fazla etkinlik türüne göre filtrelemek için OR operatörünü kullanın. Filtrenizde toplu etkinlik türlerini çıkarın. İstek, ilgili tüm toplu etkinlikleri otomatik olarak döndürür. Örneğin, yeni tepkilere (google.workspace.chat.reaction.v1.created) göre filtreleme yaparsanız sunucu, yeni tepkiler toplu etkinliğini (google.workspace.chat.reaction.v1.batchCreated) de döndürür. Desteklenen etkinlik türlerinin listesi için SpaceEvents referans dokümanlarına bakın.

İsteğe bağlı olarak başlangıç zamanına (startTime) ve bitiş zamanına (endTime) göre de filtreleme yapabilirsiniz:

  • startTime: Alan etkinliklerini listelemenin başlayacağı özel zaman damgası. 28 güne kadar önce gerçekleşen etkinlikleri listeleyebilirsiniz. Belirtilmemişse son 28 güne ait alan etkinliklerini listeler.
  • endTime: Alan etkinliklerinin listelendiği zaman damgası. Belirtilmemişse istek zamanına kadar olan etkinlikleri listeler.

Başlangıç veya bitiş saatini belirtmek için eşittir = operatörünü kullanın ve RFC-3339 biçimini uygulayın. Hem startTime hem de endTime'ye 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")

Aşağıdaki sorgular geçersiz:

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, sunucu tarafından INVALID_ARGUMENT hatasıyla reddedilir.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

Alan etkinliklerini listelemeyle ilgili 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. Not: Liste istekleri için Alan nesnesinde permissionSettings alanı döndürülmez.

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ılavuzuna bakın.