Package google.type

Índice

Fecha

Representa una fecha de calendario completa o parcial, como un cumpleaños. La hora del día y la zona horaria se especifican en otra parte o son insignificantes. La fecha está relacionada con el calendario gregoriano. Esto puede representar una de las siguientes opciones:

  • Una fecha completa con valores de año, mes y día que no sean cero
  • Un mes y un día con un año en cero (por ejemplo, un aniversario).
  • Un año solo, con cero mes y cero día.
  • Un año y un mes con un día en cero (por ejemplo, la fecha de vencimiento de una tarjeta de crédito)

Tipos relacionados:

Campos
year

int32

Es el año de la fecha. Debe encontrarse entre 1 y 9999, o 0 para especificar una fecha sin año.

month

int32

Mes del año. Debe encontrarse entre 1 y 12, o 0 para especificar un año sin mes ni día.

day

int32

El día de un mes. Debe encontrarse entre 1 y 31 y ser válido para el año y el mes, o bien 0 para especificar un año por sí solo o un año y un mes en los que el día no sea importante.

DayOfWeek

Representa un día de la semana.

Enumeradores
DAY_OF_WEEK_UNSPECIFIED No se especifica el día de la semana.
MONDAY Lunes
TUESDAY Martes
WEDNESDAY Miércoles
THURSDAY Jueves
FRIDAY Viernes
SATURDAY Sábado
SUNDAY Domingo

Intervalo

Representa un intervalo de tiempo, codificado como un inicio de marca de tiempo (inclusivo) y un final de marca de tiempo (exclusivo).

El inicio debe ser menor o igual que el final. Si el inicio es igual al final, el intervalo estará vacío (no coincide con ningún tiempo). Cuando no se especifican el inicio y el final, el intervalo coincide en cualquier momento.

Campos
start_time

Timestamp

Opcional. Inicio inclusivo del intervalo.

Si se especifica, una marca de tiempo que coincida con este intervalo deberá ser igual o posterior al inicio.

end_time

Timestamp

Opcional. Final exclusivo del intervalo.

Si se especifica, una marca de tiempo que coincida con este intervalo deberá ser anterior al final.

PhoneNumber

Un objeto que representa un número de teléfono, adecuado como un formato de conexión de API.

Esta representación:

  • No debe usarse para el formato específico de la configuración regional de un número de teléfono, como "+1 (650) 253-0000 ext. 123".

  • no está diseñado para un almacenamiento eficiente

  • Es posible que los números no sean adecuados para marcarlos: se deben usar bibliotecas especializadas (consulta las referencias) para analizar el número con ese propósito.

Para realizar alguna acción significativa con este número, como formatearlo para varios casos de uso, primero debes convertirlo en un objeto i18n.phonenumbers.PhoneNumber.

Por ejemplo, en Java sería:

com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); }

Referencias: https://github.com/google/libphonenumber

Campos
extension

string

Es la extensión del número de teléfono. La extensión no está estandarizada en las recomendaciones de ITU, excepto que se define como una serie de números con una longitud máxima de 40 dígitos. Además de los dígitos, aquí se pueden guardar otros caracteres de marcación, como ',' (para indicar que hay que esperar) o '#'.

Ten en cuenta que ninguna región utiliza actualmente extensiones con códigos cortos, por lo que este campo normalmente solo se establece junto con un número E.164. Se mantiene por separado del número E.164 para permitir las extensiones de código corto en el futuro.

Campo de unión kind. Obligatorio. Puede ser un número normal o un código corto. Es posible que, en el futuro, se agreguen campos nuevos a alguno de los siguientes campos, por lo que los clientes deben ignorar los números de teléfono para los que no se haya establecido ninguno de los campos con los que se codificaron. Las direcciones (kind) solo pueden ser una de las siguientes opciones:
e164_number

string

