rocket
Meet
Merchant API
- the official successor to Content API for Shopping.
update
Get the latest
on new Merchant API features, bug fixes, and updates.
add_alert
Note: Content API for Shopping will be sunset on August 18, 2026.
REST Resource: pubsubnotificationsettings
Stay organized with collections
Save and categorize content based on your preferences.
Resource: PubsubNotificationSettings
Settings for Pub/Sub notifications, all methods require that the caller is a direct user of the merchant center account.
| JSON representation |
{
"kind": string,
"cloudTopicName": string,
"registeredEvents": [
string
]
} |
| Fields |
kind |
string
Identifies what kind of resource this is. Value: the fixed string "content#pubsubNotificationSettings"
|
cloudTopicName |
string
Cloud pub/sub topic to which notifications are sent (read-only).
|
registeredEvents[] |
string
List of event types. Acceptable values are:
|
Methods |
|
|
Retrieves a Merchant Center account's pubsub notification settings. |
|
|
Register a Merchant Center account for pubsub notifications. |
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-02-25 UTC.
[null,null,["Last updated 2025-02-25 UTC."],[[["\u003cp\u003ePubsubNotificationSettings allows you to configure Pub/Sub notifications for your Merchant Center account, requiring direct user access.\u003c/p\u003e\n"],["\u003cp\u003eThese settings define where notifications are sent (\u003ccode\u003ecloudTopicName\u003c/code\u003e) and which events trigger them (\u003ccode\u003eregisteredEvents\u003c/code\u003e).\u003c/p\u003e\n"],["\u003cp\u003eYou can retrieve existing notification settings using the \u003ccode\u003eget\u003c/code\u003e method and register or update them with the \u003ccode\u003eupdate\u003c/code\u003e method.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eorderPendingShipment\u003c/code\u003e event is a supported event type for triggering notifications.\u003c/p\u003e\n"],["\u003cp\u003eThe JSON representation of PubsubNotificationSettings includes \u003ccode\u003ekind\u003c/code\u003e, \u003ccode\u003ecloudTopicName\u003c/code\u003e, and \u003ccode\u003eregisteredEvents\u003c/code\u003e fields.\u003c/p\u003e\n"]]],["Pub/Sub notification settings manage notifications for a Merchant Center account, requiring direct user access. Settings include a `kind`, a read-only `cloudTopicName`, and a list of `registeredEvents`. The only currently available registered event is `orderPendingShipment`. The `get` method retrieves notification settings, while the `update` method registers an account for these notifications. The settings use a specific JSON structure.\n"],null,["# REST Resource: pubsubnotificationsettings\n\n- [Resource: PubsubNotificationSettings](#PubsubNotificationSettings)\n - [JSON representation](#PubsubNotificationSettings.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: PubsubNotificationSettings\n------------------------------------\n\nSettings for Pub/Sub notifications, all methods require that the caller is a direct user of the merchant center account.\n\n| JSON representation |\n|--------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"cloudTopicName\": string, \"registeredEvents\": [ string ] } ``` |\n\n| Fields ||\n|----------------------|-------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies what kind of resource this is. Value: the fixed string \"`content#pubsubNotificationSettings`\" |\n| `cloudTopicName` | `string` Cloud pub/sub topic to which notifications are sent (read-only). |\n| `registeredEvents[]` | `string` List of event types. Acceptable values are: - \"`orderPendingShipment`\" \u003cbr /\u003e |\n\n| Methods ------- ||\n|---------------------------------------------------------------------------------------|---------------------------------------------------------------------|\n| ### [get](/shopping-content/reference/rest/v2.1/pubsubnotificationsettings/get) | Retrieves a Merchant Center account's pubsub notification settings. |\n| ### [update](/shopping-content/reference/rest/v2.1/pubsubnotificationsettings/update) | Register a Merchant Center account for pubsub notifications. |"]]