Bu sayfa, Cloud Translation API ile çevrilmiştir.

Google Workspace Events API'yi kullanarak etkinliklere abone olma

Bu sayfada, Google Workspace Events API'ye genel bir bakış ve Google Workspace'teki etkinliklere abone olmak için API'yi kullanabilirsiniz.

Google Workspace etkinlikleri, Google Workspace kaynaklarında yapılan değişiklikleri temsil eder. (ör. kaynakların ne zaman oluşturulması, güncellenmesi veya silinmesi) Uygulamanız abone olabilir İlginizi çeken etkinlikleri alabilmeniz için emin olabilirsiniz.

Uygulamanız etkinlikleri nasıl alır?

Uygulamanızın Google Workspace etkinliklerini almasına izin vermek için Google Workspace abonelikleri oluşturmak için Google Workspace Events API'si kaynaklar.

Google Workspace Events API'nin etkinlikleri nasıl yayınladığını gösteren resim. — **Şekil 1.** Örnek Google Workspace Events API, etkinlikleri Chat uygulaması.

'nı inceleyin.

Aşağıdaki örnekte, Google Workspace Events API'nin nasıl yayınlandığı gösterilmiştir. Etkinlikleri abonelik aracılığıyla Google Chat uygulamasına aktarma:

Bir Chat uygulaması, bir Chat alanına abone olur.
Chat alanı değişir. Örneğin, yeni bir ileti geldiğinde sağlar.
Chat, şuradaki bir konuya etkinlik gönderir: Google Cloud Pub/Sub Aboneliğin bildirim uç noktası görevi görür. Etkinlik nelerin değiştiğine dair veri içerir. Örneğin, yeni bir etkinlik hakkında mesajını görürseniz etkinlik, kullanılan Message kaynağıyla ilgili ayrıntıları içerir. oluşturuldu.
Chat uygulaması, Google Cloud'u Etkinliği içeren Pub/Sub mesajı ve gerekirse işlem yapar.

Önemli terminoloji

Aşağıda, Google Workspace Events API:

Google Workspace etkinliği

Google Workspace kaynağında yapılan bir değişiklik. Etkinlikler, CloudEvents ve bir abonelik etkinliği olabilir. Bir yaşam döngüsü olayı hakkında:

Abonelik etkinliği: İzlemekte olduğunuz Google Workspace kaynağında değişiklik yapıldığında Google Chat alanındaki yeni bir mesaj gibi. Her bir ürün için ve değiştirilen kaynak hakkında almak istediğiniz ayrıntılara yer verin. Ayrıntılar için bkz. Google Workspace etkinliklerinin yapısı.
Yaşam döngüsü olayı: Google Workspace aboneliğinizle ilgili bir etkinlik. Yaşam döngüsü etkinlikleri sorunlar ve aboneliğinizin durumuyla ilgili olarak sizi bilgilendirerek abonelik etkinliklerini kaçırmayın. Varsayılan olarak, aboneliğiniz her zaman yaşam döngüsü olayları alır. Ayrıntılı bilgi için Google Workspace aboneliklerinde yaşam döngüsü olayları başlıklı makaleyi inceleyin.

Google Workspace aboneliği

Google Workspace'teki bir kaynağı izleyen adlandırılmış varlık bir uygulamadır. Bir abonelik, Subscription gösterir. Abonelik aşağıdaki bilgilerle tanımlanır:

Hedef kaynak: İzlemek istediğiniz Google Workspace kaynağı. Bu kaynak, sayfanın targetResource alanında gösterilir Google Workspace aboneliği Her abonelik yalnızca bir kaynağı izler. Google Workspace'te yer alan Google Workspace Events API'nin desteklediği platformlar: Desteklenen Google Workspace etkinlikleri.
Etkinlik türleri: Hakkında bildirim almak istediğiniz değişiklik türleri seçilebilir. Örneğin, Google Chat alanında, aşağıdakilerle ilgili etkinlik alıp almamayı seçebilirsiniz: alanda ve alt kaynaklarında (ör. üyelikler ve mesajlar) yer alır.
Bildirim uç noktası: Google Workspace aboneliği etkinlik alır. İlgili içeriği oluşturmak için kullanılan Google Workspace Events API, Google Cloud Pub/Sub konularını aşağıdaki şekilde destekler: bildirim uç noktası. Google Cloud Pub/Sub'ı kullanma hakkında daha fazla bilgi edinmek için bkz. Google Cloud Pub/Sub belgeleri.
Yük seçenekleri: Değiştirilen kaynaklar hakkında almak istediğiniz etkinlik verileri.

Desteklenen Google Workspace etkinlikleri

Uygulamanızın etkinlik alabileceği etkinlikler, uygulamanızın hedef kaynağına bağlıdır. şimdi sizinle paylaşacağım. Aşağıdaki tabloda her biri için desteklenen etkinlikler gösterilir yardımcı olur.

