REST Resource: people

Recurso: Person

São informações sobre uma pessoa mescladas de várias fontes de dados, como os contatos e os 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 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 do recurso da pessoa, atribuído pelo servidor. Uma string ASCII na forma 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)

O endereço da pessoa.
ageRange
(deprecated)

enum (AgeRange)

Apenas saída. DESCONTINUADO (use person.ageRanges)

Faixa etária da pessoa.
ageRanges[]

object (AgeRangeType)

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

object (Biography)

Biografias da pessoa Esse campo é um singleton para origens de contatos.
birthdays[]

object (Birthday)

Aniversários de uma pessoa. Esse campo é um singleton para origens de contatos.
braggingRights[]
(deprecated)

object (BraggingRights)

DESCONTINUADO: Nenhum dado será retornado Os direitos de orgulho da pessoa.
calendarUrls[]

object (CalendarUrl)

URLs da agenda da pessoa
clientData[]

object (ClientData)

Dados do cliente da pessoa.
coverPhotos[]

object (CoverPhoto)

Apenas saída. Fotos de capa da pessoa.
emailAddresses[]

object (EmailAddress)

Os 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, todo o conjunto poderá ser acessado chamando people.getBatchGet.
events[]

object (Event)

Os eventos da pessoa.
externalIds[]

object (ExternalId)

Os IDs externos da pessoa.
fileAses[]

object (FileAs)

São os arquivos da pessoa.
genders[]

object (Gender)

Gênero da pessoa. Esse campo é um singleton para origens de contatos.
imClients[]

object (ImClient)

Clientes de mensagem instantânea da pessoa
interests[]

object (Interest)

Interesses da pessoa.
locales[]

object (Locale)

Preferências de localidade da pessoa.
locations[]

object (Location)

Locais da pessoa.
memberships[]

object (Membership)

As associações do grupo da pessoa.
miscKeywords[]

object (MiscKeyword)

Palavras-chave diversas da pessoa.
names[]

object (Name)

Os nomes da pessoa. Esse campo é um singleton para origens de contatos.
nicknames[]

object (Nickname)

Os apelidos da pessoa.
occupations[]

object (Occupation)

As profissões da pessoa.
organizations[]

object (Organization)

Mostra as organizações anteriores 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. Os interesses de relacionamento da pessoa.
relationshipStatuses[]
(deprecated)

object (RelationshipStatus)

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

object (Residence)

OBSOLETO: (use person.locations) as residências da pessoa.
sipAddresses[]

object (SipAddress)

Os endereços SIP da pessoa.
skills[]

object (Skill)

Habilidades da pessoa.
taglines[]
(deprecated)

object (Tagline)

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

object (Url)

Os URLs associados à pessoa.
userDefined[]

object (UserDefined)

Dados definidos pelo usuário.

Metadados de pessoas

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. Nomes de recursos anteriores dessa pessoa. 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, número de telefone ou URL do perfil verificado.
linkedPeopleResourceNames[]

string

Apenas saída. Nomes dos recursos das pessoas vinculadas a esse recurso.
deleted

boolean

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

enum (ObjectType)

Apenas saída. DESCONTINUADO (use person.metadata.sources.profileMetadata.objectType)

O tipo do objeto person.

Fonte

A origem de um campo.

Representação JSON 
{
  "type": enum (SourceType),
  "id": string,
  "etag": string,
  "updateTime": string,
  "profileMetadata": {
    object (ProfileMetadata)
  }
}
Campos
type

enum (SourceType)

O tipo de origem.
id

string

Identificador exclusivo no tipo de origem gerado pelo servidor.
etag

string

Somente preenchido 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. Somente preenchido em person.metadata.sources.

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

Um carimbo de data/hora no formato UTC "Zulu" RFC3339, 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".
profileMetadata

object (ProfileMetadata)

Apenas saída. Somente preenchido em person.metadata.sources.

Metadados sobre uma origem do tipo PROFILE.

Tipo de origem

O tipo de uma fonte.

Enums
SOURCE_TYPE_UNSPECIFIED Não especificado.
ACCOUNT Conta do Google.
PROFILE Perfil do Google. Você pode ver o perfil em https://profiles.google.com/{id}, em que {id} é o ID da origem.
DOMAIN_PROFILE Perfil do domínio do Google Workspace
CONTACT Contato do Google. Você pode ver o contato em https://contact.google.com/{id}, em que {id} é o ID da origem.
OTHER_CONTACT "Outro contato" do Google.
DOMAIN_CONTACT Contato compartilhado do domínio do Google Workspace.

Metadados do perfil

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 de perfil.
userTypes[]

enum (UserType)

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

Tipo de objeto

