REST Resource: people

משאב: אדם

מידע על אדם ממוזג ממקורות נתונים שונים, כמו אנשי הקשר ונתוני הפרופיל של המשתמש המאומת.

ברוב השדות יכולים להיות כמה פריטים. לפריטים בשדה אין סדר מובטח, אבל כל שדה שאינו ריק מובטח שמכיל בדיוק שדה אחד כאשר metadata.primary מוגדר ל-true.

ייצוג JSON 
{
  "resourceName": string,
  "etag": string,
  "metadata": {
    object (PersonMetadata)
  },
  "addresses": [
    {
      object (Address)
    }
  ],
  "ageRange": enum (AgeRange),
  "ageRanges": [
    {
      object (AgeRangeType)
    }
  ],
  "biographies": [
    {
      object (Biography)
    }
  ],
  "birthdays": [
    {
      object (Birthday)
    }
  ],
  "braggingRights": [
    {
      object (BraggingRights)
    }
  ],
  "calendarUrls": [
    {
      object (CalendarUrl)
    }
  ],
  "clientData": [
    {
      object (ClientData)
    }
  ],
  "coverPhotos": [
    {
      object (CoverPhoto)
    }
  ],
  "emailAddresses": [
    {
      object (EmailAddress)
    }
  ],
  "events": [
    {
      object (Event)
    }
  ],
  "externalIds": [
    {
      object (ExternalId)
    }
  ],
  "fileAses": [
    {
      object (FileAs)
    }
  ],
  "genders": [
    {
      object (Gender)
    }
  ],
  "imClients": [
    {
      object (ImClient)
    }
  ],
  "interests": [
    {
      object (Interest)
    }
  ],
  "locales": [
    {
      object (Locale)
    }
  ],
  "locations": [
    {
      object (Location)
    }
  ],
  "memberships": [
    {
      object (Membership)
    }
  ],
  "miscKeywords": [
    {
      object (MiscKeyword)
    }
  ],
  "names": [
    {
      object (Name)
    }
  ],
  "nicknames": [
    {
      object (Nickname)
    }
  ],
  "occupations": [
    {
      object (Occupation)
    }
  ],
  "organizations": [
    {
      object (Organization)
    }
  ],
  "phoneNumbers": [
    {
      object (PhoneNumber)
    }
  ],
  "photos": [
    {
      object (Photo)
    }
  ],
  "relations": [
    {
      object (Relation)
    }
  ],
  "relationshipInterests": [
    {
      object (RelationshipInterest)
    }
  ],
  "relationshipStatuses": [
    {
      object (RelationshipStatus)
    }
  ],
  "residences": [
    {
      object (Residence)
    }
  ],
  "sipAddresses": [
    {
      object (SipAddress)
    }
  ],
  "skills": [
    {
      object (Skill)
    }
  ],
  "taglines": [
    {
      object (Tagline)
    }
  ],
  "urls": [
    {
      object (Url)
    }
  ],
  "userDefined": [
    {
      object (UserDefined)
    }
  ]
}
שדות
resourceName

string

שם המשאב של המשתמש, שהוקצה על ידי השרת. מחרוזת ASCII בפורמט people/{person_id}.
etag

string

תג ישות ה-HTTP של המשאב. משמש לאימות מטמון אינטרנט.
metadata

object (PersonMetadata)

פלט בלבד. מטא-נתונים על האדם.
addresses[]

object (Address)

כתובות הרחוב של אותו אדם.
ageRange
(deprecated)

enum (AgeRange)

פלט בלבד. הוצא משימוש (במקום זאת, יש להשתמש ב-person.ageRanges)

טווח הגילאים של המשתמש.
ageRanges[]

object (AgeRangeType)

פלט בלבד. טווחי הגילאים של המשתמש.
biographies[]

object (Biography)

הביוגרפיות של האדם. בשדה הזה יש מקטע יחיד עבור מקורות של אנשי קשר.
birthdays[]

object (Birthday)

ימי ההולדת של אותו אדם. בשדה הזה יש מקטע יחיד עבור מקורות של אנשי קשר.
braggingRights[]
(deprecated)

object (BraggingRights)

הוצא משימוש: לא יוחזרו נתונים לגבי מקורות הגאווה של אותו אדם.
calendarUrls[]

object (CalendarUrl)

כתובות ה-URL של היומנים של אותו אדם.
clientData[]

object (ClientData)

נתוני הלקוחות של אותו אדם.
coverPhotos[]

object (CoverPhoto)

פלט בלבד. תמונות השער של האדם הזה.
emailAddresses[]

object (EmailAddress)

כתובות האימייל של המשתמש הרצוי. מספר כתובות האימייל ב-people.connections.list וב-otherContacts.list מוגבל ל-100. אם לאותו אדם יש יותר כתובות אימייל, אפשר לקבל את הקבוצה כולה על ידי התקשרות אל people.getBatchGet.
events[]

object (Event)

אירועים של אותו אדם
externalIds[]

object (ExternalId)

המזהים החיצוניים של המשתמש.
fileAses[]

object (FileAs)

