REST Resource: people

Ressource: Person

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

Die meisten Felder können mehrere Elemente enthalten. Die Elemente in einem Feld haben keine garantierte Reihenfolge. Jedes nicht leere Feld hat aber garantiert genau ein Feld, 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 vom Server zugewiesene Ressourcenname für die Person. Ein ASCII-String im Format people/{person_id}.

etag

string

Das HTTP-Entitäts-Tag der Ressource. Wird für die Web-Cache-Validierung verwendet.

metadata

object (PersonMetadata)

Nur Ausgabe. Metadaten zur Person.

addresses[]

object (Address)

Die Adressen der Person.

ageRange
(deprecated)

enum (AgeRange)

Nur Ausgabe. EINGESTELLT (Bitte verwende stattdessen person.ageRanges.)

Die Altersgruppe der Person.

ageRanges[]

object (AgeRangeType)

Nur Ausgabe. Die Altersgruppen der Person.

biographies[]

object (Biography)

Die Biografien der Person. Dieses Feld ist ein Singleton-Feld für Kontaktquellen.

birthdays[]

object (Birthday)

Die Geburtstage der Person. Dieses Feld ist ein Singleton-Feld für Kontaktquellen.

braggingRights[]
(deprecated)

object (BraggingRights)

EINGESTELLT: Es werden keine Daten zurückgegeben.

calendarUrls[]

object (CalendarUrl)

Die Kalender-URLs der Person.

clientData[]

object (ClientData)

Die Kundendaten der Person.

coverPhotos[]

object (CoverPhoto)

Nur Ausgabe. Hintergrundbilder der Person

emailAddresses[]

object (EmailAddress)

Die E-Mail-Adressen der Person. Für people.connections.list und otherContacts.list ist die Anzahl der E-Mail-Adressen auf 100 begrenzt. Wenn eine Person mehr E-Mail-Adressen hat, kann der gesamte Satz abgerufen werden, indem people.getBatchGet aufgerufen wird.

events[]

object (Event)

Termine der Person

externalIds[]

object (ExternalId)

Die externen IDs der Person.

fileAses[]

object (FileAs)

Die Datei der Person wird gespeichert.

genders[]

object (Gender)

Das Geschlecht der Person. Dieses Feld ist ein Singleton-Feld für Kontaktquellen.

imClients[]

object (ImClient)

Instant-Messaging-Clients der Person.

interests[]

object (Interest)

Interessen der Person

locales[]

object (Locale)

Die Einstellungen für das Gebietsschema der Person.

locations[]

object (Location)

Standorte der Person

memberships[]

object (Membership)

Gruppenmitgliedschaften der Person

miscKeywords[]

object (MiscKeyword)

Verschiedene Keywords der Person

names[]

object (Name)

Die Namen der Personen. Dieses Feld ist ein Singleton-Feld für Kontaktquellen.

nicknames[]

object (Nickname)

Den Spitznamen der Person.

occupations[]

object (Occupation)

Die Berufe der Person.

organizations[]

object (Organization)

Frühere oder aktuelle Organisationen der Person.

phoneNumbers[]

object (PhoneNumber)

Die Telefonnummern der Person Für people.connections.list und otherContacts.list ist die Anzahl der Telefonnummern auf 100 begrenzt. Wenn eine Person weitere Telefonnummern hat, kannst du den gesamten Satz abrufen, indem du people.getBatchGet aufrufst.

photos[]

object (Photo)

Nur Ausgabe. Fotos der Person

relations[]

object (Relation)

Die Beziehungen der Person.

relationshipInterests[]
(deprecated)

object (RelationshipInterest)

Nur Ausgabe. EINGESTELLT: Es werden keine Daten zu den Beziehungsinteressen der Person zurückgegeben.

relationshipStatuses[]
(deprecated)

object (RelationshipStatus)

Nur Ausgabe. EINGESTELLT: Es werden keine Daten zum Beziehungsstatus der Person zurückgegeben.

residences[]
(deprecated)

object (Residence)

EINGESTELLT: (Bitte verwende stattdessen person.locations) den Wohnsitz der Person.

