Method: subscriptions.list

แสดงรายการการสมัครใช้บริการ Google Workspace ดูวิธีใช้เมธอดนี้ได้ที่หัวข้อ แสดงรายการการสมัครใช้บริการ Google Workspace

คำขอ HTTP

GET https://workspaceevents.googleapis.com/v1/subscriptions

URL ใช้ ไวยากรณ์การแปลงรหัส gRPC

พารามิเตอร์การค้นหา

พารามิเตอร์
pageSize

integer

ไม่บังคับ จำนวนการสมัครใช้บริการสูงสุดที่จะแสดงผล บริการอาจแสดงผลน้อยกว่าค่านี้

หากไม่ได้ระบุหรือตั้งค่าเป็น 0 ระบบจะแสดงผลการสมัครใช้บริการสูงสุด 50 รายการ

ค่าสูงสุดคือ 100 หากระบุค่ามากกว่า 100 ระบบจะแสดงผลการสมัครใช้บริการเพียง 100 รายการ

pageToken

string

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

เมื่อแบ่งหน้า ค่าตัวกรองควรตรงกับการเรียกที่ให้โทเค็นหน้าเว็บ การส่งค่าอื่นอาจทำให้เกิดผลลัพธ์ที่ไม่คาดคิด

filter

string

ต้องระบุ ตัวกรองการค้นหา

คุณสามารถกรองการสมัครใช้บริการตามประเภทเหตุการณ์ (event_types) และทรัพยากรเป้าหมาย (target_resource)

คุณต้องระบุประเภทเหตุการณ์อย่างน้อย 1 ประเภทในการค้นหา หากต้องการกรองตามประเภทเหตุการณ์หลายประเภท ให้ใช้ตัวดำเนินการ OR

หากต้องการกรองตามทั้งประเภทเหตุการณ์และทรัพยากรเป้าหมาย ให้ใช้ตัวดำเนินการ AND และระบุชื่อทรัพยากรแบบเต็ม เช่น //chat.googleapis.com/spaces/{space}

ตัวอย่างเช่น การค้นหาต่อไปนี้ใช้ได้

event_types:"google.workspace.chat.membership.v1.updated" OR
  event_types:"google.workspace.chat.message.v1.created"

event_types:"google.workspace.chat.message.v1.created" AND
  target_resource="//chat.googleapis.com/spaces/{space}"

( event_types:"google.workspace.chat.membership.v1.updated" OR
  event_types:"google.workspace.chat.message.v1.created" ) AND
  target_resource="//chat.googleapis.com/spaces/{space}"

เซิร์ฟเวอร์จะปฏิเสธการค้นหาที่ไม่ถูกต้องด้วยข้อผิดพลาด INVALID_ARGUMENT

เนื้อหาของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

เนื้อหาการตอบกลับ

ข้อความตอบกลับสำหรับ SubscriptionsService.ListSubscriptions

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON
{
  "subscriptions": [
    {
      object (Subscription)
    }
  ],
  "nextPageToken": string
}
ช่อง
subscriptions[]

object (Subscription)

รายการการสมัครใช้บริการ

nextPageToken

string

โทเค็นที่ส่งเป็น pageToken เพื่อดึงข้อมูลหน้าถัดไปได้ หากไม่ระบุช่องนี้ แสดงว่าไม่มีหน้าถัดไป

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/meetings.space.created
  • https://www.googleapis.com/auth/meetings.space.readonly
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/drive.metadata
  • https://www.googleapis.com/auth/drive.metadata.readonly
  • https://www.googleapis.com/auth/drive.readonly

ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์