ה-file-as של אותו אדם.
genders[]

object (Gender)

המגדרים של המשתמש. בשדה הזה יש מקטע יחיד עבור מקורות של אנשי קשר.
imClients[]

object (ImClient)

לקוחות העברת ההודעות המיידיות של אותו אדם.
interests[]

object (Interest)

תחומי העניין של המשתמש.
locales[]

object (Locale)

העדפות הלוקאל של המשתמש.
locations[]

object (Location)

המיקומים של המשתמש.
memberships[]

object (Membership)

החברים בקבוצות של אותו משתמש.
miscKeywords[]

object (MiscKeyword)

מילות המפתח השונות של המשתמש.
names[]

object (Name)

שמות האנשים. בשדה הזה יש מקטע יחיד עבור מקורות של אנשי קשר.
nicknames[]

object (Nickname)

הכינויים של האנשים.
occupations[]

object (Occupation)

המקצועות של אותו אדם.
organizations[]

object (Organization)

ארגונים בעבר או בהווה של אותו אדם.
phoneNumbers[]

object (PhoneNumber)

מספרי הטלפון של אותם אנשים. מספר מספרי הטלפון בpeople.connections.list וב-otherContacts.list מוגבל ל-100. אם למשתמש יש יותר מספרי טלפון, אפשר להתקשר למספר people.getBatchGet כדי לקבל את המספר המלא.
photos[]

object (Photo)

פלט בלבד. התמונות של אותו אדם.
relations[]

object (Relation)

הקשרים של אותו אדם
relationshipInterests[]
(deprecated)

object (RelationshipInterest)

פלט בלבד. הוצא משימוש: לא יוחזרו נתונים תחומי העניין של אותו אדם שקשורים ליחסים.
relationshipStatuses[]
(deprecated)

object (RelationshipStatus)

פלט בלבד. הוצא משימוש: לא יוחזרו נתונים לגבי סטטוס הקשרים של האדם הזה.
residences[]
(deprecated)

object (Residence)

הוצא משימוש: (במקום זאת, יש להשתמש ב-person.locations) כתובת המגורים של המשתמש.
sipAddresses[]

object (SipAddress)

כתובות ה-SIP של אותם משתמשים.
skills[]

object (Skill)

הכישורים של אותו אדם.
taglines[]
(deprecated)

object (Tagline)

פלט בלבד. הוצא משימוש: לא יוחזרו נתונים התיאורים הקצרים של האדם.
urls[]

object (Url)

כתובות ה-URL שמשויכות לאותו משתמש.
userDefined[]

object (UserDefined)

נתונים בהגדרת המשתמש של המשתמש.

PersonMetadata

מטא-נתונים על אדם.

ייצוג JSON 
{
  "sources": [
    {
      object (Source)
    }
  ],
  "previousResourceNames": [
    string
  ],
  "linkedPeopleResourceNames": [
    string
  ],
  "deleted": boolean,
  "objectType": enum (ObjectType)
}
שדות
sources[]

object (Source)

מקורות הנתונים של המשתמש.
previousResourceNames[]

string

פלט בלבד. שמות של משאבים קודמים שהיו לאדם הזה. השדה הזה מאוכלס רק עבור בקשות people.connections.list שכוללות אסימון סנכרון.

שם המשאב עשוי להשתנות כשמוסיפים או מסירים שדות שמקשרים איש קשר ופרופיל, כמו כתובת אימייל מאומתת, מספר טלפון מאומת או כתובת URL של פרופיל.
linkedPeopleResourceNames[]

string

פלט בלבד. שמות המשאבים של האנשים שמקושרים למשאב הזה.
deleted

boolean

פלט בלבד. הערך הוא True אם המשאב של המשתמש נמחק. השדה הזה מאוכלס רק עבור בקשות לסנכרון של people.connections.list ו-otherContacts.list.
objectType
(deprecated)

enum (ObjectType)

פלט בלבד. הוצא משימוש (במקום זאת, יש להשתמש ב-person.metadata.sources.profileMetadata.objectType)

סוג האובייקט של המשתמש.

מקור

המקור של שדה.

ייצוג JSON 
{
  "type": enum (SourceType),
  "id": string,
  "etag": string,
  "updateTime": string,

  // Union field metadata can be only one of the following:
  "profileMetadata": {
    object (ProfileMetadata)
  }
  // End of list of possible types for union field metadata.
}
שדות
type

enum (SourceType)

סוג המקור.
id

string

המזהה הייחודי בתוך סוג המקור שנוצר על ידי השרת.
etag

string

מאוכלס רק ב-person.metadata.sources.

תג ישות ה-HTTP של המקור. משמש לאימות מטמון אינטרנט.
updateTime

string (Timestamp format)

פלט בלבד. מאוכלס רק ב-person.metadata.sources.

חותמת הזמן של העדכון האחרון של המקור הזה.

חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

שדה איחוד metadata. מאוכלס רק ב-person.metadata.sources.

מטא-נתונים של המקור. metadata יכול להיות רק אחת מהאפשרויות הבאות:
profileMetadata

object (ProfileMetadata)

