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)

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

object (Birthday)

ימי ההולדת של אותו אדם. השדה הזה הוא Singleton עבור מקורות של אנשי קשר.
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)

שמות הקבצים של האדם.
genders[]

object (Gender)

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

object (ImClient)

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

object (Interest)

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

object (Locale)

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

object (Location)

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

object (Membership)

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

object (MiscKeyword)

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

object (Name)

שמות האדם. השדה הזה הוא Singleton עבור מקורות של אנשי קשר.
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, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

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

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

object (ProfileMetadata)

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

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

enum (ObjectType)

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

enum (UserType)

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

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 (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

האזור של הכתובת. לדוגמה: מדינה (State) או מחוז.
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)

מקור השדה.

AgeRange

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

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

טיפוסים בני מנייה (enums)
AGE_RANGE_UNSPECIFIED לא צוין.
LESS_THAN_EIGHTEEN מתחת לגיל 18.
EIGHTEEN_TO_TWENTY בין 18 לעשרים.
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

סוג התוכן.

טיפוסים בני מנייה (enums)
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

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

ייצוג 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 של היומן שמתורגמת ומפורמטת בלוקאל של החשבון של הצופה או בלוקאל של כותרת ה-HTTP Accept-Language.

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

פלט בלבד. הסוג של כתובת האימייל שמתורגמת ומפורמטת בלוקאל של חשבון הצופה או בלוקאל של כותרת ה-HTTP Accept-Language.
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

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

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

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

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

פלט בלבד. הערך של המגדר שתורגם ומפורמט בלוקאל של החשבון של הצופה או בלוקאל של כותרת ה-HTTP Accept-Language. ערך שלא צוין או ערך מותאם אישית לא מותאמים לשוק המקומי.
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

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

string

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

  • home
  • work
  • other
formattedType

string

פלט בלבד. הסוג של לקוח ה-IM שתורגם ומפורמט בלוקאל של החשבון של הצופה או בלוקאל של כותרת ה-HTTP Accept-Language.
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 לשינוי חברויות. ניתן להסיר כל חבר בקבוצת אנשי קשר, אך ניתן להוסיף רק חברויות בקבוצות משתמשים או בקבוצות מערכת "myContacts" או "מסומנות בכוכב". איש קשר חייב לכלול לפחות חבר אחד בקבוצה של אנשי קשר.

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

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

טיפוסים בני מנייה (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 (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

סוג הכינוי.

טיפוסים בני מנייה (enums)
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

פלט בלבד. סוג הארגון שמתורגם ומפורמט בלוקאל של החשבון של הצופה או בלוקאל של כותרת ה-HTTP Accept-Language.
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

מספר האחוזים המקביל של אדם במשרה מלאה בארגון (100000 = 100%).

PhoneNumber

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

ייצוג 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

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

תמונה

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

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

object (FieldMetadata)

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

string

כתובת האתר של התמונה. כדי לשנות את הגודל הרצוי, מוסיפים פרמטר שאילתה 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.

RelationshipInterest

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

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

object (FieldMetadata)

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

string

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

  • friend
  • date
  • relationship
  • networking
formattedValue

string

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

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

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

מקום מגורים

הוצא משימוש: במקומם יש להשתמש ב-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

כתובות ה-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

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

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

batchDeleteContacts

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

batchUpdateContacts

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

createContact

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

deleteContact

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

deleteContactPhoto

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

get

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

getBatchGet

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

listDirectoryPeople

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

searchContacts

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

searchDirectoryPeople

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

updateContact

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

updateContactPhoto

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