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 articles d'un champ n'est pas garanti, mais chaque champ non vide contiendra forcément un seul champ avec la valeur metadata.primary définie 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 sous la forme people/{person_id}.
etag

string

Le 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)

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)

Les biographies de la personne Ce champ est un singleton des sources de contact.
birthdays[]

object (Birthday)

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

object (BraggingRights)

OBSOLÈTE: aucune donnée ne sera renvoyée. Droits de vantardise de la personne.
calendarUrls[]

object (CalendarUrl)

URL d'agenda de la personne.
clientData[]

object (ClientData)

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 concernée. Pour people.connections.list et otherContacts.list, le nombre d'adresses e-mail est limité à 100. Si une personne possède d'autres adresses e-mail, vous pouvez obtenir l'ensemble complet en appelant people.getBatchGet.
events[]

object (Event)

Événements de la personne.
externalIds[]

object (ExternalId)

Identifiants externes de la personne.
fileAses[]

object (FileAs)

Éléments de fichier de la personne.
genders[]

object (Gender)

Le genre de la personne. Ce champ est un singleton des sources de contact.
imClients[]

object (ImClient)

Clients de messagerie instantanée de la personne.
interests[]

object (Interest)

Centres d'intérêt de la personne.
locales[]

object (Locale)

Préférences régionales de la personne.
locations[]

object (Location)

Positions géographiques de la personne.
memberships[]

object (Membership)

Les abonnements de la personne à des groupes.
miscKeywords[]

object (MiscKeyword)

Mots clés divers de l'internaute
names[]

object (Name)

Noms de la personne. Ce champ est un singleton des sources de contact.
nicknames[]

object (Nickname)

Surnoms 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 d'autres numéros de téléphone, vous pouvez obtenir l'ensemble complet en appelant le people.getBatchGet.
photos[]

object (Photo)

Uniquement en sortie. Photos de la personne
relations[]

object (Relation)

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 dans la relation de la personne.
relationshipStatuses[]
(deprecated)

object (RelationshipStatus)

Uniquement en sortie. OBSOLÈTE: aucune donnée ne sera renvoyée.
residences[]
(deprecated)

object (Residence)

OBSOLÈTE: (Veuillez utiliser person.locations à la place) 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: les slogans de la personne ne seront pas renvoyés.
urls[]

object (Url)

URL associées à la personne.
userDefined[]

object (UserDefined)

Données définies par l'utilisateur de la personne

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. Ancien nom de ressource que cette personne a eu. Renseigné uniquement pour les requêtes people.connections.list qui incluent un jeton de synchronisation.

Le nom de la ressource peut changer lors de l'ajout ou de la suppression de champs qui associent un contact et un profil (adresse e-mail validée, numéro de téléphone validé ou URL de profil, par exemple).
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 dans le type de source généré par le serveur.
etag

string

Renseigné uniquement dans person.metadata.sources.

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

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres après la virgule. 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 de source.

Enums
SOURCE_TYPE_UNSPECIFIED URL indéterminée.
ACCOUNT Un compte Google
PROFILE Profil Google : Vous pouvez consulter votre profil à l'adresse https://profiles.google.com/{id}, où {id} correspond à l'ID de la source.
DOMAIN_PROFILE Profil de domaine Google Workspace :
CONTACT Contact Google : Vous pouvez consulter le contact à l'adresse https://contact.google.com/{id}, où {id} correspond à l'ID de la source.
OTHER_CONTACT Google "Autre contact" :
DOMAIN_CONTACT Contact partagé avec le domaine Google Workspace.

ProfileMetadata

Métadonnées d'un profil.

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

enum (ObjectType)

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

enum (UserType)

Uniquement en sortie. L'utilisateur saisit.

ObjectType

Type d'un objet personne.

Enums
OBJECT_TYPE_UNSPECIFIED URL indéterminée.
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'une boîte postale ou d'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 correspondre à l'une des valeurs prédéfinies suivantes:

  • home
  • work
  • other
formattedType

string

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

string

Boîte postale 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 de toutes les sources de la personne. Chaque personne disposera au maximum d'un champ avec la valeur primary définie sur "true".
sourcePrimary

boolean

"True" si le champ est le champ principal de source. Chaque source doit comporter au maximum un champ avec la valeur sourcePrimary définie sur "true".
verified

boolean

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

object (Source)

Source du champ.

AgeRange

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

Tranche d'âge d'une personne.

Enums
AGE_RANGE_UNSPECIFIED URL indéterminée.
LESS_THAN_EIGHTEEN De moins de dix-huit ans.
EIGHTEEN_TO_TWENTY Entre dix-huit et vingt.
TWENTY_ONE_OR_OLDER 21 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

La 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

La courte biographie.
contentType

enum (ContentType)

Type de contenu de la biographie.

ContentType

Type de contenu.

