- Recurso: Account
- AccountType
- AccountRole
- VerificationState
- VettedState
- PermissionLevel
- OrganizationInfo
- PostalAddress
- Métodos
Recurso: Account
Una cuenta es un contenedor de tu ubicación. Si eres el único usuario que administra ubicaciones para tu empresa, puedes utilizar tu Cuenta de Google personal. Para compartir la administración de ubicaciones con varios usuarios, crea una cuenta comercial.
Representación JSON |
---|
{ "name": string, "accountName": string, "primaryOwner": string, "type": enum ( |
Campos | |
---|---|
name |
Inmutable. El nombre del recurso, en el formato |
accountName |
Obligatorio. Es el nombre de la cuenta. Para una cuenta de tipo |
primaryOwner |
Obligatorio. Solo entrada. El nombre de recurso de la cuenta que será el propietario principal de la cuenta que se creará. Debe tener el formato |
type |
Obligatorio. Contiene el tipo de cuenta. Las cuentas de tipo PERSONAL y ORGANIZATION no pueden crearse con esta API. |
role |
Solo salida. Especifica el AccountRole de esta cuenta. |
verificationState |
Solo salida. Si se verifica, las ubicaciones futuras que se creen se conectarán automáticamente a Google Maps y se crearán páginas de Google+, sin requerir moderación. |
vettedState |
Solo salida. Indica si Google verificó la cuenta. Una cuenta aprobada puede verificar ubicaciones con el método VETTED_PARTNER. |
accountNumber |
Solo salida. Número de referencia de la cuenta, si se lo proporcionó. |
permissionLevel |
Solo salida. Especifica el nivel de permiso que el usuario tiene para esta cuenta. |
organizationInfo |
Solo salida. Información adicional de una organización. Solo se propaga para una cuenta de organización. |
AccountType
Indica qué tipo de cuenta es: personal o de usuario, o bien una cuenta comercial.
Enumeraciones | |
---|---|
ACCOUNT_TYPE_UNSPECIFIED |
No se especifica. |
PERSONAL |
Una cuenta de usuario final |
LOCATION_GROUP |
Un grupo de ubicaciones. Para obtener más información, consulta el artículo del Centro de ayuda |
USER_GROUP |
Un grupo de usuarios para segregar al personal de la organización en grupos. Para obtener más información, consulta el artículo del Centro de ayuda |
ORGANIZATION |
Una organización que representa a una empresa. Para obtener más información, consulta el artículo del Centro de ayuda |
AccountRole
Indica el nivel de acceso que tiene el usuario autenticado para esta cuenta. Para obtener más información, consulta el artículo del Centro de ayuda
Enumeraciones | |
---|---|
ACCOUNT_ROLE_UNSPECIFIED |
No se especifica. |
PRIMARY_OWNER |
El usuario es el propietario principal de esta cuenta. |
OWNER |
El usuario propietario de la cuenta. |
MANAGER |
El usuario puede administrar esta cuenta. |
SITE_MANAGER |
El usuario puede administrar un conjunto limitado de funciones para la cuenta. |
VerificationState
Indica el estado de verificación de la cuenta.
Enumeraciones | |
---|---|
VERIFICATION_STATE_UNSPECIFIED |
No se especifica. |
VERIFIED |
Cuenta verificada |
UNVERIFIED |
Cuenta sin verificar y no se solicitó la verificación. |
VERIFICATION_REQUESTED |
Cuenta que no está verificada, pero se solicitó la verificación. |
VettedState
Indica el estado verificado de una cuenta.
Enumeraciones | |
---|---|
VETTED_STATE_UNSPECIFIED |
No especificado |
NOT_VETTED |
Google no verificó la cuenta. |
VETTED |
La cuenta está verificada por Google y se encuentra en un estado válido. Las cuentas se aprueban automáticamente si tienen acceso directo a una cuenta de grupo aprobada. |
INVALID |
La cuenta se verificó, pero en un estado no válido. La cuenta se comportará como una cuenta no verificada. |
PermissionLevel
Indica el nivel de acceso que tiene el usuario autenticado para esta cuenta.
Enumeraciones | |
---|---|
PERMISSION_LEVEL_UNSPECIFIED |
No se especifica. |
OWNER_LEVEL |
El usuario tiene permiso de nivel de propietario. |
MEMBER_LEVEL |
El usuario tiene permiso de nivel de miembro. |
OrganizationInfo
Información adicional que se almacena para una organización.
Representación JSON |
---|
{
"registeredDomain": string,
"address": {
object ( |
Campos | |
---|---|
registeredDomain |
Solo salida. El dominio registrado para la cuenta. |
address |
Solo salida. Es la dirección postal de la cuenta. |
phoneNumber |
Solo salida. Es el número de contacto de la organización. |
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 preparado 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
Representación JSON |
---|
{ "revision": integer, "regionCode": string, "languageCode": string, "postalCode": string, "sortingCode": string, "administrativeArea": string, "locality": string, "sublocality": string, "addressLines": [ string ], "recipients": [ string ], "organization": string } |
Campos | |
---|---|
revision |
La revisión del esquema de Todas las revisiones nuevas deben ser compatibles con las revisiones anteriores. |
regionCode |
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. |
languageCode |
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". |
postalCode |
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.). |
sortingCode |
Opcional: Código de ordenamiento adicional específico para cada país. No se usa en la mayoría de las regiones. Cuando se utiliza, 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), "indicador del área de entrega" (Malaui) o "indicador de oficina de correos" (p.ej., Costa de Marfil). |
administrativeArea |
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 |
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 addressLines. |
sublocality |
Opcional: Sublocalidad de la dirección. Por ejemplo, pueden ser barrios, vecindarios o distritos. |
addressLines[] |
Líneas de dirección no estructuradas que describen los niveles más bajos de una dirección. Debido a que los valores de addressLines no tienen información de tipo y, en ocasiones, 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 regionCode con toda la información restante incluida en addressLines. 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 regionCode y addressLines, 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[] |
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 |
Opcional: El nombre de la organización de la dirección. |
Métodos |
|
---|---|
|
Crea una cuenta con el nombre y el tipo especificados en el elemento superior determinado. |
|
Obtiene la cuenta especificada. |
|
Enumera todas las cuentas del usuario autenticado. |
|
Actualiza la cuenta de empresa especificada. |