共用方式為

目錄資源

  • 發行項

目錄資源可讓您在 Microsoft 商家中心商店中管理目錄， (MMC) 。 如需使用目錄資源的相關資訊，請 參閱管理您的目錄。 如需示範如何新增、刪除和取得目錄的範例，請參閱 程式碼範例。

基底 URI

以下是您附加範本的基底 URI。

https://content.api.bingads.microsoft.com/shopping/v9.1/bmc/

範本

若要建立用來管理目錄的端點，請將適當的範本附加至基底 URI。

[範本] HTTP 動詞 描述 資源
{mmcMerchantId}/catalogs POST 使用 將目錄新增至存放區。 若要新增目錄，其名稱必須是唯一的。 您最多可以將 100 個目錄新增至存放區。

設定 {mmcMerchantId} 為 MMC 存放區識別碼。		 要求： 目錄
回應： 目錄
{mmcMerchantId}/catalogs/{catalogId} 把 使用 更新存放區中的目錄。 您唯一可以更新的 name 欄位是 和 isPublishingEnabled 欄位，而且您必須同時指定兩者。

設定 {mmcMerchantId} 為 MMC 存放區識別碼。		 要求： 目錄
回應： 目錄
{mmcMerchantId}/catalogs/{catalogId} 刪除 使用 從存放區刪除目錄。

設定 {mmcMerchantId} 為 MMC 存放區識別碼。

設定 {catalogId} 為目錄的識別碼。		 要求：N/A
回應：N/A
{mmcMerchantId}/catalogs/{catalogId} GET 使用 從存放區取得目錄。

設定 {mmcMerchantId} 為 MMC 存放區識別碼。

設定 {catalogId} 為目錄的識別碼。		 要求：N/A
回應： 目錄
{mmcMerchantId}/catalogs GET 使用 從存放區取得目錄清單。

設定 {mmcMerchantId} 為 MMC 存放區識別碼。		 要求：N/A
回應： 目錄

查詢參數

端點可能包含下列查詢參數。

參數 說明
Alt 選用。 使用 來指定要求和回應中所使用的內容類型。 可能的值為 json 和 xml 。 預設值為 json 。

標題

以下是要求和回應標頭。

頁首 說明
AuthenticationToken 要求標頭。

將此標頭設定為 OAuth 驗證權杖。 如需取得權杖的相關資訊，請參閱 驗證您的認證。
Content-Location 回應標頭。

URL，識別已插入目錄的存放區。 此標頭包含在 Insert 要求的回應中。
CustomerAccountId 要求標頭。

您代表標頭中指定的客戶所管理之任何帳戶的 CustomerId 帳戶識別碼。 您指定的帳號並不重要。 只有在您代表客戶管理帳戶時，才指定此標頭。
CustomerId 要求標頭。

您管理其存放區之客戶的客戶識別碼。 只有在您代表客戶管理市集時，才指定此標頭。 如果您設定此標頭，也必須設定 CustomerAccountId 標頭。
DeveloperToken 要求標頭。

用戶端應用程式的開發人員存取權杖。 每個要求都必須包含此標頭。 如需取得權杖的相關資訊，請參閱 您是否有 Microsoft Advertising 認證和開發人員權杖？
位置 回應標頭。

URL，識別已插入目錄的存放區。 此標頭包含在 Insert 要求的回應中。
WebRequestActivityId 回應標頭。

包含要求詳細資料的記錄專案識別碼。 如果發生錯誤，您應該一律擷取此識別碼。 如果您無法判斷並解決問題，請包含此識別碼以及您提供支援小組的其他資訊。

要求和回應物件

以下是 API 所使用的要求和回應物件。

每個物件都會根據您為要求指定的內容類型，定義您使用的 JSON 金鑰名稱和 XML 專案名稱。

物件 描述
類別目錄 定義目錄。
目錄 定義目錄清單。

類別目錄

定義目錄。

