- משאב: אדם
- ייצוג 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
מוגדר כ-true.
ייצוג 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[] |
שמות הקבצים של האדם. |
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 |
פלט בלבד. True אם המשאב של המשתמש נמחק. השדה הזה מאוכלס רק עבור בקשות סנכרון |
objectType |
פלט בלבד. הוצא משימוש (יש להשתמש ב- סוג האובייקט של האדם. |
מקור
המקור של השדה.
ייצוג JSON |
---|
{ "type": enum ( |
שדות | |
---|---|
type |
סוג המקור. |
id |
המזהה הייחודי בתוך סוג המקור שנוצר על ידי השרת. |
etag |
מאוכלס רק ב תג ישות ה-HTTP של המקור. משמש לאימות מטמון אינטרנט. |
updateTime |
פלט בלבד. מאוכלס רק ב חותמת הזמן של העדכון האחרון של המקור הזה. חותמת זמן בפורמט "זולו" RFC3339 UTC, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: |
שדה איחוד מטא-נתונים על המקור. |
|
profileMetadata |
פלט בלבד. מאוכלס רק ב מטא נתונים על מקור מסוג PROFILE. |
SourceType
סוג המקור.
טיפוסים בני מנייה (enums) | |
---|---|
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
סוג האובייקט של אדם.
טיפוסים בני מנייה (enums) | |
---|---|
OBJECT_TYPE_UNSPECIFIED |
לא צוין. |
PERSON |
אדם. |
PAGE |
הדף 'Currents'. |
UserType
סוג המשתמש.
טיפוסים בני מנייה (enums) | |
---|---|
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 |
האזור של הכתובת. לדוגמה: מדינה (State) או מחוז. |
postalCode |
המיקוד של הכתובת. |
country |
המדינה שבה נמצאת הכתובת. |
countryCode |
קוד המדינה של הכתובת בפורמט ISO 3166-1 alpha-2. |
FieldMetadata
מטא-נתונים על שדה.
ייצוג JSON |
---|
{
"primary": boolean,
"sourcePrimary": boolean,
"verified": boolean,
"source": {
object ( |
שדות | |
---|---|
primary |
פלט בלבד. True אם השדה הוא השדה הראשי לכל המקורות של אותו אדם. לכל משתמש יהיה שדה אחד לכל היותר שבו |
sourcePrimary |
הערך הוא True אם השדה הוא השדה הראשי עבור |
verified |
פלט בלבד. True אם השדה מאומת, FALSE אם השדה לא מאומת. שדה מאומת הוא בדרך כלל שם, כתובת אימייל, מספר טלפון או אתר שאושרו על ידי אותו אדם. |
source |
מקור השדה. |
AgeRange
הוצא משימוש (יש להשתמש ב-person.ageRanges
במקום)
טווח גילאים של אדם.
טיפוסים בני מנייה (enums) | |
---|---|
AGE_RANGE_UNSPECIFIED |
לא צוין. |
LESS_THAN_EIGHTEEN |
מתחת לגיל 18. |
EIGHTEEN_TO_TWENTY |
בין 18 לעשרים. |
TWENTY_ONE_OR_OLDER |
עשרים ואחת ומעלה. |
AgeRangeType
טווח הגילאים של המשתמש.
ייצוג JSON |
---|
{ "metadata": { object ( |
שדות | |
---|---|
metadata |
מטא-נתונים על טווח הגילאים. |
ageRange |
טווח הגילאים. |
ביוגרפיה
ביוגרפיה קצרה של אדם.
ייצוג JSON |
---|
{ "metadata": { object ( |
שדות | |
---|---|
metadata |
מטא-נתונים על הביוגרפיה. |
value |
הביוגרפיה הקצרה. |
contentType |
סוג התוכן של הביוגרפיה. |
ContentType
סוג התוכן.
טיפוסים בני מנייה (enums) | |
---|---|
CONTENT_TYPE_UNSPECIFIED |
לא צוין. |
TEXT_PLAIN |
טקסט פשוט. |
TEXT_HTML |
טקסט HTML. |
יום הולדת
תאריך לידה של אדם. ציינת לפחות אחד מהשדות date
ו-text
. השדות date
ו-text
בדרך כלל מייצגים את אותו תאריך, אבל הם לא מובטחים. לקוחות צריכים תמיד להגדיר את השדה date
בעת שינוי ימי הולדת.
ייצוג JSON |
---|
{ "metadata": { object ( |
שדות | |
---|---|
metadata |
מטא-נתונים על יום ההולדת. |
date |
התאריך המובנה של יום ההולדת. |
text |
יש העדפה להשתמש בשדה מחרוזת בפורמט חופשי שמייצגת את יום ההולדת של המשתמש. הערך הזה לא אומת. |
תאריך
מייצג תאריך קלנדרי שלם או חלקי, כמו יום הולדת. השעה ביום ואזור הזמן מצוינים במקום אחר או שאינם משמעותיים. התאריך הזה יחסי ללוח השנה הגרגוריאני. הערך הזה יכול לייצג את אחת מהאפשרויות הבאות:
- תאריך מלא, עם ערכים שאינם אפס שנה, חודש ויום.
- חודש ויום, עם שנת אפס (למשל יום נישואין).
- שנה בפני עצמה, עם חודש של אפס ויום אפס.
- שנה וחודש, עם אפס יום (לדוגמה, תאריך תפוגת התוקף של כרטיס האשראי).
סוגים קשורים:
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 |
יש לציין True אם תמונת השער היא תמונת השער המוגדרת כברירת מחדל. False אם תמונת השער היא תמונת השער שסופקה על ידי המשתמש. |
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 |
שם המשתמש בלקוח ההודעות המיידיות. |
type |
הסוג של לקוח ההודעה המיידית. הסוג יכול להיות מותאם אישית או אחד מהערכים המוגדרים מראש הבאים:
|
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 |
True אם המשתמש נמצא בדומיין Google Workspace של הצופה. |
MiscKeyword
מילות מפתח שונות של משתמש.
ייצוג JSON |
---|
{ "metadata": { object ( |
שדות | |
---|---|
metadata |
מטא-נתונים על מילת המפתח השונות. |
value |
הערך של מילות המפתח השונות. |
type |
הסוג של מילות המפתח השונות. |
formattedType |
פלט בלבד. הסוג של מילות המפתח השונות שמתורגמות ומפורמטות בלוקאל של החשבון של הצופה או בלוקאל של כותרת ה-HTTP |
KeywordType
הסוג של מילות המפתח השונות.
טיפוסים בני מנייה (enums) | |
---|---|
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
סוג הכינוי.
טיפוסים בני מנייה (enums) | |
---|---|
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 |
True אם הארגון הוא הארגון הנוכחי של האדם. FALSE אם הארגון הוא ארגון קודם. |
name |
שם הארגון. |
phoneticName |
השם הפונטי של הארגון. |
department |
המחלקה של האדם בארגון. |
title |
התפקיד של האדם בארגון. |
jobDescription |
תיאור התפקיד של האדם בארגון. |
symbol |
הסמל שמשויך לארגון. לדוגמה, סמל מניה, קיצור או ראשי תיבות. |
domain |
שם הדומיין המשויך לארגון. לדוגמה, |
location |
מיקום המשרד של הארגון שבו האדם עובד. |
costCenter |
מרכז העלויות של האדם בארגון. |
fullTimeEquivalentMillipercent |
מספר האחוזים המקביל של אדם במשרה מלאה בארגון (100000 = 100%). |
PhoneNumber
מספר טלפון של אדם כלשהו.
ייצוג JSON |
---|
{
"metadata": {
object ( |
שדות | |
---|---|
metadata |
מטא-נתונים על מספר הטלפון. |
value |
מספר הטלפון. |
canonicalForm |
פלט בלבד. הגרסה הקנונית של מספר הטלפון מסוג ITU-T E.164. |
type |
הסוג של מספר הטלפון. הסוג יכול להיות מותאם אישית או אחד מהערכים המוגדרים מראש הבאים:
|
formattedType |
פלט בלבד. הסוג של מספר הטלפון שמתורגם ומפורמט בלוקאל של החשבון של הצופה או בלוקאל של כותרת ה-HTTP |
תמונה
תמונה של אדם כלשהו. תמונה שמוצגת ליד השם של האדם כדי לעזור לאחרים לזהות אותו.
ייצוג JSON |
---|
{
"metadata": {
object ( |
שדות | |
---|---|
metadata |
מטא-נתונים על התמונה. |
url |
כתובת האתר של התמונה. כדי לשנות את הגודל הרצוי, מוסיפים פרמטר שאילתה |
default |
יש לציין True אם התמונה היא תמונת ברירת מחדל. false אם התמונה היא תמונה שסופקו על ידי המשתמש. |
קשר
הקשר של אדם לאדם אחר.
ייצוג JSON |
---|
{
"metadata": {
object ( |
שדות | |
---|---|
metadata |
מטא-נתונים על הקשר. |
person |
שם האדם האחר שאליו מתייחס הקשר הזה. |
type |
הקשר של האדם לאדם האחר. הסוג יכול להיות מותאם אישית או אחד מהערכים המוגדרים מראש הבאים:
|
formattedType |
פלט בלבד. סוג הקשר שמתורגם ומפורמט בלוקאל של החשבון של הצופה או בלוקאל שצוין בכותרת Accept-Language. |
RelationshipInterest
הוצא משימוש: לא יוחזרו נתונים על מידת העניין של האדם במערכת יחסים .
ייצוג JSON |
---|
{
"metadata": {
object ( |
שדות | |
---|---|
metadata |
מטא-נתונים על תחום העניין של הקשר. |
value |
סוג הקשרים שהאדם מחפש. הערך יכול להיות מותאם אישית או אחד מהערכים המוגדרים מראש הבאים:
|
formattedValue |
פלט בלבד. הערך של קשר הגומלין המתורגם ומעוצב באזור החשבון של הצופה או בלוקאל שצוין בכותרת Accept-Language. |
RelationshipStatus
הוצא משימוש: לא יוחזרו נתונים של סטטוס הקשר של המשתמש.
ייצוג JSON |
---|
{
"metadata": {
object ( |
שדות | |
---|---|
metadata |
מטא-נתונים על סטטוס הקשר. |
value |
סטטוס הקשר. הערך יכול להיות מותאם אישית או אחד מהערכים המוגדרים מראש הבאים:
|
formattedValue |
פלט בלבד. הערך של סטטוס הקשר המתורגם והמפורמט בלוקאל של החשבון של הצופה או בלוקאל של כותרת ה-HTTP |
מקום מגורים
הוצא משימוש: במקומם יש להשתמש ב-person.locations
. מקום המגורים בעבר או במקום המגורים הנוכחי של אדם.
ייצוג JSON |
---|
{
"metadata": {
object ( |
שדות | |
---|---|
metadata |
מטא-נתונים על הבית. |
value |
כתובת המגורים. |
current |
True אם הבית הוא מקום המגורים הנוכחי של האדם; FALSE אם הבית הוא מקום המגורים הקודם. |
SipAddress
כתובת ה-SIP של מישהו. כתובות הפרוטוקול ההתחלתיות של הסשן משמשות לתקשורת VoIP כדי לבצע שיחות קוליות או שיחות וידאו באינטרנט.
ייצוג JSON |
---|
{
"metadata": {
object ( |
שדות | |
---|---|
metadata |
מטא-נתונים על כתובת ה-SIP. |
value |
כתובת ה-SIP בפורמט RFC 3261 19.1 SIP URI. |
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 עבור אנשי הקשר המעודכנים. |
|
יוצרים איש קשר חדש ומחזירים את המשאב של אותו איש קשר. |
|
מחיקת איש קשר. |
|
מחיקת תמונה של איש קשר. |
|
מספק מידע על אדם על ידי ציון שם המשאב. |
|
מספק מידע על רשימה של אנשים ספציפיים על ידי ציון רשימה של שמות המשאבים המבוקשים. |
|
מספק רשימה של פרופילים בדומיין ואנשי קשר בדומיין בספריית הדומיין של המשתמש המאומת. |
|
מספק רשימה של אנשי קשר בקבוצות של אנשי הקשר של המשתמש המאומת אשר תואמים לשאילתת החיפוש. |
|
מספק רשימה של פרופילים בדומיין ואנשי קשר מהדומיין של המשתמש המאומת בספריית הדומיין של המשתמש המאומת. |
|
עדכון נתוני איש קשר של איש קשר קיים. |
|
עדכון תמונה של איש קשר. |