REST Resource: people

Risorsa: persona

Informazioni su una persona unite da varie origini dati, come i contatti e i dati del profilo dell'utente autenticato.

La maggior parte dei campi può avere più elementi. L'ordine degli elementi in un campo non è garantito, ma è garantito che ogni campo non vuoto abbia esattamente un campo con il valore metadata.primary impostato su true.

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

string

Il nome risorsa della persona, assegnato dal server. Una stringa ASCII nel formato people/{person_id}.

etag

string

Il tag entità HTTP della risorsa. Utilizzato per la convalida della cache web.

metadata

object (PersonMetadata)

Solo output. I metadati sulla persona.

addresses[]

object (Address)

Gli indirizzi della persona.

ageRange
(deprecated)

enum (AgeRange)

Solo output. OBSOLETO (utilizza invece person.ageRanges)

La fascia d'età della persona.

ageRanges[]

object (AgeRangeType)

Solo output. Le fasce d'età della persona.

biographies[]

object (Biography)

Le biografie della persona. Questo campo è un singleton per le origini dei contatti.

birthdays[]

object (Birthday)

I compleanni della persona. Questo campo è un singleton per le origini dei contatti.

braggingRights[]
(deprecated)

object (BraggingRights)

OBSOLETO: non verrà restituito alcun dato sulle imprese memorabili della persona.

calendarUrls[]

object (CalendarUrl)

Gli URL dei calendari della persona.

clientData[]

object (ClientData)

I dati del cliente della persona.

coverPhotos[]

object (CoverPhoto)

Solo output. Le foto di copertina della persona.

emailAddresses[]

object (EmailAddress)

Gli indirizzi email della persona. Per people.connections.list e otherContacts.list, il numero di indirizzi email è limitato a 100. Se una persona ha più indirizzi email, l'intero insieme può essere ottenuto chiamando people.getBatchGet.

events[]

object (Event)

Gli eventi della persona.

externalIds[]

object (ExternalId)

Gli ID esterni della persona.

fileAses[]

object (FileAs)

I file della persona.

genders[]

object (Gender)

Il genere della persona. Questo campo è un singleton per le origini dei contatti.

imClients[]

object (ImClient)

I client di messaggistica immediata della persona.

interests[]

object (Interest)

Gli interessi della persona.

locales[]

object (Locale)

Le preferenze internazionali dell'utente.

locations[]

object (Location)

La posizione della persona.

memberships[]

object (Membership)

Le iscrizioni al gruppo della persona.

miscKeywords[]

object (MiscKeyword)

Le parole chiave varie della persona.

names[]

object (Name)

I nomi della persona. Questo campo è un singleton per le origini dei contatti.

nicknames[]

object (Nickname)

I nickname della persona.

occupations[]

object (Occupation)

Le professioni della persona.

organizations[]

object (Organization)

Organizzazioni passate o attuali della persona.

phoneNumbers[]

object (PhoneNumber)

I numeri di telefono della persona. Per people.connections.list e otherContacts.list il numero di telefono è limitato a 100. Se una persona ha più numeri di telefono, l'intero set può essere ottenuto chiamando il numero people.getBatchGet.

photos[]

object (Photo)

Solo output. Le foto della persona.

relations[]

object (Relation)

Le relazioni della persona.

relationshipInterests[]
(deprecated)

object (RelationshipInterest)

Solo output. OBSOLETO: non verranno restituiti dati relativi agli interessi della relazione della persona.

relationshipStatuses[]
(deprecated)

object (RelationshipStatus)

Solo output. OBSOLETO: non verranno restituiti dati relativi agli stati della relazione della persona.

residences[]
(deprecated)

object (Residence)

OBSOLETO: (utilizza invece person.locations) l'indirizzo di residenza della persona.

sipAddresses[]

object (SipAddress)

Gli indirizzi SIP della persona.

skills[]

object (Skill)

Le abilità della persona.

taglines[]
(deprecated)

object (Tagline)

Solo output. OBSOLETO: non verranno restituiti dati dagli slogan della persona.

urls[]

object (Url)

Gli URL associati della persona.

userDefined[]

object (UserDefined)

I dati definiti dall'utente della persona.

PersonMetadata

I metadati relativi a una persona.

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

object (Source)

Le fonti di dati della persona.

previousResourceNames[]

string

Solo output. Eventuali nomi di risorse precedenti per questa persona. Compilato solo per le richieste people.connections.list che includono un token di sincronizzazione.

