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.
Business Information API
Stay organized with collections
Save and categorize content based on your preferences.
Change log
v1
API Access
The Business Information API will need to be enabled from the GCP Console. The OAuth scope remains the same.
Endpoint URL
Endpoints for all business information, attributes, categories, chains and locations search are accessible at https://mybusinessbusinessinformation.googleapis.com/v1/ instead of https://mybusiness.googleapis.com/v4/
The path name for locations endpoints has changed from accounts/accountId/locations/locationId to locations/locationId
Location Updates
locationName has been renamed to title.websiteUrl has been renamed to websiteUri.accounts.locations.list and locations.get now requires a readMask.primaryPhone and additionalPhones are now part of
PhoneNumbers.primaryCategory and additionalCategories are now part of
Categories.address has been renamed to storefrontAddress.accounts.locations.clearAssociation has been updated to
locations.clearLocationAssociation.serviceItems are now read and updated directly from the Location object.
Attributes
- New
Attributes object and corresponding locations.attributes.getGoogleUpdated endpoint to get the Google updated version.
attributes.list has a show_all parameter allowing clients to see all the various attributes that can be set for a particular category and region combination.
Service Area Businesses
- Businesses of type
CUSTOMER_LOCATION_ONLY are no longer required to fill
out an address.
- Addition of
regionCode in
ServiceAreaBusiness.
It must be set for businesses of type CUSTOMER_LOCATION_ONLY.
Deprecated Endpoints and Objects
- Removal of
LocationKey object. The existing fields have been moved into
Metadata.
- Removal of
PriceLists object. It has been replaced by FoodMenus and
ServiceLists.
- Removal of
LocationState object. Most of the existing fields have been moved into
Metadata. Although Metadata contains a boolean to see whether the merchant has full control of the business (voice of merchant), more detailed suspension and verification related fields have been moved to the Verifications API. Use method locations.getVoiceOfMerchantState for next steps in order to gain voice of merchant.
- The endpoints
googleLocations.report and
accounts.locations.findMatchingLocations have been deprecated.
TransferLocation endpoint has been moved to locations.transfer under the
Account Management API.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-16 UTC."],[[["The Business Information API now uses `https://mybusinessbusinessinformation.googleapis.com/v1/` as the base endpoint and requires enabling in the GCP Console."],["Location data structure has been updated, renaming or relocating fields like `locationName`, `websiteUrl`, `primaryPhone`, `primaryCategory`, and `address`."],["A new `Attributes` object and `getGoogleUpdated` endpoint have been introduced for managing business attributes, and `attributes.list` now includes a `show_all` parameter."],["Service area businesses (`CUSTOMER_LOCATION_ONLY`) no longer require an address but need a `regionCode`, while `LocationKey`, `PriceLists`, and `LocationState` objects are deprecated."],["Some endpoints have been moved or deprecated, including `googleLocations.report`, `accounts.locations.findMatchingLocations`, and `TransferLocation`."]]],["The Business Information API requires enabling in the GCP Console, with a new endpoint URL: `https://mybusinessbusinessinformation.googleapis.com/v1/`. Location endpoints' path changed to `locations/locationId`. Updates include renaming fields like `locationName` to `title` and incorporating `PhoneNumbers` and `Categories`. `Attributes` now includes a `getGoogleUpdated` endpoint, with `show_all` parameter. Service area businesses (type `CUSTOMER_LOCATION_ONLY`) now require `regionCode`. Deprecated objects include `LocationKey`, `PriceLists`, `LocationState`, and removed endpoints `googleLocations.report`, `accounts.locations.findMatchingLocations`, and `TransferLocation` moved.\n"]]