Method: contactGroups.list

Hiermit werden alle Kontaktgruppen des authentifizierten Nutzers aufgelistet. Die Mitglieder der Kontaktgruppen enthalten keine Daten.

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 der Ressourcen, die zurückgegeben werden sollen. Gültige Werte liegen zwischen 1 und 1.000 (einschließlich). Wenn kein Wert festgelegt oder auf 0 festgelegt, ist der Standardwert 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 der Erstellung des Synchronisierungstokens geändert wurden.

groupFields

string (FieldMask format)

Optional. Eine Feldmaske, um einzuschränken, welche Felder für die Gruppe zurückgegeben werden. Die Standardeinstellung ist metadata, groupType, memberCount und name, wenn das Feld nicht festgelegt oder leer ist. Gültige Felder sind:

  • clientData
  • groupType
  • memberCount
  • Metadaten
  • Name

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Die Antwort auf eine Anfrage zum Auflisten 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)

Liste der Kontaktgruppen Die Mitglieder der Kontaktgruppen enthalten keine Daten.

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 Änderungen seit der letzten Anfrage 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.