Method: people.getBatchGet

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

Permintaan ini 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 diisi. Nama resource orang yang akan diberikan informasi. Dapat diulang. Parameter kueri URL harus

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

  • Untuk mendapatkan informasi tentang pengguna terautentikasi, tentukan people/me.
  • Untuk mendapatkan informasi tentang Akun Google, tentukan people/{account_id}.
  • Untuk mendapatkan informasi tentang kontak, tentukan nama resource yang mengidentifikasi kontak sebagai 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 subset kolom orang.

personFields

string (FieldMask format)

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

  • addresses
  • ageRanges
  • biografi
  • ulang tahun
  • calendarUrls
  • dataklien
  • coverFoto
  • alamatEmail
  • acara
  • ID eksternal
  • gender
  • imClients
  • minat
  • lokalitas
  • lokasi
  • channel
  • metadata
  • Kata Kunci Lain-Lain
  • nama
  • nama panggilan
  • pekerjaan
  • organisasi
  • nomor telepon
  • foto
  • hubungan
  • sipAddress
  • keterampilan
  • Url
  • Buatan pengguna
sources[]

enum (ReadSourceType)

Opsional. Masker dari 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

Jika berhasil, isi respons memuat data dengan struktur berikut:

Respons terhadap permintaan dapatkan untuk daftar orang berdasarkan nama resource.

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/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 mendapatkan informasi lebih lanjut, lihat Panduan otorisasi.