פלט בלבד. מאוכלס רק ב-person.metadata.sources.

מטא נתונים על מקור מסוג 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": [
    enum (UserType)
  ]
}
שדות
objectType

enum (ObjectType)

פלט בלבד. סוג אובייקט הפרופיל.
userTypes[]

enum (UserType)

פלט בלבד. המשתמש מקליד.

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 (FieldMetadata)
  },
  "formattedValue": string,
  "type": string,
  "formattedType": string,
  "poBox": string,
  "streetAddress": string,
  "extendedAddress": string,
  "city": string,
  "region": string,
  "postalCode": string,
  "country": string,
  "countryCode": string
}
שדות
metadata

object (FieldMetadata)

מטא-נתונים על הכתובת.
formattedValue

string

הערך הלא מובנה של הכתובת. אם המשתמש לא תגדיר את הערך הזה, המערכת תבנה אותו באופן אוטומטי מערכים מובְנים.
type

string

סוג הכתובת. הסוג יכול להיות מותאם אישית או אחד מהערכים המוגדרים מראש הבאים:

  • home
  • work
  • other
formattedType

string

פלט בלבד. סוג הכתובת שתורגמה והפורמט שלה נקבעה לפי לוקאל החשבון של הצופה או לפי הלוקאל של כותרת ה-HTTP Accept-Language.
poBox

string

הזמנת הרכש של הכתובת.
streetAddress

string

כתובת הרחוב.
extendedAddress

string

הכתובת המורחבת של הכתובת; למשל, מספר הדירה.
city

string

העיר שמוגדרת בכתובת.
region

string

אזור הכתובת; לדוגמה, המדינה או המחוז.
postalCode

string

המיקוד שמוגדר בכתובת.
country

string

המדינה שמוגדרת בכתובת.
countryCode

string

קוד המדינה של הכתובת בפורמט ISO 3166-1 alpha-2.

FieldMetadata

מטא-נתונים של שדה.

ייצוג JSON 
{
  "primary": boolean,
  "sourcePrimary": boolean,
  "verified": boolean,
  "source": {
    object (Source)
  }
}
שדות
primary

boolean

פלט בלבד. הערך הוא True אם השדה הוא השדה הראשי לכל המקורות בגוף המשתמש. לכל משתמש יהיה שדה אחד לכל היותר כאשר primary מוגדר ל-True.
sourcePrimary

boolean

הערך הוא True אם השדה הוא השדה הראשי של source. כל מקור יכול לכלול שדה אחד לכל היותר כאשר sourcePrimary מוגדר כ-true.
verified

boolean

פלט בלבד. True אם השדה מאומת; FALSE אם השדה לא מאומת. שדה מאומת הוא בדרך כלל שם, כתובת אימייל, מספר טלפון או אתר שהבעלות עליהם אושרה.
source

object (Source)

מקור השדה.

טווח גילים

הוצא משימוש (במקום זאת, יש להשתמש ב-person.ageRanges)

טווח גילאים של אדם.

טיפוסים בני מנייה (enum)
AGE_RANGE_UNSPECIFIED לא צוין.
LESS_THAN_EIGHTEEN מתחת לגיל 18.
EIGHTEEN_TO_TWENTY בין שמונה-עשר לעשרים.
TWENTY_ONE_OR_OLDER עשרים ואחת ומעלה.

AgeRangeType

טווח הגילאים של המשתמש.

ייצוג JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "ageRange": enum (AgeRange)
}
שדות
metadata

object (FieldMetadata)

מטא-נתונים בנושא טווח הגילאים.
ageRange

enum (AgeRange)

טווח הגילאים.

ביוגרפיה

ביוגרפיה קצרה של אדם.

ייצוג JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "contentType": enum (ContentType)
}
שדות
metadata

object (FieldMetadata)

מטא-נתונים על הביוגרפיה.
value

string

הביוגרפיה הקצרה.
contentType

enum (ContentType)

סוג התוכן של הביוגרפיה.

ContentType

סוג התוכן.

טיפוסים בני מנייה (enum)
CONTENT_TYPE_UNSPECIFIED לא צוין.
TEXT_PLAIN טקסט פשוט.
TEXT_HTML טקסט HTML.

יום הולדת

יום הולדת של אדם. צריך לציין לפחות אחד מהשדות date ו-text. השדות date ו-text בדרך כלל מייצגים את אותו תאריך, אבל זה לא מובטח. כשמשנים ימי הולדת, הלקוחות צריכים תמיד להגדיר את השדה date.

ייצוג JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "date": {
    object (Date)
  },
  "text": string
}
שדות
metadata

object (FieldMetadata)

מטא-נתונים על יום ההולדת.
date

object (Date)

התאריך המובנה של יום ההולדת.
text
(deprecated)

string

כדאי להשתמש בשדה date אם הוא מוגדר.

מחרוזת בפריסה גמישה שמייצגת את יום ההולדת של המשתמש. הערך הזה לא מאומת.

תאריך

