REST Resource: people

Ressource: Person

Informationen zu einer Person, die aus verschiedenen Datenquellen zusammengeführt wurden, z. B. die Kontakte und Profildaten des authentifizierten Nutzers.

Die meisten Felder können mehrere Elemente enthalten. Die Elemente in einem Feld haben keine garantierte Reihenfolge, aber in jedem nicht leeren Feld ist garantiert genau ein Feld enthalten, bei dem metadata.primary auf „true“ gesetzt ist.

JSON-Darstellung 
{
  "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)
    }
  ]
}
Felder
resourceName

string

Der Ressourcenname für die Person, der vom Server zugewiesen wird. Ein ASCII-String im Format people/{person_id}.
etag

string

Das HTTP-Entitäts-Tag der Ressource. Wird für die Validierung des Webcaches verwendet.
metadata

object (PersonMetadata)

Nur Ausgabe. Metadaten zur Person.
addresses[]

object (Address)

Die Adressen der Person.
ageRange
(deprecated)

enum (AgeRange)

Nur Ausgabe. Eingestellt (nutzen Sie stattdessen person.ageRanges)

Das Alter der Person.
ageRanges[]

object (AgeRangeType)

Nur Ausgabe. Die Altersgruppen der Person.
biographies[]

object (Biography)

Die Biografien der Person. Dieses Feld ist ein Singleton für Kontaktquellen.
birthdays[]

object (Birthday)

Die Geburtstage der Person. Dieses Feld ist ein Singleton für Kontaktquellen.
braggingRights[]
(deprecated)

object (BraggingRights)

VERWORFEN: Es werden keine Daten angezeigt, die angebend sind.
calendarUrls[]

object (CalendarUrl)

Die Kalender-URLs der Person.
clientData[]

object (ClientData)

Die Kundendaten der Person.
coverPhotos[]

object (CoverPhoto)

Nur Ausgabe. Die Hintergrundbilder der Person
emailAddresses[]

object (EmailAddress)

Die E-Mail-Adressen der Person. Bei people.connections.list und otherContacts.list ist die Anzahl der E-Mail-Adressen auf 100 beschränkt. Wenn eine Person mehr E-Mail-Adressen hat, kann der gesamte Satz durch Aufrufen von people.getBatchGet abgerufen werden.
events[]

object (Event)

Die Termine der Person
externalIds[]

object (ExternalId)

Die externen IDs der Person.
fileAses[]

object (FileAs)

Die Dateistatus der Person.
genders[]

object (Gender)

Das Geschlecht der Person. Dieses Feld ist ein Singleton für Kontaktquellen.
imClients[]

object (ImClient)

Die Instant Messaging-Clients der Person.
interests[]

object (Interest)

Die Interessen der Person.
locales[]

object (Locale)

Die Spracheinstellungen der Person.
locations[]

object (Location)

Die Standorte der Person.
memberships[]

object (Membership)

Die Gruppenmitgliedschaften der Person.
miscKeywords[]

object (MiscKeyword)

Sonstige Keywords der Person
names[]

object (Name)

Die Namen der Personen. Dieses Feld ist ein Singleton für Kontaktquellen.
nicknames[]

object (Nickname)

Spitznamen der Person
occupations[]

object (Occupation)

Die Tätigkeiten der Person.
organizations[]

object (Organization)

Frühere oder aktuelle Organisationen der Person
phoneNumbers[]

object (PhoneNumber)

Die Telefonnummern der Person. Bei people.connections.list und otherContacts.list ist die Anzahl der Telefonnummern auf 100 begrenzt. Wenn eine Person mehr Telefonnummern hat, kann der gesamte Satz durch Aufrufen von people.getBatchGet abgerufen werden.
photos[]

object (Photo)

Nur Ausgabe. Fotos der Person
relations[]

object (Relation)

Die Beziehungen der Person.
relationshipInterests[]
(deprecated)

object (RelationshipInterest)

Nur Ausgabe. VERWORFEN: Es werden keine Daten zu den Beziehungsinteressen der Person zurückgegeben.
relationshipStatuses[]
(deprecated)

object (RelationshipStatus)

Nur Ausgabe. VERWORFEN: Es werden keine Daten zum Beziehungsstatus der Person zurückgegeben.
residences[]
(deprecated)

object (Residence)

VERWORFEN: Verwende stattdessen person.locations.
sipAddresses[]

object (SipAddress)

Die SIP-Adressen der Person.
skills[]

object (Skill)

Die Fähigkeiten der Person.
taglines[]
(deprecated)

object (Tagline)

Nur Ausgabe. VERWORFEN: Es werden keine Daten für die Kurzinfo der Person zurückgegeben.
urls[]

object (Url)

Verknüpfte URLs der Person
userDefined[]

object (UserDefined)

Die benutzerdefinierten Daten der Person.

Personenmetadaten

