Google My Business API

The Google My Business API provides an interface for managing business location information on Google.

Service: mybusiness.googleapis.com

All URIs below are relative to https://mybusiness.googleapis.com

This service provides the following discovery documents:

REST Resource: v4.accounts

Methods
deleteNotifications DELETE /v4/{name=accounts/*/notifications}
Clears the pubsub notification settings for the account.
generateAccountNumber POST /v4/{name=accounts/*}:generateAccountNumber
Generates an account number for this account.
get GET /v4/{name=accounts/*}
Gets the specified account.
getNotifications GET /v4/{name=accounts/*/notifications}
Returns the pubsub notification settings for the account.
list GET /v4/accounts
Lists all of the accounts for the authenticated user.
update PUT /v4/{name=accounts/*}
Updates the specified business account.
updateNotifications PUT /v4/{name=accounts/*/notifications}

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.

REST Resource: v4.accounts.admins

Methods
create POST /v4/{parent=accounts/*}/admins
Invites the specified user to become an administrator for the specified account.
delete DELETE /v4/{name=accounts/*/admins/*}
Removes the specified admin from the specified account.
list GET /v4/{parent=accounts/*}/admins
Lists the admins for the specified account.
patch PATCH /v4/{name=accounts/*/admins/*}
Updates the Admin for the specified Account Admin.

REST Resource: v4.accounts.invitations

Methods
accept POST /v4/{name=accounts/*/invitations/*}:accept
Accepts the specified invitation.
decline POST /v4/{name=accounts/*/invitations/*}:decline
Declines the specified invitation.
list GET /v4/{parent=accounts/*}/invitations
Lists pending invitations for the specified account.

REST Resource: v4.accounts.locations

Methods
associate POST /v4/{name=accounts/*/locations/*}:associate
Associates a location to a place ID.
batchGet POST /v4/{name=accounts/*}/locations:batchGet
Gets all of the specified locations in the given account.
clearAssociation POST /v4/{name=accounts/*/locations/*}:clearAssociation
Clears an association between a location and its place ID.
create POST /v4/{parent=accounts/*}/locations
Creates a new location owned by the specified account, and returns it.
delete DELETE /v4/{name=accounts/*/locations/*}
Deletes a location.
findMatches POST /v4/{name=accounts/*/locations/*}:findMatches
Finds all of the possible locations that are a match to the specified location.
get GET /v4/{name=accounts/*/locations/*}
Gets the specified location.
getGoogleUpdated GET /v4/{name=accounts/*/locations/*}:googleUpdated
Gets the Google-updated version of the specified location.
list GET /v4/{parent=accounts/*}/locations
Lists the locations for the specified account.
patch PATCH /v4/{name=accounts/*/locations/*}
Updates the specified location.
reportInsights POST /v4/{name=accounts/*}/locations:reportInsights
Returns a report containing insights on one or more metrics by location.
transfer POST /v4/{name=accounts/*/locations/*}:transfer
Moves a location from an account that the user owns to another account that the same user administers.

REST Resource: v4.accounts.locations.admins

Methods
create POST /v4/{parent=accounts/*/locations/*}/admins
Invites the specified user to become an administrator for the specified location.
delete DELETE /v4/{name=accounts/*/locations/*/admins/*}
Removes the specified admin as a manager of the specified location.
list GET /v4/{parent=accounts/*/locations/*}/admins
Lists all of the admins for the specified location.
patch PATCH /v4/{name=accounts/*/locations/*/admins/*}
Updates the Admin for the specified Location Admin.

REST Resource: v4.accounts.locations.localPosts

Methods
create POST /v4/{parent=accounts/*/locations/*}/localPosts
Creates a new local post associated with the specified location, and returns it.
delete DELETE /v4/{name=accounts/*/locations/*/localPosts/*}
Deletes a local post.
get GET /v4/{name=accounts/*/locations/*/localPosts/*}
Gets the specified local post.
list GET /v4/{parent=accounts/*/locations/*}/localPosts
Returns a list of local posts associated with a location.
patch PATCH /v4/{name=accounts/*/locations/*/localPosts/*}
Updates the specified local post and returns the updated local post.
reportInsights POST /v4/{name=accounts/*/locations/*}/localPosts:reportInsights
Returns insights for a set of local posts associated with a single listing.

REST Resource: v4.accounts.locations.media

Methods
create POST /v4/{parent=accounts/*/locations/*}/media
Creates a new media item for the location.
delete DELETE /v4/{name=accounts/*/locations/*/media/*}
Deletes the specified media item.
get GET /v4/{name=accounts/*/locations/*/media/*}
Returns metadata for the requested media item.
list GET /v4/{parent=accounts/*/locations/*}/media
Returns a list of media items associated with a location.
patch PATCH /v4/{name=accounts/*/locations/*/media/*}
Updates metadata of the specified media item.
startUpload POST /v4/{parent=accounts/*/locations/*}/media:startUpload
Generates a MediaItemDataRef for media item uploading.

REST Resource: v4.accounts.locations.media.customers

Methods
get GET /v4/{name=accounts/*/locations/*/media/customers/*}
Returns metadata for the requested customer media item.
list GET /v4/{parent=accounts/*/locations/*}/media/customers
Returns a list of media items associated with a location that have been contributed by customers.

REST Resource: v4.accounts.locations.reviews

Methods
deleteReply DELETE /v4/{name=accounts/*/locations/*/reviews/*}/reply
Deletes the response to the specified review.
get GET /v4/{name=accounts/*/locations/*/reviews/*}
Returns the specified review.
list GET /v4/{parent=accounts/*/locations/*}/reviews
Returns the paginated list of reviews for the specified location.
updateReply PUT /v4/{name=accounts/*/locations/*/reviews/*}/reply
Updates the reply to the specified review.

REST Resource: v4.attributes

Methods
list GET /v4/attributes
Returns the list of available attributes that would be available for a location with the given primary category and country.

REST Resource: v4.categories

Methods
list GET /v4/categories
Returns a list of business categories.

Service: mybusiness.googleapis.com

All URIs below are relative to https://mybusiness.googleapis.com

This service provides the following discovery documents:

REST Resource: v3.accounts

Methods
deleteNotifications DELETE /v3/{name=accounts/*/notifications}
Clears the pubsub notification settings for the account.
get GET /v3/{name=accounts/*}
Gets the specified account.
getNotifications GET /v3/{name=accounts/*/notifications}
Returns the pubsub notification settings for the account.
list GET /v3/accounts
Lists all of the accounts for the authenticated user.
update PUT /v3/{name=accounts/*}
Updates the specified business account.
updateNotifications PUT /v3/{name=accounts/*/notifications}

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.

