REST Resource: people

Recurso: Person

Información sobre una persona combinada de varias fuentes de datos, como los contactos y los datos del perfil del usuario autenticado.

La mayoría de los campos pueden tener varios elementos. Los elementos de un campo no tienen un orden garantizado, pero se garantiza que cada campo que no esté vacío tenga exactamente un campo con metadata.primary como verdadero.

Representación 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)
    }
  ]
}
Campos
resourceName

string

El nombre del recurso para la persona, asignado por el servidor. Una string ASCII con el formato people/{person_id}.
etag

string

La etiqueta de entidad HTTP del recurso. Se utiliza para la validación de caché web.
metadata

object (PersonMetadata)

Solo salida. Metadatos sobre la persona.
addresses[]

object (Address)

Las direcciones de la persona.
ageRange
(deprecated)

enum (AgeRange)

Solo salida. OBSOLETO (en su lugar, usa person.ageRanges)

El rango de edad de la persona.
ageRanges[]

object (AgeRangeType)

Solo salida. Los rangos de edad de la persona.
biographies[]

object (Biography)

Las biografías de la persona. Este campo es un singleton de las fuentes de contacto.
birthdays[]

object (Birthday)

Los cumpleaños de la persona. Este campo es un singleton de las fuentes de contacto.
braggingRights[]
(deprecated)

object (BraggingRights)

OBSOLETO: No se mostrarán datos para presumir los derechos de la persona.
calendarUrls[]

object (CalendarUrl)

Las URL de calendario de la persona.
clientData[]

object (ClientData)

Los datos del cliente de la persona.
coverPhotos[]

object (CoverPhoto)

Solo salida. Las fotos de portada de la persona.
emailAddresses[]

object (EmailAddress)

Las direcciones de correo electrónico de la persona. Para people.connections.list y otherContacts.list, la cantidad de direcciones de correo electrónico está limitada a 100. Si una persona tiene más direcciones de correo electrónico, puedes llamar a people.getBatchGet para obtener todo el conjunto.
events[]

object (Event)

Los eventos de la persona.
externalIds[]

object (ExternalId)

Los ID externos de la persona.
fileAses[]

object (FileAs)

El archivo de la persona.
genders[]

object (Gender)

El género de la persona. Este campo es un singleton de las fuentes de contacto.
imClients[]

object (ImClient)

Los clientes de mensajería instantánea de la persona.
interests[]

object (Interest)

Los intereses de la persona.
locales[]

object (Locale)

Las preferencias de configuración regional de la persona.
locations[]

object (Location)

Las ubicaciones de la persona.
memberships[]

object (Membership)

Las membresías grupales de la persona.
miscKeywords[]

object (MiscKeyword)

Las palabras clave varias de la persona.
names[]

object (Name)

Los nombres de la persona. Este campo es un singleton de las fuentes de contacto.
nicknames[]

object (Nickname)

Los apodos de la persona.
occupations[]

object (Occupation)

Las profesiones de la persona.
organizations[]

object (Organization)

Las organizaciones pasadas o actuales de la persona.
phoneNumbers[]

object (PhoneNumber)

Los números de teléfono de la persona. Para people.connections.list y otherContacts.list, la cantidad de números de teléfono está limitada a 100. Si una persona tiene más números de teléfono, puedes llamar a people.getBatchGet para obtener el conjunto completo.
photos[]

object (Photo)

Solo salida. Las fotos de la persona.
relations[]

object (Relation)

Las relaciones de la persona.
relationshipInterests[]
(deprecated)

object (RelationshipInterest)

Solo salida. OBSOLETO: No se mostrarán datos para los intereses de relación de la persona.
relationshipStatuses[]
(deprecated)

object (RelationshipStatus)

Solo salida. OBSOLETO: No se mostrarán datos para el estado civil de la persona.
residences[]
(deprecated)

object (Residence)

OBSOLETO: (en su lugar, utiliza person.locations) Residencias de la persona.
sipAddresses[]

object (SipAddress)

Las direcciones SIP de la persona.
skills[]

object (Skill)

Las habilidades de la persona.
taglines[]
(deprecated)

