REST Resource: people

Recurso: Person

Informações sobre uma pessoa mescladas de várias fontes de dados, como contatos e dados de perfil do usuário autenticado.

A maioria dos campos pode ter vários itens. Os itens em um campo não têm ordem garantida, mas cada campo não vazio tem a garantia de ter exatamente um campo com metadata.primary definido como verdadeiro.

Representação 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

O nome de recurso da pessoa, atribuído pelo servidor. Uma string ASCII no formato de people/{person_id}.
etag

string

A tag de entidade HTTP do recurso. Usado para validação de cache da Web.
metadata

object (PersonMetadata)

Apenas saída. Metadados sobre a pessoa.
addresses[]

object (Address)

Os endereços da pessoa.
ageRange
(deprecated)

enum (AgeRange)

Apenas saída. USO SUSPENSO (Use person.ageRanges)

A faixa etária da pessoa.
ageRanges[]

object (AgeRangeType)

Apenas saída. As faixas etárias da pessoa.
biographies[]

object (Biography)

As biografias da pessoa. Este campo é um Singleton para origens de contato.
birthdays[]

object (Birthday)

Aniversários da pessoa. Este campo é um Singleton para origens de contato.
braggingRights[]
(deprecated)

object (BraggingRights)

DESCONTINUADO: nenhum dado será retornado.
calendarUrls[]

object (CalendarUrl)

Os URLs da agenda da pessoa.
clientData[]

object (ClientData)

Os dados do cliente da pessoa.
coverPhotos[]

object (CoverPhoto)

Apenas saída. As fotos da capa da pessoa.
emailAddresses[]

object (EmailAddress)

Endereços de e-mail da pessoa. Para people.connections.list e otherContacts.list, o número de endereços de e-mail é limitado a 100. Se uma pessoa tiver mais endereços de e-mail, chame people.getBatchGet para acessar todo o conjunto.
events[]

object (Event)

Os eventos da pessoa.
externalIds[]

object (ExternalId)

IDs externos da pessoa.
fileAses[]

object (FileAs)

As tabelas de arquivo da pessoa.
genders[]

object (Gender)

O gênero da pessoa. Este campo é um Singleton para origens de contato.
imClients[]

object (ImClient)

Os clientes de mensagens instantâneas da pessoa.
interests[]

object (Interest)

Os interesses da pessoa.
locales[]

object (Locale)

As preferências de localidade da pessoa.
locations[]

object (Location)

A localização da pessoa.
memberships[]

object (Membership)

As associações a grupos da pessoa.
miscKeywords[]

object (MiscKeyword)

As palavras-chave diversas da pessoa.
names[]

object (Name)

Os nomes da pessoa. Este campo é um Singleton para origens de contato.
nicknames[]

object (Nickname)

O apelido da pessoa.
occupations[]

object (Occupation)

As profissões da pessoa.
organizations[]

object (Organization)

São as organizações antigas ou atuais da pessoa.
phoneNumbers[]

object (PhoneNumber)

Os números de telefone da pessoa. Para people.connections.list e otherContacts.list, o número de números de telefone é limitado a 100. Se uma pessoa tiver mais números de telefone, todo o conjunto poderá ser acessado chamando people.getBatchGet.
photos[]

object (Photo)

Apenas saída. As fotos da pessoa.
relations[]

object (Relation)

As relações da pessoa.
relationshipInterests[]
(deprecated)

object (RelationshipInterest)

Apenas saída. DESCONTINUADO: nenhum dado será retornado sobre os interesses de relacionamento da pessoa.
relationshipStatuses[]
(deprecated)

object (RelationshipStatus)

Apenas saída. DESCONTINUADO: nenhum dado será retornado o status de relacionamento da pessoa.
residences[]
(deprecated)

object (Residence)

DESCONTINUADA: (use person.locations) a residência da pessoa.
sipAddresses[]

object (SipAddress)

Endereços SIP da pessoa.
skills[]

object (Skill)

As habilidades da pessoa.
taglines[]
(deprecated)