Die Metadaten einer Person.

JSON-Darstellung 
{
  "sources": [
    {
      object (Source)
    }
  ],
  "previousResourceNames": [
    string
  ],
  "linkedPeopleResourceNames": [
    string
  ],
  "deleted": boolean,
  "objectType": enum (ObjectType)
}
Felder
sources[]

object (Source)

Die Datenquellen der Person.
previousResourceNames[]

string

Nur Ausgabe. Bisherige Ressourcennamen dieser Person. Wird nur für people.connections.list-Anfragen ausgefüllt, die ein Synchronisierungstoken enthalten.

Der Ressourcenname kann sich ändern, wenn Sie Felder hinzufügen oder entfernen, die einen Kontakt und ein Profil enthalten, z. B. eine bestätigte E-Mail-Adresse, Telefonnummer oder Profil-URL.
linkedPeopleResourceNames[]

string

Nur Ausgabe. Ressourcennamen von Personen, die mit dieser Ressource verknüpft sind.
deleted

boolean

Nur Ausgabe. Wahr, wenn die Personsressource gelöscht wurde. Wird nur für people.connections.list- und otherContacts.list-Synchronisierungsanfragen ausgefüllt.
objectType
(deprecated)

enum (ObjectType)

Nur Ausgabe. Eingestellt (nutzen Sie stattdessen person.metadata.sources.profileMetadata.objectType)

Der Typ des Person-Objekts.

Quelle

Die Quelle eines Felds.

JSON-Darstellung 
{
  "type": enum (SourceType),
  "id": string,
  "etag": string,
  "updateTime": string,
  "profileMetadata": {
    object (ProfileMetadata)
  }
}
Felder
type

enum (SourceType)

Der Quelltyp.
id

string

Die eindeutige Kennung innerhalb des vom Server generierten Quelltyps.
etag

string

Wird nur in person.metadata.sources ausgefüllt.

Das HTTP-Entitäts-Tag der Quelle. Wird für die Validierung des Webcaches verwendet.
updateTime

string (Timestamp format)

Nur Ausgabe. Wird nur in person.metadata.sources ausgefüllt.

Zeitstempel der letzten Aktualisierung dieser Quelle.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit einer Auflösung von Nanosekunden und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
profileMetadata

object (ProfileMetadata)

Nur Ausgabe. Wird nur in person.metadata.sources ausgefüllt.

Metadaten zu einer Quelle vom Typ PROFILE.

Quelltyp

Der Typ einer Quelle.

Enums
SOURCE_TYPE_UNSPECIFIED Nicht angegeben
ACCOUNT Google-Konto:
PROFILE Google-Profil: Sie können sich das Profil unter https://profiles.google.com/{id} ansehen, wobei {id} die Quell-ID ist.
DOMAIN_PROFILE Google Workspace-Domainprofil.
CONTACT Google-Kontakt Sie können den Kontakt unter https://contact.google.com/{id} aufrufen, wobei {id} die Quell-ID ist.
OTHER_CONTACT „Anderer Kontakt“ von Google.
DOMAIN_CONTACT Gemeinsamer Kontakt für die Google Workspace-Domain

Profilmetadaten

Die Metadaten eines Profils.

JSON-Darstellung 
{
  "objectType": enum (ObjectType),
  "userTypes": [
    enum (UserType)
  ]
}
Felder
objectType

enum (ObjectType)

Nur Ausgabe. Der Profilobjekttyp.
userTypes[]

enum (UserType)

Nur Ausgabe. Der Nutzer tippt.

Objekttyp

Der Typ eines Personenobjekts.

Enums
OBJECT_TYPE_UNSPECIFIED Nicht angegeben
PERSON Person.
PAGE Seite „Currents“:

Nutzertyp

Der Typ des Nutzers.

Enums
USER_TYPE_UNKNOWN Der Nutzertyp ist unbekannt.
GOOGLE_USER Der Nutzer ist ein Google-Nutzer.
GPLUS_USER Der Nutzer ist Currents-Nutzer.
GOOGLE_APPS_USER Der Nutzer ist ein Google Workspace-Nutzer.

Adresse

Die physische Adresse einer Person Kann ein Postfach oder eine Adresse sein. Alle Felder sind optional.

JSON-Darstellung 
{
  "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
}
Felder
metadata

object (FieldMetadata)

Metadaten zur Adresse.
formattedValue

string

Der unstrukturierte Wert der Adresse. Wenn der Nutzer dies nicht festlegt, wird es automatisch aus strukturierten Werten erstellt.
type

string

Der Typ der Adresse. Es kann ein benutzerdefinierter Typ oder einer der folgenden vordefinierten Werte sein:

  • home
  • work
  • other
formattedType

string

Nur Ausgabe. Der Typ der Adresse, die in der Sprache des Kontos des Betrachters übersetzt und formatiert wurde, oder der Sprache des HTTP-Headers Accept-Language.
poBox

