Method: contactGroups.batchGet

Rufen Sie eine Liste der Kontaktgruppen ab, die dem authentifizierten Nutzer gehören, indem Sie eine Liste mit Kontaktgruppen-Ressourcennamen angeben.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Abfrageparameter

Parameter
resourceNames[]

string

Erforderlich. Die Ressourcennamen der Kontaktgruppen, die abgerufen werden sollen.

Es sind maximal 200 Ressourcennamen zulässig.
maxMembers

integer

Optional. Gibt die maximale Anzahl der Mitglieder an, die für jede Gruppe zurückgegeben werden sollen. Wenn kein Wert festgelegt ist, wird der Standardwert 0 verwendet. Dadurch werden null Mitglieder zurückgegeben.
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 Batchanfrage zum Abrufen von Kontaktgruppen.

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

JSON-Darstellung 
{
  "responses": [
    {
      object (ContactGroupResponse)
    }
  ]
}
Felder
responses[]

object (ContactGroupResponse)

Die Liste der Antworten für jede angeforderte Kontaktgruppenressource.

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.

ContactGroupResponse

Die Antwort für eine bestimmte Kontaktgruppe.

JSON-Darstellung 
{
  "requestedResourceName": string,
  "status": {
    object (Status)
  },
  "contactGroup": {
    object (ContactGroup)
  }
}
Felder
requestedResourceName

string

Der ursprünglich angeforderte Ressourcenname.
status

object (Status)

Der Status der Antwort.
contactGroup

object (ContactGroup)

Kontaktgruppe