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 d'un champ n'est pas garanti. Cependant, il est garanti qu'un seul champ vide pour metadata.primary est 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 pour la personne, attribué par le serveur. Chaîne ASCII au format 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)

Adresse postale 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)

Biographies de la personne. Ce champ est un singleton pour les sources de contact.

birthdays[]

object (Birthday)

Anniversaires de la personne. Ce champ est un singleton pour les sources de contact.

braggingRights[]
(deprecated)

object (BraggingRights)

OBSOLÈTE: aucune donnée ne sera renvoyée. Droits de se vanter.

calendarUrls[]

object (CalendarUrl)

URL de l'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. 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, l'ensemble peut être obtenu en appelant people.getBatchGet.

events[]

object (Event)

Événements de la personne.

externalIds[]

object (ExternalId)

ID externes de la personne.

fileAses[]

object (FileAs)

Les fichiers en tant que fichiers de la personne.

genders[]

object (Gender)

Sexes de la personne. Ce champ est un singleton pour les 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)

Situation géographique de la personne.

memberships[]

object (Membership)

Appartenance à un groupe de la personne.

miscKeywords[]

object (MiscKeyword)

Mots clés divers de la personne.

names[]

object (Name)

Noms de la personne. Ce champ est un singleton pour les sources de contact.

nicknames[]

object (Nickname)

Les pseudos de la personne.

occupations[]

object (Occupation)

Professions de la personne.

organizations[]

object (Organization)

Les 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 plus de numéros de téléphone, vous pouvez appeler l'people.getBatchGet pour obtenir l'ensemble des numéros.

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. Intérêts relationnels de la personne.

relationshipStatuses[]
(deprecated)

object (RelationshipStatus)

Uniquement en sortie. OBSOLÈTE: aucune donnée ne sera renvoyée. Situations amoureuses de la personne.

residences[]
(deprecated)

object (Residence)

OBSOLÈTE : (Veuillez utiliser person.locations à la place.) Les résidences de la personne.

sipAddresses[]

object (SipAddress)

Adresses SIP de la personne.

skills[]

object (Skill)

Compétences de la personne.

taglines[]
(deprecated)

object (Tagline)

Uniquement en sortie. OBSOLÈTE : aucune donnée ne sera renvoyée. Les slogans de la personne.

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 relatives à une personne.

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

object (Source)

Sources de données de la personne.

previousResourceNames[]

string

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

Le nom de la ressource peut changer lorsque vous ajoutez ou supprimez des champs qui associent un contact et un profil, tels qu'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. Vraie 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 d'objet "personne".

Source

Source d'un champ.

Représentation JSON
{
  "type": enum (SourceType),
  "id": string,
  "etag": string,
  "updateTime": string,
  "profileMetadata": {
    object (ProfileMetadata)
  }
}
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.

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.

Horodatage 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 fractionnaires. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

profileMetadata

object (ProfileMetadata)

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

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

Type de source

Type d'une source.

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

Métadonnées de profil

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. Types d'utilisateurs.

Type d'objet

Type d'objet "personne".

Enums
OBJECT_TYPE_UNSPECIFIED URL indéterminée.
PERSON Personne.
PAGE Page Currents :

Type d'utilisateur

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 relatives à l'adresse.

formattedValue

string

Valeur non structurée de l'adresse. S'il n'est pas défini par l'utilisateur, il sera automatiquement construit à 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 d'adresse traduite et mise en forme dans les paramètres régionaux du compte de l'utilisateur ou dans les paramètres régionaux Accept-Language.

poBox

string

Boîte postale de l'adresse.

streetAddress

string

Adresse postale.

extendedAddress

string

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

Métadonnées du champ

Métadonnées d'un champ.

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

boolean

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

sourcePrimary

boolean

Vraie si le champ est le champ principal de source. Chaque source doit comporter au maximum un champ avec sourcePrimary défini sur "true".

verified

boolean

Uniquement en sortie. True si le champ est validé, false s'il 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 la propriété a été confirmée comme appartenant à la personne en question.

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 URL indéterminée.
LESS_THAN_EIGHTEEN Moins de 18 ans.
EIGHTEEN_TO_TWENTY Entre dix-huit et vingt ans.
TWENTY_ONE_OR_OLDER 21 ans et plus