O tipo de um objeto de pessoa.

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

Tipo de usuário

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 é do Currents.
GOOGLE_APPS_USER O usuário é do Google Workspace.

Address

Endereço físico de uma pessoa. Pode ser uma caixa postal ou um 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, ele será construído automaticamente com base nos 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 do endereço traduzido e formatado na localidade da conta do visualizador ou na localidade do cabeçalho HTTP Accept-Language.
poBox

string

Caixa postal do endereço.
streetAddress

string

É o endereço.
extendedAddress

string

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

string

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 de país ISO 3166-1 alfa-2 do endereço.

Metadados de campo

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 campo principal para a 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. Falso se o campo não for verificado. Um campo verificado geralmente é um nome, endereço de e-mail, número de telefone ou site que foi confirmado para ser de propriedade da pessoa.
source

object (Source)

A origem do campo.

Faixa etária

DESCONTINUADO (use person.ageRanges)

Faixa etária de uma pessoa.

Enums
AGE_RANGE_UNSPECIFIED Não especificado.
LESS_THAN_EIGHTEEN menores de 18 anos;
EIGHTEEN_TO_TWENTY Entre 18 e 20.
TWENTY_ONE_OR_OLDER Com 21 anos ou mais.

Tipo de faixa etária

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)

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 biografia curta.
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

Aniversário de uma pessoa. Pelo menos um dos campos date e text é especificado. Os campos date e text geralmente representam a mesma data, mas não são garantidos. Os clientes sempre precisam definir o campo date ao mudar 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

Use o campo date se ele tiver sido definido.

Uma string de formato livre que representa a data de aniversário do usuário. Este valor não foi 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 refere-se ao calendário gregoriano. Isso pode representar um dos seguintes:

  • Uma data completa, com valores de ano, mês e dia diferentes de zero.
  • Um mês e um dia, com um ano zero (por exemplo, um aniversário).
  • um ano sozinho, com um mês e zero um dia;
  • Um ano e mês, com um dia definido como zero (por exemplo, a data de validade de um 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 9999, ou 0 para especificar uma data sem um ano.
month

integer

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

integer

Dia de um 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 seja significativo.

Direito de se gabar

OBSOLETO: nenhum dado será retornado como o motivo 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.

URL da agenda

É o 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 do 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 visualizador ou na localidade do cabeçalho HTTP Accept-Language.

Dados do cliente

Dados arbitrários do cliente preenchidos por clientes Chaves e valores duplicados são permitidos.

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

Valor especificado do cliente dos dados do cliente.

Fotode capa

Foto de uma pessoa. Uma imagem grande mostrada na página do perfil da pessoa que representa quem ela é ou com o que se importa.

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 de capa for uma foto de capa 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

O tipo do 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 visualizador 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 visualizador 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 visualizador ou na localidade do cabeçalho HTTP Accept-Language.

Arquivar como

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 "as-as".
value

string

O valor "file-as"

Gênero

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 visualizador ou na localidade do cabeçalho HTTP Accept-Language. O valor não especificado ou personalizado não é localizado.
addressMeAs

string

Campo de texto livre para pronomes que devem ser usados para falar com a pessoa. Os valores comuns são:

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

IClient

Cliente de mensagem instantânea 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 mensagem instantânea.
username

string

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

string

O tipo do cliente de mensagens instantâneas. O tipo pode ser personalizado ou um destes valores predefinidos:

  • home
  • work
  • other
formattedType

string

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

string

O protocolo do cliente de mensagem instantânea. 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 visualizador 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

A tag de idioma IETF BCP 47 bem formada 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 de formato livre do local.
type

string

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

  • desk
  • grewUp
current

boolean

Indica se o local é o atual.
buildingId

string

O identificador do edifício.
floor

string

Nome ou número do andar.
floorSection

string

A seção do andar em floor_name.
deskCode

string

O local da mesa individual.

Assinatura

a associação de uma pessoa a um grupo; Só é possível modificar as associações ao grupo de contatos.

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 assinatura do domínio.

Associação ao grupo de contatos

Uma associação a um 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 da associação ao grupo de contatos.
contactGroupResourceName

string

O nome do 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 ao grupo de contatos pode ser removida, mas somente as associações a grupos de usuários ou grupos de sistema "meus contatos" ou "com estrela" podem ser adicionadas. Um contato sempre deve ter pelo menos uma associação ao grupo de contatos.

Associação ao domínio

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

Palavras-chave diversas

Palavra-chave diversa 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 diversa.
value

string

Valor da palavra-chave diversa.
type

enum (KeywordType)

O tipo de palavra-chave diversa.
formattedType

string

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

Tipo de palavra-chave

Tipo de palavra-chave diversa.

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 de diretório.
OUTLOOK_KEYWORD Campo do Outlook para a palavra-chave.
OUTLOOK_MILEAGE Campo do Outlook para quilometragem.
OUTLOOK_PRIORITY Campo de prioridade do Outlook.
OUTLOOK_SENSITIVITY Campo de Outlook para confidencialidade.
OUTLOOK_SUBJECT Campo do Outlook para o assunto.
OUTLOOK_USER Campo do Outlook para o usuário.
HOME Tela inicial.
WORK Trabalho.
OTHER Outro.

Nome

É o nome de uma pessoa. Se o nome for um mononome, o nome da família estará 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 visualizador ou o cabeçalho HTTP Accept-Language.
displayNameLastFirst

string

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

string

O valor do nome do formato livre.
familyName

string

O nome da família.
givenName

string

O nome fornecido.
middleName

string

Os nomes do meio
honorificPrefix

string

Os prefixos honorários, como Mrs. ou Dr.
honorificSuffix

string

Os sufixos honorários, como Jr.
phoneticFullName

string

O nome completo escrito como soa.
phoneticFamilyName

string

O nome da família escrito como soa.
phoneticGivenName

string

O nome escrito como soado.
phoneticMiddleName

string

Os nomes do meio escritos como soam
phoneticHonorificPrefix

string

Os prefixos honorários escritos em som.
phoneticHonorificSuffix

string

Os sufixos honorários escritos como soam.

Apelido

Apelido de uma 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 de apelido.

Tipo de apelido

É o tipo de apelido.

Enums
DEFAULT Apelido genérico.
MAIDEN_NAME

Nome de solteira ou família de nascimento Usado quando o nome de família da pessoa muda de acordo com o casamento.
INITIALS

Iniciales.
GPLUS

Apelido do perfil do Google+.
OTHER_NAME

Uma afiliação profissional ou outro nome, por exemplo, Dr. Smith.
ALTERNATE_NAME Nome alternativo conhecido pela pessoa.
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

Mostra a organização anterior ou atual de uma pessoa. É permitido usar períodos sobrepostos.

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 da 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 visualizador ou na localidade do cabeçalho HTTP Accept-Language.
startDate

object (Date)

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

object (Date)

A data de término quando 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 anterior.
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

Cargo da pessoa na organização.
jobDescription

string

É a descrição da vaga 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 onde a pessoa trabalha.
costCenter

string

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

integer

O milissegundo equivalente 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. O formulário ITU-T E.164 canônico do número de telefone.
type

string

O tipo de 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 visualizador ou na localidade do cabeçalho HTTP Accept-Language.

Foto

Foto de uma pessoa. Uma foto ao lado do nome da pessoa para ajudar a reconhecer a pessoa.

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} no fim 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 for uma foto 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 essa 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 de relação traduzida e formatada na localidade da conta do visualizador ou na localidade especificada no cabeçalho HTTP Accept-Language.

