認証されたユーザーが所有するすべての連絡先グループを一覧表示します。連絡先グループのメンバーは入力されません。
HTTP リクエスト
GET https://people.googleapis.com/v1/contactGroups
この URL は gRPC Transcoding 構文を使用します。
クエリ パラメータ
パラメータ | |
---|---|
pageToken |
省略可。前回の contactGroups.list の呼び出しから返された nextPageToken の値。リソースの次のページをリクエストします。 |
pageSize |
省略可。返されるリソースの最大数。有効な値は 1 ~ 1, 000 です。設定しない場合、または 0 に設定した場合、デフォルトは 30 です。 |
syncToken |
省略可。前回の |
groupFields |
省略可。グループで返されるフィールドを制限するフィールド マスク。未設定または空に設定した場合のデフォルトは、
|
リクエスト本文
リクエストの本文は空にする必要があります。
レスポンスの本文
連絡先グループのリスト リクエストに対するレスポンス。
成功すると、レスポンスの本文に次の構造のデータが含まれます。
JSON 表現 |
---|
{
"contactGroups": [
{
object ( |
フィールド | |
---|---|
contactGroups[] |
連絡先グループのリスト。連絡先グループのメンバーは入力されません。 |
totalItems |
ページ分けなしのリスト内のアイテムの合計数。 |
nextPageToken |
結果の次のページを取得するために使用できるトークン。 |
nextSyncToken |
最後のリクエスト以降の変更を取得するために使用できるトークン。 |
承認スコープ
次の OAuth スコープのいずれかが必要です。
https://www.googleapis.com/auth/contacts
https://www.googleapis.com/auth/contacts.readonly
詳しくは、承認ガイドをご覧ください。