מייצג תאריך קלנדרי מלא או חלקי, כמו יום הולדת. השעה ביום ואזור הזמן מצוינים במקום אחר או לא משמעותיים. התאריך הוא ביחס ללוח השנה הגרגוריאני. המצב הזה יכול לייצג אחת מהאפשרויות הבאות:

  • תאריך מלא, עם ערכים שונים של שנה, חודש ויום.
  • חודש ויום, עם שנה אפס (למשל יום נישואין).
  • שנה בפני עצמה, עם חודש אפס ויום אפס.
  • שנה וחודש, עם יום אפס (לדוגמה, תאריך תפוגה של כרטיס אשראי).

סוגים קשורים:

ייצוג JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
שדות
year

integer

השנה שבה חל התאריך. חייב להיות בין 1 ל-9999, או 0 כדי לציין תאריך ללא שנה.
month

integer

החודש בשנה. הערך חייב להיות 1 עד 12, או 0 כדי לציין שנה בלי חודש ויום.
day

integer

היום בחודש. הערך צריך להיות בין 1 ל-31 ותקף לשנה ולחודש, או 0 כדי לציין שנה בלבד או שנה וחודש שבהם אין חשיבות לציון יום מסוים.

BraggingRights

הוצא משימוש: לא יוחזרו נתונים לגבי זכויות הגאווה של אדם.

ייצוג JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
שדות
metadata

object (FieldMetadata)

מטא-נתונים על מקורות הגאווה.
value

string

זכויות ההתרברבות; לדוגמה, climbed mount everest.

CalendarUrl

כתובת האתר של היומן.

ייצוג JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "url": string,
  "type": string,
  "formattedType": string
}
שדות
metadata

object (FieldMetadata)

מטא-נתונים על כתובת ה-URL של היומן.
url

string

כתובת ה-URL של היומן.
type

string

הסוג של כתובת ה-URL של היומן. הסוג יכול להיות מותאם אישית או אחד מהערכים המוגדרים מראש הבאים:

  • home
  • freeBusy
  • work
formattedType

string

פלט בלבד. הסוג של כתובת ה-URL של היומן מתורגמת ומעוצבת לפי לוקאל החשבון של הצופה או לפי Accept-Language לוקאל כותרת ה-HTTP.

ClientData

נתוני לקוחות שרירותיים שמאוכלסים על ידי לקוחות. אפשר להשתמש במפתחות ובערכים כפולים.

ייצוג JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "key": string,
  "value": string
}
שדות
metadata

object (FieldMetadata)

מטא-נתונים על נתוני הלקוח.
key

string

הלקוח ציין המפתח של נתוני הלקוח.
value

string

הלקוח ציין את הערך של נתוני הלקוח.

CoverPhoto

תמונת שער של אדם. תמונה גדולה שמוצגת בדף הפרופיל של המשתמש ומייצגת את מי שהוא או את מה שחשוב לו.

ייצוג JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "url": string,
  "default": boolean
}
שדות
metadata

object (FieldMetadata)

מטא-נתונים של תמונת השער.
url

string

כתובת ה-URL של תמונת השער.
default

boolean

True אם תמונת השער היא תמונת השער שמוגדרת כברירת מחדל. false אם תמונת השער היא תמונת שער שסופקה על ידי המשתמש.

EmailAddress

כתובת אימייל של אדם מסוים.

ייצוג JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string,
  "displayName": string
}
שדות
metadata

object (FieldMetadata)

מטא-נתונים לגבי כתובת אימייל.
value

string

כתובת האימייל.
type

string

הסוג של כתובת האימייל. הסוג יכול להיות מותאם אישית או אחד מהערכים המוגדרים מראש הבאים:

  • home
  • work
  • other
formattedType

string

פלט בלבד. סוג כתובת האימייל שתורגמה והפורמט שלה נקבע לפי לוקאל החשבון של הצופה או לפי Accept-Language לוקאל כותרת ה-HTTP.
displayName

string

השם המוצג של הודעת האימייל.

אירוע

אירוע שקשור לאדם הזה.

ייצוג JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "date": {
    object (Date)
  },
  "type": string,
  "formattedType": string
}
שדות
metadata

object (FieldMetadata)

מטא-נתונים של האירוע.
date

object (Date)

תאריך האירוע.
type

string

סוג האירוע. הסוג יכול להיות מותאם אישית או אחד מהערכים המוגדרים מראש הבאים:

  • anniversary
  • other
formattedType

string

פלט בלבד. סוג האירוע שתורגם ומפורמט לפי לוקאל החשבון של הצופה או לפי Accept-Language לוקאל כותרת ה-HTTP.

ExternalId

מזהה מישות חיצונית שקשורה לאדם הזה.

ייצוג JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string
}
שדות
metadata

object (FieldMetadata)

מטא-נתונים של המזהה החיצוני.
value

string

הערך של המזהה החיצוני.
type

string

הסוג של המזהה החיצוני. הסוג יכול להיות מותאם אישית או אחד מהערכים המוגדרים מראש הבאים:

  • account
  • customer
  • loginId
  • network
  • organization
formattedType

string