Relação com interesses

DESCONTINUADO: Nenhum dado será retornado como interesse de relacionamento de uma pessoa .

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

object (FieldMetadata)

Metadados sobre o interesse no 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 na relação traduzido e formatado na localidade da conta do espectador ou na localidade especificada no cabeçalho HTTP Accept-Language.

Relacionamento

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 da relação.
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 da relação traduzido e formatado na localidade da conta do visualizador ou na localidade do cabeçalho HTTP Accept-Language.

Residência

DESCONTINUADO: use person.locations. Residência anterior 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 da residência.
current

boolean

Verdadeiro se a residência for a residência atual da pessoa. Falso se a residência for uma residência antiga.

Endereço IP

É o endereço SIP de uma pessoa. Os endereços do protocolo inicial da sessão são usados para comunicações VoIP para fazer chamadas de voz ou de 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 URI SIP RFC 3261 19.1.
type

string

O tipo do 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 visualizador 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 de uma linha da pessoa.

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

object (FieldMetadata)

Metadados sobre o slogan.
value

string

O 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 do URL. O tipo pode ser personalizado ou um destes valores predefinidos:

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

string

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

Definido pelo usuário

São dados arbitrários do usuário 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

Valor especificado do usuário final dos dados definidos pelo usuário.

Métodos

batchCreateContacts

Crie um lote de novos contatos e retorne PersonResponses para o novo

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

batchDeleteContacts

 Exclua um lote de contatos.

batchUpdateContacts

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

createContact

 Crie um novo contato e retorne o recurso de pessoa para esse contato.

deleteContact

 Exclua 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

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

searchContacts

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

searchDirectoryPeople

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

updateContact

 Atualizar os dados de contato de um contato atual.

updateContactPhoto

 Atualizar a foto de um contato.