REST Resource: people

Ressource: Person

Informations sur une personne fusionnées à partir de différentes sources de données, telles que les contacts et les données de profil de l'utilisateur authentifié.

La plupart des champs peuvent comporter plusieurs éléments. L'ordre des éléments dans un champ n'est pas garanti, mais chaque champ non vide comportera exactement un champ avec metadata.primary défini sur "true".

Représentation 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)
    }
  ]
}
Champs
resourceName

string

Nom de ressource de la personne, attribué par le serveur. Chaîne ASCII au format people/{person_id}.
etag

string

Tag d'entité HTTP de la ressource. Utilisé pour la validation du cache Web.
metadata

object (PersonMetadata)

Uniquement en sortie. Métadonnées sur la personne.
addresses[]

object (Address)

Les adresses postales de la personne
ageRange
(deprecated)

enum (AgeRange)

Uniquement en sortie. OBSOLÈTE (Veuillez utiliser person.ageRanges à la place.)

Tranche d'âge de la personne
ageRanges[]

object (AgeRangeType)

Uniquement en sortie. Tranches d'âge de la personne
biographies[]

object (Biography)

Ses biographies Ce champ est un singleton pour les sources des contacts.
birthdays[]

object (Birthday)

Anniversaires de la personne Ce champ est un singleton pour les sources des contacts.
braggingRights[]
(deprecated)

object (BraggingRights)

OBSOLÈTE: Aucune donnée ne sera renvoyée. Les plus belles réussites de la personne.
calendarUrls[]

object (CalendarUrl)

URL de l'agenda de la personne.
clientData[]

object (ClientData)

Les données client de la personne.
coverPhotos[]

object (CoverPhoto)

Uniquement en sortie. Photos de couverture de la personne
emailAddresses[]

object (EmailAddress)

Adresses e-mail de la personne. Pour people.connections.list et otherContacts.list, le nombre d'adresses e-mail est limité à 100. Si une personne possède plusieurs adresses e-mail, l'ensemble peut être obtenu en appelant people.getBatchGet.
events[]

object (Event)

les événements de cette personne ;
externalIds[]

object (ExternalId)

ID externes de la personne
fileAses[]

object (FileAs)

Fichiers File-ases de la personne.
genders[]

object (Gender)

Genre de la personne Ce champ est un singleton pour les sources des contacts.
imClients[]

object (ImClient)

Les clients de messagerie instantanée de l'utilisateur
interests[]

object (Interest)

Centres d'intérêt de l'utilisateur
locales[]

object (Locale)

Préférences régionales de l'utilisateur
locations[]

object (Location)

Positions géographiques de la personne
memberships[]

object (Membership)

Les adhésions à des groupes de la personne.
miscKeywords[]

object (MiscKeyword)

Les différents mots clés de l'internaute
names[]

object (Name)

Le nom de la personne Ce champ est un singleton pour les sources des contacts.
nicknames[]

object (Nickname)

Les pseudos de la personne.
occupations[]

object (Occupation)

Professions de la personne.
organizations[]

object (Organization)

Organisations passées ou actuelles de la personne
phoneNumbers[]

object (PhoneNumber)

Numéros de téléphone de la personne. Pour people.connections.list et otherContacts.list, le nombre de numéros de téléphone est limité à 100. Si une personne possède plusieurs numéros de téléphone, l'ensemble complet peut être obtenu en appelant people.getBatchGet.
photos[]

object (Photo)

Uniquement en sortie. Photos de la personne
relations[]

object (Relation)

Les relations de la personne.
relationshipInterests[]
(deprecated)

object (RelationshipInterest)

Uniquement en sortie. OBSOLÈTE: aucune donnée ne sera renvoyée concernant les intérêts amoureux de la personne.
relationshipStatuses[]
(deprecated)

object (RelationshipStatus)

Uniquement en sortie. OBSOLÈTE: Aucune donnée ne sera renvoyée concernant les états de relation de la personne.
residences[]
(deprecated)

object (Residence)

OBSOLÈTE: (Veuillez utiliser plutôt person.locations) Le lieu de résidence de la personne.
sipAddresses[]

object (SipAddress)

Adresses SIP de la personne.
skills[]

object (Skill)

Les compétences de la personne.
taglines[]
(deprecated)

object (Tagline)

Uniquement en sortie. OBSOLÈTE: Aucune donnée ne sera renvoyée pour les slogans de la personne.
urls[]

