REST Resource: subscriptions

แหล่งข้อมูล: การสมัครใช้บริการ

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

การแสดง JSON 
{
  "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.
}
ช่อง
name

string

ตัวระบุ ชื่อทรัพยากรของการสมัครใช้บริการ

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

string

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

string

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

ผู้ใช้จะอนุญาตให้แอปของคุณสร้างการสมัครใช้บริการได้เพียง 1 รายการสําหรับทรัพยากรเป้าหมายหนึ่งๆ หากแอปพยายามสร้างการสมัครใช้บริการอื่นด้วยข้อมูลเข้าสู่ระบบของผู้ใช้เดียวกัน คำขอจะแสดงข้อผิดพลาด ALREADY_EXISTS
eventTypes[]

string

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

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

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

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

object (PayloadOptions)

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

object (NotificationEndpoint)

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

enum (State)

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

enum (ErrorType)

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

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

string

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

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

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

string (Timestamp format)

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

string (Timestamp format)

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

boolean

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

string

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

ฟิลด์สหภาพ expiration เวลาของการสมัครใช้บริการที่หมดอายุ

เวลาหมดอายุสูงสุดจะขึ้นอยู่กับว่าการสมัครใช้บริการของคุณมีข้อมูลทรัพยากรในเพย์โหลดเหตุการณ์หรือไม่ (ระบุไว้ในช่อง PayloadOptions)

  • อาจใช้เวลาถึง 7 วันหากเพย์โหลดละเว้นข้อมูลทรัพยากร
  • อาจใช้เวลาสูงสุด 4 ชั่วโมงหากเพย์โหลดมีข้อมูลทรัพยากร หากองค์กร Google Workspace ให้สิทธิ์เข้าถึงทรัพยากรผ่านการมอบสิทธิ์ทั่วทั้งโดเมน คุณจะขยายเวลาหมดอายุของการสมัครใช้บริการได้สูงสุด 24 ชั่วโมง

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

คุณสามารถใช้เมธอด UpdateSubscription เพื่อขยายวันที่หมดอายุเพื่อป้องกันไม่ให้การสมัครใช้บริการหมดอายุ โปรดดูรายละเอียดที่หัวข้ออัปเดตหรือต่ออายุการสมัครใช้บริการ expiration ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
expireTime

string (Timestamp format)

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

string (Duration format)

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

PayloadOptions

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

การแสดง JSON 
{
  "includeResource": boolean,
  "fieldMask": string
}
ช่อง
includeResource

boolean

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

string (FieldMask format)

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

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

NotificationEndpoint

ปลายทางที่การสมัครใช้บริการส่งเหตุการณ์

การแสดง JSON 
{

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

ฟิลด์สหภาพ endpoint

endpoint ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
pubsubTopic

string

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

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

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

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

รัฐ

สถานะที่เป็นไปได้สำหรับการสมัครใช้บริการ

Enum
STATE_UNSPECIFIED ค่าเริ่มต้น ค่านี้ไม่ได้ใช้
ACTIVE การสมัครใช้บริการทํางานอยู่และสามารถรับและส่งเหตุการณ์ไปยังปลายทางการแจ้งเตือนได้
SUSPENDED การสมัครรับข้อมูลไม่สามารถรับเหตุการณ์ได้เนื่องจากมีข้อผิดพลาด ดูข้อผิดพลาดได้ในช่อง suspensionReason
DELETED ระบบจะลบการสมัครใช้บริการ

ErrorType

ข้อผิดพลาดที่อาจเกิดขึ้นสำหรับการสมัครใช้บริการ

Enum
ERROR_TYPE_UNSPECIFIED ค่าเริ่มต้น ค่านี้ไม่ได้ใช้งาน
USER_SCOPE_REVOKED ผู้ใช้ที่ให้สิทธิ์ได้เพิกถอนการให้สิทธิ์ขอบเขต OAuth อย่างน้อย 1 รายการ ดูข้อมูลเพิ่มเติมเกี่ยวกับการให้สิทธิ์สำหรับ Google Workspace ได้ที่กำหนดค่าหน้าจอขอความยินยอม OAuth
RESOURCE_DELETED ทรัพยากรเป้าหมายสำหรับการสมัครใช้บริการไม่มีอยู่แล้ว
USER_AUTHORIZATION_FAILURE ผู้ใช้ที่อนุญาตให้สร้างการสมัครใช้บริการจะไม่มีสิทธิ์เข้าถึงทรัพยากรเป้าหมายของการสมัครใช้บริการอีกต่อไป
ENDPOINT_PERMISSION_DENIED แอปพลิเคชัน Google Workspace ไม่มีสิทธิ์เข้าถึงเพื่อนำส่งเหตุการณ์ไปยังปลายทางการแจ้งเตือนของการสมัครใช้บริการของคุณ
ENDPOINT_NOT_FOUND ไม่มีปลายทางการแจ้งเตือนของการสมัครใช้บริการ หรือไม่พบหน้าปลายทางในโปรเจ็กต์ Google Cloud ที่คุณสร้างการสมัครใช้บริการ
ENDPOINT_RESOURCE_EXHAUSTED จุดสิ้นสุดการแจ้งเตือนของการสมัครใช้บริการไม่ได้รับเหตุการณ์เนื่องจากโควต้าไม่เพียงพอหรือถึงขีดจํากัด
OTHER เกิดข้อผิดพลาดที่ไม่ทราบสาเหตุ

เมธอด

create

 สร้างการสมัครใช้บริการ Google Workspace

delete

 ลบการสมัครใช้บริการ Google Workspace

get

 รับรายละเอียดเกี่ยวกับการสมัครใช้บริการ Google Workspace

list

 แสดงการสมัครใช้บริการ Google Workspace

patch

 อัปเดตหรือต่ออายุการสมัครใช้บริการ Google Workspace

reactivate

 เปิดใช้งานการสมัครใช้บริการ Google Workspace ที่ถูกระงับอีกครั้ง