REST Resource: people

Recurso: Person

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

A maioria dos campos pode ter vários itens. Os itens em um campo não têm ordem garantida, mas cada campo que não está 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 no formato 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. OBSOLETO (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)

Os aniversários da pessoa. Este campo é um Singleton para origens de contato.

braggingRights[]
(deprecated)

object (BraggingRights)

OBSOLETO: nenhum dado será retornado. Os direitos de se gabar da pessoa.

calendarUrls[]

object (CalendarUrl)

Os URLs da agenda da pessoa.

clientData[]

object (ClientData)

Dados do cliente da pessoa

coverPhotos[]

object (CoverPhoto)

Apenas saída. Fotos da capa da pessoa.

emailAddresses[]

object (EmailAddress)

O endereço 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 pode ser recebido chamando people.getBatchGet.

events[]

object (Event)

os eventos da pessoa;

externalIds[]

object (ExternalId)

Os IDs externos da pessoa.

fileAses[]

object (FileAs)

O estado do 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)

Interesses da pessoa.

locales[]

object (Locale)

Preferências de localidade da pessoa.

locations[]

object (Location)

A localização da pessoa.

memberships[]

object (Membership)

As associações da pessoa a grupos.

miscKeywords[]

object (MiscKeyword)

As palavras-chave diversas da pessoa.

names[]

object (Name)

São os nomes das pessoas. Este campo é um Singleton para origens de contato.

nicknames[]

object (Nickname)

Os apelidos da pessoa.

occupations[]

object (Occupation)

Ocupações da pessoa.

organizations[]

object (Organization)

As organizações anteriores ou atuais da pessoa.

phoneNumbers[]

object (PhoneNumber)

O número 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 pode ser obtido chamando people.getBatchGet.

photos[]

object (Photo)

Apenas saída. São as fotos da pessoa.

relations[]

object (Relation)

Relações da pessoa.

relationshipInterests[]
(deprecated)

object (RelationshipInterest)

Apenas saída. OBSOLETO: nenhum dado será retornado. Os interesses de relacionamento da pessoa.

relationshipStatuses[]
(deprecated)

object (RelationshipStatus)

Apenas saída. OBSOLETO: nenhum dado será retornado. O 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)

As habilidades da pessoa.

taglines[]
(deprecated)

object (Tagline)

Apenas saída. OBSOLETO: nenhum dado vai ser retornado. As frases de efeito 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. Nomes de recursos 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 e-mail verificado, número de telefone confirmado ou URL do perfil.

linkedPeopleResourceNames[]

string

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

deleted

boolean

Apenas saída. Verdadeiro se o recurso de 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. OBSOLETO (use person.metadata.sources.profileMetadata.objectType)

O tipo do objeto da pessoa.

Origem

A origem 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 dessa 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".

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

Enums
SOURCE_TYPE_UNSPECIFIED Não especificado.
ACCOUNT Uma Conta do Google.
PROFILE Perfil do Google. Você pode visualizar o perfil em https://profiles.google.com/{id}, em que {id} é o ID da origem.
DOMAIN_PROFILE Perfil de domínio do Google Workspace.
CONTACT Contato do Google. Veja 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:

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. O usuário digita.

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 do usuário.

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

Endereço

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 o valor não for definido pelo usuário, ele será automaticamente construído a partir de valores estruturados.

type

string

O tipo do 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

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

O 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 de 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 como sendo de propriedade da pessoa.

source

object (Source)

A origem do campo.

AgeRange

OBSOLETO (use person.ageRanges)

A faixa etária de uma pessoa.

Enums
AGE_RANGE_UNSPECIFIED Não especificado.
LESS_THAN_EIGHTEEN Menos de 18 anos.
EIGHTEEN_TO_TWENTY Entre 18 e 20 anos.
TWENTY_ONE_OR_OLDER Mais de 21 anos.

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

Breve biografia 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 em HTML.

Aniversário

O aniversário de uma pessoa. Pelo menos um dos campos date e text é especificado. Os campos date e text normalmente representam a mesma data, mas não há garantias de que isso ocorra. Os clientes precisam sempre definir o campo date ao modificar 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.

Uma 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 ano zero (por exemplo, uma data comemorativa);
  • Um ano sozinho, com um mês zero e um dia zero.
  • um ano e um 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

OBSOLETO: nenhum dado será retornado. Os dados de uma pessoa se gabam.

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

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

ClientData

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

O valor especificado pelo cliente dos dados do cliente.

CoverPhoto

Foto da capa de uma pessoa. Uma imagem grande exibida na página de perfil da pessoa que representa quem ela é ou o que é importante para ela.

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

