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 otro lugar o son insignificantes. La fecha está relacionada con el calendario gregoriano. Puede representar una de las siguientes opciones:

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

Tipos relacionados:

Campos
year

int32

Año de la fecha. Debe ser entre 1 y 9,999, o bien 0 para especificar una fecha sin año.

month

int32

Mes del año. Debe ser del 1 al 12 o 0 para especificar un año sin un mes ni un día.

day

int32

Día del mes. Debe ser entre 1 y 31 y ser válido para el año y el mes o bien 0 para especificar un año solo o un año y un mes en los que el día no sea significativo.

DayOfWeek

Representa un día de la semana.

Enumeraciones
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. Cuando el inicio es igual al final, el intervalo está vacío (no coincide con ningún momento). Cuando no se especifican la hora de inicio ni la de finalización, el intervalo coincide con cualquier hora.

Campos
start_time

Timestamp

Opcional. Inicio inclusivo del intervalo.

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

end_time

Timestamp

Opcional. Finalización exclusiva del intervalo.

Si se especifica, una marca de tiempo que coincida con este intervalo deberá estar antes del final.

Númerotelefónico

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

Esta representación:

  • No se debe usar para el formato específico de 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 no sea adecuado para realizar llamadas. Para ello, se deben usar bibliotecas especializadas (consulta las referencias).

Para hacer algo significativo con este número, como darle formato para varios casos de uso, primero conviértelo en un objeto i18n.phonenumbers.PhoneNumber.

Por ejemplo, en Java, sería lo siguiente:

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 la ITU, excepto por definirse como una serie de números con una longitud máxima de 40 dígitos. Además de los dígitos, es posible que se almacenen aquí otros caracteres de marcación, como ',' (que indica una espera) o '#'.

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

Campo de unión kind. Obligatorio. Puede ser un número normal o un código corto. Es posible que se agreguen campos nuevos a la siguiente opción en el futuro, por lo que los clientes deben ignorar los números de teléfono para los que no se configuró ninguno de los campos con los que 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 usa un formato E.164 de la ITU relajado que consta del código de llamada del país (de 1 a 3 dígitos) y el número del suscriptor, sin espacios ni formato adicionales Por ejemplo: - Correcto: "+15552220123" - Incorrecto: "+1 (555) 222-01234 x123".

El formato E.164 de la ITU limita el último a 12 dígitos, pero, en la práctica, no todos los países respetan esa restricción, por lo que relajamos esa restricción aquí. No se permiten números 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

Es 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 normales y se puede usar para dirigir mensajes en sistemas de MMS y SMS, así como para marcar de forma abreviada (por ejemplo, "Envía 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 a nivel internacional, lo que significa que el mismo código corto puede existir en diferentes regiones, con diferentes precios y usos, incluso si esas regiones comparten el mismo código de llamada del país (por ejemplo, EE.UU. y Canadá).

Campos
region_code

string

Obligatorio. Es el código de región BCP-47 de la ubicación en la que 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 el código de llamada del país Por ejemplo, “611”.

PostalAddress

Representa una dirección postal. Por ejemplo, para direcciones de entrega postal o 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 típico, una dirección se crearía a partir de la entrada del usuario o de la importación de datos existentes, según el tipo de proceso.

Sugerencias para la entrada o edición de direcciones: - Usa un widget de dirección listo para la internacionalización, como https://github.com/google/libaddressinput. - No se debe presentar a los usuarios elementos de la IU para ingresar o editar campos fuera de los países donde se usa ese campo.

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

Campos
revision

int32

Es 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 más información. 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 códigos postales ni requieren que estén presentes, pero, cuando se usan, pueden activar una validación adicional con otras partes de la dirección (por ejemplo, la validación de estado o código postal 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", seguida de un número (por ejemplo, "CEDEX 7") o solo un número, que representa el "código de sector" (Jamaica), el "indicador de zona de entrega" (Malawi) o el "indicador de oficina de correos" (por ejemplo, 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, para España, se trata de la provincia y no de la comunidad autónoma (por ejemplo, "Barcelona" y no "Cataluña"). Muchos países no usan un área administrativa en las direcciones postales. Por ejemplo, en Suiza, este campo no debe propagarse.

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.

Dado que los valores de address_lines no tienen información de tipo y, a veces, pueden contener varios valores en un solo campo (por ejemplo, "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 (por ejemplo, Japón), se usa address_language para hacerlo explícito (por ejemplo, "ja" para el orden de mayor a menor y "ja-Latn" o "en" para el orden 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 de un día en formato de 24 horas. Debe ser mayor o igual que 0 y, por lo general, debe ser menor o igual que 23. Una API puede permitir el valor “24:00:00” para casos como el horario de cierre de empresas.

minutes

int32

Minutos de una hora. Debe ser mayor o igual que 0 y menor o igual que 59.

seconds

int32

Son los segundos de un minuto. Debe ser mayor o igual que 0 y, por lo general, debe ser menor o igual que 59. Una API puede permitir el valor 60 si permite segundos bisiestos.

nanos

int32

Fracciones de segundos, en nanosegundos. Debe ser mayor o igual que 0 y menor o igual que 999,999,999.

TimeZone

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

Campos
id

string

Es la zona horaria de la base de datos de zonas horarias de IANA. Por ejemplo, "America/New_York".

version

string

Opcional. Número de versión de la base de datos de zonas horarias de IANA. Por ejemplo, "2019a".