פלט בלבד. סוג האירוע שתורגם ומפורמט לפי לוקאל החשבון של הצופה או לפי Accept-Language לוקאל כותרת ה-HTTP.

FileAs

השם שישמש למיון האדם ברשימה.

ייצוג JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
שדות
metadata

object (FieldMetadata)

מטא-נתונים לגבי קבצים מסוג 'קובץ בתור'.
value

string

הערך 'קובץ בתור'

מגדר

המגדר של אדם.

ייצוג JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "formattedValue": string,
  "addressMeAs": string
}
שדות
metadata

object (FieldMetadata)

מטא-נתונים שקשורים למגדר.
value

string

המגדר של המשתמש. המגדר יכול להיות מותאם אישית או אחד מהערכים הבאים שהוגדרו מראש:

  • male
  • female
  • unspecified
formattedValue

string

פלט בלבד. הערך של המגדר שתורגם ומפורמט לפי לוקאל החשבון של הצופה או לפי Accept-Language לוקאל כותרת ה-HTTP. ערכים שלא צוינו או ערכים מותאמים אישית לא מותאמים לשוק המקומי.
addressMeAs

string

שדה טקסט חופשי ללשון פנייה שצריך להשתמש בה כדי לפנות לאדם ספציפי. הערכים הנפוצים הם:

  • he/him
  • she/her
  • they/them

ImClient

לקוח להעברת הודעות מיידיות של משתמש.

ייצוג JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "username": string,
  "type": string,
  "formattedType": string,
  "protocol": string,
  "formattedProtocol": string
}
שדות
metadata

object (FieldMetadata)

מטא-נתונים על לקוח ה-IM.
username

string

שם המשתמש המשמש בלקוח ה-IM.
type

string

הסוג של לקוח IM. הסוג יכול להיות מותאם אישית או אחד מהערכים המוגדרים מראש הבאים:

  • home
  • work
  • other
formattedType

string

פלט בלבד. הסוג של לקוח ה-IM שתורגם ומפורמט לפי לוקאל החשבון של הצופה או לפי Accept-Language לוקאל כותרת ה-HTTP.
protocol

string

הפרוטוקול של לקוח ה-IM. הפרוטוקול יכול להיות מותאם אישית או אחד מהערכים הבאים שהוגדרו מראש:

  • aim
  • msn
  • yahoo
  • skype
  • qq
  • googleTalk
  • icq
  • jabber
  • netMeeting
formattedProtocol

string

פלט בלבד. הפרוטוקול של לקוח ה-IM בפורמט של לוקאל החשבון של הצופה, או לפי הלוקאל של כותרת ה-HTTP Accept-Language.

תחום עניין

אחד מתחומי העניין של האדם.

ייצוג JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
שדות
metadata

object (FieldMetadata)

מטא-נתונים לגבי תחום העניין.
value

string

העניין; לדוגמה, stargazing.

שפה ואזור

העדפת אזור של משתמש.

ייצוג JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
שדות
metadata

object (FieldMetadata)

מטא-נתונים לגבי הלוקאל.
value

string

תג השפה IETF BCP 47 בפורמט תקין שמייצג את הלוקאל.

מיקום

המיקום של משתמש.

ייצוג JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "current": boolean,
  "buildingId": string,
  "floor": string,
  "floorSection": string,
  "deskCode": string
}
שדות
metadata

object (FieldMetadata)

מטא-נתונים לגבי המיקום.
value

string

ערך בפריסה גמישה של המיקום.
type

string

סוג המיקום. הסוג יכול להיות מותאם אישית או אחד מהערכים המוגדרים מראש הבאים:

  • desk
  • grewUp
current

boolean

האם המיקום הוא המיקום הנוכחי.
buildingId

string

מזהה הבניין
floor

string

שם הקומה או מספר הקומה
floorSection

string

קטע הקומה ב-floor_name.
deskCode

string

מיקום של שולחן עבודה וירטואלי.

מינוי

חברות של אדם בקבוצה. ניתן לשנות רק חברויות בקבוצות של אנשי קשר.

ייצוג JSON 
{
  "metadata": {
    object (FieldMetadata)
  },

  // Union field membership can be only one of the following:
  "contactGroupMembership": {
    object (ContactGroupMembership)
  },
  "domainMembership": {
    object (DomainMembership)
  }
  // End of list of possible types for union field membership.
}
שדות
metadata

object (FieldMetadata)

מטא-נתונים על המינוי.
שדה איחוד membership. המינוי. membership יכול להיות רק אחת מהאפשרויות הבאות:
contactGroupMembership

object (ContactGroupMembership)

החברות בקבוצת אנשי הקשר.
domainMembership

object (DomainMembership)

פלט בלבד. המינוי לדומיין.

ContactGroupMembership

חברות בקבוצת אנשי קשר של Google.

ייצוג JSON 
{
  "contactGroupId": string,
  "contactGroupResourceName": string
}
שדות
contactGroupId
(deprecated)

string

פלט בלבד. מזהה קבוצת אנשי הקשר של החברות בקבוצה של אנשי הקשר.
contactGroupResourceName

string