object (Tagline)

Apenas saída. DESCONTINUADO: nenhum dado será retornado nos slogans da pessoa.
urls[]

object (Url)

URLs associados à pessoa.
userDefined[]

object (UserDefined)

Dados definidos pelo usuário da pessoa.

PersonMetadata

Os metadados sobre uma pessoa.

Representação JSON 
{
  "sources": [
    {
      object (Source)
    }
  ],
  "previousResourceNames": [
    string
  ],
  "linkedPeopleResourceNames": [
    string
  ],
  "deleted": boolean,
  "objectType": enum (ObjectType)
}
Campos
sources[]

object (Source)

As fontes de dados da pessoa.
previousResourceNames[]

string

Apenas saída. Todos os nomes de recurso anteriores que essa pessoa teve. Preenchido apenas para solicitações people.connections.list que incluem um token de sincronização.

O nome do recurso pode mudar ao adicionar ou remover campos que vinculam um contato e um perfil, como um e-mail ou número de telefone verificados.
linkedPeopleResourceNames[]

string

Apenas saída. Nomes de recursos de pessoas vinculadas a este recurso.
deleted

boolean

Apenas saída. Verdadeiro se o recurso da pessoa tiver sido excluído. Preenchido apenas para solicitações de sincronização people.connections.list e otherContacts.list.
objectType
(deprecated)

enum (ObjectType)

Apenas saída. USO SUSPENSO (Use person.metadata.sources.profileMetadata.objectType)

O tipo do objeto de pessoa.

Origem

A fonte de um campo.

Representação 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)

O tipo de origem.
id

string

O identificador exclusivo dentro do tipo de origem gerado pelo servidor.
etag

string

Preenchido apenas em person.metadata.sources.

A tag de entidade HTTP da origem. Usado para validação de cache da Web.
updateTime

string (Timestamp format)

Apenas saída. Preenchido apenas em person.metadata.sources.

Carimbo de data/hora da última atualização desta origem.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

Campo de união metadata. Preenchido apenas em person.metadata.sources.

Metadados sobre a origem. metadata pode ser apenas de um dos tipos a seguir:
profileMetadata

object (ProfileMetadata)

Apenas saída. Preenchido apenas em person.metadata.sources.

Metadados sobre uma origem do tipo PROFILE.

SourceType

O tipo de uma fonte.

Enums
SOURCE_TYPE_UNSPECIFIED Não especificado.
ACCOUNT Uma Conta do Google.
PROFILE Perfil do Google. Acesse o perfil em https://profiles.google.com/{id}, em que {id} é o código de origem.
DOMAIN_PROFILE Perfil do domínio do Google Workspace.
CONTACT Contato do Google: Veja o contato em https://contact.google.com/{id}, em que {id} é o código da origem.
OTHER_CONTACT "Outro contato" do Google.
DOMAIN_CONTACT Contato compartilhado do domínio do Google Workspace.

ProfileMetadata

Os metadados sobre um perfil.

Representação JSON 
{
  "objectType": enum (ObjectType),
  "userTypes": [
    enum (UserType)
  ]
}
Campos
objectType

enum (ObjectType)

Apenas saída. O tipo de objeto do perfil.
userTypes[]

enum (UserType)

Apenas saída. Os tipos de usuário.

ObjectType

O tipo de um objeto de pessoa.

Enums
OBJECT_TYPE_UNSPECIFIED Não especificado.
PERSON Pessoa.
PAGE Página do Currents.

UserType

O tipo de usuário.

Enums
USER_TYPE_UNKNOWN O tipo de usuário é desconhecido.
GOOGLE_USER O usuário é um usuário do Google.
GPLUS_USER O usuário é um usuário do Currents.
GOOGLE_APPS_USER O usuário é um usuário do Google Workspace.

Endereço

O endereço físico de uma pessoa. Pode ser uma caixa postal ou o endereço. Todos os campos são opcionais.

Representação 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)

Metadados sobre o endereço.
formattedValue

string

