REST Resource: people

Recurso: Person

Información sobre una persona combinada a partir 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 configurado 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 que asigna el servidor. Una cadena ASCII con el formato people/{person_id}.
etag

string

La etiqueta de entidad HTTP del recurso. Se usa para la validación de la 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)

Indica 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 para fuentes de contacto.
birthdays[]

object (Birthday)

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

object (BraggingRights)

OBSOLETO: No se mostrarán datos sobre el derecho a presumir de la persona.
calendarUrls[]

object (CalendarUrl)

Las URLs del 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 se limita a 100. Si un objeto Person tiene más direcciones de correo electrónico, se puede obtener todo el conjunto llamando a people.getBatchGet.
events[]

object (Event)

Los eventos de la persona.
externalIds[]

object (ExternalId)

El ID externo de la persona
fileAses[]

object (FileAs)

El estado de los archivos de la persona.
genders[]

object (Gender)

El género de la persona. Este campo es un singleton para 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 regionales de la persona.
locations[]

object (Location)

Las ubicaciones de la persona.
memberships[]

object (Membership)

Pertenencia al grupo de la persona.
miscKeywords[]

object (MiscKeyword)

Las palabras clave varias de la persona.
names[]

object (Name)

El nombre de la persona. Este campo es un singleton para fuentes de contacto.
nicknames[]

object (Nickname)

Los sobrenombres de la persona.
occupations[]

object (Occupation)

Las ocupaciones 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 se limita a 100. Si una persona tiene más números de teléfono, se puede obtener todo el conjunto llamando a people.getBatchGet.
photos[]

object (Photo)

Solo salida. Son 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 sobre los intereses sentimentales de la persona.
relationshipStatuses[]
(deprecated)

object (RelationshipStatus)

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

object (Residence)

OBSOLETO: (En su lugar, usa person.locations) Las residencias de la persona.
sipAddresses[]

object (SipAddress)

Son 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 en los eslóganes de la persona.
urls[]

object (Url)

Son las URLs asociadas de la persona.
userDefined[]

object (UserDefined)

Los datos de la persona definidos por el usuario.

PersonMetadata

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 haya tenido esta persona. Se propaga solo para las solicitudes de 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 verificado, un número de teléfono verificado o la URL de perfil.
linkedPeopleResourceNames[]

string

Solo salida. Nombres de recursos de personas vinculadas a este recurso.
deleted

boolean

Solo salida. Es verdadero si se borró el recurso de persona. Se propaga solo para las solicitudes de sincronización 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 de persona.

Fuente

La fuente de un campo.

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

enum (SourceType)

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

Es la etiqueta de entidad HTTP de la fuente. Se usa para la validación de la 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 una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

Campo de unión metadata. Solo se propaga en person.metadata.sources.

Metadatos sobre la fuente metadata puede ser una de las siguientes opciones:
profileMetadata

object (ProfileMetadata)

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

Metadatos sobre una fuente de tipo PROFILE.

SourceType

Es el tipo de una fuente.

Enumeraciones
SOURCE_TYPE_UNSPECIFIED Sin especificar.
ACCOUNT Cuenta de Google
PROFILE Perfil de Google. Puedes ver el perfil en https://profiles.google.com/{id}, donde {id} es el ID de la fuente.
DOMAIN_PROFILE Perfil del dominio de Google Workspace.
CONTACT Contacto de Google. Puedes ver el contacto en https://contact.google.com/{id}, donde {id} es el ID de la fuente.
OTHER_CONTACT Google “Otro contacto”.
DOMAIN_CONTACT Contacto compartido de dominio de Google Workspace.

ProfileMetadata

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 usuario escribe.

ObjectType

El tipo de objeto de persona.

Enumeraciones
OBJECT_TYPE_UNSPECIFIED Sin especificar.
PERSON Persona.
PAGE Página de Currents.

UserType

Es el tipo de usuario.

Enumeraciones
USER_TYPE_UNKNOWN El tipo de usuario es desconocido.
GOOGLE_USER El usuario es un usuario de Google.
GPLUS_USER Es usuario de Currents.
GOOGLE_APPS_USER El usuario es un usuario de Google Workspace.

