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.
NotificationSetting
Stay organized with collections
Save and categorize content based on your preferences.
A Google Pub/Sub topic where notifications can be published when a location is updated or has a new review. There will be only one notification setting resource per-account.
JSON representation |
{
"name": string,
"pubsubTopic": string,
"notificationTypes": [
enum (NotificationType )
]
} |
Fields |
name |
string
Required. The resource name this setting is for. This is of the form accounts/{account_id}/notificationSetting .
|
pubsubTopic |
string
Optional. The Google Pub/Sub topic that will receive notifications when locations managed by this account are updated. If unset, no notifications will be posted. The account mybusiness-api-pubsub@system.gserviceaccount.com must have at least Publish permissions on the Pub/Sub topic.
|
notificationTypes[] |
enum (NotificationType )
The types of notifications that will be sent to the Pub/Sub topic. To stop receiving notifications entirely, use NotificationSettings.UpdateNotificationSetting with an empty notificationTypes or set the pubsubTopic to an empty string.
|
NotificationType
Type of notification sent to the Pub/Sub topic.
Enums |
NOTIFICATION_TYPE_UNSPECIFIED |
No notification type. Will not match any notifications. |
GOOGLE_UPDATE |
The location has Google updates for review. The location_name field on the notification will provide the resource name of the location with Google updates. |
NEW_REVIEW |
A new review has been added to the location. The review_name field on the notification will provide the resource name of the review that was added, and location_name will have the location's resource name. |
UPDATED_REVIEW |
A review on the location has been updated. The review_name field on the notification will provide the resource name of the review that was added, and location_name will have the location's resource name. |
NEW_CUSTOMER_MEDIA |
A new media item has been added to the location by a Google Maps user. The notification will provide the resource name of the new media item. |
NEW_QUESTION |
A new question is added to the location. The notification will provide the resource name of question. |
UPDATED_QUESTION |
A question of the location is updated. The notification will provide the resource name of question. |
NEW_ANSWER |
A new answer is added to the location. The notification will provide the resource name of question and answer. |
UPDATED_ANSWER |
An answer of the location is updated. The notification will provide the resource name of question and answer. |
DUPLICATE_LOCATION |
Indicates whether there is a change in location metadata's duplicate location field. |
LOSS_OF_VOICE_OF_MERCHANT |
Deprecated: Migrate the existing usages of this value to the more expanded "VOICE_OF_MERCHANT_UPDATED". |
VOICE_OF_MERCHANT_UPDATED |
Indicates whether the location has an update in Voice of Merchant (VOM) status. VOM dictates whether the location is in good standing and the merchant has control over the business on Google. Any edits made to the location will propagate to Maps after passing the review phase. Call GetVoiceOfMerchantState rpc for more details. |
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\u003eGoogle Pub/Sub notifications can be configured for location updates and new reviews.\u003c/p\u003e\n"],["\u003cp\u003eA single notification setting exists per account, directing notifications to a specified Pub/Sub topic.\u003c/p\u003e\n"],["\u003cp\u003eNotification types include Google updates, new/updated reviews, new customer media, new/updated Q&A, duplicate location and Voice of Merchant updates.\u003c/p\u003e\n"],["\u003cp\u003eAccount must grant \u003ccode\u003emybusiness-api-pubsub@system.gserviceaccount.com\u003c/code\u003e publish permissions on the designated Pub/Sub topic.\u003c/p\u003e\n"],["\u003cp\u003eTo disable notifications, clear the \u003ccode\u003enotificationTypes\u003c/code\u003e list or set \u003ccode\u003epubsubTopic\u003c/code\u003e to an empty string in the notification settings.\u003c/p\u003e\n"]]],[],null,["# NotificationSetting\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n- [NotificationType](#NotificationType)\n\nA Google Pub/Sub topic where notifications can be published when a location is updated or has a new review. There will be only one notification setting resource per-account.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"pubsubTopic\": string, \"notificationTypes\": [ enum (/my-business/reference/notifications/rest/v1/NotificationSetting#NotificationType) ] } ``` |\n\n| Fields ||\n|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. The resource name this setting is for. This is of the form `accounts/{account_id}/notificationSetting`. |\n| `pubsubTopic` | `string` Optional. The Google Pub/Sub topic that will receive notifications when locations managed by this account are updated. If unset, no notifications will be posted. The account [mybusiness-api-pubsub@system.gserviceaccount.com](mailto:mybusiness-api-pubsub@system.gserviceaccount.com) must have at least Publish permissions on the Pub/Sub topic. |\n| `notificationTypes[]` | `enum (`[NotificationType](/my-business/reference/notifications/rest/v1/NotificationSetting#NotificationType)`)` The types of notifications that will be sent to the Pub/Sub topic. To stop receiving notifications entirely, use NotificationSettings.UpdateNotificationSetting with an empty notificationTypes or set the pubsubTopic to an empty string. |\n\nNotificationType\n----------------\n\nType of notification sent to the Pub/Sub topic.\n\n| Enums ||\n|---------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `NOTIFICATION_TYPE_UNSPECIFIED` | No notification type. Will not match any notifications. |\n| `GOOGLE_UPDATE` | The location has Google updates for review. The location_name field on the notification will provide the resource name of the location with Google updates. |\n| `NEW_REVIEW` | A new review has been added to the location. The review_name field on the notification will provide the resource name of the review that was added, and location_name will have the location's resource name. |\n| `UPDATED_REVIEW` | A review on the location has been updated. The review_name field on the notification will provide the resource name of the review that was added, and location_name will have the location's resource name. |\n| `NEW_CUSTOMER_MEDIA` | A new media item has been added to the location by a Google Maps user. The notification will provide the resource name of the new media item. |\n| `NEW_QUESTION` | A new question is added to the location. The notification will provide the resource name of question. |\n| `UPDATED_QUESTION` | A question of the location is updated. The notification will provide the resource name of question. |\n| `NEW_ANSWER` | A new answer is added to the location. The notification will provide the resource name of question and answer. |\n| `UPDATED_ANSWER` | An answer of the location is updated. The notification will provide the resource name of question and answer. |\n| `DUPLICATE_LOCATION` | Indicates whether there is a change in location metadata's duplicate location field. |\n| `LOSS_OF_VOICE_OF_MERCHANT` | Deprecated: Migrate the existing usages of this value to the more expanded \"VOICE_OF_MERCHANT_UPDATED\". | This item is deprecated! |\n| `VOICE_OF_MERCHANT_UPDATED` | Indicates whether the location has an update in Voice of Merchant (VOM) status. VOM dictates whether the location is in good standing and the merchant has control over the business on Google. Any edits made to the location will propagate to Maps after passing the review phase. Call GetVoiceOfMerchantState rpc for more details. |"]]