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

const (
	NotificationsApiService_GetNotificationSubscription_FullMethodName    = "/google.shopping.merchant.notifications.v1beta.NotificationsApiService/GetNotificationSubscription"
	NotificationsApiService_CreateNotificationSubscription_FullMethodName = "/google.shopping.merchant.notifications.v1beta.NotificationsApiService/CreateNotificationSubscription"
	NotificationsApiService_UpdateNotificationSubscription_FullMethodName = "/google.shopping.merchant.notifications.v1beta.NotificationsApiService/UpdateNotificationSubscription"
	NotificationsApiService_DeleteNotificationSubscription_FullMethodName = "/google.shopping.merchant.notifications.v1beta.NotificationsApiService/DeleteNotificationSubscription"
	NotificationsApiService_ListNotificationSubscriptions_FullMethodName  = "/google.shopping.merchant.notifications.v1beta.NotificationsApiService/ListNotificationSubscriptions"
)

var (
	Resource_name = map[int32]string{
		0: "RESOURCE_UNSPECIFIED",
		1: "PRODUCT",
	}
	Resource_value = map[string]int32{
		"RESOURCE_UNSPECIFIED": 0,
		"PRODUCT":              1,
	}
)

var (
	Attribute_name = map[int32]string{
		0: "ATTRIBUTE_UNSPECIFIED",
		1: "STATUS",
	}
	Attribute_value = map[string]int32{
		"ATTRIBUTE_UNSPECIFIED": 0,
		"STATUS":                1,
	}
)

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_v1beta_notificationsapi_proto protoreflect.FileDescriptor

var NotificationsApiService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.shopping.merchant.notifications.v1beta.NotificationsApiService",
	HandlerType: (*NotificationsApiServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetNotificationSubscription",
			Handler:    _NotificationsApiService_GetNotificationSubscription_Handler,
		},
		{
			MethodName: "CreateNotificationSubscription",
			Handler:    _NotificationsApiService_CreateNotificationSubscription_Handler,
		},
		{
			MethodName: "UpdateNotificationSubscription",
			Handler:    _NotificationsApiService_UpdateNotificationSubscription_Handler,
		},
		{
			MethodName: "DeleteNotificationSubscription",
			Handler:    _NotificationsApiService_DeleteNotificationSubscription_Handler,
		},
		{
			MethodName: "ListNotificationSubscriptions",
			Handler:    _NotificationsApiService_ListNotificationSubscriptions_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/shopping/merchant/notifications/v1beta/notificationsapi.proto",
}

func RegisterNotificationsApiServiceServer(s grpc.ServiceRegistrar, srv NotificationsApiServiceServer)

type Attribute int32

const (
	// Unspecified attribute
	Attribute_ATTRIBUTE_UNSPECIFIED Attribute = 0
	// Status of the changed entity
	Attribute_STATUS Attribute = 1
)

func (Attribute) Descriptor() protoreflect.EnumDescriptor

func (x Attribute) Enum() *Attribute

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

func (x Attribute) Number() protoreflect.EnumNumber

func (x Attribute) String() string

func (Attribute) Type() protoreflect.EnumType

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 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.v1beta.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 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 merchant. We will allow the
	// following types of notification subscriptions to exist together (per
	// merchant 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 merchant as a subscriber per event type):
	// 1. multiple self subscriptions.
	// 2. multiple "all managed accounts" subscriptions.
	// 3. all 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)
}

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 merchant. We will allow the
	// following types of notification subscriptions to exist together (per
	// merchant 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 merchant as a subscriber per event type):
	// 1. multiple self subscriptions.
	// 2. multiple "all managed accounts" subscriptions.
	// 3. all 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)
}