Il nome della risorsa può cambiare quando aggiungi o rimuovi campi che collegano un contatto e un profilo, ad esempio un indirizzo email verificato, un numero di telefono verificato o un URL del profilo.

linkedPeopleResourceNames[]

string

Solo output. Nomi delle persone collegate a questa risorsa.

deleted

boolean

Solo output. True se la risorsa persona è stata eliminata. Compilato solo per le richieste di sincronizzazione people.connections.list e otherContacts.list.

objectType
(deprecated)

enum (ObjectType)

Solo output. OBSOLETO (utilizza invece person.metadata.sources.profileMetadata.objectType)

Il tipo di oggetto persona.

Origine

L'origine di un campo.

Rappresentazione JSON
{
  "type": enum (SourceType),
  "id": string,
  "etag": string,
  "updateTime": string,

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

enum (SourceType)

Il tipo di origine.

id

string

L'identificatore univoco all'interno del tipo di origine generato dal server.

etag

string

Compilato solo in person.metadata.sources.

Il tag dell'entità HTTP dell'origine. Utilizzato per la convalida della cache web.

updateTime

string (Timestamp format)

Solo output. Compilato solo in person.metadata.sources.

Timestamp dell'ultimo aggiornamento di questa origine.

Un timestamp nel formato RFC3339 UTC "Zulu" con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

Campo unione metadata. Compilato solo in person.metadata.sources.

I metadati sulla fonte. metadata può essere solo uno dei seguenti:

profileMetadata

object (ProfileMetadata)

Solo output. Compilato solo in person.metadata.sources.

Metadati relativi a una sorgente di tipo PROFILE.

SourceType

Il tipo di origine.

Enum
SOURCE_TYPE_UNSPECIFIED Non specificato.
ACCOUNT Account Google.
PROFILE Profilo Google. Puoi visualizzare il profilo all'indirizzo https://profiles.google.com/{id}, dove {id} è l'ID sorgente.
DOMAIN_PROFILE Profilo del dominio Google Workspace.
CONTACT Contatto Google. Puoi visualizzare il contatto all'indirizzo https://contact.google.com/{id}, dove {id} è l'ID sorgente.
OTHER_CONTACT Google "Altro contatto".
DOMAIN_CONTACT Contatto condiviso nel dominio Google Workspace.

ProfileMetadata

I metadati relativi a un profilo.

Rappresentazione JSON
{
  "objectType": enum (ObjectType),
  "userTypes": [
    enum (UserType)
  ]
}
Campi
objectType

enum (ObjectType)

Solo output. Il tipo di oggetto del profilo.

userTypes[]

enum (UserType)

Solo output. I tipi di utente.

ObjectType

Il tipo di un oggetto persona.

Enum
OBJECT_TYPE_UNSPECIFIED Non specificato.
PERSON Persona.
PAGE Pagina Currents.

UserType

Il tipo di utente.

Enum
USER_TYPE_UNKNOWN Il tipo di utente non è noto.
GOOGLE_USER L'utente è un utente Google.
GPLUS_USER L'utente è un utente di Currents.
GOOGLE_APPS_USER L'utente è un utente di Google Workspace.

Indirizzo

L'indirizzo fisico di una persona. Potrebbe essere un P.O. casella postale o indirizzo. Tutti i campi sono facoltativi.

Rappresentazione JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "formattedValue": string,
  "type": string,
  "formattedType": string,
  "poBox": string,
  "streetAddress": string,
  "extendedAddress": string,
  "city": string,
  "region": string,
  "postalCode": string,
  "country": string,
  "countryCode": string
}
Campi
metadata

object (FieldMetadata)

I metadati relativi all'indirizzo.

formattedValue

string

Il valore non strutturato dell'indirizzo. Se non viene impostato dall'utente, verrà creato automaticamente a partire da valori strutturati.

type

string

Il tipo di indirizzo. Il tipo può essere personalizzato o uno di questi valori predefiniti:

  • home
  • work
  • other
formattedType

string

Solo output. Il tipo di indirizzo tradotto e formattato nelle impostazioni internazionali dell'account del visualizzatore o nelle impostazioni internazionali dell'intestazione HTTP Accept-Language.

poBox

string

La sezione P.O. casella dell'indirizzo.

streetAddress

string

L'indirizzo fisico.

extendedAddress

