共用方式為


狀態資源

狀態資源可讓您取得上傳至指定目錄的產品供應專案狀態。 將供應專案上傳至目錄之後,它們會經歷驗證和編輯檢閱程式。 此程式最多可能需要 36 小時。 只有在完成檢閱程式之後,供應專案才會包含在報表中。

如需程式運作方式的概觀,請 參閱如何取得產品供應專案的狀態?

如需示範如何取得目錄狀態和下載報表的程式碼範例,請參閱 下載目錄狀態報表

基底 URI

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

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

範本

若要建立用來取得目錄中產品供應專案狀態的端點,請將適當的範本附加至基底 URI。

注意事項

{bmcMerchantId}/catalogs/{catalogId}/status 已被取代,我們不建議使用它。

[範本] HTTP 動詞 描述 資源
{bmcMerchantId}/catalogs/{catalogId}/status GET 使用 取得通過或失敗驗證和編輯檢閱的上傳供應專案數目。

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

設定 {catalogId} 為目錄的識別碼。
要求:N/A
回應: 狀態

查詢參數

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

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

標題

以下是要求和回應標頭。

頁首 說明
Accept 要求標頭。 <p > 下載報表時包含此標頭。 您必須將此標頭設定為 application/x-zip-compressed
AuthenticationToken 要求標頭。

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

URL,識別產品插入的存放區。 此標頭包含在 Insert 要求的回應中。
CustomerAccountId 要求標頭。

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

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

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

URL,識別產品插入的存放區。 此標頭包含在 Insert 要求的回應中。
WebRequestActivityId 回應標頭。

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

要求和回應物件

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

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

物件 描述
狀態 定義已上傳至目錄的產品供應專案狀態。

狀態

定義已上傳至目錄的產品供應專案狀態。 物件的 XML 名稱是 < catalogStatus > 。

名稱 類型 XML 專案名稱
catalogId 所報告目錄的識別碼。 ulong <catalog_id>
publishedCount 通過驗證和編輯檢閱的供應專案數目。 ulong <published_count>
rejectedCount 驗證和編輯檢閱失敗的供應專案數目。 此計數表示報表本文中的資料列數目 (請參閱 報表格式) 。 ulong <rejected_count>
rejectionReportUrl 您用來下載報表的 URL。 只有在 大於零時 rejectedCount ,物件才會包含此欄位。

報表已壓縮,必須先解壓縮,才能讀取。
字串 <catalog_id>

HTTP 狀態碼

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

狀態碼 描述
200 成功。
400 不正確的要求。 查詢參數值無效,或報表 URL (看到 拒絕ReportUrl) 不再有效。
401 未經 授權。 使用者的認證無效。
404 找不到。 狀態不適用於指定的目錄,或目錄或存放區識別碼無效。
500 伺服器錯誤。

報表格式

您下載的報表檔案包含在 Zip 壓縮資料夾 (*.zip) 中。 您必須先解壓縮資料夾及其內容,才能讀取報表。 報表是名為 MerchantCatalogReport.csv 的逗號分隔檔案。

報表分成標頭區段和報表主體區段。 第一個資料列包含標頭區段的下列資料行名稱。

欄名稱 說明
目錄名稱 目錄的名稱。
目錄識別碼 目錄的識別碼。
市集識別碼 包含目錄之存放區的識別碼。
上傳時間 請勿使用。 如果此欄位存在,請忽略它。

第二個數據列包含標頭資料。

第三個數據列是空白的。

第四個數據列包含報表主體的下列資料行名稱,從第五列開始。

欄名稱 說明
專案識別碼 驗證或編輯檢閱失敗之供應專案的 offerId 。 報表將包含唯一識別碼。
郵件 所報告的錯誤。
類型 錯誤的類型。 可能的值為 Error 或 Warning。
造成錯誤的資料值,如果錯誤是由不正確值所造成。
供應專案程式碼片段 以分號分隔的供應專案資料子集清單。 格式為 title;productType;link;imageLink;price;salePrice;saleStartDate;saleEndDate。 並非所有錯誤都會包含所有元件。

如需報表的範例,請參閱 範例報表