type ProductChange struct {

	// The old value of the changed resource or attribute.
	OldValue *string `protobuf:"bytes,1,opt,name=old_value,json=oldValue,proto3,oneof" json:"old_value,omitempty"`
	// The new value of the changed resource or attribute.
	NewValue *string `protobuf:"bytes,2,opt,name=new_value,json=newValue,proto3,oneof" json:"new_value,omitempty"`
	// Countries that have the change (if applicable)
	RegionCode *string `protobuf:"bytes,3,opt,name=region_code,json=regionCode,proto3,oneof" json:"region_code,omitempty"`
	// Reporting contexts that have the change (if applicable)
	ReportingContext *typepb.ReportingContext_ReportingContextEnum `protobuf:"varint,4,opt,name=reporting_context,json=reportingContext,proto3,enum=google.shopping.type.ReportingContext_ReportingContextEnum,oneof" json:"reporting_context,omitempty"`
	// contains filtered or unexported fields
}

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

func (x *ProductChange) GetNewValue() string

func (x *ProductChange) GetOldValue() string

func (x *ProductChange) GetRegionCode() string

func (x *ProductChange) GetReportingContext() typepb.ReportingContext_ReportingContextEnum

func (*ProductChange) ProtoMessage()

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

func (x *ProductChange) Reset()

func (x *ProductChange) String() string

type ProductStatusChangeMessage struct {

	// The target account that owns the entity that changed.
	// Format : `accounts/{merchant_id}`
	Account *string `protobuf:"bytes,1,opt,name=account,proto3,oneof" json:"account,omitempty"`
	// The account that manages the merchant's account. can be the same as
	// merchant id if it is standalone account. Format :
	// `accounts/{service_provider_id}`
	ManagingAccount *string `protobuf:"bytes,2,opt,name=managing_account,json=managingAccount,proto3,oneof" json:"managing_account,omitempty"`
	// The resource that changed, in this case it will always be `Product`.
	ResourceType *Resource `protobuf:"varint,3,opt,name=resource_type,json=resourceType,proto3,enum=google.shopping.merchant.notifications.v1beta.Resource,oneof" json:"resource_type,omitempty"`
	// The attribute in the resource that changed, in this case it will be always
	// `Status`.
	Attribute *Attribute `protobuf:"varint,4,opt,name=attribute,proto3,enum=google.shopping.merchant.notifications.v1beta.Attribute,oneof" json:"attribute,omitempty"`
	// A message to describe the change that happened to the product
	Changes []*ProductChange `protobuf:"bytes,5,rep,name=changes,proto3" json:"changes,omitempty"`
	// The product id.
	ResourceId *string `protobuf:"bytes,6,opt,name=resource_id,json=resourceId,proto3,oneof" json:"resource_id,omitempty"`
	// The product name.
	// Format: `{product.name=accounts/{account}/products/{product}}`
	Resource *string `protobuf:"bytes,7,opt,name=resource,proto3,oneof" json:"resource,omitempty"`
	// contains filtered or unexported fields
}

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

func (x *ProductStatusChangeMessage) GetAccount() string

func (x *ProductStatusChangeMessage) GetAttribute() Attribute

func (x *ProductStatusChangeMessage) GetChanges() []*ProductChange

func (x *ProductStatusChangeMessage) GetManagingAccount() string

func (x *ProductStatusChangeMessage) GetResource() string

func (x *ProductStatusChangeMessage) GetResourceId() string

func (x *ProductStatusChangeMessage) GetResourceType() Resource

func (*ProductStatusChangeMessage) ProtoMessage()

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

func (x *ProductStatusChangeMessage) Reset()

func (x *ProductStatusChangeMessage) String() string

type Resource int32

const (
	// Unspecified resource
	Resource_RESOURCE_UNSPECIFIED Resource = 0
	// Resource type : product
	Resource_PRODUCT Resource = 1
)

func (Resource) Descriptor() protoreflect.EnumDescriptor

func (x Resource) Enum() *Resource

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

func (x Resource) Number() protoreflect.EnumNumber

func (x Resource) String() string

func (Resource) Type() protoreflect.EnumType

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) ListNotificationSubscriptions(context.Context, *ListNotificationSubscriptionsRequest) (*ListNotificationSubscriptionsResponse, error)

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

type UnsafeNotificationsApiServiceServer interface {
	// contains filtered or unexported methods
}

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