Method: contactGroups.batchGet

Sie können eine Liste der Kontaktgruppen abrufen, deren Inhaber der authentifizierte Nutzer ist, indem Sie eine Liste der Ressourcennamen der 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. Der Standardwert ist 0, wenn kein Wert festgelegt ist. Dadurch werden null Mitglieder zurückgegeben.

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 Batchanfrage zum Abrufen von Kontaktgruppen.

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

Kontaktgruppen-Antwort

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)

Die Kontaktgruppe.