Method: contactGroups.list

Wyświetla wszystkie grupy kontaktów należące do uwierzytelnionego użytkownika. Członkowie grup kontaktów nie są wypełnieni.

Żą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 contactGroups.list. Powoduje przejście na następną stronę zasobów.

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 zostanie ustawiony lub zostanie ustawiony na 0, domyślna wartość to 30.

syncToken

string

Opcjonalnie: Token synchronizacji zwrócony przez poprzednie wywołanie funkcji contactgroups.list. Zwrócone zostaną tylko zasoby zmienione od czasu utworzenia tokena synchronizacji.

groupFields

string (FieldMask format)

Opcjonalnie: Maska pola ograniczająca, które pola w grupie są zwracane. Jeśli nie jest ustawiona lub jest pusta, domyślne wartości 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. Członkowie grup kontaktów nie są wypełnieni.

totalItems

integer

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

nextPageToken

string

Token, za pomocą którego można pobrać następną stronę wyników.

nextSyncToken

string

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

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

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

Więcej informacji znajdziesz w przewodniku na temat autoryzacji.