存放區資源
注意事項
Store 資源僅供封閉式 Beta 參與者使用。 如需參與封閉式 Beta 或 open-Beta 計畫的相關資訊，請連絡您的帳戶管理員。
在 Beta 期間，所有 Store 程式設計項目和檔都可能會變更。
使用 Store 資源來管理使用者所擁有的存放區。 您可以新增商店、取得特定的存放區，或取得使用者擁有的所有商店。 閱讀其他資訊。
基底 URI
以下是您附加 範本 的基底 URI。
https://content.api.ads.microsoft.com/v9.1/bmc
例如，若要新增存放區或取得使用者所擁有的商店清單，請使用下列端點：
https://content.api.ads.microsoft.com/v9.1/bmc/stores
範本
這些是您附加至 基底 URI 以建立 HTTP 端點的範本。
/stores 範本
| HTTP 動詞 | 描述 | 資源 |
|---|---|---|
| 發佈 | 新增存放區。 下列限制適用且可能會變更：
|
要求： StoreCreate 回應： 存放區 |
| GET | 取得使用者擁有的存放區清單。 | 要求：N/A 回應： StoreCollection |
/stores/{merchantId} 範本
| HTTP 動詞 | 描述 | 資源 |
|---|---|---|
| GET | 取得指定的存放區。 設定 {merchantId} 為您想要取得之存放區的識別碼。 |
要求：N/A 回應： 存放區 |
查詢參數
要求可能包含下列查詢參數：
| 參數 | 說明 |
|---|---|
| dry-run | 選用。 使用 來測試或偵錯您的應用程式。 包含此參數的呼叫不會影響生產資料， (存放區不會新增) ;不過，回應會包含呼叫所產生的任何錯誤。 使用此參數時，請考慮下列限制。
|
標題
以下是要求和回應標頭。
| 頁首 | 說明 |
|---|---|
| AuthenticationToken | 要求標頭。 將此標頭設定為 OAuth 存取權杖。 如需取得存取權杖的資訊，請參閱 驗證您的認證。 |
| Content-Type | 要求標頭。 所有 POST 要求都必須指定此標頭，而且必須設定為 application/json 。 |
| CustomerAccountId | 要求標頭。 您代表標頭中指定的客戶所管理之任何帳戶的 CustomerId 帳戶識別碼。 您指定的帳號並不重要。 只有在您代表客戶管理帳戶時，才指定此標頭。 |
| CustomerId | 要求標頭。 您管理其存放區之客戶的客戶識別碼。 只有在您代表客戶管理市集時，才指定此標頭。 如果您設定此標頭，也必須設定 CustomerAccountId 標頭。 |
| DeveloperToken | 要求標頭。 用戶端應用程式的開發人員權杖。 每個要求都必須包含此標頭。 如需取得權杖的相關資訊，請參閱 您是否有 Microsoft Advertising 認證和開發人員權杖？ |
| WebRequestActivityId | 回應標頭。 包含要求詳細資料的記錄專案識別碼。 如果發生錯誤，您應該一律擷取此識別碼。 如果您無法判斷並解決問題，請包含此識別碼以及您提供支援小組的其他資訊。 |
要求和回應物件
以下是 API 所使用的要求和回應物件。
| 物件 | 描述 |
|---|---|
| 錯誤 | 定義錯誤。 |
| ErrorResponse | 定義最上層錯誤物件。 |
| Store | 在 Microsoft 商家中心定義存放區。 |
| StoreCollection | 定義 Microsoft 商家中心內的商店集合。 |
| StoreCreate | 定義要新增至 Microsoft 商家中心的存放區。 |
| StoreStatus | 定義存放區的狀態。 |
錯誤
定義錯誤。
| 名稱 | 值 | 類型 |
|---|---|---|
| code | 要求失敗的原因。 例如，如果 storeName 欄位驗證失敗，則程式碼為 InvalidStoreNameErr。 |
字串 |
| 訊息 | 錯誤的描述。 | 字串 |
ErrorResponse
定義最上層錯誤物件。
| 名稱 | 值 | 類型 |
|---|---|---|
| 錯誤 | 處理要求時發生的錯誤清單。 | Error[] |
儲存區
在 Microsoft 商家中心定義存放區。
| 名稱 | 值 | 類型 |
|---|---|---|
| isBlockAggregator | 布林值，指出您是否要防止匯總者從您的市集提供任何廣告。 匯總工具會合並來自多個通常不相關之企業的產品供應專案。 根據預設，匯總者可以在廣告中包含您的目錄。 如果您想要防止產品顯示在 Bing 的匯總工具廣告中，則 為 true 。 如果您有兩個存放區 (一個存放區美國一個存放區，另一個存放區則適用于使用 http://www.contoso.com 該存放區的英國) ，而其中一個商店會封鎖匯總工具，則兩者都會儲存區塊匯總工具。 |
布林值 |
| isSslCheckout | 布林值，指出您的存放區是否已啟用 SSL。 所有存放區都必須有 SSL 登入和結帳頁面。 如果商店的網站已啟用 SSL，則為 true 。 | 布林值 |
| 商家識別碼 | 存放區的識別碼。 | 不帶正負號的長 |
| notificationEmail | 要接收通知電子郵件的收件者清單。 電子郵件會在市集獲得核准或存放區發生驗證錯誤時通知您。 | String[] |
| notificationLanguage | 用來撰寫通知電子郵件的語言。 語言的格式 < 為 language-country >< /region > 。 例如，en-US。 | 字串 |
| storeDescription | 描述存放區的使用方式。 | 字串 |
| storeName | 存放區的名稱。 | 字串 |
| storeStatus | 存放區的狀態。 | StoreStatus |
| storeUrl | 存放區的目的地 URL。 目的地 URL 是使用者在按一下您的廣告時會導向的網頁。 | 字串 |
StoreCollection
定義存放區清單。
| 名稱 | 值 | 類型 |
|---|---|---|
| 商店 | 使用者所擁有的存放區清單。 | Store[] |
StoreCreate
定義要新增至 Microsoft 商家中心的存放區。
| 名稱 | 值 | 類型 | 必要 |
|---|---|---|---|
| isBlockAggregator | 布林值，指出您是否要防止匯總者從您的市集提供任何廣告。 匯總工具會合並來自多個通常不相關之企業的產品供應專案。 根據預設，匯總者可以在廣告中包含您的目錄。 設定為 true 可防止您的產品顯示在 Bing 上匯總工具的廣告中。 如果您有兩個存放區 (一個存放區美國一個存放區，另一個存放區則適用于使用 http://www.contoso.com 該存放區的英國) ，而其中一個商店會封鎖匯總工具，則兩者都會儲存區塊匯總工具。 預設為 false。 |
布林值 | 否 |
| isSslCheckout | 布林值，指出您的存放區是否已啟用 SSL。 所有存放區都必須有 SSL 登入和結帳頁面。 如果您的商店網站已啟用 SSL，請設定為 true 。 如果 為 false ，則表示不核准存放區。 預設為 true。 |
布林值 | 否 |
| notificationEmail | 要接收通知電子郵件的收件者清單。 電子郵件會在市集獲得核准或存放區發生驗證錯誤時通知您。 您可以指定的電子郵件地址數目上限為 14。 | String[] | 是 |
| notificationLanguage | 用來撰寫通知電子郵件的語言。 語言的格式 < 為 language-country >< /region > 。 以下是您可能指定的不區分大小寫值。
|
字串 | 是 |
| storeDescription | 描述存放區的使用方式。 描述限制為最多 350 個字元，且只能包含英數位元 ([a-zA-Z0-9]) 。 | 字串 | 否 |
| storeName | 存放區的名稱。 因為商店的名稱會出現在您的產品廣告中，所以請務必使用正確代表您網站的名稱。 名稱必須：
|
字串 | 是 |
| storeUrl | 存放區的目的地 URL。 目的地 URL 是使用者在按一下您的廣告時會導向的網頁。 URL 不得重新導向至另一個位置。 URL 的格式必須正確，且最多為 1,024 個字元。 您必須 驗證並宣告網站的 URL。 如果 Microsoft 無法確認您的網站符合 SSL 規範，則商店會遭到停用。 商家網站必須有 SSL 登入和結帳頁面。 確認您的 SSL 憑證有效。 | 字串 | 是 |
StoreStatus
定義存放區的狀態。
| 名稱 | 值 | 類型 |
|---|---|---|
| 訊息 | 不允許存放區的原因。 只有在 [不核准] 時，物件才會 status 包含此欄位。 |
字串 |
| 狀態 | 存放區的狀態。 以下是可能的值。
message 以瞭解原因。最初已自動核准的存放區可能會從 [已核准] 移至 ManualReview。 您無法將產品新增至進行手動檢閱的市集，而且市集中的產品將無法提供服務。 視不核准的原因而定，您可以使用 Microsoft Ads 應用程式來修正問題。 否則，您必須建立具有適當值的新存放區。 |
字串 |
HTTP 狀態碼
要求可能會傳回下列 HTTP 狀態碼。
| 狀態碼 | 描述 |
|---|---|
| 200 | 成功。 |
| 201 | 已成功新增市集。 |
| 400 | 不正確的要求。 POST 要求的本文很可能包含不正確資料或格式不正確。 |
| 401 | 未經 授權。 使用者的認證無效。 |
| 404 | 找不到。 找不到要求的存放區。 |
| 500 | 伺服器錯誤。 |
錯誤碼
要求可能會傳回下列錯誤碼。
| 錯誤碼 | 描述 |
|---|---|
| AdultAdvertiserErr | 成人廣告商可能無法建立商店。 |
| DomainNotOwnedByCustomerErr | 在 storeUrl 欄位中指定的網域不是客戶所擁有。 請確定客戶已確認他們擁有網域。 |
| DuplicateStoreNameErr | 另一個具有指定存放區名稱的存放區存在;Microsoft 商家中心必須是唯一的商店名稱。 |
| ExceededMaxStoresForCustomerErr | 客戶超過他們可能會建立的商店數目。 如需限制，請 參閱新增存放區 POST。 |
| ExceededMaxStoresForDestinationUrlErr | 客戶超過他們可以使用相同目的地 URL 建立的存放區數目。 如需限制，請 參閱新增存放區 POST。 |
| InvalidStoreDescriptionErr | 存放區的描述無效。 如需限制，請參閱 storeDescription。 |
| InvalidStoreDestinationUrlErr | 您在 storeUrl 欄位中指定的存放區目的地 URL 無效。 |
| InvalidStoreNameErr | 存放區的名稱無效。 如需限制，請參閱 storeName。 |
| MarketNotSupportedErr | 您在 notificationLanguage 欄位中指定的市場無效。 |
| NoDomainsFoundForCustomerErr | 客戶沒有已驗證的網域。 |