Package google.shopping.merchant.inventories.v1beta

索引

LocalInventoryService

这项服务用于管理商品的本地商品目录

DeleteLocalInventory

rpc DeleteLocalInventory(DeleteLocalInventoryRequest) returns (Empty)

从商家账号中的指定商品中删除指定的 LocalInventory。系统最多可能需要 1 小时才能从指定商品中删除 LocalInventory。收到成功删除的响应后,请等待相应时间段后再尝试删除。

授权范围

需要以下 OAuth 作用域:

  • https://www.googleapis.com/auth/content

有关详情,请参阅 OAuth 2.0 概览

InsertLocalInventory

rpc InsertLocalInventory(InsertLocalInventoryRequest) returns (LocalInventory)

向商家帐号中的商品插入 LocalInventory 资源。

如果商品已存在具有相同 storeCode 的条目,则替换完整的 LocalInventory 资源。

新的或更新后的 LocalInventory 资源最多可能需要 30 分钟才会显示在商品中。

授权范围

需要以下 OAuth 作用域:

  • https://www.googleapis.com/auth/content

有关详情,请参阅 OAuth 2.0 概览

ListLocalInventories

rpc ListLocalInventories(ListLocalInventoriesRequest) returns (ListLocalInventoriesResponse)

列出商家帐号中指定商品的 LocalInventory 资源。此响应包含的项目数量可能少于 pageSize 指定的数量。如果上一个请求中返回了 pageToken,它可用于获取其他结果。

每个产品都针对一个给定帐号列出了 LocalInventory 项资源。

授权范围

需要以下 OAuth 作用域:

  • https://www.googleapis.com/auth/content

有关详情,请参阅 OAuth 2.0 概览

RegionalInventoryService

用于管理商品地区商品目录的服务。此外,还有单独的 regions 资源和 API 可用于管理区域定义。

DeleteRegionalInventory

rpc DeleteRegionalInventory(DeleteRegionalInventoryRequest) returns (Empty)

从商家账号中的指定商品中删除指定的 RegionalInventory 资源。系统最多可能需要 1 小时才能从指定商品中删除 RegionalInventory。收到成功删除的响应后,请等待相应时间段后再尝试删除。

授权范围

需要以下 OAuth 作用域:

  • https://www.googleapis.com/auth/content

有关详情,请参阅 OAuth 2.0 概览

InsertRegionalInventory

rpc InsertRegionalInventory(InsertRegionalInventoryRequest) returns (RegionalInventory)

向商家账号中的指定商品插入 RegionalInventory

如果商品已存在具有相同 region 的条目,则替换完整的 RegionalInventory 资源。

新的或更新后的 RegionalInventory 资源最多可能需要 30 分钟才会显示在商品中。

授权范围

需要以下 OAuth 作用域:

  • https://www.googleapis.com/auth/content

有关详情,请参阅 OAuth 2.0 概览

ListRegionalInventories

rpc ListRegionalInventories(ListRegionalInventoriesRequest) returns (ListRegionalInventoriesResponse)

列出商家帐号中指定商品的 RegionalInventory 资源。此响应包含的项目数量可能少于 pageSize 指定的数量。如果上一个请求中返回了 pageToken,它可用于获取其他结果。

每个产品都针对一个给定帐号列出了 RegionalInventory 项资源。

授权范围

需要以下 OAuth 作用域:

  • https://www.googleapis.com/auth/content

有关详情,请参阅 OAuth 2.0 概览

DeleteLocalInventoryRequest

DeleteLocalInventory 方法的请求消息。

字段
name

string

必需。要删除的指定商品的本地商品目录名称。格式:accounts/{account}/products/{product}/localInventories/{store_code}

DeleteRegionalInventoryRequest

DeleteRegionalInventory 方法的请求消息。

字段
name

string

必需。要删除的 RegionalInventory 资源的名称。格式:accounts/{account}/products/{product}/regionalInventories/{region}

InsertLocalInventoryRequest

InsertLocalInventory 方法的请求消息。

字段
parent

string

必需。将在其中插入此广告资源的帐号和产品。格式:accounts/{account}/products/{product}

local_inventory

LocalInventory

必需。商品的本地商品目录信息。如果商品已包含针对同一 storeCodeLocalInventory 资源,则会执行完全替换 LocalInventory 资源。

InsertRegionalInventoryRequest

InsertRegionalInventory 方法的请求消息。

字段
parent

string

必需。将在其中插入此广告资源的帐号和产品。格式:accounts/{account}/products/{product}

regional_inventory

RegionalInventory

必需。要添加到商品的地区商品目录信息。如果商品已包含针对同一 regionRegionalInventory 资源,则会执行完全替换 RegionalInventory 资源。

ListLocalInventoriesRequest