Hedef kaynak	Biçim	Desteklenen etkinlikler	Sınırlamalar (varsa)
Google Sohbet
Google Chat alanları	Belirli bir alana abone olmak için: `//chat.googleapis.com/spaces/SPACE_ID` Kullanıcının üyesi olduğu tüm alanlara abone olmak için: `//chat.googleapis.com/spaces/-`	Mesajlar Üyelikler Tepkiler Boşluk Ayrıntılı bilgi için Google Chat etkinliklerine abone olma başlıklı makaleyi inceleyin.	Aboneliği yetkilendiren Google Chat kullanıcısı Google Workspace veya Google üzerinden alana üye olmak Hesap'a dokunun.
Google Chat kullanıcıları	`//cloudidentity.googleapis.com/users/USER_ID`	Üyelikler Ayrıntılı bilgi için Google Chat etkinliklerine abone olma başlıklı makaleyi inceleyin.	Abonelik yalnızca aboneliği yetkilendiren kullanıcıyla ilgili etkinlikleri alır. Kullanıcılar, abonelikleri diğer kullanıcılar adına yetkilendiremez.
Google Meet
Google Meet toplantı alanları	`//meet.googleapis.com/spaces/SPACE_ID`	Konferanslar Katılımcı oturumları Kayıtlar Transkriptler Ayrıntılı bilgi için Google Meet etkinliklerine abone olma başlıklı makaleyi inceleyin.
Google Meet kullanıcıları	`//cloudidentity.googleapis.com/users/USER_ID`	Konferanslar Katılımcı oturumları Kayıtlar Transkriptler Ayrıntılı bilgi için Google Meet etkinliklerine abone olma başlıklı makaleyi inceleyin.	Abonelik, aşağıdaki koşulları karşılayan toplantı alanlarıyla ilgili etkinlikleri alır: şunlardan biridir: Toplantı alanının sahibi. Düzenleyen toplantı alanıyla ilişkili Google Takvim etkinliğinin.

Google Workspace etkinliklerinin yapısı

Google Workspace etkinlikleri, CloudEvents spesifikasyon, etkinlik verilerini tanımlamanın endüstri standardına yöneliktir. Google Workspace etkinlikler şunları içerir:

CloudEvent'in özellikleri.
Veriler Google Workspace kaynakları hakkında etkinlik

Aşağıdaki bölümde, bu özellik için özelliklerin ve verilerin yapısı açıklanmaktadır. Google Workspace etkinlikleri

CloudEvent özellikleri

Google Workspace etkinlikleri şunları içeriyor: CloudEvents özellikleri:

Özellik	Açıklama	Örnek
`datacontenttype`	Etkinlikte aktarılan verilerin türü.	`application/json`
`id`	CloudEvent için bir tanımlayıcı.	`spaces/AAAABBBBBBB/spaceEvents/ABCDEFGHIJKLMNO`
`source`	Etkinliğin kaynağı. Google Workspace etkinliklerinde bu, aboneliğin tam kaynak adıdır.	`//workspaceevents.googleapis.com/subscriptions/chat-spaces-abcdefg`
`specversion`	Bu etkinlik için kullanılan CloudEvents spesifikasyon sürümü.	`1.0`
`subject`	Etkinliğin gerçekleştiği Google Workspace kaynağı.	`//chat.googleapis.com/spaces/AAAABBBBBBB`
`time`	Etkinliğin gerçekleştiği zaman damgası (RFC 3339 biçiminde).	`2023-09-07T21:37:36.260127Z`
`type`	Google Workspace etkinliğinin türü.	`google.workspace.chat.message.v1.created`

Etkinlik verileri

Etkinlik verileri, aboneliğinizin hedefinde yapılan bir değişikliği temsil eden yüktür hedef kaynağın alt kaynakları dahil olmak üzere kaynaktır. abonelik ücretiyle ilgili verilerin kullanılabilmesini veya değiştirilen kaynağın adını ya da yalnızca adını değiştirebilirsiniz.

Örneğin, bir Chat alanına aboneliğiniz varsa alandaki yeni mesajlarla ilgili etkinlikleri alabilir. Şununla ilgili etkinlikler için: söz konusu olduğunda, etkinlik verileri Chat spaces.message kaynak oluşturuldu.

Bir abonelik oluşturduğunuzda ne kadar kaynak veri olacağını belirtebilirsiniz uygulamanızın aldığı etkinliklere dahil edilir:

Kaynak verilerini dahil et: Değiştirilen öğenin bir kısmını veya tamamını içerir gösterir. Kaynak verileri eklemeyi seçerseniz aboneliğiniz süre 4 saat veya alan genelinde kullanıyorsanız 24 saat ile sınırlıdır yetki.
Kaynak verilerini hariç tut: Yalnızca değiştirilen öğenin adını içerir gösterir. Abonelik süreniz 7 güne kadar çıkabilir. Şununla ilgili ayrıntıları almak için: isterseniz kaynak adını kullanarak kaynağı sorgulayabilirsiniz.

Etkinlik verileriyle ilgili bu seçenekler payloadOptions'nda gösterilmiştir. alanına giriş yapabilirsiniz.

Google Cloud Pub/Sub mesajları olarak etkinlikler

Google Workspace Events API abonelikleri Google Cloud Pub/Sub'ı kullanır Google Workspace alan bildirim uç noktası olarak konuları etkinlikler. Etkinlikler Google Cloud Pub/Sub mesajları olarak kodlanır. Uygulamanız Google Cloud Pub/Sub mesajını işleyerek harekete geçebilir veya etkinliği tıklayın.

Aşağıdaki örnekte, aşağıdakileri içeren bir Google Cloud Pub/Sub mesajı gösterilmektedir: Chat alanındaki güncellenmiş bir mesajla ilgili etkinlik:

 {
    "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: Aşağıdakileri içeren CloudEvent özellikleri etkinlik türünü belirtmelisiniz. Bu durumda etkinlik, boşluk oluşturur.
data: Güncellenen bilgilerle ilgili ayrıntıları içeren etkinlik verileri Base64 kodlu dize olarak biçimlendirilmiş spaces.message kaynağı.
messageId: Google Cloud Pub/Sub mesajının tanımlayıcısı.

CloudEvents'in Google Cloud Pub/Sub'da nasıl belirtildiği hakkında daha fazla bilgi edinmek için mesajları için CloudEvents için Google Cloud Pub/Sub Protokol Bağlama bölümüne bakın.

Google Chat etkinliklerine abone olma
Yaşam döngüsü olayları (Google Workspace abonelikleri için)
Google Workspace Events API kapsamlarını seçme
Google Workspace aboneliği oluşturma