Class NotificationsApiServiceClientImpl

NotificationsApiService client wrapper implementation, for convenient use.

Inheritance

object

NotificationsApiServiceClient

NotificationsApiServiceClientImpl

Inherited Members

NotificationsApiServiceClient.DefaultEndpoint

NotificationsApiServiceClient.DefaultScopes

NotificationsApiServiceClient.ServiceMetadata

NotificationsApiServiceClient.CreateAsync(CancellationToken)

NotificationsApiServiceClient.Create()

NotificationsApiServiceClient.ShutdownDefaultChannelsAsync()

NotificationsApiServiceClient.GetNotificationSubscriptionAsync(GetNotificationSubscriptionRequest, CancellationToken)

NotificationsApiServiceClient.GetNotificationSubscription(string, CallSettings)

NotificationsApiServiceClient.GetNotificationSubscriptionAsync(string, CallSettings)

NotificationsApiServiceClient.GetNotificationSubscriptionAsync(string, CancellationToken)

NotificationsApiServiceClient.GetNotificationSubscription(NotificationSubscriptionName, CallSettings)

NotificationsApiServiceClient.GetNotificationSubscriptionAsync(NotificationSubscriptionName, CallSettings)

NotificationsApiServiceClient.GetNotificationSubscriptionAsync(NotificationSubscriptionName, CancellationToken)

NotificationsApiServiceClient.CreateNotificationSubscriptionAsync(CreateNotificationSubscriptionRequest, CancellationToken)

NotificationsApiServiceClient.CreateNotificationSubscription(string, NotificationSubscription, CallSettings)

NotificationsApiServiceClient.CreateNotificationSubscriptionAsync(string, NotificationSubscription, CallSettings)

NotificationsApiServiceClient.CreateNotificationSubscriptionAsync(string, NotificationSubscription, CancellationToken)

NotificationsApiServiceClient.CreateNotificationSubscription(AccountName, NotificationSubscription, CallSettings)

NotificationsApiServiceClient.CreateNotificationSubscriptionAsync(AccountName, NotificationSubscription, CallSettings)

NotificationsApiServiceClient.CreateNotificationSubscriptionAsync(AccountName, NotificationSubscription, CancellationToken)

NotificationsApiServiceClient.UpdateNotificationSubscriptionAsync(UpdateNotificationSubscriptionRequest, CancellationToken)

NotificationsApiServiceClient.UpdateNotificationSubscription(NotificationSubscription, FieldMask, CallSettings)

NotificationsApiServiceClient.UpdateNotificationSubscriptionAsync(NotificationSubscription, FieldMask, CallSettings)

NotificationsApiServiceClient.UpdateNotificationSubscriptionAsync(NotificationSubscription, FieldMask, CancellationToken)

NotificationsApiServiceClient.DeleteNotificationSubscriptionAsync(DeleteNotificationSubscriptionRequest, CancellationToken)

NotificationsApiServiceClient.DeleteNotificationSubscription(string, CallSettings)

NotificationsApiServiceClient.DeleteNotificationSubscriptionAsync(string, CallSettings)

NotificationsApiServiceClient.DeleteNotificationSubscriptionAsync(string, CancellationToken)

NotificationsApiServiceClient.DeleteNotificationSubscription(NotificationSubscriptionName, CallSettings)

NotificationsApiServiceClient.DeleteNotificationSubscriptionAsync(NotificationSubscriptionName, CallSettings)

NotificationsApiServiceClient.DeleteNotificationSubscriptionAsync(NotificationSubscriptionName, CancellationToken)

NotificationsApiServiceClient.ListNotificationSubscriptions(string, string, int?, CallSettings)

NotificationsApiServiceClient.ListNotificationSubscriptionsAsync(string, string, int?, CallSettings)

NotificationsApiServiceClient.ListNotificationSubscriptions(AccountName, string, int?, CallSettings)

NotificationsApiServiceClient.ListNotificationSubscriptionsAsync(AccountName, string, int?, CallSettings)

NotificationsApiServiceClient.GetNotificationSubscriptionHealthMetricsAsync(GetNotificationSubscriptionHealthMetricsRequest, CancellationToken)

NotificationsApiServiceClient.GetNotificationSubscriptionHealthMetrics(string, CallSettings)

NotificationsApiServiceClient.GetNotificationSubscriptionHealthMetricsAsync(string, CallSettings)