object (Tagline)

Solo salida. OBSOLETO: No se mostrarán datos para los eslóganes de la persona.
urls[]

object (Url)

Las URL asociadas de la persona.
userDefined[]

object (UserDefined)

Los datos definidos por el usuario de la persona.

Metadatos de persona

Los metadatos sobre una persona.

Representación JSON 
{
  "sources": [
    {
      object (Source)
    }
  ],
  "previousResourceNames": [
    string
  ],
  "linkedPeopleResourceNames": [
    string
  ],
  "deleted": boolean,
  "objectType": enum (ObjectType)
}
Campos
sources[]

object (Source)

Las fuentes de datos de la persona.
previousResourceNames[]

string

Solo salida. Cualquier nombre de recurso anterior que esta persona haya tenido. Se propaga solo para las solicitudes people.connections.list que incluyen un token de sincronización.

El nombre del recurso puede cambiar cuando se agregan o quitan campos que vinculan un contacto y un perfil, como un correo electrónico, un número de teléfono verificados o la URL del perfil.
linkedPeopleResourceNames[]

string

Solo salida. Nombres de recursos vinculados a este recurso.
deleted

boolean

Solo salida. Verdadero si se borró el recurso de persona. Se propaga solo para solicitudes de sincronización de people.connections.list y otherContacts.list.
objectType
(deprecated)

enum (ObjectType)

Solo salida. OBSOLETO (en su lugar, usa person.metadata.sources.profileMetadata.objectType)

El tipo de objeto persona.

Fuente

La fuente de un campo.

Representación JSON 
{
  "type": enum (SourceType),
  "id": string,
  "etag": string,
  "updateTime": string,
  "profileMetadata": {
    object (ProfileMetadata)
  }
}
Campos
type

enum (SourceType)

El tipo de fuente.
id

string

El identificador único dentro del tipo de fuente que genera el servidor.
etag

string

Solo se propaga en person.metadata.sources.

La etiqueta de entidad HTTP de la fuente. Se utiliza para la validación de caché web.
updateTime

string (Timestamp format)

Solo salida. Solo se propaga en person.metadata.sources.

Marca de tiempo de la última actualización de esta fuente.

Una marca de tiempo en formato RFC3339 UTC "Zulú", con resolución de nanosegundos y hasta nueve dígitos decimales. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
profileMetadata

object (ProfileMetadata)

Solo salida. Solo se propaga en person.metadata.sources.

Metadatos acerca de una fuente de tipo PROFILE

Tipo de origen

El tipo de una fuente.

Enumeradores
SOURCE_TYPE_UNSPECIFIED No se especifica.
ACCOUNT Cuenta de Google.
PROFILE Perfil de Google. Puedes verlo en https://profiles.google.com/{id}, donde {id} es el ID de la fuente.
DOMAIN_PROFILE Perfil de dominio de Google Workspace.
CONTACT Contacto de Google. Puedes verlo en https://contact.google.com/{id}, donde {id} es el ID de la fuente.
OTHER_CONTACT "Otro contacto" de Google.
DOMAIN_CONTACT Contacto compartido del dominio de Google Workspace.

Metadatos de perfiles

Los metadatos sobre un perfil

Representación JSON 
{
  "objectType": enum (ObjectType),
  "userTypes": [
    enum (UserType)
  ]
}
Campos
objectType

enum (ObjectType)

Solo salida. El tipo de objeto de perfil.
userTypes[]

enum (UserType)

Solo salida. El tipo de usuario.

Tipo de objeto

Tipo de objeto de una persona.

Enumeradores
OBJECT_TYPE_UNSPECIFIED No se especifica.
PERSON Persona.
PAGE Página Currents.

Tipo de usuario

Es el tipo de usuario.

Enumeradores
USER_TYPE_UNKNOWN Se desconoce el tipo de usuario.
GOOGLE_USER El usuario es un usuario de Google.
GPLUS_USER El usuario es de Currents.
GOOGLE_APPS_USER El usuario es usuario de Google Workspace.

Address

La dirección física de una persona. Puede ser un apartado postal o una dirección. Todos los campos son opcionales.