O valor não estruturado do endereço. Se ele não for definido pelo usuário, será construído automaticamente a partir de valores estruturados.
type

string

Tipo de endereço. O tipo pode ser personalizado ou um destes valores predefinidos:

  • home
  • work
  • other
formattedType

string

Apenas saída. O tipo de endereço traduzido e formatado na localidade da conta do leitor ou na localidade do cabeçalho HTTP Accept-Language.
poBox

string

A caixa postal do endereço.
streetAddress

string

É o endereço.
extendedAddress

string

O endereço completo do endereço. por exemplo, o número do apartamento.
city

string

A cidade do endereço.
region

string

A região do endereço. por exemplo, o estado ou a província.
postalCode

string

CEP do endereço.
country

string

O país do endereço.
countryCode

string

O código do país ISO 3166-1 alfa-2 do endereço.

FieldMetadata

Metadados sobre um campo.

Representação JSON 
{
  "primary": boolean,
  "sourcePrimary": boolean,
  "verified": boolean,
  "source": {
    object (Source)
  }
}
Campos
primary

boolean

Apenas saída. Verdadeiro se o campo for o campo principal para todas as fontes na pessoa. Cada pessoa terá no máximo um campo com primary definido como verdadeiro.
sourcePrimary

boolean

Verdadeiro se o campo for o principal para o source. Cada origem precisa ter no máximo um campo com sourcePrimary definido como verdadeiro.
verified

boolean

Apenas saída. Verdadeiro se o campo for verificado. "false" se o campo não foi verificado. Um campo verificado normalmente é um nome, endereço de e-mail, número de telefone ou site que foi confirmado como propriedade da pessoa.
source

object (Source)

A fonte do campo.

Faixa etária

USO SUSPENSO (Use person.ageRanges)

A faixa etária de uma pessoa.

Enums
AGE_RANGE_UNSPECIFIED Não especificado.
LESS_THAN_EIGHTEEN Com menos de 18 anos.
EIGHTEEN_TO_TWENTY Entre 18 e 20.
TWENTY_ONE_OR_OLDER Vinte e um anos ou mais.

AgeRangeType

Faixa etária de uma pessoa.

Representação JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "ageRange": enum (AgeRange)
}
Campos
metadata

object (FieldMetadata)

Metadados sobre a faixa etária.
ageRange

enum (AgeRange)

A faixa etária.

Biografia

Biografia curta de uma pessoa.

Representação JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "contentType": enum (ContentType)
}
Campos
metadata

object (FieldMetadata)

Metadados sobre a biografia.
value

string

A breve biografia.
contentType

enum (ContentType)

O tipo de conteúdo da biografia.

ContentType

O tipo de conteúdo.

Enums
CONTENT_TYPE_UNSPECIFIED Não especificado.
TEXT_PLAIN Texto simples.
TEXT_HTML Texto HTML.

Aniversário

O aniversário de uma pessoa. Pelo menos um dos campos date e text está especificado. Os campos date e text normalmente representam a mesma data, mas não há garantia disso. Os clientes precisam sempre definir o campo date ao mudarem aniversários.

Representação JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "date": {
    object (Date)
  },
  "text": string
}
Campos
metadata

object (FieldMetadata)

Metadados sobre o aniversário.
date

object (Date)

A data estruturada do aniversário.
text
(deprecated)

string

Prefira usar o campo date, se definido.

String de formato livre que representa o aniversário do usuário. Este valor não é validado.

Data

Representa uma data inteira ou parcial do calendário, como um aniversário. A hora do dia e o fuso horário são especificados em outro lugar ou são insignificantes. A data é referente ao calendário gregoriano. Isso pode representar uma das seguintes opções:

  • uma data completa, com valores de ano, mês e dia diferentes de zero;
  • um mês e dia, com um ano zero (por exemplo, uma data comemorativa);
  • um ano sozinho, com um mês zero e um dia zero;
  • um ano e mês, com um dia zero (por exemplo, uma data de validade de cartão de crédito).

Tipos relacionados:

Representação JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Campos
year

integer

