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

ไม่บังคับ เปลี่ยนแปลงไม่ได้ ตัวระบุ ชื่อทรัพยากรของการสมัครใช้บริการ

รูปแบบ: subscriptions/{subscription}

string

เอาต์พุตเท่านั้น ตัวระบุที่ไม่ซ้ำกันที่ระบบกำหนดให้สำหรับการสมัครใช้บริการ

string

ต้องระบุ เปลี่ยนแปลงไม่ได้ ทรัพยากร Google Workspace ที่มีการตรวจสอบเหตุการณ์ โดยมีรูปแบบเป็นชื่อเต็มของทรัพยากร หากต้องการดูข้อมูลเกี่ยวกับทรัพยากรเป้าหมายและเหตุการณ์ที่รองรับ โปรดดูเหตุการณ์ของ Google Workspace ที่รองรับ

ผู้ใช้สามารถให้สิทธิ์แก่แอปของคุณเพื่อสร้างการสมัครใช้บริการ 1 รายการสำหรับทรัพยากรเป้าหมายหนึ่งๆ เท่านั้น หากแอปพยายามสร้างการสมัครใช้บริการอื่นโดยใช้ข้อมูลเข้าสู่ระบบของผู้ใช้รายการเดียวกัน คำขอจะแสดงข้อผิดพลาด ALREADY_EXISTS

string

ต้องระบุ เปลี่ยนแปลงไม่ได้ รายการที่ไม่เรียงลำดับ ข้อมูลที่ป้อนสําหรับสร้างการสมัครใช้บริการ หากไม่เป็นเช่นนั้น ให้แสดงเฉพาะเอาต์พุต เหตุการณ์อย่างน้อย 1 ประเภทที่จะรับเกี่ยวกับทรัพยากรเป้าหมาย จัดรูปแบบตามข้อกำหนด CloudEvent

ประเภทเหตุการณ์ที่รองรับขึ้นอยู่กับทรัพยากรเป้าหมายของการสมัครใช้บริการของคุณ โปรดดูรายละเอียดที่หัวข้อเหตุการณ์ของ Google Workspace ที่รองรับ

โดยค่าเริ่มต้น คุณจะได้รับเหตุการณ์เกี่ยวกับวงจรของการสมัครใช้บริการด้วย คุณไม่จำเป็นต้องระบุเหตุการณ์ตลอดอายุการใช้งานสำหรับช่องนี้

หากคุณระบุประเภทเหตุการณ์ที่ไม่มีอยู่สำหรับทรัพยากรเป้าหมาย คำขอจะแสดงรหัสสถานะ HTTP 400 Bad Request

object (PayloadOptions)

ไม่บังคับ ตัวเลือกเกี่ยวกับข้อมูลที่จะรวมไว้ในเพย์โหลดของเหตุการณ์ รองรับเฉพาะกิจกรรมใน Google Chat

object (NotificationEndpoint)

ต้องระบุ เปลี่ยนแปลงไม่ได้ ปลายทางที่การสมัครใช้บริการนำส่งเหตุการณ์ เช่น หัวข้อ Pub/Sub

enum (State)

เอาต์พุตเท่านั้น สถานะของการสมัครใช้บริการ กำหนดว่าการสมัครใช้บริการสามารถรับเหตุการณ์และส่งไปยังปลายทางการแจ้งเตือนได้หรือไม่

enum (ErrorType)

เอาต์พุตเท่านั้น ข้อผิดพลาดที่ทำให้การสมัครใช้บริการถูกระงับ

หากต้องการเปิดใช้งานการสมัครใช้บริการอีกครั้ง ให้แก้ไขข้อผิดพลาดและเรียกใช้เมธอด subscriptions.reactivate

string

เอาต์พุตเท่านั้น ผู้ใช้ที่ให้สิทธิ์สร้างการสมัครใช้บริการ

รูปแบบ: users/{user}

สำหรับผู้ใช้ Google Workspace ค่า {user} คือช่อง user.id จาก Directory API

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่สร้างการสมัครใช้บริการ

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาล่าสุดที่มีการอัปเดตการสมัครใช้บริการ

boolean

เอาต์พุตเท่านั้น หากเป็น true แสดงว่าการสมัครใช้บริการอยู่ระหว่างการอัปเดต

string

ไม่บังคับ เซิร์ฟเวอร์จะคำนวณการตรวจสอบข้อผิดพลาดดังกล่าวโดยอิงตามค่าของช่องอื่นๆ และอาจมีการส่งตามคำขออัปเดตเพื่อให้แน่ใจว่าไคลเอ็นต์มีค่าเป็นปัจจุบันก่อนดำเนินการต่อ

string (Timestamp format)

ค่าเริ่มต้นที่ไม่ว่างเปล่า การประทับเวลาในเขตเวลา UTC เมื่อการสมัครใช้บริการหมดอายุ แสดงเอาต์พุตเสมอ ไม่ว่าจะใช้อินพุตใดก็ตาม

string (Duration format)

อินพุตเท่านั้น Time to Live (TTL) หรือระยะเวลาของการสมัครใช้บริการ หากไม่ระบุหรือตั้งค่าเป็น 0 ให้ใช้ระยะเวลาสูงสุดที่เป็นไปได้

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

boolean

ไม่บังคับ เพย์โหลดเหตุการณ์มีข้อมูลเกี่ยวกับทรัพยากรที่มีการเปลี่ยนแปลงหรือไม่ เช่น สําหรับเหตุการณ์ที่มีการสร้างข้อความ Google Chat ดูว่าเพย์โหลดมีข้อมูลเกี่ยวกับทรัพยากร Message หรือไม่ หากเป็นเท็จ เพย์โหลดเหตุการณ์จะรวมเฉพาะชื่อของทรัพยากรที่เปลี่ยนแปลงเท่านั้น

string (FieldMask format)

ไม่บังคับ หากตั้งค่า includeResource เป็น true รายการช่องที่รวมไว้ในเพย์โหลดของเหตุการณ์ แยกฟิลด์ด้วยเครื่องหมายจุลภาค เช่น หากต้องการระบุผู้ส่งข้อความ Google Chat และเวลาที่สร้าง ให้ป้อน message.sender,message.createTime หากไม่ระบุ เพย์โหลดจะรวมทุกช่องสำหรับทรัพยากร

ถ้าคุณระบุฟิลด์ที่ไม่มีอยู่สำหรับทรัพยากร ระบบจะไม่สนใจฟิลด์นั้น

{

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

string

เปลี่ยนแปลงไม่ได้ หัวข้อ Cloud Pub/Sub ที่รับเหตุการณ์สำหรับการสมัครใช้บริการ

รูปแบบ: projects/{project}/topics/{topic}

คุณต้องสร้างหัวข้อในโปรเจ็กต์ Google Cloud เดียวกับที่สร้างการสมัครใช้บริการนี้

เมื่อหัวข้อได้รับเหตุการณ์ เหตุการณ์จะเข้ารหัสเป็นข้อความ Cloud Pub/Sub โปรดดูรายละเอียดที่การเชื่อมโยงโปรโตคอลของ Google Cloud Pub/Sub สำหรับ CloudEvents