Representación 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
}
Campos
metadata

object (FieldMetadata)

Metadatos sobre la dirección.
formattedValue

string

El valor no estructurado de la dirección. Si no lo configura el usuario, se construirá automáticamente a partir de valores estructurados.
type

string

El tipo de la dirección. El tipo puede ser personalizado o uno de estos valores predefinidos:

  • home
  • work
  • other
formattedType

string

Solo salida. Es el tipo de dirección traducida y con formato en la configuración regional de la cuenta del usuario o la configuración regional del encabezado HTTP Accept-Language.
poBox

string

El apartado postal de la dirección.
streetAddress

string

Indica la dirección,
extendedAddress

string

La dirección extendida de la dirección, por ejemplo, el número de departamento.
city

string

La ciudad de la dirección.
region

string

La región de la dirección (por ejemplo, el estado o la provincia).
postalCode

string

El código postal de la dirección.
country

string

El país de la dirección.
countryCode

string

El código de país ISO 3166-1 alpha-2 de la dirección.

Metadatos de campo

Metadatos sobre un campo.

Representación JSON 
{
  "primary": boolean,
  "sourcePrimary": boolean,
  "verified": boolean,
  "source": {
    object (Source)
  }
}
Campos
primary

boolean

Solo salida. Verdadero si el campo es el principal para todas las fuentes del usuario. Cada persona tendrá, como máximo, un campo con primary establecido en verdadero.
sourcePrimary

boolean

Verdadero si el campo es el principal para source. Cada fuente debe tener, como máximo, un campo con sourcePrimary configurado como verdadero.
verified

boolean

Solo salida. Verdadero si el campo está verificado; falso si el campo no está verificado. Un campo verificado suele ser un nombre, una dirección de correo electrónico, un número de teléfono o un sitio web que se haya confirmado que pertenecen a la persona.
source

object (Source)

La fuente del campo.

Rango de edades

OBSOLETO (en su lugar, usa person.ageRanges)

Rango de edad de una persona.

Enumeradores
AGE_RANGE_UNSPECIFIED No se especifica.
LESS_THAN_EIGHTEEN Menor de dieciocho años.
EIGHTEEN_TO_TWENTY Entre dieciocho y veinte.
TWENTY_ONE_OR_OLDER Veintiún años y más.

Tipo de rango de edad

Indica el rango de edad de una persona.

Representación JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "ageRange": enum (AgeRange)
}
Campos
metadata

object (FieldMetadata)

Metadatos sobre el rango de edad.
ageRange

enum (AgeRange)

El rango de edad.

Biografía

La breve biografía de una persona.

Representación JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "contentType": enum (ContentType)
}
Campos
metadata

object (FieldMetadata)

Metadatos sobre la biografía.
value

string

La biografía breve.
contentType

enum (ContentType)

Es el tipo de contenido de la biografía.

ContentType

El tipo de contenido.

Enumeradores
CONTENT_TYPE_UNSPECIFIED No se especifica.
TEXT_PLAIN Texto sin formato
TEXT_HTML Texto HTML

Cumpleaños

Es el cumpleaños de una persona. Se especificaron al menos uno de los campos date y text. Por lo general, los campos date y text representan la misma fecha, pero no se garantiza que lo hagan. Los clientes siempre deben configurar el campo date cuando mutan los cumpleaños.

Representación JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "date": {
    object (Date)
  },
  "text": string
}
Campos
metadata

object (FieldMetadata)

Metadatos sobre la fecha de nacimiento.
date

object (Date)

Fecha estructurada de cumpleaños.
text
(deprecated)

string

Si se establece, es preferible utilizar el campo date.

Una string de formato libre que representa la fecha de nacimiento del usuario. Este valor no está validado.

Fecha

Representa una fecha de calendario completa o parcial, como un cumpleaños. La hora del día y la zona horaria se especifican en otro lugar o son insignificantes. La fecha está relacionada con el calendario gregoriano. Esto puede representar uno de los siguientes aspectos:

  • Una fecha completa con valores de año, mes y día distintos de cero
  • Un mes y un día con un año en cero (por ejemplo, un aniversario).
  • Un año solo con un mes en cero y un día cero
  • Un año y un mes, con un día de cero (por ejemplo, una fecha de vencimiento de la tarjeta de crédito).