string

L'indirizzo esteso dell'indirizzo; ad esempio il numero dell'appartamento.

city

string

La città dell'indirizzo.

region

string

La regione dell'indirizzo; ad esempio lo stato o la provincia.

postalCode

string

Il codice postale dell'indirizzo.

country

string

Il paese dell'indirizzo.

countryCode

string

Il codice paese ISO 3166-1 alpha-2 dell'indirizzo.

FieldMetadata

I metadati relativi a un campo.

Rappresentazione JSON
{
  "primary": boolean,
  "sourcePrimary": boolean,
  "verified": boolean,
  "source": {
    object (Source)
  }
}
Campi
primary

boolean

Solo output. True se il campo è il campo principale per tutte le origini della persona. Per ogni persona sarà disponibile al massimo un campo con il valore primary impostato su true.

sourcePrimary

boolean

True se il campo è il campo principale per source. Ogni origine deve avere al massimo un campo con sourcePrimary impostato su true.

verified

boolean

Solo output. True se il campo è verificato; false se il campo non è verificato. In genere, un campo verificato è un nome, un indirizzo email, un numero di telefono o un sito web di cui è stata confermata la proprietà della persona.

source

object (Source)

L'origine del campo.

Intervallo età

OBSOLETO (utilizza invece person.ageRanges)

La fascia d'età di una persona.

Enum
AGE_RANGE_UNSPECIFIED Non specificato.
LESS_THAN_EIGHTEEN Ha meno di diciotto anni.
EIGHTEEN_TO_TWENTY Tra i diciotto e i venti anni.
TWENTY_ONE_OR_OLDER Da 21 in su.

AgeRangeType

La fascia d'età di una persona.

Rappresentazione JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "ageRange": enum (AgeRange)
}
Campi
metadata

object (FieldMetadata)

I metadati sulla fascia d'età.

ageRange

enum (AgeRange)

La fascia d'età.

Biografia

La breve biografia di una persona.

Rappresentazione JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "contentType": enum (ContentType)
}
Campi
metadata

object (FieldMetadata)

Metadati sulla biografia.

value

string

La breve biografia.

contentType

enum (ContentType)

Il tipo di contenuti della biografia.

ContentType

Il tipo di contenuti.

Enum
CONTENT_TYPE_UNSPECIFIED Non specificato.
TEXT_PLAIN Testo normale.
TEXT_HTML Testo HTML.

Compleanno

Il compleanno di una persona. È stato specificato almeno uno dei campi date e text. In genere, i campi date e text rappresentano la stessa data, ma non è garantito che questo avvenga. I clienti devono sempre impostare il campo date in caso di modifica dei compleanni.

Rappresentazione JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "date": {
    object (Date)
  },
  "text": string
}
Campi
metadata

object (FieldMetadata)

I metadati sulla data di nascita.

date

object (Date)

La data strutturata della data di nascita.

text
(deprecated)

string

Preferisci utilizzare il campo date, se impostato.

Una stringa in formato libero che rappresenta la data di nascita dell'utente. Questo valore non è convalidato.

Data

Rappresenta una data di calendario intera o parziale, come un compleanno. L'ora del giorno e il fuso orario sono specificati altrove o non sono significativi. La data è relativa al calendario gregoriano. Può trattarsi di uno dei seguenti valori:

  • Una data completa, con valori diversi da zero per anno, mese e giorno.
  • Un mese e un giorno con zero anni (ad esempio, un anniversario).
  • Un anno a sé stante, con uno zero mese e uno zero-day.
  • Un anno e un mese, con zero day (ad esempio, la data di scadenza della carta di credito).

Tipi correlati:

Rappresentazione JSON
{
  "year": integer,
  "month": integer,
  "day": integer
}
Campi
year

integer

Anno della data. Il valore deve essere compreso tra 1 e 9999 oppure 0 per specificare una data senza anno.

month

integer

Mese dell'anno. Il valore deve essere compreso tra 1 e 12 oppure 0 per specificare un anno senza mese e giorno.

day

integer

Giorno di un mese. Deve essere compreso tra 1 e 31 e deve essere valido per l'anno e il mese oppure 0 per specificare un anno da solo o un anno e mese in cui il giorno non è significativo.

BraggingRights

OBSOLETO: non verranno restituiti dati Imprese di imprese memorabili di una persona.

Rappresentazione JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Campi
metadata

object (FieldMetadata)

