NotificationsApiService

rpc CreateNotificationSubscription(CreateNotificationSubscriptionRequest) returns (NotificationSubscription)

Creates a notification subscription for a business. For standalone or subaccounts accounts, the business can create a subscription for self. For advanced accounts, the business can create a subscription for all managed accounts or for a specific subaccount.

See Decode notifications for information on how to decode the notification payload and how to interpret its contents.

We will allow the following types of notification subscriptions to exist together (per business as a subscriber per event type):

1. Subscription for all managed accounts + subscription for self.

2. Multiple "partial" subscriptions for managed accounts + subscription for self.

we will not allow (per business as a subscriber per event type):

1. Multiple self subscriptions.

2. Multiple "all managed accounts" subscriptions.

3. "All managed accounts" subscription and partial subscriptions at the same time.

4. Multiple partial subscriptions for the same target account.

Authorization scopes

Requires the following OAuth scope:

• https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.

rpc DeleteNotificationSubscription(DeleteNotificationSubscriptionRequest) returns (Empty)

Deletes a notification subscription for a merchant.

Authorization scopes

Requires the following OAuth scope:

• https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.

rpc GetNotificationSubscription(GetNotificationSubscriptionRequest) returns (NotificationSubscription)

Gets notification subscriptions for an account.

Authorization scopes

Requires the following OAuth scope:

• https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.

rpc ListNotificationSubscriptions(ListNotificationSubscriptionsRequest) returns (ListNotificationSubscriptionsResponse)

Gets all the notification subscriptions for a merchant.

Authorization scopes

Requires the following OAuth scope:

• https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.

rpc UpdateNotificationSubscription(UpdateNotificationSubscriptionRequest) returns (NotificationSubscription)

Updates an existing notification subscription for a merchant.

Authorization scopes

Requires the following OAuth scope:

• https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.