The Google My Business API provides an interface for managing business location information on Google.
- REST Resource: v4.accounts
- REST Resource: v4.accounts.admins
- REST Resource: v4.accounts.invitations
- REST Resource: v4.accounts.locations
- REST Resource: v4.accounts.locations.admins
- REST Resource: v4.accounts.locations.followers
- REST Resource: v4.accounts.locations.insuranceNetworks
- REST Resource: v4.accounts.locations.localPosts
- REST Resource: v4.accounts.locations.media
- REST Resource: v4.accounts.locations.media.customers
- REST Resource: v4.accounts.locations.questions
- REST Resource: v4.accounts.locations.questions.answers
- REST Resource: v4.accounts.locations.reviews
- REST Resource: v4.accounts.locations.verifications
- REST Resource: v4.attributes
- REST Resource: v4.categories
- REST Resource: v4.chains
- REST Resource: v4.googleLocations
- REST Resource: v1.media
Service: mybusiness.googleapis.com
To call this service, we recommend that you use the Google-provided client libraries . If your application needs to use your own libraries to call this service, use the following information when you make the API requests.
Discovery document
A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery documents:
Service endpoint
A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:
-
https://mybusiness.googleapis.com
REST Resource: v4.accounts
create
(deprecated)
POST /v4/accounts
Creates an account with the specified name and type under the given parent.
deleteNotifications
(deprecated)
DELETE /v4/{name=accounts/*/notifications}
Clears the pubsub notification settings for the account.
generateAccountNumber
(deprecated)
POST /v4/{name=accounts/*}:generateAccountNumber
Generates an account number for this account.
get
(deprecated)
GET /v4/{name=accounts/*}
Gets the specified account.
getNotifications
(deprecated)
GET /v4/{name=accounts/*/notifications}
Returns the pubsub notification settings for the account.
list
(deprecated)
GET /v4/accounts
Lists all of the accounts for the authenticated user.
GET /v4/{name=accounts/*}:recommendGoogleLocations
List all the
GoogleLocation
s that have been recommended to the specified Business Profile account. update
(deprecated)
PUT /v4/{name=accounts/*}
Updates the specified business account.
updateNotifications
(deprecated)
PUT /v4/{name=accounts/*/notifications}
Sets the pubsub notification settings for the account informing Business Profile 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. |
batchGetReviews
|
POST /v4/{name=accounts/*}/locations:batchGetReviews
Returns the paginated list of reviews for all specified locations. |
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. |
fetchVerificationOptions
|
POST /v4/{name=accounts/*/locations/*}:fetchVerificationOptions
Reports all eligible verification options for a location in a specific language. |
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. |
getFoodMenus
|
GET /v4/{name=accounts/*/locations/*/foodMenus}
Returns the food menus of a specific location. |
getGoogleUpdated
|
GET /v4/{name=accounts/*/locations/*}:googleUpdated
Gets the Google-updated version of the specified location. |
getHealthProviderAttributes
|
GET /v4/{name=accounts/*/locations/*/healthProviderAttributes}
Returns the Health provider attributes of a specific location. |
getServiceList
|
GET /v4/{name=accounts/*/locations/*/serviceList}
Get the specified service list of a 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. |
updateFoodMenus
|
PATCH /v4/{foodMenus.name=accounts/*/locations/*/foodMenus}
Updates the food menus of a specific location. |
updateHealthProviderAttributes
|
PATCH /v4/{healthProviderAttributes.name=accounts/*/locations/*/healthProviderAttributes}
Updates the Health provider attributes of a specific location. |
updateServiceList
|
PATCH /v4/{serviceList.name=accounts/*/locations/*/serviceList}
Updates the specified service list of a location. |
verify
|
POST /v4/{name=accounts/*/locations/*}:verify
Starts the verification process for a location. |
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.followers
Methods | |
---|---|
getMetadata
|
GET /v4/{name=accounts/*/locations/*/followers/metadata}
Get the followers settings for a location. |
REST Resource: v4.accounts.locations.insuranceNetworks
Methods | |
---|---|
list
|
GET /v4/{parent=accounts/*/locations/*}/insuranceNetworks
Returns a list of all insurance networks supported by Google. |
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.questions
Methods | |
---|---|
create
|
POST /v4/{parent=accounts/*/locations/*}/questions
Adds a question for the specified location. |
delete
|
DELETE /v4/{name=accounts/*/locations/*/questions/*}
Deletes a specific question written by the current user. |
list
|
GET /v4/{parent=accounts/*/locations/*}/questions
Returns the paginated list of questions and some of its answers for a specified location. |
patch
|
PATCH /v4/{name=accounts/*/locations/*/questions/*}
Updates a specific question written by the current user. |
REST Resource: v4.accounts.locations.questions.answers
Methods | |
---|---|
delete
|
DELETE /v4/{parent=accounts/*/locations/*/questions/*}/answers:delete
Deletes the answer written by the current user to a question. |
list
|
GET /v4/{parent=accounts/*/locations/*/questions/*}/answers
Returns the paginated list of answers for a specified question. |
upsert
|
POST /v4/{parent=accounts/*/locations/*/questions/*}/answers:upsert
Creates an answer or updates the existing answer written by the user for the specified question. |
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.accounts.locations.verifications
Methods | |
---|---|
complete
|
POST /v4/{name=accounts/*/locations/*/verifications/*}:complete
Completes a PENDING
verification. |
list
|
GET /v4/{parent=accounts/*/locations/*}/verifications
List verifications of a location, ordered by create time. |
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 | |
---|---|
batchGet
|
GET /v4/categories:batchGet
Returns a list of business categories for the provided language and GConcept ids. |
list
|
GET /v4/categories
Returns a list of business categories. |
REST Resource: v4.chains
Methods | |
---|---|
get
|
GET /v4/{name=chains/*}
Gets the specified chain. |
search
|
GET /v4/chains:search
Searches the chain based on chain name. |
REST Resource: v4.googleLocations
Methods | |
---|---|
report
|
POST /v4/{name=googleLocations/*}:report
Report a GoogleLocation
. |
search
|
POST /v4/googleLocations:search
Search all of the possible locations that are a match to the specified request. |
Service: mybusiness.googleapis.com
To call this service, we recommend that you use the Google-provided client libraries . If your application needs to use your own libraries to call this service, use the following information when you make the API requests.
Discovery document
A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery documents:
Service endpoint
A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:
-
https://mybusiness.googleapis.com
REST Resource: v1.media
Methods | |
---|---|
upload
|
POST /v1/media/{resourceName=**}
POST /upload/v1/media/{resourceName=**}
Uploads media. |