I metadati sulle imprese che si possono vantare.

value

string

Le imprese che vogliono vantarsi; ad esempio climbed mount everest.

CalendarUrl

L'URL del calendario di una persona.

Rappresentazione JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "url": string,
  "type": string,
  "formattedType": string
}
Campi
metadata

object (FieldMetadata)

Metadati sull'URL del calendario.

url

string

L'URL del calendario.

type

string

Il tipo di URL del calendario. Il tipo può essere personalizzato o uno di questi valori predefiniti:

  • home
  • freeBusy
  • work
formattedType

string

Solo output. Il tipo di URL del calendario tradotto e formattato nelle impostazioni internazionali dell'account del visualizzatore o nelle impostazioni internazionali dell'intestazione HTTP Accept-Language.

ClientData

Dati arbitrariamente client compilati dai client. Sono consentiti valori e chiavi duplicati.

Rappresentazione JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "key": string,
  "value": string
}
Campi
metadata

object (FieldMetadata)

I metadati sui dati del client.

key

string

La chiave specificata dal client dei dati del client.

value

string

Valore dei dati del cliente specificato dal cliente.

CoverPhoto

La foto di copertina di una persona. Un'immagine di grandi dimensioni mostrata nella pagina del profilo di una persona, che rappresenta la sua identità o i suoi interessi.

Rappresentazione JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "url": string,
  "default": boolean
}
Campi
metadata

object (FieldMetadata)

I metadati sulla foto di copertina.

url

string

L'URL della foto di copertina.

default

boolean

True se la foto di copertina è la foto di copertina predefinita; false se la foto di copertina è una foto di copertina fornita dall'utente.

EmailAddress

L'indirizzo email di una persona.

Rappresentazione JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string,
  "displayName": string
}
Campi
metadata

object (FieldMetadata)

I metadati relativi all'indirizzo email.

value

string

L'indirizzo email.

type

string

Il tipo di indirizzo email. Il tipo può essere personalizzato o uno di questi valori predefiniti:

  • home
  • work
  • other
formattedType

string

Solo output. Il tipo di indirizzo email tradotto e formattato nelle impostazioni internazionali dell'account del visualizzatore o nelle impostazioni internazionali dell'intestazione HTTP Accept-Language.

displayName

string

Il nome visualizzato dell'email.

Evento

Un evento correlato alla persona in questione.

Rappresentazione JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "date": {
    object (Date)
  },
  "type": string,
  "formattedType": string
}
Campi
metadata

object (FieldMetadata)

I metadati relativi all'evento.

date

object (Date)

La data dell'evento.

type

string

Il tipo di evento. Il tipo può essere personalizzato o uno di questi valori predefiniti:

  • anniversary
  • other
formattedType

string

Solo output. Il tipo di evento tradotto e formattato nelle impostazioni internazionali dell'account del visualizzatore o nelle impostazioni internazionali dell'intestazione HTTP Accept-Language.

ID Esterno

Un identificatore di un'entità esterna correlata alla persona in questione.

Rappresentazione JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string
}
Campi
metadata

object (FieldMetadata)

Metadati sull'ID esterno.

value

string

Il valore dell'ID esterno.

type

string

Il tipo di ID esterno. Il tipo può essere personalizzato o uno di questi valori predefiniti:

  • account
  • customer
  • loginId
  • network
  • organization
formattedType

string

Solo output. Il tipo di evento tradotto e formattato nelle impostazioni internazionali dell'account del visualizzatore o nelle impostazioni internazionali dell'intestazione HTTP Accept-Language.

FileAs

Il nome da utilizzare per ordinare la persona in un elenco.

Rappresentazione JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Campi
metadata

object (FieldMetadata)

I metadati relativi al file-as.

value

string

Il valore File-as

Genere

Il genere di una persona.

Rappresentazione JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "formattedValue": string,
  "addressMeAs": string
}
Campi
metadata

object (FieldMetadata)

I metadati sul genere.

value

string

Il genere della persona. Il genere può essere personalizzato oppure può utilizzare uno di questi valori predefiniti:

  • male
  • female
  • unspecified
formattedValue

string

Solo output. Il valore del genere tradotto e formattato nelle impostazioni internazionali dell'account del visualizzatore o nelle impostazioni internazionali dell'intestazione HTTP Accept-Language. I valori non specificati o personalizzati non vengono localizzati.

addressMeAs