Ano da data. Precisa ser de 1 a 9.999 ou 0 para especificar uma data sem ano.
month

integer

Mês do ano. Precisa ser de 1 a 12, ou 0 para especificar um ano sem um mês e dia.
day

integer

Dia do mês. Precisa ser de 1 a 31 e válido para o ano e o mês, ou 0 para especificar um ano sozinho ou um ano e mês em que o dia não é significativo.

BraggingRights

DESCONTINUADO: nenhum dado será retornado com os motivos de orgulho de uma pessoa.

Representação JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Campos
metadata

object (FieldMetadata)

Metadados sobre os motivos de orgulho.
value

string

Os motivos de orgulho por exemplo, climbed mount everest.

CalendarUrl

URL da agenda de uma pessoa.

Representação JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "url": string,
  "type": string,
  "formattedType": string
}
Campos
metadata

object (FieldMetadata)

Metadados sobre o URL da agenda.
url

string

O URL da agenda.
type

string

O tipo de URL da agenda. O tipo pode ser personalizado ou um destes valores predefinidos:

  • home
  • freeBusy
  • work
formattedType

string

Apenas saída. O tipo de URL da agenda traduzido e formatado na localidade da conta do leitor ou na localidade do cabeçalho HTTP Accept-Language.

ClientData

Dados arbitrários do cliente preenchidos pelos clientes. São permitidas chaves e valores duplicados.

Representação JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "key": string,
  "value": string
}
Campos
metadata

object (FieldMetadata)

Metadados sobre os dados do cliente.
key

string

A chave especificada pelo cliente dos dados do cliente.
value

string

O valor especificado pelo cliente dos dados do cliente.

CoverPhoto

Foto da capa de uma pessoa. Uma imagem grande mostrada na página de perfil da pessoa que representa quem ela é ou o que é do interesse dela.

Representação JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "url": string,
  "default": boolean
}
Campos
metadata

object (FieldMetadata)

Metadados sobre a foto da capa.
url

string

O URL da foto da capa.
default

boolean

Verdadeiro se a foto da capa for a foto de capa padrão. falso se a foto da capa for fornecida pelo usuário.

EmailAddress

Endereço de e-mail de uma pessoa.

Representação JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string,
  "displayName": string
}
Campos
metadata

object (FieldMetadata)

Metadados sobre o endereço de e-mail.
value

string

O endereço de e-mail.
type

string

Tipo de endereço de e-mail. O tipo pode ser personalizado ou um destes valores predefinidos:

  • home
  • work
  • other
formattedType

string

Apenas saída. O tipo de endereço de e-mail traduzido e formatado na localidade da conta do leitor ou na localidade do cabeçalho HTTP Accept-Language.
displayName

string

O nome de exibição do e-mail.

Evento

Um evento relacionado à pessoa.

Representação JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "date": {
    object (Date)
  },
  "type": string,
  "formattedType": string
}
Campos
metadata

object (FieldMetadata)

Metadados sobre o evento.
date

object (Date)

A data do evento.
type

string

O tipo do evento. O tipo pode ser personalizado ou um destes valores predefinidos:

  • anniversary
  • other
formattedType

string

Apenas saída. O tipo do evento traduzido e formatado na localidade da conta do espectador ou na localidade do cabeçalho HTTP Accept-Language.

ExternalId

Identificador de uma entidade externa relacionada à pessoa.

Representação JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string
}
Campos
metadata

object (FieldMetadata)

Metadados sobre o ID externo.
value

string

O valor do ID externo.
type

string

O tipo do ID externo. O tipo pode ser personalizado ou um destes valores predefinidos:

  • account
  • customer
  • loginId
  • network
  • organization
formattedType

string

Apenas saída. O tipo do evento traduzido e formatado na localidade da conta do espectador ou na localidade do cabeçalho HTTP Accept-Language.

FileAs

O nome que deve ser usado para classificar a pessoa em uma lista.

Representação JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Campos
metadata

object (FieldMetadata)

Metadados sobre o arquivo como.
value

string

O valor do arquivo como valor

