Google Workspace Events API'yi kullanarak etkinliklere abone olma

Bu sayfada, Google Workspace Events API'ye genel bir bakış sunulmakta ve Google Workspace'teki etkinliklere abone olmak için API'nin nasıl kullanılacağı açıklanmaktadır.

Google Workspace etkinlikleri, kaynak oluşturma, güncelleme veya silme gibi Google Workspace kaynaklarındaki değişiklikleri ifade eder. Google Workspace Events API'yi kullanarak Google Workspace kaynağına abone olabilir ve ilgili etkinlikleri alabilirsiniz.

Uygulamanızın etkinlikleri alma şekli

Uygulamanızın Google Workspace etkinliklerini almasına izin vermek için Google Workspace kaynaklarına abonelik oluşturmak üzere Google Workspace Events API'yi kullanın.

Aşağıdaki örnekte, Google Workspace Events API'nin etkinlikleri bir abonelik aracılığıyla Chat uygulamasına nasıl ilettiği açıklanmaktadır:

1. Bir Chat uygulaması, Google Chat alanına abone olur.
2. Sohbet alanı değişir. Örneğin, alanda yeni bir mesaj yayınlandığında.
3. Chat, Google Cloud Pub/Sub'daki bir konuya bir etkinlik gönderir. Bu konu, aboneliğin bildirim uç noktası olarak işlev görür. Etkinlik, değişen öğelerle ilgili veriler içerir. Örneğin, yeni bir mesajla ilgili etkinlikte, oluşturulan Message kaynağıyla ilgili ayrıntılar yer alır.
4. 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 terimler şunlardır:

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ü olayı olabilir:

Abonelik etkinliği

İzlediğiniz Google Workspace kaynağında yapılan bir değişiklik (ör. Chat alanındaki yeni bir mesaj). Değişen kaynakla ilgili ne kadar ayrıntılı bilgi almak istediğinizi belirtebilirsiniz. Ayrıntılı bilgi için Google Workspace etkinliklerinin yapısı başlıklı makaleyi inceleyin.

Yaşam döngüsü olayı

Google Workspace aboneliğinizle ilgili bir etkinlik. Yaşam döngüsü etkinlikleri, abonelik etkinliklerini kaçırmamanız için sizi sorunlar ve aboneliğinizin durumu hakkında bilgilendirir. Varsayılan olarak, aboneliğiniz her zaman yaşam döngüsü etkinliklerini alır. Ayrıntılar için Google Workspace aboneliklerinin 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ış bir varlık. Abonelik, Subscription kaynağıyla temsil edilir. Abonelik aşağıdaki bilgilerle tanımlanır:

Hedef kaynak

İzlemek istediğiniz Google Workspace kaynağı. Bu kaynak, Google Workspace aboneliğinin targetResource alanında gösterilir. Her abonelik yalnızca bir kaynağı izleyebilir. Google Workspace Events API'nin desteklediği Google Workspace kaynaklarını görmek için Desteklenen Google Workspace etkinlikleri başlıklı makaleyi inceleyin.

Etkinlik türleri

Hedef kaynakla ilgili olarak bildirim almak istediğiniz değişiklik türleri. Örneğin, bir Chat alanına abone olduysanız alan ve alt kaynaklarıyla (ör. üyelikler ve mesajlar) ilgili etkinlikleri alıp almayacağınızı seçebilirsiniz.

Bildirim uç noktası

Google Workspace aboneliğinin etkinlikleri 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 kaynaklar hakkında almak istediğiniz etkinlik verileri.

Desteklenen Google Workspace etkinlikleri

Uygulamanızın etkinlik alabileceği etkinlikler, aboneliğinizin hedef kaynağına bağlıdır. Aşağıdaki tabloda, olası her hedef kaynak için desteklenen etkinlikler gösterilmektedir.

Daha fazla bilgi edinmek için aşağıdaki kılavuzlara bakın:

• Chat etkinliklerine abone olma
• Drive etkinliklerine abone olma
• Meet etkinliklerine abone olma

Google Workspace etkinliklerinin yapısı

Google Workspace etkinlikleri, etkinlik verilerini açıklamak için sektör standardı bir yöntem 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 etkinliklerinin özelliklerinin ve verilerinin yapısı açıklanmaktadır.

CloudEvent özellikleri

Google Workspace etkinlikleri aşağıdaki zorunlu CloudEvents özelliklerini içerir:

Etkinlik verileri

Etkinlik verileri, hedef kaynağın alt kaynakları da dahil olmak üzere aboneliğinizin hedef kaynağında yapılan bir değişikliği temsil eden bir yükdü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 etkinlikleri alabilirsiniz. Yeni mesajlarla ilgili etkinliklerde, etkinlik verileri oluşturulan Chat spaces.message kaynağını içeren bir yük içerir.

Abonelik oluşturduğunuzda, uygulamanızın aldığı etkinliklere ne kadar kaynak verisi dahil edileceğini belirtebilirsiniz.

Etkinlik verileriyle ilgili 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, Google Cloud Pub/Sub mesajını işleyerek işlem yapabilir veya etkinliğe yanıt verebilir.

Aşağıdaki örnekte, bir Chat alanındaki güncellenmiş mesajla ilgili bir etkinlik içeren 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"
    }
}

Bu örnekte aşağıdaki alanlar bulunur:

• attributes: Etkinlik türünü içeren CloudEvent'in özellikleri. Bu durumda etkinlik, alandaki güncellenmiş bir mesajla ilgilidir.
• data: Güncellenen etkinlik verileri, Base64 kodlu dize olarak biçimlendirilmiş spaces.message kaynağıyla ilgili ayrıntıları içerir.
• messageId: Google Cloud Pub/Sub mesajının tanımlayıcısı.

CloudEvents'in Google Cloud Pub/Sub mesajlarında nasıl belirtildiği hakkında daha fazla bilgi edinmek için Google Cloud Pub/Sub Protocol Binding for CloudEvents başlıklı makaleyi inceleyin.

İlgili konular

• Google Workspace Events API kapsamlarını seçme
• Google Workspace aboneliği oluşturma