string

Das Postfach der Adresse.
streetAddress

string

Die Adresse.
extendedAddress

string

Die erweiterte Adresse der Adresse, z. B. die Wohnungsnummer.
city

string

Die Stadt der Adresse.
region

string

Die Region der Adresse, z. B. das Bundesland.
postalCode

string

Die Postleitzahl der Adresse.
country

string

Das Land der Adresse.
countryCode

string

Der Ländercode der Adresse nach ISO 3166-1 alpha-2.

Feldmetadaten

Metadaten zu einem Feld.

JSON-Darstellung 
{
  "primary": boolean,
  "sourcePrimary": boolean,
  "verified": boolean,
  "source": {
    object (Source)
  }
}
Felder
primary

boolean

Nur Ausgabe. Wahr, wenn das Feld das primäre Feld für alle Quellen in der Person ist. Jede Person hat maximal ein Feld, in dem primary auf „true“ gesetzt ist.
sourcePrimary

boolean

Wahr, wenn das Feld das primäre Feld für source ist. Jede Quelle darf höchstens ein Feld haben, in dem sourcePrimary auf „true“ gesetzt ist.
verified

boolean

Nur Ausgabe. Der Wert ist „true“, wenn das Feld bestätigt ist, und „false“, wenn das Feld nicht bestätigt ist. Ein bestätigtes Feld ist in der Regel ein Name, eine E-Mail-Adresse, eine Telefonnummer oder eine Website, für die die Person bestätigt wurde.
source

object (Source)

Die Quelle des Felds.

AgeRange

Eingestellt (nutzen Sie stattdessen person.ageRanges)

Die Altersgruppe einer Person.

Enums
AGE_RANGE_UNSPECIFIED Nicht angegeben
LESS_THAN_EIGHTEEN Jünger als 18 Jahre.
EIGHTEEN_TO_TWENTY Zwischen achtzehn und zwanzig Jahre.
TWENTY_ONE_OR_OLDER Einundzwanzig und älter.

Altersbereichstyp

Das Alter einer Person.

JSON-Darstellung 
{
  "metadata": {
    object (FieldMetadata)
  },
  "ageRange": enum (AgeRange)
}
Felder
metadata

object (FieldMetadata)

Metadaten zur Altersgruppe.
ageRange

enum (AgeRange)

Die Altersgruppe.

Biografie

Die Kurzbiografie einer Person.

JSON-Darstellung 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "contentType": enum (ContentType)
}
Felder
metadata

object (FieldMetadata)

Metadaten zur Biografie.
value

string

Die kurze Biografie.
contentType

enum (ContentType)

Der Inhaltstyp der Biografie.

ContentType

Die Art des Inhalts.

Enums
CONTENT_TYPE_UNSPECIFIED Nicht angegeben
TEXT_PLAIN Nur Text
TEXT_HTML HTML-Text.

Geburtstag

Der Geburtstag einer Person. Mindestens eines der Felder date und text ist angegeben. Die Felder date und text enthalten normalerweise dasselbe Datum, können dies jedoch nicht garantieren. Kunden sollten immer das Feld date festlegen, wenn Geburtstage mutiert werden.

JSON-Darstellung 
{
  "metadata": {
    object (FieldMetadata)
  },
  "date": {
    object (Date)
  },
  "text": string
}
Felder
metadata

object (FieldMetadata)

Metadaten zum Geburtstag.
date

object (Date)

Das strukturierte Datum des Geburtsdatums.
text
(deprecated)

string

Verwenden Sie das Feld date, falls festgelegt.

Ein String im freien Format, der das Geburtsdatum des Nutzers darstellt. Dieser Wert ist nicht validiert.

Datum

Stellt ein ganzes oder teilweises Kalenderdatum dar, z. B. einen Geburtstag. Tageszeit und Zeitzone sind entweder an anderer Stelle angegeben oder unbedeutend. Das Datum bezieht sich auf den gregorianischen Kalender. Das kann Folgendes sein:

  • Ein vollständiges Datum mit Werten für Jahr, Monat und Tag ungleich null.
  • Ein Monat und ein Tag mit einem Jahr von null, z. B. ein Jahrestag.
  • Ein Jahr für sich – mit 0 Monaten und 0 Tagen
  • Ein Jahr und ein Monat mit einem null Tag (z. B. ein Ablaufdatum einer Kreditkarte)

Ähnliche Typen:

JSON-Darstellung 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Felder
year

integer

Jahr des Datums. Der Wert muss zwischen 1 und 9999 oder 0 liegen, wenn ein Datum ohne Jahr angegeben werden soll.
month

integer

Monat eines Jahres. Der Wert muss zwischen 1 und 12 oder 0 liegen, damit ein Jahr ohne Monat und Tag angegeben werden kann.
day

integer

