Kaynak: Abonelik
Bir Google Workspace kaynağıyla ilgili etkinlikleri almak için kullanılan abonelik. Abonelikler hakkında daha fazla bilgi edinmek için Google Workspace Events API'ye genel bakış başlıklı makaleyi inceleyin.
JSON gösterimi |
---|
{ "name": string, "uid": string, "targetResource": string, "eventTypes": [ string ], "payloadOptions": { object ( |
Alanlar | |
---|---|
name |
İsteğe bağlı. Sabit. Tanımlayıcı. Aboneliğin kaynak adı. Biçim: |
uid |
Yalnızca çıkış. Abonelik için sistem tarafından atanan benzersiz tanımlayıcı. |
targetResource |
Zorunlu. Sabit. Etkinlikler için izlenen ve tam kaynak adı olarak biçimlendirilmiş Google Workspace kaynağı. Hedef kaynaklar ve bunların desteklediği etkinlikler hakkında bilgi edinmek için Desteklenen Google Workspace etkinlikleri başlıklı makaleyi inceleyin. Kullanıcı, uygulamanızı belirli bir hedef kaynak için yalnızca bir abonelik oluşturacak şekilde yetkilendirebilir. Uygulamanız aynı kullanıcı kimlik bilgileriyle başka bir abonelik oluşturmaya çalışırsa istek |
eventTypes[] |
Zorunlu. Sabit. Sırasız liste. Abonelik oluşturmak için giriş. Aksi takdirde, yalnızca çıkış yapın. Hedef kaynak hakkında alınacak bir veya daha fazla etkinlik türü. CloudEvents özelliklerine göre biçimlendirilmiştir. Desteklenen etkinlik türleri, aboneliğinizin hedef kaynağına bağlıdır. Ayrıntılar için Desteklenen Google Workspace etkinlikleri başlıklı makaleyi inceleyin. Varsayılan olarak, aboneliğinizin yaşam döngüsü ile ilgili etkinlikleri de alırsınız. Bu alan için yaşam döngüsü olaylarını belirtmenize gerek yoktur. Hedef kaynak için var olmayan bir etkinlik türü belirtirseniz istek, HTTP |
payloadOptions |
İsteğe bağlı. Etkinlik yüküne hangi verilerin dahil edileceğine dair seçenekler. Yalnızca Google Chat etkinlikleri için desteklenir. |
notificationEndpoint |
Zorunlu. Sabit. Aboneliğin etkinlikleri yayınladığı uç nokta (ör. Pub/Sub konusu). |
state |
Yalnızca çıkış. Aboneliğin durumu. Aboneliğin etkinlikleri alıp alamayacağını ve bunları bildirim uç noktasına teslim edip edemeyeceğini belirler. |
suspensionReason |
Yalnızca çıkış. Aboneliğin askıya alınmasına neden olan hata. Aboneliği yeniden etkinleştirmek için hatayı giderin ve |
authority |
Yalnızca çıkış. Aboneliğin oluşturulmasına yetki veren kullanıcı. Biçim: Google Workspace kullanıcıları için |
createTime |
Yalnızca çıkış. Aboneliğin oluşturulduğu zaman. |
updateTime |
Yalnızca çıkış. Aboneliğin son güncellenme zamanı. |
reconciling |
Yalnızca çıkış. |
etag |
İsteğe bağlı. Bu sağlama toplamı, sunucu tarafından diğer alanların değerine göre hesaplanır ve devam etmeden önce istemcinin güncel bir değere sahip olduğundan emin olmak için güncelleme isteklerinde gönderilebilir. |
Birleştirme alanı Maksimum geçerlilik süresi, aboneliğinizin etkinlik yüklerine kaynak verileri içerip içermediğine bağlıdır (
Süresi dolan abonelikler otomatik olarak silinir. Aboneliğin süresi dolmadan 12 saat ve bir saat önce Aboneliğin süresinin dolmasını önlemek için |
|
expireTime |
Varsayılan boş değildir. Aboneliğin sona erdiği zamanın UTC zaman damgasıdır. Girişte kullanılanlardan bağımsız olarak her zaman çıkışta gösterilir. |
ttl |
Yalnızca giriş'e dokunun. Aboneliğin geçerlilik süresi (TTL) veya süresi. Belirtilmezse veya |
PayloadOptions
Etkinlik yüküne hangi verilerin dahil edileceğine dair seçenekler. Yalnızca Google Chat etkinlikleri için desteklenir.
JSON gösterimi |
---|
{ "includeResource": boolean, "fieldMask": string } |
Alanlar | |
---|---|
includeResource |
İsteğe bağlı. Etkinlik yükünün değişen kaynakla ilgili verileri içerip içermediği. Örneğin, Google Chat mesajının oluşturulduğu bir etkinlik için yükün |
fieldMask |
İsteğe bağlı. Kaynak için mevcut olmayan bir alan belirtirseniz sistem bu alanı yoksayar. |
NotificationEndpoint
Aboneliğin etkinlikleri yayınladığı uç nokta.
JSON gösterimi |
---|
{ // Union field |
Alanlar | |
---|---|
Birleştirme alanı
|
|
pubsubTopic |
Sabit. Abonelikle ilgili etkinlikleri alan Cloud Pub/Sub konusu. Biçim: Konuyu, bu aboneliği oluşturduğunuz Google Cloud projesinde oluşturmanız gerekir. Konu etkinlikler aldığında etkinlikler Cloud Pub/Sub mesajları olarak kodlanır. Ayrıntılar için CloudEvents için Google Cloud Pub/Sub Protokol Bağlama bölümüne bakın. |
Eyalet
Abonelik için olası durumlar.
Sıralamalar | |
---|---|
STATE_UNSPECIFIED |
Varsayılan değer. Bu değer kullanılmıyor. |
ACTIVE |
Abonelik etkin durumda ve bildirim uç noktasına etkinlik alıp yayınlayabilir. |
SUSPENDED |
Abonelik bir hata nedeniyle etkinlikleri alamıyor. Hatayı tanımlamak için alanına bakın. |
DELETED |
Abonelik silindi. |
ErrorType
Abonelikle ilgili olası hatalar.
Sıralamalar | |
---|---|
ERROR_TYPE_UNSPECIFIED |
Varsayılan değer. Bu değer kullanılmıyor. |
USER_SCOPE_REVOKED |
Yetki veren kullanıcı, bir veya daha fazla OAuth kapsamının verilmesini iptal etti. Google Workspace yetkilendirmesi hakkında daha fazla bilgi edinmek için OAuth izin ekranını yapılandırma başlıklı makaleye bakın. |
RESOURCE_DELETED |
Aboneliğin hedef kaynağı artık mevcut değil. |
USER_AUTHORIZATION_FAILURE |
Aboneliğin oluşturulmasına yetki veren kullanıcı artık aboneliğin hedef kaynağına erişemez. |
ENDPOINT_PERMISSION_DENIED |
Google Workspace uygulamasının, aboneliğinizin bildirim uç noktasına etkinlik gönderme erişimi yok. |
ENDPOINT_NOT_FOUND |
Aboneliğin bildirim uç noktası yok veya uç nokta, aboneliği oluşturduğunuz Google Cloud projesinde bulunamıyor. |
ENDPOINT_RESOURCE_EXHAUSTED |
Aboneliğin bildirim uç noktası, yetersiz kota veya hız sınırına ulaşıldığı için etkinlik alamadı. |
OTHER |
Tanımlanamayan bir hata oluştu. |
Yöntemler |
|
---|---|
|
Google Workspace aboneliği oluşturur. |
|
Google Workspace aboneliğini siler. |
|
Google Workspace aboneliğiyle ilgili ayrıntıları alır. |
|
Google Workspace aboneliklerini listeler. |
|
Google Workspace aboneliğini günceller veya yeniler. |
|
Askıya alınmış bir Google Workspace aboneliğini yeniden etkinleştirir. |