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 ประเภทที่จะได้รับเกี่ยวกับทรัพยากรเป้าหมาย จัดรูปแบบตามข้อกำหนด CloudEvents

ประเภทเหตุการณ์ที่รองรับจะขึ้นอยู่กับทรัพยากรเป้าหมายของการสมัครใช้บริการ โปรดดูรายละเอียดที่หัวข้อกิจกรรมของ 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 ที่ถูกระงับอีกครั้ง