REST Resource: accounts.notificationsubscriptions
Stay organized with collections
Save and categorize content based on your preferences.
Resource: NotificationSubscription
Represents a notification subscription owned by a Merchant account.
JSON representation |
{
"name": string,
"registeredEvent": enum (NotificationEventType ),
"callBackUri": string,
// Union field interested_in can be only one of the following:
"allManagedAccounts": boolean,
"targetAccount": string
// End of list of possible types for union field interested_in .
} |
Fields |
name |
string
Output only. The name of the notification configuration. Generated by the Content API upon creation of a new NotificationSubscription . The account represents the merchant ID of the merchant that owns the configuration. Format: accounts/{account}/notificationsubscriptions/{notificationSubscription}
|
registeredEvent |
enum (NotificationEventType )
The event that the merchant wants to be notified about.
|
callBackUri |
string
URL to be used to push the notification to the merchant.
|
Union field interested_in . interested_in can be only one of the following:
|
allManagedAccounts |
boolean
If this value is true, the requesting account is notified of the specified event for all managed accounts (can be subaccounts or other linked accounts) including newly added accounts on a daily basis.
|
targetAccount |
string
The name of the account you want to receive notifications for. Format: accounts/{account}
|
NotificationEventType
Represents the event type that the merchant is interested in receiving notifications for.
Enums |
NOTIFICATION_EVENT_TYPE_UNSPECIFIED |
Notifications event type is unspecified. |
PRODUCT_STATUS_CHANGE |
Notification of product status changes, for example when product becomes disapproved. |
Methods |
|
Creates a notification subscription for a business. |
|
Deletes a notification subscription for a merchant. |
|
Gets notification subscriptions for an account. |
|
Gets all the notification subscriptions for a merchant. |
|
Updates an existing notification subscription for a merchant. |
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-07-31 UTC.
[null,null,["Last updated 2025-07-31 UTC."],[],[],null,["# REST Resource: accounts.notificationsubscriptions\n\n- [Resource: NotificationSubscription](#NotificationSubscription)\n - [JSON representation](#NotificationSubscription.SCHEMA_REPRESENTATION)\n- [NotificationEventType](#NotificationEventType)\n- [Methods](#METHODS_SUMMARY)\n\nResource: NotificationSubscription\n----------------------------------\n\nRepresents a notification subscription owned by a Merchant account.\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"registeredEvent\": enum (/merchant/api/reference/rest/notifications_v1/accounts.notificationsubscriptions#NotificationEventType), \"callBackUri\": string, // Union field `interested_in` can be only one of the following: \"allManagedAccounts\": boolean, \"targetAccount\": string // End of list of possible types for union field `interested_in`. } ``` |\n\n| Fields ||\n|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Output only. The `name` of the notification configuration. Generated by the Content API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account}/notificationsubscriptions/{notificationSubscription}` |\n| `registeredEvent` | `enum (`[NotificationEventType](/merchant/api/reference/rest/notifications_v1/accounts.notificationsubscriptions#NotificationEventType)`)` The event that the merchant wants to be notified about. |\n| `callBackUri` | `string` URL to be used to push the notification to the merchant. |\n| Union field `interested_in`. `interested_in` can be only one of the following: ||\n| `allManagedAccounts` | `boolean` If this value is true, the requesting account is notified of the specified event for all managed accounts (can be subaccounts or other linked accounts) including newly added accounts on a daily basis. |\n| `targetAccount` | `string` The `name` of the account you want to receive notifications for. Format: `accounts/{account}` |\n\nNotificationEventType\n---------------------\n\nRepresents the event type that the merchant is interested in receiving notifications for.\n\n| Enums ||\n|---------------------------------------|---------------------------------------------------------------------------------------|\n| `NOTIFICATION_EVENT_TYPE_UNSPECIFIED` | Notifications event type is unspecified. |\n| `PRODUCT_STATUS_CHANGE` | Notification of product status changes, for example when product becomes disapproved. |\n\n| Methods ------- ||\n|-------------------------------------------------------------------------------------------------------|---------------------------------------------------------------|\n| ### [create](/merchant/api/reference/rest/notifications_v1/accounts.notificationsubscriptions/create) | Creates a notification subscription for a business. |\n| ### [delete](/merchant/api/reference/rest/notifications_v1/accounts.notificationsubscriptions/delete) | Deletes a notification subscription for a merchant. |\n| ### [get](/merchant/api/reference/rest/notifications_v1/accounts.notificationsubscriptions/get) | Gets notification subscriptions for an account. |\n| ### [list](/merchant/api/reference/rest/notifications_v1/accounts.notificationsubscriptions/list) | Gets all the notification subscriptions for a merchant. |\n| ### [patch](/merchant/api/reference/rest/notifications_v1/accounts.notificationsubscriptions/patch) | Updates an existing notification subscription for a merchant. |"]]