Package cloud.google.com/go/shopping/merchant/notifications/apiv1/notificationspb (v1.1.0)

var (
	NotificationSubscription_NotificationEventType_name = map[int32]string{
		0: "NOTIFICATION_EVENT_TYPE_UNSPECIFIED",
		1: "PRODUCT_STATUS_CHANGE",
	}
	NotificationSubscription_NotificationEventType_value = map[string]int32{
		"NOTIFICATION_EVENT_TYPE_UNSPECIFIED": 0,
		"PRODUCT_STATUS_CHANGE":               1,
	}
)

var File_google_shopping_merchant_notifications_v1_notificationsapi_proto protoreflect.FileDescriptor

func RegisterNotificationsApiServiceServer(s *grpc.Server, srv NotificationsApiServiceServer)

type CreateNotificationSubscriptionRequest struct {

	// Required. The merchant account that owns the new notification subscription.
	// Format: `accounts/{account}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The notification subscription to create.
	NotificationSubscription *NotificationSubscription `protobuf:"bytes,2,opt,name=notification_subscription,json=notificationSubscription,proto3" json:"notification_subscription,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateNotificationSubscriptionRequest) Descriptor() ([]byte, []int)

func (x *CreateNotificationSubscriptionRequest) GetNotificationSubscription() *NotificationSubscription

func (x *CreateNotificationSubscriptionRequest) GetParent() string

func (*CreateNotificationSubscriptionRequest) ProtoMessage()

func (x *CreateNotificationSubscriptionRequest) ProtoReflect() protoreflect.Message

func (x *CreateNotificationSubscriptionRequest) Reset()

func (x *CreateNotificationSubscriptionRequest) String() string

type DeleteNotificationSubscriptionRequest struct {

	// Required. The name of the notification subscription to be deleted.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteNotificationSubscriptionRequest) Descriptor() ([]byte, []int)

func (x *DeleteNotificationSubscriptionRequest) GetName() string

func (*DeleteNotificationSubscriptionRequest) ProtoMessage()

func (x *DeleteNotificationSubscriptionRequest) ProtoReflect() protoreflect.Message

func (x *DeleteNotificationSubscriptionRequest) Reset()

func (x *DeleteNotificationSubscriptionRequest) String() string

type GetNotificationSubscriptionHealthMetricsRequest struct {

	// Required. The `name` of the notification subscription for which metrics are
	// retrieved.
	// Format:
	// `accounts/{account}/notificationsubscriptions/{notification_subscription}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

func (*GetNotificationSubscriptionHealthMetricsRequest) Descriptor() ([]byte, []int)

func (x *GetNotificationSubscriptionHealthMetricsRequest) GetName() string

func (*GetNotificationSubscriptionHealthMetricsRequest) ProtoMessage()

func (x *GetNotificationSubscriptionHealthMetricsRequest) ProtoReflect() protoreflect.Message

func (x *GetNotificationSubscriptionHealthMetricsRequest) Reset()

func (x *GetNotificationSubscriptionHealthMetricsRequest) String() string

type GetNotificationSubscriptionRequest struct {

	// Required. The `name` of the notification subscription.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

func (*GetNotificationSubscriptionRequest) Descriptor() ([]byte, []int)

func (x *GetNotificationSubscriptionRequest) GetName() string

func (*GetNotificationSubscriptionRequest) ProtoMessage()

func (x *GetNotificationSubscriptionRequest) ProtoReflect() protoreflect.Message

func (x *GetNotificationSubscriptionRequest) Reset()

func (x *GetNotificationSubscriptionRequest) String() string

type ListNotificationSubscriptionsRequest struct {

	// Required. The merchant account who owns the notification subscriptions.
	// Format: `accounts/{account}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The maximum number of notification subscriptions to return in a page.
	// The default value for `page_size` is 100. The
	// maximum value is `200`. Values above `200` will be coerced to `200`.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Token (if provided) to retrieve the subsequent page. All other parameters
	// must match the original call that provided the page token.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

func (*ListNotificationSubscriptionsRequest) Descriptor() ([]byte, []int)

func (x *ListNotificationSubscriptionsRequest) GetPageSize() int32

func (x *ListNotificationSubscriptionsRequest) GetPageToken() string

func (x *ListNotificationSubscriptionsRequest) GetParent() string

func (*ListNotificationSubscriptionsRequest) ProtoMessage()

func (x *ListNotificationSubscriptionsRequest) ProtoReflect() protoreflect.Message

func (x *ListNotificationSubscriptionsRequest) Reset()

func (x *ListNotificationSubscriptionsRequest) String() string

type ListNotificationSubscriptionsResponse struct {

	// The list of notification subscriptions requested by the merchant.
	NotificationSubscriptions []*NotificationSubscription `protobuf:"bytes,1,rep,name=notification_subscriptions,json=notificationSubscriptions,proto3" json:"notification_subscriptions,omitempty"`
	// A token, which can be sent as `page_token` to retrieve the next page.
	// If this field is omitted, there are no subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

func (*ListNotificationSubscriptionsResponse) Descriptor() ([]byte, []int)

func (x *ListNotificationSubscriptionsResponse) GetNextPageToken() string

func (x *ListNotificationSubscriptionsResponse) GetNotificationSubscriptions() []*NotificationSubscription

func (*ListNotificationSubscriptionsResponse) ProtoMessage()

func (x *ListNotificationSubscriptionsResponse) ProtoReflect() protoreflect.Message

func (x *ListNotificationSubscriptionsResponse) Reset()

func (x *ListNotificationSubscriptionsResponse) String() string

type NotificationSubscription struct {

	// Types that are assignable to InterestedIn:
	//
	//	*NotificationSubscription_AllManagedAccounts
	//	*NotificationSubscription_TargetAccount
	InterestedIn isNotificationSubscription_InterestedIn `protobuf_oneof:"interested_in"`
	// 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/{notification_subscription}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The event that the merchant wants to be notified about.
	RegisteredEvent NotificationSubscription_NotificationEventType `protobuf:"varint,2,opt,name=registered_event,json=registeredEvent,proto3,enum=google.shopping.merchant.notifications.v1.NotificationSubscription_NotificationEventType" json:"registered_event,omitempty"`
	// URL to be used to push the notification to the merchant.
	CallBackUri string `protobuf:"bytes,5,opt,name=call_back_uri,json=callBackUri,proto3" json:"call_back_uri,omitempty"`
	// contains filtered or unexported fields
}

func (*NotificationSubscription) Descriptor() ([]byte, []int)

func (x *NotificationSubscription) GetAllManagedAccounts() bool

func (x *NotificationSubscription) GetCallBackUri() string

func (m *NotificationSubscription) GetInterestedIn() isNotificationSubscription_InterestedIn

func (x *NotificationSubscription) GetName() string

func (x *NotificationSubscription) GetRegisteredEvent() NotificationSubscription_NotificationEventType

func (x *NotificationSubscription) GetTargetAccount() string

func (*NotificationSubscription) ProtoMessage()

func (x *NotificationSubscription) ProtoReflect() protoreflect.Message

func (x *NotificationSubscription) Reset()

func (x *NotificationSubscription) String() string

type NotificationSubscriptionHealthMetrics struct {

	// Output only. Identifier. 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.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The number of retained acknowledged messages for the last 24 hours
	AcknowledgedMessagesCount int64 `protobuf:"varint,2,opt,name=acknowledged_messages_count,json=acknowledgedMessagesCount,proto3" json:"acknowledged_messages_count,omitempty"`
	// The number of unacknowledged messages for the last 7 days, we will attempt
	// to re-deliver the unacknowledged message later and once successfully
	// delivered it will not be counted within unacknowledged messages (the number
	// of unacknowledged messages should gradually decrease to zero once the issue
	// is fixed).
	UndeliveredMessagesCount int64 `protobuf:"varint,3,opt,name=undelivered_messages_count,json=undeliveredMessagesCount,proto3" json:"undelivered_messages_count,omitempty"`
	// The time since the oldest unacknowledged message was sent in seconds
	OldestUnacknowledgedMessageWaitingTime int64 `protobuf:"varint,4,opt,name=oldest_unacknowledged_message_waiting_time,json=oldestUnacknowledgedMessageWaitingTime,proto3" json:"oldest_unacknowledged_message_waiting_time,omitempty"`
	// contains filtered or unexported fields
}

func (*NotificationSubscriptionHealthMetrics) Descriptor() ([]byte, []int)

func (x *NotificationSubscriptionHealthMetrics) GetAcknowledgedMessagesCount() int64

func (x *NotificationSubscriptionHealthMetrics) GetName() string

func (x *NotificationSubscriptionHealthMetrics) GetOldestUnacknowledgedMessageWaitingTime() int64

func (x *NotificationSubscriptionHealthMetrics) GetUndeliveredMessagesCount() int64

func (*NotificationSubscriptionHealthMetrics) ProtoMessage()

func (x *NotificationSubscriptionHealthMetrics) ProtoReflect() protoreflect.Message

func (x *NotificationSubscriptionHealthMetrics) Reset()

func (x *NotificationSubscriptionHealthMetrics) String() string

type NotificationSubscription_AllManagedAccounts struct {
	// 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.
	AllManagedAccounts bool `protobuf:"varint,3,opt,name=all_managed_accounts,json=allManagedAccounts,proto3,oneof"`
}

type NotificationSubscription_NotificationEventType int32

const (
	// Notifications event type is unspecified.
	NotificationSubscription_NOTIFICATION_EVENT_TYPE_UNSPECIFIED NotificationSubscription_NotificationEventType = 0
	// Notification of product status changes, for example when product becomes
	// disapproved.
	NotificationSubscription_PRODUCT_STATUS_CHANGE NotificationSubscription_NotificationEventType = 1
)

func (NotificationSubscription_NotificationEventType) Descriptor() protoreflect.EnumDescriptor

func (x NotificationSubscription_NotificationEventType) Enum() *NotificationSubscription_NotificationEventType

func (NotificationSubscription_NotificationEventType) EnumDescriptor() ([]byte, []int)

func (x NotificationSubscription_NotificationEventType) Number() protoreflect.EnumNumber

func (x NotificationSubscription_NotificationEventType) String() string

func (NotificationSubscription_NotificationEventType) Type() protoreflect.EnumType

type NotificationSubscription_TargetAccount struct {
	// The `name` of the account you want to receive notifications for.
	// Format: `accounts/{account}`
	TargetAccount string `protobuf:"bytes,4,opt,name=target_account,json=targetAccount,proto3,oneof"`
}

type NotificationsApiServiceClient interface {
	// Gets notification subscriptions for an account.
	GetNotificationSubscription(ctx context.Context, in *GetNotificationSubscriptionRequest, opts ...grpc.CallOption) (*NotificationSubscription, error)
	// 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.
	CreateNotificationSubscription(ctx context.Context, in *CreateNotificationSubscriptionRequest, opts ...grpc.CallOption) (*NotificationSubscription, error)
	// Updates an existing notification subscription for a merchant.
	UpdateNotificationSubscription(ctx context.Context, in *UpdateNotificationSubscriptionRequest, opts ...grpc.CallOption) (*NotificationSubscription, error)
	// Deletes a notification subscription for a merchant.
	DeleteNotificationSubscription(ctx context.Context, in *DeleteNotificationSubscriptionRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Gets all the notification subscriptions for a merchant.
	ListNotificationSubscriptions(ctx context.Context, in *ListNotificationSubscriptionsRequest, opts ...grpc.CallOption) (*ListNotificationSubscriptionsResponse, error)
	// Retrieves notification subscription health metrics for a merchant.
	// We recommend calling this periodically (hourly or daily) to monitor health
	// of your callback endpoint.
	GetNotificationSubscriptionHealthMetrics(ctx context.Context, in *GetNotificationSubscriptionHealthMetricsRequest, opts ...grpc.CallOption) (*NotificationSubscriptionHealthMetrics, error)
}

func NewNotificationsApiServiceClient(cc grpc.ClientConnInterface) NotificationsApiServiceClient

type NotificationsApiServiceServer interface {
	// Gets notification subscriptions for an account.
	GetNotificationSubscription(context.Context, *GetNotificationSubscriptionRequest) (*NotificationSubscription, error)
	// 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.
	CreateNotificationSubscription(context.Context, *CreateNotificationSubscriptionRequest) (*NotificationSubscription, error)
	// Updates an existing notification subscription for a merchant.
	UpdateNotificationSubscription(context.Context, *UpdateNotificationSubscriptionRequest) (*NotificationSubscription, error)
	// Deletes a notification subscription for a merchant.
	DeleteNotificationSubscription(context.Context, *DeleteNotificationSubscriptionRequest) (*emptypb.Empty, error)
	// Gets all the notification subscriptions for a merchant.
	ListNotificationSubscriptions(context.Context, *ListNotificationSubscriptionsRequest) (*ListNotificationSubscriptionsResponse, error)
	// Retrieves notification subscription health metrics for a merchant.
	// We recommend calling this periodically (hourly or daily) to monitor health
	// of your callback endpoint.
	GetNotificationSubscriptionHealthMetrics(context.Context, *GetNotificationSubscriptionHealthMetricsRequest) (*NotificationSubscriptionHealthMetrics, error)
}

type UnimplementedNotificationsApiServiceServer struct {
}

func (*UnimplementedNotificationsApiServiceServer) CreateNotificationSubscription(context.Context, *CreateNotificationSubscriptionRequest) (*NotificationSubscription, error)

func (*UnimplementedNotificationsApiServiceServer) DeleteNotificationSubscription(context.Context, *DeleteNotificationSubscriptionRequest) (*emptypb.Empty, error)

func (*UnimplementedNotificationsApiServiceServer) GetNotificationSubscription(context.Context, *GetNotificationSubscriptionRequest) (*NotificationSubscription, error)

func (*UnimplementedNotificationsApiServiceServer) GetNotificationSubscriptionHealthMetrics(context.Context, *GetNotificationSubscriptionHealthMetricsRequest) (*NotificationSubscriptionHealthMetrics, error)

func (*UnimplementedNotificationsApiServiceServer) ListNotificationSubscriptions(context.Context, *ListNotificationSubscriptionsRequest) (*ListNotificationSubscriptionsResponse, error)

func (*UnimplementedNotificationsApiServiceServer) UpdateNotificationSubscription(context.Context, *UpdateNotificationSubscriptionRequest) (*NotificationSubscription, error)

type UpdateNotificationSubscriptionRequest struct {

	// Required. The new version of the notification subscription that should be
	// updated.
	NotificationSubscription *NotificationSubscription `protobuf:"bytes,1,opt,name=notification_subscription,json=notificationSubscription,proto3" json:"notification_subscription,omitempty"`
	// List of fields being updated.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

func (*UpdateNotificationSubscriptionRequest) Descriptor() ([]byte, []int)

func (x *UpdateNotificationSubscriptionRequest) GetNotificationSubscription() *NotificationSubscription

func (x *UpdateNotificationSubscriptionRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateNotificationSubscriptionRequest) ProtoMessage()

func (x *UpdateNotificationSubscriptionRequest) ProtoReflect() protoreflect.Message

func (x *UpdateNotificationSubscriptionRequest) Reset()

func (x *UpdateNotificationSubscriptionRequest) String() string