El número de teléfono, representado como un signo más ("+") inicial, seguido de un número de teléfono que utiliza un formato relajado de ITU E.164 que consta del código telefónico del país (de 1 a 3 dígitos) y el número del suscriptor, sin espacios ni formato adicionales, p.ej., - correcto: “+15552220123” - incorrecto: “+1 (555) 222-01234 x123”

El formato ITU E.164 limita estos últimos a 12 dígitos, pero en la práctica no todos los países respetan eso, por lo que flexibilizamos esta restricción en este caso. No se permiten números solo nacionales.

Referencias: https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes

short_code

ShortCode

Un código corto.

Referencias: https://en.wikipedia.org/wiki/Short_code

ShortCode

Un objeto que representa un código corto, que es un número de teléfono que suele ser mucho más corto que los números de teléfono comunes y que se puede usar para enviar direcciones de mensajes en sistemas de MMS y SMS, así como para la marcación abreviada (p. ej., "Enviar un mensaje de texto al 611 para ver cuántos minutos te quedan en tu plan").

Los códigos cortos están restringidos a una región y no se pueden marcar internacionalmente, lo que significa que el mismo código corto puede existir en distintas regiones, con distintos usos y precios, incluso si esas regiones comparten el mismo código de llamada de país (p. ej., EE.UU. y Canadá).

Campos
region_code

string

Obligatorio. Es el código regional BCP-47 de la ubicación donde se pueden realizar llamadas a este código corto, como “US” y “BB”.

Referencias: http://www.unicode.org/reports/tr35/#unicode_region_subtag

number

string

Obligatorio. Los dígitos del código corto, sin el signo más (+) ni con el código de llamada de país, p.ej., "611".

PostalAddress

Representa una dirección postal, p. ej., para envíos postales o direcciones de pago. Si se proporciona una dirección postal, un servicio postal puede enviar artículos a las instalaciones, a la casilla postal o a otras ubicaciones similares. No está diseñado para modelar ubicaciones geográficas (caminos, pueblos, montañas).

En el uso común, una dirección se crearía a través de una entrada del usuario o a partir de la importación de datos existentes, según el tipo de proceso.

Consejos sobre el ingreso o la edición de direcciones: - Usa un widget de dirección listo para la internacionalización, como https://github.com/google/libaddressinput). - Los usuarios no deben ver elementos de la IU para ingresar o editar campos fuera de países en los que se usa ese campo.

Para obtener orientación sobre cómo usar este esquema, consulta https://support.google.com/business/answer/6397478

Campos
revision

int32

La revisión del esquema de PostalAddress. Se debe configurar como 0, que es la última versión.

Todas las revisiones nuevas deben ser compatibles con las revisiones anteriores.

region_code

string

Obligatorio. Código de región de CLDR para el país o la región de la dirección. Nunca se infiere y depende del usuario garantizar que el valor sea correcto. Consulta https://cldr.unicode.org/ y https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html para obtener detalles. Ejemplo: "CH" para Suiza.

language_code

string

Opcional. Código de idioma BCP-47 de los contenidos de esta dirección (si se conoce). Suele ser el idioma de la IU del formulario de entrada o se espera que coincida con uno de los idiomas usados en la región o el país de la dirección, o sus transliteraciones equivalentes. Esto puede afectar el formato en ciertos países, pero no es fundamental para la precisión de los datos y nunca afectará una validación o alguna otra operación no relacionada con el formato.

Si este valor es desconocido, se debe omitir (en lugar de especificar una configuración predeterminada posiblemente incorrecta).

Ejemplos: "zh-Hant", "ja", "ja-Latn", "en".

postal_code

string

Opcional. Código postal de la dirección. No todos los países usan o exigen la presencia de códigos postales, pero en los lugares donde se usan, es posible que activen una validación adicional con otras partes de la dirección (p. ej., validación del código postal o el estado en EE.UU.).

sorting_code

string

