Sign up for email announcements to stay updated on the latest information about the GMB API.

GoogleLocations

The GoogleLocations API allows you to see in advance whether a location has been claimed in Google My Business. This way, if the location has been claimed, you can immediately request access to the location. Also, if you manage bulk-verified accounts, you can more accurately select potential matches in advance and avoid the creation of duplicate locations.

The API endpoint returns a URL that indicates if a location has already been claimed. If it has been claimed, the same URL allows you start the access request process.

The following image provides an overview of the process to gain ownership of a location.

Figure 1. Swimlane diagram of Google My Business location ownership

The following steps allow you to use the GoogleLocations API:

  1. Collect location data from the merchant.
  2. Call the googleLocations.search endpoint. Provide the location data within the body of the call. Alternatively, you can provide it in a query string, similar to what a user would enter in Search or Maps. For example, "Starbucks 5th ave NYC."

    The API returns a list of potentially matching locations and information about each location, such as locationName and address.

  3. Select the location that matches your location. If there are no matches, call accounts.locations.create, leave the placeID field blank, and skip to step 5.
  4. Based on the state of requestAdminRightsUrl in the response, take the following actions:

    1. If requestAdminRightsUrl exists, another user has ownership of the listing. Direct the merchant to the URL to start a request for access and ownership of the existing location in Google My Business.
    2. If requestAdminRightsUrl doesn't exist, call accounts.locations.create and provide the placeID of the selected location returned in step 3 as part of the location object.
  5. If you created new listings as part of this process, you can utilize the verification APIs to begin verification of the listings. For more information, see Manage verification.