object (Url)

URL associées à la personne.
userDefined[]

object (UserDefined)

Données définies par l'utilisateur de l'utilisateur.

PersonMetadata

Métadonnées sur une personne.

Représentation JSON 
{
  "sources": [
    {
      object (Source)
    }
  ],
  "previousResourceNames": [
    string
  ],
  "linkedPeopleResourceNames": [
    string
  ],
  "deleted": boolean,
  "objectType": enum (ObjectType)
}
Champs
sources[]

object (Source)

Sources des données de la personne.
previousResourceNames[]

string

Uniquement en sortie. Tous les anciens noms de ressources que cette personne a eus. Renseigné uniquement pour les requêtes people.connections.list qui incluent un jeton de synchronisation.

Le nom de la ressource peut changer lorsque vous ajoutez ou supprimez des champs qui associent un contact à un profil, comme une adresse e-mail validée, un numéro de téléphone validé ou une URL de profil.
linkedPeopleResourceNames[]

string

Uniquement en sortie. Noms de ressources des personnes associées à cette ressource.
deleted

boolean

Uniquement en sortie. "True" si la ressource de personne a été supprimée. Renseigné uniquement pour les requêtes de synchronisation people.connections.list et otherContacts.list.
objectType
(deprecated)

enum (ObjectType)

Uniquement en sortie. OBSOLÈTE (Veuillez utiliser person.metadata.sources.profileMetadata.objectType à la place.)

Type de l'objet personne.

Source

Source d'un champ.

Représentation 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.
}
Champs
type

enum (SourceType)

Type de source.
id

string

Identifiant unique du type de source généré par le serveur.
etag

string

Renseigné uniquement dans person.metadata.sources.

Tag d'entité HTTP de la source. Utilisé pour la validation du cache Web.
updateTime

string (Timestamp format)

Uniquement en sortie. Renseigné uniquement dans person.metadata.sources.

Code temporel de la dernière mise à jour de cette source.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

Champ d'union metadata. Renseigné uniquement dans person.metadata.sources.

Métadonnées sur la source. metadata ne peut être qu'un des éléments suivants :
profileMetadata

object (ProfileMetadata)

Uniquement en sortie. Renseigné uniquement dans person.metadata.sources.

Métadonnées sur une source de type PROFILE.

SourceType

Type d'une source.

Enums
SOURCE_TYPE_UNSPECIFIED Non spécifié.
ACCOUNT Un compte Google
PROFILE Profil Google : Vous pouvez consulter le profil à l'adresse https://profiles.google.com/{id}, où {id} correspond à l'ID de la source.
DOMAIN_PROFILE Profil du domaine Google Workspace
CONTACT Contact Google : Vous pouvez consulter le contact sur la page https://contact.google.com/{id}, où {id} correspond à l'ID de la source.
OTHER_CONTACT "Autre contact" de Google :
DOMAIN_CONTACT Contact partagé du domaine Google Workspace

ProfileMetadata

Métadonnées associées à un profil.

Représentation JSON 
{
  "objectType": enum (ObjectType),
  "userTypes": [
    enum (UserType)
  ]
}
Champs
objectType

enum (ObjectType)

Uniquement en sortie. Type d'objet de profil.
userTypes[]

enum (UserType)

Uniquement en sortie. L'utilisateur saisit.

ObjectType

Type d'objet de personne.

Enums
OBJECT_TYPE_UNSPECIFIED Non spécifié.
PERSON Personne.
PAGE Page Currents :

UserType

Type d'utilisateur.

Enums
USER_TYPE_UNKNOWN Le type d'utilisateur est inconnu.
GOOGLE_USER L'utilisateur est un utilisateur Google.
GPLUS_USER L'utilisateur est un utilisateur Currents.
GOOGLE_APPS_USER L'utilisateur est un utilisateur Google Workspace.

Adresse

Adresse physique d'une personne. Il peut s'agir d'un bon ou une adresse postale. Tous les champs sont facultatifs.

Représentation 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
}
Champs
metadata

object (FieldMetadata)

Métadonnées sur l'adresse.
formattedValue

string

Valeur non structurée de l'adresse. Si cette valeur n'est pas définie par l'utilisateur, elle sera automatiquement créée à partir de valeurs structurées.
type

string

