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.
Manage real-time notifications
Stay organized with collections
Save and categorize content based on your preferences.
In the My Business Notifications API, notifications are published in
the Cloud Pub/Sub service. After
you set up Cloud Pub/Sub and create a topic, you can perform the following
operations on notifications:
New or updated reviews, questions and answers, media uploads,
Google updates for review, location state changes, and more are supported.
The NotificationType object
lists and describes the available notification types.
Before you begin
To use the My Business Notifications API, register your application and obtain
OAuth 2.0 credentials. For details on how to get started with the API,
see Basic setup.
Cloud Pub/Sub setup
To set up API notifications with
Cloud Pub/Sub, perform the following steps:
- Follow the Cloud Pub/Sub guide to
set up your application.
- Create a topic
in your Cloud Pub/Sub project and note the name of the created topic.
- Give at least
pubsub.topics.publish
permissions to mybusiness-api-pubsub@system.gserviceaccount.com.
- Follow the Subscriber overview
guide to set up either push or pull notifications.
- To receive notifications, call the
accounts.updateNotificationSetting
endpoint in the My Business Notifications API. In the call, use the topic
name you created in Cloud Pub/Sub to link your Business Profile account to the topic.
- (Optional) Repeat step 5 for each Business Profile account that you want to
receive notifications for.
Retrieve notification settings
The accounts.getNotificationSetting
endpoint returns the current Cloud Pub/Sub notification settings for an
account. The following table shows how to call it:
GET
https://mybusinessnotifications.googleapis.com/v1/accounts/{accountId}/notificationSetting
Update notification settings
The accounts.updateNotificationSetting
endpoint updates the Cloud Pub/Sub notification settings associated with an
account. The following table shows how to call it:
PATCH
https://mybusinessnotifications.googleapis.com/v1/accounts/{accountId}/notificationSetting?updateMask={commaSeparatedFieldsToUpdate}
{
pubsubTopic: your/pubsub/topicName
}
Delete notification settings
Calling the accounts.updateNotificationSetting
with an empty pubsubTopic deletes the Cloud Pub/Sub notification settings from an account.
The following table shows how to call it:
PATCH
https://mybusinessnotifications.googleapis.com/v1/accounts/{accountId}/notificationSetting?updateMask=pubsubTopic
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 2025-08-28 UTC.
[null,null,["Last updated 2025-08-28 UTC."],[[["\u003cp\u003eThe My Business Notifications API uses Cloud Pub/Sub to deliver notifications about various business events, such as new reviews, Q&As, and location updates.\u003c/p\u003e\n"],["\u003cp\u003eTo receive notifications, you must set up a Cloud Pub/Sub topic, grant necessary permissions, and link your Business Profile account to the topic using the API.\u003c/p\u003e\n"],["\u003cp\u003eYou can manage your notification settings using the API to retrieve, update (including setting a new topic or deleting the setting), or delete them.\u003c/p\u003e\n"],["\u003cp\u003eThe API provides endpoints for retrieving, updating, and deleting notification settings associated with your Business Profile account.\u003c/p\u003e\n"],["\u003cp\u003eRefer to the provided links for detailed instructions on setting up Cloud Pub/Sub and using the My Business Notifications API.\u003c/p\u003e\n"]]],[],null,["# Manage real-time notifications\n\n\u003cbr /\u003e\n\nIn the My Business Notifications API, notifications are published in\nthe [Cloud Pub/Sub](https://cloud.google.com/pubsub/) service. After\nyou set up Cloud Pub/Sub and create a topic, you can perform the following\noperations on notifications:\n\n- [Retrieve notification settings.](#retrieve_notification_settings)\n- [Update notification settings.](#update_notification_settings)\n- [Delete notification settings.](#delete_notification_settings)\n\nNew or updated reviews, questions and answers, media uploads,\nGoogle updates for review, location state changes, and more are supported.\nThe [NotificationType](/my-business/reference/notifications/rest/v1/NotificationSetting#NotificationType) object\nlists and describes the available notification types.\n\nBefore you begin\n----------------\n\nTo use the My Business Notifications API, register your application and obtain\nOAuth 2.0 credentials. For details on how to get started with the API,\nsee [Basic setup](/my-business/content/basic-setup).\n\nCloud Pub/Sub setup\n-------------------\n\nTo set up API notifications with\n[Cloud Pub/Sub](https://cloud.google.com/pubsub/), perform the following steps:\n\n1. Follow the Cloud Pub/Sub guide to [set up your application](https://cloud.google.com/pubsub/docs/quickstart-client-libraries).\n2. [Create a topic](https://cloud.google.com/pubsub/docs/admin#create_a_topic) in your Cloud Pub/Sub project and note the name of the created topic.\n3. Give at least [`pubsub.topics.publish`](https://cloud.google.com/pubsub/docs/access-control#tbl_roles) permissions to mybusiness-api-pubsub@system.gserviceaccount.com.\n4. Follow the [Subscriber overview](https://cloud.google.com/pubsub/docs/subscriber) guide to set up either push or pull notifications.\n5. To receive notifications, call the [`accounts.updateNotificationSetting`](/my-business/reference/notifications/rest/v1/accounts/updateNotificationSetting) endpoint in the My Business Notifications API. In the call, use the topic name you created in Cloud Pub/Sub to link your Business Profile account to the topic.\n6. (Optional) Repeat step 5 for each Business Profile account that you want to receive notifications for.\n\nRetrieve notification settings\n------------------------------\n\nThe [`accounts.getNotificationSetting`](/my-business/reference/notifications/rest/v1/accounts/getNotificationSetting)\nendpoint returns the current Cloud Pub/Sub notification settings for an\naccount. The following table shows how to call it:\nHTTP \n\n```\nGET\nhttps://mybusinessnotifications.googleapis.com/v1/accounts/{accountId}/notificationSetting\n```\n\nUpdate notification settings\n----------------------------\n\nThe [`accounts.updateNotificationSetting`](/my-business/reference/notifications/rest/v1/accounts/updateNotificationSetting)\nendpoint updates the Cloud Pub/Sub notification settings associated with an\naccount. The following table shows how to call it:\nHTTP \n\n```\nPATCH\nhttps://mybusinessnotifications.googleapis.com/v1/accounts/{accountId}/notificationSetting?updateMask={commaSeparatedFieldsToUpdate}\n\n{\n pubsubTopic: your/pubsub/topicName\n}\n```\n\nDelete notification settings\n----------------------------\n\nCalling the [`accounts.updateNotificationSetting`](/my-business/reference/notifications/rest/v1/accounts/updateNotificationSetting)\nwith an empty `pubsubTopic` deletes the Cloud Pub/Sub notification settings from an account.\nThe following table shows how to call it:\nHTTP \n\n```\nPATCH\nhttps://mybusinessnotifications.googleapis.com/v1/accounts/{accountId}/notificationSetting?updateMask=pubsubTopic\n```"]]