REST Resource: people

Ressource: Person

Zusammengeführte Informationen zu einer Person aus verschiedenen Datenquellen, z. B. die Kontakt- und Profildaten des authentifizierten Nutzers

Die meisten Felder können mehrere Elemente enthalten. Die Elemente in einem Feld haben keine garantierte Reihenfolge, aber jedes nicht leere Feld hat 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 (Verwenden Sie 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)

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 Titelbilder der Person

emailAddresses[]

object (EmailAddress)

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 über mehr E-Mail-Adressen verfügt, 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)

Dateispeicher der Person.

genders[]

object (Gender)

Das Geschlecht der Person. Dieses Feld ist ein Singleton-Feld 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)

Den Standort der Person.

memberships[]

object (Membership)

Die Gruppenmitgliedschaften der Person.

miscKeywords[]

object (MiscKeyword)

Die sonstigen Keywords der Person

names[]

object (Name)

Die Namen der Person. 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 mehr Telefonnummern hat, kann der gesamte Satz unter 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 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 verwenden Sie stattdessen person.locations.) Der 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: Die Kurzinfos der Person werden nicht zurückgegeben.

urls[]

object (Url)

Die verknüpften URLs der Person.

userDefined[]

object (UserDefined)

Die benutzerdefinierten Daten der Person.

PersonMetadata

Die Metadaten zu 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 True, 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 (Verwenden Sie 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 Quelltyps, die vom Server generiert wird.

etag

string

Wird 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 Wird nur in person.metadata.sources ausgefüllt.

Zeitstempel der letzten Aktualisierung dieser Quelle.

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

Union-Feld metadata. Wird 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 Wird 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} die Quell-ID ist.
DOMAIN_PROFILE Google Workspace-Domainprofil:
CONTACT Google-Kontakt Sie finden den Kontakt unter https://contact.google.com/{id}, wobei {id} die ID der Quelle ist.
OTHER_CONTACT Anderer Kontakt von Google:
DOMAIN_CONTACT Freigegebener Kontakt für Google Workspace-Domain.

ProfileMetadata

Die Metadaten zu einem Profil.

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

enum (ObjectType)

Nur Ausgabe Der Profilobjekttyp.

userTypes[]

enum (UserType)

Nur Ausgabe Der Nutzer tippt.

ObjectType

Der Typ eines Personenobjekts.

Enums
OBJECT_TYPE_UNSPECIFIED Nicht angegeben
PERSON Person.
PAGE Currents-Seite

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. Dies 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 dies nicht vom Nutzer festgelegt wird, wird es automatisch aus strukturierten Werten erstellt.

type

string

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

  • home
  • work
  • other
formattedType

string

Nur Ausgabe Der Typ der Adresse, übersetzt und formatiert in die Sprache des Kontos des Betrachters oder die 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

Der Ort 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 nach ISO 3166-1 alpha-2 der Adresse.

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. Für jede Person ist maximal ein Feld zulässig, bei dem primary auf „true“ gesetzt ist.

sourcePrimary

boolean

True, wenn das Feld das primäre Feld für source ist. Für jede Quelle darf es höchstens ein Feld geben, bei dem sourcePrimary auf „true“ gesetzt ist.

verified

boolean

Nur Ausgabe „True“, wenn das Feld bestätigt ist, und „false“, wenn es ungeprüft ist. Ein bestätigtes Feld ist in der Regel ein Name, eine E-Mail-Adresse, eine Telefonnummer oder eine Website, bei denen die Inhaberschaft der Person bestätigt wurde.

source

object (Source)

Die Quelle des Felds.

AgeRange

EINGESTELLT (Verwenden Sie stattdessen person.ageRanges.)

Die Altersspanne einer Person.

Enums
AGE_RANGE_UNSPECIFIED Nicht angegeben
LESS_THAN_EIGHTEEN Jünger als 18.
EIGHTEEN_TO_TWENTY Zwischen achtzehn und zwanzig.
TWENTY_ONE_OR_OLDER Einundzwanzig 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 kurze Biografie 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