string

Campo di testo in formato libero per i pronomi da utilizzare per rivolgersi alla persona. I valori comuni sono:

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

ImClient

Client di messaggistica immediata di una persona.

Rappresentazione JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "username": string,
  "type": string,
  "formattedType": string,
  "protocol": string,
  "formattedProtocol": string
}
Campi
metadata

object (FieldMetadata)

I metadati sul client di messaggistica immediata.

username

string

Il nome utente utilizzato nel client di messaggistica immediata.

type

string

Il tipo di client di messaggistica immediata. Il tipo può essere personalizzato o uno di questi valori predefiniti:

  • home
  • work
  • other
formattedType

string

Solo output. Il tipo di client di messaggistica immediata tradotto e formattato nelle impostazioni internazionali dell'account del visualizzatore o nelle impostazioni internazionali dell'intestazione HTTP Accept-Language.

protocol

string

Il protocollo del client di messaggistica immediata. Il protocollo può essere personalizzato oppure può utilizzare uno di questi valori predefiniti:

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

string

Solo output. Il protocollo del client di messaggistica immediata formattato nelle impostazioni internazionali dell'account del visualizzatore o nelle impostazioni internazionali dell'intestazione HTTP Accept-Language.

Interesse

Uno degli interessi della persona.

Rappresentazione JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Campi
metadata

object (FieldMetadata)

I metadati sull'interesse.

value

string

l'interesse; ad esempio stargazing.

Impostazioni internazionali

La lingua preferita di una persona.

Rappresentazione JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Campi
metadata

object (FieldMetadata)

Metadati sulle impostazioni internazionali.

value

string

Il tag corretto per la lingua IETF BCP 47 che rappresenta le impostazioni internazionali.

Località

La posizione di una persona.

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

object (FieldMetadata)

I metadati sulla località.

value

string

Il valore in formato libero della località.

type

string

Il tipo di località. Il tipo può essere personalizzato o uno di questi valori predefiniti:

  • desk
  • grewUp
current

boolean

Se la posizione è la posizione corrente.

buildingId

string

L'identificatore dell'edificio.

floor

string

Il nome o il numero del piano.

floorSection

string

La sezione del piano in floor_name.

deskCode

string

La posizione della singola scrivania.

Abbonamento

L'appartenenza di una persona a un gruppo. È possibile modificare solo le iscrizioni ai gruppi di contatti.

Rappresentazione JSON
{
  "metadata": {
    object (FieldMetadata)
  },

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

object (FieldMetadata)

I metadati sull'abbonamento.

Campo unione membership. L'abbonamento. membership può essere solo uno dei seguenti:
contactGroupMembership

object (ContactGroupMembership)

L'appartenenza al gruppo di contatti.

domainMembership

object (DomainMembership)

Solo output. L'appartenenza al dominio.

ContactGroupMembership

L'iscrizione a un gruppo di contatti Google.

Rappresentazione JSON
{
  "contactGroupId": string,
  "contactGroupResourceName": string
}
Campi
contactGroupId
(deprecated)

string

Solo output. L'ID gruppo di contatti per l'appartenenza al gruppo di contatti.

contactGroupResourceName

string

Il nome della risorsa per il gruppo di contatti, assegnato dal server. Una stringa ASCII, nel formato contactGroups/{contactGroupId}. Per modificare le appartenenze può essere utilizzato solo contactGroupResourceName. È possibile rimuovere qualsiasi iscrizione al gruppo di contatti, ma solo il gruppo di utenti o "i miei contatti" o "speciali" è possibile aggiungere le appartenenze a gruppi di sistema. Un contatto deve avere sempre almeno un'appartenenza a un gruppo di contatti.

DomainMembership

Un abbonamento a un dominio Google Workspace.

Rappresentazione JSON
{
  "inViewerDomain": boolean
}
Campi
inViewerDomain

boolean

True se la persona appartiene al dominio Google Workspace del visualizzatore.

MiscKeyword

La parola chiave variegata di una persona.

Rappresentazione JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": enum (KeywordType),
  "formattedType": string
}
Campi
metadata

object (FieldMetadata)

Metadati sulla parola chiave varie.

value

string

Il valore della parola chiave varie.

type

enum (KeywordType)

Il tipo di parola chiave varie.

formattedType

string

Solo output. Il tipo di parola chiave varie tradotta e formattata nelle impostazioni internazionali dell'account del visualizzatore o nelle impostazioni internazionali dell'intestazione HTTP Accept-Language.

