Class NotificationsApiService.NotificationsApiServiceClient

Client for NotificationsApiService

Inheritance

object

ClientBase

ClientBase<NotificationsApiService.NotificationsApiServiceClient>

NotificationsApiService.NotificationsApiServiceClient

Inherited Members

ClientBase<NotificationsApiService.NotificationsApiServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace: Google.Shopping.Merchant.Notifications.V1

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

Syntax

public class NotificationsApiService.NotificationsApiServiceClient : ClientBase<NotificationsApiService.NotificationsApiServiceClient>

Constructors

NotificationsApiServiceClient()

Protected parameterless constructor to allow creation of test doubles.

Declaration

protected NotificationsApiServiceClient()

NotificationsApiServiceClient(CallInvoker)

Creates a new client for NotificationsApiService that uses a custom CallInvoker.

Declaration

public NotificationsApiServiceClient(CallInvoker callInvoker)

Parameters

Type	Name	Description
CallInvoker	callInvoker	The callInvoker to use to make remote calls.

NotificationsApiServiceClient(ChannelBase)

Creates a new client for NotificationsApiService

Declaration

public NotificationsApiServiceClient(ChannelBase channel)

Parameters

Type	Name	Description
ChannelBase	channel	The channel to use to make remote calls.

NotificationsApiServiceClient(ClientBaseConfiguration)

Protected constructor to allow creation of configured clients.

Declaration

protected NotificationsApiServiceClient(ClientBase.ClientBaseConfiguration configuration)

Parameters

Type	Name	Description
ClientBase.ClientBaseConfiguration	configuration	The client configuration.

Methods

CreateNotificationSubscription(CreateNotificationSubscriptionRequest, CallOptions)

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):

Subscription for all managed accounts + subscription for self.
Multiple "partial" subscriptions for managed accounts + subscription for self.

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

Multiple self subscriptions.
Multiple "all managed accounts" subscriptions.
"All managed accounts" subscription and partial subscriptions at the same time.
Multiple partial subscriptions for the same target account.

Declaration

public virtual NotificationSubscription CreateNotificationSubscription(CreateNotificationSubscriptionRequest request, CallOptions options)

Parameters

Type	Name	Description
CreateNotificationSubscriptionRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
NotificationSubscription	The response received from the server.

CreateNotificationSubscription(CreateNotificationSubscriptionRequest, Metadata, DateTime?, CancellationToken)

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

Subscription for all managed accounts + subscription for self.
Multiple "partial" subscriptions for managed accounts + subscription for self.

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

Multiple self subscriptions.
Multiple "all managed accounts" subscriptions.
"All managed accounts" subscription and partial subscriptions at the same time.
Multiple partial subscriptions for the same target account.

Declaration

