Package google.type

Índice

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:

Campos
year

int32

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

int32

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

int32

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.

DayOfWeek

Representa um dia da semana.

Enums
DAY_OF_WEEK_UNSPECIFIED O dia da semana não é especificado.
MONDAY Segunda-feira
TUESDAY Terça-feira
WEDNESDAY Quarta-feira
THURSDAY Quinta-feira
FRIDAY Sexta-feira
SATURDAY Sábado
SUNDAY Domingo

PostalAddress

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

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

Orientações sobre a inserção ou edição de endereços: - Use um widget de endereço pronto para internacionalização, como https://github.com/google/libaddressinput. - Os usuários não devem ver elementos da UI para inserção ou edição de campos fora dos países em que os campos são usados.

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

Campos
revision

int32

A revisão de esquema do 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.
region_code

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 detalhes, consulte https://cldr.unicode.org/ e https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html. Exemplo: "CH" para Suíça.
language_code

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".
postal_code

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 ou CEP nos Estados Unidos).
sorting_code

string

Opcional. Código de classificação adicional específico de país. Não é usado na maioria das regiões. Quando usado, o valor é uma string como "CEDEX", opcionalmente seguida por um número (por exemplo, "CEDEX 7"), ou apenas um número, representando o "código do setor" (Jamaica), o "indicador da área de entrega" (Malawi) ou o "indicador dos correios" (Costa do Marfim).
administrative_area

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. 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, ela deve ficar em branco.
locality

string

Opcional. Geralmente se refere à parte do endereço relacionada à cidade/município. Exemplos: cidade nos EUA, comunidade na Itália, distrito postal no Reino Unido. Em regiões administrativas que não são claramente definidas ou não se encaixam bem nessa estrutura, deixe locality em branco e use address_lines.
sublocality

string

Opcional. Sublocalidade do endereço. Por exemplo, pode ser um bairro ou distrito.
address_lines[]

string

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

Como os valores em address_lines 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" para o 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 "en" 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 region_code com todas as informações restantes colocadas no address_lines. 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 contenha apenas um region_code e address_lines e depois geocodificar é a maneira recomendada de lidar com endereços não estruturados (em vez de adivinhar quais partes do endereço devem ser regiões 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.

TimeOfDay

Representa um horário do dia. A data e o fuso horário não são relevantes ou são especificados em outro lugar. Uma API pode permitir segundos bissextos. Os tipos relacionados são google.type.Date e google.protobuf.Timestamp.

Campos
hours

int32

Horas de um dia no formato de 24 horas. Precisa ser maior ou igual a 0 e geralmente menor ou igual a 23. Uma API pode permitir o valor "24:00:00" para o horário de fechamento da empresa, por exemplo.
minutes

int32

Minutos de uma hora. Precisa ser maior ou igual a 0 e menor ou igual a 59.
seconds

int32

Segundos de um minuto. Precisa ser maior ou igual a 0 e normalmente menor ou igual a 59. Uma API pode permitir o valor 60 se permitir segundos bissextos.
nanos

int32

Frações de segundos, em nanossegundos. Precisa ser maior ou igual a 0 e menor ou igual a 999.999.999.

TimeZone

Representa um fuso horário do banco de dados IANA.

Campos
id

string

Fuso horário do banco de dados IANA. Por exemplo, "America/New_York".
version

string

Opcional. Número da versão do banco de dados IANA de fuso horário. Por exemplo, "2019a".