Geburtstag einer Person. Es ist mindestens eines der Felder date und text angegeben. Die Felder date und text stellen normalerweise dasselbe Datum dar. Dies kann jedoch 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, sollte das Feld date verwendet werden.

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. Dabei kann es sich um einen der folgenden Gründe handeln:

  • Ein vollständiges Datum mit Werten für Jahr, Monat und Tag ungleich null.
  • Monat und Tag mit einem Jahr 0 (z. B. ein Jahrestag).
  • Ein Jahr für sich, mit einem Nullmonat und einem Tag von null.
  • Ein Jahr und ein Monat mit einem 0-Tag (z. B. das 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 sein, um ein Datum ohne Jahr anzugeben.

month

integer

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

day

integer

Tag eines Monats Der Wert muss zwischen 1 und 31 liegen und für das Jahr und den Monat gültig sein. Mit 0 können Sie ein Jahr allein oder ein Jahr und einen Monat angeben, bei dem der Tag keine Bedeutung hat.

BraggingRights

EINGESTELLT: Es werden keine Daten zurückgegeben.

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

Der Typ der Kalender-URL. Der Typ kann benutzerdefiniert oder einer der folgenden vordefinierten Werte sein:

  • home
  • freeBusy
  • work
formattedType

string

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

ClientData

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 Kundendaten.

CoverPhoto

Das Hintergrundbild einer Person. Ein großes Bild auf der Profilseite einer Person, das zeigt, wer diese Person ist oder was ihr wichtig ist.

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

object (FieldMetadata)

Metadaten zum Titelbild.

url

string

Die URL des Titelbildes.

default

boolean

„True“, wenn das Hintergrundbild das Standardtitelbild ist, und „false“, wenn es sich um ein vom Nutzer bereitgestelltes Titelbild handelt.

EmailAddress

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. Der Typ kann benutzerdefiniert oder einer der folgenden vordefinierten Werte sein:

  • home
  • work
  • other
formattedType

string

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

displayName

string

Der Anzeigename der E-Mail.

Veranstaltung

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. Der Typ kann benutzerdefiniert oder einer der folgenden vordefinierten Werte sein:

  • anniversary
  • other
formattedType

string

Nur Ausgabe Der Typ des Ereignisses, übersetzt und formatiert in die Sprache des Betrachters für das Konto oder die Sprache des HTTP-Headers Accept-Language.

ExternalId

Eine Kennung von einer externen Entität, die mit der Person in Verbindung steht.

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. Der Typ kann benutzerdefiniert oder einer der folgenden vordefinierten Werte sein:

  • account
  • customer
  • loginId
  • network
  • organization
formattedType

string

Nur Ausgabe Der Typ des Ereignisses, übersetzt und formatiert in die Sprache des Betrachters für das Konto oder die Sprache des HTTP-Headers Accept-Language.

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

Wert für „Datei als“

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 oder einer der folgenden vordefinierten Werte sein:

  • male
  • female
  • unspecified
formattedValue

string

Nur Ausgabe Der Wert des Geschlechts übersetzt und formatiert in die Sprache des Kontos des Zuschauers oder die Sprache des HTTP-Headers Accept-Language. Nicht angegebene oder benutzerdefinierte Werte sind nicht lokalisiert.

addressMeAs

string

Kostenloses Textfeld für Pronomen, mit dem die Person angesprochen werden soll. Häufige 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. Der Typ kann benutzerdefiniert oder einer der folgenden vordefinierten Werte sein:

  • home
  • work
  • other
formattedType

string

Nur Ausgabe Der Typ des IM-Clients, der in die Sprache des Betrachters für das Konto oder in die Sprache des HTTP-Headers Accept-Language übersetzt und formatiert wird.

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, das in der Sprache des Kontos des Betrachters oder im HTTP-Header Accept-Language formatiert ist.

Interesse

Eines der Interessen der Person.

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

object (FieldMetadata)

Metadaten zu den Interessen.

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 wohlgeformte Tag für die Sprache 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 Ort.

value

string

Der Wert im freien Format des Standorts.

type

string

Der Typ des Standorts. Der Typ kann benutzerdefiniert 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

Etagenabschnitt in floor_name.

deskCode

string

Der Standort des jeweiligen Arbeitsplatzes.

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 der Kontaktgruppe

domainMembership

object (DomainMembership)

Nur Ausgabe Die Domainmitgliedschaft.

ContactGroupMembership

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}. Zum Ändern von Mitgliedschaften kann nur „contactGroupResourceName“ verwendet werden. Jede Mitgliedschaft in einer Kontaktgruppe kann entfernt werden, aber nur Mitgliedschaften in Benutzergruppen, "myContacts" oder "markierte" Systemgruppen können hinzugefügt werden. Ein Kontakt muss immer mindestens eine Mitgliedschaft in einer Kontaktgruppe haben.

DomainMembership

Sie haben eine Google Workspace-Domain abonniert.

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

boolean

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

MiscKeyword

Als 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

Wert des Keywords sonstiger Wert

type

enum (KeywordType)

Der sonstige Keyword-Typ.

formattedType

string

Nur Ausgabe Der Typ des sonstigen Keywords, der in die Sprache des Betrachters des Kontos oder in die Sprache des HTTP-Headers Accept-Language übersetzt und formatiert 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 den Kilometerstand.
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 den 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äß der vom Konto des Zuschauers oder im Accept-Language-HTTP-Header angegebenen Sprache formatiert ist.

displayNameLastFirst

string

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

unstructuredName

string

Der Wert des Namens in freiem Format.

familyName

string

Der Familienname.

givenName

string

Der Vorname.

middleName

string

Zweiter Vorname(n)

honorificPrefix

string

Die Ehrenpräfixe, z. B. Mrs. oder Dr.

honorificSuffix

string

