Method: people.getBatchGet

Liefert Informationen über eine Liste bestimmter Personen durch Angabe einer Liste angeforderter Ressourcennamen. 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 angegeben 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.
  • Wenn Sie Informationen zu einem Kontakt abrufen möchten, geben Sie den Ressourcennamen an, der den von people.connections.list zurückgegebenen Kontakt identifiziert.

Es sind maximal 200 Ressourcennamen zulässig.
requestMask
(deprecated)

object (RequestMask)

EINGESTELLT (Verwenden Sie stattdessen personFields.)

Eine Maske, mit der die Ergebnisse auf eine Teilmenge von Personenfeldern beschränkt werden.
personFields

string (FieldMask format)

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

  • addresses
  • ageRanges
  • biografien
  • Geburtstage
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • Veranstaltungen
  • externalIds
  • geschlechter
  • imClients
  • interessen
  • locales
  • Standorte
  • mitgliedschaft
  • Metadaten
  • miscKeywords
  • names
  • Spitznamen
  • Berufe
  • organizations
  • phoneNumbers
  • fotos
  • Beziehungen
  • sipAddresses
  • skills
  • urls
  • userDefined
sources[]

enum (ReadSourceType)

Optional. Eine Maske, die angibt, welche Quelltypen zurückgegeben werden sollen. Wenn kein Wert festgelegt wird, 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 Ressourcenname.

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

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.