產品資源
產品資源可讓您在 Microsoft 商家中心商店中管理產品供應專案, (MMC) 。 如需使用 Products 資源的相關信息,請 參閱管理您的產品。 如需示範如何新增、刪除及取得產品的範例,請參閱 程式碼範例。
基底 URI
以下是您附加範本的基底 URI。
https://content.api.bingads.microsoft.com/shopping/v9.1/bmc/
範本
若要建立用來管理產品供應專案的端點,請將適當的範本附加至基底 URI。
範本 | HTTP 動詞 | 描述 | 資源 |
---|---|---|---|
{mmcMerchantId}/products/batch |
POST | 使用 在單一要求中執行多個插入 (更新) 、取得和刪除。 批次不得包含相同產品的多個動作。 例如,要求不得嘗試插入和刪除相同的產品。 設定 {mmcMerchantId} 為 MMC 存放區識別碼。 |
要求: Batch 回應: 批次 |
{mmcMerchantId}/products/{productUniqueId} |
刪除 | 使用 從市集刪除單一產品供應專案。 設定 {mmcMerchantId} 為 MMC 存放區識別碼。設定 {productUniqueId} 為完整產品 標識 碼 (例如 Online:en:US:Sku123) 。如果您在多個目錄中插入具有相同標識符的產品,則會從所有目錄中刪除該產品。 刪除的產品最多可能需要 12 小時才能停止傳遞。 建議您先將產品可用性更新為「缺貨」,再刪除。 |
要求:N/A 回應:N/A |
{mmcMerchantId}/products/{productUniqueId} |
GET | 使用 從市集取得單一產品供應專案。 設定 {mmcMerchantId} 為 MMC 存放區識別碼。設定 {productUniqueId} 為完整產品 標識 碼 (例如 Online:en:US:Sku123) 。如果您在多個目錄中插入具有相同標識碼的產品,服務只會傳回其中一個標識碼,且其中一個未決定。 |
要求:N/A 回應: 產品 |
{mmcMerchantId}/products |
GET | 使用取得市集中的產品清單。 設定 {mmcMerchantId} 為 MMC 存放區識別碼。 |
要求:N/A 回應: 產品 |
{mmcMerchantId}/products |
POST | 使用 將更新 (插入) 市集中的單一產品供應專案。 如果產品不存在,則會新增;否則會更新產品。 因為更新會覆寫目前的供應專案,所以您必須包含構成供應專案的所有欄位。 若要將供應專案插入特定目錄,請指定 bmc-catalog-id 查詢參數;否則,產品會插入商店的預設目錄中。 設定 {mmcMerchantId} 為 MMC 存放區識別碼。請注意 ,由於 Get/List 和 Delete 要求會對市集而非特定目錄採取行動,因此您不應該將具有相同 通道、 contentLanguage、 targetCountry 和 offerId 的產品插入多個目錄中。 |
要求: 產品 回應: 產品 |
查詢參數
端點可能包含下列查詢參數。
參數 | 描述 |
---|---|
Alt | 選用。 使用 來指定要求和回應中所使用的內容類型。 可能的值為 json 和 xml 。 預設值為 json 。 |
bmc-catalog-id | 選用。 用來指定要插入 (更新) 產品供應項目的目錄。 如果您的存放區包含多個目錄,請使用此參數。 如果您未指定此參數,產品會插入商店的預設目錄中。 此參數僅用於插入產品供應專案。 Get、List 和 Delete 要求會忽略此參數,因為它們會跨目錄運作。 |
dry-run | 選用。 在偵錯應用程式以測試呼叫時使用 。 包含此參數的呼叫不會影響生產數據, (產品不會插入或刪除) ;不過,回應會包含呼叫所產生的任何錯誤。 使用此參數時,請考慮下列限制。
|
max-results | 選用。 使用 指定要在清單要求中傳回的項目數目上限。 您可以指定的最大值為 250。 預設值為 25。 |
start-token | 選用。 用來逐頁查看商店的產品清單。 令牌會識別要在清單要求中傳回的產品下一頁。 請勿在第一個清單要求中指定此參數。 如果目錄包含超過要求的產品數目 (請參閱 max-results 查詢參數) ,回應會包含 nextPageToken 字段 (請參閱 Products) ,其中包含您在下一個清單要求中使用的令牌值。 |
標頭
以下是要求和響應標頭。
Header | 描述 |
---|---|
AuthenticationToken | 要求標頭。 將此標頭設定為 OAuth 存取令牌。 如需取得存取令牌的資訊,請參閱 驗證您的認證。 |
Content-Location | 回應標頭。 URL,識別產品插入的存放區。 此標頭包含在 Insert 要求的回應中。 |
Content-Type | 要求和回應標頭。 要求或響應主體中的內容類型。 針對 POST,如果您使用 JSON,請將此標頭設定為 application/json 。 否則,如果您使用 XML,請將此標頭設定為 application/xml 。 |
CustomerAccountId | 要求標頭。 您代表標頭中指定的客戶所管理之任何帳戶的 CustomerId 帳戶標識碼。 您指定的帳戶並不重要。 只有在您代表客戶管理帳戶時,才指定此標頭。 |
CustomerId | 要求標頭。 您管理其存放區之客戶的客戶標識碼。 只有在您代表客戶管理市集時,才指定此標頭。 如果您設定此標頭,也必須設定 CustomerAccountId 標頭。 |
DeveloperToken | 要求標頭。 用戶端應用程式的開發人員令牌。 每個要求都必須包含此標頭。 如需取得令牌的相關信息,請參閱 您是否有 Microsoft Advertising 認證和開發人員令牌? |
位置 | 回應標頭。 URL,識別產品插入的存放區。 此標頭包含在 Insert 要求的回應中。 |
WebRequestActivityId | 回應標頭。 包含要求詳細數據的記錄項目標識碼。 如果發生錯誤,您應該一律擷取此標識碼。 如果您無法判斷並解決問題,請包含此標識碼以及您提供支援小組的其他資訊。 |
要求和回應物件
以下是 API 所使用的要求和回應物件。
每個物件都會根據您為要求指定的內容類型,定義您使用的 JSON 金鑰名稱和 XML 項目名稱。
物件 | 描述 |
---|---|
批 | 定義要在批次要求中處理的項目清單。 |
錯誤 | 定義錯誤。 |
ErrorResponse | 定義單一產品插入的最上層錯誤物件。 |
BatchItemError | 定義批處理期間針對專案所發生的錯誤。 |
項目 | 定義批次要求或回應中的專案。 |
產品 | 定義產品。 |
ProductCustomAttribute | 定義自訂屬性。 |
ProductCustomGroup | 定義一組自定義屬性。 |
ProductDestination | 定義目的地。 |
ProductPrice | 定義產品的價格。 |
ProductTax | 定義決定適用稅金的地理位置。 |
產品 | 定義產品清單。 |
ProductShipping | 定義出貨成本。 |
ProductShippingWeight | 定義專案的出貨重量。 |
UnitPricing | 定義專案的每一單價。 |
警告 | 定義警告訊息。 |
批
定義要在批次要求中處理的項目清單。 請注意 ,此對象用於批次要求和回應。
名稱 | 值 | 類型 | XML 項目名稱 |
---|---|---|---|
條目 | 要在批次要求中處理的項目陣列。 您可以指定的項目數上限為 12,000。 不過,要求大小上限為 4 MB,因此實際的項目數目取決於產品屬性的數目 (例如大小、色彩、模式) ,以及您是否壓縮數據。 例如,如果您壓縮數據,或許可以指定12,000個專案,但如果沒有,您可能只能指定2,000個專案。 |
Item[] | <批> |
BatchItemError
定義批處理期間針對專案所發生的錯誤。
名稱 | 值 | 類型 | XML 項目名稱 |
---|---|---|---|
錯誤 | 處理項目時發生的錯誤清單。 | Error[] | <錯誤> |
code | 錯誤的 HTTP 狀態代碼。 | String | |
訊息 | 與錯誤相關聯的訊息。 | String |
錯誤
定義錯誤。
名稱 | 值 | 類型 | XML 項目名稱 |
---|---|---|---|
網域 | 僅限內部使用。 | String | <域> |
位置 | 不會使用。 | String | <location type=“string”> |
locationType | 不會使用。 | String | 請參閱location>元素的<類型屬性 |
訊息 | 錯誤的描述。 | String | <internalReason> |
reason | 要求失敗的原因。 例如,產品驗證失敗。 | String | <原因> |
ErrorResponse
定義單一產品插入的最上層錯誤物件。
名稱 | 值 | 類型 | XML 項目名稱 |
---|---|---|---|
錯誤 | 處理項目時發生的錯誤清單。 | Errors[] | <錯誤> |
錯誤
定義供應項目的錯誤和警告清單。
名稱 | 值 | 類型 | XML 項目名稱 |
---|---|---|---|
錯誤 | 處理項目時發生的錯誤清單。 | Error[] | <錯誤> |
警告 | 處理專案時發生的警告清單。 已接受供應專案,但您應該儘早解決問題。 例如,如果您未指定 gtin、 mpn 和 品牌 識別碼,則 MMC 會傳回警告。 | Warning[] | <警告> |
code | HTTP 狀態代碼或錯誤。 | String | |
訊息 | 與錯誤相關聯的訊息。 | String |
項目
定義批次要求中的專案。
名稱 | 值 | 類型 | XML 項目名稱 |
---|---|---|---|
batchId | 在批次要求中識別此專案的使用者定義標識碼。 例如,如果批次包含10個專案,您可以指派標識碼1到10。 | Unsigned Integer | <entry batch_id=“unsigned integer” method=“string”> |
錯誤 | 錯誤物件,其中包含發生的驗證錯誤清單。 只有在發生錯誤時,回應才會包含此欄位。 | BatchItemError | <錯誤> |
商家標識碼 | 商家中心商店標識碼。 | Unsigned Long | <merchant_id> |
方法 | 要套用至項目的動作。 可能的值為 insert 、 get 和 delete 。 如果專案正在新增或更新產品供應專案,請將 方法 設定為 insert ;如果專案正在刪除產品,請將 方法 設定為 delete ;如果專案正在取得產品,請將 方法 設定為 get 。 字串不區分大小寫。 |
String | 請參閱 entry method > 元素的 <屬性 |
產品 | 產品供應專案。 只有在產品) 插入更新 (時,才在要求中指定此欄位。 回應只會包含取得和插入更新 () 的這個欄位。 | 產品 | <產品> |
productId | 完整產品標識碼 (例如 Online:en:US:Sku123) 。 只有在取得或刪除產品供應專案時,才包含此欄位。 請勿在批次要求中包含具有相同產品標識碼的多個專案。 |
String | <product_id> |
產品
定義產品。 如需此物件中欄位的詳細資訊,請 參閱摘要檔案如何組織?
JSON 和 XML 名稱 | 值 | 類型 | 插入的必要專案 |
---|---|---|---|
additionalImageLinks <additional_image_link> |
產品廣告中可使用之其他影像的 URL。 若要指定多個影像, MMC 不會使用其他映像;此欄位包含於Google相容性。 |
String[] | 否 |
成人 <成人> |
布爾值,決定專案是否為成人產品。 如果專案的目標市場是成人,則設定為 true 。 預設值為 false 。 請注意,不支援成人產品,而且將會遭到拒絕。 |
布林值 | 否 |
adwordsGrouping <adwords_grouping> |
一組每個下載成本 (CPA) 專案群組。 MMC 不會使用此欄位;其包含於Google相容性。 |
字串 | 否 |
adwordsLabels <adwords_label> |
群組專案的標籤 (請參閱 adwordsGrouping) 。 僅適用於按兩下成本 () 。 MMC 不會使用此欄位;其包含於Google相容性。 |
String[] | 否 |
adwordsRedirect <adwords_redirect> |
要在產品廣告中使用的 URL。 如果指定,此 URL 必須重新導向至 連結中指定的 URL。 | 字串 | 否 |
ageGroup <age_group> |
項目的目標年齡群組。 以下是可能的值。
|
字串 | 否 |
可用性 <可用性> |
產品的可用性狀態。 以下是可能的值。
|
字串 | 是 |
availabilityDate <availability_date> |
前置訂單產品可供出貨的 UTC 日期 (請參閱 availability 字段) 。 此欄位是選擇性的,但如果您知道預先訂購的產品可供出貨的日期,您應該設定此欄位。 以 ISO 8601 格式指定日期。注意: MMC 目前會忽略此欄位的內容。 |
字串 | 否 |
品牌 <品牌> |
專案的品牌、製造商或發行者。 字串最多可包含 10 個字和 1,000 個字元。 若要確保字串在 UX 中顯示良好,您應該將品牌名稱限制為不超過 70 個字元。 | 字串 | 是 |
通道 <通道> |
產品的銷售通路。 以下是可能不區分大小寫的值。
|
字串 | 是 |
color <顏色> |
產品的主要色彩。 如果色彩是色彩的混合,您可以指定最多 3 種色彩的斜線分隔清單 (例如紅色/綠色/藍色) 。 如果有多種色彩的服裝可供使用,您會為每個色彩建立產品,並使用 itemGroupId 將產品的變體分組。 欄位限制為 100 個字元。 建議用於郵件專案。 |
字串 | 否 |
條件 <條件> |
產品的條件。 以下是可能的值。
|
字串 | 是 |
contentLanguage <content_language> |
產品的兩個字母 ISO 639-1 語言代碼。 以下是可能不區分大小寫的值:
|
字串 | 是 |
customAttributes <custom_attribute> |
商家所使用的自定義屬性清單。 | ProductCustomAttribute[] | 否 |
customGroups<custom_group> | 商家所使用的自定義群組清單。 | ProductCustomGroup[] | 否 |
customLabel0 <custom_label_0> |
自定義標籤 0,用來篩選 Microsoft 購物活動的產品。 標籤限製為 100 個字元。 | 字串 | 否 |
customLabel1 <custom_label_1> |
自定義標籤 1,用來篩選 Microsoft 購物活動的產品。 標籤限製為 100 個字元。 | 字串 | 否 |
customLabel2 <custom_label_2> |
自定義標籤 2,用來篩選 Microsoft 購物活動的產品。 標籤限製為 100 個字元。 | 字串 | 否 |
customLabel3 <custom_label_3> |
自定義標籤 3,用來篩選 Microsoft 購物活動的產品。 標籤限製為 100 個字元。 | 字串 | 否 |
customLabel4 <custom_label_4> |
自定義標籤 4,用來篩選 Microsoft 購物活動的產品。 標籤限製為 100 個字元。 | 字串 | 否 |
描述 <描述> |
產品的描述。 描述可能不包含促銷文字。 描述限制為最多 10,000 個字元,而且可能包含任何 Unicode 字元。 描述將會進行編輯檢閱。 |
字串 | 否 |
目的地 <目的地> |
產品的預定目的地。 MMC 不會使用此欄位;其包含於Google相容性。 |
ProductDestination[] | 否 |
energyEfficiencyClass <energy_efficiency_class> |
能源效率類別,如 EU 指示詞 2010/30/EU 中所定義。 以下是可能的值。
|
字串 | 否 |
expirationDate <expiration_date> |
指定產品到期時間的 UTC 日期和時間。 如果您未指定到期日,則產品會在您新增或更新產品的日期和時間 30 天后到期, (日期和時間是以 Microsoft 伺服器的時區) 為基礎。 使用此欄位來指定從今天起小於 30 天的到期日。 您的到期日應一律包含時間元件,並指定時區或位移資訊。 如果沒有,API 會嘗試使用 targetCountry 來判斷時區。 對於具有多個時區的國家或地區,API 會決定要使用的時區。 例如,如果美國國家/地區,API 會使用太平洋標準時間 (PST) 。 您應該追蹤即將到期的產品,並在到期前更新其到期日,或只是更新產品 (您不需要更新產品的任何字段) 這會自動將到期日再延長 30 天。 如果您明確設定到期日,則必須自行設定新的到期日;在此情況下,更新產品不會自動將到期日再延長 30 天。 |
字串 | 否 |
性別 <性別> |
產品的目標性別。 以下是可能的值。
|
字串 | 否 |
googleProductCategory <google_product_category> |
找到產品的產品類別目錄。 您可以指定類別字串 (例如,動物 & 寵物供應 > 專案寵物供應 >) 或類別標識碼 (例如 3) 。 針對類別字串,子類別目錄清單會以大於符號 (『>) 分隔。 欄位限制為 255 個字元。 如需類別字串和識別碼的清單,請參閱類別。 |
字串 | 否 |
gtin <gtin> |
製造商 (GTIN) 指派的全域交易項目編號。 如果製造商指派 GTIN,您必須指定它。 以下是 GTIN 的類型。
|
字串 | 是 |
Id <Id> |
完整的產品標識碼。標識符是 通道、 contentLanguage、 targetCountry 和 offerId 的複合。 標識碼會區分大小寫。 使用此標識碼來取得或刪除產品。 |
字串 | 否 |
identifierExists <identifier_exists> |
布爾值,決定產品供應專案是否指定 gtin、 mpn 或 品牌 識別碼。 預設值為 true 。 如果您未指定這三個標識符,請將 設定為 false 。 唯一的產品標識碼會定義全球 Marketplace 中的產品。 使用唯一標識符標記您的產品,可讓客戶更容易找到您的產品。 如果已知,您應該指定這三個標識符。 |
布林值 | 否 |
imageLink <image_link> |
產品影像的 URL,可在產品廣告中使用。 URL 限制為 1,000 個字元,而且可以使用 HTTP 或 HTTPS 通訊協定。 允許的影像類型為 bmp、gif、exif、jpg、png 和 tiff。 建議的影像大小為 200x200 像素。 影像不得超過 3.9 MB。 影像將會進行編輯檢閱。 |
字串 | 是 |
isBundle <is_bundle> |
布爾值,決定產品是否為商家定義的套件群組。 如果產品是套件組合,則值為 true 。 | 布林值 | 否 |
itemGroupId <item_group_id> |
可用來將相同產品的所有變體分組的標識碼。 例如,如果服裝有 3 種色彩,您可以為每個色彩建立產品,並使用此標識符將它們分組。 一般而言,您會將依色彩、材質、圖樣或大小而有所不同的專案分組。 標識碼在目錄中必須是唯一的,且限製為50個字元。 |
字串 | 否 |
kind <kind> |
物件的型別。 這個欄位設定為 content#product 。 |
字串 | 否 |
連結 <連結> |
您網站上產品頁面的 URL。 URL 限制為 2,000 個字元,而且可以使用 HTTP 或 HTTPS 通訊協定。 網域必須符合存放區的網域。 此連結會用於產品廣告中。 無法重新導向URL。 若要在產品廣告中使用可能重新導向至此 URL 的另一個 URL,請參閱 adwordsRedirect。 此連結所指向的網頁將會進行編輯檢閱。 |
字串 | 是 |
材料 <材料> |
產品的主要材質。 如果材質是材質的混合,您可以指定最多 3 個材質的斜線分隔清單 (例如,十六進位/斜體/) 。 如果有多種材質可以使用服裝,您會為每個材質建立產品,並使用 itemGroupId 將產品的變體分組。 欄位限制為 200 個字元。 建議用於郵件專案。 |
字串 | 否 |
mobileLink <mobile_link> |
包含產品相關信息的行動裝置優化版本網頁 URL (請參閱 連結) 。 | 字串 | 否 |
multipack <multipack> |
以單一單位銷售的相同產品數目 (例如,4 個手電筒筒) 。 設定價格時,它必須是 multipack 的總 價格。 | 整數 | 否 |
mpn <mpn> |
產品的製造商元件編號 (MPN) 。 如果製造商指派 MPN,您必須加以指定。 MPN 限制為 70 個字元。 | 字串 | 是 |
offerId <offer_id> |
所提供產品的使用者定義識別碼。 供應項目標識碼不區分大小寫,而且在目錄中必須是唯一的,且最多只能有 50 個字元。 因為供應專案標識碼是用來建立產品 標識符,所以在將產品新增至市集之後,您可能不會變更此字段。 |
字串 | 是 |
onlineOnly <online_only> |
布爾值,決定產品是否只能在在線購買。 如果產品只能在在線使用,則值 為 true 。 預設值為 false 。 | 布林值 | 否 |
模式 <模式> |
產品 (的圖樣或圖形列印,例如,plaid) 。 模式限制為100個字元。 如果有多種模式可以使用服裝,您會為每個模式建立產品,並使用 itemGroupId 將產品的變體分組。 建議用於郵件專案。 |
字串 | 否 |
價格 <價格> |
產品的價格。 以目標國家/地區的貨幣指定價格。 如需是否要在價格中包含稅金的資訊,請參閱 Microsoft 商家中心目錄稅務原則。 價格必須符合產品網頁上顯示的價格 (請參閱 連結) ,且必須介於 0.01 (1 cent) 到 10000000.00 (10000 萬) 範圍內。 不過,如果符合下列條件,您可以將價格設定為0.0 (零) 。 1.googleProductCategory 字段設定為下列其中一個類別: - 電子 > 通訊 > 電話語音 > 行動電話 - 電子 > 電腦 > Tablet 計算機 2. 標題 欄位包含下列其中一個關鍵字: -合同 -安裝 -租賃 -付款 上述關鍵詞會以英文顯示;不過,title 和 關鍵詞必須是指定市場語言。 標題通常會包含片語,例如 “...含方案」 或 “...僅限合約。 合約關鍵詞可在所有市場中使用;不過,收款、付款和租用只能在美國市場使用。 |
ProductPrice | 是 |
productType <product_type> |
廣告定義的產品類別,可能與不同 googleProductCategory 。 例如,動物 & 寵物供應 > 項目寵物提供 > 鳥類供應專案 > 。 子類別清單會以大於符號 (『>) 分隔。 欄位限制為 750 個字元。您可以指定多個以逗號分隔的類別字串。 例如,在 Wig & Accessories > Wig > Accessories Wig Caps、& Accessories > Wig Accessories > Wig Glue。 |
字串 | 否 |
promotionId <promotion_id> |
以逗號分隔的標識符清單,可識別促銷摘要中的促銷。 您最多可以指定 10 個促銷標識碼。 標識碼必須包含至少 1 個字元,且最多 60 個字元。 允許的字元為任何英數位元、虛線 ( ) 和底線 (_) 。 市場 (的所有標識符都會看到 contentLanguage 和 targetCountry) 必須是唯一的。 例如,在市場中,您可能不會使用 PROMO1 和 promo1,但您可以在 en-US 市場中使用 PROMO1 ,並在 en-GB 市場中使用 promo1 。 您可以在一或多個產品上指定相同的唯一促銷標識符。 如果您指定的標識碼符合相同目標國家/地區 (促銷摘要中的促銷標識符,Microsoft 會) 促銷產品。 只有在大小寫相同時,標識碼才會相符。 例如,如果產品的標識碼為 PROMO1 且摘要的標識碼為 PROMO1,則標識符會相符,但如果摘要的標識碼為 Promo1,則標識碼不相符。 若要確保未來不會意外升級產品,您應該移除已結束促銷的標識碼。 雖然標識符在促銷結束后 6 個月內無法再次用於促銷摘要中,但如果標識碼在之後於另一個促銷中重複使用,則產品將會升階。 |
字串 | 否 |
salePrice <sale_price> |
項目的銷售價格。 銷售價格必須介於 0.01 (1 cent) 到 10000000.00 (1000 萬) 範圍內。 針對銷售專案,請設定銷售價格和銷售生效日期 (請參閱 salePriceEffectiveDate ) 。 如果您設定銷售價格,但未設定銷售價格生效日期,則會繼續使用銷售價格,直到產品到期或您設定有效日期為止。如果符合下列條件,您可以將銷售價格設定為0.0 (零) 。 1.googleProductCategory 字段設定為下列其中一個類別: - 電子 > 通訊 > 電話語音 > 行動電話 - 電子 > 電腦 > Tablet 計算機 2. 標題 欄位包含下列其中一個關鍵字: -合同 -安裝 -租賃 -付款 上述關鍵詞會以英文顯示;不過,title 和 關鍵詞必須是指定市場語言。 標題通常會包含片語,例如 “...含方案」 或 “...僅限合約。 合約關鍵詞可在所有市場中使用;不過,收款、付款和租用只能在美國市場使用。 |
ProductPrice | 否 |
salePriceEffectiveDate <sale_price_effective_date> |
銷售的UTC開始和結束日期。 以 ISO 8601 格式指定日期。 例如,2016-04-05T08:00-08:00/2016-04-10T19:30-08:00 (使用斜線 ('/') 來分隔開始和結束日期) 。 如需詳細資訊,請參閱 salePrice 。 |
字串 | 否 |
sellerName <seller_name> |
銷售產品的商家名稱。 僅供匯總工具用來識別商家。 匯總工具是代表個別商家運作的第三方網站。 匯總者代表商家提交的產品必須遵守 Microsoft Advertising 原則和 服務條款。 匯總工具必須將此欄位設定為銷售人員名稱。 如果呼叫端不是匯總工具,而且未設定此字段,則預設為存放區名稱。 名稱限制為 255 個字元。 |
字串 | 否 |
航運 <航運> |
根據位置寄送產品的價格。 注意:如果目標國家/地區是DE (德國) ,則需要出貨;否則為選擇性。 |
ProductShipping[] | 是 |
shippingLabel <shipping_label> |
出貨標籤。 注意:如果目標國家/地區是DE (德國) ,則需要出貨資訊;否則為選擇性。 |
字串 | 是 |
shippingWeight <shipping_weight> |
產品的權數。 權數用於出貨用途。 注意:如果目標國家/地區是DE (德國) ,則需要出貨資訊;否則為選擇性。 |
ProductShippingWeight | 是 |
大小 <大小> |
產品的可用大小。 例如,小型、中型和大型。 一致地套用重設大小。 大小值是用戶定義的,但應該以您的目標國家/地區為基礎。 所有以法國、德國、英國和 美國 為目標的 & 配件產品都需要此欄位。 | String[] | 否 |
sizeSystem <size_system> |
用來調整產品大小的測量系統。 例如,鞋子可能會使用美國系統或英國系統來重設大小。 以下是可能的值。
|
字串 | 否 |
sizeType <size_type> |
產品的剪下。 以下是可能的值。
|
字串 | 否 |
targetCountry <target_country> |
目標國家/地區的兩個字母 ISO 3166 國家/地區代碼 (您要公告產品) 的國家/地區。 國家/地區必須符合目錄所指定的市場。 以下是可能不區分大小寫的值:
|
字串 | 是 |
稅 <稅> |
產品的稅務資訊。 MMC 不會使用此欄位;其包含於Google相容性。 |
ProductTax[] | 否 |
標題 <標題> |
產品的標題 (例如,女性鞋) 。 標題可能不包含促銷文字。 標題限制為最多 150 個字元,而且可能包含任何 Unicode 字元。 標題將會進行編輯檢閱。 |
字串 | 是 |
unitPricingBaseMeasure <unit_pricing_base_measure> |
例如,價格 (100ml 表示價格是根據 100ml 單位) 來計算。
|
UnitPricingBaseMeasure | 否 |
unitPricingMeasure <unit_pricing_measure> |
產品銷售時的量值和維度。
|
UnitPricingMeasure | 否 |
validatedDestinations <validated_destination> |
已通過驗證之預定目的地的唯讀清單。 MMC 不會使用此欄位;其包含於Google相容性。 |
String[] | 否 |
警告 | 產品供應項目問題的警告清單。 已接受供應專案,但您應該儘早解決問題。 例如,如果您未指定 gtin、 mpn 和 品牌 識別碼,則 MMC 會傳回警告。 供應專案只會在插入/更新的回應中包含此欄位。 |
Warning[] | 否 |
ProductCustomAttribute
定義自訂屬性。
名稱 | 值 | 類型 | XML 項目名稱 |
---|---|---|---|
name | 取得或設定屬性的名稱。 | String | <名字> |
類型 | 取得或設定屬性的類型。 以下是可能的值。
|
String | <類型> |
單位 | 取得或設定屬性的測量單位。 僅用於 INT 和 FLOAT 類型的值。 | String | <單位> |
數值 | 取得或設定屬性的值。 | String | <價值> |
ProductCustomGroup
定義一組客戶屬性。
名稱 | 值 | 類型 | XML 項目名稱 |
---|---|---|---|
屬性 | 取得或設定群組的屬性。 | ProductCustomAttribute | <屬性> |
name | 取得或設定群組的名稱。 | String | <名字> |
ProductDestination
定義目的地。
名稱 | 值 | 類型 | XML 項目名稱 |
---|---|---|---|
意圖 | 以下是可能的值。
|
String | <意圖> |
destinationName | 取得或設定目的地的名稱。 | String | <destination_name> |
ProductPrice
定義產品的價格或銷售價格。
名稱 | 值 | 類型 | XML 項目名稱 |
---|---|---|---|
貨幣 | 取得或設定價格所述的貨幣。 使用 ISO 4217 貨幣代碼指定貨幣。 以下是可能的值。
|
String |
currency 屬性。例如,<price currency=“USD”。> |
數值 | 取得或設定項目的價格。 請勿包含貨幣符號,例如 『$』。 | 雙精度浮點數 | 文字值。 例如, <price currency=“USD”>38.0<\price>。 |
產品
定義產品清單。 請注意 ,這是 List 要求傳回的最上層物件。
名稱 | 值 | 類型 | XML 項目名稱 |
---|---|---|---|
kind | 取得物件的型別。 此欄位設定為 content#productsListResponse。 | String | <kind> |
nextPageToken | 取得用來取得下一頁結果的令牌。 如果物件不包含此欄位,就不會再有頁面可取得。 請參閱 start-token。 | String | <next_page_token> |
資源 | 取得產品清單。 如果目錄不包含任何供應專案,則陣列是空的。 | Product[] | <產品> |
ProductShipping
定義出貨成本。
名稱 | 值 | 類型 | XML 項目名稱 |
---|---|---|---|
國家 | 取得或設定專案出貨所在國家/地區的兩個字母 ISO 3166 國家/地區代碼。 | String | <國家> |
locationGroupName | 取得或設定位置組名。 | String | <location_group_name> |
locationId | 取得或設定要運送專案之地理位置的標識碼。 如需標識碼的清單,請參閱 地理位置代碼。 | String | <location_id> |
postalCode | 取得或設定寄送專案所在位置的郵遞區號或郵遞區編碼範圍。 您可以指定郵遞區區編碼,如下所示:
|
String | <postal_code> |
價格 | 取得或設定將專案寄送至指定位置的固定價格。 | ProductPrice | <價格> |
地區 | 取得或設定要將專案運送至 (的地理區域,例如 zip 程式代碼) 。 | String | <地區> |
服務 | 取得或設定描述服務類別或傳遞速度的文字描述。 | String | <服務> |
ProductShippingWeight
定義專案的出貨重量。
名稱 | 值 | 類型 | XML 項目名稱 |
---|---|---|---|
單位 | 取得或設定量值的單位。 | String |
unit 屬性。例如,<shipping_weight unit=“oz”。> |
數值 | 取得或設定項目的權數,用來計算專案的出貨成本。 | String | 文字值。 例如, <shipping_weight unit=“oz”>20.3<shipping_weight>。 |
ProductTax
定義決定適用稅金的地理位置。
名稱 | 值 | 類型 | XML 項目名稱 |
---|---|---|---|
國家 | 取得或設定適用其稅率的國家/地區。 使用兩個字母 的 ISO 3166 國家/地區代碼。 | String | <國家> |
locationId | 取得或設定套用稅率之地理位置的標識碼。 如需標識碼的清單,請參閱 地理位置代碼。 | Long | <location_id> |
postalCode | 取得或設定要套用稅率的郵遞區號或郵遞區編碼範圍。 您可以指定郵遞區區編碼,如下所示:
|
String | <postal_code> |
率 | 取得或設定要套用至項目價格的百分比稅率。 若要指定 5% 的速率,請將此欄位設定為 5。 若要指定 9.8% 的速率,請將此字段設定為 9.8。 | 雙精度浮點數 | <率> |
地區 | 取得或設定適用其稅率的地理區域。 | String | <地區> |
taxShip | 取得或設定布爾值,決定是否要將稅金套用至出貨成本。 如果在出貨時需支付稅金,請將 設定為 true 。 | 布林值 | <船> |
UnitPricing
定義專案的每一單價。
名稱 | 值 | 類型 | XML 項目名稱 |
---|---|---|---|
單位 | 取得或設定量值的單位。 例如,如果價格是每一盎司,則為 四 分之一。 | String |
unit 屬性。例如, <unit_pricing_measure unit=“oz”> |
數值 | 取得或設定每個單位的價格。 | 雙精度浮點數 | 文字值。 例如, <unit_pricing_measure unit=“oz”>34.5<\unit_pricing_measure> |
警告
定義警告訊息。
名稱 | 值 | 類型 | XML 項目名稱 |
---|---|---|---|
網域 | 僅限內部使用。 | String | <域> |
訊息 | 警告的描述。 | String | <internalReason> |
reason | 供應項目產生警告的原因。 例如,當製造商已知已指派標識符時,您並未提供 (gtin、 mpn 或 品牌) 的識別符。 | String | <原因> |
HTTP 狀態碼
要求可能會傳回下列 HTTP 狀態代碼。
狀態碼 | 描述 |
---|---|
200 | 成功。 |
204 | 已成功刪除產品。 |
400 | 不正確的要求。 查詢參數值無效,或要求本文中的某個項目無效。 Batch:如果發生錯誤,失敗的批次專案將會包含錯誤。 |
401 | 未經授權。 用戶的認證無效。 |
404 | 找不到。 |
409 | 衝突。 無法完成作業,因為與資源的目前狀態發生衝突。 |
413 | 要求實體太大。 要求的大小超過允許的最大值。 |
500 | 伺服器錯誤。 |