KeywordType

Tipo di parola chiave varie.

Enum
TYPE_UNSPECIFIED Non specificato.
OUTLOOK_BILLING_INFORMATION Campo Outlook per i dati di fatturazione.
OUTLOOK_DIRECTORY_SERVER Campo Outlook per il server di directory.
OUTLOOK_KEYWORD Campo Outlook per la parola chiave.
OUTLOOK_MILEAGE Campo di Outlook per il chilometraggio.
OUTLOOK_PRIORITY Campo Outlook per la priorità.
OUTLOOK_SENSITIVITY Campo di Outlook per la sensibilità.
OUTLOOK_SUBJECT Campo Outlook per l'oggetto.
OUTLOOK_USER Campo Outlook per l'utente.
HOME Home.
WORK Lavoro.
OTHER Altro

Nome

Il nome di una persona. Se il nome è un mononimo, il nome della famiglia è vuoto.

Rappresentazione JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "displayName": string,
  "displayNameLastFirst": string,
  "unstructuredName": string,
  "familyName": string,
  "givenName": string,
  "middleName": string,
  "honorificPrefix": string,
  "honorificSuffix": string,
  "phoneticFullName": string,
  "phoneticFamilyName": string,
  "phoneticGivenName": string,
  "phoneticMiddleName": string,
  "phoneticHonorificPrefix": string,
  "phoneticHonorificSuffix": string
}
Campi
metadata

object (FieldMetadata)

I metadati relativi al nome.

displayName

string

Solo output. Il nome visualizzato formattato in base alle impostazioni internazionali specificate dall'account del visualizzatore o dall'intestazione HTTP Accept-Language.

displayNameLastFirst

string

Solo output. Il nome visualizzato con il cognome creato inizialmente in base alle impostazioni internazionali specificate dall'account del visualizzatore o dall'intestazione HTTP Accept-Language.

unstructuredName

string

Il valore del nome in formato libero.

familyName

string

Il cognome.

givenName

string

Il nome assegnato.

middleName

string

Il secondo nome.

honorificPrefix

string

I prefissi onorifici, ad esempio Mrs. o Dr.

honorificSuffix

string

I suffissi onorifici, ad esempio Jr.

phoneticFullName

string

Il nome completo scritto come sembra.

phoneticFamilyName

string

Come sembra, il nome della famiglia si scrive.

phoneticGivenName

string

Il nome scritto esattamente come sembra.

phoneticMiddleName

string

Il secondo nome o i secondi scritti quando suonano.

phoneticHonorificPrefix

string

I prefissi onorifici vengono scritti mentre suonano.

phoneticHonorificSuffix

string

I suffissi onorifici scritti nel momento esatto in cui suonano.

Nickname

Il nickname di una persona.

Rappresentazione JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": enum (NicknameType)
}
Campi
metadata

object (FieldMetadata)

I metadati relativi al nickname.

value

string

Il nickname.

type

enum (NicknameType)

Il tipo di nickname.

NicknameType

Il tipo di nickname.

Enum
DEFAULT Nickname generico.
MAIDEN_NAME

Cognome da nubile o cognome da nubile. Utilizzato quando il cognome della persona è cambiato in seguito al matrimonio.

INITIALS

Iniziali.

GPLUS

Nickname del profilo Google+.

OTHER_NAME

Affiliazione professionale o altro nome; ad esempio Dr. Smith.

ALTERNATE_NAME Nome alternativo con cui la persona è nota.
SHORT_NAME

Una versione più breve del nome della persona.

Professione

La professione di una persona.

Rappresentazione JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Campi
metadata

object (FieldMetadata)

I metadati sulla professione.

value

string

L'occupazione; ad esempio carpenter.

Organizzazione

L'organizzazione passata o attuale di una persona. Sono consentiti intervalli di date sovrapposti.

Rappresentazione JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "type": string,
  "formattedType": string,
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  },
  "current": boolean,
  "name": string,
  "phoneticName": string,
  "department": string,
  "title": string,
  "jobDescription": string,
  "symbol": string,
  "domain": string,
  "location": string,
  "costCenter": string,
  "fullTimeEquivalentMillipercent": integer
}
Campi
metadata

object (FieldMetadata)

I metadati sull'organizzazione.

type

string