Opcional. Código de ordenamiento adicional específico para cada país. No se usa en la mayoría de las regiones. Cuando se usa, el valor es una cadena como "CEDEX", opcionalmente seguida de un número (p.ej., "CEDEX 7"), o solo un número, que representa el "código de sector" (Jamaica), el "indicador de área de entrega" (Malawi) o el "indicador de oficina de correo" (p.ej., Costa de Marfil).

administrative_area

string

Opcional. División administrativa más alta que se usa para las direcciones postales de un país o una región. Por ejemplo, puede ser un estado, una provincia, una óblast o una prefectura. Específicamente, en el caso de España, corresponde a la provincia y no a la comunidad autónoma (p.ej., "Barcelona" y no "Cataluña"). Muchos países no usan un área administrativa en las direcciones postales. P. ej., en Suiza se dejaría vacío.

locality

string

Opcional. Por lo general, se refiere a la parte de la dirección que indica la ciudad o el pueblo. Ejemplos: ciudad de EE.UU., comuna de Italia o ciudad postal en el Reino Unido. En regiones del mundo donde las localidades no están bien definidas o no coinciden bien con esta estructura, deja la localidad vacía y usa address_lines.

sublocality

string

Opcional. Sublocalidad de la dirección. Por ejemplo, pueden ser barrios, vecindarios o distritos.

address_lines[]

string

Líneas de dirección no estructuradas que describen los niveles más bajos de una dirección.

Debido a que los valores en address_lines no tienen información de tipo y, a veces, pueden contener varios valores en un solo campo (p.ej., “Austin, TX”), es importante que el orden de las líneas sea claro. El orden de las líneas de dirección debe ser el "orden de sobre" que se usa en el país o la región de la dirección. En lugares donde esto puede variar, (p. ej., Japón), address_language se usa para hacerlo explícito (p. ej., "ja" para ordenar de mayor a menor en "ja-Latn" o "en" para indicar de menor a mayor). De esta manera, se puede seleccionar la línea más específica de una dirección a partir del idioma.

La representación estructural mínima que se permite para una dirección consiste en un region_code con toda la información restante incluida en address_lines. Sería posible dar un formato a una dirección así de manera muy aproximada sin codificación geográfica, pero no podría realizarse un análisis semántico de ningún componente de la dirección hasta que se resuelva al menos de manera parcial.

Crear una dirección que solo contiene region_code y address_lines, y luego realizar la codificación geográfica es la manera recomendada de controlar direcciones sin estructura alguna (en lugar de inferir qué partes de la dirección deben ser localidades o áreas administrativas).

recipients[]

string

Opcional. El destinatario en la dirección. Es posible que este campo contenga varias líneas de información en ciertas circunstancias. Por ejemplo, puede contener información sobre la entrega "por medio de".

organization

string

Opcional. El nombre de la organización de la dirección.

TimeOfDay

Representa una hora del día. La fecha y la zona horaria no son significativas o se especifican en otro lugar. Una API puede optar por permitir segundos bisiestos. Los tipos relacionados son google.type.Date y google.protobuf.Timestamp.

Campos
hours

int32

Horas del día en formato de 24 horas. Debe ser del 0 al 23. Una API puede permitir el valor “24:00:00” para casos como el horario de cierre de empresas.

minutes

int32

Minutos de horas del día. Debe ser un valor entre 0 y 59.

seconds

int32

Segundos de minutos de la hora. Por lo general, debe ser un valor entre 0 y 59. Una API puede permitir el valor 60 si permite segundos bisiestos.

nanos

int32

Fracciones de segundos en nanosegundos. Debe ser un valor entre 0 y 999,999,999.

TimeZone

Representa una zona horaria de la base de datos de zonas horarias de IANA.

Campos
id

string

Zona horaria de la base de datos de zonas horarias de IANA, p. ej., “America/New_York”.

version

string

Opcional. Número de versión de la base de datos de zonas horarias de IANA, p. ej., “2019a”.