Tipos relacionados:

Representación JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Campos
year

integer

Año de la fecha. Debe encontrarse entre 1 y 9999, o 0 para especificar una fecha sin año.
month

integer

Mes del año Debe encontrarse entre 1 y 12, o 0 para especificar un año sin mes ni día.
day

integer

Día del mes Debe encontrarse entre 1 y 31 y ser válido para el mes del año, o bien debe ser 0 para especificar un año por su cuenta o un año y un mes en los que el día no es importante.

Motivos para presumir

OBSOLETO: No se mostrarán datos sobre los motivos de orgullo de una persona.

Representación JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Campos
metadata

object (FieldMetadata)

Metadatos sobre los motivos de orgullo
value

string

Los derechos a presumir, por ejemplo, climbed mount everest

URL del calendario

La URL del calendario de una persona.

Representación JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "url": string,
  "type": string,
  "formattedType": string
}
Campos
metadata

object (FieldMetadata)

Metadatos sobre la URL del calendario.
url

string

La URL del calendario.
type

string

Es el tipo de URL del calendario. El tipo puede ser personalizado o uno de estos valores predefinidos:

  • home
  • freeBusy
  • work
formattedType

string

Solo salida. Es el tipo de URL del calendario traducida y con formato en la configuración regional de la cuenta del usuario o del encabezado HTTP Accept-Language.

Datos del cliente

Datos de clientes arbitrarios que propagan los clientes. Se permiten valores y claves duplicados.

Representación JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "key": string,
  "value": string
}
Campos
metadata

object (FieldMetadata)

Metadatos sobre los datos del cliente.
key

string

La clave especificada por el cliente de los datos del cliente.
value

string

El valor especificado por el cliente de los datos del cliente.

Foto de portada

La foto de portada de una persona. Una imagen grande que se muestra en la página de perfil de la persona y que representa a la persona o lo que le importa.

Representación JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "url": string,
  "default": boolean
}
Campos
metadata

object (FieldMetadata)

Metadatos sobre la foto de portada.
url

string

La URL de la foto de portada.
default

boolean

Verdadero si la foto de portada es la predeterminada; false si la foto de portada es una foto de portada proporcionada por el usuario.

EmailAddress

La dirección de correo electrónico de una persona.

Representación JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string,
  "displayName": string
}
Campos
metadata

object (FieldMetadata)

Metadatos sobre la dirección de correo electrónico.
value

string

La dirección de correo electrónico.
type

string

Es el tipo de dirección de correo electrónico. El tipo puede ser personalizado o uno de estos valores predefinidos:

  • home
  • work
  • other
formattedType

string

Solo salida. Corresponde al tipo de dirección de correo electrónico traducida y con formato en la configuración regional de la cuenta del usuario o del encabezado HTTP Accept-Language.
displayName

string

El nombre visible del correo electrónico.

Evento

Un evento relacionado con la persona.

Representación JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "date": {
    object (Date)
  },
  "type": string,
  "formattedType": string
}
Campos
metadata

object (FieldMetadata)

Metadatos sobre el evento.
date

object (Date)

La fecha del evento.
type

string

El tipo de evento. El tipo puede ser personalizado o uno de estos valores predefinidos:

  • anniversary
  • other
formattedType

string

Solo salida. El tipo de evento traducido y con formato en la configuración regional de la cuenta del usuario o la configuración regional del encabezado HTTP Accept-Language.

ID externo

Es un identificador de una entidad externa relacionada con la persona.

Representación JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string
}
Campos
metadata

object (FieldMetadata)

Metadatos sobre el ID externo.
value

string

El valor del ID externo.
type

string

Es el tipo de ID externo. El tipo puede ser personalizado o uno de estos valores predefinidos:

  • account
  • customer
  • loginId
  • network
  • organization
formattedType

string

Solo salida. El tipo de evento traducido y con formato en la configuración regional de la cuenta del usuario o la configuración regional del encabezado HTTP Accept-Language.

FileA

