Google Business Performance API has a
NEW API method that allows fetching multiple `DailyMetrics` in a single API request. Review the
deprecation schedule and instructions to migrate over from v4 reportInsights API method to Google Business Profile Performance API.
My Business Account Management API
Stay organized with collections
Save and categorize content based on your preferences.
The My Business Account Management API provides an interface for managing access to a location on Google.
Note - If you have a quota of 0 after enabling the API, please request for GBP API access.
Service: mybusinessaccountmanagement.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 document:
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://mybusinessaccountmanagement.googleapis.com
| Methods |
create |
POST /v1/accounts
Creates an account with the specified name and type under the given parent. |
get |
GET /v1/{name=accounts/*}
Gets the specified account. |
list |
GET /v1/accounts
Lists all of the accounts for the authenticated user. |
patch |
PATCH /v1/{account.name=accounts/*}
Updates the specified business account. |
| Methods |
create |
POST /v1/{parent=accounts/*}/admins
Invites the specified user to become an administrator for the specified account. |
delete |
DELETE /v1/{name=accounts/*/admins/*}
Removes the specified admin from the specified account. |
list |
GET /v1/{parent=accounts/*}/admins
Lists the admins for the specified account. |
patch |
PATCH /v1/{accountAdmin.name=accounts/*/admins/*}
Updates the Admin for the specified Account Admin. |
| Methods |
accept |
POST /v1/{name=accounts/*/invitations/*}:accept
Accepts the specified invitation. |
decline |
POST /v1/{name=accounts/*/invitations/*}:decline
Declines the specified invitation. |
list |
GET /v1/{parent=accounts/*}/invitations
Lists pending invitations for the specified account. |
| Methods |
transfer |
POST /v1/{name=locations/*}:transfer
Moves a location from an account that the user owns to another account that the same user administers. |
| Methods |
create |
POST /v1/{parent=locations/*}/admins
Invites the specified user to become an administrator for the specified location. |
delete |
DELETE /v1/{name=locations/*/admins/*}
Removes the specified admin as a manager of the specified location. |
list |
GET /v1/{parent=locations/*}/admins
Lists all of the admins for the specified location. |
patch |
PATCH /v1/{locationAdmin.name=locations/*/admins/*}
Updates the Admin for the specified location. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-16 UTC.
[null,null,["Last updated 2024-10-16 UTC."],[[["\u003cp\u003eThe My Business Account Management API allows you to manage access to Google Business Profile locations.\u003c/p\u003e\n"],["\u003cp\u003eYou can create and manage Google Business Profile accounts, including inviting and removing administrators.\u003c/p\u003e\n"],["\u003cp\u003eThe API enables managing location access, including transferring locations between accounts and managing location administrators.\u003c/p\u003e\n"],["\u003cp\u003eUsers with a quota of 0 after enabling the API should request GBP API access for full functionality.\u003c/p\u003e\n"]]],[],null,["# My Business Account Management API\n\nThe My Business Account Management API provides an interface for managing access to a location on Google. \n\nNote - If you have a quota of 0 after enabling the API, please [request](https://developers.google.com/my-business/content/prereqs#request-access) for GBP API access.\n\n- [REST Resource: v1.accounts](#v1.accounts)\n- [REST Resource: v1.accounts.admins](#v1.accounts.admins)\n- [REST Resource: v1.accounts.invitations](#v1.accounts.invitations)\n- [REST Resource: v1.locations](#v1.locations)\n- [REST Resource: v1.locations.admins](#v1.locations.admins)\n\nService: mybusinessaccountmanagement.googleapis.com\n---------------------------------------------------\n\nTo call this service, we recommend that you use the Google-provided [client libraries](https://cloud.google.com/apis/docs/client-libraries-explained). If your application needs to use your own libraries to call this service, use the following information when you make the API requests.\n\n### Discovery document\n\nA [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) 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 document:\n\n- \u003chttps://mybusinessaccountmanagement.googleapis.com/$discovery/rest?version=v1\u003e\n\n### Service endpoint\n\nA [service endpoint](https://cloud.google.com/apis/design/glossary#api_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:\n\n- `https://mybusinessaccountmanagement.googleapis.com`\n\nREST Resource: [v1.accounts](/my-business/reference/accountmanagement/rest/v1/accounts)\n---------------------------------------------------------------------------------------\n\n| Methods ||\n|----------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------|\n| [create](/my-business/reference/accountmanagement/rest/v1/accounts/create) | `POST /v1/accounts` Creates an account with the specified name and type under the given parent. |\n| [get](/my-business/reference/accountmanagement/rest/v1/accounts/get) | `GET /v1/{name=accounts/*}` Gets the specified account. |\n| [list](/my-business/reference/accountmanagement/rest/v1/accounts/list) | `GET /v1/accounts` Lists all of the accounts for the authenticated user. |\n| [patch](/my-business/reference/accountmanagement/rest/v1/accounts/patch) | `PATCH /v1/{account.name=accounts/*}` Updates the specified business account. |\n\nREST Resource: [v1.accounts.admins](/my-business/reference/accountmanagement/rest/v1/accounts.admins)\n-----------------------------------------------------------------------------------------------------\n\n| Methods ||\n|-----------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|\n| [create](/my-business/reference/accountmanagement/rest/v1/accounts.admins/create) | `POST /v1/{parent=accounts/*}/admins` Invites the specified user to become an administrator for the specified account. |\n| [delete](/my-business/reference/accountmanagement/rest/v1/accounts.admins/delete) | `DELETE /v1/{name=accounts/*/admins/*}` Removes the specified admin from the specified account. |\n| [list](/my-business/reference/accountmanagement/rest/v1/accounts.admins/list) | `GET /v1/{parent=accounts/*}/admins` Lists the admins for the specified account. |\n| [patch](/my-business/reference/accountmanagement/rest/v1/accounts.admins/patch) | `PATCH /v1/{accountAdmin.name=accounts/*/admins/*}` Updates the Admin for the specified Account Admin. |\n\nREST Resource: [v1.accounts.invitations](/my-business/reference/accountmanagement/rest/v1/accounts.invitations)\n---------------------------------------------------------------------------------------------------------------\n\n| Methods ||\n|------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|\n| [accept](/my-business/reference/accountmanagement/rest/v1/accounts.invitations/accept) | `POST /v1/{name=accounts/*/invitations/*}:accept` Accepts the specified invitation. |\n| [decline](/my-business/reference/accountmanagement/rest/v1/accounts.invitations/decline) | `POST /v1/{name=accounts/*/invitations/*}:decline` Declines the specified invitation. |\n| [list](/my-business/reference/accountmanagement/rest/v1/accounts.invitations/list) | `GET /v1/{parent=accounts/*}/invitations` Lists pending invitations for the specified account. |\n\nREST Resource: [v1.locations](/my-business/reference/accountmanagement/rest/v1/locations)\n-----------------------------------------------------------------------------------------\n\n| Methods ||\n|---------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|\n| [transfer](/my-business/reference/accountmanagement/rest/v1/locations/transfer) | `POST /v1/{name=locations/*}:transfer` Moves a location from an account that the user owns to another account that the same user administers. |\n\nREST Resource: [v1.locations.admins](/my-business/reference/accountmanagement/rest/v1/locations.admins)\n-------------------------------------------------------------------------------------------------------\n\n| Methods ||\n|------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------|\n| [create](/my-business/reference/accountmanagement/rest/v1/locations.admins/create) | `POST /v1/{parent=locations/*}/admins` Invites the specified user to become an administrator for the specified location. |\n| [delete](/my-business/reference/accountmanagement/rest/v1/locations.admins/delete) | `DELETE /v1/{name=locations/*/admins/*}` Removes the specified admin as a manager of the specified location. |\n| [list](/my-business/reference/accountmanagement/rest/v1/locations.admins/list) | `GET /v1/{parent=locations/*}/admins` Lists all of the admins for the specified location. |\n| [patch](/my-business/reference/accountmanagement/rest/v1/locations.admins/patch) | `PATCH /v1/{locationAdmin.name=locations/*/admins/*}` Updates the Admin for the specified location. |"]]