REST Resource: accounts.notificationsubscriptions

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

create

Creates a notification subscription for a business.

delete

Deletes a notification subscription for a merchant.

get

Gets notification subscriptions for an account.

list

Gets all the notification subscriptions for a merchant.

patch

Updates an existing notification subscription for a merchant.