Dirección

La dirección física de una persona. Puede ser un apartado postal o la dirección postal. 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 el usuario no establece esta opción, se creará automáticamente a partir de valores estructurados.
type

string

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

  • home
  • work
  • other
formattedType

string

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

string

El apartado P.O. 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

Ciudad de la dirección
region

string

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

string

Código postal de la dirección
country

string

País de la dirección
countryCode

string

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

FieldMetadata

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 campo principal para todas las fuentes de la persona. Cada persona tendrá, como máximo, un campo con primary establecido como verdadero.
sourcePrimary

boolean

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

boolean

Solo salida. Es verdadero si el campo está verificado. Es falso si el campo no está verificado. Por lo general, un campo verificado es un nombre, una dirección de correo electrónico, un número de teléfono o un sitio web que se confirma que es propiedad de la persona.
source

object (Source)

Es la fuente del campo.

Rango de edades

OBSOLETO (en su lugar, usa person.ageRanges)

El rango de edad de una persona.

Enumeraciones
AGE_RANGE_UNSPECIFIED Sin especificar.
LESS_THAN_EIGHTEEN Menor de dieciocho años.
EIGHTEEN_TO_TWENTY Entre dieciocho y veinte.
TWENTY_ONE_OR_OLDER Veintiún y más.

AgeRangeType

El rango de edad de una persona.

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

object (FieldMetadata)

Metadatos sobre rango de edad
ageRange

enum (AgeRange)

Indica el rango de edad.

Biografía

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

El tipo de contenido de la biografía.

ContentType

Indica el tipo de contenido.

Enumeraciones
CONTENT_TYPE_UNSPECIFIED Sin especificar.
TEXT_PLAIN Texto sin formato
TEXT_HTML Texto HTML.

Fecha de nacimiento

El cumpleaños de una persona. Se especifica 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 así sea. Los clientes siempre deben configurar el campo date cuando cambien los cumpleaños.

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

object (FieldMetadata)

Metadatos sobre el cumpleaños
date

object (Date)

Es la fecha estructurada de cumpleaños.
text
(deprecated)

string

Prefiere usar el campo date si está configurado.

Es una cadena 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. Puede representar una de las siguientes opciones:

  • Una fecha completa con valores para el año, mes y día que no sean cero.
  • Un mes y un día, con cero año (por ejemplo, un aniversario).
  • Un año por sí solo, con un mes cero y un día cero.
  • Es un año y un mes, con un día cero (por ejemplo, la fecha de vencimiento de una tarjeta de crédito).

Tipos relacionados:

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

integer

Año de la fecha. Debe ser entre 1 y 9,999, o bien 0 para especificar una fecha sin año.
month

integer

Mes del año. Debe ser del 1 al 12 o 0 para especificar un año sin un mes ni un día.
day

integer

Día del mes. Debe ser entre 1 y 31 y ser válido para el año y el mes o bien 0 para especificar un año solo o un año y un mes en los que el día no sea significativo.

BraggingRights

OBSOLETO: No se mostrarán datos. Indica el derecho a presumir de una persona.

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

object (FieldMetadata)

Metadatos sobre el derecho a presumir
value

string

El derecho a presumir por ejemplo, climbed mount everest.

CalendarUrl

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

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 según la configuración regional de la cuenta del usuario o la configuración regional del encabezado HTTP Accept-Language.

ClientData

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

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

object (FieldMetadata)

Metadatos sobre los datos del cliente
key

string

El cliente especificó la clave de los datos del cliente.
value

string

El cliente especificó el valor de los datos del cliente.

CoverPhoto

La foto de portada de una persona. Se muestra una imagen grande en la página de perfil de la persona que representa quién es o qué le interesa.

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 foto de portada 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

Es la dirección de correo electrónico.
type

string

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. El tipo de dirección de correo electrónico traducida y con formato según la configuración regional de la cuenta del usuario o la configuración regional 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)

Es 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. Es el tipo de evento traducido y con formato en la configuración regional de la cuenta del usuario o en la configuración regional del encabezado HTTP Accept-Language.