名稱 值 類型 XML 專案名稱
Id 可唯一識別存放區中目錄的識別碼。

此欄位是唯讀的;請勿設定此欄位。		 Unsigned Long <Id>
isDefault 布林值，決定目錄是否為存放區的預設目錄。 如果目錄是存放區的預設目錄，則為 true ;否則為 false。

當您建立商店時，如果您未指定另一個目錄，則會取得產品要寫入的預設目錄。

此欄位是唯讀的;請勿設定此欄位。		 布林值 <is_default>
isPublishingEnabled 布林值，決定 Microsoft 是否可以從目錄發佈產品。 如果 Microsoft 可以從目錄發佈產品，則設定為 true ;否則，請將它設定為 false。

您可以更新此欄位。

您也可以使用此欄位來測試應用程式，再將它部署到生產環境。 藉由將此欄位設定為 false，您可以進行 產品資源 呼叫，而不需要變更或發佈生產資料。		 布林值 <is_publishing_enabled>
市場 發行目錄中產品所在的市場。

注意： 並非每個人都有這項功能。 如果沒有，別擔心，它很快就會推出！。

以下是您可以指定的可能市場。
  • 馬來西巴 (sq-AL)
  • Andorra，法文 (fr-AD)
  • 阿根廷，西班牙 (es-AR)
  • Aruba，英文 (en-AW)
  • 澳洲，英文 (en-AU)
  • 奧地利，德國 (de-AT)
  • 巴哈馬，英文 (en-BS)
  • 孟加拉國，英文 (en-BD)
  • 比利時，荷蘭 (nl-BE)
  • 比利時，法 (fr-BE)
  • 菲律賓，西班牙 (es-BO)
  • 波士尼亞-赫塞哥維納、波士尼亞 (bs-BA)
  • 巴西、葡萄牙 (pt-BR)
  • 汶萊，英文 (en-BN)
  • 保加利亞，保加利亞 (bg-BG)
  • 加拿大，英文 (en-CA)
  • 加拿大、法 (fr-CA)
  • 開曼群島、英文 (en-KY)
  • 智利，西班牙 (es-CL)
  • 哥倫比亞，西班牙 (es-CO)
  • 波多黎各，西班牙 (es-CR)
  • 克羅埃西亞、克羅埃西亞 (hr-HR)
  • 馬來文、英文 (en-CY)
  • 希臘文，希臘 (el-CY)
  • 捷克，捷克 (cs-CZ)
  • 丹麥、丹麥 (da-DK)
  • 多國，英文 (-DM)
  • 西班牙共和國，西班牙 (es-DO)
  • 厄瓜多，西班牙 (es-EC)
  • El Spanish，西班牙 (es-SV)
  • 愛沙尼亞、愛沙尼亞 (et-EE)
  • 隨即 (-FJ)
  • 芬蘭、芬蘭 (fi-FI)
  • 法國，英文 (en-FR)
  • 法國、法 (fr-FR)
  • 法屬 guiana、法 (fr-GF)
  • 法屬 Polynesia、法 (fr-PF)
  • 德國，英文 (en-DE)
  • 德國、德國 (de-DE)
  • 希臘，英文 (en-GR)
  • 希臘、希臘 (el-GR)
  • 關島，英文 ()
  • 西班牙文 (es-GT)
  • 蓋亞納，英文 (GY)
  • 荷蘭，法 (fr-HT)
  • 西班牙文 (西班牙文 es-HN)
  • 香港特別行政區，繁體中文 (zh-HK)
  • 匈牙利，英文 (en-HU)
  • 匈牙利，匈牙利 (hu-HU)
  • 作為 is-IS (的冰島 ()
  • 印度，英文 (en-IN)
  • 印尼，英文 (en-ID)
  • 愛爾蘭，英文 (en-IE)
  • 義大利，英文 (en-IT)
  • 義大利，義大利 (it-IT)
  • 日本、日本 (ja-JP)
  • 拉脫維亞，拉脫維亞文 (lv-LV)
  • 列支敦斯登，德文 (de-LI)
  • 立陶宛，立陶宛 (lt-LT)
  • 荷蘭，法 (fr-LU)
  • 德國的盧森堡 (de-LU)
  • 馬來西亞，英文 (en-MY)
  • Maldives、英文 (en-MV)
  • 馬來，馬特斯 (mt-MT)
  • Martinique，法文 (fr-MQ)
  • 墨西哥，西班牙 (es-MX)
  • 南非，法 (fr-MC)
  • 蒙古文、英文 (en-MN)
  • 蒙特內哥羅，英文 (en-ME)
  • 塞爾維亞文，塞爾維亞 (sr-ME)
  • Montserrat、英文 (en-MS)
  • 尼泊爾，英文 (en-NP)
  • 荷蘭，荷蘭 (nl-NL)
  • 荷蘭，英文 (el-NL)
  • 新卡裡多尼亞，法 (fr-NC)
  • 紐西蘭，英文 (NZ)
  • 北馬其頓，馬其頓 (mk-MK)
  • 挪威，挪威 (nb-NO)
  • 菲律賓，西班牙 (es-PA)
  • 巴布亞紐幾內亞，英文 (en-PG)
  • 菲律賓，西班牙 (es-PY)
  • 秘魯，西班牙 (es-PE)
  • 身分識別，英文 (，en-PH)
  • 波蘭、波蘭 (pl-PL)
  • 葡萄牙，葡萄牙 (pt-PT)
  • 波多黎各，西班牙 (es-PR)
  • 羅馬尼亞、羅馬尼亞 (ro-RO)
  • 聖馬利諾，英文 (en-SM)
  • 聖馬利諾，義大利 (it-SM)
  • 塞爾維亞，英文 (en-RS)
  • 塞爾維亞，塞爾維亞 (sr-RS)
  • 新加坡，英文 (en-SG)
  • 斯洛伐克，英文 (en-SK)
  • 斯洛伐克，斯洛伐克 (sk-SK)
  • 斯洛維尼亞，斯洛維尼亞 (sl-SI)
  • 南非，英文 (en-ZA)
  • 西班牙，英文 (en-ES)
  • 西班牙，西班牙 (es-ES)
  • 印度，英文 (LK)
  • 瑞典，英文 (en-SE)
  • 瑞典，瑞典 (sv-SE)
  • 瑞士，德國 (de-CH)
  • 瑞士，法 (fr-CH)
  • 臺灣，繁體中文 (zh-TW)
  • 泰國，英文 (TH)
  • Trinidad 和 Tobago、英文 (en-TT)
  • Türkiye，土耳其文 (tr-TR)
  • 英國，英文 (GB)
  • 美國、英文 (en-US)
  • 美國，西班牙 (es-US)
  • 西班牙文、西班牙文 (es-UY)
  • 義大利 (義大利文城市/VA)
  • 委內瑞拉，西班牙 (es-VE)
  • 越南、英文 (en-VN)
您新增至目錄的所有產品都必須指定相同的市場 (請參閱 contentLanguage 和 targetCountry) 。

將目錄新增至存放區之後，您可能不會更新此欄位。

在上述清單中，de-DE 是您指定的市場值;請勿在您的市場字串中包含 (德) 。		 字串 <市場>
名字 目錄的名稱。 名稱最多可包含 70 個字元。

您可以更新此欄位。		 字串 <名字>

目錄

定義目錄清單。

名稱 值 類型 XML 專案名稱
目錄 存放區中的目錄清單。 Catalog[] <目錄>

HTTP 狀態碼

要求可能會傳回下列 HTTP 狀態碼。

狀態碼 描述
200 成功。
201 已成功新增目錄。
204 已成功刪除目錄。
400 不正確的要求。 查詢參數值無效，或要求本文中的某個專案無效。
401 未經 授權。 使用者的認證無效。
404 找不到。
500 伺服器錯誤。