Method: contactGroups.list

Liệt kê tất cả nhóm liên hệ thuộc sở hữu của người dùng đã xác thực. Thành viên của nhóm người liên hệ không được điền sẵn.

Yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số truy vấn

Thông số
pageToken

string

Không bắt buộc. Giá trị nextPageToken được trả về từ lệnh gọi trước đó đến contactGroups.list. Yêu cầu trang tài nguyên tiếp theo.
pageSize

integer

Không bắt buộc. Số lượng tài nguyên tối đa cần trả về. Các giá trị hợp lệ nằm trong khoảng từ 1 đến 1.000 (tính cả 2 giá trị này). Giá trị mặc định là 30 nếu không được đặt hoặc được đặt là 0.
syncToken

string

Không bắt buộc. Mã thông báo đồng bộ hoá được lệnh gọi trước đó trả về cho contactgroups.list. Chỉ những tài nguyên thay đổi kể từ khi mã thông báo đồng bộ hoá được tạo mới được trả về.
groupFields

string (FieldMask format)

Không bắt buộc. Mặt nạ trường (field mask) để hạn chế những trường trong nhóm được trả về. Giá trị mặc định là metadata, groupType, memberCount và name nếu không được đặt hoặc đặt thành trống. Các trường hợp lệ là:

  • clientData
  • groupType
  • memberCount
  • siêu dữ liệu
  • tên

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Nội dung phản hồi

Phản hồi cho yêu cầu của nhóm người liên hệ về danh sách.

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "contactGroups": [
    {
      object (ContactGroup)
    }
  ],
  "totalItems": integer,
  "nextPageToken": string,
  "nextSyncToken": string
}
Trường
contactGroups[]

object (ContactGroup)

Danh sách nhóm liên hệ. Thành viên của nhóm người liên hệ không được điền sẵn.
totalItems

integer

Tổng số mục trong danh sách không phân trang.
nextPageToken

string

Mã thông báo có thể được dùng để truy xuất trang kết quả tiếp theo.
nextSyncToken

string

Mã thông báo này có thể được dùng để truy xuất các thay đổi kể từ yêu cầu gần đây nhất.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau đây:

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

Để biết thêm thông tin, hãy xem bài viết Hướng dẫn uỷ quyền.