Method: contactGroups.list

Hiermit werden alle Kontaktgruppen des authentifizierten Nutzers aufgelistet. 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“ wurde von einem vorherigen Aufruf von contactGroups.list zurückgegeben. 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 im Bereich von 1 bis 1.000. Der Standardwert ist 30, wenn nicht oder 0 festgelegt.

syncToken

string

Optional. Ein Synchronisierungstoken, das von einem vorherigen Aufruf von 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 zur Einschränkung der zurückgegebenen Felder in der Gruppe. Die Standardeinstellung ist metadata, groupType, memberCount und name, wenn kein Wert festgelegt oder das Feld leer ist. Gültige Felder sind:

  • Kundendaten
  • Gruppentyp
  • Anzahl der Mitglieder
  • metadata
  • name

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

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

Die Antwort auf eine Listenkontaktgruppe.

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 Ä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 Autorisierungsleitfaden.