Il tipo di organizzazione. Il tipo può essere personalizzato o uno di questi valori predefiniti:

  • work
  • school
formattedType

string

Solo output. Il tipo di organizzazione tradotto e formattato nelle impostazioni internazionali dell'account del visualizzatore o nelle impostazioni internazionali dell'intestazione HTTP Accept-Language.

startDate

object (Date)

La data di inizio in cui la persona è entrata a far parte dell'organizzazione.

endDate

object (Date)

La data di fine in cui la persona ha lasciato l'organizzazione.

current

boolean

True se l'organizzazione è l'attuale organizzazione della persona; false se l'organizzazione è un'organizzazione precedente.

name

string

Il nome dell'organizzazione.

phoneticName

string

Il nome fonetico dell'organizzazione.

department

string

Il reparto della persona all'interno dell'organizzazione.

title

string

La qualifica della persona presso l'organizzazione.

jobDescription

string

La descrizione dell'incarico assegnato alla persona presso l'organizzazione.

symbol

string

Il simbolo associato all'organizzazione. ad esempio il simbolo di un teleborsa, l'abbreviazione o l'acronimo.

domain

string

Il nome di dominio associato all'organizzazione. ad esempio google.com.

location

string

La sede dell'ufficio dell'organizzazione in cui lavora la persona.

costCenter

string

Il centro di costo della persona presso l'organizzazione.

fullTimeEquivalentMillipercent

integer

Millipercento equivalente a tempo pieno della persona all'interno dell'organizzazione (100.000 = 100%).

Numero di telefono

Il numero di telefono di una persona.

Rappresentazione JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "canonicalForm": string,
  "type": string,
  "formattedType": string
}
Campi
metadata

object (FieldMetadata)

I metadati sul numero di telefono.

value

string

Il numero di telefono.

canonicalForm

string

Solo output. Il formato ITU-T E.164 canonico del numero di telefono.

type

string

Il tipo di numero di telefono. Il tipo può essere personalizzato o uno di questi valori predefiniti:

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

string

Solo output. Il tipo di numero di telefono tradotto e formattato nelle impostazioni internazionali dell'account del visualizzatore o nelle impostazioni internazionali dell'intestazione HTTP Accept-Language.

Foto

La foto di una persona. Un'immagine mostrata accanto al nome della persona per aiutare gli altri a riconoscerla.

Rappresentazione JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "url": string,
  "default": boolean
}
Campi
metadata

object (FieldMetadata)

I metadati sulla foto.

url

string

L'URL della foto. Puoi modificare le dimensioni desiderate aggiungendo un parametro di query sz={size} alla fine dell'URL, dove {size} è la dimensione in pixel. Esempio: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50

default

boolean

True se la foto è una foto predefinita; false se la foto è fornita dall'utente.

Relazione

La relazione di una persona con un'altra persona.

Rappresentazione JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "person": string,
  "type": string,
  "formattedType": string
}
Campi
metadata

object (FieldMetadata)

I metadati sulla relazione.

person

string

Il nome dell'altra persona a cui si riferisce questa relazione.

type

string

La relazione della persona con l'altra persona. Il tipo può essere personalizzato o uno di questi valori predefiniti:

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

string

Solo output. Il tipo di relazione tradotta e formattata nelle impostazioni internazionali dell'account del visualizzatore o in quelle specificate nell'intestazione HTTP Accept-Language.

RelationshipInterest

OBSOLETO: non verranno restituiti dati relativi all'interesse per la relazione di una persona .

Rappresentazione JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "formattedValue": string
}
Campi
metadata

object (FieldMetadata)

I metadati sull'interesse relativo alla relazione.

value

string

Il tipo di rapporto che la persona sta cercando. Il valore può essere personalizzato oppure può utilizzare uno di questi valori predefiniti:

  • friend
  • date
  • relationship
  • networking
formattedValue

string

Solo output. Il valore dell'interesse alla relazione tradotto e formattato nelle impostazioni internazionali dell'account del visualizzatore o in quelle specificate nell'intestazione HTTP Accept-Language.

RelationshipStatus

OBSOLETO: non verranno restituiti dati relativi allo stato della relazione di una persona.

Rappresentazione JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "formattedValue": string
}
Campi
metadata

object (FieldMetadata)

I metadati sullo stato della relazione.

value

string

Lo stato della relazione. Il valore può essere personalizzato oppure può utilizzare uno di questi valori predefiniti:

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

