Method: people.getBatchGet

Liefert Informationen zu einer Liste bestimmter Personen, indem Sie eine Liste der angeforderten Ressourcennamen angeben. Verwenden Sie people/me, um den authentifizierten Nutzer anzugeben.

Die Anfrage gibt einen 400-Fehler zurück, wenn „personFields“ nicht angegeben ist.

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 bereitgestellt werden sollen. Sie ist wiederholbar. Der URL-Suchparameter muss

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 abzurufen.
  • Um Informationen zu einem Kontakt abzurufen, geben Sie den Ressourcennamen an, der den Kontakt als von people.connections.list zurückgegeben identifiziert.

Es sind maximal 200 Ressourcennamen zulässig.

requestMask
(deprecated)

object (RequestMask)

Eingestellt (nutzen Sie stattdessen personFields)

Eine Maske, die Ergebnisse auf eine Teilmenge von Personenfeldern beschränkt.

personFields

string (FieldMask format)

Erforderlich. Eine Feldmaske zur Einschränkung der zurückgegebenen Felder für jede Person. Sie können mehrere Felder angeben, indem Sie sie durch Kommas trennen. Gültige Werte sind:

  • addresses
  • Altersbereiche
  • Biografien
  • Geburtstage
  • calendarUrls
  • Kundendaten
  • Cover Photos
  • emailAddresses
  • Veranstaltungen
  • Externe IDs
  • geschlechter
  • Kunden
  • interessen
  • locales
  • Standorte
  • mitgliedschaft
  • metadata
  • Sonstige Keywords
  • names
  • Spitznamen
  • Berufe
  • organizations
  • phoneNumbers
  • fotos
  • Beziehungen
  • sipAdressen
  • skills
  • URLs
  • Benutzerdefiniert
sources[]

enum (ReadSourceType)

Optional. Eine Maske, welche Quelltypen zurückgegeben werden sollen. 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

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

Die Antwort auf eine get-Anfrage für eine Liste von Personen nach Ressourcenname.

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

Weitere Informationen finden Sie im Autorisierungsleitfaden.