แหล่งข้อมูล: การสมัครใช้บริการ
การแสดง JSON |
---|
{ "name": string, "uid": string, "targetResource": string, "eventTypes": [ string ], "payloadOptions": { object ( |
ช่อง | |
---|---|
name |
ไม่บังคับ เปลี่ยนแปลงไม่ได้ ตัวระบุ ชื่อทรัพยากรของการสมัครใช้บริการ รูปแบบ: |
uid |
เอาต์พุตเท่านั้น ตัวระบุที่ไม่ซ้ำกันที่ระบบกำหนดให้สำหรับการสมัครใช้บริการ |
targetResource |
ต้องระบุ เปลี่ยนแปลงไม่ได้ ทรัพยากร Google Workspace ที่มีการตรวจสอบเหตุการณ์ โดยมีรูปแบบเป็นชื่อเต็มของทรัพยากร หากต้องการดูข้อมูลเกี่ยวกับทรัพยากรเป้าหมายและเหตุการณ์ที่รองรับ โปรดดูเหตุการณ์ของ Google Workspace ที่รองรับ ผู้ใช้สามารถให้สิทธิ์แก่แอปของคุณเพื่อสร้างการสมัครใช้บริการ 1 รายการสำหรับทรัพยากรเป้าหมายหนึ่งๆ เท่านั้น หากแอปพยายามสร้างการสมัครใช้บริการอื่นโดยใช้ข้อมูลเข้าสู่ระบบของผู้ใช้รายการเดียวกัน คำขอจะแสดงข้อผิดพลาด |
eventTypes[] |
ต้องระบุ เปลี่ยนแปลงไม่ได้ รายการที่ไม่เรียงลำดับ ข้อมูลที่ป้อนสําหรับสร้างการสมัครใช้บริการ หากไม่เป็นเช่นนั้น ให้แสดงเฉพาะเอาต์พุต เหตุการณ์อย่างน้อย 1 ประเภทที่จะรับเกี่ยวกับทรัพยากรเป้าหมาย จัดรูปแบบตามข้อกำหนด CloudEvent ประเภทเหตุการณ์ที่รองรับขึ้นอยู่กับทรัพยากรเป้าหมายของการสมัครใช้บริการของคุณ โปรดดูรายละเอียดที่หัวข้อเหตุการณ์ของ Google Workspace ที่รองรับ โดยค่าเริ่มต้น คุณจะได้รับเหตุการณ์เกี่ยวกับวงจรของการสมัครใช้บริการด้วย คุณไม่จำเป็นต้องระบุเหตุการณ์ตลอดอายุการใช้งานสำหรับช่องนี้ หากคุณระบุประเภทเหตุการณ์ที่ไม่มีอยู่สำหรับทรัพยากรเป้าหมาย คำขอจะแสดงรหัสสถานะ HTTP |
payloadOptions |
ไม่บังคับ ตัวเลือกเกี่ยวกับข้อมูลที่จะรวมไว้ในเพย์โหลดของเหตุการณ์ รองรับเฉพาะกิจกรรมใน Google Chat |
notificationEndpoint |
ต้องระบุ เปลี่ยนแปลงไม่ได้ ปลายทางที่การสมัครใช้บริการนำส่งเหตุการณ์ เช่น หัวข้อ Pub/Sub |
state |
เอาต์พุตเท่านั้น สถานะของการสมัครใช้บริการ กำหนดว่าการสมัครใช้บริการสามารถรับเหตุการณ์และส่งไปยังปลายทางการแจ้งเตือนได้หรือไม่ |
suspensionReason |
เอาต์พุตเท่านั้น ข้อผิดพลาดที่ทำให้การสมัครใช้บริการถูกระงับ หากต้องการเปิดใช้งานการสมัครใช้บริการอีกครั้ง ให้แก้ไขข้อผิดพลาดและเรียกใช้เมธอด |
authority |
เอาต์พุตเท่านั้น ผู้ใช้ที่ให้สิทธิ์สร้างการสมัครใช้บริการ รูปแบบ: สำหรับผู้ใช้ Google Workspace ค่า |
createTime |
เอาต์พุตเท่านั้น เวลาที่สร้างการสมัครใช้บริการ |
updateTime |
เอาต์พุตเท่านั้น เวลาล่าสุดที่มีการอัปเดตการสมัครใช้บริการ |
reconciling |
เอาต์พุตเท่านั้น หากเป็น |
etag |
ไม่บังคับ เซิร์ฟเวอร์จะคำนวณการตรวจสอบข้อผิดพลาดดังกล่าวโดยอิงตามค่าของช่องอื่นๆ และอาจมีการส่งตามคำขออัปเดตเพื่อให้แน่ใจว่าไคลเอ็นต์มีค่าเป็นปัจจุบันก่อนดำเนินการต่อ |
ช่องการรวม เวลาหมดอายุสูงสุดขึ้นอยู่กับว่าการสมัครใช้บริการมีข้อมูลทรัพยากรในเพย์โหลดเหตุการณ์หรือไม่ (ระบุในช่อง
หลังจากการสมัครใช้บริการหมดอายุ ระบบจะลบโดยอัตโนมัติ คุณจะได้รับเหตุการณ์ตลอดอายุการใช้งาน คุณสามารถใช้เมธอด |
|
expireTime |
ค่าเริ่มต้นที่ไม่ว่างเปล่า การประทับเวลาในเขตเวลา UTC เมื่อการสมัครใช้บริการหมดอายุ แสดงเอาต์พุตเสมอ ไม่ว่าจะใช้อินพุตใดก็ตาม |
ttl |
อินพุตเท่านั้น Time to Live (TTL) หรือระยะเวลาของการสมัครใช้บริการ หากไม่ระบุหรือตั้งค่าเป็น |
PayloadOptions
ตัวเลือกเกี่ยวกับข้อมูลที่จะรวมไว้ในเพย์โหลดของเหตุการณ์ รองรับเฉพาะกิจกรรมใน Google Chat
การแสดง JSON |
---|
{ "includeResource": boolean, "fieldMask": string } |
ช่อง | |
---|---|
includeResource |
ไม่บังคับ เพย์โหลดเหตุการณ์มีข้อมูลเกี่ยวกับทรัพยากรที่มีการเปลี่ยนแปลงหรือไม่ เช่น สําหรับเหตุการณ์ที่มีการสร้างข้อความ Google Chat ดูว่าเพย์โหลดมีข้อมูลเกี่ยวกับทรัพยากร |
fieldMask |
ไม่บังคับ หากตั้งค่า ถ้าคุณระบุฟิลด์ที่ไม่มีอยู่สำหรับทรัพยากร ระบบจะไม่สนใจฟิลด์นั้น |
NotificationEndpoint
ปลายทางที่การสมัครใช้บริการนำส่งเหตุการณ์
การแสดง JSON |
---|
{ // Union field |
ช่อง | |
---|---|
ช่องการรวม
|
|
pubsubTopic |
เปลี่ยนแปลงไม่ได้ หัวข้อ Cloud Pub/Sub ที่รับเหตุการณ์สำหรับการสมัครใช้บริการ รูปแบบ: คุณต้องสร้างหัวข้อในโปรเจ็กต์ Google Cloud เดียวกับที่สร้างการสมัครใช้บริการนี้ เมื่อหัวข้อได้รับเหตุการณ์ เหตุการณ์จะเข้ารหัสเป็นข้อความ Cloud Pub/Sub โปรดดูรายละเอียดที่การเชื่อมโยงโปรโตคอลของ Google Cloud Pub/Sub สำหรับ CloudEvents |
รัฐ
สถานะที่เป็นไปได้สำหรับการสมัครใช้บริการ
Enum | |
---|---|
STATE_UNSPECIFIED |
ค่าเริ่มต้น ค่านี้ไม่ได้ใช้ |
ACTIVE |
การสมัครใช้บริการมีการใช้งานอยู่และสามารถรับและส่งเหตุการณ์ไปยังปลายทางการแจ้งเตือนได้ |
SUSPENDED |
การสมัครใช้บริการรับเหตุการณ์ไม่ได้เนื่องจากเกิดข้อผิดพลาด หากต้องการทราบข้อผิดพลาด โปรดดูช่อง
|
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 |
เกิดข้อผิดพลาดที่ไม่ทราบสาเหตุ |
เมธอด |
|
---|---|
|
สร้างการสมัครใช้บริการ Google Workspace |
|
ลบการสมัครใช้บริการ Google Workspace |
|
ดูรายละเอียดเกี่ยวกับการสมัครใช้บริการ Google Workspace |
|
แสดงรายการการสมัครใช้บริการ Google Workspace |
|
อัปเดตหรือต่ออายุการสมัครใช้บริการ Google Workspace |
|
เปิดใช้งานการสมัครใช้บริการ Google Workspace ที่ถูกระงับอีกครั้ง |