Method: contactGroups.list

認証されたユーザーが所有するすべての連絡先グループを一覧表示します。連絡先グループのメンバーには入力されません。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

クエリ パラメータ

パラメータ
pageToken

string

省略可。前回の contactGroups.list の呼び出しから返された nextPageToken 値。リソースの次のページをリクエストします。
pageSize

integer

省略可。返されるリソースの最大数。有効な値は 1 ～ 1, 000 です。設定しない場合または 0 に設定した場合のデフォルトは 30 です。
syncToken

string

省略可。前回の contactgroups.list 呼び出しで返された同期トークン。同期トークンの作成後に変更されたリソースのみが返されます。
groupFields

string (FieldMask format)

省略可。返されるグループのフィールドを制限するフィールド マスク。設定しない場合や空に設定した場合のデフォルトは、metadata、groupType、memberCount、name です。有効なフィールドは次のとおりです。

  • clientData
  • groupType
  • memberCount
  • メタデータ
  • name

リクエスト本文

リクエストの本文は空にする必要があります。

レスポンスの本文

連絡先グループの一覧表示リクエストに対するレスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

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

詳細については、承認ガイドをご覧ください。