sipAddresses[]

object (SipAddress)

Die SIP-Adressen der Person

skills[]

object (Skill)

Die Fähigkeiten der Person.

taglines[]
(deprecated)

object (Tagline)

Nur Ausgabe. EINGESTELLT: Es werden keine Daten zu den Kurzinfos der Person zurückgegeben.

urls[]

object (Url)

Die verknüpften URLs der Person.

userDefined[]

object (UserDefined)

Benutzerdefinierte Daten der Person

PersonMetadata

Die Metadaten einer Person.

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

object (Source)

Die Datenquellen für die Person.

previousResourceNames[]

string

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

Der Ressourcenname kann sich ändern, wenn Felder hinzugefügt oder entfernt werden, die einen Kontakt und ein Profil verknüpfen, z. B. eine bestätigte E-Mail-Adresse, bestätigte 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 Personenressource gelöscht wurde. Wird nur für people.connections.list- und otherContacts.list-Synchronisierungsanfragen ausgefüllt.

objectType
(deprecated)

enum (ObjectType)

Nur Ausgabe. EINGESTELLT (Bitte verwende stattdessen person.metadata.sources.profileMetadata.objectType.)

Der Typ des Personenobjekts.

Quelle

Die Quelle eines Felds.

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

enum (SourceType)

Der Quelltyp.

id

string

Die eindeutige Kennung innerhalb des vom Server generierten Quelltyps.

etag

string

Nur in person.metadata.sources ausgefüllt.

Das HTTP-Entitäts-Tag der Quelle. Wird für die Web-Cache-Validierung verwendet.

updateTime

string (Timestamp format)

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

Zeitstempel der letzten Aktualisierung dieser Quelle.

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

Union-Feld metadata. Nur in person.metadata.sources ausgefüllt.

Metadaten zur Quelle. Für metadata ist nur einer der folgenden Werte zulässig:

profileMetadata

object (ProfileMetadata)

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

Metadaten zu einer Quelle vom Typ PROFILE.

SourceType

Der Typ einer Quelle.

Enums
SOURCE_TYPE_UNSPECIFIED Nicht angegeben
ACCOUNT Ein Google-Konto
PROFILE Google-Profil: Sie können das Profil unter https://profiles.google.com/{id} aufrufen, wobei {id} für die Quellen-ID steht.
DOMAIN_PROFILE Google Workspace-Domainprofil.
CONTACT Google-Kontakt: Sie können den Kontakt unter https://contact.google.com/{id} aufrufen, wobei {id} für die Quellen-ID steht.
OTHER_CONTACT Google „Anderer Kontakt“.
DOMAIN_CONTACT Freigegebener Google Workspace-Domainkontakt.

ProfileMetadata

Die Metadaten zu einem Profil.

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

enum (ObjectType)

Nur Ausgabe. Der Objekttyp des Profils.

userTypes[]

enum (UserType)

Nur Ausgabe. Die Nutzereingabe.

ObjectType

Der Typ eines Personenobjekts.

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

UserType

Der Typ der Nutzenden.

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

Adresse

Die Anschrift einer Person. Kann ein Postfach sein oder die Adresse. 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. Wird sie nicht vom Nutzer festgelegt, wird sie automatisch aus strukturierten Werten erstellt.

type

string

Der Typ der Adresse. Beim Typ kann es sich um einen benutzerdefinierten Wert oder einen der folgenden vordefinierten Werte handeln:

  • home
  • work
  • other
formattedType

string

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

poBox

string

Das P.O. der Adresse ein.

streetAddress

string

Die Adresse.

extendedAddress

string

Die erweiterte Adresse der Adresse zum Beispiel die Wohnungsnummer.

city

string

Die Stadt der Adresse.

region

string

Die Region der Adresse z. B. das Bundesland oder die Provinz.

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.

FieldMetadata

Metadaten zu einem Feld.

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

boolean

Nur Ausgabe. „True“, wenn das Feld das primäre Feld für alle Quellen in der Person ist. Jede Person hat höchstens ein Feld, für das primary auf „true“ gesetzt ist.