Type d'adresse. Le type peut être personnalisé ou l'une des valeurs prédéfinies suivantes:

  • home
  • work
  • other
formattedType

string

Uniquement en sortie. Type de l'adresse traduite et mise en forme dans les paramètres régionaux du compte de l'utilisateur ou dans les paramètres régionaux de l'en-tête HTTP Accept-Language.
poBox

string

Le P.O. de l'adresse.
streetAddress

string

Adresse postale.
extendedAddress

string

Adresse étendue de l'adresse par exemple, le numéro d'appartement.
city

string

Ville de l'adresse.
region

string

Région de l'adresse par exemple l'État ou la province.
postalCode

string

Code postal de l'adresse.
country

string

Pays de l'adresse.
countryCode

string

Code pays ISO 3166-1 alpha-2 de l'adresse.

FieldMetadata

Métadonnées sur un champ.

Représentation JSON 
{
  "primary": boolean,
  "sourcePrimary": boolean,
  "verified": boolean,
  "source": {
    object (Source)
  }
}
Champs
primary

boolean

Uniquement en sortie. "True" si le champ est le champ principal pour toutes les sources de la personne. Chaque personne disposera au maximum d'un champ pour lequel primary sera défini sur "true".
sourcePrimary

boolean

"True" si le champ est le champ principal de source. Chaque source doit comporter au maximum un champ pour lequel sourcePrimary est défini sur "true".
verified

boolean

Uniquement en sortie. "True" si le champ est validé. "false" si le champ n'est pas validé. Un champ validé correspond généralement à un nom, une adresse e-mail, un numéro de téléphone ou un site Web dont l'appartenance à la personne a été confirmée.
source

object (Source)

Source du champ.

Âge

OBSOLÈTE (Veuillez utiliser person.ageRanges à la place.)

Tranche d'âge d'une personne.

Enums
AGE_RANGE_UNSPECIFIED Non spécifié.
LESS_THAN_EIGHTEEN De moins de dix-huit ans.
EIGHTEEN_TO_TWENTY Entre dix-huit et vingt ans.
TWENTY_ONE_OR_OLDER 21 ans et plus.

AgeRangeType

Tranche d'âge d'une personne.

Représentation JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "ageRange": enum (AgeRange)
}
Champs
metadata

object (FieldMetadata)

Métadonnées sur la tranche d'âge.
ageRange

enum (AgeRange)

Tranche d'âge.

Biographie

Courte biographie d'une personne.

Représentation JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "contentType": enum (ContentType)
}
Champs
metadata

object (FieldMetadata)

Métadonnées sur la biographie.
value

string

Brève biographie.
contentType

enum (ContentType)

Type de contenu de la biographie.

ContentType

Type de contenu.

Enums
CONTENT_TYPE_UNSPECIFIED Non spécifié.
TEXT_PLAIN Texte brut.
TEXT_HTML Texte HTML.

Anniversaire

Anniversaire d'une personne. Au moins l'un des champs date et text est spécifié. Les champs date et text représentent généralement la même date, mais cela n'est pas garanti. Les clients doivent toujours définir le champ date lors de la mutation d'anniversaires.

Représentation JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "date": {
    object (Date)
  },
  "text": string
}
Champs
metadata

object (FieldMetadata)

Métadonnées sur l'anniversaire.
date

object (Date)

Date structurée de l'anniversaire.
text
(deprecated)

string

Il est préférable d'utiliser le champ date s'il est défini.

Chaîne au format libre représentant la date de naissance de l'utilisateur. Cette valeur n'est pas validée.

Date

Représente une date du calendrier entière ou partielle, par exemple un anniversaire. L'heure de la journée et le fuseau horaire sont spécifiés ailleurs, ou ne sont pas significatifs. La date est donnée selon le calendrier grégorien. Il peut s'agir de l'un des éléments suivants:

  • Une date complète, avec des valeurs non nulles pour l'année, le mois et le jour.
  • Un mois et un jour, avec une année nulle (par exemple, un anniversaire).
  • une année seule, avec un mois et un jour zéro.
  • Une année et un mois, avec un jour zéro (par exemple, la date d'expiration d'une carte de crédit).

Types associés:

Représentation JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Champs
year

integer

Année de la date. Doit être comprise entre 1 et 9999, ou 0 pour indiquer une date sans année.
month

integer

Mois de l'année. La valeur doit être comprise entre 1 et 12, ou égale à 0 pour spécifier une année sans mois ni jour.
day