El nombre que se debe utilizar para ordenar a la persona en una lista.

Representación JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Campos
metadata

object (FieldMetadata)

Metadatos sobre el archivo como
value

string

El valor de archivo como

Género

El género de una persona.

Representación JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "formattedValue": string,
  "addressMeAs": string
}
Campos
metadata

object (FieldMetadata)

Metadatos sobre el género.
value

string

El género de la persona. El género puede ser personalizado o uno de estos valores predefinidos:

  • male
  • female
  • unspecified
formattedValue

string

Solo salida. Es el valor del género traducido y con el formato establecido en la configuración regional de la cuenta del usuario o en la configuración regional del encabezado HTTP Accept-Language. Los valores personalizados o sin especificar no están localizados.
addressMeAs

string

Campo de texto de formato libre para pronombres que se deben utilizar para dirigirse a la persona Los valores comunes son los siguientes:

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

Cliente

El cliente de mensajería instantánea de una persona.

Representación JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "username": string,
  "type": string,
  "formattedType": string,
  "protocol": string,
  "formattedProtocol": string
}
Campos
metadata

object (FieldMetadata)

Metadatos sobre el cliente de IM.
username

string

El nombre de usuario utilizado en el cliente de IM.
type

string

El tipo de cliente de IM. El tipo puede ser personalizado o uno de estos valores predefinidos:

  • home
  • work
  • other
formattedType

string

Solo salida. El tipo de cliente de IM traducido y con formato en la configuración regional de la cuenta del usuario o del encabezado HTTP Accept-Language.
protocol

string

El protocolo del cliente de IM. El protocolo puede ser personalizado o uno de estos valores predefinidos:

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

string

Solo salida. El protocolo del cliente de IM formateado en la configuración regional de la cuenta del espectador o la configuración regional del encabezado HTTP Accept-Language.

Interés

Uno de los intereses de la persona.

Representación JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Campos
metadata

object (FieldMetadata)

Metadatos sobre el interés
value

string

El interés, por ejemplo, stargazing

Configuración regional

La preferencia de configuración regional de una persona.

Representación JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Campos
metadata

object (FieldMetadata)

Metadatos sobre la configuración regional
value

string

La etiqueta de idioma IETF BCP 47 con el formato adecuado.

Ubicación

La ubicación de una persona.

Representación JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "current": boolean,
  "buildingId": string,
  "floor": string,
  "floorSection": string,
  "deskCode": string
}
Campos
metadata

object (FieldMetadata)

Metadatos sobre la ubicación.
value

string

El valor de formato libre de la ubicación.
type

string

Es el tipo de ubicación. El tipo puede ser personalizado o uno de estos valores predefinidos:

  • desk
  • grewUp
current

boolean

Indica si la ubicación es la actual.
buildingId

string

El identificador del edificio.
floor

string

El nombre o número del piso.
floorSection

string

La sección del piso en floor_name.
deskCode

string

La ubicación individual del escritorio.

Membresía

La membresía de una persona a un grupo. Solo se pueden modificar las membresías de grupos de contactos.

Representación 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.
}
Campos
metadata

object (FieldMetadata)

Metadatos sobre la membresía.
Campo de unión membership. La membresía. Las direcciones (membership) solo pueden ser una de las siguientes opciones:
contactGroupMembership

object (ContactGroupMembership)

La membresía del grupo de contactos.
domainMembership

object (DomainMembership)

Solo salida. La membresía del dominio.

Membresía del grupo de contactos

Una membresía de un grupo de contactos de Google.

Representación JSON 
{
  "contactGroupId": string,
  "contactGroupResourceName": string
}
Campos
contactGroupId
(deprecated)

string

Solo salida. El ID de grupo de contactos de la membresía del grupo de contactos.
contactGroupResourceName

string

El nombre del recurso para el grupo de contactos, asignado por el servidor. Una string ASCII con el formato contactGroups/{contactGroupId}. Para modificar las membresías, solo se puede usar contactGroupResourceName. Se puede quitar cualquier membresía de grupo de contactos, pero solo se pueden agregar membresías de grupos de usuarios o de grupos "myContacts" o "destacados". Un contacto siempre debe tener al menos una membresía de grupo de contactos.

