REST Resource: people

Recurso: Person

Es la 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 tendrá exactamente un campo con metadata.primary establecido 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 de recurso de la persona, asignado por 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)

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

birthdays[]

object (Birthday)

Los cumpleaños de la persona. Este campo es un singleton para fuentes de contactos.

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. En people.connections.list y otherContacts.list, la cantidad de direcciones de correo electrónico se limita a 100. Si una persona 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)

Los IDs externos de la persona.

fileAses[]

object (FileAs)

El archivo file-ases de la persona.

genders[]

object (Gender)

El género de la persona. Este campo es un singleton para fuentes de contactos.

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 del grupo de la persona.

miscKeywords[]

object (MiscKeyword)

Las palabras clave varias de la persona.

names[]

object (Name)

Los nombres de las personas. Este campo es un singleton para fuentes de contactos.

nicknames[]

object (Nickname)

Los sobrenombres de la persona.

occupations[]

object (Occupation)

Las ocupaciones de la persona.

organizations[]

object (Organization)

Las organizaciones anteriores o actuales de la persona.

phoneNumbers[]

object (PhoneNumber)

Los números de teléfono de la persona. En el caso de 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. 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 respecto de los intereses de la relación de la persona.

relationshipStatuses[]
(deprecated)

object (RelationshipStatus)

Solo salida. OBSOLETO: No se mostrarán datos sobre los estados de relación de la persona.

residences[]
(deprecated)

object (Residence)

OBSOLETO: (En su lugar, usa person.locations). Las 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 los eslóganes de la persona.

urls[]

object (Url)

Las URLs asociadas con la persona.

userDefined[]

object (UserDefined)

Son los datos definidos por el usuario de la persona.

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 anterior de recursos que haya tenido esta persona. 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 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 de people.connections.list y otherContacts.list.

objectType
(deprecated)

enum (ObjectType)

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

Es el tipo de objeto 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.

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 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 del tipo PROFILE.

SourceType

Es el tipo de una fuente.

Enumeradores
SOURCE_TYPE_UNSPECIFIED No se especifica.
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 de 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 "Otro contacto" de Google.
DOMAIN_CONTACT Contacto compartido en el 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

Es el tipo de un objeto persona.

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

UserType

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 un usuario de Google Workspace.

Dirección

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 el usuario no establece esto, se creará automáticamente a partir de valores estructurados.

type

string

Es el tipo de la dirección. El tipo puede ser personalizado o uno de los siguientes valores predefinidos:

  • home
  • work
  • other
formattedType

string

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

Indica 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

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. Es 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 campo principal de 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 y 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 cuya propiedad se confirmó como propiedad de la persona.

source

object (Source)

La fuente del campo.

AgeRange

OBSOLETO (en su lugar, usa person.ageRanges)

El 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 los 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 el rango de edad

ageRange

enum (AgeRange)

El rango de edad.

Biografía

Biografía breve 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

Biografía corta.

contentType

enum (ContentType)

Es el tipo de contenido de la biografía.

ContentType

Es el tipo de contenido.

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

Fecha de nacimiento

Es el cumpleaños de una persona. Se especificó 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 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 la fecha de nacimiento.

text
(deprecated)

string

Prefiere usar el campo date si se configuró.

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 no son significativas. La fecha está relacionada con el calendario gregoriano. Esto puede representar uno de los siguientes elementos:

  • Una fecha completa, con valores de año, mes y día que no sean cero
  • Es un mes y un día con un año en cero (por ejemplo, un aniversario).
  • Un año 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 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 bien 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 año y el mes, o 0 para especificar un año por sí mismo o un año y un mes cuando el día no sea importante.

BraggingRights

OBSOLETO: No se mostrarán datos sobre 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

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

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

  • home
  • freeBusy
  • work
formattedType

string

Solo salida. Es el tipo de URL del calendario 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.

ClientData

Datos del cliente arbitrarios que los clientes completan. 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

La clave de los datos del cliente que especificó el cliente.

value

string

El valor que especifica el cliente de los datos del cliente.

CoverPhoto

La foto de portada de una persona Una imagen grande que se muestra en la página de perfil de una persona y 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; falso si es una foto de portada proporcionada por el usuario.

EmailAddress

Es 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

El tipo de dirección de correo electrónico. El tipo puede ser personalizado o uno de los siguientes valores predefinidos:

  • home
  • work
  • other
formattedType

string

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

Es 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 los siguientes valores predefinidos:

  • anniversary
  • other
formattedType

string

Solo salida. Indica el tipo del evento 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.

ExternalId

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 los siguientes valores predefinidos:

  • account
  • customer
  • loginId
  • network
  • organization
formattedType

string

Solo salida. Indica el tipo del evento 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.

FileAs

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

Metadatos sobre el archivo como

value

string

El valor de archivo como

Género

El género de la persona.

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

object (FieldMetadata)

Metadatos sobre el género.

value

string

Es 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. Indica el valor del género 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. Si no se especifica o el valor personalizado no está localizado.

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 los siguientes valores predefinidos:

  • home
  • work
  • other
formattedType

string

Solo salida. El tipo de cliente de IM traducido y formateado 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 el formato de la configuración regional de la cuenta del usuario 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 el 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

Es 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 los siguientes valores predefinidos:

  • desk
  • grewUp
current

boolean

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 del escritorio individual.

Membresía