integer

Jour du mois. Doit être compris entre 1 et 31, et valide pour l'année et le mois, ou 0 pour indiquer une année seule, ou une année et un mois où le jour n'est pas significatif.

BraggingRights

OBSOLÈTE: Aucune donnée ne sera renvoyée. Les plus belles réussites d'une personne.

Représentation JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Champs
metadata

object (FieldMetadata)

Métadonnées sur vos plus belles réussites.
value

string

Les plus belles réussites Exemple : climbed mount everest.

CalendarUrl

URL de l'agenda d'une personne.

Représentation JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "url": string,
  "type": string,
  "formattedType": string
}
Champs
metadata

object (FieldMetadata)

Métadonnées sur l'URL de l'agenda.
url

string

URL de l'agenda.
type

string

Type d'URL de l'agenda. Le type peut être personnalisé ou l'une des valeurs prédéfinies suivantes:

  • home
  • freeBusy
  • work
formattedType

string

Uniquement en sortie. Type d'URL d'agenda traduit et formaté dans les paramètres régionaux du compte de l'utilisateur ou dans les paramètres régionaux de l'en-tête HTTP Accept-Language.

ClientData

Données client arbitraires remplies par les clients. Les clés et valeurs en double sont autorisées.

Représentation JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "key": string,
  "value": string
}
Champs
metadata

object (FieldMetadata)

Métadonnées sur les données client.
key

string

Clé des données du client spécifiée par le client.
value

string

Valeur des données client spécifiée par le client.

CoverPhoto

Photo de couverture d'une personne. Une grande image affichée sur la page de profil d'une personne qui représente qui elle est ou ce qui l'intéresse.

Représentation JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "url": string,
  "default": boolean
}
Champs
metadata

object (FieldMetadata)

Métadonnées de la photo de couverture.
url

string

URL de la photo de couverture.
default

boolean

"True" si la photo de couverture est la photo de couverture par défaut. "false" si la photo de couverture est fournie par l'utilisateur.

EmailAddress

Adresse e-mail d'une personne.

Représentation JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string,
  "displayName": string
}
Champs
metadata

object (FieldMetadata)

Métadonnées sur l'adresse e-mail.
value

string

Adresse e-mail.
type

string

Type d'adresse e-mail. Le type peut être personnalisé ou l'une des valeurs prédéfinies suivantes:

  • home
  • work
  • other
formattedType

string

Uniquement en sortie. Type d'adresse e-mail traduit et formaté dans les paramètres régionaux du compte de l'utilisateur ou dans les paramètres régionaux de l'en-tête HTTP Accept-Language.
displayName

string

Nom à afficher de l'e-mail.

Événement

Événement lié à la personne.

Représentation JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "date": {
    object (Date)
  },
  "type": string,
  "formattedType": string
}
Champs
metadata

object (FieldMetadata)

Métadonnées sur l'événement.
date

object (Date)

Date de l'événement.
type

string

Le type d'événement. Le type peut être personnalisé ou l'une des valeurs prédéfinies suivantes:

  • anniversary
  • other
formattedType

string

Uniquement en sortie. Type d'événement traduit et formaté dans les paramètres régionaux du compte de l'utilisateur ou dans les paramètres régionaux de l'en-tête HTTP Accept-Language.

Identifiant externe

Identifiant d'une entité externe liée à la personne.

Représentation JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string
}
Champs
metadata

object (FieldMetadata)

Métadonnées sur l'ID externe.
value

string

Valeur de l'ID externe.
type

string

Type de l'ID externe. Le type peut être personnalisé ou l'une des valeurs prédéfinies suivantes:

  • account
  • customer
  • loginId
  • network
  • organization
formattedType

string

Uniquement en sortie. Type d'événement traduit et formaté dans les paramètres régionaux du compte de l'utilisateur ou dans les paramètres régionaux de l'en-tête HTTP Accept-Language.

FileAs

Nom à utiliser pour trier la personne dans une liste.

Représentation JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Champs
metadata

object (FieldMetadata)

Métadonnées sur le fichier "file-as".
value

string

Valeur de fichier en tant que

Sexe

Genre d'une personne

Représentation JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "formattedValue": string,
  "addressMeAs": string
}
Champs
metadata

object (FieldMetadata)

Métadonnées sur le genre.
value

string