Gênero

O gênero de uma pessoa.

Representação JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "formattedValue": string,
  "addressMeAs": string
}
Campos
metadata

object (FieldMetadata)

Metadados sobre o gênero.
value

string

O gênero da pessoa. O gênero pode ser personalizado ou um destes valores predefinidos:

  • male
  • female
  • unspecified
formattedValue

string

Apenas saída. O valor do gênero traduzido e formatado na localidade da conta do espectador ou na localidade do cabeçalho HTTP Accept-Language. Valores não especificados ou personalizados não foram localizados.
addressMeAs

string

Campo de texto de formato livre para pronomes que devem ser usados para se dirigir à pessoa. Os valores comuns são:

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

ImClient

O cliente de mensagens instantâneas de uma pessoa.

Representação JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "username": string,
  "type": string,
  "formattedType": string,
  "protocol": string,
  "formattedProtocol": string
}
Campos
metadata

object (FieldMetadata)

Metadados sobre o cliente de IM.
username

string

O nome de usuário usado no cliente de mensagem instantânea.
type

string

O tipo de cliente de IM. O tipo pode ser personalizado ou um destes valores predefinidos:

  • home
  • work
  • other
formattedType

string

Apenas saída. O tipo de cliente de mensagem instantânea traduzido e formatado na localidade da conta do leitor ou na localidade do cabeçalho HTTP Accept-Language.
protocol

string

O protocolo do cliente de IM. O protocolo pode ser personalizado ou um destes valores predefinidos:

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

string

Apenas saída. O protocolo do cliente de mensagem instantânea formatado na localidade da conta do leitor ou na localidade do cabeçalho HTTP Accept-Language.

Interesse

Um dos interesses da pessoa.

Representação JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Campos
metadata

object (FieldMetadata)

Metadados sobre o interesse.
value

string

O interesse; por exemplo, stargazing.

Localidade

A preferência de localidade de uma pessoa.

Representação JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Campos
metadata

object (FieldMetadata)

Metadados sobre a localidade.
value

string

Tag de idioma IETF BCP 47 bem formada que representa a localidade.

Local

A localização de uma pessoa.

Representação JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "current": boolean,
  "buildingId": string,
  "floor": string,
  "floorSection": string,
  "deskCode": string
}
Campos
metadata

object (FieldMetadata)

Metadados sobre o local.
value

string

O valor em formato livre do local.
type

string

Tipo de local. O tipo pode ser personalizado ou um destes valores predefinidos:

  • desk
  • grewUp
current

boolean

Se o local é o local atual.
buildingId

string

É o identificador do edifício.
floor

string

O nome ou número do andar.
floorSection

string

Seção do andar em floor_name.
deskCode

string

O local da mesa.

Associação

A associação de uma pessoa a um grupo. Somente associações a grupos de contatos podem ser modificadas.

Representação 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)

Metadados sobre a assinatura.
Campo de união membership. A assinatura. membership pode ser apenas de um dos tipos a seguir:
contactGroupMembership

object (ContactGroupMembership)

A associação ao grupo de contatos.
domainMembership

object (DomainMembership)

Apenas saída. A associação ao domínio.

ContactGroupMembership

Uma associação ao grupo de contatos do Google.

Representação JSON 
{
  "contactGroupId": string,
  "contactGroupResourceName": string
}
Campos
contactGroupId
(deprecated)

string

Apenas saída. O ID do grupo de contatos referente à associação ao grupo de contatos.
contactGroupResourceName

string

O nome de recurso para o grupo de contatos, atribuído pelo servidor. Uma string ASCII, na forma de contactGroups/{contactGroupId}. Somente contactGroupResourceName pode ser usado para modificar associações. Qualquer associação a grupo de contatos pode ser removida, mas somente o grupo de usuários ou "myContacts" ou "com estrela" associações a grupos do sistema podem ser adicionadas. Um contato sempre deve ter pelo menos uma associação ao grupo de contatos.

DomainMembership

Uma assinatura do domínio do Google Workspace.

