Method: contactGroups.batchGet

Rufen Sie eine Liste der Kontaktgruppen des authentifizierten Nutzers ab, indem Sie eine Liste mit Ressourcennamen für Kontaktgruppen 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 abzurufenden Kontaktgruppen.

Es sind maximal 200 Ressourcennamen zulässig.

maxMembers

integer

Optional. Gibt die maximale Anzahl von Mitgliedern an, die für jede Gruppe zurückgegeben werden sollen. Wenn nicht festgelegt, ist der Standardwert 0, wodurch keine Mitglieder zurückgegeben werden.

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 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