Genre de la personne. Il peut s'agir d'un critère de sexe personnalisé ou de l'une des valeurs prédéfinies suivantes:

  • male
  • female
  • unspecified
formattedValue

string

Uniquement en sortie. Valeur du sexe traduite et mise en forme dans les paramètres régionaux du compte de l'utilisateur ou dans les paramètres régionaux de l'en-tête HTTP Accept-Language. Les valeurs non spécifiées ou personnalisées ne sont pas localisées.
addressMeAs

string

Champ de texte libre pour les pronoms à utiliser pour s'adresser à la personne. Les valeurs les plus courantes sont les suivantes:

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

ImClient

Client de messagerie instantanée d'une personne.

Représentation JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "username": string,
  "type": string,
  "formattedType": string,
  "protocol": string,
  "formattedProtocol": string
}
Champs
metadata

object (FieldMetadata)

Métadonnées sur le client de messagerie instantanée.
username

string

Nom d'utilisateur utilisé dans le client de messagerie instantanée.
type

string

Type du client de messagerie instantanée. Le type peut être personnalisé ou l'une des valeurs prédéfinies suivantes:

  • home
  • work
  • other
formattedType

string

Uniquement en sortie. Type de client de messagerie instantanée traduit et formaté dans les paramètres régionaux du compte de l'utilisateur ou dans les paramètres régionaux de l'en-tête HTTP Accept-Language.
protocol

string

Protocole du client de messagerie instantanée. Le protocole peut être personnalisé ou l'une des valeurs prédéfinies suivantes:

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

string

Uniquement en sortie. Protocole du client de messagerie instantanée formaté dans les paramètres régionaux du compte de l'utilisateur ou dans les paramètres régionaux de l'en-tête HTTP Accept-Language.

Centre d'intérêt

Un des centres d'intérêt de la personne

Représentation JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Champs
metadata

object (FieldMetadata)

Métadonnées sur le centre d'intérêt.
value

string

L'intérêt ; Exemple : stargazing.

Paramètres régionaux

Les préférences régionales d'une personne.

Représentation JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Champs
metadata

object (FieldMetadata)

Métadonnées sur les paramètres régionaux.
value

string

Balise de langue IETF BCP 47 correctement formatée représentant les paramètres régionaux.

Lieu

Position géographique d'une personne.

Représentation JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "current": boolean,
  "buildingId": string,
  "floor": string,
  "floorSection": string,
  "deskCode": string
}
Champs
metadata

object (FieldMetadata)

Métadonnées sur l'établissement.
value

string

Valeur au format libre du lieu.
type

string

Type de lieu. Le type peut être personnalisé ou l'une des valeurs prédéfinies suivantes:

  • desk
  • grewUp
current

boolean

Indique si la position correspond à la position actuelle.
buildingId

string

Identifiant du bâtiment.
floor

string

Nom ou numéro de l'étage.
floorSection

string

Section de l'étage dans floor_name.
deskCode

string

L'emplacement du bureau individuel.

Abonnement

Appartenance d'une personne à un groupe. Seules les adhésions aux groupes de contacts peuvent être modifiées.

Représentation 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.
}
Champs
metadata

object (FieldMetadata)

Métadonnées sur l'appartenance.
Champ d'union membership. L'abonnement. membership ne peut être qu'un des éléments suivants :
contactGroupMembership

object (ContactGroupMembership)

Appartenance au groupe de contacts.
domainMembership

object (DomainMembership)

Uniquement en sortie. L'appartenance au domaine.

ContactGroupMembership

Appartenance à un groupe de contacts Google.

Représentation JSON 
{
  "contactGroupId": string,
  "contactGroupResourceName": string
}
Champs
contactGroupId
(deprecated)

string

Uniquement en sortie. ID du groupe de contacts correspondant à l'appartenance au groupe de contacts.
contactGroupResourceName

string

Nom de ressource du groupe de contacts, attribué par le serveur. Chaîne ASCII, au format contactGroups/{contactGroupId}. Seul contactGroupResourceName peut être utilisé pour modifier les adhésions. Tous les membres d'un groupe de contacts peuvent être supprimés, mais seuls le groupe d'utilisateurs ou "myContacts" sont supprimés. ou "ajoutés aux favoris" des adhésions à des groupes système peuvent être ajoutées. Un contact doit toujours avoir au moins un groupe de contacts.

DomainMembership

Vous devez être membre d'un domaine Google Workspace.

