Package google.shopping.merchant.notifications.v1beta

索引

• NotificationsApiService（接口）
• Attribute（枚举）
• CreateNotificationSubscriptionRequest（消息）
• DeleteNotificationSubscriptionRequest（消息）
• GetNotificationSubscriptionRequest（消息）
• ListNotificationSubscriptionsRequest（消息）
• ListNotificationSubscriptionsResponse（消息）
• NotificationSubscription（消息）
• NotificationSubscription.NotificationEventType（枚举）
• ProductChange（消息）
• ProductStatusChangeMessage（消息）
• Resource（枚举）
• UpdateNotificationSubscriptionRequest（消息）

NotificationsApiService

用于为商家管理通知订阅的服务

CreateNotificationSubscription

rpc CreateNotificationSubscription(CreateNotificationSubscriptionRequest) returns (NotificationSubscription) 为商家创建通知订阅。对于独立账号或子账号，商家可以自行创建订阅。对于 MCA，企业可以为所有受管账号或特定子账号创建订阅。 我们将允许以下类型的通知订阅共存（每项事件类型对应一个订阅方，每个企业一个订阅方）： 为所有客户账号订阅 + 为自己订阅。 为受管理的账号订阅多个“部分”方案，并为自己订阅一个方案。 我们不允许（每个事件类型，每个商家作为订阅者）： 多个自行订阅。 多个“所有受管理的账号”订阅。 同时订阅“所有客户账号”和部分订阅。 针对同一目标账号的多个部分订阅。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/content 如需了解详情，请参阅 OAuth 2.0 概览。

DeleteNotificationSubscription
rpc DeleteNotificationSubscription(DeleteNotificationSubscriptionRequest) returns (Empty) 删除商家的通知订阅。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/content 如需了解详情，请参阅 OAuth 2.0 概览。

GetNotificationSubscription
rpc GetNotificationSubscription(GetNotificationSubscriptionRequest) returns (NotificationSubscription) 获取账号的通知订阅。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/content 如需了解详情，请参阅 OAuth 2.0 概览。

ListNotificationSubscriptions
rpc ListNotificationSubscriptions(ListNotificationSubscriptionsRequest) returns (ListNotificationSubscriptionsResponse) 获取商家的所有通知订阅。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/content 如需了解详情，请参阅 OAuth 2.0 概览。

UpdateNotificationSubscription
rpc UpdateNotificationSubscription(UpdateNotificationSubscriptionRequest) returns (NotificationSubscription) 更新商家的现有通知订阅。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/content 如需了解详情，请参阅 OAuth 2.0 概览。

属性

用于指定要更改的资源中的属性，以便通知商家。

枚举
ATTRIBUTE_UNSPECIFIED	未指定属性
STATUS	更改的实体的状态

CreateNotificationSubscriptionRequest

CreateNotificationSubscription 方法的请求消息。

字段
parent	string 必需。拥有新通知订阅的商家账号。格式：accounts/{account}
notification_subscription	NotificationSubscription 必需。要创建的通知订阅。

DeleteNotificationSubscriptionRequest

DeleteNotificationSubscription 方法的请求消息。

字段
name	string 必需。要删除的通知订阅的名称。

GetNotificationSubscriptionRequest

GetNotificationSubscription 方法的请求消息。

字段
name	string 必需。通知订阅的 name。

ListNotificationSubscriptionsRequest

ListNotificationSubscription 方法的请求消息。

字段
parent	string 必需。拥有通知订阅的商家账号。格式：accounts/{account}
page_size	int32 在一个页面中返回的通知订阅的数量上限。page_size 的默认值为 100。最大值为 200。高于 200 的值将被强制转换为 200。
page_token	string 用于检索后续页面的令牌（如果提供）。所有其他参数都必须与提供页面令牌的原始调用一致。

ListNotificationSubscriptionsResponse

ListNotificationSubscription 方法的响应消息。

字段
notification_subscriptions[]	NotificationSubscription 商家请求的通知订阅列表。
next_page_token	string 可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段，则不存在后续页面。

NotificationSubscription

表示商家账号拥有的通知订阅。

字段
name	string 仅限输出。通知配置的 name。在创建新的 NotificationSubscription 时由 Content API 生成。account 代表拥有相应配置的商家的商家 ID。格式：accounts/{account}/notificationsubscriptions/{notification_subscription}
registered_event	NotificationEventType 商家希望接收通知的事件。
call_back_uri	string 用于向商家推送通知的网址。
联合字段 interested_in。 interested_in 只能是下列其中一项：
all_managed_accounts	bool 如果此值为 true，则请求账号会在所有客户账号（可以是子账号或其他关联的账号）（包括每天新增的账号）的指定事件发生时收到通知。
target_account	string 您要接收通知的账号的 name。格式：accounts/{account}

NotificationEventType

表示商家有意接收通知的事件类型。

枚举
NOTIFICATION_EVENT_TYPE_UNSPECIFIED	通知事件类型未指定。
PRODUCT_STATUS_CHANGE	商品状态变化通知，例如商品被拒批时。

ProductChange

商品发生的更改，包括旧值、新值、国家/地区代码（作为地区代码）和报告上下文。

字段
old_value	string 更改的资源或属性的旧值。
new_value	string 更改的资源或属性的新值。
region_code	string 发生变更的国家/地区（如果适用）
reporting_context	ReportingContextEnum 发生更改的报告上下文（如果适用）

ProductStatusChangeMessage

商家将收到的商品状态变更事件通知消息

字段
changes[]	ProductChange 用于描述商品所发生的更改的消息
account	string 拥有发生更改的实体的目标账号。格式：accounts/{merchant_id}
managing_account	string 用于管理商家账号的账号。如果是独立账号，则可以与商家 ID 相同。格式：accounts/{service_provider_id}
resource_type	Resource 发生更改的资源，在本例中始终为 Product。
attribute	Attribute 资源中发生更改的属性，在本例中始终为 Status。
resource_id	string 商品 ID。
resource	string 商品名称。格式：{product.name=accounts/{account}/products/{product}}

资源

用于指定要更改的资源以向商家发送通知的枚举。

枚举
RESOURCE_UNSPECIFIED	未指定资源
PRODUCT	资源类型：商品

UpdateNotificationSubscriptionRequest

UpdateNotificationSubscription 方法的请求消息。

字段
notification_subscription	NotificationSubscription 必需。应更新的通知订阅的新版本。
update_mask	FieldMask 要更新的字段的列表。