People API memungkinkan Anda:
- Membaca dan mengelola Kontak pengguna yang diautentikasi
- Membaca dan menyalin "Kontak lainnya" milik pengguna yang diautentikasi
- Membaca informasi profil untuk pengguna yang diautentikasi dan kontak mereka
- Membaca profil dan kontak domain
Misalnya, pengguna terautentikasi, Jen, memiliki Fabian dan Ranjith di kontak pribadinya. Saat aplikasi Anda memanggil
people.connections.list
untuk membaca
daftar koneksinya, Jen akan melihat layar izin yang meminta untuk memberi
aplikasi tersebut akses ke daftar tersebut. Jika Jen mengizinkan, aplikasi akan membaca daftar yang berisi
person resources
untuk Fabian dan Ranjith.
Jika memerlukan informasi untuk orang tertentu, aplikasi dapat memanggil
people.get
, yang meneruskan nama resource, untuk mendapatkan
person resource
bagi orang tersebut.
Aplikasi juga dapat mengelola kontak dengan membuat kontak baru menggunakan
people.createContact
, memperbarui kontak
yang ada yang telah dibaca dari
people.connections.list
menggunakan
people.updateContact
, dan menghapus kontak
menggunakan people.deleteContact
.
Pengguna Google Workspace juga dapat mencantumkan profil domain direktori dan kontak
domain mereka menggunakan
people.listDirectoryPeople
atau menelusurinya
menggunakan
people.searchDirectoryPeople
.
Tampilan gabungan informasi tentang orang
Informasi orang yang dibaca People API digabungkan dari berbagai sumber, bergantung pada kondisi berikut:
Sumber | Kondisi |
---|---|
Data profil Google publik | Selalu. |
Data profil domain Google Workspace | Admin domain telah mengaktifkan kontak eksternal dan
berbagi
profil
data cakupan domain dan cakupan
directory.readonly telah
diberikan |
Informasi profil pribadi pengguna yang telah diautentikasi | Salah satu cakupan
profile telah
diberikan. |
Kontak pengguna yang telah diotentikasi | Cakupan
contacts telah
diberikan. |
Memahami Data Orang yang Digabungkan
Data untuk seseorang berasal dari satu jenis sumber utama. Data dari sumber lain akan digabungkan dengan data ini jika sumbernya terhubung melalui alamat email, nomor telepon, atau URL profil yang terverifikasi. Berikut cara menyusun seseorang:
Sumber Utama | Kontak | Profil | Profil Domain Google Workspace | Kontak Domain Google Workspace | Penggunaan |
---|---|---|---|---|---|
Kontak | 1 | 0+ | 0+ | 0+ | Ditampilkan untuk sebagian besar endpoint |
Profil | 0+ | 1 | 0 atau 1 | 0 | Ditampilkan people.get saat digunakan untuk mendapatkan orang untuk pengguna yang login atau mendapatkan orang untuk Akun Google pengguna lain. |
Kontak Domain | 0+ | 0 | 0 | 1 | Dikembalikan dalam people.listDirectoryPeople atau people.searchDirectoryPeople . |
Hanya orang berbasis kontak yang dapat diubah oleh endpoint mutasi. Mutasi kontak profil dan kontak domain tidak didukung.