- แหล่งข้อมูล: บุคคล
- การแสดง 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
- เมธอด
แหล่งข้อมูล: บุคคล
ข้อมูลเกี่ยวกับบุคคลที่ผสานรวมจากแหล่งข้อมูลต่างๆ เช่น รายชื่อติดต่อและข้อมูลโปรไฟล์ของผู้ใช้ที่ผ่านการตรวจสอบสิทธิ์
ช่องส่วนใหญ่มีได้หลายรายการ รายการในฟิลด์ไม่มีคำสั่งซื้อที่รับประกัน แต่จะรับประกันว่าฟิลด์ที่ไม่ว่างเปล่าจะมีฟิลด์ที่ตั้งค่า metadata.primary
เป็นจริง 1 ฟิลด์เท่านั้น
การแสดง JSON |
---|
{ "resourceName": string, "etag": string, "metadata": { object ( |
ช่อง | |
---|---|
resourceName |
ชื่อทรัพยากรสำหรับบุคคลนั้น ซึ่งกำหนดโดยเซิร์ฟเวอร์ สตริง ASCII ในรูปแบบ |
etag |
แท็กเอนทิตี HTTP ของทรัพยากร ใช้สําหรับการตรวจสอบเว็บแคช |
metadata |
เอาต์พุตเท่านั้น ข้อมูลเมตาเกี่ยวกับบุคคล |
addresses[] |
ที่อยู่ของบุคคลนั้น |
ageRange |
เอาต์พุตเท่านั้น เลิกใช้งานแล้ว (โปรดใช้ ช่วงอายุของบุคคลนั้น |
ageRanges[] |
เอาต์พุตเท่านั้น ช่วงอายุของบุคคลนั้น |
biographies[] |
ชีวประวัติของบุคคลนั้น ฟิลด์นี้เป็นฟิลด์เดี่ยวสําหรับแหล่งที่มาของรายชื่อติดต่อ |
birthdays[] |
วันเกิดของบุคคลนั้น ฟิลด์นี้เป็นฟิลด์เดี่ยวสําหรับแหล่งที่มาของรายชื่อติดต่อ |
braggingRights[] |
เลิกใช้งานแล้ว: จะไม่มีการแสดงข้อมูลที่บุคคลดังกล่าวจะคุยโม้อยู่ได้ |
calendarUrls[] |
URL ปฏิทินของบุคคลนั้น |
clientData[] |
ข้อมูลลูกค้าของบุคคลนั้น |
coverPhotos[] |
เอาต์พุตเท่านั้น รูปภาพปกของบุคคล |
emailAddresses[] |
อีเมลของบุคคลนั้น สำหรับ |
events[] |
เหตุการณ์ของบุคคลนั้น |
externalIds[] |
รหัสภายนอกของบุคคลนั้น |
fileAses[] |
ชื่อไฟล์ของบุคคลดังกล่าว |
genders[] |
เพศของบุคคลนั้น ฟิลด์นี้เป็นฟิลด์เดี่ยวสําหรับแหล่งที่มาของรายชื่อติดต่อ |
imClients[] |
โปรแกรมรับส่งข้อความโต้ตอบแบบทันทีของบุคคลนั้น |
interests[] |
ความสนใจของบุคคลนั้น |
locales[] |
ค่ากำหนดภาษาของบุคคล |
locations[] |
ตำแหน่งของบุคคลนั้น |
memberships[] |
การเป็นสมาชิกกลุ่มของบุคคลนั้น |
miscKeywords[] |
คีย์เวิร์ดเบ็ดเตล็ดของบุคคลนั้น |
names[] |
ชื่อบุคคล ฟิลด์นี้เป็นฟิลด์เดี่ยวสําหรับแหล่งที่มาของรายชื่อติดต่อ |
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 |
ที่อยู่
ที่อยู่จริงของบุคคล อาจเป็น P.O กล่องหรือที่อยู่ถนน ไม่จำเป็นต้องกรอกข้อมูลครบทุกช่อง
การแสดง JSON |
---|
{
"metadata": {
object ( |
ช่อง | |
---|---|
metadata |
ข้อมูลเมตาเกี่ยวกับที่อยู่ |
formattedValue |
ค่าที่ไม่มีโครงสร้างของที่อยู่ หากผู้ใช้ไม่ได้ตั้งค่าไว้ ระบบจะสร้างการตั้งค่าจากค่าที่มีโครงสร้างโดยอัตโนมัติ |
type |
ประเภทของที่อยู่ คุณสามารถกำหนดประเภทเองหรือกำหนดค่าล่วงหน้าค่าใดค่าหนึ่งต่อไปนี้
|
formattedType |
เอาต์พุตเท่านั้น ประเภทของที่อยู่ที่แปลและจัดรูปแบบในภาษาของบัญชีหรือภาษาของส่วนหัว HTTP |
poBox |
ตู้ ป.ณ. (P.O.) ของที่อยู่ |
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 |
เอาต์พุตเท่านั้น เป็นจริงหากยืนยันช่องนี้แล้ว false หากช่องนี้ไม่ได้รับการยืนยัน โดยปกติ ฟิลด์ที่ยืนยันแล้วคือชื่อ อีเมล หมายเลขโทรศัพท์ หรือเว็บไซต์ที่ได้รับการยืนยันว่าเป็นของบุคคลนั้น |
source |
แหล่งที่มาของช่อง |
ช่วงอายุ
เลิกใช้งานแล้ว (โปรดใช้ 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 เดือนและวัน โดยมี 0 ปี (เช่น วันครบรอบ)
- ปีหนึ่งๆ มี 0 เดือนและมี 0 วัน
- 1 ปีและเดือน โดยมี 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 เพื่อระบุปีเพียงอย่างเดียว หรือ 1 ปีและเดือนที่วันไม่มีนัยสำคัญ |
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 |
ค่า "File-as" |
เพศ
เพศของบุคคล
การแสดง 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%) |
หมายเลขโทรศัพท์
หมายเลขโทรศัพท์ของบุคคล
การแสดง JSON |
---|
{
"metadata": {
object ( |
ช่อง | |
---|---|
metadata |
ข้อมูลเมตาเกี่ยวกับหมายเลขโทรศัพท์ |
value |
หมายเลขโทรศัพท์ |
canonicalForm |
เอาต์พุตเท่านั้น รูปแบบ ITU-T E.164 ที่กำหนดเป็น Canonical ของหมายเลขโทรศัพท์ |
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 สำหรับรายชื่อติดต่อที่อัปเดตแล้ว |
|
สร้างผู้ติดต่อใหม่และส่งคืนทรัพยากรบุคคลสำหรับผู้ติดต่อนั้น |
|
ลบผู้ติดต่อ |
|
ลบรูปภาพของรายชื่อติดต่อ |
|
ให้ข้อมูลเกี่ยวกับบุคคลด้วยการระบุชื่อทรัพยากร |
|
ให้ข้อมูลเกี่ยวกับรายชื่อบุคคลที่ระบุโดยระบุชื่อทรัพยากรที่ขอ |
|
แสดงรายการโปรไฟล์ของโดเมนและรายชื่อติดต่อของโดเมนในไดเรกทอรีโดเมนของผู้ใช้ที่ผ่านการตรวจสอบสิทธิ์ |
|
ระบุรายชื่อติดต่อในรายชื่อติดต่อที่จัดกลุ่มไว้ของผู้ใช้ที่ผ่านการตรวจสอบสิทธิ์ซึ่งตรงกับคำค้นหา |
|
ระบุรายการโปรไฟล์ของโดเมนและรายชื่อติดต่อของโดเมนในไดเรกทอรีโดเมนของผู้ใช้ที่ผ่านการตรวจสอบสิทธิ์ซึ่งตรงกับคำค้นหา |
|
อัปเดตข้อมูลรายชื่อติดต่อสำหรับผู้ติดต่อที่มีอยู่ |
|
อัปเดตรูปภาพของรายชื่อติดต่อ |