Package google.shopping.merchant.notifications.v1beta

索引

NotificationsApiService

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

CreateNotificationSubscription

rpc CreateNotificationSubscription(CreateNotificationSubscriptionRequest) returns (NotificationSubscription)

为商家创建通知订阅。我们将允许以下类型的通知订阅同时存在（对于每种事件类型，每个商家都作为一个订阅者）：1. 为所有客户账号订阅 + 自行订阅 2。客户帐号有多个“部分”订阅 + 自身订阅

我们不允许出现以下情况（对于每种活动类型，每个商家作为订阅者）：1. 多次自助订阅。2. 多个“所有客户账号”订阅。3. 同时进行所有订阅和部分订阅。4. 同一目标账号有多个部分订阅

授权范围

需要以下 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

要更新的字段列表。