Membresía del dominio

Una membresía de un dominio de Google Workspace.

Representación JSON 
{
  "inViewerDomain": boolean
}
Campos
inViewerDomain

boolean

Verdadero si la persona está en el dominio de Google Workspace del usuario.

Palabras clave varias

La palabra clave variada de una persona.

Representación JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": enum (KeywordType),
  "formattedType": string
}
Campos
metadata

object (FieldMetadata)

Metadatos sobre varias palabras clave
value

string

El valor de la otra palabra clave
type

enum (KeywordType)

El tipo de palabras clave varias.
formattedType

string

Solo salida. Es el tipo de palabra clave miscelánea traducido y con formato en la configuración regional de la cuenta del espectador o la configuración regional del encabezado HTTP Accept-Language.

Tipo de palabra clave

Tipo de palabra clave miscelánea.

Enumeradores
TYPE_UNSPECIFIED No se especifica.
OUTLOOK_BILLING_INFORMATION Campo de Outlook para los datos de facturación
OUTLOOK_DIRECTORY_SERVER Campo de Outlook para el servidor del directorio.
OUTLOOK_KEYWORD Campo de Outlook para la palabra clave
OUTLOOK_MILEAGE Campo de kilometraje de Outlook
OUTLOOK_PRIORITY Campo de Outlook para la prioridad
OUTLOOK_SENSITIVITY Campo de Outlook para la sensibilidad.
OUTLOOK_SUBJECT Campo de Outlook del asunto
OUTLOOK_USER Campo de Outlook para el usuario
HOME Pantalla principal
WORK Trabajo.
OTHER Otra opción

Nombre

El nombre de una persona. Si el nombre es un nombre único, el nombre de la familia está vacío.

Representación 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
}
Campos
metadata

object (FieldMetadata)

Metadatos sobre el nombre.
displayName

string

Solo salida. El nombre visible tiene un formato acorde a la configuración regional que se especifica en la cuenta del usuario o en el encabezado HTTP Accept-Language.
displayNameLastFirst

string

Solo salida. El nombre visible con el apellido primero formateado según la configuración regional especificada por la cuenta del usuario o el encabezado HTTP Accept-Language.
unstructuredName

string

El valor del nombre de formato libre.
familyName

string

El apellido.
givenName

string

El nombre dado.
middleName

string

Segundo nombre.
honorificPrefix

string

Los prefijos honoríficos, como Mrs. o Dr.
honorificSuffix

string

Los sufijos honoríficos, como Jr.
phoneticFullName

string

El nombre completo deletreado como suena.
phoneticFamilyName

string

El nombre de familia que se escribe
phoneticGivenName

string

El nombre dado que se escribe como suena.
phoneticMiddleName

string

El segundo nombre que se deletrea a medida que suenan
phoneticHonorificPrefix

string

Los prefijos honoríficos que se deletrean
phoneticHonorificSuffix

string

Sufijos honoríficos que se deletrean a medida que suenan.

Sobrenombre

Es el sobrenombre de una persona.

Representación JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": enum (NicknameType)
}
Campos
metadata

object (FieldMetadata)

Metadatos sobre el sobrenombre
value

string

El sobrenombre.
type

enum (NicknameType)

El tipo de sobrenombre.

Sobrenombre

El tipo de sobrenombre.

Enumeradores
DEFAULT Sobrenombre genérico.
MAIDEN_NAME

Apellido de soltera o de nacimiento. Se usa cuando el apellido de la persona cambia como resultado de un matrimonio.
INITIALS

Iniciales.
GPLUS

Seudónimo del perfil de Google+.
OTHER_NAME

Una afiliación profesional u otro nombre, por ejemplo, Dr. Smith.
ALTERNATE_NAME El nombre alternativo de la persona es conocido por.
SHORT_NAME

Una versión más corta del nombre de la persona.

Occupation

La profesión de una persona.

Representación JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Campos
metadata

object (FieldMetadata)

Metadatos sobre la profesión.
value

string

La profesión; por ejemplo, carpenter

Organización