REST Resource: v3.accounts.admins

Methods
create POST /v3/{name=accounts/*}/admins
Invites the specified user to become an administrator for the specified account.
delete DELETE /v3/{name=accounts/*/admins/*}
Removes the specified admin from the specified account.
list GET /v3/{name=accounts/*}/admins
Lists the admins for the specified account.

REST Resource: v3.accounts.locations

Methods
associate POST /v3/{name=accounts/*/locations/*}:associate
Associates a location to a place ID.
batchGet POST /v3/{name=accounts/*}/locations:batchGet
Gets all of the specified locations in the given account.
clearAssociation POST /v3/{name=accounts/*/locations/*}:clearAssociation
Clears an association between a location and its place ID.
create POST /v3/{name=accounts/*}/locations
Creates a new location owned by the specified account, and returns it.
delete DELETE /v3/{name=accounts/*/locations/*}
Deletes a location.
findMatches POST /v3/{name=accounts/*/locations/*}:findMatches
Finds all of the possible locations that are a match to the specified location.
get GET /v3/{name=accounts/*/locations/*}
Gets the specified location.
getGoogleUpdated GET /v3/{name=accounts/*/locations/*}:googleUpdated
Gets the Google-updated version of the specified location.
list GET /v3/{name=accounts/*}/locations
Lists the locations for the specified account.
patch PATCH /v3/{name=accounts/*/locations/*}
Updates the specified location.
reportInsights POST /v3/{name=accounts/*}/locations:reportInsights
Returns a report containing insights on one or more metrics by location.
transfer POST /v3/{name=accounts/*/locations/*}:transfer
Transfer a location from one account to another.

REST Resource: v3.accounts.locations.admins

Methods
create POST /v3/{name=accounts/*/locations/*}/admins
Invites the specified user to become an administrator for the specified location.
delete DELETE /v3/{name=accounts/*/locations/*/admins/*}
Removes the specified admin as a manager of the specified location.
list GET /v3/{name=accounts/*/locations/*}/admins
Lists all of the admins for the specified location.

REST Resource: v3.accounts.locations.reviews

Methods
deleteReply DELETE /v3/{name=accounts/*/locations/*/reviews/*}/reply
Deletes the response to the specified review.
get GET /v3/{name=accounts/*/locations/*/reviews/*}
Returns the specified review.
list GET /v3/{name=accounts/*/locations/*}/reviews
Returns the paginated list of reviews for the specified location.
reply POST /v3/{name=accounts/*/locations/*/reviews/*}/reply
Updates the reply to the specified review.

REST Resource: v3.attributes

Methods
list GET /v3/attributes
Returns the list of available attributes that would be available for a location with the given primary category and country.

REST Resource: v3.categories

Methods
list GET /v3/categories
Returns a list of business categories.

Service: mybusiness.googleapis.com

All URIs below are relative to https://mybusiness.googleapis.com

This service provides the following discovery documents:

REST Resource: media

Methods
upload POST /v1/media/{resourceName=**}
Method for media upload.

Send feedback about...

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