Tag eines Monats. Der Wert muss zwischen 1 und 31 liegen und für das Jahr und den Monat gültig sein. Sie kann auch 0 sein, um nur ein Jahr oder ein Jahr und einen Monat anzugeben, bei denen der Tag keine Bedeutung hat.

Dies und Das

VERWORFEN: Es werden keine Daten angezeigt, die die Angabe des Angemessenen einer Person anzeigen.

JSON-Darstellung 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Felder
metadata

object (FieldMetadata)

Metadaten zu "Dies und Das".
value

string

Das prahlen, z. B. climbed mount everest.

Kalender-URL

Die Kalender-URL einer Person.

JSON-Darstellung 
{
  "metadata": {
    object (FieldMetadata)
  },
  "url": string,
  "type": string,
  "formattedType": string
}
Felder
metadata

object (FieldMetadata)

Metadaten zur Kalender-URL.
url

string

Die Kalender-URL.
type

string

Der Typ der Kalender-URL. Es kann ein benutzerdefinierter Typ oder einer der folgenden vordefinierten Werte sein:

  • home
  • freeBusy
  • work
formattedType

string

Nur Ausgabe. Die Art der Kalender-URL, die in der Sprache des Kontos des Betrachters übersetzt oder formatiert ist, oder der Sprache des Accept-Language-HTTP-Headers.

Kundendaten

Beliebige Kundendaten, die von Kunden ausgefüllt werden. Doppelte Schlüssel und Werte sind zulässig.

JSON-Darstellung 
{
  "metadata": {
    object (FieldMetadata)
  },
  "key": string,
  "value": string
}
Felder
metadata

object (FieldMetadata)

Metadaten zu den Kundendaten.
key

string

Der vom Client angegebene Schlüssel der Clientdaten.
value

string

Der vom Client angegebene Wert der Clientdaten.

Titelbild

Titelbild einer Person. Ein großes Bild auf der Profilseite der Person, das zeigt, wer sie ist oder was sie interessiert.

JSON-Darstellung 
{
  "metadata": {
    object (FieldMetadata)
  },
  "url": string,
  "default": boolean
}
Felder
metadata

object (FieldMetadata)

Metadaten zum Titelbild.
url

string

Die URL des Titelbilds.
default

boolean

„True“, wenn das Hintergrundbild das Standardtitelbild ist; „False“, wenn es ein vom Nutzer bereitgestelltes Hintergrundbild ist.

EmailAddress (E-Mail-Adresse)

Die E-Mail-Adresse einer Person.

JSON-Darstellung 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string,
  "displayName": string
}
Felder
metadata

object (FieldMetadata)

Metadaten zur E-Mail-Adresse.
value

string

Die E-Mail-Adresse.
type

string

Der Typ der E-Mail-Adresse. Es kann ein benutzerdefinierter Typ oder einer der folgenden vordefinierten Werte sein:

  • home
  • work
  • other
formattedType

string

Nur Ausgabe. Der Typ der E-Mail-Adresse, die in der Sprache des Kontoinhabers übersetzt oder formatiert wurde, oder der Sprache des HTTP-Headers Accept-Language.
displayName

string

Der Anzeigename der E-Mail.

Veranstaltung

Ein Ereignis im Zusammenhang mit der Person.

JSON-Darstellung 
{
  "metadata": {
    object (FieldMetadata)
  },
  "date": {
    object (Date)
  },
  "type": string,
  "formattedType": string
}
Felder
metadata

object (FieldMetadata)

Metadaten zum Ereignis.
date

object (Date)

Das Datum des Ereignisses.
type

string

Der Typ des Ereignisses. Es kann ein benutzerdefinierter Typ oder einer der folgenden vordefinierten Werte sein:

  • anniversary
  • other
formattedType

string

Nur Ausgabe. Die Art des Ereignisses, die in der Sprache des Kontos des Betrachters übersetzt oder formatiert ist, oder in der Sprache des Accept-Language-HTTP-Headers.

ExternalId

Eine Kennung einer externen Entität, die sich auf die Person bezieht.

JSON-Darstellung 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string
}
Felder
metadata

object (FieldMetadata)

Metadaten zur externen ID.
value

string

Der Wert der externen ID.
type

string

Der Typ der externen ID. Es kann ein benutzerdefinierter Typ oder einer der folgenden vordefinierten Werte sein:

  • account
  • customer
  • loginId
  • network
  • organization
formattedType

string

Nur Ausgabe. Die Art des Ereignisses, die in der Sprache des Kontos des Betrachters übersetzt oder formatiert ist, oder in der Sprache des Accept-Language-HTTP-Headers.

FileAs

Der Name, der zum Sortieren der Person in einer Liste verwendet werden soll.

JSON-Darstellung 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Felder
metadata

object (FieldMetadata)

Metadaten über die Datei-as.
value

string

Der Wert unter „file-as“

Geschlecht