La organización anterior o actual de una persona. Se permiten los períodos superpuestos.

Representación 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
}
Campos
metadata

object (FieldMetadata)

Metadatos sobre la organización.
type

string

Es el tipo de organización. El tipo puede ser personalizado o uno de estos valores predefinidos:

  • work
  • school
formattedType

string

Solo salida. El tipo de organización traducido y con formato en la configuración regional de la cuenta del usuario o el encabezado HTTP Accept-Language.
startDate

object (Date)

La fecha de inicio de la persona que se unió a la organización.
endDate

object (Date)

Fecha de finalización cuando la persona abandonó la organización.
current

boolean

Verdadero si la organización es la organización actual de la persona; false si la organización es una organización pasada.
name

string

Es el nombre de la organización.
phoneticName

string

El nombre fonético de la organización.
department

string

El departamento de la persona en la organización.
title

string

Es el cargo laboral de la persona en la organización.
jobDescription

string

La descripción del trabajo de la persona en la organización.
symbol

string

El símbolo asociado con la organización; por ejemplo, un símbolo bursátil, una abreviatura o un acrónimo.
domain

string

El nombre de dominio asociado con la organización (por ejemplo, google.com).
location

string

La ubicación de la oficina en la que trabaja la persona.
costCenter

string

Es el centro de costos de la persona en la organización.
fullTimeEquivalentMillipercent

integer

El porcentaje equivalente de tiempo completo de la persona dentro de la organización (100,000 = 100%).

PhoneNumber

Número de teléfono de una persona.

Representación JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "canonicalForm": string,
  "type": string,
  "formattedType": string
}
Campos
metadata

object (FieldMetadata)

Metadatos sobre el número de teléfono
value

string

El número de teléfono.
canonicalForm

string

Solo salida. La forma canónica de ITU-T E.164 del número de teléfono.
type

string

El tipo de número de teléfono. El tipo puede ser personalizado o uno de estos valores predefinidos:

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

string

Solo salida. Es el tipo de número de teléfono traducido y con formato en la configuración regional de la cuenta del usuario o del encabezado HTTP Accept-Language.

Foto

La foto de una persona. Imagen que se muestra junto al nombre de la persona para que otras personas puedan reconocerla.

Representación JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "url": string,
  "default": boolean
}
Campos
metadata

object (FieldMetadata)

Metadatos sobre la foto.
url

string

La URL de la foto. Para cambiar el tamaño deseado, agrega un parámetro de búsqueda sz={size} al final de la URL, en el que {size} es el tamaño en píxeles. Ejemplo: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50
default

boolean

Verdadero si la foto es una foto predeterminada; false si la foto es una foto proporcionada por el usuario.

Relación

La relación de una persona con otra.

Representación JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "person": string,
  "type": string,
  "formattedType": string
}
Campos
metadata

object (FieldMetadata)

Metadatos sobre la relación.
person

string

El nombre de la otra persona a la que hace referencia esta relación.
type

string

La relación de la persona con la otra persona. El tipo puede ser personalizado o uno de estos valores predefinidos:

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

string

Solo salida. Es el tipo de relación que se traduce y se formatea en la configuración regional de la cuenta del usuario o la configuración regional especificada en el encabezado HTTP de Accept-Language.

Relación de interés

OBSOLETO: No se mostrarán datos para el interés sentimental de las personas .

Representación JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "formattedValue": string
}
Campos
metadata

object (FieldMetadata)

Metadatos sobre el interés de la relación.
value

string

El tipo de relación que busca la persona. El valor puede ser personalizado o uno de estos valores predefinidos:

  • friend
  • date
  • relationship
  • networking
formattedValue

string

Solo salida. El valor de la relación de interés traducido y con formato en la configuración regional de la cuenta del usuario o la configuración regional especificada en el encabezado HTTP de Accept-Language.

Estado de la relación

OBSOLETO: No se muestran datos sobre el estado civil de la persona.

Representación JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "formattedValue": string
}
Campos
metadata

object (FieldMetadata)

Metadatos sobre el estado de la relación.
value

string

El estado civil. El valor puede ser personalizado o uno de estos valores predefinidos:

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