La membresía de una persona en un grupo. Solo se pueden modificar las membresías del grupo 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)

Pertenencia al grupo de contactos.

domainMembership

object (DomainMembership)

Solo salida. 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 pertenencia al grupo de contactos.

contactGroupResourceName

string

El nombre de recurso del grupo de contactos, asignado por el servidor. Una cadena ASCII, con el formato de contactGroups/{contactGroupId}. Solo se puede usar contactGroupResourceName para modificar las membresías. Se puede quitar cualquier pertenencia a un grupo de contactos, pero solo se puede agregar la pertenencia a grupos de usuarios, o a los grupos del sistema "myContacts" o "destacado". Los contactos siempre deben 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)

El tipo de palabra clave misceláneo.

formattedType

string

Solo salida. El tipo de palabra clave miscelánea 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.

KeywordType

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 Outlook para el kilometraje.
OUTLOOK_PRIORITY Campo de Outlook para la prioridad.
OUTLOOK_SENSITIVITY Campo de Outlook para la sensibilidad.
OUTLOOK_SUBJECT Campo de Outlook para el asunto.
OUTLOOK_USER Campo de Outlook para el usuario.
HOME Pantalla principal
WORK Trabajo.
OTHER Otro rol

Nombre

El nombre de una persona. Si el nombre es un monoónimo, el nombre de la familia estará 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 un formato que depende de la configuración regional especificada por la cuenta del usuario o del encabezado HTTP Accept-Language.

displayNameLastFirst

string

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

unstructuredName

string

Es el valor del nombre de formato libre.

familyName

string

El apellido.

givenName

string

Es el nombre dado.

middleName

string

Los segundos nombres

honorificPrefix

string

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

honorificSuffix

string

Los sufijos honoríficos, como Jr.

phoneticFullName

string

El nombre completo se deletrea como suena.

phoneticFamilyName

string

Nombre de familia deletreado como suena.

phoneticGivenName

string

El nombre específico se deletrea como suena.

phoneticMiddleName

string

Segundo nombre escrito

phoneticHonorificPrefix

string

Prefijos honoríficos que se deletrean como suenan.

phoneticHonorificSuffix

string

Son sufijos honoríficos que se deletrean como suenan.

Apodo

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)

Es el tipo de sobrenombre.

NicknameType

Es el tipo de un sobrenombre.

Enumeradores
DEFAULT Sobrenombre genérico.
MAIDEN_NAME

Apellido de soltera o apellido natural. 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 por el que se conoce a la persona.
SHORT_NAME

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

Occupation

La ocupación de una persona.

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

object (FieldMetadata)

Metadatos sobre la profesión.

value

string

Indica la ocupación; por ejemplo, carpenter.

Organización

Es la organización anterior o 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 los siguientes valores predefinidos:

  • work
  • school
formattedType

string

Solo salida. Indica el tipo de organización que se tradujo y se le dio 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)

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

endDate

object (Date)

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

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

jobDescription

string

Es 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 de cotización bursátil, una abreviatura o un acrónimo.

domain

string

Es 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

Es 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 (100000 = 100%).

PhoneNumber

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

Es el número de teléfono.

canonicalForm

string

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

type

string

Indica el tipo de número de teléfono. El tipo puede ser personalizado o uno de los siguientes valores predefinidos:

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

string

Solo salida. Es el tipo del 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 que se muestra junto al nombre de la persona para que los demás la reconozcan.

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. Puedes cambiar el tamaño deseado si agregas 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 una foto predeterminada; falso si es una foto 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 entre la persona y la otra persona. El tipo puede ser personalizado o uno de los siguientes 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 formateado en la configuración regional de la cuenta del usuario o en 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 el interés en la relación.

value

string

El tipo de relación que la persona busca. El valor puede ser personalizado o uno de los siguientes:

  • friend
  • date
  • relationship
  • networking
formattedValue

string

Solo salida. 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 civil 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

Estado de la relación. El valor puede ser personalizado o uno de los siguientes:

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

string

Solo salida. El valor del estado de 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 actual o pasada 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; falso 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 realizar llamadas de voz o videollamadas 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 formato de URI de SIP RFC 3261 19.1.

type

string

Es el tipo de dirección SIP. El tipo puede ser personalizado o uno de los siguientes valores predefinidos:

  • home
  • work
  • mobile
  • other
formattedType

string

Solo salida. Es el tipo de dirección SIP traducida y formateada en la configuración regional de la cuenta del usuario o en la configuración regional 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 destreza.

value

string

La habilidad, 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

El eslogan.

URL

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

Es la URL.

type

string

Es el tipo de la URL. El tipo puede ser personalizado o uno de los siguientes 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 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.

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)

Son los metadatos sobre los datos definidos por el usuario.

key

string

Es la clave especificada por el usuario final de los datos definidos por el usuario.

value

string

Es el valor que especifica el usuario final de los datos que define el usuario.

Métodos

batchCreateContacts

Crea un lote de contactos nuevos y devuelve las PersonResponses para el nuevo

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

batchDeleteContacts

Borra 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 muestra el recurso de persona correspondiente a ese contacto.

deleteContact

Borra 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 mediante la especificación de una lista de nombres de recursos solicitados.

listDirectoryPeople

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

searchContacts

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

searchDirectoryPeople

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

updateContact

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

updateContactPhoto

Actualiza la foto de un contacto.