Method: contactGroups.list

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

คำขอ HTTP

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

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

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

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

string

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

integer

ไม่บังคับ จำนวนทรัพยากรสูงสุดที่จะแสดง ค่าที่ใช้ได้จะอยู่ระหว่าง 1 ถึง 1, 000 ค่าเริ่มต้นเป็น 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

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