Représentation JSON 
{
  "inViewerDomain": boolean
}
Champs
inViewerDomain

boolean

Vrai si la personne fait partie du domaine Google Workspace de l'utilisateur.

MiscKeyword

Mot clé divers d'une personne.

Représentation JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": enum (KeywordType),
  "formattedType": string
}
Champs
metadata

object (FieldMetadata)

Métadonnées sur les mots clés "Divers".
value

string

Valeur du mot clé "divers".
type

enum (KeywordType)

Type de mot clé "Divers".
formattedType

string

Uniquement en sortie. Type de mot clé divers traduit et formaté dans les paramètres régionaux du compte de l'utilisateur ou dans les paramètres régionaux de l'en-tête HTTP Accept-Language.

KeywordType

Type de mot clé divers.

Enums
TYPE_UNSPECIFIED Non spécifié.
OUTLOOK_BILLING_INFORMATION Champ Outlook pour les informations de facturation.
OUTLOOK_DIRECTORY_SERVER Champ Outlook du serveur d'annuaire.
OUTLOOK_KEYWORD Champ Outlook pour le mot clé.
OUTLOOK_MILEAGE Champ de prévision du kilométrage.
OUTLOOK_PRIORITY Champ Outlook pour la priorité.
OUTLOOK_SENSITIVITY Champ Outlook pour la sensibilité.
OUTLOOK_SUBJECT Champ Outlook pour l'objet.
OUTLOOK_USER Champ Outlook pour l'utilisateur.
HOME Accueil
WORK Professionnel.
OTHER Autre rôle

Nom

Nom d'une personne. S'il s'agit d'un mononyme, le nom de famille n'est pas renseigné.

Représentation 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
}
Champs
metadata

object (FieldMetadata)

Métadonnées sur le nom.
displayName

string

Uniquement en sortie. Nom à afficher formaté selon les paramètres régionaux spécifiés par le compte du lecteur ou l'en-tête HTTP Accept-Language.
displayNameLastFirst

string

Uniquement en sortie. Nom à afficher dont le nom est d'abord mis en forme conformément aux paramètres régionaux spécifiés par le compte du spectateur ou l'en-tête HTTP Accept-Language.
unstructuredName

string

Valeur du nom de format libre.
familyName

string

Nom de famille.
givenName

string

Nom donné.
middleName

string

Deuxième(s) prénom(s).
honorificPrefix

string

Les préfixes honorifiques tels que Mrs. ou Dr.
honorificSuffix

string

Suffixes honorifiques tels que Jr.
phoneticFullName

string

Nom complet tel qu'il est prononcé.
phoneticFamilyName

string

Nom de famille orthographié tel qu'il se prononce.
phoneticGivenName

string

Nom saisi tel qu'il se prononce.
phoneticMiddleName

string

Le ou les deuxième(s) prénom(s) orthographié(s) tel qu'il sonne.
phoneticHonorificPrefix

string

Préfixes honorifiques orthographiés tels qu'ils sonnent.
phoneticHonorificSuffix

string

Suffixes honorifiques orthographiés tels qu'ils sonnent.

Pseudo

Pseudo d'une personne.

Représentation JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": enum (NicknameType)
}
Champs
metadata

object (FieldMetadata)

Métadonnées sur le pseudo.
value

string

Pseudo.
type

enum (NicknameType)

Type de pseudo.

NicknameType

Type de pseudo.

Enums
DEFAULT Pseudo générique.
MAIDEN_NAME

Nom de jeune fille ou nom de famille. Utilisé lorsque le nom de famille de la personne a changé à la suite du mariage.
INITIALS

Initiales
GPLUS

Pseudo du profil Google+
OTHER_NAME

Une affiliation professionnelle ou un autre nom Exemple : Dr. Smith.
ALTERNATE_NAME Autre nom connu de la personne.
SHORT_NAME

Version abrégée du nom de la personne.

Profession

Profession d'une personne.

Représentation JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Champs
metadata

object (FieldMetadata)

Métadonnées sur la profession.
value

string

Profession ; Exemple : carpenter.

Organisation

Organisation actuelle ou passée d'une personne. Les périodes qui se chevauchent sont autorisées.

Représentation 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
}
Champs
metadata

object (FieldMetadata)

Métadonnées sur l'organisation.
type

string