Representação JSON 
{
  "inViewerDomain": boolean
}
Campos
inViewerDomain

boolean

Verdadeiro se a pessoa estiver no domínio do Google Workspace do leitor.

MiscKeyword

Palavra-chave diversas de uma pessoa.

Representação JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": enum (KeywordType),
  "formattedType": string
}
Campos
metadata

object (FieldMetadata)

Metadados sobre a palavra-chave de diversos tipos.
value

string

O valor da palavra-chave diversa.
type

enum (KeywordType)

O tipo de palavra-chave diversa.
formattedType

string

Apenas saída. O tipo de palavra-chave diversificada traduzida e formatada na localidade da conta do espectador ou na localidade do cabeçalho HTTP Accept-Language.

KeywordType

Tipo de palavra-chave diversificada.

Enums
TYPE_UNSPECIFIED Não especificado.
OUTLOOK_BILLING_INFORMATION Campo do Outlook para informações de faturamento.
OUTLOOK_DIRECTORY_SERVER Campo do Outlook para o servidor do diretório.
OUTLOOK_KEYWORD Campo do Outlook para a palavra-chave.
OUTLOOK_MILEAGE Campo do Outlook para quilometragem.
OUTLOOK_PRIORITY Campo do Outlook para prioridade.
OUTLOOK_SENSITIVITY Campo do Outlook para sensibilidade.
OUTLOOK_SUBJECT Campo do Outlook para o assunto.
OUTLOOK_USER Campo do Outlook para o usuário.
HOME Início.
WORK Trabalho.
OTHER Outros

Nome

O nome de uma pessoa. Se o nome for um monônimo, o nome do grupo ficará em branco.

Representação 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)

Metadados sobre o nome.
displayName

string

Apenas saída. O nome de exibição formatado de acordo com a localidade especificada pela conta do espectador ou o cabeçalho HTTP Accept-Language.
displayNameLastFirst

string

Apenas saída. O nome de exibição com o sobrenome formatado de acordo com a localidade especificada pela conta do espectador ou o cabeçalho HTTP Accept-Language.
unstructuredName

string

O valor do nome de formato livre.
familyName

string

O sobrenome.
givenName

string

O nome fornecido.
middleName

string

O(s) nome(s) do meio.
honorificPrefix

string

Os prefixos honoríficos, como Mrs. ou Dr.
honorificSuffix

string

Os sufixos honoríficos, como Jr.
phoneticFullName

string

O nome completo escrito como parece.
phoneticFamilyName

string

O sobrenome escrito como parece.
phoneticGivenName

string

O nome escrito como parece.
phoneticMiddleName

string

Os nomes do meio escritos do jeito que parecem.
phoneticHonorificPrefix

string

Os prefixos honoríficos soletrados como soam.
phoneticHonorificSuffix

string

Os sufixos honoríficos soletrados como soam.

Apelido

O apelido da pessoa.

Representação JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": enum (NicknameType)
}
Campos
metadata

object (FieldMetadata)

Metadados sobre o apelido.
value

string

O apelido.
type

enum (NicknameType)

O tipo do apelido.

NicknameType

O tipo de um apelido.

Enums
DEFAULT Apelido genérico.
MAIDEN_NAME

Nome de solteira ou sobrenome de nascimento. Usado quando o sobrenome da pessoa muda devido ao casamento.
INITIALS

Iniciais.
GPLUS

Apelido do perfil do Google+.
OTHER_NAME

Afiliação profissional ou outro nome Por exemplo: Dr. Smith.
ALTERNATE_NAME É o nome alternativo pelo qual a pessoa é conhecida.
SHORT_NAME

Uma versão mais curta do nome da pessoa.

Profissão

A profissão de uma pessoa.

Representação JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Campos
metadata

object (FieldMetadata)

Metadados sobre a profissão.
value

string

A profissão; por exemplo, carpenter.

Organização

É a organização antiga ou atual de uma pessoa. É permitido sobrepor períodos.

Representação 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)

Metadados sobre a organização.
type

string

