REST Resource: accounts

Recurso: conta

Uma conta é um contêiner do seu local. Se você é o único usuário que gerencia os locais da sua empresa, pode usar sua Conta do Google pessoal. Para compartilhar o gerenciamento de locais com vários usuários, crie uma conta do negócio.

Representação JSON 
{
  "name": string,
  "accountName": string,
  "primaryOwner": string,
  "type": enum (AccountType),
  "role": enum (AccountRole),
  "verificationState": enum (VerificationState),
  "vettedState": enum (VettedState),
  "accountNumber": string,
  "permissionLevel": enum (PermissionLevel),
  "organizationInfo": {
    object (OrganizationInfo)
  }
}
Campos
name

string

Imutável. O nome do recurso, no formato accounts/{account_id}.
accountName

string

Obrigatório. Nome da conta. Para uma conta do tipo PERSONAL, esse é o nome e o sobrenome da conta de usuário.
primaryOwner

string

Obrigatório. Somente entrada. O nome do recurso da conta que será o proprietário principal da conta que está sendo criada. Ele precisa estar no formato accounts/{account_id}.
type

enum (AccountType)

Obrigatório. Contém o tipo de conta. Contas do tipo PERSONAL e ORGANIZATION não podem ser criadas usando esta API.
role

enum (AccountRole)

Apenas saída. Especifica o AccountRole da conta.
verificationState

enum (VerificationState)

Apenas saída. Se forem confirmados, os locais futuros criados serão conectados automaticamente ao Google Maps e terão páginas do Google+ criadas, sem a necessidade de moderação.
vettedState

enum (VettedState)

Apenas saída. Indica se a conta foi verificada pelo Google. Uma conta verificada pode verificar locais pelo método VETTED_PARTNER.
accountNumber

string

Apenas saída. Número de referência da conta, se provisionado.
permissionLevel

enum (PermissionLevel)

Apenas saída. Especifica o nível de permissão que o usuário tem para essa conta.
organizationInfo

object (OrganizationInfo)

Apenas saída. Informações adicionais de uma organização. Ele é preenchido apenas para uma conta da organização.

AccountType

Indica que tipo de conta é: pessoal/de usuário ou empresarial.

Enums
ACCOUNT_TYPE_UNSPECIFIED Não especificado.
PERSONAL Uma conta de usuário final.
LOCATION_GROUP Um grupo de locais. Para mais informações, consulte o artigo da Central de Ajuda.
USER_GROUP Um grupo de usuários para separar a equipe da organização em grupos. Para mais informações, consulte o artigo da Central de Ajuda.
ORGANIZATION É uma organização que representa uma empresa. Para mais informações, consulte o artigo da Central de Ajuda.

AccountRole

Indica o nível de acesso que o usuário autenticado tem para essa conta. Para mais informações, consulte o artigo da Central de Ajuda.

Enums
ACCOUNT_ROLE_UNSPECIFIED Não especificado.
PRIMARY_OWNER O usuário é o proprietário principal desta conta.
OWNER O usuário proprietário da conta.
MANAGER O usuário pode gerenciar esta conta.
SITE_MANAGER O usuário pode gerenciar um conjunto limitado de recursos para a conta.

VerificationState

Indica o estado de verificação da conta.

Enums
VERIFICATION_STATE_UNSPECIFIED Não especificado.
VERIFIED Conta verificada.
UNVERIFIED Conta que não foi verificada, e a verificação não foi solicitada.
VERIFICATION_REQUESTED Conta que não foi verificada, mas a verificação foi solicitada.

VettedState

Indica o estado verificado de uma conta.

Enums
VETTED_STATE_UNSPECIFIED Não especificado
NOT_VETTED A conta não é verificada pelo Google.
VETTED Se a conta for verificada pelo Google e estiver em um estado válido. Uma conta é verificada automaticamente se tiver acesso direto a uma conta de um grupo verificado.
INVALID A conta foi verificada, mas está em estado inválido. Ela se comportará como uma conta não verificada.

PermissionLevel

Indica o nível de acesso que o usuário autenticado tem para essa conta.

Enums
PERMISSION_LEVEL_UNSPECIFIED Não especificado.
OWNER_LEVEL O usuário tem permissão no nível de proprietário.
MEMBER_LEVEL O usuário tem permissão de nível de membro.

OrganizationInfo

Informações adicionais armazenadas para uma organização.

Representação JSON 
{
  "registeredDomain": string,
  "address": {
    object (PostalAddress)
  },
  "phoneNumber": string
}
Campos
registeredDomain

string

Apenas saída. O domínio registrado da conta.
address

object (PostalAddress)

Apenas saída. O endereço postal da conta.
phoneNumber

string

Apenas saída. O número de contato da organização.

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.

Dicas sobre inserção / 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 receber elementos da interface para entrada ou edição de campos fora dos países em que o campo é usado.

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

Representação 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

integer

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

Métodos

create

 Cria uma conta com o nome e o tipo especificados sob a conta principal.

get

 Recebe a conta especificada.

list

 Lista todas as contas do usuário autenticado.

patch

 Atualiza a conta empresarial especificada.