Method: contactGroups.list

Listet alle Kontaktgruppen auf, deren Inhaber der authentifizierte Nutzer ist. Die Mitglieder der Kontaktgruppen werden nicht ausgefüllt.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Abfrageparameter

Parameter
pageToken

string

Optional. Der Wert "nextPageToken", der von einem vorherigen Aufruf an contactGroups.list zurückgegeben wurde. Fordert die nächste Seite mit Ressourcen an.
pageSize

integer

Optional. Die maximale Anzahl von Ressourcen, die zurückgegeben werden sollen. Gültige Werte liegen zwischen 1 und 1.000 (einschließlich). Wenn die Richtlinie nicht konfiguriert oder auf „0“ festgelegt ist, ist die Standardeinstellung 30.
syncToken

string

Optional. Ein Synchronisierungstoken, das von einem vorherigen Aufruf an contactgroups.list zurückgegeben wurde. Es werden nur Ressourcen zurückgegeben, die seit Erstellung des Synchronisierungstokens geändert wurden.
groupFields

string (FieldMask format)

Optional. Eine Feldmaske, mit der eingeschränkt wird, welche Felder in der Gruppe zurückgegeben werden. Wenn die Richtlinie nicht konfiguriert oder auf „leer“ gesetzt ist, werden standardmäßig metadata, groupType, memberCount und name verwendet. Gültige Felder sind:

  • clientData
  • groupType
  • memberCount
  • Metadaten
  • name

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Die Antwort auf eine Anfrage zur Auflistung von Kontaktgruppen.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "contactGroups": [
    {
      object (ContactGroup)
    }
  ],
  "totalItems": integer,
  "nextPageToken": string,
  "nextSyncToken": string
}
Felder
contactGroups[]

object (ContactGroup)

Die Liste der Kontaktgruppen. Die Mitglieder der Kontaktgruppen werden nicht ausgefüllt.
totalItems

integer

Die Gesamtzahl der Elemente in der Liste ohne Paginierung.
nextPageToken

string

Das Token, mit dem die nächste Ergebnisseite abgerufen werden kann.
nextSyncToken

string

Das Token, mit dem seit der letzten Anfrage Änderungen abgerufen werden können.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.