Google

My Business Business Information API

The My Business Business Information API provides an interface for managing business information on Google. Note: If you have a quota of 0 after enabling the…

Developer tools#openapi#analytics#media

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The My Business Business Information API provides an interface for managing business information on Google. Note: If you have a quota of 0 after enabling the API, please request GBP API access at https://developers.google.com/my-business/content/prereqs#request-access.

Endpoints 11

accounts.locations

  • GETLists the locations for the specified account./v1/:parent/locations?filter=string&orderBy=string&pageSize=0&pageToken=string&readMask=stringLists the locations for the specified account.
  • POSTCreates a new Location that will be owned by the logged in user./v1/:parent/locations?requestId=string&validateOnly=trueCreates a new Location that will be owned by the logged in user.

attributes

  • GETReturns the list of attributes that would be available for a location with the given primary category and country./v1/attributes?categoryName=string&languageCode=string&pageSize=0&pageToken=string&parent=string&regionCode=string&showAll=trueReturns the list of attributes that would be available for a location with the given primary category and country.

categories

  • GETReturns a list of business categories for the provided language and GConcept ids./v1/categories:batchGet?languageCode=string&names=string&regionCode=string&view=CATEGORY_VIEW_UNSPECIFIEDReturns a list of business categories for the provided language and GConcept ids.
  • GETReturns a list of business categories/v1/categories?filter=string&languageCode=string&pageSize=0&pageToken=string&regionCode=string&view=CATEGORY_VIEW_UNSPECIFIEDReturns a list of business categories. Search will match the category name but not the category ID. Search only matches the front of a category name (that is,…

locations

  • GETRetrieves attributes for a location as last set by the merchant/v1/:nameRetrieves attributes for a location as last set by the merchant. It may not reflect updates from Google or user-generated content that are live on Google Maps.
  • DELETEDeletes a location/v1/:nameDeletes a location. If this location cannot be deleted using the API and it is marked so in the google.mybusiness.businessinformation.v1.LocationState, use…
  • PATCHUpdate attributes for a given location./v1/:name?attributeMask=stringUpdate attributes for a given location.

chains

  • GETSearches the chain based on chain name./v1/chains:search?chainName=string&pageSize=0Searches the chain based on chain name.

googleLocations

  • POSTSearch all of the possible locations that are a match to the specified request./v1/googleLocations:searchSearch all of the possible locations that are a match to the specified request.

locations.attributes

  • GETRetrieves attributes for a location as they appear live on Google Maps and Search/v1/:name:getGoogleUpdatedRetrieves attributes for a location as they appear live on Google Maps and Search. This consumer-facing view may have been updated by Google or user-generated…

API details

Base URL
https://mybusinessbusinessinformation.googleapis.com
Authentication
OAuth 2.0 (authorization code flow)
An API key in the key query parameter
Operations
11 operations on 8 pathsGET 7POST 2PATCH 1DELETE 1
Main resources
locations 3accounts.locations 2categories 2attributes 1chains 1googleLocations 1locations.attributes 1
Response formats
application/json
Description format
Google API Discovery, API version v1

How to test the My Business Business Information API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the My Business Business Information API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Lists the locations for the specified account.” (GET /v1/:parent/locations?filter=string&orderBy=string&pageSize=0&pageToken=string&readMask=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the My Business Business Information API?

The My Business Business Information API provides an interface for managing business information on Google. Note: If you have a quota of 0 after enabling the… It is listed under Developer tools and has 11 endpoints.

Who publishes the My Business Business Information API?

It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.

What is the base URL of the My Business Business Information API?

Requests go to https://mybusinessbusinessinformation.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the My Business Business Information API?

It accepts 2 methods: OAuth 2.0 (authorization code flow); an API key in the key query parameter.

How many endpoints does the My Business Business Information API have?

11 operations on 8 paths (7 GET, 2 POST, 1 PATCH, 1 DELETE). The largest groups are locations, accounts.locations, categories, attributes.

Is forking the My Business Business Information API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.