שם המשאב של קבוצת אנשי הקשר, שהוקצה על ידי השרת. מחרוזת ASCII, בפורמט contactGroups/{contactGroupId}. אפשר להשתמש רק ב-contactGroupResourceName לשינוי חברויות. אפשר להסיר כל חבר או חברה בקבוצת אנשי קשר, אבל רק קבוצת משתמשים או 'אנשי הקשר שלי' או 'מסומנים בכוכב' חברויות בקבוצות מערכת. לאיש קשר חייב להיות תמיד לפחות חבר אחד בקבוצה של אנשי קשר.

DomainMembership

מינוי לדומיין של Google Workspace.

ייצוג JSON 
{
  "inViewerDomain": boolean
}
שדות
inViewerDomain

boolean

True אם המשתמש נמצא בדומיין Google Workspace של הצופה.

MiscKeyword

מילת מפתח שונה של משתמש.

ייצוג JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": enum (KeywordType),
  "formattedType": string
}
שדות
metadata

object (FieldMetadata)

מטא נתונים לגבי מילת המפתח 'שונות'.
value

string

הערך של מילת המפתח 'שונות'.
type

enum (KeywordType)

סוג מילת המפתח 'שונות'.
formattedType

string

פלט בלבד. הסוג של מילת המפתח השונות שתורגמה והפורמט שלה לפי אזור החשבון של הצופה או לפי לוקאל כותרת ה-HTTP Accept-Language.

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 (FieldMetadata)
  },
  "displayName": string,
  "displayNameLastFirst": string,
  "unstructuredName": string,
  "familyName": string,
  "givenName": string,
  "middleName": string,
  "honorificPrefix": string,
  "honorificSuffix": string,
  "phoneticFullName": string,
  "phoneticFamilyName": string,
  "phoneticGivenName": string,
  "phoneticMiddleName": string,
  "phoneticHonorificPrefix": string,
  "phoneticHonorificSuffix": string
}
שדות
metadata

object (FieldMetadata)

מטא-נתונים על השם.
displayName

string

פלט בלבד. הפורמט של השם המוצג תואם ללוקאל שצוין על ידי חשבון הצופה או על ידי כותרת ה-HTTP Accept-Language.
displayNameLastFirst

string

פלט בלבד. השם המוצג עם שם המשפחה בפורמט הראשון בהתאם ללוקאל שצוין בחשבון של הצופה, או לפי כותרת ה-HTTP Accept-Language.
unstructuredName

string

ערך השם של הטופס החופשי.
familyName

string

שם המשפחה.
givenName

string

השם הנתון.
middleName

string

השמות האמצעיים
honorificPrefix

string

הקידומות התכוננות, כמו Mrs. או Dr.
honorificSuffix

string

סיומות כבוד, כמו Jr.
phoneticFullName

string

השם המלא מאוית כמו שהוא נשמע.
phoneticFamilyName

string

שם המשפחה מאוית כפי שהוא נשמע.
phoneticGivenName

string

השם הנתון מאוית כמו שהוא נשמע.
phoneticMiddleName

string

השמות האמצעיים מאויתים כמו שהם נשמעים.
phoneticHonorificPrefix

string

הקידומות המכובדות מאויתות כפי שהן נשמעות.
phoneticHonorificSuffix

string

סיומות המכובדות מאויתות כפי שהן נשמעות.

כינוי

כינוי של אדם.

ייצוג JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": enum (NicknameType)
}
שדות
metadata

object (FieldMetadata)

מטא-נתונים על הכינוי.
value

string

הכינוי.
type

enum (NicknameType)

סוג הכינוי.

NicknameType

סוג הכינוי.

טיפוסים בני מנייה (enum)
DEFAULT כינוי גנרי.
MAIDEN_NAME

שם נעורים או שם משפחה של נעורים. בשימוש כאשר שם המשפחה של אדם השתנה כתוצאה מנישואים.
INITIALS

ראשי תיבות.
GPLUS

כינוי של פרופיל Google+.
OTHER_NAME

שיוך מקצועי או שם אחר; לדוגמה, Dr. Smith.
ALTERNATE_NAME השם החלופי מוכר לאדם הזה.
SHORT_NAME

גרסה קצרה יותר של שם האדם.

עיסוק

המקצוע של אדם מסוים.

ייצוג JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
שדות
metadata

object (FieldMetadata)

מטא-נתונים לגבי המקצוע.
value

string

המקצוע; לדוגמה, carpenter.

ארגון

הארגון הקודם או הנוכחי של המשתמש. מותר להגדיר טווחי תאריכים חופפים.

ייצוג JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "type": string,
  "formattedType": string,
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  },
  "current": boolean,
  "name": string,
  "phoneticName": string,
  "department": string,
  "title": string,
  "jobDescription": string,
  "symbol": string,
  "domain": string,
  "location": string,
  "costCenter": string,
  "fullTimeEquivalentMillipercent": integer
}
שדות
metadata

object (FieldMetadata)

מטא-נתונים על הארגון.
type

string

סוג הארגון. הסוג יכול להיות מותאם אישית או אחד מהערכים המוגדרים מראש הבאים:

  • work
  • school
