Package google.shopping.merchant.inventories.v1beta

索引

LocalInventoryService

服務,用於管理產品的店面商品目錄

DeleteLocalInventory

rpc DeleteLocalInventory(DeleteLocalInventoryRequest) returns (Empty)

從商家帳戶中指定的產品中刪除指定的 LocalInventory。系統最多可能需要一個小時才能從特定產品中刪除 LocalInventory。收到刪除成功的回應後,請等待該期間過後再嘗試再次刪除。

授權範圍

需要下列 OAuth 範圍:

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

詳情請參閱 OAuth 2.0 Overview

InsertLocalInventory

rpc InsertLocalInventory(InsertLocalInventoryRequest) returns (LocalInventory)

LocalInventory 資源插入商家帳戶中的產品。

如果產品已有相同 storeCode 的項目,就會取代完整的 LocalInventory 資源。

新版或更新版 LocalInventory 資源最多可能需要 30 分鐘才會顯示在產品中。

授權範圍

需要下列 OAuth 範圍:

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

詳情請參閱 OAuth 2.0 Overview

ListLocalInventories

rpc ListLocalInventories(ListLocalInventoriesRequest) returns (ListLocalInventoriesResponse)

列出商家帳戶中指定產品的 LocalInventory 資源。回應中包含的項目可能少於 pageSize 指定的項目數量。如果先前的要求傳回 pageToken,您可以使用該值取得其他結果。

LocalInventory 資源會依帳戶的產品列出。

授權範圍

需要下列 OAuth 範圍:

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

詳情請參閱 OAuth 2.0 Overview

RegionalInventoryService

用於管理產品區域商品目錄的服務。此外,還有獨立的 regions 資源和 API 可用於管理區域定義。

DeleteRegionalInventory

rpc DeleteRegionalInventory(DeleteRegionalInventoryRequest) returns (Empty)

從商家帳戶中指定的產品中,刪除指定的 RegionalInventory 資源。系統最多可能需要一個小時才能從特定產品中刪除 RegionalInventory。收到刪除成功的回應後,請等待該期間過後再嘗試再次刪除。

授權範圍

需要下列 OAuth 範圍:

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

詳情請參閱 OAuth 2.0 Overview

InsertRegionalInventory

rpc InsertRegionalInventory(InsertRegionalInventoryRequest) returns (RegionalInventory)

在商家帳戶中,將 RegionalInventory 插入特定產品。

如果產品已有相同 region 的項目,就會取代完整的 RegionalInventory 資源。

新版或更新版 RegionalInventory 資源最多可能需要 30 分鐘才會顯示在產品中。

授權範圍

需要下列 OAuth 範圍:

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

詳情請參閱 OAuth 2.0 Overview

ListRegionalInventories

rpc ListRegionalInventories(ListRegionalInventoriesRequest) returns (ListRegionalInventoriesResponse)

列出商家帳戶中指定產品的 RegionalInventory 資源。回應中包含的項目可能少於 pageSize 指定的項目數量。如果先前的要求傳回 pageToken,您可以使用該值取得其他結果。

RegionalInventory 資源會依帳戶的產品列出。

授權範圍

需要下列 OAuth 範圍:

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

詳情請參閱 OAuth 2.0 Overview

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

必要欄位。產品的店面商品目錄資訊。如果產品已針對相同的 storeCode 提供 LocalInventory 資源,系統會完全取代 LocalInventory 資源。

InsertRegionalInventoryRequest

InsertRegionalInventory 方法的要求訊息。

欄位
parent

string

必要欄位。要插入此廣告素材資源的帳戶和產品。格式:accounts/{account}/products/{product}

regional_inventory

RegionalInventory

必要欄位。要加入產品的區域商品目錄資訊。如果產品已針對相同的 region 提供 RegionalInventory 資源,系統會完全取代 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

產品在這個地區是否有售。如要瞭解系統接受的屬性值,請參閱區域產品目錄資料規格