Bu sayfada, Google Workspace Events API'ye genel bir bakış sunulur ve Google Workspace'teki etkinliklere abone olmak için API'yi nasıl kullanabileceğiniz açıklanır.
Google Workspace etkinlikleri, Google Workspace kaynaklarında yapılan değişiklikleri (ör. kaynakların oluşturulması, güncellenmesi veya silinmesi) temsil eder. Uygulamanız, ilgilendiğiniz alakalı etkinlikleri alabilmeniz için bir Google Workspace kaynağına abone olabilir.
Uygulamanız etkinlikleri nasıl alır?
Uygulamanızın Google Workspace etkinliklerini almasına izin vermek için Google Workspace Events API'yi kullanarak Google Workspace kaynaklarına abonelikler oluşturursunuz.
Aşağıdaki örnekte, Google Workspace Events API'nin bir abonelik aracılığıyla etkinlikleri Google Chat uygulamasına nasıl yayınladığı gösterilmektedir:
- Chat uygulaması bir Chat alanına abone olur.
- Sohbet alanı değişir. Örneğin, alanda yeni bir mesaj yayınlanır.
- Chat, aboneliğin bildirim uç noktası olarak hizmet veren
Google Cloud Pub/Sub'daki bir konuya etkinlik yayınlar. Etkinlik, nelerin değiştiğine dair veriler içerir. Örneğin, yeni bir mesajla ilgili bir etkinlikte, oluşturulan
Messagekaynağıyla ilgili ayrıntılar yer alır. - Chat uygulaması, etkinliği içeren Google Cloud Pub/Sub mesajını işler ve gerekirse işlem yapar.
Önemli terminoloji
Google Workspace Events API'de kullanılan yaygın terimlerin listesi aşağıda verilmiştir:
- Google Workspace etkinliği
Google Workspace kaynağında yapılan bir değişiklik. Etkinlikler, CloudEvents spesifikasyonu kullanılarak biçimlendirilir ve abonelik etkinliği veya yaşam döngüsü etkinliği olabilir:
- Abonelik etkinliği
- İzleme yaptığınız Google Workspace kaynağında yapılan bir değişiklik (ör. Google Chat alanında yeni bir mesaj). Değişen kaynak hakkında ne kadar ayrıntı almak istediğinizi belirtebilirsiniz. Ayrıntılar için Google Workspace etkinliklerinin yapısı başlıklı makaleyi inceleyin.
- Yaşam döngüsü etkinliği
- Google Workspace aboneliğinizle ilgili bir etkinlik. Yaşam döngüsü etkinlikleri, abonelik etkinliklerini kaçırmamanız için sorunlar ve aboneliğinizin durumu hakkında sizi bilgilendirir. Aboneliğiniz varsayılan olarak her zaman yaşam döngüsü etkinliklerini alır. Ayrıntılar için Google Workspace abonelikleri için yaşam döngüsü etkinlikleri başlıklı makaleyi inceleyin.
- Google Workspace aboneliği
Bir Google Workspace uygulamasındaki kaynağı izleyen adlandırılmış varlık. Abonelikler
Subscriptionkaynağıyla temsil edilir. Abonelikler aşağıdaki bilgilerle tanımlanır:- Hedef kaynak
- İzlemek istediğiniz Google Workspace kaynağı.
Bu kaynak, Google Workspace aboneliğinin
targetResourcealanında gösterilir. Her abonelik yalnızca bir kaynağı izleyebilir. Google Workspace Events API'nin hangi Google Workspace kaynaklarını desteklediğini görmek için Desteklenen Google Workspace etkinlikleri başlıklı makaleyi inceleyin. - Etkinlik türleri
- Hedef kaynak için bildirim almak istediğiniz değişiklik türleri. Örneğin, bir Google Chat alanına abone olduysanız alan ve alt kaynakları (ör. üyelikler ve mesajlar) ile ilgili etkinlikleri alıp almayacağınızı seçebilirsiniz.
- Bildirim alma noktası
- Google Workspace aboneliğinin etkinlik aldığı uç nokta. Google Workspace Events API, bildirim uç noktası olarak Google Cloud Pub/Sub konularını destekler. Google Cloud Pub/Sub'ı kullanma hakkında daha fazla bilgi edinmek için Google Cloud Pub/Sub belgelerine bakın.
- Yük seçenekleri
- Değiştirilen kaynaklarla ilgili almak istediğiniz etkinlik verileri.
Desteklenen Google Workspace etkinlikleri
Uygulamanızın alabileceği etkinlikler, aboneliğinizin hedef kaynağına bağlıdır. Aşağıdaki tabloda, her olası hedef kaynak için desteklenen etkinlikler gösterilmektedir.
| Hedef kaynak | Desteklenen etkinlikler |
|---|---|
| Google Chat alanları |
|
| Google Chat kullanıcıları |
|
| Google Meet toplantı alanları |
|
| Google Meet kullanıcıları |
|
Daha fazla bilgi edinmek için aşağıdaki kılavuzları inceleyin:
Google Workspace etkinliklerinin yapısı
Google Workspace etkinlikleri, etkinlik verilerini açıklamanın endüstri standardı bir yolu olan CloudEvents spesifikasyonuna uyar. Google Workspace etkinlikleri şunları içerir:
- CloudEvent'in özellikleri.
- Etkinlik sonucunda değişen Google Workspace kaynağıyla ilgili veriler
Aşağıdaki bölümde, Google Workspace etkinliklerine ait özelliklerin ve verilerin yapısı açıklanmaktadır.
CloudEvent özellikleri
Google Workspace etkinlikleri aşağıdaki zorunlu CloudEvents özelliklerini içerir:
| Özellik | Açıklama | Örnek |
|---|---|---|
|
Etkinlikte iletilen veri türü. |
|
|
CloudEvent'in tanımlayıcısıdır. |
|
|
Etkinliğin kaynağı. Google Workspace etkinlikleri için bu, aboneliğin tam kaynak adıdır. |
//workspaceevents.googleapis.com/subscriptions/chat-spaces-abcdefg
|
|
Bu etkinlik için kullanılan CloudEvents spesifikasyonu sürümü. |
|
|
Etkinliğin gerçekleştiği Google Workspace kaynağı. |
|
|
Etkinliğin gerçekleştiği zaman damgası (RFC 3339 biçiminde). |
|
|
Google Workspace etkinliğinin türü. |
|
Etkinlik verileri
Etkinlik verileri, aboneliğinizin hedef kaynağındaki (hedef kaynağın alt kaynakları dahil) bir değişikliği temsil eden bir yüktür. Aboneliğinizde, yükün değiştirilen kaynakla ilgili verileri mi yoksa yalnızca değiştirilen kaynağın adını mı içermesini istediğinizi belirtebilirsiniz.
Örneğin, bir Chat alanına aboneyseniz alandaki yeni mesajlarla ilgili etkinlikler alabilirsiniz. Yeni mesajlarla ilgili etkinliklerde etkinlik verileri, oluşturulan Chat spaces.message kaynağını içeren bir yükü içerir.
Abonelik oluştururken uygulamanızın aldığı etkinliklere ne kadar kaynak verisinin dahil edileceğini belirtebilirsiniz:
- Kaynak verilerini dahil et: Değiştirilen kaynağın bazı veya tüm alanlarını içerir. Kaynak verilerini dahil etmeyi seçerseniz aboneliğinizin süresi 4 saatle sınırlıdır. Alan genelinde yetkilendirme kullanıyorsanız bu süre 24 saattir.
- Kaynak verilerini hariç tut: Yalnızca değiştirilen kaynağın adını içerir. Aboneliğinizin süresi en fazla 7 gündür. Etkinlikle ilgili ayrıntıları görmek için kaynak adını kullanarak kaynağı sorgulayabilirsiniz.
Etkinlik verileri için bu seçenekler, aboneliğinizin payloadOptions alanında gösterilir.
Google Cloud Pub/Sub mesajları olarak etkinlikler
Google Workspace Events API abonelikleri, Google Workspace etkinliklerini alan bildirim uç noktası olarak Google Cloud Pub/Sub konularını kullanır. Etkinlikler Google Cloud Pub/Sub mesajları olarak kodlanır. Uygulamanız, işlem yapmak veya etkinliğe yanıt vermek için Google Cloud Pub/Sub mesajını işleyebilir.
Aşağıdaki örnekte, Chat alanındaki güncellenmiş bir mesajla ilgili etkinlik içeren bir Google Cloud Pub/Sub mesajı gösterilmektedir:
{
"message":
{
"attributes":
{
"ce-datacontenttype": "application/json",
"ce-id": "spaces/SPACE_ID/spaceEvents/SPACE_EVENT_ID",
"ce-source": "//workspaceevents.googleapis.com/subscriptions/SUBSCRIPTION_ID",
"ce-specversion": "1.0",
"ce-subject": "//chat.googleapis.com/spaces/SPACE_ID",
"ce-time": "2023-09-07T21:37:53.274191Z",
"ce-type": "google.workspace.chat.message.v1.updated"
},
"data": "EVENT_DATA",
"messageId": "PUBSUB_MESSAGE_ID",
"orderingKey": "//workspaceevents.googleapis.com/subscriptions/SUBSCRIPTION_ID",
"publishTime": "2023-09-07T21:37:53.713Z"
}
}
Aşağıdaki alanlara dikkat edin:
attributes: Etkinlik türünü içeren CloudEvent özellikleri. Bu durumda etkinlik, alanda güncellenen bir mesajla ilgilidir.data: Güncellenenspaces.messagekaynağıyla ilgili ayrıntıları içeren, Base64 kodlu dize olarak biçimlendirilmiş etkinlik verileri.messageId: Google Cloud Pub/Sub mesajının tanımlayıcısıdır.
CloudEvents'in Google Cloud Pub/Sub mesajlarında nasıl belirtildiği hakkında daha fazla bilgi edinmek için CloudEvents için Google Cloud Pub/Sub Protokol Bağlantısı başlıklı makaleyi inceleyin.