sourcePrimary

boolean

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

verified

boolean

Nur Ausgabe. "True", wenn das Feld verifiziert ist false, wenn das Feld ungeprüft ist. Ein bestätigtes Feld ist in der Regel ein Name, eine E-Mail-Adresse, eine Telefonnummer oder eine Website, deren Inhaber bestätigt wurde.

source

object (Source)

Die Quelle des Felds.

Altersgruppe

EINGESTELLT (Bitte verwende stattdessen person.ageRanges.)

Die Altersspanne einer Person.

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

AgeRangeType

Die Altersgruppe 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 stellen normalerweise dasselbe Datum dar, dies kann aber nicht garantiert werden. Kunden sollten beim Ändern von Geburtstagen immer das Feld date festlegen.

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

object (FieldMetadata)

Metadaten zum Geburtstag.

date

object (Date)

Das strukturierte Datum des Geburtstags.

text
(deprecated)

string

Falls festgelegt, wird bevorzugt das Feld date verwendet.

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

Datum

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

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

Ähnliche Typen:

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

integer

Jahr des Datums. Muss zwischen 1 und 9999 liegen oder 0, um ein Datum ohne Jahr anzugeben.

month

integer

Monat eines Jahres. Muss zwischen 1 und 12 liegen oder 0, um ein Jahr ohne Monat und Tag anzugeben.

day

integer

Tag im Monat. Muss zwischen 1 und 31 liegen und für das Jahr und den Monat gültig sein, oder 0, um ein Jahr allein oder ein Jahr und Monat anzugeben, wenn der Tag nicht von Bedeutung ist.

BraggingRights

EINGESTELLT: Es werden keine Daten zurückgegeben, wenn eine Person angeben möchte.

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

object (FieldMetadata)

Metadaten zum Angeben.

value

string

Angeben, z. B. climbed mount everest.

CalendarUrl

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

Typ der Kalender-URL. Beim Typ kann es sich um einen benutzerdefinierten Wert oder einen der folgenden vordefinierten Werte handeln:

  • home
  • freeBusy
  • work
formattedType

string

Nur Ausgabe. Der Typ der Kalender-URL, die in der Sprache des Zuschauers oder in der Accept-Language-HTTP-Header-Sprache übersetzt und formatiert wurde.

ClientData

Beliebige Kundendaten, die von Kunden eingegeben 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 Kunden angegebene Schlüssel der Kundendaten.

value

string

Der vom Kunden angegebene Wert für die Kundendaten.

CoverPhoto

Titelbild einer Person Ein großes Bild auf der Profilseite einer 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 Titelbild das Standardtitelbild ist false, wenn das Titelbild 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. Beim Typ kann es sich um einen benutzerdefinierten Wert oder einen der folgenden vordefinierten Werte handeln:

  • home
  • work
  • other
formattedType

string

Nur Ausgabe. Der Typ der E-Mail-Adresse, die in der Sprache des Zuschauers oder in der Accept-Language-HTTP-Header-Sprache übersetzt und formatiert wurde.

displayName

string

Der Anzeigename der E-Mail.

Ereignis

Ein Ereignis, das sich auf die Person bezieht.

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. Beim Typ kann es sich um einen benutzerdefinierten Wert oder einen der folgenden vordefinierten Werte handeln:

  • anniversary
  • other
formattedType

string

Nur Ausgabe. Der Typ des Ereignisses, das in der Sprache des Zuschauers oder in der Sprache des HTTP-Headers Accept-Language übersetzt und formatiert wurde.

ExternalId

Eine mit der Person verbundene Kennung einer externen Entität.

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. Beim Typ kann es sich um einen benutzerdefinierten Wert oder einen der folgenden vordefinierten Werte handeln:

  • account
  • customer
  • loginId
  • network
  • organization
formattedType

string

Nur Ausgabe. Der Typ des Ereignisses, das in der Sprache des Zuschauers oder in der Sprache des HTTP-Headers Accept-Language übersetzt und formatiert wurde.

FileAs

