REST Resource: subscriptions

{
  "name": string,
  "uid": string,
  "targetResource": string,
  "eventTypes": [
    string
  ],
  "payloadOptions": {
    object (PayloadOptions)
  },
  "notificationEndpoint": {
    object (NotificationEndpoint)
  },
  "state": enum (State),
  "suspensionReason": enum (ErrorType),
  "authority": string,
  "createTime": string,
  "updateTime": string,
  "reconciling": boolean,
  "etag": string,

  // Union field expiration can be only one of the following:
  "expireTime": string,
  "ttl": string
  // End of list of possible types for union field expiration.
}

string

İsteğe bağlı. Sabit. Tanımlayıcı. Aboneliğin kaynak adı.

Biçim: subscriptions/{subscription}

string

Yalnızca çıkış. Abonelik için sistem tarafından atanan benzersiz tanımlayıcı.

string

Zorunlu. Sabit. Tam kaynak adı olarak biçimlendirilmiş, etkinlikler için izlenen Google Workspace kaynağı. Hedef kaynaklar ve destekledikleri etkinlikler hakkında bilgi edinmek için Desteklenen Google Workspace etkinlikleri başlıklı makaleyi inceleyin.

Kullanıcılar, uygulamanıza yalnızca belirli bir hedef kaynak için bir abonelik oluşturma yetkisi verebilir. Uygulamanız aynı kullanıcı kimlik bilgileriyle başka bir abonelik oluşturmaya çalışırsa istek, ALREADY_EXISTS hatası döndürür.

string

Zorunlu. Sabit. Sırasız liste. Abonelik oluşturma girişi. Aksi takdirde yalnızca çıkış kullanılır. Hedef kaynak hakkında alınacak bir veya daha fazla etkinlik türü. CloudEvents spesifikasyonuna 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 etkinlikler de alırsınız. Bu alan için yaşam döngüsü olayları belirtmeniz gerekmez.

Hedef kaynak için var olmayan bir etkinlik türü belirtirseniz istek, bir HTTP 400 Bad Request durum kodu döndürür.

object (PayloadOptions)

İsteğe bağlı. Etkinlik yüküne hangi verilerin dahil edileceğine ilişkin seçenekler. Yalnızca Google Chat etkinlikleri için desteklenir.

object (NotificationEndpoint)

Zorunlu. Sabit. Aboneliğin, Pub/Sub konusu gibi etkinlikleri yayınladığı uç nokta.

enum (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.

enum (ErrorType)

Yalnızca çıkış. Aboneliği askıya alan hata.

Aboneliği yeniden etkinleştirmek için hatayı giderin ve subscriptions.reactivate yöntemini çağırın.

string

Yalnızca çıkış. Aboneliğin oluşturulmasına yetki veren kullanıcı.

Biçim: users/{user}

Google Workspace kullanıcıları için {user} değeri, Directory API'deki user.id alanıdır.

string (Timestamp format)

Yalnızca çıkış. Aboneliğin oluşturulduğu zaman.

string (Timestamp format)

Yalnızca çıkış. Aboneliğin son güncellendiği zaman.

boolean

Yalnızca çıkış. true ise abonelik güncellenmektedir.

string

İsteğe bağlı. Bu sağlama toplamı, diğer alanların değerine bağlı olarak sunucu tarafından hesaplanır ve devam etmeden önce istemcinin güncel bir değere sahip olduğundan emin olmak için güncelleme isteklerinde gönderilebilir.

string (Timestamp format)

Boş olmayan varsayılan. Aboneliğin sona erdiği zaman (UTC) zaman damgası. Girişte ne kullanıldığına bakılmaksızın, çıkışta her zaman görüntülenir.

string (Duration format)

Yalnızca giriş. Aboneliğin geçerlilik süresi (TTL) veya süresi. Belirtilmemişse veya 0 olarak ayarlanırsa mümkün olan maksimum süreyi kullanır.

{
  "includeResource": boolean,
  "fieldMask": string
}

boolean

İ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 Message kaynağıyla ilgili verileri içerip içermediği. Yanlış değerine ayarlanırsa etkinlik yükü yalnızca değiştirilen kaynağın adını içerir.

string (FieldMask format)

İsteğe bağlı. includeResource, true olarak ayarlanırsa etkinlik yüküne dahil edilecek alanların listesi. Alanları virgülle ayırın. Örneğin, bir Google Chat mesajının gönderenini dahil etmek ve zaman oluşturmak için message.sender,message.createTime yazın. Atlanırsa yük, kaynağın tüm alanlarını içerir.

Kaynak için var olmayan bir alan belirtirseniz sistem bu alanı yok sayar.

{

  // Union field endpoint can be only one of the following:
  "pubsubTopic": string
  // End of list of possible types for union field endpoint.
}

string

Sabit. Abonelikle ilgili etkinlikleri alan Cloud Pub/Sub konusu.

Biçim: projects/{project}/topics/{topic}

Konuyu, bu aboneliği oluşturduğunuz Google Cloud projesinde oluşturmanız gerekir.

Konu etkinlik aldığında etkinlikler, Cloud Pub/Sub mesajları olarak kodlanır. Ayrıntılar için CloudEvents için Google Cloud Pub/Sub Protokol Bağlantısı bölümüne bakın.