Die Ehrensuffixe, z. B. Jr.

phoneticFullName

string

Vollständiger Name, wie er buchstabiert wird

phoneticFamilyName

string

Der Familienname, der so buchstabiert wird, wie er klingt.

phoneticGivenName

string

Der Vorname, wie er buchstabiert wird

phoneticMiddleName

string

Zweiter Vorname(n), der/die so buchstabiert werden, wie er klingen soll.

phoneticHonorificPrefix

string

Die Ehrenpräfixe, die so buchstabiert werden, wie sie klingen.

phoneticHonorificSuffix

string

Die Ehrensuffixe, die so buchstabiert werden, 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 Alias.

type

enum (NicknameType)

Der Typ des Alias.

NicknameType

Der Typ eines Alias.

Enums
DEFAULT Allgemeiner Spitzname.
MAIDEN_NAME

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

INITIALS

Initialen

GPLUS

Alias des Google+ Profils.

OTHER_NAME

Eine berufliche Zugehörigkeit oder ein anderer Name, z. B. Dr. Smith.

ALTERNATE_NAME Alternativer Name für die Person, unter der bekannt ist
SHORT_NAME

Eine kürzere Version des Namens einer Person.

Beruf

Den Beruf einer Person.

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

object (FieldMetadata)

Metadaten zur Tätigkeit.

value

string

Den Beruf. Beispiel: carpenter.

Organisation

Die vergangene oder aktuelle Organisation einer Person. Zeiträume, die sich überschneiden, 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. Der Typ kann benutzerdefiniert oder einer der folgenden vordefinierten Werte sein:

  • work
  • school
formattedType

string

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

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

title

string

Die Berufsbezeichnung der Person im Unternehmen.

jobDescription

string

Die Stellenbeschreibung der Person im Unternehmen.

symbol

string

Das mit der Organisation verbundene 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 Büros der Organisation, in dem die Person arbeitet.

costCenter

string

Die Kostenstelle der Person im Unternehmen.

fullTimeEquivalentMillipercent

integer

den Vollzeit-Äquivalent einer Person innerhalb des Unternehmens (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 Form der Telefonnummer gemäß ITU-T E.164.

type

string

Der Typ der Telefonnummer. Der Typ kann benutzerdefiniert 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, übersetzt und in die Sprache des Betrachters für das Konto oder in die Sprache des HTTP-Headers Accept-Language übersetzt und formatiert werden.

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 den Abfrageparameter sz={size} anhängen. Dabei ist {size} die Größe in Pixeln. Beispiel: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50

default

boolean

„True“, wenn das Foto ein Standardfoto ist, und „false“, wenn das Foto ein von einem 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. Der Typ kann benutzerdefiniert 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 Der Typ der Beziehung, übersetzt und formatiert in die Sprache des Kontos des Betrachters oder die im „Accept-Language“-HTTP-Header angegebene Sprache.

RelationshipInterest

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

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

object (FieldMetadata)

Metadaten zur Beziehungsinteressen.

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 übersetzt und formatiert in die Sprache des Kontos des Betrachters oder die im „Accept-Language“-HTTP-Header angegebene Sprache.

RelationshipStatus

EINGESTELLT: Der Beziehungsstatus einer Person wird nicht 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 übersetzt und formatiert in die Sprache des Kontos des Betrachters oder die Sprache des HTTP-Headers Accept-Language.

Wohnsitz

EINGESTELLT: Verwenden Sie 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

True, wenn der Wohnsitz der aktuelle Wohnsitz der Person ist; false, wenn es sich um einen früheren Wohnsitz handelt.

SipAddress

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 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. Der Typ kann benutzerdefiniert oder einer der folgenden vordefinierten Werte sein:

  • home
  • work
  • mobile
  • other
formattedType

string

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

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

Die verknüpften 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. Der Typ kann benutzerdefiniert 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 die Sprache des Kontos des Betrachters oder die Sprache des HTTP-Headers Accept-Language übersetzt und formatiert wurde.

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 Stapel neuer Kontakte und geben Sie die PersonResponses für die neuen

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

batchDeleteContacts

Lösche einen Batch von Kontakten.

batchUpdateContacts

Einen Batch von Kontakten aktualisieren und eine Zuordnung von Ressourcennamen an PersonResponses für die aktualisierten Kontakte zurückgeben.

createContact

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

deleteContact

Eine Kontaktperson löschen.

deleteContactPhoto

Foto eines Kontakts löschen

get

Liefert Informationen zu einer Person durch Angabe eines Ressourcennamens.

getBatchGet

Liefert Informationen über eine Liste bestimmter Personen durch Angabe einer Liste angeforderter Ressourcennamen.

listDirectoryPeople

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

searchContacts

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

searchDirectoryPeople

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

updateContact

Aktualisieren Sie die Kontaktdaten einer vorhandenen Kontaktperson.

updateContactPhoto

Foto eines Kontakts aktualisieren