Das Geschlecht einer Person.

JSON-Darstellung 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "formattedValue": string,
  "addressMeAs": string
}
Felder
metadata

object (FieldMetadata)

Metadaten zum Geschlecht.
value

string

Das Geschlecht für die Person. Das Geschlecht kann benutzerdefiniert sein oder einen der folgenden vordefinierten Werte haben:

  • male
  • female
  • unspecified
formattedValue

string

Nur Ausgabe. Der Wert des Geschlechts, übersetzt und formatiert in der Sprache des Betrachters oder im HTTP-Header Accept-Language. Nicht angegebene oder benutzerdefinierte Werte werden nicht lokalisiert.
addressMeAs

string

Textfeld im freien Format für Pronomen, mit dem die Person angesprochen werden soll. Häufige Werte:

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

ImClient

Der Chat-Client einer Person.

JSON-Darstellung 
{
  "metadata": {
    object (FieldMetadata)
  },
  "username": string,
  "type": string,
  "formattedType": string,
  "protocol": string,
  "formattedProtocol": string
}
Felder
metadata

object (FieldMetadata)

Metadaten zum IM-Client.
username

string

Der im IM-Client verwendete User-Name.
type

string

Der Typ des IM-Clients. Es kann ein benutzerdefinierter Typ oder einer der folgenden vordefinierten Werte sein:

  • home
  • work
  • other
formattedType

string

Nur Ausgabe. Der Typ des IM-Clients, der in der Sprache des Kontos des Betrachters übersetzt und formatiert wurde, oder der Sprache des Accept-Language-HTTP-Headers.
protocol

string

Das Protokoll des IM-Clients. Das Protokoll kann benutzerdefiniert oder einer der folgenden vordefinierten Werte sein:

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

string

Nur Ausgabe. Das Protokoll des IM-Clients, der in der Sprache des Kontokontos des Nutzers oder der Accept-Language-HTTP-Header-Sprache formatiert ist.

Interesse

Eines der Interessen der Person.

JSON-Darstellung 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Felder
metadata

object (FieldMetadata)

Metadaten zum Interesse.
value

string

Das Interesse, z. B. stargazing.

Sprache

Das Gebietsschema einer Person.

JSON-Darstellung 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Felder
metadata

object (FieldMetadata)

Metadaten zum Gebietsschema.
value

string

Das wohlgeformte IETF BCP 47-Sprachtag, das die Sprache darstellt.

Standort

Der Standort einer Person.

JSON-Darstellung 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "current": boolean,
  "buildingId": string,
  "floor": string,
  "floorSection": string,
  "deskCode": string
}
Felder
metadata

object (FieldMetadata)

Metadaten zum Standort.
value

string

Der Wert im freien Format des Standorts.
type

string

Der Typ des Standorts. Es kann ein benutzerdefinierter Typ oder einer der folgenden vordefinierten Werte sein:

  • desk
  • grewUp
current

boolean

Gibt an, ob der Standort der aktuelle Standort ist.
buildingId

string

Die Gebäude-ID.
floor

string

Name oder Nummer der Etage
floorSection

string

Der Etagenabschnitt in floor_name.
deskCode

string

Der individuelle Arbeitsplatz.

Mitgliedschaft

Die Mitgliedschaft einer Person in einer Gruppe. Nur Mitgliedergruppen können geändert werden.

JSON-Darstellung 
{
  "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.
}
Felder
metadata

object (FieldMetadata)

Metadaten zur Mitgliedschaft.
Union-Feld membership. Die Mitgliedschaft. Für membership ist nur einer der folgenden Werte zulässig:
contactGroupMembership

object (ContactGroupMembership)

Die Mitgliedschaft in der Kontaktgruppe.
domainMembership

object (DomainMembership)

Nur Ausgabe. Die Domainmitgliedschaft.

Kontaktgruppenmitgliedschaft

Eine Mitgliedschaft in einer Google-Kontaktgruppe.

JSON-Darstellung 
{
  "contactGroupId": string,
  "contactGroupResourceName": string
}
Felder
contactGroupId
(deprecated)

string

Nur Ausgabe. Die Kontaktgruppen-ID für die Mitgliedschaft in der Kontaktgruppe.
contactGroupResourceName

string

Der Ressourcenname für die Kontaktgruppe, der vom Server zugewiesen wurde. Ein ASCII-String im Format contactGroups/{contactGroupId}. Nur contactGroupResourceName kann zum Ändern von Mitgliedschaften verwendet werden. Jede Kontaktgruppenmitgliedschaft kann entfernt werden, es können jedoch nur Nutzergruppen oder Mitglieder aus „myContacts“ oder „markierte“ Systemgruppen hinzugefügt werden. Ein Kontakt muss immer mindestens eine Kontaktgruppenmitgliedschaft haben.

Domainmitgliedschaft

Eine Google Workspace-Domainmitgliedschaft.