Enums
CONTENT_TYPE_UNSPECIFIED URL indéterminée.
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 ce n'est pas garanti. Les clients doivent toujours définir le champ date lorsqu'ils modifient des 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 l'anniversaire 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 relative au calendrier grégorien. Il peut s'agir de l'un des éléments suivants:

  • Date complète, avec des valeurs d'année, de mois et de jour non nulles.
  • Un mois et un jour, avec une année nulle (par exemple, un anniversaire).
  • Une année seule, avec zéro mois et zéro jour.
  • Année et 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. La valeur doit être comprise entre 1 et 9 999, ou valeur 0 si vous souhaitez indiquer une date sans année.
month

integer

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

integer

Jour du mois. La valeur doit être comprise entre 1 et 31, et valide pour l'année et le mois, ou la valeur 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 vous sera renvoyée. Les droits de vantardise d'une personne.

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

object (FieldMetadata)

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

string

Vos plus belles réussites (climbed mount everest, par exemple).

CalendarUrl

URL d'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 correspondre à 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 du lecteur ou dans les paramètres régionaux de l'en-tête HTTP Accept-Language.

ClientData

Données de client arbitraires renseignées par les clients. Les clés et les 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 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 Grande image affichée sur la page de profil de la personne qui représente cette personne ou ce qui l'intéresse.

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

object (FieldMetadata)

Métadonnées sur 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 une photo 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 correspondre à 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 du lecteur ou dans les paramètres régionaux de l'en-tête HTTP Accept-Language.
displayName

string

Nom à afficher pour 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 correspondre à l'une des valeurs prédéfinies suivantes:

  • anniversary
  • other
formattedType

string

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

ExternalId

Identifiant issu 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 d'ID externe. Le type peut être personnalisé ou correspondre à l'une des valeurs prédéfinies suivantes:

  • account
  • customer
  • loginId
  • network
  • organization
formattedType

string

Uniquement en sortie. Type d'événement traduit et mis en forme dans les paramètres régionaux du compte du lecteur 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 en tant que.
value

string

Valeur "Fichier en tant que"

Gender

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. Le genre peut être personnalisé ou utiliser l'une des valeurs prédéfinies suivantes:

  • male
  • female
  • unspecified
formattedValue

string

Uniquement en sortie. Valeur du genre 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. 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 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 de client de messagerie instantanée. Le type peut être personnalisé ou correspondre à 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 correspondre à l'une de ces valeurs prédéfinies:

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

Intérêt

Un des intérêts 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

Le centre d'intérêt (par exemple, stargazing).

Paramètres régionaux

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 bien formatée représentant les paramètres régionaux.

Emplacement

L'emplacement 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 de forme libre de l'emplacement.
type

string

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

  • desk
  • grewUp
current

boolean

Indique si l'emplacement correspond à la position actuelle.
buildingId

string

Identifiant du bâtiment.
floor

string

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

string

Section d'étage dans floor_name.
deskCode

string

Emplacement du bureau individuel.

Abonnement

Appartenance d'une personne à un groupe. Seules les appartenances 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'adhésion.
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. 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 pour l'appartenance au groupe de contacts.
contactGroupResourceName

string

Nom de ressource du groupe de contacts, attribué par le serveur. Chaîne ASCII, sous la forme contactGroups/{contactGroupId}. Vous ne pouvez modifier les adhésions qu'à l'aide de contactGroupResourceName. Toute appartenance à un groupe de contacts peut être supprimée, mais seules les appartenances aux groupes d'utilisateurs ou aux groupes système "mesContacts" ou "suivis" peuvent être ajoutées. Un contact doit toujours être membre d'au moins un groupe de contacts.

DomainMembership

Vous devez disposer d'un abonnement à un domaine Google Workspace.

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

boolean

Vrai si l'utilisateur appartient au domaine Google Workspace du lecteur.

MiscKeyword

Mot clé divers d'un utilisateur

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 mis en forme dans les paramètres régionaux du compte de l'utilisateur ou dans ceux de l'en-tête HTTP Accept-Language.

KeywordType

Type de mot clé divers.

Enums
TYPE_UNSPECIFIED URL indéterminée.
OUTLOOK_BILLING_INFORMATION Champ Outlook pour les informations de facturation.
OUTLOOK_DIRECTORY_SERVER Champ Outlook pour le serveur d'annuaire.
OUTLOOK_KEYWORD Champ "Outlook" pour le mot clé.
OUTLOOK_MILEAGE Champ Outlook pour le 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 Écran d'accueil
WORK Professionnel.
OTHER Autre rôle

Nom

Nom d'une personne. Si le nom est un mononyme, le nom de famille est vide.

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 a d'abord été formaté conformément aux paramètres régionaux spécifiés par le compte du lecteur ou dans l'en-tête HTTP Accept-Language.
unstructuredName

string

Valeur du nom au format libre.
familyName

string