string

Solo salida. Es el valor de la relación de estado traducido y con formato en la configuración regional de la cuenta del usuario o la configuración regional del encabezado HTTP Accept-Language.

Residencia

OBSOLETO: usa el valor person.locations. La residencia de una persona.

Representación JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "current": boolean
}
Campos
metadata

object (FieldMetadata)

Metadatos sobre la residencia.
value

string

Es la dirección de la residencia.
current

boolean

Verdadero si la residencia es la residencia actual de la persona; false si la residencia es una residencia pasada.

Dirección SIP

La dirección SIP de una persona. Las direcciones del Protocolo inicial de sesión se utilizan para las comunicaciones de VoIP a fin de realizar llamadas de voz o videollamadas mediante Internet.

Representación JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string
}
Campos
metadata

object (FieldMetadata)

Metadatos sobre la dirección SIP.
value

string

La dirección SIP en formato RFC 3261 19.1.
type

string

El tipo de la dirección SIP. El tipo puede ser personalizado o uno de estos valores predefinidos:

  • home
  • work
  • mobile
  • other
formattedType

string

Solo salida. Es el tipo de dirección SIP traducida y con formato en la configuración regional de la cuenta del usuario o del encabezado HTTP Accept-Language.

Skill

Una habilidad que tiene la persona.

Representación JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Campos
metadata

object (FieldMetadata)

Metadatos sobre la habilidad.
value

string

La habilidad; por ejemplo, underwater basket weaving

Eslogan

OBSOLETO: No se mostrarán datos. Es una descripción breve de una línea sobre la persona.

Representación JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Campos
metadata

object (FieldMetadata)

Metadatos sobre la descripción breve
value

string

La descripción.

URL

Las URL asociadas a una persona.

Representación JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string
}
Campos
metadata

object (FieldMetadata)

Metadatos sobre la URL.
value

string

La URL.
type

string

Es el tipo de URL. El tipo puede ser personalizado o uno de estos valores predefinidos:

  • home
  • work
  • blog
  • profile
  • homePage
  • ftp
  • reservations
  • appInstallPage: Sitio web de una aplicación de Currents.
  • other
formattedType

string

Solo salida. Es el tipo de URL traducido y con el formato establecido en la configuración regional de la cuenta del usuario o en la configuración regional del encabezado HTTP Accept-Language.

Definido por el usuario

Datos de usuario arbitrarios que propagan los usuarios finales.

Representación JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "key": string,
  "value": string
}
Campos
metadata

object (FieldMetadata)

Metadatos sobre los datos definidos por el usuario.
key

string

La clave especificada por el usuario final de los datos definidos por el usuario.
value

string

El valor especificado por el usuario final de los datos definidos por el usuario.

Métodos

batchCreateContacts

Crea un lote de contactos nuevos y muestra las respuestas de persona para la nueva

Las solicitudes de mutación del mismo usuario se deben enviar de forma secuencial para evitar una mayor latencia y fallas.

batchDeleteContacts

 Borra un lote de contactos.

batchUpdateContacts

 Actualiza un lote de contactos y muestra un mapa con los nombres de los recursos a PersonResponses para los contactos actualizados.

createContact

 Crea un contacto nuevo y muestra el recurso de persona para ese contacto.

deleteContact

 Borra una persona de contacto.

deleteContactPhoto

 Borrar la foto de un contacto.

get

 Proporciona información acerca de una persona mediante la especificación de un nombre de recurso.

getBatchGet

 Proporciona información sobre una lista de personas específicas mediante la especificación de una lista de nombres de recursos solicitados.

listDirectoryPeople

 Proporciona una lista de perfiles de dominio y contactos de dominio en el directorio de dominio del usuario autenticado.

searchContacts

 Proporciona una lista de los contactos agrupados del usuario autenticado que coincide con la búsqueda.

searchDirectoryPeople

 Proporciona una lista de los perfiles del dominio autenticados y los contactos del dominio que coinciden con la consulta de búsqueda.

updateContact

 Actualice los datos de contacto de una persona de contacto existente.

updateContactPhoto

 Actualiza la foto de un contacto.