ID externo

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

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

  • account
  • customer
  • loginId
  • network
  • organization
formattedType

string

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

FileAs

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

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

object (FieldMetadata)

Los metadatos sobre el archivo como
value

string

El valor file-as

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

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

  • male
  • female
  • unspecified
formattedValue

string

Solo salida. El valor del género traducido y con formato 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 en formato libre para los pronombres que deben usarse para dirigirse a la persona. Los valores comunes son los siguientes:

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

ImClient

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 según la configuración regional de la cuenta del usuario o la configuración regional 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 con formato de la configuración regional de la cuenta del visualizador 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 idioma de una persona.

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

object (FieldMetadata)

Metadatos sobre la configuración regional
value

string

Es la etiqueta de idioma IETF BCP 47 con formato correcto que representa la configuración regional.

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 ubicación actual.
buildingId

string

Es 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

Es la membresía de una persona en un grupo. Solo se puede modificar la pertenencia a los 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 los miembros
Campo de unión membership. La membresía. Las direcciones (membership) solo pueden ser una de las siguientes opciones:
contactGroupMembership

object (ContactGroupMembership)

Es la membresía del grupo de contactos.
domainMembership

object (DomainMembership)

Solo salida. Es la membresía del dominio.

ContactGroupMembership

Pertenencia a un grupo de contactos de Google

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

string

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

string

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

DomainMembership

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.

MiscKeyword

La palabra clave miscelánea de un usuario.

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

object (FieldMetadata)

Metadatos sobre la palabra clave miscelánea
value

string

El valor de la palabra clave miscelánea.
type

enum (KeywordType)

Es el tipo de palabra clave miscelánea.
formattedType

string

Solo salida. Es el tipo de palabra clave varias traducidas y con formato según la configuración regional de la cuenta del usuario o la configuración regional del encabezado HTTP Accept-Language.

KeywordType

Tipo de palabra clave variada.

Enumeraciones
TYPE_UNSPECIFIED Sin especificar.
OUTLOOK_BILLING_INFORMATION Campo de Outlook para los datos de facturación.
OUTLOOK_DIRECTORY_SERVER Campo de Outlook para el servidor de directorio.
OUTLOOK_KEYWORD Campo de Outlook para la palabra clave.
OUTLOOK_MILEAGE Campo de Outlook para el kilometraje.
OUTLOOK_PRIORITY Campo de Outlook para la prioridad.
OUTLOOK_SENSITIVITY Campo de Outlook para sensibilidad.
OUTLOOK_SUBJECT Campo de Outlook para el asunto.
OUTLOOK_USER Campo de Outlook para el usuario.
HOME Página de inicio
WORK Trabajo.
OTHER Otro rol

Nombre

El nombre de una persona. Si el nombre es un nombre real, significa que el apellido 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 con el formato que depende de la configuración regional especificada por la cuenta del usuario o el encabezado HTTP Accept-Language.
displayNameLastFirst

string

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

string

El valor del nombre en formato libre.
familyName

string

El apellido.
givenName

string

Es el nombre específico.
middleName

string

El 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 tal como se escribe.
phoneticFamilyName

string

El apellido escrito tal como suena.
phoneticGivenName

string

El nombre que se escribe así como suena.
phoneticMiddleName

string

Los segundos nombres escritos tal como suenan.
phoneticHonorificPrefix

string

Son los prefijos honoríficos que se escriben a medida que suenan.
phoneticHonorificSuffix

string

Los sufijos honoríficos que se escriben cuando 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.

NicknameType

Indica el tipo de sobrenombre.

Enumeraciones
DEFAULT Sobrenombre genérico.
MAIDEN_NAME

Apellido de soltera o apellido. Se usa cuando el apellido de la persona cambió como resultado del matrimonio.
INITIALS

Iniciales.
GPLUS

Sobrenombre del perfil de Google+.
OTHER_NAME

Una afiliación profesional u otro nombre por ejemplo, Dr. Smith.
ALTERNATE_NAME Nombre alternativo con el que se conoce a la persona.
SHORT_NAME

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

Ocupación

Ocupación de una persona.

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

object (FieldMetadata)

