Method: contactGroups.list

Wyświetl wszystkie grupy kontaktów należące do uwierzytelnionego użytkownika. Lista członków grup kontaktów nie jest wypełniona.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry zapytania

Parametry
pageToken

string

Opcjonalnie. Wartość nextPageToken zwrócona z poprzedniego wywołania do contactGroups.list. Wysyła żądanie do następnej strony z zasobami.
pageSize

integer

Opcjonalnie. Maksymalna liczba zasobów do zwrócenia. Prawidłowe wartości mieszczą się w zakresie od 1 do 1000 włącznie. Jeśli nie jest ustawiona lub jest ustawiona na 0, domyślna wartość to 30.
syncToken

string

Opcjonalnie. Token synchronizacji zwrócony przez poprzednie wywołanie metody contactgroups.list. Zwrócone zostaną tylko zasoby, które zostały zmienione od czasu utworzenia tokena synchronizacji.
groupFields

string (FieldMask format)

Opcjonalnie. Maska pola określająca, które pola w grupie mają być zwracane. Jeśli nie jest ustawiony lub jest pusty, domyślna wartość to metadata, groupType, memberCount i name. Prawidłowe pola to:

  • clientData
  • groupType
  • memberCount
  • metadane
  • nazwa

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź na żądanie wyświetlenia listy grup kontaktów.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "contactGroups": [
    {
      object (ContactGroup)
    }
  ],
  "totalItems": integer,
  "nextPageToken": string,
  "nextSyncToken": string
}
Pola
contactGroups[]

object (ContactGroup)

Lista grup kontaktów. Lista członków grup kontaktów nie jest wypełniona.
totalItems

integer

Łączna liczba elementów na liście bez podziału na strony.
nextPageToken

string

Token, którego można użyć do pobrania następnej strony wyników.
nextSyncToken

string

Token, za pomocą którego można pobrać zmiany od czasu ostatniego żądania.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.