- แหล่งข้อมูล: บุคคล
- การแสดง JSON
- PersonMetadata
- แหล่งที่มา
- SourceType
- ProfileMetadata
- ObjectType
- UserType
- ที่อยู่
- FieldMetadata
- AgeRange
- AgeRangeType
- ชีวประวัติ
- ContentType
- วันเกิด
- วันที่
- BraggingRights
- CalendarUrl
- ClientData
- CoverPhoto
- EmailAddress
- เหตุการณ์
- ExternalId
- FileAs
- เพศ
- ImClient
- ความสนใจ
- ภาษา
- ตำแหน่ง
- การเป็นสมาชิก
- ContactGroupMembership
- DomainMembership
- MiscKeyword
- KeywordType
- ชื่อ
- ชื่อเล่น
- NicknameType
- อาชีพ
- องค์กร
- PhoneNumber
- รูปภาพ
- ความสัมพันธ์
- RelationshipInterest
- RelationshipStatus
- ที่พักอาศัย
- SipAddress
- ทักษะ
- แท็กไลน์
- URL
- UserDefined
- เมธอด
แหล่งข้อมูล: บุคคล
ข้อมูลเกี่ยวกับบุคคลที่ผสานรวมมาจากแหล่งข้อมูลต่างๆ เช่น รายชื่อติดต่อและข้อมูลโปรไฟล์ของผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว
ช่องส่วนใหญ่สามารถใส่ได้หลายรายการ รายการในช่องไม่มีคำสั่งซื้อที่รับประกันการแสดงผล แต่รับประกันว่าช่องที่ไม่เว้นว่างไว้จะมีเพียง 1 ช่องที่ตั้งค่า metadata.primary
เป็น "จริง"
การแสดง JSON |
---|
{ "resourceName": string, "etag": string, "metadata": { object ( |
ช่อง | |
---|---|
resourceName |
ชื่อทรัพยากรสำหรับบุคคลที่เซิร์ฟเวอร์กำหนด สตริง ASCII ในรูปแบบของ |
etag |
แท็กเอนทิตี HTTP ของทรัพยากร ใช้สำหรับการตรวจสอบเว็บแคช |
metadata |
เอาต์พุตเท่านั้น ข้อมูลเมตาเกี่ยวกับบุคคล |
addresses[] |
ที่อยู่ของบุคคล |
ageRange |
เอาต์พุตเท่านั้น เลิกใช้งานแล้ว (โปรดใช้ ช่วงอายุของบุคคลนั้น |
ageRanges[] |
เอาต์พุตเท่านั้น ช่วงอายุของบุคคลนั้น |
biographies[] |
ชีวประวัติของบุคคลนั้น ฟิลด์นี้เป็น Singleton สำหรับแหล่งที่มาของที่อยู่ติดต่อ |
birthdays[] |
วันเกิดของบุคคลนั้น ฟิลด์นี้เป็น Singleton สำหรับแหล่งที่มาของที่อยู่ติดต่อ |
braggingRights[] |
เลิกใช้งานแล้ว: จะไม่มีการส่งกลับข้อมูลเรื่องสิทธิ์ในการโม้ให้แก่บุคคลนั้น |
calendarUrls[] |
URL ปฏิทินของบุคคล |
clientData[] |
ข้อมูลไคลเอ็นต์ของบุคคลดังกล่าว |
coverPhotos[] |
เอาต์พุตเท่านั้น รูปภาพปกของบุคคลดังกล่าว |
emailAddresses[] |
อีเมลของบุคคลนั้น สำหรับ |
events[] |
เหตุการณ์ของบุคคลนั้น |
externalIds[] |
รหัสภายนอกของบุคคลนั้น |
fileAses[] |
File-ases ของบุคคลที่ต้องการ |
genders[] |
เพศของผู้ใช้ ฟิลด์นี้เป็น Singleton สำหรับแหล่งที่มาของที่อยู่ติดต่อ |
imClients[] |
โปรแกรมรับส่งข้อความโต้ตอบแบบทันทีของบุคคลนั้น |
interests[] |
ความสนใจของบุคคล |
locales[] |
ค่ากำหนดภาษาของบุคคลนั้น |
locations[] |
ตําแหน่งของบุคคล |
memberships[] |
การเป็นสมาชิกกลุ่มของบุคคลนั้น |
miscKeywords[] |
คีย์เวิร์ดเบ็ดเตล็ดของบุคคลนั้น |
names[] |
ชื่อบุคคลนั้น ฟิลด์นี้เป็น Singleton สำหรับแหล่งที่มาของที่อยู่ติดต่อ |
nicknames[] |
ชื่อเล่นของบุคคลนั้น |
occupations[] |
อาชีพของบุคคลนั้น |
organizations[] |
องค์กรในอดีตหรือองค์กรปัจจุบันของบุคคลนั้น |
phoneNumbers[] |
หมายเลขโทรศัพท์ของบุคคลนั้น สำหรับ |
photos[] |
เอาต์พุตเท่านั้น รูปภาพของบุคคลนั้น |
relations[] |
ความสัมพันธ์ของบุคคลนั้น |
relationshipInterests[] |
เอาต์พุตเท่านั้น เลิกใช้งานแล้ว: ระบบจะไม่แสดงผลข้อมูลความสนใจด้านความสัมพันธ์ของบุคคลนั้น |
relationshipStatuses[] |
เอาต์พุตเท่านั้น เลิกใช้งานแล้ว: ระบบจะไม่แสดงผลข้อมูลสถานะความสัมพันธ์ของบุคคล |
residences[] |
เลิกใช้งานแล้ว: (โปรดใช้ |
sipAddresses[] |
ที่อยู่ SIP ของบุคคลนั้น |
skills[] |
ทักษะของบุคคล |
taglines[] |
เอาต์พุตเท่านั้น เลิกใช้งานแล้ว: ระบบจะไม่แสดงผลข้อมูลแท็กไลน์ของบุคคล |
urls[] |
URL ที่เกี่ยวข้องของบุคคล |
userDefined[] |
ข้อมูลที่กำหนดโดยผู้ใช้ของบุคคลนั้น |
PersonMetadata
ข้อมูลเมตาเกี่ยวกับบุคคล
การแสดง JSON |
---|
{ "sources": [ { object ( |
ช่อง | |
---|---|
sources[] |
แหล่งที่มาของข้อมูลสำหรับบุคคล |
previousResourceNames[] |
เอาต์พุตเท่านั้น ชื่อทรัพยากรเดิมที่บุคคลนี้มี ป้อนข้อมูลสําหรับคําขอ ชื่อทรัพยากรอาจเปลี่ยนแปลงเมื่อเพิ่มหรือนำช่องที่ลิงก์รายชื่อติดต่อและโปรไฟล์ออก เช่น อีเมลที่ยืนยันแล้ว หมายเลขโทรศัพท์ที่ยืนยันแล้ว หรือ URL ของโปรไฟล์ |
linkedPeopleResourceNames[] |
เอาต์พุตเท่านั้น ชื่อทรัพยากรของบุคคลที่ลิงก์กับทรัพยากรนี้ |
deleted |
เอาต์พุตเท่านั้น เป็นจริงหากทรัพยากรบุคคลถูกลบ ป้อนข้อมูลสำหรับคำขอซิงค์ |
objectType |
เอาต์พุตเท่านั้น เลิกใช้งานแล้ว (โปรดใช้ ประเภทของออบเจ็กต์บุคคล |
แหล่งที่มา
แหล่งที่มาของช่อง
การแสดง JSON |
---|
{ "type": enum ( |
ช่อง | |
---|---|
type |
ประเภทแหล่งที่มา |
id |
ตัวระบุที่ไม่ซ้ำกันภายในประเภทต้นทางที่เซิร์ฟเวอร์สร้างขึ้น |
etag |
ป้อนข้อมูลใน แท็กเอนทิตี HTTP ของแหล่งที่มา ใช้สำหรับการตรวจสอบเว็บแคช |
updateTime |
เอาต์พุตเท่านั้น ป้อนข้อมูลใน การประทับเวลาอัปเดตล่าสุดของแหล่งที่มานี้ การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและมีตัวเลขที่เป็นเศษส่วนได้สูงสุด 9 หลัก ตัวอย่าง: |
ฟิลด์สหภาพ ข้อมูลเมตาเกี่ยวกับแหล่งที่มา |
|
profileMetadata |
เอาต์พุตเท่านั้น ป้อนข้อมูลใน ข้อมูลเมตาเกี่ยวกับแหล่งที่มาของประเภท PROFILE |
SourceType
ประเภทของแหล่งที่มา
Enum | |
---|---|
SOURCE_TYPE_UNSPECIFIED |
ไม่ระบุ |
ACCOUNT |
บัญชี Google |
PROFILE |
โปรไฟล์ Google คุณดูโปรไฟล์ได้ที่ https://profiles.google.com/{id} โดย {id} เป็นรหัสแหล่งที่มา |
DOMAIN_PROFILE |
โปรไฟล์ในโดเมน Google Workspace |
CONTACT |
รายชื่อติดต่อของ Google ดูรายชื่อติดต่อได้ที่ https://contact.google.com/{id} โดย {id} เป็นรหัสต้นทาง |
OTHER_CONTACT |
"รายชื่อติดต่ออื่นๆ" ของ Google |
DOMAIN_CONTACT |
รายชื่อติดต่อที่แชร์ของโดเมน Google Workspace |
ProfileMetadata
ข้อมูลเมตาเกี่ยวกับโปรไฟล์
การแสดง JSON |
---|
{ "objectType": enum ( |
ช่อง | |
---|---|
objectType |
เอาต์พุตเท่านั้น ประเภทออบเจ็กต์โปรไฟล์ |
userTypes[] |
เอาต์พุตเท่านั้น ผู้ใช้พิมพ์ |
ObjectType
ประเภทของออบเจ็กต์บุคคล
Enum | |
---|---|
OBJECT_TYPE_UNSPECIFIED |
ไม่ระบุ |
PERSON |
บุคคล |
PAGE |
หน้า Currents |
UserType
ประเภทของผู้ใช้
Enum | |
---|---|
USER_TYPE_UNKNOWN |
ไม่ทราบประเภทผู้ใช้ |
GOOGLE_USER |
ผู้ใช้คือผู้ใช้ Google |
GPLUS_USER |
ผู้ใช้รายนั้นเป็นผู้ใช้ Currents |
GOOGLE_APPS_USER |
ผู้ใช้คือผู้ใช้ Google Workspace |
ที่อยู่
ที่อยู่จริงของบุคคล โดยอาจเป็นตู้ ปณ. หรือที่อยู่ ไม่จำเป็นต้องกรอกข้อมูลครบทุกช่อง
การแสดง JSON |
---|
{
"metadata": {
object ( |
ช่อง | |
---|---|
metadata |
ข้อมูลเมตาเกี่ยวกับที่อยู่ |
formattedValue |
ค่าที่ไม่มีโครงสร้างของที่อยู่ หากผู้ใช้ไม่ได้ตั้งค่านี้ไว้ ระบบจะสร้างขึ้นจากค่าที่มีโครงสร้างโดยอัตโนมัติ |
type |
ประเภทของที่อยู่ โดยสามารถกำหนดเองหรือมีค่าที่กำหนดล่วงหน้าค่าใดค่าหนึ่งต่อไปนี้
|
formattedType |
เอาต์พุตเท่านั้น ประเภทของที่อยู่ที่แปลและจัดรูปแบบในภาษาของบัญชีของผู้ชมหรือภาษาส่วนหัวของ HTTP ของ |
poBox |
ตู้ ปณ. ของที่อยู่ |
streetAddress |
ที่อยู่ |
extendedAddress |
ที่อยู่แบบขยายของที่อยู่ เช่น เลขที่อพาร์ตเมนต์ |
city |
เมืองของที่อยู่ |
region |
ภูมิภาคของที่อยู่ เช่น รัฐหรือจังหวัด |
postalCode |
รหัสไปรษณีย์ของที่อยู่ |
country |
ประเทศของที่อยู่ |
countryCode |
รหัสประเทศ ISO 3166-1 alpha-2 ของที่อยู่ |
FieldMetadata
ข้อมูลเมตาเกี่ยวกับช่อง
การแสดง JSON |
---|
{
"primary": boolean,
"sourcePrimary": boolean,
"verified": boolean,
"source": {
object ( |
ช่อง | |
---|---|
primary |
เอาต์พุตเท่านั้น เป็นจริงหากฟิลด์นี้เป็นช่องหลักสำหรับแหล่งที่มาทั้งหมดในบุคคลนั้นๆ ผู้ใช้แต่ละคนจะมีช่องไม่เกิน 1 ช่องโดยตั้งค่า |
sourcePrimary |
เป็นจริงหากช่องนี้เป็นช่องหลักของ |
verified |
เอาต์พุตเท่านั้น เป็นจริงหากช่องได้รับการยืนยันแล้ว เป็นเท็จ หากช่องไม่ได้รับการยืนยัน โดยทั่วไป ช่องที่ได้รับการยืนยันคือชื่อ อีเมล หมายเลขโทรศัพท์ หรือเว็บไซต์ที่ได้รับการยืนยันว่าเป็นของบุคคลนั้น |
source |
แหล่งที่มาของฟิลด์ |
AgeRange
เลิกใช้งานแล้ว (โปรดใช้ person.ageRanges
แทน)
ช่วงอายุของบุคคล
Enum | |
---|---|
AGE_RANGE_UNSPECIFIED |
ไม่ระบุ |
LESS_THAN_EIGHTEEN |
อายุต่ำกว่า 18 ปี |
EIGHTEEN_TO_TWENTY |
ระหว่าง 18 ถึง 20 |
TWENTY_ONE_OR_OLDER |
21 ปีขึ้นไป |
AgeRangeType
ช่วงอายุของบุคคล
การแสดง JSON |
---|
{ "metadata": { object ( |
ช่อง | |
---|---|
metadata |
ข้อมูลเมตาเกี่ยวกับช่วงอายุ |
ageRange |
ช่วงอายุ |
ชีวประวัติ
ประวัติสั้นๆ ของบุคคล
การแสดง JSON |
---|
{ "metadata": { object ( |
ช่อง | |
---|---|
metadata |
ข้อมูลเมตาเกี่ยวกับชีวประวัติ |
value |
ประวัติสั้นๆ |
contentType |
ประเภทเนื้อหาของชีวประวัติ |
ContentType
ประเภทของเนื้อหา
Enum | |
---|---|
CONTENT_TYPE_UNSPECIFIED |
ไม่ระบุ |
TEXT_PLAIN |
ข้อความธรรมดา |
TEXT_HTML |
ข้อความ HTML |
วันเกิด
วันเกิดของบุคคล ระบุช่อง date
และ text
อย่างน้อย 1 ช่อง โดยปกติแล้ว ช่อง date
และ text
จะแสดงวันที่เดียวกัน แต่ไม่รับประกันว่าจะปรากฏ ลูกค้าควรตั้งค่าช่อง date
เสมอเมื่อเปลี่ยนแปลงวันเกิด
การแสดง JSON |
---|
{ "metadata": { object ( |
ช่อง | |
---|---|
metadata |
ข้อมูลเมตาเกี่ยวกับวันเกิด |
date |
วันที่มีโครงสร้างของวันเกิด |
text |
ต้องการใช้ช่อง สตริงรูปแบบอิสระที่แสดงถึงวันเกิดของผู้ใช้ ค่านี้ไม่ได้รับการตรวจสอบ |
วันที่
แสดงวันที่ในปฏิทินทั้งหมดหรือบางส่วน เช่น วันเกิด เวลาของวันและเขตเวลามีการระบุไว้ที่อื่นหรือไม่มีนัยสำคัญ โดยวันที่จะสัมพันธ์กับปฏิทินเกรกอเรียน ซึ่งอาจแสดงถึงข้อใดข้อหนึ่งต่อไปนี้
- วันที่แบบเต็มซึ่งมีค่าปี เดือน และวันที่ไม่ใช่ 0
- เดือนและวัน 1 ปี (เช่น วันครบรอบ)
- ผ่านไป 1 ปี โดยมี 0 เดือนกับ 0 วัน
- ปีและเดือนที่มี 0 วัน (เช่น วันที่หมดอายุของบัตรเครดิต)
ประเภทที่เกี่ยวข้อง:
google.type.TimeOfDay
google.type.DateTime
google.protobuf.Timestamp
การแสดง JSON |
---|
{ "year": integer, "month": integer, "day": integer } |
ช่อง | |
---|---|
year |
ปีของวันที่ ต้องอยู่ระหว่าง 1 ถึง 9999 หรือ 0 เพื่อระบุวันที่โดยไม่มีปี |
month |
เดือนของปี ต้องอยู่ระหว่าง 1 ถึง 12 หรือ 0 เพื่อระบุปีโดยไม่มีเดือนและวัน |
day |
วันของเดือน ต้องอยู่ระหว่าง 1 ถึง 31 และใช้ได้กับปีและเดือน หรือ 0 เพื่อระบุปีเพียงอย่างเดียว หรือปีและเดือนที่วันไม่เป็นนัยสำคัญ |
BraggingRights
เลิกใช้งานแล้ว: จะไม่มีการส่งคืนข้อมูลสิทธิ์โม้ของบุคคล
การแสดง JSON |
---|
{
"metadata": {
object ( |
ช่อง | |
---|---|
metadata |
ข้อมูลเมตาเกี่ยวกับสิทธิ์ในการโม้ |
value |
เรื่องจริงไม่ได้โม้ เช่น |
CalendarUrl
URL ปฏิทินของบุคคล
การแสดง JSON |
---|
{
"metadata": {
object ( |
ช่อง | |
---|---|
metadata |
ข้อมูลเมตาเกี่ยวกับ URL ของปฏิทิน |
url |
URL ของปฏิทิน |
type |
ประเภทของ URL ปฏิทิน โดยสามารถกำหนดเองหรือมีค่าที่กำหนดล่วงหน้าค่าใดค่าหนึ่งต่อไปนี้
|
formattedType |
เอาต์พุตเท่านั้น ประเภทของ URL ปฏิทินที่แปลและจัดรูปแบบในภาษาของบัญชีของผู้ชมหรือภาษาส่วนหัวของ HTTP ของ |
ClientData
ข้อมูลไคลเอ็นต์ที่กําหนดเองซึ่งลูกค้าสร้างขึ้น อนุญาตให้มีคีย์และค่าซ้ำกัน
การแสดง JSON |
---|
{
"metadata": {
object ( |
ช่อง | |
---|---|
metadata |
ข้อมูลเมตาเกี่ยวกับข้อมูลไคลเอ็นต์ |
key |
ไคลเอ็นต์ระบุคีย์ของข้อมูลไคลเอ็นต์ |
value |
ค่าที่ลูกค้าระบุของข้อมูลไคลเอ็นต์ |
CoverPhoto
รูปภาพปกของบุคคล รูปภาพขนาดใหญ่ที่แสดงในหน้าโปรไฟล์ของบุคคลนั้นซึ่งแสดงถึงตัวตนหรือสิ่งที่พวกเขาสนใจ
การแสดง JSON |
---|
{
"metadata": {
object ( |
ช่อง | |
---|---|
metadata |
ข้อมูลเมตาเกี่ยวกับรูปภาพปก |
url |
URL ของรูปภาพปก |
default |
เป็นจริงหากรูปภาพปกเป็นรูปภาพปกเริ่มต้น เป็นเท็จ หากรูปภาพปกเป็นรูปภาพปกที่ผู้ใช้ระบุ |
EmailAddress
อีเมลของบุคคล
การแสดง JSON |
---|
{
"metadata": {
object ( |
ช่อง | |
---|---|
metadata |
ข้อมูลเมตาเกี่ยวกับอีเมล |
value |
อีเมล |
type |
ประเภทของอีเมล โดยสามารถกำหนดเองหรือมีค่าที่กำหนดล่วงหน้าค่าใดค่าหนึ่งต่อไปนี้
|
formattedType |
เอาต์พุตเท่านั้น ประเภทของอีเมลที่แปลและจัดรูปแบบในภาษาของบัญชีของผู้ชมหรือภาษาส่วนหัวของ HTTP ของ |
displayName |
ชื่อที่แสดงของอีเมล |
เหตุการณ์
เหตุการณ์ที่เกี่ยวข้องกับบุคคลดังกล่าว
การแสดง JSON |
---|
{ "metadata": { object ( |
ช่อง | |
---|---|
metadata |
ข้อมูลเมตาเกี่ยวกับเหตุการณ์ |
date |
วันที่เกิดเหตุการณ์ |
type |
ประเภทของกิจกรรม โดยสามารถกำหนดเองหรือมีค่าที่กำหนดล่วงหน้าค่าใดค่าหนึ่งต่อไปนี้
|
formattedType |
เอาต์พุตเท่านั้น ประเภทของเหตุการณ์ที่มีการแปลและจัดรูปแบบในภาษาของบัญชีของผู้ชมหรือภาษาส่วนหัวของ HTTP ของ |
ExternalId
ตัวระบุจากบุคคลภายนอกที่เกี่ยวข้องกับบุคคล
การแสดง JSON |
---|
{
"metadata": {
object ( |
ช่อง | |
---|---|
metadata |
ข้อมูลเมตาเกี่ยวกับรหัสภายนอก |
value |
ค่าของรหัสภายนอก |
type |
ประเภทของรหัสภายนอก โดยสามารถกำหนดเองหรือมีค่าที่กำหนดล่วงหน้าค่าใดค่าหนึ่งต่อไปนี้
|
formattedType |
เอาต์พุตเท่านั้น ประเภทของเหตุการณ์ที่มีการแปลและจัดรูปแบบในภาษาของบัญชีของผู้ชมหรือภาษาส่วนหัวของ HTTP ของ |
FileAs
ชื่อที่ควรใช้ในการจัดเรียงบุคคลในรายชื่อ
การแสดง JSON |
---|
{
"metadata": {
object ( |
ช่อง | |
---|---|
metadata |
ข้อมูลเมตาเกี่ยวกับไฟล์เป็น |
value |
ค่า "เก็บเป็น" |
เพศ
เพศของบุคคล
การแสดง JSON |
---|
{
"metadata": {
object ( |
ช่อง | |
---|---|
metadata |
ข้อมูลเมตาเกี่ยวกับเพศ |
value |
เพศสำหรับบุคคล คุณสามารถกำหนดเพศเองหรือค่าใดค่าหนึ่งต่อไปนี้
|
formattedValue |
เอาต์พุตเท่านั้น ค่าของเพศที่แปลและจัดรูปแบบเป็นภาษาบัญชีของผู้ชมหรือภาษาส่วนหัว HTTP ของ |
addressMeAs |
ช่องข้อความรูปแบบอิสระสำหรับคำสรรพนามที่จะใช้เพื่อกล่าวถึงบุคคล ค่าทั่วไปมีดังนี้
|
ImClient
โปรแกรมรับส่งข้อความโต้ตอบแบบทันทีของบุคคล
การแสดง JSON |
---|
{
"metadata": {
object ( |
ช่อง | |
---|---|
metadata |
ข้อมูลเมตาเกี่ยวกับไคลเอ็นต์ IM |
username |
ชื่อผู้ใช้ที่ใช้ในโปรแกรม IM |
type |
ประเภทของไคลเอ็นต์ IM โดยสามารถกำหนดเองหรือมีค่าที่กำหนดล่วงหน้าค่าใดค่าหนึ่งต่อไปนี้
|
formattedType |
เอาต์พุตเท่านั้น ประเภทของไคลเอ็นต์ IM ที่แปลและจัดรูปแบบในภาษาของบัญชีของผู้ชมหรือภาษาส่วนหัว HTTP ของ |
protocol |
โปรโตคอลของไคลเอ็นต์ IM โปรโตคอลสามารถกำหนดเองหรือมีค่าที่กำหนดไว้ล่วงหน้าค่าใดค่าหนึ่งต่อไปนี้
|
formattedProtocol |
เอาต์พุตเท่านั้น โปรโตคอลของไคลเอ็นต์ IM ที่จัดรูปแบบในภาษาของบัญชีของผู้ชมหรือภาษาส่วนหัว HTTP ของ |
ความสนใจ
ความสนใจของบุคคลคนหนึ่ง
การแสดง JSON |
---|
{
"metadata": {
object ( |
ช่อง | |
---|---|
metadata |
ข้อมูลเมตาเกี่ยวกับความสนใจ |
value |
ความสนใจ เช่น |
ภาษา
ค่ากำหนดภาษาของบุคคล
การแสดง JSON |
---|
{
"metadata": {
object ( |
ช่อง | |
---|---|
metadata |
ข้อมูลเมตาเกี่ยวกับภาษา |
value |
แท็กภาษา IETF BCP 47 ที่มีการจัดรูปแบบอย่างดีที่แสดงถึงภาษาดังกล่าว |
ตำแหน่ง
ตําแหน่งของบุคคล
การแสดง JSON |
---|
{
"metadata": {
object ( |
ช่อง | |
---|---|
metadata |
ข้อมูลเมตาเกี่ยวกับสถานที่ |
value |
ค่ารูปแบบอิสระของสถานที่ตั้ง |
type |
ประเภทของสถานที่ โดยสามารถกำหนดเองหรือมีค่าที่กำหนดล่วงหน้าค่าใดค่าหนึ่งต่อไปนี้
|
current |
สถานที่ตั้งนั้นคือตำแหน่งปัจจุบันหรือไม่ |
buildingId |
ตัวระบุอาคาร |
floor |
ชื่อหรือหมายเลขชั้น |
floorSection |
ส่วนชั้นใน |
deskCode |
ตำแหน่งของโต๊ะทำงานส่วนบุคคล |
การเป็นสมาชิก
การเป็นสมาชิกกลุ่มของบุคคล แก้ไขได้เฉพาะการเป็นสมาชิกกลุ่มของรายชื่อติดต่อเท่านั้น
การแสดง JSON |
---|
{ "metadata": { object ( |
ช่อง | |
---|---|
metadata |
ข้อมูลเมตาเกี่ยวกับการเป็นสมาชิก |
ฟิลด์สหภาพ membership การเป็นสมาชิก membership ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
contactGroupMembership |
การเป็นสมาชิกกลุ่มรายชื่อติดต่อ |
domainMembership |
เอาต์พุตเท่านั้น การเป็นสมาชิกโดเมน |
ContactGroupMembership
การเป็นสมาชิกกลุ่มรายชื่อติดต่อของ Google
การแสดง JSON |
---|
{ "contactGroupId": string, "contactGroupResourceName": string } |
ช่อง | |
---|---|
contactGroupId |
เอาต์พุตเท่านั้น รหัสกลุ่มรายชื่อติดต่อสำหรับการเป็นสมาชิกกลุ่มรายชื่อติดต่อ |
contactGroupResourceName |
ชื่อทรัพยากรสำหรับกลุ่มรายชื่อติดต่อที่เซิร์ฟเวอร์กำหนด สตริง ASCII ในรูปแบบของ |
DomainMembership
การเป็นสมาชิกโดเมน Google Workspace
การแสดง JSON |
---|
{ "inViewerDomain": boolean } |
ช่อง | |
---|---|
inViewerDomain |
เป็นจริงหากบุคคลดังกล่าวอยู่ในโดเมน Google Workspace ของผู้ชม |
MiscKeyword
คีย์เวิร์ดเบ็ดเตล็ดของบุคคล
การแสดง JSON |
---|
{ "metadata": { object ( |
ช่อง | |
---|---|
metadata |
ข้อมูลเมตาเกี่ยวกับคีย์เวิร์ดเบ็ดเตล็ด |
value |
มูลค่าของคีย์เวิร์ดเบ็ดเตล็ด |
type |
ประเภทคีย์เวิร์ดเบ็ดเตล็ด |
formattedType |
เอาต์พุตเท่านั้น ประเภทคีย์เวิร์ดเบ็ดเตล็ดที่มีการแปลและจัดรูปแบบในภาษาของบัญชีของผู้ชมหรือภาษาส่วนหัว HTTP ของ |
KeywordType
ประเภทคีย์เวิร์ดเบ็ดเตล็ด
Enum | |
---|---|
TYPE_UNSPECIFIED |
ไม่ระบุ |
OUTLOOK_BILLING_INFORMATION |
ฟิลด์ Outlook สำหรับข้อมูลการเรียกเก็บเงิน |
OUTLOOK_DIRECTORY_SERVER |
ฟิลด์ Outlook สำหรับเซิร์ฟเวอร์ไดเรกทอรี |
OUTLOOK_KEYWORD |
ช่อง Outlook สำหรับคีย์เวิร์ด |
OUTLOOK_MILEAGE |
ฟิลด์ Outlook สำหรับระยะทาง |
OUTLOOK_PRIORITY |
Outlook สำหรับลำดับความสำคัญ |
OUTLOOK_SENSITIVITY |
ฟิลด์ Outlook สำหรับความละเอียดอ่อน |
OUTLOOK_SUBJECT |
ช่อง Outlook สำหรับเรื่อง |
OUTLOOK_USER |
ช่อง Outlook สำหรับผู้ใช้ |
HOME |
บ้าน |
WORK |
งาน |
OTHER |
อื่นๆ |
ชื่อ
ชื่อบุคคล หากชื่อเป็นคำเดี่ยว ชื่อครอบครัวจะว่างเปล่า
การแสดง JSON |
---|
{
"metadata": {
object ( |
ช่อง | |
---|---|
metadata |
ข้อมูลเมตาเกี่ยวกับชื่อ |
displayName |
เอาต์พุตเท่านั้น ชื่อที่แสดงจะจัดรูปแบบตามภาษาที่บัญชีของผู้ดูระบุหรือส่วนหัว HTTP ของ |
displayNameLastFirst |
เอาต์พุตเท่านั้น ชื่อที่แสดงพร้อมนามสกุลจะจัดรูปแบบตามภาษาที่ระบุโดยบัญชีของผู้ดูหรือส่วนหัว HTTP ของ |
unstructuredName |
ค่าชื่อรูปแบบอิสระ |
familyName |
นามสกุล |
givenName |
ชื่อจริง |
middleName |
ชื่อกลาง |
honorificPrefix |
คำนำหน้าที่เหมาะสม เช่น |
honorificSuffix |
คำต่อท้ายที่ปรากฏ เช่น |
phoneticFullName |
ชื่อและนามสกุลสะกดตามการออกเสียง |
phoneticFamilyName |
นามสกุลสะกดตามการออกเสียง |
phoneticGivenName |
ชื่อที่สะกดตามการออกเสียง |
phoneticMiddleName |
ชื่อกลางสะกดตามการออกเสียง |
phoneticHonorificPrefix |
คำนำหน้าที่น่าจดจำสะกดตามการออกเสียง |
phoneticHonorificSuffix |
คำเสริมท้ายที่เป็นเกียรติคุณสะกดตามการออกเสียง |
ชื่อเล่น
ชื่อเล่นของบุคคล
การแสดง JSON |
---|
{ "metadata": { object ( |
ช่อง | |
---|---|
metadata |
ข้อมูลเมตาเกี่ยวกับชื่อเล่น |
value |
ชื่อเล่น |
type |
ประเภทของชื่อเล่น |
NicknameType
ประเภทของชื่อเล่น
Enum | |
---|---|
DEFAULT |
ชื่อเล่นทั่วไป |
MAIDEN_NAME |
นามสกุลเดิมหรือนามสกุลกำเนิด ใช้เมื่อนามสกุลของบุคคลนั้นมีการเปลี่ยนแปลงอันเป็นผลจากการแต่งงาน |
INITIALS |
ชื่อย่อ |
GPLUS |
ชื่อเล่นของโปรไฟล์ Google+ |
OTHER_NAME |
ความเกี่ยวข้องทางวิชาชีพหรือชื่ออื่น เช่น |
ALTERNATE_NAME |
ชื่อสำรองคือบุคคลที่เรารู้จัก |
SHORT_NAME |
ชื่อที่สั้นกว่าของชื่อบุคคล |
อาชีพ
อาชีพของบุคคล
การแสดง JSON |
---|
{
"metadata": {
object ( |
ช่อง | |
---|---|
metadata |
ข้อมูลเมตาเกี่ยวกับอาชีพ |
value |
อาชีพ เช่น |
องค์กร
องค์กรในอดีตหรือองค์กรปัจจุบันของบุคคล อนุญาตให้มีช่วงวันที่ซ้อนทับกัน
การแสดง JSON |
---|
{ "metadata": { object ( |
ช่อง | |
---|---|
metadata |
ข้อมูลเมตาเกี่ยวกับองค์กร |
type |
ประเภทขององค์กร โดยสามารถกำหนดเองหรือมีค่าที่กำหนดล่วงหน้าค่าใดค่าหนึ่งต่อไปนี้
|
formattedType |
เอาต์พุตเท่านั้น ประเภทขององค์กรที่แปลและจัดรูปแบบในภาษาของบัญชีของผู้ชมหรือภาษาส่วนหัวของ HTTP ของ |
startDate |
วันที่เริ่มต้นที่บุคคลนั้นเข้าร่วมองค์กร |
endDate |
วันที่สิ้นสุดที่บุคคลนั้นออกจากองค์กร |
current |
เป็นจริงหากองค์กรเป็นองค์กรปัจจุบันของผู้ใช้ เท็จหากองค์กรเป็นองค์กรในอดีต |
name |
ชื่อขององค์กร |
phoneticName |
คำอ่านชื่อองค์กร |
department |
แผนกของบุคคลในองค์กร |
title |
ตำแหน่งงานของบุคคลนั้นในองค์กร |
jobDescription |
คําบรรยายลักษณะงานของบุคคลในองค์กร |
symbol |
สัญลักษณ์ที่เกี่ยวข้องกับองค์กร เช่น สัญลักษณ์หุ้น ตัวย่อ หรือคำย่อ |
domain |
ชื่อโดเมนที่เชื่อมโยงกับองค์กร เช่น |
location |
สถานที่ตั้งของสำนักงานขององค์กรที่ผู้ใช้ทำงานอยู่ |
costCenter |
ศูนย์ต้นทุนของบุคคลในองค์กร |
fullTimeEquivalentMillipercent |
เทียบเท่ากับเต็มเวลาของบุคคลในองค์กร (100,000 = 100%) |
PhoneNumber
หมายเลขโทรศัพท์ของบุคคล
การแสดง JSON |
---|
{
"metadata": {
object ( |
ช่อง | |
---|---|
metadata |
ข้อมูลเมตาเกี่ยวกับหมายเลขโทรศัพท์ |
value |
หมายเลขโทรศัพท์ |
canonicalForm |
เอาต์พุตเท่านั้น หมายเลขโทรศัพท์ในรูปแบบ ITU-T E.164 ที่กำหนดหน้าแล้ว |
type |
ประเภทของหมายเลขโทรศัพท์ โดยสามารถกำหนดเองหรือมีค่าที่กำหนดล่วงหน้าค่าใดค่าหนึ่งต่อไปนี้
|
formattedType |
เอาต์พุตเท่านั้น ประเภทหมายเลขโทรศัพท์ที่แปลและจัดรูปแบบในภาษาของบัญชีของผู้ชมหรือภาษาส่วนหัวของ HTTP ของ |
รูปภาพ
รูปภาพของบุคคล รูปภาพที่แสดงข้างชื่อบุคคลนั้นเพื่อช่วยให้ผู้อื่นจดจำบุคคลนั้นได้
การแสดง JSON |
---|
{
"metadata": {
object ( |
ช่อง | |
---|---|
metadata |
ข้อมูลเมตาเกี่ยวกับรูปภาพ |
url |
URL ของรูปภาพ คุณเปลี่ยนขนาดที่ต้องการได้โดยเพิ่มพารามิเตอร์การค้นหา |
default |
"จริง" หากรูปภาพเป็นรูปภาพเริ่มต้น "เท็จ" หากรูปภาพนั้นเป็นรูปภาพที่ผู้ใช้ให้ไว้ |
ความสัมพันธ์
ความเกี่ยวข้องของบุคคลหนึ่งๆ กับบุคคลอื่น
การแสดง JSON |
---|
{
"metadata": {
object ( |
ช่อง | |
---|---|
metadata |
ข้อมูลเมตาเกี่ยวกับความสัมพันธ์ |
person |
ชื่อของบุคคลอื่นที่ความสัมพันธ์นี้อ้างถึง |
type |
ความสัมพันธ์ของบุคคลนั้นกับอีกฝ่าย โดยสามารถกำหนดเองหรือมีค่าที่กำหนดล่วงหน้าค่าใดค่าหนึ่งต่อไปนี้
|
formattedType |
เอาต์พุตเท่านั้น ประเภทของความสัมพันธ์ที่แปลและจัดรูปแบบในภาษาของบัญชีของผู้ชมหรือภาษาที่ระบุในส่วนหัว HTTP ที่ยอมรับ |
RelationshipInterest
เลิกใช้งานแล้ว: ระบบจะไม่แสดงผลข้อมูลความสนใจด้านความสัมพันธ์ของบุคคล
การแสดง JSON |
---|
{
"metadata": {
object ( |
ช่อง | |
---|---|
metadata |
ข้อมูลเมตาเกี่ยวกับความสนใจในความสัมพันธ์ |
value |
ความสัมพันธ์แบบที่บุคคลนั้นกำลังมองหา ค่าสามารถกำหนดเองหรือค่าใดค่าหนึ่งที่กำหนดไว้ล่วงหน้าต่อไปนี้
|
formattedValue |
เอาต์พุตเท่านั้น ค่าของความสนใจความสัมพันธ์จะแปลและจัดรูปแบบเป็นภาษาบัญชีของผู้ชมหรือภาษาที่ระบุในส่วนหัว HTTP ที่ยอมรับได้ |
RelationshipStatus
เลิกใช้งานแล้ว: ระบบจะไม่แสดงผลสถานะความสัมพันธ์ของบุคคล
การแสดง JSON |
---|
{
"metadata": {
object ( |
ช่อง | |
---|---|
metadata |
ข้อมูลเมตาเกี่ยวกับสถานะความสัมพันธ์ |
value |
สถานะความสัมพันธ์ ค่าสามารถกำหนดเองหรือค่าใดค่าหนึ่งที่กำหนดไว้ล่วงหน้าต่อไปนี้
|
formattedValue |
เอาต์พุตเท่านั้น ค่าของสถานะความสัมพันธ์ที่แปลและจัดรูปแบบเป็นภาษาของบัญชีของผู้ชมหรือภาษาส่วนหัว HTTP ของ |
ที่พัก
เลิกใช้งานแล้ว: โปรดใช้ person.locations
แทน ที่อยู่ในอดีตหรือปัจจุบันของบุคคล
การแสดง JSON |
---|
{
"metadata": {
object ( |
ช่อง | |
---|---|
metadata |
ข้อมูลเมตาเกี่ยวกับที่พักอาศัย |
value |
ที่อยู่ของที่พักอาศัย |
current |
จริงหากผู้พำนักอาศัยเป็นที่พำนักปัจจุบันของบุคคลนั้น เท็จหากเป็นที่อยู่อาศัยที่ผ่านมาแล้ว |
SipAddress
ที่อยู่ SIP ของบุคคล ที่อยู่โปรโตคอลเริ่มต้นของเซสชันใช้สำหรับการสื่อสาร VoIP เพื่อโทรด้วยเสียงหรือวิดีโอคอลผ่านอินเทอร์เน็ต
การแสดง JSON |
---|
{
"metadata": {
object ( |
ช่อง | |
---|---|
metadata |
ข้อมูลเมตาเกี่ยวกับที่อยู่ SIP |
value |
ที่อยู่ SIP ในรูปแบบ URI ของ SIP RFC 3261 19.1 |
type |
ประเภทของที่อยู่ SIP ประเภทอาจเป็นแบบกำหนดเองหรือค่าใดค่าหนึ่งที่กำหนดไว้ล่วงหน้าต่อไปนี้
|
formattedType |
เอาต์พุตเท่านั้น ประเภทของที่อยู่ SIP ที่แปลและจัดรูปแบบในภาษาของบัญชีของผู้ชมหรือภาษาส่วนหัว HTTP ของ |
ทักษะ
ทักษะที่บุคคลนั้นมี
การแสดง JSON |
---|
{
"metadata": {
object ( |
ช่อง | |
---|---|
metadata |
ข้อมูลเมตาเกี่ยวกับทักษะ |
value |
ทักษะ เช่น |
แท็กไลน์
เลิกใช้งานแล้ว: ระบบจะไม่แสดงผลข้อมูล คำอธิบายสั้นๆ บรรทัดเดียวของบุคคลดังกล่าว
การแสดง JSON |
---|
{
"metadata": {
object ( |
ช่อง | |
---|---|
metadata |
ข้อมูลเมตาเกี่ยวกับแท็กไลน์ |
value |
แท็กไลน์ |
URL
URL ที่เชื่อมโยงของบุคคล
การแสดง JSON |
---|
{
"metadata": {
object ( |
ช่อง | |
---|---|
metadata |
ข้อมูลเมตาเกี่ยวกับ URL |
value |
URL |
type |
ประเภทของ URL โดยสามารถกำหนดเองหรือมีค่าที่กำหนดล่วงหน้าค่าใดค่าหนึ่งต่อไปนี้
|
formattedType |
เอาต์พุตเท่านั้น ประเภทของ URL ที่แปลและจัดรูปแบบในภาษาของบัญชีของผู้ชมหรือภาษาส่วนหัวของ HTTP ของ |
UserDefined
ข้อมูลผู้ใช้ที่กำหนดเองซึ่งสร้างขึ้นโดยผู้ใช้ปลายทาง
การแสดง JSON |
---|
{
"metadata": {
object ( |
ช่อง | |
---|---|
metadata |
ข้อมูลเมตาเกี่ยวกับข้อมูลที่ผู้ใช้กำหนด |
key |
คีย์ที่ผู้ใช้ปลายทางระบุสำหรับข้อมูลที่กำหนดโดยผู้ใช้ |
value |
ค่าที่ผู้ใช้ระบุของข้อมูลที่กำหนดโดยผู้ใช้ |
วิธีการ |
|
---|---|
|
สร้างกลุ่มรายชื่อติดต่อใหม่ และส่งกลับ PersonResponses สำหรับรายการใหม่ ควรส่งคำขอเปลี่ยนแปลงคำขอสำหรับผู้ใช้รายเดียวกันตามลำดับเพื่อหลีกเลี่ยงเวลาในการตอบสนองและความล้มเหลวที่เพิ่มขึ้น |
|
ลบกลุ่มรายชื่อติดต่อ |
|
อัปเดตกลุ่มรายชื่อติดต่อแล้วส่งกลับแผนที่ของชื่อทรัพยากรไปยัง PersonResponses สำหรับรายชื่อติดต่อที่อัปเดต |
|
สร้างรายชื่อติดต่อใหม่และส่งคืนทรัพยากรบุคคลสำหรับรายชื่อติดต่อนั้น |
|
ลบผู้ติดต่อ |
|
ลบรูปภาพของรายชื่อติดต่อ |
|
ให้ข้อมูลเกี่ยวกับบุคคลโดยระบุชื่อทรัพยากร |
|
ให้ข้อมูลเกี่ยวกับรายชื่อบุคคลที่ระบุ โดยระบุรายชื่อทรัพยากรที่ขอ |
|
ระบุรายการโปรไฟล์ของโดเมนและรายชื่อติดต่อของโดเมนในไดเรกทอรีโดเมนของผู้ใช้ที่ผ่านการตรวจสอบสิทธิ์ |
|
ระบุรายชื่อติดต่อในรายชื่อติดต่อในกลุ่มของผู้ใช้ที่ตรวจสอบสิทธิ์แล้วซึ่งตรงกับคำค้นหา |
|
ระบุรายการโปรไฟล์ของโดเมนและรายชื่อติดต่อของโดเมนในไดเรกทอรีโดเมนของผู้ใช้ที่ผ่านการตรวจสอบสิทธิ์แล้วซึ่งตรงกับคำค้นหา |
|
อัปเดตข้อมูลรายชื่อติดต่อของบุคคลที่ติดต่อที่มีอยู่ |
|
อัปเดตรูปภาพของรายชื่อติดต่อ |