string

Solo output. Il valore dello stato della relazione tradotto e formattato nelle impostazioni internazionali dell'account del visualizzatore o nelle impostazioni internazionali dell'intestazione HTTP Accept-Language.

Residenza

OBSOLETO: usa invece person.locations. Residenza passata o attuale di una persona.

Rappresentazione JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "current": boolean
}
Campi
metadata

object (FieldMetadata)

I metadati sulla residenza.

value

string

L'indirizzo della residenza.

current

boolean

True se la residenza è l'attuale residenza della persona; false se la residenza è una residenza passata.

SipAddress

L'indirizzo SIP di una persona. Gli indirizzi Session Initial Protocol vengono utilizzati per le comunicazioni VoIP che consentono di effettuare chiamate vocali o videochiamate su Internet.

Rappresentazione JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string
}
Campi
metadata

object (FieldMetadata)

I metadati sull'indirizzo SIP.

value

string

L'indirizzo SIP nel formato SIP URI RFC 3261 19.1.

type

string

Il tipo di indirizzo SIP. Il tipo può essere personalizzato oppure può usare uno dei seguenti valori predefiniti:

  • home
  • work
  • mobile
  • other
formattedType

string

Solo output. Il tipo di indirizzo SIP tradotto e formattato nelle impostazioni internazionali dell'account del visualizzatore o nelle impostazioni internazionali dell'intestazione HTTP Accept-Language.

Skill

Una competenza personale della persona.

Rappresentazione JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Campi
metadata

object (FieldMetadata)

I metadati sulla competenza.

value

string

La competenza; ad esempio underwater basket weaving.

Slogan

OBSOLETO: non verranno restituiti dati. Una breve descrizione di una riga della persona.

Rappresentazione JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Campi
metadata

object (FieldMetadata)

I metadati relativi allo slogan.

value

string

Lo slogan.

URL

Gli URL associati di una persona.

Rappresentazione JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string
}
Campi
metadata

object (FieldMetadata)

Metadati relativi all'URL.

value

string

L'URL.

type

string

Il tipo di URL. Il tipo può essere personalizzato o uno di questi valori predefiniti:

  • home
  • work
  • blog
  • profile
  • homePage
  • ftp
  • reservations
  • appInstallPage: sito web per un'applicazione Currents.
  • other
formattedType

string

Solo output. Il tipo di URL tradotto e formattato nelle impostazioni internazionali dell'account del visualizzatore o nelle impostazioni internazionali dell'intestazione HTTP Accept-Language.

UserDefined

Dati utente arbitrari popolati dagli utenti finali.

Rappresentazione JSON
{
  "metadata": {
    object (FieldMetadata)
  },
  "key": string,
  "value": string
}
Campi
metadata

object (FieldMetadata)

I metadati sui dati definiti dall'utente.

key

string

La chiave specificata dall'utente finale dei dati definiti dall'utente.

value

string

Il valore specificato dall'utente finale dei dati definiti dall'utente.

Metodi

batchCreateContacts

Creare un gruppo di nuovi contatti e restituire le PersonResponses per i nuovi

Le richieste di modifica per lo stesso utente devono essere inviate in sequenza per evitare un aumento della latenza e degli errori.

batchDeleteContacts

Eliminare un gruppo di contatti.

batchUpdateContacts

Aggiorna un gruppo di contatti e restituisci una mappa dei nomi delle risorse a PersonResponses per i contatti aggiornati.

createContact

Crea un nuovo contatto e restituisci la risorsa persona per quel contatto.

deleteContact

Eliminare un contatto.

deleteContactPhoto

Eliminare la foto di un contatto.

get

Fornisce informazioni su una persona specificando un nome risorsa.

getBatchGet

Fornisce informazioni su un elenco di persone specifiche specificando un elenco di nomi di risorse richiesti.

listDirectoryPeople

Fornisce un elenco di profili di dominio e contatti di dominio nella directory del dominio dell'utente autenticato.

searchContacts

Fornisce un elenco di contatti nei contatti raggruppati dell'utente autenticato che corrispondono alla query di ricerca.

searchDirectoryPeople

Fornisce un elenco di profili di dominio e contatti di dominio nella directory del dominio dell'utente autenticato corrispondenti alla query di ricerca.

updateContact

Aggiornare i dati di contatto di un contatto esistente.

updateContactPhoto

Aggiorna la foto di un contatto.