JSON-Darstellung 
{
  "inViewerDomain": boolean
}
Felder
inViewerDomain

boolean

Dieser Wert ist „True“, wenn sich die Person in der Google Workspace-Domain des Betrachters befindet.

Sonstige Keywords

Das sonstige Keyword eines Nutzers

JSON-Darstellung 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": enum (KeywordType),
  "formattedType": string
}
Felder
metadata

object (FieldMetadata)

Metadaten zum diversen Keyword.
value

string

Der Wert des anderen Keywords.
type

enum (KeywordType)

Der Keyword-Typ „Sonstiges“.
formattedType

string

Nur Ausgabe. Der Typ des Keywords, das in der Sprache des Kontos des Betrachters übersetzt oder formatiert ist, oder der Sprache des Accept-Language-HTTP-Headers.

Keyword-Typ

Keyword-Typ.

Enums
TYPE_UNSPECIFIED Nicht angegeben
OUTLOOK_BILLING_INFORMATION Outlook-Feld für Zahlungsinformationen.
OUTLOOK_DIRECTORY_SERVER Outlook-Feld für den Verzeichnisserver.
OUTLOOK_KEYWORD Outlook-Feld für Keyword.
OUTLOOK_MILEAGE Outlook-Feld für Laufleistung.
OUTLOOK_PRIORITY Outlook-Feld für Priorität.
OUTLOOK_SENSITIVITY Outlook-Feld für die Vertraulichkeit.
OUTLOOK_SUBJECT Outlook-Feld für den Betreff.
OUTLOOK_USER Outlook-Feld für Nutzer.
HOME Startseite
WORK Arbeit.
OTHER Sonstiges.

Name

Der Name einer Person. Wenn der Name ein Mononym ist, ist der Familienname leer.

JSON-Darstellung 
{
  "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
}
Felder
metadata

object (FieldMetadata)

Metadaten zum Namen.
displayName

string

Nur Ausgabe. Der Anzeigename, der gemäß dem im Konto des Betrachters angegebenen Gebietsschema oder dem Accept-Language-HTTP-Header formatiert ist.
displayNameLastFirst

string

Nur Ausgabe. Der Anzeigename mit dem letzten Namen, der zuerst gemäß dem im Konto des Nutzers angegebenen Gebietsschema oder dem Accept-Language-HTTP-Header formatiert ist.
unstructuredName

string

Der Wert für das kostenlose Format.
familyName

string

Der Familienname.
givenName

string

Der angegebene Name.
middleName

string

Zweiter Vorname
honorificPrefix

string

Die wichtigsten Präfixe, z. B. Mrs. oder Dr.
honorificSuffix

string

Ehrliche Suffixe, z. B. Jr.
phoneticFullName

string

Der vollständige Name, wie er buchstabiert wird.
phoneticFamilyName

string

Der Schreibweise des Familiennamens.
phoneticGivenName

string

Der angegebene Name wird so geschrieben, wie es klingt.
phoneticMiddleName

string

Der zweite Vorname in der Schreibweise.
phoneticHonorificPrefix

string

Die Präfixe werden nach ihrem Klang buchstabiert.
phoneticHonorificSuffix

string

Die heiligen Suffixe, die so buchstabiert werden, wie sie klingen.

Alternativname

Alias einer Person.

JSON-Darstellung 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": enum (NicknameType)
}
Felder
metadata

object (FieldMetadata)

Metadaten zum Alias.
value

string

Das Alias.
type

enum (NicknameType)

Der Typ des Alias.

Aliastyp

Der Typ eines Alias.

Enums
DEFAULT Generischer Spitzname.
MAIDEN_NAME

Mädchen- oder Geburtsfamilienname. Wird verwendet, wenn der Familienname aufgrund einer Heirat geändert wurde.
INITIALS

Initialen.
GPLUS

Alias des Google+ Profils
OTHER_NAME

Berufliche Zugehörigkeit oder anderer Name, z. B. Dr. Smith.
ALTERNATE_NAME Der alternative Name der Person ist bekannt.
SHORT_NAME

Eine kürzere Version des Namens.

Beruf

Der Beruf einer Person.

JSON-Darstellung 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Felder
metadata

object (FieldMetadata)

Metadaten zur Tätigkeit.
value

string

Der Beruf, z. B. carpenter.

Organisation

Die bisherige oder aktuelle Organisation einer Person. Sich überschneidende Zeiträume sind zulässig.

JSON-Darstellung 
{
  "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
}
Felder
metadata

object (FieldMetadata)

Metadaten zur Organisation.
type

string

Der Typ der Organisation. Es kann ein benutzerdefinierter Typ oder einer der folgenden vordefinierten Werte sein:

  • work
  • school
formattedType

string