Nom de famille.
givenName

string

Nom donné.
middleName

string

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

string

Préfixes honorifiques, tels que Mrs. ou Dr.
honorificSuffix

string

Les suffixes honorifiques, tels que Jr.
phoneticFullName

string

Nom complet orthographié tel qu'il se prononce.
phoneticFamilyName

string

Nom de famille épelé comme son nom l'indique.
phoneticGivenName

string

Nom donné épelé comme son nom l'indique.
phoneticMiddleName

string

Deuxième prénom orthographié tel qu'il se prononce.
phoneticHonorificPrefix

string

Préfixes honorifiques orthographiés comme ils se prononcent.
phoneticHonorificSuffix

string

Les suffixes honorifiques sont épelés à leur voix.

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 de naissance. Utilisé lorsque le nom de famille de la personne a changé à la suite d'un mariage.
INITIALS

Initiales.
GPLUS

Pseudo du profil Google+.
OTHER_NAME

Affiliation professionnelle ou autre nom (par exemple, Dr. Smith.)
ALTERNATE_NAME Autre nom de la personne connue.
SHORT_NAME

Version plus courte 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 (par exemple, carpenter)

Organisation

Organisation passée ou actuelle d'une personne. Les plages de dates peuvent se chevaucher.

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 correspondre à 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 du lecteur 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

"True" si l'organisation est l'organisation actuelle de la personne ; "false" si cette organisation est une ancienne organisation.
name

string

Nom de l'organisme.
phoneticName

string

Nom phonétique de l'organisation.
department

string

Le service dont dépend cette personne au sein de 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, symbole boursier, abréviation ou acronyme).
domain

string

Nom de domaine associé à l'organisation (par exemple, google.com).
location

string

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

string

Centre de coûts de la personne au sein de l'organisation.
fullTimeEquivalentMillipercent

integer

Équivalent temps plein de la personne au sein de l'organisation (100 000 = 100%).

PhoneNumber

Le 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. Forme 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 correspondre à 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 du lecteur ou dans les paramètres régionaux de l'en-tête HTTP Accept-Language.

Photo

Photo d'une personne. Image 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} correspond à 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" s'il s'agit d'une photo fournie par un utilisateur.

Relation

Lien d'une personne avec 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

Lien entre la personne et l'autre personne. Le type peut être personnalisé ou correspondre à 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 formaté dans les paramètres régionaux du compte du lecteur ou dans les paramètres régionaux spécifiés dans l'en-tête HTTP Accept-Language.

RelationshipInterest

OBSOLÈTE: aucune donnée ne sera renvoyée concernant l'intérêt dans la relation 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 dans la relation.
value

string

Le type de relation que la personne recherche. Il peut s'agir d'une valeur personnalisée ou de 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 dans les paramètres régionaux du compte de l'utilisateur ou dans les paramètres régionaux spécifiés dans l'en-tête HTTP Accept-Language.

RelationshipStatus

OBSOLÈTE: aucune donnée ne sera renvoyée concernant la situation 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. Il peut s'agir d'une valeur personnalisée ou de 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 formatée dans les paramètres régionaux du compte du lecteur 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 passée ou actuelle 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

"True" si la résidence est la résidence actuelle de la personne ; "false" si elle est une résidence passée.

SipAddress

Adresse SIP d'une personne. Les adresses Initial Protocol 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 RFC 3261 19.1.
type

string

Type d'adresse SIP. Il peut s'agir d'un type personnalisé ou de l'une des valeurs prédéfinies suivantes:

  • home
  • work
  • mobile
  • other
formattedType

string

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

Skill

Une compétence que la personne a.

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

object (FieldMetadata)

Des métadonnées sur la compétence.
value

string

La compétence (par exemple, underwater basket weaving)

Tagline

OBSOLÈTE: aucune donnée ne sera renvoyée. Brève description de la personne en 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

URL.
type

string

Type d'URL. Le type peut être personnalisé ou correspondre à 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 du lecteur 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é des données définies par l'utilisateur spécifiée par l'utilisateur final.
value

string

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

Méthodes

batchCreateContacts

Créer un lot de nouveaux contacts et renvoyer les réponses PersonResponses pour la nouvelle

Les requêtes de mutation pour un même utilisateur doivent être envoyées de manière séquentielle afin d'éviter une augmentation de la latence et des échecs.

batchDeleteContacts

 Supprimer un lot de contacts

batchUpdateContacts

 Mettre à jour un lot de contacts et renvoyer un mappage de noms de ressources vers 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 une liste des profils de domaine et des contacts du domaine dans l'annuaire du 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 une liste des profils de domaine et des contacts du domaine dans l'annuaire du domaine de l'utilisateur authentifié qui correspondent à la requête de recherche.

updateContact

 Mettez à jour les données de contact d'un contact existant.

updateContactPhoto

 mettre à jour la photo d'un contact ;