Method: people.getBatchGet

Memberikan informasi tentang daftar orang tertentu dengan menentukan daftar nama fasilitas yang diminta. Gunakan people/me untuk menunjukkan pengguna yang diautentikasi.

Permintaan menampilkan error 400 jika 'personFields' tidak ditentukan.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter kueri

Parameter
resourceNames[]

string

Wajib. Nama resource orang yang akan diberi informasi. Bersifat berulang. Parameter kueri URL harus

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

  • Untuk mendapatkan informasi tentang pengguna yang diautentikasi, tetapkan people/me.
  • Untuk mendapatkan informasi tentang Akun Google, tentukan people/{account_id}.
  • Untuk mendapatkan informasi tentang kontak, tentukan nama resource yang mengidentifikasi kontak seperti yang ditampilkan oleh people.connections.list.

Jumlah maksimum nama resource adalah 200.

requestMask
(deprecated)

object (RequestMask)

TIDAK DIGUNAKAN LAGI (Sebagai gantinya, gunakan personFields)

Mask untuk membatasi hasil ke sebagian kolom orang.

personFields

string (FieldMask format)

Wajib. Mask kolom untuk membatasi kolom mana pada setiap orang yang ditampilkan. Beberapa kolom dapat ditentukan dengan memisahkannya menggunakan koma. Nilai yang valid adalah:

  • addresses
  • ageRanges
  • biografi
  • ulang tahun
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • acara
  • externalIds
  • gender
  • imClients
  • minat
  • locales
  • lokasi
  • channel
  • metadata
  • miscKeywords
  • names
  • nama panggilan
  • pekerjaan
  • organizations
  • phoneNumbers
  • foto
  • relasi
  • sipAddresses
  • keterampilan
  • urls
  • userDefined
sources[]

enum (ReadSourceType)

Opsional. Mask untuk jenis sumber yang akan ditampilkan. Jika tidak ditetapkan, setelan defaultnya adalah READ_SOURCE_TYPE_CONTACT dan READ_SOURCE_TYPE_PROFILE.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Respons terhadap permintaan get untuk daftar orang berdasarkan nama resource.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON
{
  "responses": [
    {
      object (PersonResponse)
    }
  ]
}
Kolom
responses[]

object (PersonResponse)

Respons untuk setiap nama resource yang diminta.

Cakupan otorisasi

Tidak diperlukan otorisasi untuk mengakses data publik. Untuk data pribadi, salah satu cakupan OAuth berikut diperlukan:

  • 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

Untuk informasi selengkapnya, lihat Panduan otorisasi.