public virtual NotificationSubscription CreateNotificationSubscription(CreateNotificationSubscriptionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreateNotificationSubscriptionRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
NotificationSubscription	The response received from the server.

CreateNotificationSubscriptionAsync(CreateNotificationSubscriptionRequest, CallOptions)

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

Subscription for all managed accounts + subscription for self.
Multiple "partial" subscriptions for managed accounts + subscription for self.

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

Multiple self subscriptions.
Multiple "all managed accounts" subscriptions.
"All managed accounts" subscription and partial subscriptions at the same time.
Multiple partial subscriptions for the same target account.

Declaration

public virtual AsyncUnaryCall<NotificationSubscription> CreateNotificationSubscriptionAsync(CreateNotificationSubscriptionRequest request, CallOptions options)

Parameters

Type	Name	Description
CreateNotificationSubscriptionRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<NotificationSubscription>	The call object.

CreateNotificationSubscriptionAsync(CreateNotificationSubscriptionRequest, Metadata, DateTime?, CancellationToken)

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

Subscription for all managed accounts + subscription for self.
Multiple "partial" subscriptions for managed accounts + subscription for self.

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

Multiple self subscriptions.
Multiple "all managed accounts" subscriptions.
"All managed accounts" subscription and partial subscriptions at the same time.
Multiple partial subscriptions for the same target account.

Declaration

public virtual AsyncUnaryCall<NotificationSubscription> CreateNotificationSubscriptionAsync(CreateNotificationSubscriptionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreateNotificationSubscriptionRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<NotificationSubscription>	The call object.

DeleteNotificationSubscription(DeleteNotificationSubscriptionRequest, CallOptions)

Deletes a notification subscription for a merchant.

Declaration

public virtual Empty DeleteNotificationSubscription(DeleteNotificationSubscriptionRequest request, CallOptions options)

Parameters

Type	Name	Description
DeleteNotificationSubscriptionRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
Empty	The response received from the server.

DeleteNotificationSubscription(DeleteNotificationSubscriptionRequest, Metadata, DateTime?, CancellationToken)

Deletes a notification subscription for a merchant.

Declaration

public virtual Empty DeleteNotificationSubscription(DeleteNotificationSubscriptionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
DeleteNotificationSubscriptionRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
Empty	The response received from the server.

DeleteNotificationSubscriptionAsync(DeleteNotificationSubscriptionRequest, CallOptions)

Deletes a notification subscription for a merchant.

Declaration

public virtual AsyncUnaryCall<Empty> DeleteNotificationSubscriptionAsync(DeleteNotificationSubscriptionRequest request, CallOptions options)

Parameters

Type	Name	Description
DeleteNotificationSubscriptionRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<Empty>	The call object.

DeleteNotificationSubscriptionAsync(DeleteNotificationSubscriptionRequest, Metadata, DateTime?, CancellationToken)

Deletes a notification subscription for a merchant.

Declaration

public virtual AsyncUnaryCall<Empty> DeleteNotificationSubscriptionAsync(DeleteNotificationSubscriptionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
DeleteNotificationSubscriptionRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<Empty>	The call object.

GetNotificationSubscription(GetNotificationSubscriptionRequest, CallOptions)

Gets notification subscriptions for an account.

Declaration

public virtual NotificationSubscription GetNotificationSubscription(GetNotificationSubscriptionRequest request, CallOptions options)

Parameters

Type	Name	Description
GetNotificationSubscriptionRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
NotificationSubscription	The response received from the server.

GetNotificationSubscription(GetNotificationSubscriptionRequest, Metadata, DateTime?, CancellationToken)

Gets notification subscriptions for an account.

Declaration

public virtual NotificationSubscription GetNotificationSubscription(GetNotificationSubscriptionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
GetNotificationSubscriptionRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
NotificationSubscription	The response received from the server.

GetNotificationSubscriptionAsync(GetNotificationSubscriptionRequest, CallOptions)

Gets notification subscriptions for an account.

Declaration

public virtual AsyncUnaryCall<NotificationSubscription> GetNotificationSubscriptionAsync(GetNotificationSubscriptionRequest request, CallOptions options)

Parameters

Type	Name	Description
GetNotificationSubscriptionRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<NotificationSubscription>	The call object.

GetNotificationSubscriptionAsync(GetNotificationSubscriptionRequest, Metadata, DateTime?, CancellationToken)

Gets notification subscriptions for an account.

Declaration

public virtual AsyncUnaryCall<NotificationSubscription> GetNotificationSubscriptionAsync(GetNotificationSubscriptionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
GetNotificationSubscriptionRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<NotificationSubscription>	The call object.

GetNotificationSubscriptionHealthMetrics(GetNotificationSubscriptionHealthMetricsRequest, CallOptions)

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 NotificationSubscriptionHealthMetrics GetNotificationSubscriptionHealthMetrics(GetNotificationSubscriptionHealthMetricsRequest request, CallOptions options)

Parameters

Type	Name	Description
GetNotificationSubscriptionHealthMetricsRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
NotificationSubscriptionHealthMetrics	The response received from the server.

GetNotificationSubscriptionHealthMetrics(GetNotificationSubscriptionHealthMetricsRequest, Metadata, DateTime?, CancellationToken)

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 NotificationSubscriptionHealthMetrics GetNotificationSubscriptionHealthMetrics(GetNotificationSubscriptionHealthMetricsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
GetNotificationSubscriptionHealthMetricsRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
NotificationSubscriptionHealthMetrics	The response received from the server.

GetNotificationSubscriptionHealthMetricsAsync(GetNotificationSubscriptionHealthMetricsRequest, CallOptions)

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 AsyncUnaryCall<NotificationSubscriptionHealthMetrics> GetNotificationSubscriptionHealthMetricsAsync(GetNotificationSubscriptionHealthMetricsRequest request, CallOptions options)

Parameters

Type	Name	Description
GetNotificationSubscriptionHealthMetricsRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<NotificationSubscriptionHealthMetrics>	The call object.

GetNotificationSubscriptionHealthMetricsAsync(GetNotificationSubscriptionHealthMetricsRequest, Metadata, DateTime?, CancellationToken)

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 AsyncUnaryCall<NotificationSubscriptionHealthMetrics> GetNotificationSubscriptionHealthMetricsAsync(GetNotificationSubscriptionHealthMetricsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
GetNotificationSubscriptionHealthMetricsRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<NotificationSubscriptionHealthMetrics>	The call object.

ListNotificationSubscriptions(ListNotificationSubscriptionsRequest, CallOptions)

Gets all the notification subscriptions for a merchant.

Declaration

public virtual ListNotificationSubscriptionsResponse ListNotificationSubscriptions(ListNotificationSubscriptionsRequest request, CallOptions options)

Parameters

Type	Name	Description
ListNotificationSubscriptionsRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
ListNotificationSubscriptionsResponse	The response received from the server.

ListNotificationSubscriptions(ListNotificationSubscriptionsRequest, Metadata, DateTime?, CancellationToken)

Gets all the notification subscriptions for a merchant.

Declaration

public virtual ListNotificationSubscriptionsResponse ListNotificationSubscriptions(ListNotificationSubscriptionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListNotificationSubscriptionsRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
ListNotificationSubscriptionsResponse	The response received from the server.

ListNotificationSubscriptionsAsync(ListNotificationSubscriptionsRequest, CallOptions)

Gets all the notification subscriptions for a merchant.

Declaration

public virtual AsyncUnaryCall<ListNotificationSubscriptionsResponse> ListNotificationSubscriptionsAsync(ListNotificationSubscriptionsRequest request, CallOptions options)

Parameters

Type	Name	Description
ListNotificationSubscriptionsRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<ListNotificationSubscriptionsResponse>	The call object.

ListNotificationSubscriptionsAsync(ListNotificationSubscriptionsRequest, Metadata, DateTime?, CancellationToken)

Gets all the notification subscriptions for a merchant.

Declaration

public virtual AsyncUnaryCall<ListNotificationSubscriptionsResponse> ListNotificationSubscriptionsAsync(ListNotificationSubscriptionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListNotificationSubscriptionsRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<ListNotificationSubscriptionsResponse>	The call object.

NewInstance(ClientBaseConfiguration)

Creates a new instance of client from given ClientBaseConfiguration.

Declaration

protected override NotificationsApiService.NotificationsApiServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Parameters

Type	Name	Description
ClientBase.ClientBaseConfiguration	configuration

Returns

Type	Description
NotificationsApiService.NotificationsApiServiceClient

Overrides

Grpc.Core.ClientBase<Google.Shopping.Merchant.Notifications.V1.NotificationsApiService.NotificationsApiServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UpdateNotificationSubscription(UpdateNotificationSubscriptionRequest, CallOptions)

Updates an existing notification subscription for a merchant.

Declaration

public virtual NotificationSubscription UpdateNotificationSubscription(UpdateNotificationSubscriptionRequest request, CallOptions options)

Parameters

Type	Name	Description
UpdateNotificationSubscriptionRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
NotificationSubscription	The response received from the server.

UpdateNotificationSubscription(UpdateNotificationSubscriptionRequest, Metadata, DateTime?, CancellationToken)

Updates an existing notification subscription for a merchant.

Declaration

public virtual NotificationSubscription UpdateNotificationSubscription(UpdateNotificationSubscriptionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
UpdateNotificationSubscriptionRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
NotificationSubscription	The response received from the server.

UpdateNotificationSubscriptionAsync(UpdateNotificationSubscriptionRequest, CallOptions)

Updates an existing notification subscription for a merchant.

Declaration

public virtual AsyncUnaryCall<NotificationSubscription> UpdateNotificationSubscriptionAsync(UpdateNotificationSubscriptionRequest request, CallOptions options)

Parameters

Type	Name	Description
UpdateNotificationSubscriptionRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<NotificationSubscription>	The call object.

UpdateNotificationSubscriptionAsync(UpdateNotificationSubscriptionRequest, Metadata, DateTime?, CancellationToken)

Updates an existing notification subscription for a merchant.

Declaration

public virtual AsyncUnaryCall<NotificationSubscription> UpdateNotificationSubscriptionAsync(UpdateNotificationSubscriptionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
UpdateNotificationSubscriptionRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<NotificationSubscription>	The call object.