Method: people.getBatchGet

Stellt Informationen zu einer Liste bestimmter Personen bereit, indem eine Liste der angeforderten Ressourcennamen angegeben wird. Verwenden Sie people/me, um den authentifizierten Nutzer anzugeben.

Wenn „personFields“ nicht angegeben ist, gibt die Anfrage den Fehler 400 zurück.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Abfrageparameter

Parameter
resourceNames[]

string

Erforderlich. Die Ressourcennamen der Personen, zu denen Informationen angegeben werden sollen. Sie ist wiederholbar. Der URL-Suchparameter sollte

resourceNames=<name1>&resourceNames=<name2>&...

  • Geben Sie people/me an, um Informationen zum authentifizierten Nutzer abzurufen.
  • Geben Sie people/{account_id} an, um Informationen zu einem Google-Konto zu erhalten.
  • Geben Sie zum Abrufen von Informationen zu einem Kontakt den Ressourcennamen an, der den Kontakt als von people.connections.list zurückgegeben identifiziert.

Es können maximal 200 Ressourcennamen verwendet werden.

requestMask
(deprecated)

object (RequestMask)

VERWORFEN (verwenden Sie stattdessen personFields)

Eine Maske, mit der die Ergebnisse auf eine Teilmenge der Personenfelder beschränkt werden.

personFields

string (FieldMask format)

Erforderlich. Eine Feldmaske, mit der eingeschränkt wird, welche Felder zu den einzelnen Personen zurückgegeben werden. Sie können mehrere Felder angeben, indem Sie sie durch Kommas trennen. Gültige Werte sind:

  • Adressen
  • ageRanges
  • Biografien
  • Geburtstage
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • Veranstaltungen
  • externalIds
  • geschlechter
  • imClients
  • Interessen
  • locales
  • Standorte
  • mitgliedschaft
  • Metadaten
  • miscKeywords
  • Namen
  • Spitznamen
  • Berufe
  • Organisationen
  • phoneNumbers
  • Fotos
  • Beziehungen
  • sipAddresses
  • skills
  • URLs
  • userDefined
sources[]

enum (ReadSourceType)

Optional. Eine Maske der zurückzugebenden Quelltypen. Wenn kein Wert festgelegt ist, werden standardmäßig READ_SOURCE_TYPE_CONTACT und READ_SOURCE_TYPE_PROFILE verwendet.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Die Antwort auf eine GET-Anfrage für eine Liste von Personen nach Ressourcennamen.

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

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

object (PersonResponse)

Die Antwort für jeden angeforderten Ressourcennamen.

Autorisierungsbereiche

Für den Zugriff auf öffentliche Daten ist keine Autorisierung erforderlich. Für private Daten ist einer der folgenden OAuth-Bereiche erforderlich:

  • https://www.googleapis.com/auth/contacts
  • https://www.googleapis.com/auth/contacts.readonly
  • https://www.googleapis.com/auth/contacts.other.readonly
  • https://www.googleapis.com/auth/directory.readonly
  • https://www.googleapis.com/auth/profile.agerange.read
  • https://www.googleapis.com/auth/profile.emails.read
  • https://www.googleapis.com/auth/profile.language.read
  • https://www.googleapis.com/auth/user.addresses.read
  • https://www.googleapis.com/auth/user.birthday.read
  • https://www.googleapis.com/auth/user.emails.read
  • https://www.googleapis.com/auth/user.gender.read
  • https://www.googleapis.com/auth/user.organization.read
  • https://www.googleapis.com/auth/user.phonenumbers.read
  • https://www.googleapis.com/auth/userinfo.email
  • https://www.googleapis.com/auth/userinfo.profile
  • https://www.googleapis.com/auth/profile.language.read

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.