Method: contactGroups.list

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

คำขอ HTTP

GET https://people.googleapis.com/v1/contactGroups

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

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

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

string

ไม่บังคับ ค่า nextPageToken ที่แสดงผลจากการเรียกไปยัง contactGroups.list ก่อนหน้านี้ ส่งคำขอหน้าทรัพยากรถัดไป

pageSize

integer

ไม่บังคับ จำนวนทรัพยากรสูงสุดที่จะแสดง ค่าที่ใช้ได้ต้องอยู่ระหว่าง 1 ถึง 1000 ค่าเริ่มต้นคือ 30 หากไม่ได้ตั้งค่าไว้หรือตั้งค่าเป็น 0

syncToken

string

ไม่บังคับ โทเค็นการซิงค์ที่แสดงผลโดยการโทรไปยัง contactgroups.list ก่อนหน้านี้ ระบบจะแสดงผลเฉพาะทรัพยากรที่มีการเปลี่ยนแปลงนับตั้งแต่สร้างโทเค็นการซิงค์เท่านั้น

groupFields

string (FieldMask format)

ไม่บังคับ ฟิลด์มาสก์เพื่อจำกัดฟิลด์ในกลุ่มที่จะแสดงผล ค่าเริ่มต้นคือ metadata, groupType, memberCount และ name หากไม่ได้ตั้งค่าไว้หรือตั้งเป็นค่าว่าง ช่องที่ถูกต้องมีดังนี้

  • clientData
  • groupType
  • memberCount
  • ข้อมูลเมตา
  • ชื่อ

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

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

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

การตอบกลับการแสดงคำขอกลุ่มรายชื่อติดต่อ

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

การแสดง JSON
{
  "contactGroups": [
    {
      object (ContactGroup)
    }
  ],
  "totalItems": integer,
  "nextPageToken": string,
  "nextSyncToken": string
}
ช่อง
contactGroups[]

object (ContactGroup)

รายการกลุ่มรายชื่อติดต่อ จะไม่มีการป้อนข้อมูลสมาชิกของกลุ่มผู้ติดต่อ

totalItems

integer

จํานวนรายการทั้งหมดในรายการโดยไม่มีการใส่เลขหน้า

nextPageToken

string

โทเค็นที่ใช้เพื่อเรียกดูหน้าถัดไปของผลการค้นหาได้

nextSyncToken

string

โทเค็นที่ใช้เพื่อดึงข้อมูลการเปลี่ยนแปลงตั้งแต่คําขอล่าสุดได้

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

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

  • https://www.googleapis.com/auth/contacts
  • https://www.googleapis.com/auth/contacts.readonly

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