O tipo de organização. O tipo pode ser personalizado ou um destes valores predefinidos:

  • work
  • school
formattedType

string

Apenas saída. O tipo de organização traduzido e formatado na localidade da conta do leitor ou na localidade do cabeçalho HTTP Accept-Language.
startDate

object (Date)

A data de início em que a pessoa entrou na organização.
endDate

object (Date)

A data de término em que a pessoa saiu da organização.
current

boolean

Verdadeiro se a organização for a organização atual da pessoa. falso se a organização for uma organização do passado.
name

string

É o nome da organização.
phoneticName

string

O nome fonético da organização.
department

string

O departamento da pessoa na organização.
title

string

O cargo da pessoa na organização.
jobDescription

string

A descrição do trabalho da pessoa na organização.
symbol

string

O símbolo associado à organização. por exemplo, um símbolo de ação, abreviação ou acrônimo.
domain

string

o nome de domínio associado à organização; por exemplo, google.com.
location

string

O local do escritório da organização em que a pessoa trabalha.
costCenter

string

O centro de custo da pessoa na organização.
fullTimeEquivalentMillipercent

integer

O equivalente em tempo integral da pessoa na organização (100.000 = 100%).

PhoneNumber

O número de telefone de uma pessoa.

Representação JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "canonicalForm": string,
  "type": string,
  "formattedType": string
}
Campos
metadata

object (FieldMetadata)

Metadados sobre o número de telefone.
value

string

É o número de telefone.
canonicalForm

string

Apenas saída. A forma canonizada ITU-T E.164 do número de telefone.
type

string

O tipo do número de telefone. O tipo pode ser personalizado ou um destes valores predefinidos:

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

string

Apenas saída. O tipo de número de telefone traduzido e formatado na localidade da conta do espectador ou na localidade do cabeçalho HTTP Accept-Language.

Foto

A foto de uma pessoa. Uma imagem ao lado do nome da pessoa para ajudar os outros a reconhecê-la.

Representação JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "url": string,
  "default": boolean
}
Campos
metadata

object (FieldMetadata)

Metadados sobre a foto.
url

string

O URL da foto. Para mudar o tamanho, anexe um parâmetro de consulta sz={size} ao final do URL, em que {size} é o tamanho em pixels. Exemplo: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50
default

boolean

Verdadeiro se a foto for uma foto padrão. falso se a foto for fornecida pelo usuário.

Relação

Relação de uma pessoa com outra.

Representação JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "person": string,
  "type": string,
  "formattedType": string
}
Campos
metadata

object (FieldMetadata)

Metadados sobre a relação.
person

string

O nome da outra pessoa a que a relação se refere.
type

string

A relação da pessoa com a outra pessoa. O tipo pode ser personalizado ou um destes valores predefinidos:

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

string

Apenas saída. O tipo da relação traduzida e formatada na localidade da conta do leitor ou especificada no cabeçalho HTTP Accept-Language.

RelationshipInterest

DESCONTINUADO: nenhum dado será retornado sobre o interesse em relacionamento de uma pessoa .

Representação JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "formattedValue": string
}
Campos
metadata

object (FieldMetadata)

Metadados sobre o interesse do relacionamento.
value

string

O tipo de relacionamento que a pessoa está procurando. O valor pode ser personalizado ou um destes valores predefinidos:

  • friend
  • date
  • relationship
  • networking
formattedValue

string

Apenas saída. O valor do interesse do relacionamento traduzido e formatado na localidade da conta do leitor ou na localidade especificada no cabeçalho HTTP Accept-Language.

RelationshipStatus

DESCONTINUADO: nenhum dado será retornado o status de relacionamento de uma pessoa.

Representação JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "formattedValue": string
}
Campos
metadata

object (FieldMetadata)

Metadados sobre o status do relacionamento.
value

string

O status do relacionamento. O valor pode ser personalizado ou um destes valores predefinidos:

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

string

Apenas saída. O valor do status de relacionamento traduzido e formatado na localidade da conta do leitor ou na localidade do cabeçalho HTTP Accept-Language.