"True", se a foto da capa é a padrão; "false", se a foto da 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 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 de evento traduzido e formatado na localidade da conta do leitor ou na localidade do cabeçalho HTTP Accept-Language.

ExternalId

Um 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 de evento traduzido e formatado na localidade da conta do leitor ou na localidade do cabeçalho HTTP Accept-Language.

FileAs

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

value

string

O valor "file-as"

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. Os valores não especificados ou personalizados não são localizados.

addressMeAs

string

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

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

ImClient

O 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 mensagens instantâneas.

username

string

O nome de usuário usado no cliente de mensagens instantâneas.

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 de cliente de mensagens instantâneas traduzido e formatado na localidade da conta do leitor ou na localidade Accept-Language do cabeçalho HTTP.

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 mensagens instantâneas 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

Preferência de local de uma pessoa.

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

object (FieldMetadata)

Metadados sobre a localidade.

value

string

É uma 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 de formato livre do local.

type

string

O 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 individual.

Assinatura

A associação de uma pessoa a um grupo. Somente associações a grupos de contato 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 do domínio.

ContactGroupMembership

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 para a 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 a grupos de contatos pode ser removida, mas somente associações a grupos de usuários, grupos do sistema "myContacts" ou "com estrela" podem ser adicionadas. Um contato precisa sempre 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 diversas.

value

string

O valor da palavra-chave diversas.

type

enum (KeywordType)

O tipo de palavra-chave diversas.

formattedType

string

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

KeywordType

Tipo de palavra-chave diversas.

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 palavra-chave.
OUTLOOK_MILEAGE Campo do Outlook para quilometragem.
OUTLOOK_PRIORITY Campo do Outlook para prioridade.
OUTLOOK_SENSITIVITY Campo do 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 Outros

Nome

É o nome de uma pessoa. Se o nome for um apelido, o sobrenome 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 leitor ou o cabeçalho HTTP Accept-Language.

displayNameLastFirst

string

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

unstructuredName

string

O valor do nome em formato livre.

familyName

string

O sobrenome.

givenName

string

O nome fornecido.

middleName

string

Os nomes 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 conforme o nome.

phoneticGivenName

string

O nome escrito conforme o nome.

phoneticMiddleName

string

São os nomes do meio escritos com o significado.

phoneticHonorificPrefix

string

Os prefixos honoríficos escritos como eles.

phoneticHonorificSuffix

string

Os sufixos honoríficos escritos como eles soam.

Apelido

O 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 do apelido.

NicknameType

O tipo de um apelido.

Enums
DEFAULT Apelido genérico.
MAIDEN_NAME

Nome de solteira ou sobrenome de solteiro. Usado quando o sobrenome da pessoa é alterado como resultado do 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 da pessoa é conhecido.
SHORT_NAME

Uma versão menor do nome da pessoa.

Occupation

Ocupaçã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 anterior ou atual de uma pessoa. É possível 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 leitor ou na localidade Accept-Language do cabeçalho HTTP.

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 atual da pessoa; falso se a organização for 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

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ções da bolsa de valores, abreviação ou sigla.

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 custos da pessoa na organização.

fullTimeEquivalentMillipercent

integer

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

PhoneNumber

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 canônica 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 leitor ou na localidade do cabeçalho HTTP Accept-Language.

Foto

A foto de uma pessoa. Uma foto exibida 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 alterar o tamanho desejado, 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

"True", se a foto é padrão; "false", se a 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. 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 traduzido e formatado na localidade da conta do leitor ou na localidade especificada no cabeçalho HTTP Accept-Language.

RelationshipInterest

OBSOLETO: nenhum dado será retornado. O interesse de relacionamento de uma pessoa.

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

object (FieldMetadata)

Metadados sobre o interesse da relação.

value

string

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

  • friend
  • date
  • relationship
  • networking
formattedValue

string

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

RelationshipStatus

OBSOLETO: 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 predefinidos:

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

string

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

Residência

OBSOLETO: use person.locations. O passado ou residência 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 anterior.

SipAddress

Endereço SIP de uma pessoa. Endereços de protocolo inicial da sessão são usados para 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 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 leitor ou na localidade Accept-Language do cabeçalho HTTP.

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

OBSOLETO: 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: 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 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

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 os

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

batchDeleteContacts

Excluir um lote de contatos.

batchUpdateContacts

Atualiza um lote de contatos e retorna um mapa de nomes de recursos a PersonResponses para os contatos atualizados.

createContact

Criar um novo contato e retornar o recurso de pessoa desse 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 corresponde à 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

Atualizar dados de contato de uma pessoa de contato existente.

updateContactPhoto

Atualizar a foto de um contato.