NotificationsApiServiceClient.GetNotificationSubscriptionHealthMetricsAsync(string, CancellationToken)

NotificationsApiServiceClient.GetNotificationSubscriptionHealthMetrics(NotificationSubscriptionHealthMetricsName, CallSettings)

NotificationsApiServiceClient.GetNotificationSubscriptionHealthMetricsAsync(NotificationSubscriptionHealthMetricsName, CallSettings)

NotificationsApiServiceClient.GetNotificationSubscriptionHealthMetricsAsync(NotificationSubscriptionHealthMetricsName, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace: Google.Shopping.Merchant.Notifications.V1

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

Syntax

public sealed class NotificationsApiServiceClientImpl : NotificationsApiServiceClient

Remarks

Service to manage notification subscriptions for merchants

Constructors

NotificationsApiServiceClientImpl(NotificationsApiServiceClient, NotificationsApiServiceSettings, ILogger)

Constructs a client wrapper for the NotificationsApiService service, with the specified gRPC client and settings.

Declaration

public NotificationsApiServiceClientImpl(NotificationsApiService.NotificationsApiServiceClient grpcClient, NotificationsApiServiceSettings settings, ILogger logger)

Parameters

Type	Name	Description
NotificationsApiService.NotificationsApiServiceClient	grpcClient	The underlying gRPC client.
NotificationsApiServiceSettings	settings	The base NotificationsApiServiceSettings used within this client.
ILogger	logger	Optional ILogger to use within this client.

Properties

GrpcClient

The underlying gRPC NotificationsApiService client

Declaration

public override NotificationsApiService.NotificationsApiServiceClient GrpcClient { get; }

Property Value

Type	Description
NotificationsApiService.NotificationsApiServiceClient

Overrides

NotificationsApiServiceClient.GrpcClient

Methods

CreateNotificationSubscription(CreateNotificationSubscriptionRequest, CallSettings)

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 override NotificationSubscription CreateNotificationSubscription(CreateNotificationSubscriptionRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
CreateNotificationSubscriptionRequest	request	The request object containing all of the parameters for the API call.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
NotificationSubscription	The RPC response.

Overrides

NotificationsApiServiceClient.CreateNotificationSubscription(CreateNotificationSubscriptionRequest, CallSettings)

CreateNotificationSubscriptionAsync(CreateNotificationSubscriptionRequest, CallSettings)

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 override Task<NotificationSubscription> CreateNotificationSubscriptionAsync(CreateNotificationSubscriptionRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
CreateNotificationSubscriptionRequest	request	The request object containing all of the parameters for the API call.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
Task<NotificationSubscription>	A Task containing the RPC response.

Overrides

NotificationsApiServiceClient.CreateNotificationSubscriptionAsync(CreateNotificationSubscriptionRequest, CallSettings)

DeleteNotificationSubscription(DeleteNotificationSubscriptionRequest, CallSettings)

Deletes a notification subscription for a merchant.

Declaration

public override void DeleteNotificationSubscription(DeleteNotificationSubscriptionRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
DeleteNotificationSubscriptionRequest	request	The request object containing all of the parameters for the API call.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Overrides

NotificationsApiServiceClient.DeleteNotificationSubscription(DeleteNotificationSubscriptionRequest, CallSettings)

DeleteNotificationSubscriptionAsync(DeleteNotificationSubscriptionRequest, CallSettings)

Deletes a notification subscription for a merchant.

Declaration

public override Task DeleteNotificationSubscriptionAsync(DeleteNotificationSubscriptionRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
DeleteNotificationSubscriptionRequest	request	The request object containing all of the parameters for the API call.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
Task	A Task containing the RPC response.

Overrides

NotificationsApiServiceClient.DeleteNotificationSubscriptionAsync(DeleteNotificationSubscriptionRequest, CallSettings)

GetNotificationSubscription(GetNotificationSubscriptionRequest, CallSettings)

Gets notification subscriptions for an account.

Declaration

public override NotificationSubscription GetNotificationSubscription(GetNotificationSubscriptionRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
GetNotificationSubscriptionRequest	request	The request object containing all of the parameters for the API call.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
NotificationSubscription	The RPC response.

Overrides

NotificationsApiServiceClient.GetNotificationSubscription(GetNotificationSubscriptionRequest, CallSettings)

GetNotificationSubscriptionAsync(GetNotificationSubscriptionRequest, CallSettings)

Gets notification subscriptions for an account.

Declaration

public override Task<NotificationSubscription> GetNotificationSubscriptionAsync(GetNotificationSubscriptionRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
GetNotificationSubscriptionRequest	request	The request object containing all of the parameters for the API call.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
Task<NotificationSubscription>	A Task containing the RPC response.

Overrides

NotificationsApiServiceClient.GetNotificationSubscriptionAsync(GetNotificationSubscriptionRequest, CallSettings)

GetNotificationSubscriptionHealthMetrics(GetNotificationSubscriptionHealthMetricsRequest, CallSettings)

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 override NotificationSubscriptionHealthMetrics GetNotificationSubscriptionHealthMetrics(GetNotificationSubscriptionHealthMetricsRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
GetNotificationSubscriptionHealthMetricsRequest	request	The request object containing all of the parameters for the API call.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
NotificationSubscriptionHealthMetrics	The RPC response.

Overrides

NotificationsApiServiceClient.GetNotificationSubscriptionHealthMetrics(GetNotificationSubscriptionHealthMetricsRequest, CallSettings)

GetNotificationSubscriptionHealthMetricsAsync(GetNotificationSubscriptionHealthMetricsRequest, CallSettings)

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 override Task<NotificationSubscriptionHealthMetrics> GetNotificationSubscriptionHealthMetricsAsync(GetNotificationSubscriptionHealthMetricsRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
GetNotificationSubscriptionHealthMetricsRequest	request	The request object containing all of the parameters for the API call.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
Task<NotificationSubscriptionHealthMetrics>	A Task containing the RPC response.

Overrides

NotificationsApiServiceClient.GetNotificationSubscriptionHealthMetricsAsync(GetNotificationSubscriptionHealthMetricsRequest, CallSettings)

ListNotificationSubscriptions(ListNotificationSubscriptionsRequest, CallSettings)

Gets all the notification subscriptions for a merchant.

Declaration

public override PagedEnumerable<ListNotificationSubscriptionsResponse, NotificationSubscription> ListNotificationSubscriptions(ListNotificationSubscriptionsRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
ListNotificationSubscriptionsRequest	request	The request object containing all of the parameters for the API call.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
PagedEnumerable<ListNotificationSubscriptionsResponse, NotificationSubscription>	A pageable sequence of NotificationSubscription resources.

Overrides

NotificationsApiServiceClient.ListNotificationSubscriptions(ListNotificationSubscriptionsRequest, CallSettings)

ListNotificationSubscriptionsAsync(ListNotificationSubscriptionsRequest, CallSettings)

Gets all the notification subscriptions for a merchant.

Declaration

public override PagedAsyncEnumerable<ListNotificationSubscriptionsResponse, NotificationSubscription> ListNotificationSubscriptionsAsync(ListNotificationSubscriptionsRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
ListNotificationSubscriptionsRequest	request	The request object containing all of the parameters for the API call.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
PagedAsyncEnumerable<ListNotificationSubscriptionsResponse, NotificationSubscription>	A pageable asynchronous sequence of NotificationSubscription resources.

Overrides

NotificationsApiServiceClient.ListNotificationSubscriptionsAsync(ListNotificationSubscriptionsRequest, CallSettings)

UpdateNotificationSubscription(UpdateNotificationSubscriptionRequest, CallSettings)

Updates an existing notification subscription for a merchant.

Declaration

public override NotificationSubscription UpdateNotificationSubscription(UpdateNotificationSubscriptionRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
UpdateNotificationSubscriptionRequest	request	The request object containing all of the parameters for the API call.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
NotificationSubscription	The RPC response.

Overrides

NotificationsApiServiceClient.UpdateNotificationSubscription(UpdateNotificationSubscriptionRequest, CallSettings)

UpdateNotificationSubscriptionAsync(UpdateNotificationSubscriptionRequest, CallSettings)

Updates an existing notification subscription for a merchant.

Declaration

public override Task<NotificationSubscription> UpdateNotificationSubscriptionAsync(UpdateNotificationSubscriptionRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
UpdateNotificationSubscriptionRequest	request	The request object containing all of the parameters for the API call.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
Task<NotificationSubscription>	A Task containing the RPC response.

Overrides

NotificationsApiServiceClient.UpdateNotificationSubscriptionAsync(UpdateNotificationSubscriptionRequest, CallSettings)