REST Resource: accounts

Resource: Account

An account is a container for your location. If you are the only user who manages locations for your business, you can use your personal Google Account. To share management of locations with multiple users, create a business account.

JSON representation 
{
  "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)
  }
}
Fields
name

string

Immutable. The resource name, in the format accounts/{account_id}.
accountName

string

Required. The name of the account. For an account of type PERSONAL, this is the first and last name of the user account.
primaryOwner

string

Required. Input only. The resource name of the account which will be the primary owner of the account being created. It should be of the form accounts/{account_id}.
type

enum (AccountType)

Required. Contains the type of account. Accounts of type PERSONAL and ORGANIZATION cannot be created using this API.
role

enum (AccountRole)

Output only. Specifies the AccountRole of this account.
verificationState

enum (VerificationState)

Output only. If verified, future locations that are created are automatically connected to Google Maps, and have Google+ pages created, without requiring moderation.
vettedState

enum (VettedState)

Output only. Indicates whether the account is vetted by Google. A vetted account is able to verify locations via the VETTED_PARTNER method.
accountNumber

string

Output only. Account reference number if provisioned.
permissionLevel

enum (PermissionLevel)

Output only. Specifies the permission level the user has for this account.
organizationInfo

object (OrganizationInfo)

Output only. Additional info for an organization. This is populated only for an organization account.

AccountType

Indicates what kind of account this is: either a personal/user account or a business account.

Enums
ACCOUNT_TYPE_UNSPECIFIED Not specified.
PERSONAL An end-user account.
LOCATION_GROUP A group of Locations. For more information, see the help center article
USER_GROUP A User Group for segregating organization staff in groups. For more information, see the help center article
ORGANIZATION An organization representing a company. For more information, see the help center article

AccountRole

Indicates the access level that the authenticated user has for this account. For more information, see the help center article

Enums
ACCOUNT_ROLE_UNSPECIFIED Not specified.
PRIMARY_OWNER The user is the primary owner this account.
OWNER The user owner of the account.
MANAGER The user can manage this account.
SITE_MANAGER The user can manage a limited set of features for the account.

VerificationState

Indicates the verification state of the account.

Enums
VERIFICATION_STATE_UNSPECIFIED Not specified.
VERIFIED Verified account.
UNVERIFIED Account that is not verified, and verification has not been requested.
VERIFICATION_REQUESTED Account that is not verified, but verification has been requested.

VettedState

Indicates the vetted state of an account.

Enums
VETTED_STATE_UNSPECIFIED Not Specified
NOT_VETTED The account is not vetted by Google.
VETTED The account is vetted by Google and in a valid state. An account is automatically vetted if it has direct access to a vetted group account.
INVALID The account is vetted but in an invalid state. The account will behave like an unvetted account.

PermissionLevel

Indicates the access level that the authenticated user has for this account.

Enums
PERMISSION_LEVEL_UNSPECIFIED Not specified.
OWNER_LEVEL The user has owner level permission.
MEMBER_LEVEL The user has member level permission.

OrganizationInfo

Additional information stored for an organization.

JSON representation 
{
  "registeredDomain": string,
  "address": {
    object (PostalAddress)
  },
  "phoneNumber": string
}
Fields
registeredDomain

string

Output only. The registered domain for the account.
address

object (PostalAddress)

Output only. The postal address for the account.
phoneNumber

string

Output only. The contact number for the organization.

PostalAddress

Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains).

In typical usage an address would be created via user input or from importing existing data, depending on the type of process.

Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used.

For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478

JSON representation 
{
  "revision": integer,
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "sortingCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ],
  "recipients": [
    string
  ],
  "organization": string
}
Fields
revision

integer

The schema revision of the PostalAddress. This must be set to 0, which is the latest revision.

All new revisions must be backward compatible with old revisions.
regionCode

string

Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
languageCode

string

Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations.

If this value is not known, it should be omitted (rather than specifying a possibly incorrect default).

Examples: "zh-Hant", "ja", "ja-Latn", "en".
postalCode

string

Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).
sortingCode

string

Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
administrativeArea

string

Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.
locality

string

Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use addressLines.
sublocality

string

Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
addressLines[]

string

Unstructured address lines describing the lower levels of an address.

Because values in addressLines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language.

The minimum permitted structural representation of an address consists of a regionCode with all remaining information placed in the addressLines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved.

Creating an address only containing a regionCode and addressLines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
recipients[]

string

Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
organization

string

Optional. The name of the organization at the address.

Methods

create

 Creates an account with the specified name and type under the given parent.

get

 Gets the specified account.

list

 Lists all of the accounts for the authenticated user.

patch

 Updates the specified business account.