Nur Ausgabe. Der Typ der Organisation, die in der Sprache des Kontos des Betrachters übersetzt und formatiert wurde, oder der Sprache des Accept-Language-HTTP-Headers.
startDate

object (Date)

Das Startdatum der Person, die der Organisation beigetreten ist.
endDate

object (Date)

Das Enddatum, an dem die Person die Organisation verlassen hat.
current

boolean

„True“, wenn die Organisation die aktuelle Organisation der Person ist; „False“, wenn die Organisation eine frühere Organisation ist.
name

string

Der Name der Organisation
phoneticName

string

Der phonetische Name der Organisation.
department

string

Die Abteilung der Person in der Organisation.
title

string

Die Berufsbezeichnung der Person in der Organisation.
jobDescription

string

Die Stellenbeschreibung der Person in der Organisation.
symbol

string

Das mit der Organisation verknüpfte Symbol, z. B. ein Börsentickersymbol, eine Abkürzung oder ein Akronym.
domain

string

Der mit der Organisation verknüpfte Domainname, z. B. google.com.
location

string

Der Standort des Unternehmens, in dem die Person arbeitet.
costCenter

string

Die Kostenstelle der Person in der Organisation.
fullTimeEquivalentMillipercent

integer

Vollzeitbeschäftigung der Person in Millisekunden innerhalb der Organisation (100.000 = 100%).

PhoneNumber

Die Telefonnummer einer Person.

JSON-Darstellung 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "canonicalForm": string,
  "type": string,
  "formattedType": string
}
Felder
metadata

object (FieldMetadata)

Metadaten zur Telefonnummer.
value

string

Die Telefonnummer.
canonicalForm

string

Nur Ausgabe. Die kanonische ITU-T E.164-Form der Telefonnummer.
type

string

Der Typ der Telefonnummer. Es kann ein benutzerdefinierter Typ oder einer der folgenden vordefinierten Werte sein:

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

string

Nur Ausgabe. Der Typ der Telefonnummer, die in der Sprache des Kontoinhabers übersetzt oder formatiert ist, oder der Sprache des HTTP-Headers Accept-Language.

Foto

Das Foto einer Person. Ein Bild neben dem Namen der Person, damit andere sie leichter erkennen können.

JSON-Darstellung 
{
  "metadata": {
    object (FieldMetadata)
  },
  "url": string,
  "default": boolean
}
Felder
metadata

object (FieldMetadata)

Metadaten zum Foto.
url

string

Die URL des Fotos. Sie können die gewünschte Größe ändern, indem Sie am Ende der URL einen Suchparameter sz={size} anhängen, wobei {size} die Größe in Pixeln ist. Beispiel: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50
default

boolean

Der Wert ist „true“, wenn das Foto ein Standardfoto ist, und „false“, wenn das Foto ein vom Nutzer bereitgestelltes Foto ist.

Beziehung

Die Beziehung einer Person zu einer anderen Person.

JSON-Darstellung 
{
  "metadata": {
    object (FieldMetadata)
  },
  "person": string,
  "type": string,
  "formattedType": string
}
Felder
metadata

object (FieldMetadata)

Metadaten zur Beziehung.
person

string

Der Name der anderen Person, auf die sich diese Beziehung bezieht.
type

string

Die Beziehung der Person zur anderen Person. Es kann ein benutzerdefinierter Typ oder einer der folgenden vordefinierten Werte sein:

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

string

Nur Ausgabe. Die Art der Beziehung, die in der Sprache des Kontoinhabers oder der im HTTP-Header „Accept-Language“ angegebenen Sprache übersetzt und formatiert wurde.

Beziehungsinteresse

VERWORFEN: Es werden keine Daten zum Beziehungsinteresse einer Person zurückgegeben .

JSON-Darstellung 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "formattedValue": string
}
Felder
metadata

object (FieldMetadata)

Metadaten zum Beziehungsinteresse.
value

string

Die Art der Beziehung, die die Person sucht. Der Wert kann benutzerdefiniert oder einer der folgenden vordefinierten Werte sein:

  • friend
  • date
  • relationship
  • networking
formattedValue

string

Nur Ausgabe. Der Wert des Beziehungsinteresses, der in der Sprache des Kontos des Nutzers oder der im HTTP-Header „Accept-Language“ angegebenen Sprache formatiert und formatiert ist.

Beziehungsstatus

VERWORFEN: Es werden keine Daten zum Beziehungsstatus einer Person zurückgegeben.

JSON-Darstellung 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "formattedValue": string
}
Felder
metadata

object (FieldMetadata)

Metadaten zum Beziehungsstatus.
value

string

Der Beziehungsstatus. Der Wert kann benutzerdefiniert oder einer der folgenden vordefinierten Werte sein:

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

string

Nur Ausgabe. Der Wert des Beziehungsstatus, der in der Sprache des Kontos des Betrachters übersetzt oder formatiert ist, oder in der Sprache des Accept-Language-HTTP-Headers.

