Recurso REST: accounts.customers

Recurso: Customer

Entidade que representa um cliente de um revendedor ou distribuidor.

Representação JSON 

{
  "name": string,
  "orgDisplayName": string,
  "orgPostalAddress": {
    object(PostalAddress)
  },
  "primaryContactInfo": {
    object(ContactInfo)
  },
  "alternateEmail": string,
  "domain": string,
  "createTime": string,
  "updateTime": string
}
Campos
name

string

Nome do recurso do cliente no formato: “accounts/{account_id}/customers/{customer_id}” Somente leitura.

orgDisplayName

string

Nome da organização que a entidade do cliente representa.

orgPostalAddress

object(PostalAddress)

Endereço da organização da entidade do cliente. A região e os CEPs são obrigatórios para aplicar as leis e os embargos dos EUA.

primaryContactInfo

object(ContactInfo)

Dados do contato principal.

alternateEmail

string

E-mail do contato secundário. Obrigatório. O e-mail alternativo e o e-mail de contato principal precisam ter domínios diferentes.

domain

string

Domínio principal usado pelo cliente. Obrigatório. O domínio do e-mail de contato principal precisa ser igual ao domínio fornecido.

createTime

string (Timestamp format)

Somente leitura. A hora em que o cliente é criado.

Um carimbo de data/hora no formato UTC “Zulu” RFC3339 é medido com precisão de nanossegundos. Exemplo: "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

A hora em que o cliente é atualizado.

Um carimbo de data/hora no formato UTC “Zulu” RFC3339 é medido com precisão de nanossegundos. Exemplo: "2014-10-02T15:01:23.045123456Z".

PostalAddress

Representa um endereço postal, por exemplo, para endereços para pagamento ou distribuição postal. Com um endereço postal, o serviço de correios pode entregar itens em um local, uma caixa postal ou outro local semelhante. Não se destina a modelar locais geográficos (estradas, cidades, montanhas).

No uso normal, um endereço seria criado por digitação do usuário ou pela importação de dados existentes, dependendo do tipo de processo.

Recomendação sobre digitação/edição de endereços: - Use um widget de endereço pronto para i18n, como https://github.com/google/libaddressinput. - Os usuários não devem ver elementos de IU para digitação ou edição de campos fora dos países em que esse campo é usado.

Para mais orientações sobre como usar este esquema, consulte: https://support.google.com/business/answer/6397478.

Representação JSON 

{
  "revision": number,
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "sortingCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ],
  "recipients": [
    string
  ],
  "organization": string
}
Campos
revision

number

A revisão de esquema de PostalAddress. Precisa ser definido como 0, que é a revisão mais recente.

Todas as novas revisões precisam ser compatíveis com versões anteriores.
regionCode

string

Obrigatório. Código de região CLDR do país/região do endereço. Nunca é inferido e cabe ao usuário garantir que o valor esteja correto. Para ver mais detalhes, consulte http://cldr.unicode.org/ e http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html. Exemplo: "CH" para a Suíça.

languageCode

string

Opcional. Código de idioma BCP-47 do conteúdo deste endereço (se conhecido). Costuma ser o idioma da IU do formulário de entrada ou espera-se que corresponda a um dos idiomas usados no país/região do endereço ou nos equivalentes transliterados dele. Pode afetar a formatação em determinados países, mas não é fundamental para a exatidão dos dados e nunca afetará a validação ou outras operações relacionadas à não formatação.

Se você não conhece o valor, omita-o (em vez de especificar um padrão possivelmente incorreto).

Exemplos: "zh-Hant", "ja", "ja-latn", "pt".
postalCode

string

Opcional. Código postal do endereço. Nem todos os países usam ou exigem códigos postais, mas nos locais onde são usados, eles podem desencadear uma validação adicional com outras partes do endereço (por exemplo, validação de estado/CEP nos EUA).

sortingCode

string

Opcional. Código de classificação adicional específico de país. Não é usado na maioria das regiões. Nos locais em que é usado, o valor é uma string como “CEDEX”, que pode ser seguida por um número (por exemplo, “CEDEX 7”), ou apenas um número sozinho, representando o “código do setor” (Jamaica), o “indicador de área de entrega” (Malawi) ou o “indicador de agência de correio” (por exemplo, Costa do Marfim).

administrativeArea

string

Opcional. A maior subdivisão administrativa que é usada para endereços postais de um país ou uma região. Por exemplo, pode ser um estado, uma província, uma zona ou uma prefeitura. Especificamente na Espanha, é a província, e não a comunidade autônoma (por exemplo, “Barcelona”, não “Catalunha”). Muitos países não usam área administrativa em endereços postais. Por exemplo, na Suíça, isso deve ser deixado em branco.

locality

string

Opcional. Geralmente se refere à parte do endereço relativa a cidade/município. Exemplos: cidade nos EUA, comunidade na Itália, distrito postal no Reino Unido. Em regiões onde as localidades não são claramente definidas ou não se encaixam bem nessa estrutura, deixe a localidade em branco e use addressLines.

sublocality

string

Opcional. Sublocalidade do endereço. Por exemplo, pode ser bairro ou distrito.

addressLines[]

string

Linhas de endereço não estruturadas que descrevem os níveis mais detalhados de um endereço.

Como os valores em addressLines não têm informações de tipo e podem conter diversos valores em um único campo (por exemplo, “Austin, TX”), é importante que a ordem da linha seja clara. Ela precisa estar em “ordem de envelope” em país ou região do endereço. Em locais em que isso pode variar (por exemplo, Japão), address_language é usado para explicitar (por exemplo, "ja" para ordem do maior para o menor e "ja-Latn" ou "pt" para ordem do menor para o maior). Desta forma, a linha mais específica de um endereço pode ser selecionada com base no idioma.

A representação estrutural mínima permitida de um endereço consiste em um regionCode com todas as informações restantes colocadas em addressLines. Seria possível formatar esse endereço sem geocodificação, mas nenhum raciocínio semântico poderia ser feito sobre qualquer um dos componentes do endereço até que ele fosse pelo menos parcialmente resolvido.

Criar um endereço que apresente apenas um regionCode e addressLines e depois geocodificar é a maneira recomendada de lidar com endereços completamente não estruturados (em vez de adivinhar quais partes do endereço devem ser localidades ou áreas administrativas).
recipients[]

string

Opcional. O destinatário no endereço. Sob certas circunstâncias, este campo pode conter informações em várias linhas. Por exemplo, informações sobre cuidados.

organization

string

Opcional. O nome da organização no endereço.

ContactInfo

Dados de contato para uma conta de cliente.

Representação JSON 

{
  "firstName": string,
  "lastName": string,
  "displayName": string,
  "email": string,
  "title": string,
  "phone": string
}
Campos
firstName

string

Nome do contato na conta do cliente. Obrigatório.

lastName

string

Sobrenome do contato na conta do cliente. Obrigatório.

displayName

string

Nome de exibição do contato na conta do cliente. Opcional. Quando vazio, o nome de exibição será gerado pela combinação do nome e sobrenome.

email

string

E-mail do contato na conta do cliente. Obrigatório.

title

string

Cargo do contato na conta do cliente.

phone

string

Número de telefone do contato na conta do cliente.

Métodos

create

 Cria um novo recurso Customer na conta do revendedor ou distribuidor.

get

 Retorna um recurso Customer solicitado.

list

 Lista os Customers posteriores.

patch

 Atualiza um recurso Customer existente que pertence ao revendedor ou distribuidor.