formattedType

string

פלט בלבד. סוג הארגון מתורגם ומפורמט לפי לוקאל החשבון של הצופה או לפי Accept-Language לוקאל כותרת ה-HTTP.
startDate

object (Date)

תאריך ההתחלה שבו המשתמש הצטרף לארגון.
endDate

object (Date)

תאריך הסיום שבו המשתמש עזב את הארגון.
current

boolean

True אם הארגון הוא הארגון הנוכחי של האדם. FALSE אם הארגון הוא ארגון קודם.
name

string

השם של הארגון.
phoneticName

string

השם הפונטי של הארגון.
department

string

המחלקה של האדם בארגון.
title

string

תיאור התפקיד של האדם בארגון.
jobDescription

string

תיאור התפקיד של האדם בארגון.
symbol

string

הסמל שמשויך לארגון; לדוגמה, סימול מניה, קיצור או ראשי תיבות.
domain

string

שם הדומיין שמשויך לארגון, לדוגמה, google.com.
location

string

מיקום המשרד של הארגון שבו האדם עובד.
costCenter

string

מרכז העלויות של האדם בארגון.
fullTimeEquivalentMillipercent

integer

המילי-אחוז שווה ערך למשרה מלאה של אדם בארגון (100,000 = 100%).

מספר טלפון

מספר טלפון של אדם מסוים.

ייצוג JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "canonicalForm": string,
  "type": string,
  "formattedType": string
}
שדות
metadata

object (FieldMetadata)

מטא-נתונים לגבי מספר הטלפון.
value

string

מספר הטלפון.
canonicalForm

string

פלט בלבד. הצורה הקנונית של מספר הטלפון ITU-T E.164.
type

string

הסוג של מספר הטלפון. הסוג יכול להיות מותאם אישית או אחד מהערכים המוגדרים מראש הבאים:

  • home
  • work
  • mobile
  • homeFax
  • workFax
  • otherFax
  • pager
  • workMobile
  • workPager
  • main
  • googleVoice
  • other
formattedType

string

פלט בלבד. סוג מספר הטלפון שמתורגם ומפורמט לפי לוקאל החשבון של הצופה או לפי Accept-Language לוקאל כותרת ה-HTTP.

תמונה

תמונה של אדם. תמונה שמוצגת ליד השם של האדם כדי לעזור לאחרים לזהות אותו.

ייצוג JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "url": string,
  "default": boolean
}
שדות
metadata

object (FieldMetadata)

מטא-נתונים לגבי התמונה.
url

string

כתובת ה-URL של התמונה. כדי לשנות את הגודל הרצוי, אפשר להוסיף את פרמטר השאילתה sz={size} בסוף כתובת ה-URL, כאשר הגודל {size} מציין את הגודל בפיקסלים. דוגמה: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50
default

boolean

True אם התמונה היא תמונה כברירת מחדל. FALSE אם התמונה היא תמונה שסופקה על ידי משתמש.

קשר

הקשר של אדם לאדם אחר.

ייצוג JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "person": string,
  "type": string,
  "formattedType": string
}
שדות
metadata

object (FieldMetadata)

מטא-נתונים לגבי הקשר.
person

string

השם של האדם האחר שהקשר הזה מתייחס אליו.
type

string

הקשר של האדם לאדם השני. הסוג יכול להיות מותאם אישית או אחד מהערכים המוגדרים מראש הבאים:

  • spouse
  • child
  • mother
  • father
  • parent
  • brother
  • sister
  • friend
  • relative
  • domesticPartner
  • manager
  • assistant
  • referredBy
  • partner
formattedType

string

פלט בלבד. סוג הקשר שתורגם ומפורמט לפי הלוקאל של החשבון של הצופה או הלוקאל שצוין בכותרת Accept-Language HTTP.

RelationshipInterest

הוצא משימוש: לא יוחזרו נתונים לגבי מידת העניין של המשתמש במערכת היחסים .

ייצוג JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "formattedValue": string
}
שדות
metadata

object (FieldMetadata)

מטא-נתונים על העניין שקשור ליחסים.
value

string

סוג הקשר שהאדם מחפש. הערך יכול להיות מותאם אישית או אחד מהערכים הבאים שהוגדרו מראש:

  • friend
  • date
  • relationship
  • networking
formattedValue

string

פלט בלבד. הערך של העניין לקשר שתורגם ומפורמט לפי הלוקאל של החשבון של הצופה או לפי הלוקאל שצוין בכותרת Accept-Language HTTP.

RelationshipStatus

הוצא משימוש: לא יוחזרו נתונים לגבי סטטוס הקשר של המשתמש.

ייצוג JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "formattedValue": string
}
שדות
metadata

object (FieldMetadata)

מטא-נתונים לגבי סטטוס מערכת היחסים.
value

string

סטטוס הקשר. הערך יכול להיות מותאם אישית או אחד מהערכים הבאים שהוגדרו מראש:

  • single
  • inARelationship
  • engaged
  • married
  • itsComplicated
  • openRelationship
  • widowed
  • inDomesticPartnership
  • inCivilUnion
