Class NotificationsApiService.NotificationsApiServiceBase

Base class for server-side implementations of NotificationsApiService

Inheritance

object

NotificationsApiService.NotificationsApiServiceBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace: Google.Shopping.Merchant.Notifications.V1

Assembly: Google.Shopping.Merchant.Notifications.V1.dll

Syntax

[BindServiceMethod(typeof(NotificationsApiService), "BindService")]
public abstract class NotificationsApiService.NotificationsApiServiceBase

Methods

CreateNotificationSubscription(CreateNotificationSubscriptionRequest, ServerCallContext)

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

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.

Declaration

public virtual Task<NotificationSubscription> CreateNotificationSubscription(CreateNotificationSubscriptionRequest request, ServerCallContext context)

Parameters

Type	Name	Description
CreateNotificationSubscriptionRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<NotificationSubscription>	The response to send back to the client (wrapped by a task).

DeleteNotificationSubscription(DeleteNotificationSubscriptionRequest, ServerCallContext)

Deletes a notification subscription for a merchant.

Declaration

public virtual Task<Empty> DeleteNotificationSubscription(DeleteNotificationSubscriptionRequest request, ServerCallContext context)

Parameters

Type	Name	Description
DeleteNotificationSubscriptionRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<Empty>	The response to send back to the client (wrapped by a task).

GetNotificationSubscription(GetNotificationSubscriptionRequest, ServerCallContext)

Gets notification subscriptions for an account.

Declaration

public virtual Task<NotificationSubscription> GetNotificationSubscription(GetNotificationSubscriptionRequest request, ServerCallContext context)

Parameters

Type	Name	Description
GetNotificationSubscriptionRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<NotificationSubscription>	The response to send back to the client (wrapped by a task).

GetNotificationSubscriptionHealthMetrics(GetNotificationSubscriptionHealthMetricsRequest, ServerCallContext)

Retrieves notification subscription health metrics for a merchant. We recommend calling this periodically (hourly or daily) to monitor health of your callback endpoint.

Declaration

public virtual Task<NotificationSubscriptionHealthMetrics> GetNotificationSubscriptionHealthMetrics(GetNotificationSubscriptionHealthMetricsRequest request, ServerCallContext context)

Parameters

Type	Name	Description
GetNotificationSubscriptionHealthMetricsRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<NotificationSubscriptionHealthMetrics>	The response to send back to the client (wrapped by a task).

ListNotificationSubscriptions(ListNotificationSubscriptionsRequest, ServerCallContext)

Gets all the notification subscriptions for a merchant.

Declaration

public virtual Task<ListNotificationSubscriptionsResponse> ListNotificationSubscriptions(ListNotificationSubscriptionsRequest request, ServerCallContext context)

Parameters

Type	Name	Description
ListNotificationSubscriptionsRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<ListNotificationSubscriptionsResponse>	The response to send back to the client (wrapped by a task).

UpdateNotificationSubscription(UpdateNotificationSubscriptionRequest, ServerCallContext)

Updates an existing notification subscription for a merchant.

Declaration

public virtual Task<NotificationSubscription> UpdateNotificationSubscription(UpdateNotificationSubscriptionRequest request, ServerCallContext context)

Parameters

Type	Name	Description
UpdateNotificationSubscriptionRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<NotificationSubscription>	The response to send back to the client (wrapped by a task).