Wohnsitz

VERWORFEN: Verwenden Sie stattdessen person.locations. Den früheren oder aktuellen Wohnsitz einer Person.

JSON-Darstellung 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "current": boolean
}
Felder
metadata

object (FieldMetadata)

Metadaten zur Residenz.
value

string

Die Adresse des Wohnsitzes.
current

boolean

„Wahr“, wenn der Wohnsitz der aktuelle Wohnsitz der Person ist; „falsch“, wenn der Wohnsitz in der Vergangenheit liegt.

SipAddress (SIP-Adresse)

Die SIP-Adresse einer Person. Die Adressen des anfänglichen Protokolls der Sitzung werden für die VoIP-Kommunikation verwendet, um Sprach- oder Videoanrufe über das Internet durchzuführen.

JSON-Darstellung 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string
}
Felder
metadata

object (FieldMetadata)

Metadaten zur SIP-Adresse.
value

string

Die SIP-Adresse im SIP-URI-Format RFC 3261 19.1.
type

string

Der Typ der SIP-Adresse. Der Typ kann benutzerdefiniert oder einer der folgenden vordefinierten Werte sein:

  • home
  • work
  • mobile
  • other
formattedType

string

Nur Ausgabe. Der Typ der SIP-Adresse, die in der Sprache des Kontos des Betrachters übersetzt oder formatiert ist, oder der Sprache des Accept-Language-HTTP-Headers.

Skill

Eine Fähigkeit, die die Person hat.

JSON-Darstellung 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Felder
metadata

object (FieldMetadata)

Metadaten zum Skill.
value

string

Die Fähigkeit, z. B. underwater basket weaving.

Kurzbeschreibung

VERWORFEN: Es werden keine Daten zurückgegeben, die nur eine Zeile umfassen.

JSON-Darstellung 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Felder
metadata

object (FieldMetadata)

Metadaten zur Kurzinfo.
value

string

Die Kurzinfo.

URL

Verknüpfte URLs einer Person

JSON-Darstellung 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string
}
Felder
metadata

object (FieldMetadata)

Metadaten zur URL.
value

string

Die URL
type

string

Der Typ der URL. Es kann ein benutzerdefinierter Typ oder einer der folgenden vordefinierten Werte sein:

  • home
  • work
  • blog
  • profile
  • homePage
  • ftp
  • reservations
  • appInstallPage: Website für eine Currents-Anwendung.
  • other
formattedType

string

Nur Ausgabe. Der Typ der URL, die in der Sprache des Kontoinhabers übersetzt oder formatiert wurde, oder der Sprache des Accept-Language-HTTP-Headers.

Benutzerdefiniert

Beliebige Nutzerdaten, die von den Endnutzern ausgefüllt werden.

JSON-Darstellung 
{
  "metadata": {
    object (FieldMetadata)
  },
  "key": string,
  "value": string
}
Felder
metadata

object (FieldMetadata)

Metadaten zu den benutzerdefinierten Daten.
key

string

Der vom Endnutzer angegebene Schlüssel der benutzerdefinierten Daten.
value

string

Der vom Endnutzer angegebene Wert der benutzerdefinierten Daten.

Methoden

batchCreateContacts

Erstellen Sie einen Batch neuer Kontakte und geben Sie die Personenantworten für die neu

Mutate-Anfragen für denselben Nutzer sollten nacheinander gesendet werden, um erhöhte Latenz und Fehler zu vermeiden.

batchDeleteContacts

 Löschen Sie mehrere Kontakte.

batchUpdateContacts

 Aktualisieren Sie einen Batch von Kontakten und geben Sie eine Zuordnung der Ressourcennamen an PersonResponses für die aktualisierten Kontakte zurück.

createContact

 Erstellen Sie einen neuen Kontakt und geben Sie die Personsressource für diesen Kontakt zurück.

deleteContact

 Löschen Sie eine Kontaktperson.

deleteContactPhoto

 Foto eines Kontakts löschen

get

 Gibt Informationen zu einer Person an, indem ein Ressourcenname angegeben wird.

getBatchGet

 Liefert Informationen zu einer Liste bestimmter Personen, indem Sie eine Liste der angeforderten Ressourcennamen angeben.

listDirectoryPeople

 Enthält eine Liste von Domainprofilen und Domainkontakten im Domainverzeichnis des authentifizierten Nutzers.

searchContacts

 Eine Liste der Kontakte in den gruppierten Kontakten des authentifizierten Nutzers, die der Suchanfrage entsprechen

searchDirectoryPeople

 Enthält eine Liste von Domainprofilen und Domainkontakten im Domainverzeichnis des authentifizierten Nutzers, die der Suchanfrage entsprechen.

updateContact

 Kontaktdaten für eine vorhandene Kontaktperson aktualisieren.

updateContactPhoto

 Foto eines Kontakts aktualisieren