formattedValue

string

פלט בלבד. הערך של סטטוס הקשר מתורגם ומפורמט לפי לוקאל החשבון של הצופה או לפי Accept-Language לוקאל כותרת ה-HTTP.

מקום מגורים

הוצא משימוש: במקומם צריך להשתמש ב-person.locations. מקום המגורים הנוכחי או בעבר של אדם

ייצוג JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "current": boolean
}
שדות
metadata

object (FieldMetadata)

מטא-נתונים על הבית.
value

string

כתובת המגורים.
current

boolean

True אם מקום המגורים הוא מקום המגורים הנוכחי של אותו אדם; false אם מקום המגורים הוא מקום מגורים בעבר.

SipAddress

כתובת SIP של אדם מסוים. כתובות הפרוטוקול הראשוני של הסשן משמשות לתקשורת VoIP כדי לבצע שיחות קוליות או שיחות וידאו באינטרנט.

ייצוג JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string
}
שדות
metadata

object (FieldMetadata)

מטא-נתונים על כתובת ה-SIP.
value

string

כתובת ה-SIP בפורמט RFC 3261 19.1 SIP URI.
type

string

הסוג של כתובת ה-SIP. הסוג יכול להיות מותאם אישית או אחד מהערכים המוגדרים מראש הבאים:

  • home
  • work
  • mobile
  • other
formattedType

string

פלט בלבד. סוג כתובת ה-SIP שתורגמה והפורמט שלה נקבע לפי לוקאל החשבון של הצופה או לפי הלוקאל של כותרת ה-HTTP Accept-Language.

מיומנות למידה

מיומנות שיש לאותו אדם.

ייצוג JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
שדות
metadata

object (FieldMetadata)

מטא-נתונים לגבי המיומנות.
value

string

המיומנות; לדוגמה, underwater basket weaving.

שורת תיוג

הוצא משימוש: לא יוחזרו נתונים. תיאור קצר של אדם הוא שורה אחת.

ייצוג JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
שדות
metadata

object (FieldMetadata)

מטא-נתונים שקשורים לתיאור הקצר.
value

string

התיאור הקצר.

כתובת אתר

כתובות ה-URL שמשויכות לאדם.

ייצוג JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string
}
שדות
metadata

object (FieldMetadata)

מטא-נתונים לגבי כתובת ה-URL.
value

string

כתובת ה-URL.
type

string

הסוג של כתובת ה-URL. הסוג יכול להיות מותאם אישית או אחד מהערכים המוגדרים מראש הבאים:

  • home
  • work
  • blog
  • profile
  • homePage
  • ftp
  • reservations
  • appInstallPage: אתר לאפליקציה ב-Currents.
  • other
formattedType

string

פלט בלבד. סוג כתובת ה-URL שתורגמה והפורמט שלה נקבע לפי לוקאל החשבון של הצופה או לפי הלוקאל של כותרת ה-HTTP Accept-Language.

UserDefined

נתונים שרירותיים של משתמשים שאוכלסו על ידי משתמשי הקצה.

ייצוג JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "key": string,
  "value": string
}
שדות
metadata

object (FieldMetadata)

מטא-נתונים על נתונים בהגדרת המשתמש.
key

string

המפתח של הנתונים בהגדרת המשתמש שצוינו על ידי משתמש הקצה.
value

string

הערך של משתמש הקצה שהמשתמש ציין.

שיטות

batchCreateContacts

יצירת קבוצה של אנשי קשר חדשים והחזרת ThreeResponses

בקשות שינוי עבור אותו משתמש צריכות להישלח ברצף כדי למנוע זמן אחזור ארוך יותר וכשלים.

batchDeleteContacts

 מוחקים קבוצה של אנשי קשר.

batchUpdateContacts

 עדכון קבוצה של אנשי קשר והחזרת מפה של שמות משאבים ל-UserResponses עבור אנשי הקשר המעודכנים.

createContact

 ליצור איש קשר חדש ולהחזיר את המשאב של איש הקשר הזה.

deleteContact

 מחיקת איש קשר.

deleteContactPhoto

 מחיקת התמונה של איש הקשר.

get

 מספקת מידע על אדם על ידי ציון שם המשאב.

getBatchGet

 מספקת מידע על רשימה של אנשים ספציפיים על ידי ציון רשימה של שמות המשאבים המבוקשים.

listDirectoryPeople

 מספקת רשימה של פרופילים בדומיין ואנשי קשר מהדומיין בספריית הדומיין של המשתמש המאומת.

searchContacts

 מספקת רשימה של אנשי קשר ברשימת אנשי הקשר המקובצים של המשתמשים המאומתים, שתואמות לשאילתת החיפוש.

searchDirectoryPeople

 מספקת רשימה של פרופילים בדומיין ואנשי קשר מהדומיין בספריית הדומיין של המשתמשים המאומתים שתואמים לשאילתת החיפוש.

updateContact

 עדכון נתוני איש הקשר של איש קשר קיים.

updateContactPhoto

 לעדכן את התמונה של איש הקשר.