Tranche d'âge

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

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.

Birthday

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 concernant la date de naissance.

date

object (Date)

Date structurée de l'anniversaire.

text
(deprecated)

string

Préférez 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 de calendrier complète ou partielle, comme un anniversaire. L'heure de la journée et le fuseau horaire sont indiqués ailleurs ou sont insignifiants. 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 un mois et un jour zéro.
  • Année et mois, avec un jour zéro (par exemple, une date d'expiration de 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 9999, ou égale à 0 pour indiquer une date sans année.

month

integer

Mois d'une année. La valeur doit être comprise entre 1 et 12, ou égale à 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 égale à 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.

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

object (FieldMetadata)

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

value

string

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

URL de l'agenda

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 de l'agenda 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.

Données client

Données 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é spécifiée par le client pour les données client.

value

string

Valeur spécifiée par le client pour les données client.

Photo de couverture

Photo de couverture d'une personne. Grande image affichée sur la page de profil de la personne, qui représente son identité ou ses centres d'intérêt.

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

Vraie si la photo de couverture est la photo de couverture par défaut ; false si la photo de couverture est une photo de couverture 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 traduite et mise en forme dans les paramètres régionaux du compte de l'utilisateur ou dans les paramètres régionaux Accept-Language.

displayName

string

Nom à afficher de l'e-mail.

Événement

Événement associé à la personne.

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

object (FieldMetadata)

Métadonnées relatives à 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 mis en forme dans les paramètres régionaux du compte de l'utilisateur ou dans les paramètres régionaux 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 d'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 mis en forme dans les paramètres régionaux du compte de l'utilisateur ou dans les paramètres régionaux Accept-Language.

Fichiers

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 de fichier en tant que

Gender

Sexe d'une personne.

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

object (FieldMetadata)

Métadonnées sur le sexe.

value

string

Sexe 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 à traduire 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 à forme 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 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 mis 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.

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 mis en forme dans les paramètres régionaux du compte de l'utilisateur ou dans les paramètres régionaux 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

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

Format de tag de langue IETF BCP 47 qui représente les paramètres régionaux.

Emplacement

Situation 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 du lieu sous forme libre.

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 le lieu est le lieu actuel.

buildingId

string

Identifiant du bâtiment.

floor

string

Nom ou numéro d'étage.

floorSection

string

Section de l'étage dans floor_name.

deskCode

string

L'emplacement du bureau individuel.

Abonnement

L'appartenance d'une personne à un groupe. Seuls les membres d'un groupe de contacts peuvent être modifiés.

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'abonnement.

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.

Appartenance au groupe de contacts

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 au format contactGroups/{contactGroupId}. Vous ne pouvez utiliser que contactGroupResourceName pour modifier les adhésions. Tous les membres d'un groupe de contacts peuvent être supprimés, mais seuls les adhésions à des groupes d'utilisateurs ou à mes groupes système "Mes Contacts" ou "Suivis" peuvent être ajoutées. Un contact doit toujours être associé à au moins un groupe de contacts.

Appartenance à un domaine

Abonnement à un domaine Google Workspace.

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

boolean

Vraie si la personne appartient au domaine Google Workspace de l'utilisateur.

Mots clés divers

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 le mot clé 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 les paramètres régionaux de l'en-tête HTTP Accept-Language.

Type de mot clé

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 du serveur d'annuaire.
OUTLOOK_KEYWORD Champ Outlook pour le mot clé.
OUTLOOK_MILEAGE Champ d'Outlook pour le kilométrage.
OUTLOOK_PRIORITY Champ "Outlook" pour la priorité.
OUTLOOK_SENSITIVITY champ "Sensibilité" dans Outlook.
OUTLOOK_SUBJECT Champ Outlook pour l'objet.
OUTLOOK_USER Champ Outlook pour l'utilisateur.
HOME Écran d'accueil
WORK Professionnel.
OTHER Autre.

Nom

Nom d'une personne. S'il s'agit d'un mononyme, le nom de la 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 mis en forme en fonction des paramètres régionaux spécifiés par le compte de l'utilisateur ou de l'en-tête HTTP Accept-Language.

displayNameLastFirst

string

Uniquement en sortie. Nom à afficher dont le nom est formaté en premier selon les paramètres régionaux spécifiés par le compte de l'utilisateur ou l'en-tête HTTP Accept-Language.

unstructuredName

string

Valeur du nom à forme 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

Les suffixes honorifiques, tels que Jr.

phoneticFullName

string

Nom complet tel qu'il s'affiche.

phoneticFamilyName

string

Nom de la famille épelé tel qu'il apparaît.

phoneticGivenName

string

Nom donné tel qu'il apparaît.

phoneticMiddleName

string

Deuxième(s) deuxième(s) prénom(s) épelé(s) lors de son affichage

phoneticHonorificPrefix

string

Préfixes honorifiques orthographiés lors du son.

phoneticHonorificSuffix

string

Les suffixes honorifiques épelés comme ils sonnent.

Pseudo

Le 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

Le pseudo.

type

enum (NicknameType)

Type de pseudo.

Type de pseudo

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

Une affiliation professionnelle ou un autre nom (par exemple, Dr. Smith.)

ALTERNATE_NAME Autre nom connu.
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 : par exemple, carpenter.

Organisation

Organisation passée ou actuelle d'une personne. Les plages de dates 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 mis 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.

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

Intitulé du poste de la personne dans l'organisation.

jobDescription

string

Description du poste de la personne dans l'organisation.

symbol

string

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

domain

string

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

location

string

L'adresse du bureau de l'organisation où la personne travaille.

costCenter

string

Le centre de coûts de la personne dans l'organisation.

fullTimeEquivalentMillipercent

integer

Nombre de millisecondes correspondant à temps plein à la personne 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 mis 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.

Photo

Photo d'une personne Une photo affichée à côté du nom de l'utilisateur pour aider les autres utilisateurs à le 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

Relation 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

Relation de la personne avec 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 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.

Intérêt pour la relation

OBSOLÈTE : aucune donnée ne sera renvoyée concernant les centres d'intérêt de la personne .

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

object (FieldMetadata)

Métadonnées sur l'intérêt relationnel.

value

string

Type de relation recherché par la personne. Il peut s'agir de valeurs personnalisées ou prédéfinies:

  • friend
  • date
  • relationship
  • networking
formattedValue

string

Uniquement en sortie. Valeur de l'intérêt pour 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 spécifiés dans l'en-tête HTTP "Accept-Language".

État de la relation

OBSOLÈTE : aucune donnée ne sera renvoyée sur 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 de valeurs personnalisées ou prédéfinies:

  • 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. Ancienne ou actuelle résidence 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 la résidence est une résidence passée.

Adresse SIP

Adresse SIP d'une personne. Les adresses IP de la 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 IP. Le type peut être personnalisé ou l'une des valeurs prédéfinies suivantes:

  • home
  • work
  • mobile
  • other
formattedType

string

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

Skill

Compétence de la personne.

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

object (FieldMetadata)

Métadonnées sur la compétence.

value

string

Compétence : par exemple, underwater basket weaving.

Résumé

OBSOLÈTE: aucune donnée ne sera renvoyée. Il s'agit d'une brève description de la personne sur 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 d'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 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 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.

Définie par l'utilisateur

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 des données définies par l'utilisateur.

value

string

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

Méthodes

batchCreateContacts

Créez un lot de nouveaux contacts et renvoyez les réponses PersonResponse pour le nouveau

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

batchDeleteContacts

Supprimer un lot de contacts

batchUpdateContacts

Mettez à jour un lot de contacts et renvoyez un mappage de noms de ressources à PersonResponses pour les contacts mis à jour.

createContact

Créez un contact et renvoyez la ressource de cette personne.

deleteContact

Supprimer un contact.

deleteContactPhoto

Supprimer 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 de profils et de contacts de domaine dans l'annuaire des domaines de l'utilisateur authentifié.

searchContacts

Fournit une liste de contacts figurant dans les contacts groupés de l'utilisateur authentifié correspondant à la requête de recherche.

searchDirectoryPeople

Fournit une liste de profils du domaine et de contacts du domaine dans l'annuaire du domaine de l'utilisateur authentifié correspondant à la requête de recherche.

updateContact

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

updateContactPhoto

Mettez à jour la photo d'un contact.