Der Name, nach dem die Person in einer Liste sortiert werden soll.

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

object (FieldMetadata)

Metadaten zu „file-as“.

value

string

Der Wert „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 der Person. Das Geschlecht kann benutzerdefiniert sein oder einer der folgenden vordefinierten Werte:

  • male
  • female
  • unspecified
formattedValue

string

Nur Ausgabe. Der Wert des Geschlechts, der in der Sprache des Zuschauers oder im HTTP-Header „Accept-Language“ übersetzt und formatiert wurde. Nicht angegebene oder benutzerdefinierte Werte sind nicht lokalisiert.

addressMeAs

string

Textfeld in freiem Format für Pronomen, mit dem die Person angesprochen werden soll. Gängige Werte sind:

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

ImClient

Der Instant-Messaging-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 Nutzername.

type

string

Der Typ des IM-Clients. Beim Typ kann es sich um einen benutzerdefinierten Wert oder einen der folgenden vordefinierten Werte handeln:

  • home
  • work
  • other
formattedType

string

Nur Ausgabe. Der Typ des IM-Clients, der in die Sprache des Zuschauers oder für den HTTP-Header „Accept-Language“ übersetzt und formatiert wurde.

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, formatiert in der Sprache des Zuschauers oder im HTTP-Header-Gebiet Accept-Language.

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

Die Spracheinstellung einer Person.

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

object (FieldMetadata)

Metadaten zur Sprache.

value

string

Das korrekt formatierte Sprach-Tag IETF BCP 47 für die Sprache.

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

Wert des Standorts im freien Format

type

string

Der Typ des Standorts. Beim Typ kann es sich um einen benutzerdefinierten Wert oder einen der folgenden vordefinierten Werte handeln:

  • desk
  • grewUp
current

boolean

Gibt an, ob es sich bei dem Standort um den aktuellen Standort handelt.

buildingId

string

Die Gebäude-ID.

floor

string

Der Name oder die Etage.

floorSection

string

Der Etagenabschnitt in floor_name.

deskCode

string

Der Standort des einzelnen Desktops.

Mitgliedschaft

Die Mitgliedschaft einer Person in einer Gruppe. Nur Mitgliedschaften in Kontaktgruppen 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 einer Kontaktgruppe.

domainMembership

object (DomainMembership)

Nur Ausgabe. Die Domainmitgliedschaft.

ContactGroupMembership

Mitgliedschaft in einer Google-Kontaktgruppe

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

string

Nur Ausgabe. Die Kontaktgruppen-ID für die Kontaktgruppenmitgliedschaft.

contactGroupResourceName

string

Der vom Server zugewiesene Ressourcenname für die Kontaktgruppe. Ein ASCII-String im Format contactGroups/{contactGroupId}. Nur contactGroupResourceName kann zum Ändern von Mitgliedschaften verwendet werden. Jede Mitgliedschaft in Kontaktgruppe kann entfernt werden, aber nur die Nutzergruppe oder "myContacts" oder "markiert" Mitgliedschaften in Systemgruppen hinzugefügt werden können. Ein Kontakt muss immer mindestens eine Kontaktgruppenzugehörigkeit haben.

DomainMembership

Sie haben eine Google Workspace-Domain.

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

boolean

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

MiscKeyword

Sonstiges Keyword einer Person

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

object (FieldMetadata)

Metadaten zum sonstigen Keyword

value

string

Der Wert des sonstigen Keywords.

type

enum (KeywordType)

Der Keyword-Typ „Sonstiges“.

formattedType

string

Nur Ausgabe. Der Typ des Keywords, das für das Konto des Zuschauers übersetzt und formatiert wurde oder in der Accept-Language-HTTP-Header-Sprache übersetzt wurde.

KeywordType

Art des sonstigen Keywords.

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 die Kilometerzahl.
OUTLOOK_PRIORITY Outlook-Feld für die Priorität.
OUTLOOK_SENSITIVITY Outlook-Feld für Vertraulichkeit.
OUTLOOK_SUBJECT Outlook-Feld für den Betreff.
OUTLOOK_USER Outlook-Feld für Nutzer.
HOME Übersicht
WORK Arbeit.
OTHER Sonstiges