Residência

DESCONTINUADO: use person.locations. Residência passada ou atual de uma pessoa.

Representação JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "current": boolean
}
Campos
metadata

object (FieldMetadata)

Metadados sobre a residência.
value

string

O endereço de residência.
current

boolean

Verdadeiro se a residência for a residência atual da pessoa. falso se a residência é uma residência passada.

SipAddress

Endereço SIP de uma pessoa. Os endereços de protocolo inicial da sessão são usados em comunicações VoIP para fazer chamadas de voz ou vídeo pela Internet.

Representação JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string
}
Campos
metadata

object (FieldMetadata)

Metadados sobre o endereço SIP.
value

string

O endereço SIP no formato de SIP URI RFC 3261 19.1.
type

string

O tipo de endereço SIP. O tipo pode ser personalizado ou um destes valores predefinidos:

  • home
  • work
  • mobile
  • other
formattedType

string

Apenas saída. O tipo de endereço SIP traduzido e formatado na localidade da conta do leitor ou na localidade do cabeçalho HTTP Accept-Language.

Skill

Uma habilidade que a pessoa tem.

Representação JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Campos
metadata

object (FieldMetadata)

Metadados sobre a habilidade.
value

string

A habilidade; por exemplo, underwater basket weaving.

Slogan

DESCONTINUADO: nenhum dado será retornado. Uma breve descrição em uma linha da pessoa.

Representação JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string
}
Campos
metadata

object (FieldMetadata)

Metadados sobre o slogan.
value

string

Slogan.

URL

URLs associados a uma pessoa.

Representação JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "value": string,
  "type": string,
  "formattedType": string
}
Campos
metadata

object (FieldMetadata)

Metadados sobre o URL.
value

string

O URL.
type

string

O tipo de URL. O tipo pode ser personalizado ou um destes valores predefinidos:

  • home
  • work
  • blog
  • profile
  • homePage
  • ftp
  • reservations
  • appInstallPage: o site de um aplicativo do Currents.
  • other
formattedType

string

Apenas saída. O tipo de URL traduzido e formatado na localidade da conta do leitor ou na localidade do cabeçalho HTTP Accept-Language.

UserDefined

Dados arbitrários preenchidos pelos usuários finais.

Representação JSON 
{
  "metadata": {
    object (FieldMetadata)
  },
  "key": string,
  "value": string
}
Campos
metadata

object (FieldMetadata)

Metadados sobre os dados definidos pelo usuário.
key

string

A chave especificada pelo usuário final dos dados definidos pelo usuário.
value

string

O valor especificado pelo usuário final dos dados definidos pelo usuário.

Métodos

batchCreateContacts

Cria um lote de novos contatos e retorna PersonResponses para a

As solicitações de modificação para o mesmo usuário devem ser enviadas sequencialmente para evitar aumento de latência e falhas.

batchDeleteContacts

 Exclui um lote de contatos.

batchUpdateContacts

 Atualize um lote de contatos e retorne um mapa de nomes de recursos a PersonResponses para os contatos atualizados.

createContact

 Cria um novo contato e retorna o recurso de pessoa para esse contato.

deleteContact

 Excluir uma pessoa de contato.

deleteContactPhoto

 Excluir a foto de um contato.

get

 Fornece informações sobre uma pessoa especificando um nome de recurso.

getBatchGet

 Fornece informações sobre uma lista de pessoas específicas especificando uma lista de nomes de recursos solicitados.

listDirectoryPeople

 Fornece uma lista de perfis de domínio e contatos do domínio no diretório de domínio do usuário autenticado.

searchContacts

 Fornece uma lista de contatos nos contatos agrupados do usuário autenticado que correspondem à consulta de pesquisa.

searchDirectoryPeople

 Fornece uma lista de perfis de domínio e contatos do domínio no diretório de domínio do usuário autenticado que corresponde à consulta de pesquisa.

updateContact

 Atualize os dados de um contato existente.

updateContactPhoto

 Atualizar a foto de um contato.