Type d'organisation. Le type peut être personnalisé ou l'une des valeurs prédéfinies suivantes:

  • work
  • school
formattedType

string

Uniquement en sortie. Type d'organisation traduit et formaté dans les paramètres régionaux du compte de l'utilisateur ou dans les paramètres régionaux de l'en-tête HTTP Accept-Language.
startDate

object (Date)

Date de début à laquelle la personne a rejoint l'organisation.
endDate

object (Date)

Date de fin à laquelle la personne a quitté l'organisation.
current

boolean

Vrai si l'organisation est l'organisation actuelle de la personne ; "false" si l'organisation est passée.
name

string

Nom de l'organisme.
phoneticName

string

Nom phonétique de l'organisation.
department

string

Le service de la personne dans l'organisation.
title

string

Fonction de la personne au sein de l'organisation.
jobDescription

string

Description du poste de la personne au sein de l'organisation.
symbol

string

Symbole associé à l'organisation. par exemple, un symbole boursier, une abréviation ou un acronyme.
domain

string

Le nom de domaine associé à l'organisation Exemple : google.com.
location

string

Emplacement du bureau de l'organisation dans lequel la personne travaille.
costCenter

string

Le centre de coûts de la personne au sein de l'entreprise
fullTimeEquivalentMillipercent

integer

Équivalent de temps plein en millipercent d'employés dans l'organisation (100 000 = 100%).

PhoneNumber

Numéro de téléphone d'une personne.

Représentation JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "canonicalForm": string,
  "type": string,
  "formattedType": string
}
Champs
metadata

object (FieldMetadata)

Métadonnées sur le numéro de téléphone.
value

string

Numéro de téléphone.
canonicalForm

string

Uniquement en sortie. Format canonique ITU-T E.164 du numéro de téléphone.
type

string

Type de numéro de téléphone. Le type peut être personnalisé ou l'une des valeurs prédéfinies suivantes:

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

string

Uniquement en sortie. Type de numéro de téléphone traduit et formaté dans les paramètres régionaux du compte de l'utilisateur ou dans les paramètres régionaux de l'en-tête HTTP Accept-Language.

Photo

Photo d'une personne. Une photo affichée à côté du nom de la personne pour aider les autres utilisateurs à la reconnaître.

Représentation JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "url": string,
  "default": boolean
}
Champs
metadata

object (FieldMetadata)

Métadonnées relatives à la photo.
url

string

URL de la photo. Vous pouvez modifier la taille souhaitée en ajoutant un paramètre de requête sz={size} à la fin de l'URL, où {size} est la taille en pixels. Exemple: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50
default

boolean

"True" si la photo est une photo par défaut. "false" si la photo est fournie par l'utilisateur.

Relation

La relation entre une personne et une autre personne.

Représentation JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "person": string,
  "type": string,
  "formattedType": string
}
Champs
metadata

object (FieldMetadata)

Métadonnées sur la relation.
person

string

Nom de l'autre personne à laquelle cette relation fait référence.
type

string

La relation entre la personne et l'autre personne Le type peut être personnalisé ou l'une des valeurs prédéfinies suivantes:

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

string

Uniquement en sortie. Type de relation traduit et mis en forme selon les paramètres régionaux du compte de l'utilisateur ou ceux spécifiés dans l'en-tête HTTP Accept-Language.

RelationshipInterest

OBSOLÈTE: Aucune donnée n'est renvoyée concernant les intérêts amoureux d'une personne .

Représentation JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "formattedValue": string
}
Champs
metadata

object (FieldMetadata)

Métadonnées sur l'intérêt de la relation.
value

string

Le type de relation que la personne recherche. La valeur peut être personnalisée ou l'une des valeurs prédéfinies suivantes:

  • friend
  • date
  • relationship
  • networking
formattedValue

string

Uniquement en sortie. Valeur de la relation d'intérêt traduite et mise en forme selon les paramètres régionaux du compte de l'utilisateur ou ceux spécifiés dans l'en-tête HTTP Accept-Language.

RelationshipStatus

OBSOLÈTE: aucune donnée n'est renvoyée concernant la relation amoureuse d'une personne.

Représentation JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "formattedValue": string
}
Champs
metadata

object (FieldMetadata)

Métadonnées sur l'état de la relation.
value

string

État de la relation. La valeur peut être personnalisée ou l'une des valeurs prédéfinies suivantes:

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

string