Name

Der Name einer Person. Wenn es sich um einen Einzelnamen handelt, ist das Feld für den Familiennamen 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 in der Sprache formatiert ist, die im Konto des Zuschauers oder im Accept-Language-HTTP-Header angegeben ist.

displayNameLastFirst

string

Nur Ausgabe. Der Anzeigename mit dem Nachnamen, der zuerst gemäß der Sprache formatiert ist, die im Konto des Zuschauers oder im Accept-Language-HTTP-Header angegeben ist.

unstructuredName

string

Der Wert für den Namen im freien Format.

familyName

string

Der Familienname.

givenName

string

Der Vorname.

middleName

string

Zweiter Vorname(n).

honorificPrefix

string

Die Ehrenpräfixe wie Mrs. oder Dr.

honorificSuffix

string

Die ehrenamtlichen Suffixe wie Jr.

phoneticFullName

string

Der vollständige Name, wie er sich anhört.

phoneticFamilyName

string

Der Familienname, wie er klingt.

phoneticGivenName

string

Der Vorname, wie er sich anhört.

phoneticMiddleName

string

Der oder die zweite(r) Vorname(n) wird so buchstabiert, wie sie klingen.

phoneticHonorificPrefix

string

Die buchstabierten Präfixe, wie sie klingen.

phoneticHonorificSuffix

string

Die buchstabierten Suffixe, wie sie klingen.

Alias

Der Spitzname einer Person.

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

object (FieldMetadata)

Metadaten zum Alias.

value

string

Der Spitzname.

type

enum (NicknameType)

Der Typ des Alias.

NicknameType

Die Art eines Alias.

Enums
DEFAULT Generischer Alias.
MAIDEN_NAME

Mädchenname oder Geburtsfamilienname. Wird verwendet, wenn sich der Familienname der Person infolge der Heirat geändert hat.

INITIALS

Initialen.

GPLUS

Nickname für das Google+ Profil.

OTHER_NAME

die Zugehörigkeit zu einer Berufsgruppe oder ein anderer Name; Beispiel: Dr. Smith.

ALTERNATE_NAME Alternativer Name, unter dem die Person bekannt ist.
SHORT_NAME

Eine kürzere Version des Namens der Person.

Beruf

Der Beruf einer Person.

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

object (FieldMetadata)

Metadaten zum Beruf.

value

string

Der Beruf: z. B. carpenter.

Organisation

Die frühere 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

Die Art der Organisation. Beim Typ kann es sich um einen benutzerdefinierten Wert oder einen der folgenden vordefinierten Werte handeln:

  • work
  • school
formattedType

string

Nur Ausgabe. Der Typ der Organisation, der in der Sprache des Zuschauers oder in der Accept-Language-HTTP-Header-Sprache übersetzt und formatiert wurde.

startDate

object (Date)

Das Startdatum, an dem die Person 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 es sich bei der Organisation um eine frühere Organisation handelt.

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 im Unternehmen.

jobDescription

string

Die Stellenbeschreibung der Person in der Organisation.

symbol

string

Symbol für die Organisation beispielsweise ein Börsenkürzel, 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

Kostenstelle der Person in der Organisation.

fullTimeEquivalentMillipercent

integer

Der Milliprozentsatz der Person in Vollzeit in 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. Das kanonische Format ITU-T E.164 der Telefonnummer.

type

string

Der Typ der Telefonnummer. Beim Typ kann es sich um einen benutzerdefinierten Wert oder einen der folgenden vordefinierten Werte handeln:

  • 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 Zuschauers oder in der Accept-Language-HTTP-Header-Sprache übersetzt und formatiert ist.

Foto

Das Foto einer Person. Ein Bild, das neben dem Namen der Person angezeigt wird, 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 den Suchparameter sz={size} an das Ende der URL anhängen, wobei {size} für die Größe in Pixeln steht. Beispiel: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50

default

boolean

