Method: people.getBatchGet

Udostępnia informacje o liście konkretnych osób przez określenie listy żądanych nazw zasobów. Użyj people/me, aby wskazać uwierzytelnionego użytkownika.

Jeśli nie podasz parametru „personFields”, żądanie zwróci błąd 400.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry zapytania

Parametry
resourceNames[]

string

Wymagane. Nazwy zasobów z informacjami o użytkownikach. Jest powtarzalny. Parametr zapytania w adresie URL powinien być

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

  • Aby uzyskać informacje o uwierzytelnionym użytkowniku, wpisz people/me.
  • Aby uzyskać informacje o koncie Google, podaj people/{account_id}.
  • Aby uzyskać informacje o kontakcie, podaj nazwę zasobu, która identyfikuje kontakt zwracany przez funkcję people.connections.list.

Możesz mieć maksymalnie 200 nazw zasobów.

requestMask
(deprecated)

object (RequestMask)

WYCOFANY (użyj zamiast niego personFields)

Maska służąca do ograniczania wyników do podzbioru pól osoby.

personFields

string (FieldMask format)

Wymagane. Maska pola, która ogranicza, które pola dotyczące danej osoby mają być zwracane. Można określić wiele pól, rozdzielając je przecinkami. Prawidłowe wartości to:

  • adresy
  • ageRanges
  • biografie
  • urodziny
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • wydarzenia
  • externalIds
  • płeć
  • imClients
  • zainteresowania
  • locales
  • lokalizacje
  • kanału
  • metadane
  • miscKeywords
  • nazwy
  • pseudonimy
  • zawody
  • organizacje
  • phoneNumbers
  • zdjęcia
  • relacje
  • sipAddresses
  • umiejętności
  • adresy
  • userDefined
sources[]

enum (ReadSourceType)

Opcjonalnie: Maska typów źródeł do zwrócenia. Jeśli nie zostanie ustawiony, domyślnie przyjmuje się wartości READ_SOURCE_TYPE_CONTACT i READ_SOURCE_TYPE_PROFILE.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź na żądanie pobrania listy osób według nazwy zasobu.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON
{
  "responses": [
    {
      object (PersonResponse)
    }
  ]
}
Pola
responses[]

object (PersonResponse)

Odpowiedź dla każdej żądanej nazwy zasobu.

Zakresy autoryzacji

Dostęp do danych publicznych nie wymaga autoryzacji. W przypadku danych prywatnych wymagany jest jeden z tych zakresów OAuth:

  • 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

Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.