REST Resource: accounts

Resource: Account

An account is a container for your business's locations. 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,
  "type": enum(AccountType),
  "role": enum(AccountRole),
  "state": {
    object(AccountState)
  },
  "profilePhotoUrl": string,
  "accountNumber": string,
  "permissionLevel": enum(PermissionLevel),
  "organizationInfo": {
    object(OrganizationInfo)
  }
}
Fields
name

string

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

accountName

string

The name of the account.

type

enum(AccountType)

Output only. Specifies the AccountType of this account.

role

enum(AccountRole)

Output only. Specifies the AccountRole the caller has for this account.

state

object(AccountState)

Output only. Indicates the AccountState of this account.

profilePhotoUrl

string

Profile photo for the account. This is populated only for the personal account.

accountNumber

string

Account reference number if provisioned.

permissionLevel

enum(PermissionLevel)

Output only. Specifies the PermissionLevel the caller has for this account.

organizationInfo

object(OrganizationInfo)

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.
USER_GROUP A User Group for segregating organization staff in groups.
ORGANIZATION An organization representing a company.

AccountRole

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

Enums
ACCOUNT_ROLE_UNSPECIFIED Not specified.
OWNER The user owns this account.
CO_OWNER The user is a co-owner of the account.
MANAGER The user can manage this account.
COMMUNITY_MANAGER The user can manage social (Google+) pages for the account.

AccountState

Indicates status of the account, such as whether the account has been verified by Google.

JSON representation
{
  "status": enum(AccountStatus)
}
Fields
status

enum(AccountStatus)

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

AccountStatus

Indicates the verification status of the account.

Enums
ACCOUNT_STATUS_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.

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 Info stored for an organization.

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

string

The registered domain for the account.

postalAddress

object(PostalAddress)

The postal address for the account.

phoneNumber

string

The contact number for the organization.

Methods

deleteNotifications

Clears the pubsub notification settings for the account.

generateAccountNumber

Generates an account number for this account.

get

Gets the specified account.

getNotifications

Returns the pubsub notification settings for the account.

list

Lists all of the accounts for the authenticated user.

update

Updates the specified business account.

updateNotifications

Sets the pubsub notification settings for the account informing My Business which topic to send pubsub notifications for:

  • New reviews for locations administered by the account.

Send feedback about...

Google My Business API
Google My Business API
Need help? Visit our support page.