"True", wenn das Foto ein Standardfoto ist; 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. Beim Typ kann es sich um einen benutzerdefinierten Wert oder einen der folgenden vordefinierten Werte handeln:

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

string

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

RelationshipInterest

EINGESTELLT: Es werden keine Daten zum Beziehungsinteresse der 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, nach der die Person sucht. Der Wert kann ein benutzerdefinierter Wert oder einer der folgenden vordefinierten Werte sein:

  • friend
  • date
  • relationship
  • networking
formattedValue

string

Nur Ausgabe. Der Wert des Beziehungsinteresses, der in der Sprache des Zuschauers oder in der im HTTP-Header „Accept-Language“ angegebenen Sprache übersetzt und formatiert wurde.

RelationshipStatus

EINGESTELLT: 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 ein benutzerdefinierter Wert 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 Zuschauers oder im HTTP-Header „Accept-Language“ übersetzt und formatiert ist.

Wohnsitz

EINGESTELLT: Bitte verwende stattdessen person.locations. Früherer oder aktueller Wohnsitz einer Person

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

object (FieldMetadata)

Metadaten zum Wohnsitz.

value

string

Die Adresse des Wohnsitzes.

current

boolean

Wahr, wenn es sich bei dem Wohnsitz um den derzeitigen Wohnsitz der Person handelt; false, wenn der Wohnsitz in der Vergangenheit war.

SipAddress

Die SIP-Adresse einer Person. Session Initial Protocol-Adressen werden für die VoIP-Kommunikation verwendet, um Sprach- oder Videoanrufe über das Internet zu tätigen.

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. Beim Typ kann es sich um einen benutzerdefinierten Wert oder einen der folgenden vordefinierten Werte handeln:

  • home
  • work
  • mobile
  • other
formattedType

string

Nur Ausgabe. Der Typ der SIP-Adresse, die in der Sprache des Zuschauers oder in der Accept-Language-HTTP-Header-Sprache übersetzt und formatiert ist.

Skill

Eine Fähigkeit, die die Person besitzt.

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

object (FieldMetadata)

Metadaten zu der Fähigkeit.

value

string

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

Kurzbeschreibung

EINGESTELLT: Es werden keine Daten zurückgegeben. Eine kurze einzeilige Beschreibung der Person.

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. Beim Typ kann es sich um einen benutzerdefinierten Wert oder einen der folgenden vordefinierten Werte handeln:

  • 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 Zuschauers oder in der Accept-Language-HTTP-Header-Sprache übersetzt und formatiert ist.

UserDefined

Beliebige Nutzerdaten, die von den Endnutzern eingefügt 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 PersonResponses für die neuen

Änderungsanfragen für denselben Nutzer sollten sequenziell gesendet werden, um erhöhte Latenz und Fehler zu vermeiden.

batchDeleteContacts

Mehrere Kontakte löschen

batchUpdateContacts

Einen Batch von Kontakten aktualisieren und für die aktualisierten Kontakte eine Karte mit Ressourcennamen an „PersonResponses“ zurückgeben

createContact

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

deleteContact

Löschen Sie eine Kontaktperson.

deleteContactPhoto

Foto eines Kontakts löschen

get

Liefert durch Angabe eines Ressourcennamens Informationen zu einer Person.

getBatchGet

Stellt Informationen zu einer Liste bestimmter Personen bereit, indem eine Liste angeforderter Ressourcennamen angegeben wird.

listDirectoryPeople

Stellt eine Liste der Domainprofile und Domainkontakte im Domainverzeichnis des authentifizierten Nutzers bereit.

searchContacts

Stellt eine Liste der Kontakte in den gruppierten Kontakten des authentifizierten Nutzers bereit, die mit der Suchanfrage übereinstimmen.

searchDirectoryPeople

Stellt eine Liste der Domainprofile und Domainkontakte im Domainverzeichnis des authentifizierten Nutzers bereit, die mit der Suchanfrage übereinstimmen.

updateContact

Kontaktdaten einer vorhandenen Kontaktperson aktualisieren

updateContactPhoto

Aktualisieren Sie das Foto eines Kontakts.