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)

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

  • 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

詳しくは、承認ガイドをご覧ください。