Metadatos sobre la ocupación
value

string

La ocupación por ejemplo, carpenter.

Organización

El pasado o la organización actual de una persona. Se permiten 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 traducida y con formato en la configuración regional de la cuenta del usuario o en la configuración regional del encabezado HTTP Accept-Language.
startDate

object (Date)

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

object (Date)

Es la fecha de finalización en la que la persona abandonó la organización.
current

boolean

Verdadero si la organización es la organización actual de la persona. Falso si la organización es una organización anterior.
name

string

Es el nombre de la organización.
phoneticName

string

Es el nombre fonético de la organización.
department

string

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

string

El cargo 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 de la organización en la que trabaja la persona.
costCenter

string

El centro de costos de la persona en la organización.
fullTimeEquivalentMillipercent

integer

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

Númerotelefónico

El 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

Indica el número de teléfono.
canonicalForm

string

Solo salida. El formato ITU-T E.164 canónicaizado 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. El tipo de número de teléfono traducido y con formato según la configuración regional de la cuenta del usuario o la configuración regional del encabezado HTTP Accept-Language.

Foto

La foto de una persona. Una foto junto al nombre de la persona para ayudar a que los demás la reconozcan

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

object (FieldMetadata)

Metadatos de la foto
url

string

La URL de la foto. Para cambiar el tamaño deseado, agrega un parámetro de consulta sz={size} al final de la URL, donde {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 predeterminada. false si la foto es una proporcionada por el usuario.

Relación

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 se refiere esta relación.
type

string

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. El tipo de relación traducida y con formato en la configuración regional de la cuenta del visualizador o la configuración regional especificada en el encabezado HTTP Accept-Language.

RelationshipInterest

OBSOLETO: No se mostrarán datos sobre el interés en la relación de una persona .

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

object (FieldMetadata)

Metadatos sobre los intereses de la relación
value

string

Es 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. Es el valor del interés de la relación traducido y con formato en la configuración regional de la cuenta del usuario o en la configuración regional especificada en el encabezado HTTP Accept-Language.

RelationshipStatus

OBSOLETO: No se mostrarán datos sobre el estado de la relación de una 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 de la relación. El valor puede ser personalizado o uno de estos valores predefinidos:

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

string

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

Residencia

OBSOLETO: En su lugar, usa person.locations. La residencia anterior o actual 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 anterior.

SipAddress

La dirección SIP de una persona. Las direcciones del protocolo inicial de la sesión se utilizan para las comunicaciones VoIP para hacer llamadas de voz o video por 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 el formato de URI de SIP RFC 3261 19.1.
type

string

El tipo de 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 en la configuración regional del encabezado HTTP Accept-Language.

Skill

Es una habilidad que la persona tiene.

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

object (FieldMetadata)

Metadatos sobre la destreza
value

string

La destreza; por ejemplo, underwater basket weaving.

Eslogan

OBSOLETO: No se mostrarán datos. Una descripción breve de una línea de 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 breve

URL

Son las URLs asociadas de 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: Es el sitio web de una app de Currents.
  • other
formattedType

string

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

UserDefined

Son datos arbitrarios del usuario 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 que especificó el usuario final de los datos definidos por el usuario

Métodos

batchCreateContacts

Crear un lote de contactos nuevos y mostrar las PersonResponses para los

Las solicitudes de modificación para el mismo usuario deben enviarse de forma secuencial para evitar el aumento de la latencia y las fallas.

batchDeleteContacts

 Eliminar un lote de contactos

batchUpdateContacts

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

createContact

 Crea un contacto nuevo y devuelve el recurso de personas para ese contacto.

deleteContact

 Borrar una persona de contacto

deleteContactPhoto

 Borra la foto de un contacto.

get

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

getBatchGet

 Proporciona información sobre una lista de personas específicas a través de 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 coinciden con la búsqueda.

searchDirectoryPeople

 Proporciona una lista de perfiles de dominio y contactos de dominio en el directorio de dominio del usuario autenticado que coinciden con la búsqueda.

updateContact

 Actualizar los datos de contacto de una persona de contacto existente

updateContactPhoto

 Actualiza la foto de un contacto.