ListLocalInventories 方法的请求消息。

字段
parent

string

必需。要列出其本地商品目录的父级商品的 name。格式:accounts/{account}/products/{product}

page_size

int32

要返回的指定商品的最大 LocalInventory 资源数。如果指定产品的商品目录数量少于 pageSize,则服务返回的商品目录数量会少于此值。默认值为 25000。最大值为 25000;如果指定的值大于最大值,则 pageSize 将默认采用最大值

page_token

string

从之前的 ListLocalInventories 调用接收的页面令牌。提供页面令牌以检索后续页面。

进行分页时,提供给 ListLocalInventories 的所有其他参数必须与提供页面令牌的调用匹配。在对上一个请求的响应中作为 nextPageToken 返回的令牌。

ListLocalInventoriesResponse

ListLocalInventories 方法的响应消息。

字段
local_inventories[]

LocalInventory

指定帐号中指定产品的 LocalInventory 资源。

next_page_token

string

可作为 pageToken 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

ListRegionalInventoriesRequest

ListRegionalInventories 方法的请求消息。

字段
parent

string

必需。要列出其 RegionalInventory 资源的父级商品的 name。格式:accounts/{account}/products/{product}

page_size

int32

要返回的指定商品的最大 RegionalInventory 资源数。如果指定产品的商品目录数量少于 pageSize,则服务返回的商品目录数量会少于此值。默认值为 25000。最大值为 100000;如果指定的值大于最大值,则 pageSize 将默认为最大值。

page_token

string

从之前的 ListRegionalInventories 调用接收的页面令牌。提供页面令牌以检索后续页面。

进行分页时,提供给 ListRegionalInventories 的所有其他参数必须与提供页面令牌的调用匹配。在对上一个请求的响应中作为 nextPageToken 返回的令牌。

ListRegionalInventoriesResponse

ListRegionalInventories 方法的响应消息。

字段
regional_inventories[]

RegionalInventory

指定帐号中指定产品的 RegionalInventory 资源。

next_page_token

string

可作为 pageToken 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

LocalInventory

商品的本地商品目录信息。表示 storeCode 指定的商店中特定商品的店内信息。如需查看所有接受的属性值的列表,请参阅本地商品目录数据规范

字段
name

string

仅限输出。LocalInventory 资源的名称。格式:accounts/{account}/products/{product}/localInventories/{store_code}

account

int64

仅限输出。拥有该产品的帐号。如果客户端设置了此字段,则将忽略此字段。

store_code

string

必需。不可变。销售商品所在实体店的商店代码(商家资料中的商店 ID)。有关详情,请参阅本地商品目录数据规范

price

Price

此商店的商品价格。

sale_price

Price

此商店的商品促销价。如果已定义 salePriceEffectiveDate,则必须提供此值。

sale_price_effective_date

Interval

此商店促销的 TimePeriod

custom_attributes[]

CustomAttribute

自定义(商家提供的)属性列表。您也可以使用 CustomAttribute 以通用形式提交数据规范的任何属性。

availability

string

此商店的商品库存状况。如需了解可接受的属性值,请参阅本地商品目录数据规范

quantity

int64

此商店所售商品的数量。必须大于或等于零。

pickup_method

string

此商品支持的提货方法。除非值为 "not supported",否则此字段必须与 pickupSla 一起提交。如需了解可接受的属性值,请参阅本地商品目录数据规范

pickup_sla

string

从这家商店下单到可以自提商品的订单日期(从下单日期算起)的相对时间段。必须通过 pickupMethod 提交。如需了解可接受的属性值,请参阅本地商品目录数据规范

instore_product_location

string

商品在商店中的位置。长度上限为 20 个字节。

RegionalInventory

商品的地区商品目录信息。表示特定 region 中给定商品的价格和库存状况等具体信息。如需查看所有接受的属性值的列表,请参阅地区商品目录数据规范

字段
name

string

仅限输出。RegionalInventory 资源的名称。格式:{regional_inventory.name=accounts/{account}/products/{product}/regionalInventories/{region}

account

int64

仅限输出。拥有该产品的帐号。如果客户端设置了此字段,则将忽略此字段。

region

string

必需。不可变。此 RegionalInventory 资源所在区域的 ID。如需了解详情,请参阅地区性库存状况和价格

price

Price

此地区的商品价格。

sale_price

Price

商品在此地区的促销价。如果已定义 salePriceEffectiveDate,则必须提供此值。

sale_price_effective_date

Interval

此地区促销价的 TimePeriod

custom_attributes[]

CustomAttribute

自定义(商家提供的)属性列表。您也可以使用 CustomAttribute 以通用形式提交数据规范的任何属性。

availability

string

商品在此地区的库存状况。如需了解可接受的属性值,请参阅地区商品目录数据规范