Uniquement en sortie. Valeur de l'état de la relation traduite et mise en forme dans les paramètres régionaux du compte de l'utilisateur ou dans les paramètres régionaux de l'en-tête HTTP Accept-Language.

Résidence

OBSOLÈTE: veuillez utiliser person.locations à la place. Résidence actuelle ou antérieure d'une personne.

Représentation JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "current": boolean
}
Champs
metadata

object (FieldMetadata)

Métadonnées sur la résidence.
value

string

Adresse de la résidence.
current

boolean

Vrai si le lieu de résidence est le lieu de résidence actuel de la personne. "false" si la résidence est une résidence antérieure.

SipAddress

Adresse SIP d'une personne. Les adresses de protocole initial de session sont utilisées pour les communications VoIP afin de passer des appels vocaux ou vidéo sur Internet.

Représentation JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string
}
Champs
metadata

object (FieldMetadata)

Métadonnées sur l'adresse SIP.
value

string

Adresse SIP au format SIP URI RFC 3261 19.1.
type

string

Type de l'adresse SIP. Le type peut être personnalisé ou l'une des valeurs prédéfinies suivantes:

  • home
  • work
  • mobile
  • other
formattedType

string

Uniquement en sortie. Type de l'adresse SIP traduite et mise en forme dans les paramètres régionaux du compte du spectateur ou dans les paramètres régionaux de l'en-tête HTTP Accept-Language.

Skill

Une compétence que la personne possède.

Représentation JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Champs
metadata

object (FieldMetadata)

Métadonnées sur la compétence.
value

string

La compétence ; Exemple : underwater basket weaving.

Tagline

OBSOLÈTE: aucune donnée ne sera renvoyée. Une brève description de la personne (une ligne)

Représentation JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Champs
metadata

object (FieldMetadata)

Métadonnées sur le slogan.
value

string

Le slogan

URL

URL associées à une personne.

Représentation JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string
}
Champs
metadata

object (FieldMetadata)

Métadonnées sur l'URL.
value

string

L'URL.
type

string

Type d'URL. Le type peut être personnalisé ou l'une des valeurs prédéfinies suivantes:

  • home
  • work
  • blog
  • profile
  • homePage
  • ftp
  • reservations
  • appInstallPage: site Web d'une application Currents.
  • other
formattedType

string

Uniquement en sortie. Type d'URL traduit et formaté dans les paramètres régionaux du compte de l'utilisateur ou dans les paramètres régionaux de l'en-tête HTTP Accept-Language.

UserDefined

Données utilisateur arbitraires renseignées par les utilisateurs finaux.

Représentation JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "key": string,
  "value": string
}
Champs
metadata

object (FieldMetadata)

Métadonnées sur les données définies par l'utilisateur.
key

string

Clé spécifiée par l'utilisateur final pour les données définies par l'utilisateur.
value

string

Valeur spécifiée par l'utilisateur final pour les données définies par l'utilisateur.

Méthodes

batchCreateContacts

Créez un lot de nouveaux contacts et renvoyez les PersonResponses pour les nouveaux

Les requêtes de mutation pour le même utilisateur doivent être envoyées de manière séquentielle pour éviter une latence accrue et des échecs.

batchDeleteContacts

 Supprimer un lot de contacts

batchUpdateContacts

 Mettre à jour un lot de contacts et renvoyer un mappage des noms de ressources à PersonResponses pour les contacts mis à jour

createContact

 Créez un nouveau contact et renvoyez la ressource de personne pour ce contact.

deleteContact

 Supprimer un contact

deleteContactPhoto

 Supprimez la photo d'un contact.

get

 Fournit des informations sur une personne en spécifiant un nom de ressource.

getBatchGet

 Fournit des informations sur une liste de personnes spécifiques en spécifiant une liste de noms de ressources demandés.

listDirectoryPeople

 Fournit la liste des profils de domaine et des contacts du domaine dans l'annuaire de domaine de l'utilisateur authentifié.

searchContacts

 Fournit la liste des contacts regroupés de l'utilisateur authentifié qui correspondent à la requête de recherche.

searchDirectoryPeople

 Fournit la liste des profils de domaine et des contacts du domaine dans l'annuaire de domaines de l'utilisateur authentifié qui correspondent à la requête de recherche.

updateContact

 Mettre à jour les coordonnées d'un contact existant

updateContactPhoto

 Modifiez la photo d'un contact.