ProductStatuses 資源

發行項
11/13/2024

注意事項

Store 資源僅供封閉式 Beta 參與者使用。如需參與封閉式 Beta 或 open-Beta 計畫的相關資訊，請連絡您的帳戶管理員。

在 Beta 期間，所有 Store 程式設計項目和檔都可能會變更。

使用 ProductStatuses 資源來取得市集中產品供應專案的狀態。

基底 URI

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

https://content.api.ads.microsoft.com/v9.1/bmc

例如，若要取得商店中產品供應專案狀態的摘要檢視，請使用下列端點：

https://content.api.ads.microsoft.com/v9.1/bmc/stores/{merchantId}/productstatusessummary

範本

這些是您附加至基底 URI 以建立 HTTP 端點的範本。

/stores/{merchantId}/productstatusessummary

HTTP 動詞	描述	資源
Get	取得商店中產品供應專案狀態的摘要檢視。服務會傳回市集中已核准、核准和到期的供應專案數目。設定 `{merchantId}` 為存放區的識別碼，以從中取得狀態。從供應專案的狀態變更到在摘要檢視中反映的時間，最多可能需要兩小時的時間。	要求：N/A 回應： ProductStatusesSummary

/stores/{merchantId}/productstatuses

HTTP 動詞	描述	資源
Get	取得商店中產品供應專案狀態的詳細資料檢視。只有狀態為 [已核准] 或 [警告] 的產品才會傳回詳細資料。設定 `{merchantId}` 為您要從中取得狀態的存放區識別碼。 max-results查詢參數會決定服務傳回的供應專案數目。若要逐頁查看所有供應專案，請使用接續權杖查詢參數。	要求：N/A 回應： ProductStatuses

查詢參數

要求可能包含下列查詢參數：

參數	說明
max-results	選用。使用來指定清單要求中要傳回的專案數目上限，例如 `/stores/{merchantId}/productstatuses` 。您可以指定的最大值為 250。預設值為 25。
continuation-token	選用。使用逐頁查看商店的產品狀態清單。權杖會識別要傳回的產品狀態下一頁。請勿在第一個清單要求中指定此參數。如果商店包含超過要求的產品數目 (請參閱 max-results 查詢參數) ，則回應會包含字 `nextPageToken` 段。在下一個要求中，將接續權杖設定為中的 `nextPageToken` 權杖值。

標題

以下是要求和回應標頭。

頁首	說明
AuthenticationToken	要求標頭。將此標頭設定為 OAuth 存取權杖。如需取得存取權杖的資訊，請參閱驗證您的認證。
Content-Type	要求標頭。所有 POST 要求都必須指定此標頭，而且必須設定為 `application/json` 。
CustomerAccountId	要求標頭。您代表標頭中指定的客戶所管理之任何帳戶的 `CustomerId` 帳戶識別碼。您指定的帳號並不重要。只有在您代表客戶管理帳戶時，才指定此標頭。
CustomerId	要求標頭。您管理其存放區之客戶的客戶識別碼。只有在您代表客戶管理市集時，才指定此標頭。如果您設定此標頭，也必須設定 `CustomerAccountId` 標頭。
DeveloperToken	要求標頭。用戶端應用程式的開發人員權杖。每個要求都必須包含此標頭。如需取得權杖的相關資訊，請參閱您是否有 Microsoft Advertising 認證和開發人員權杖？
WebRequestActivityId	回應標頭。包含要求詳細資料的記錄專案識別碼。如果發生錯誤，您應該一律擷取此識別碼。如果您無法判斷並解決問題，請包含此識別碼以及您提供支援小組的其他資訊。

要求和回應物件

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

物件	描述
錯誤	定義錯誤。
ErrorResponse	定義最上層錯誤物件。
ProductStatus	定義產品供應專案的狀態。
ProductStatuses	定義有問題的產品供應專案清單。
ProductStatusesSummary	定義商店中產品供應專案狀態的摘要檢視。
ProductStatusItemLevelIssue	定義產品供應專案的問題。

錯誤

定義錯誤。

名稱	值	類型
code	要求失敗的原因。	字串
訊息	錯誤的描述。	字串

ErrorResponse

定義最上層錯誤物件。

名稱	值	類型
錯誤	處理要求時發生的錯誤清單。	Error[]

ProductStatus

定義產品供應專案的狀態。

名稱	值	類型
creationDate	建立產品供應專案的日期和時間。	日期時間
expirationDate	產品供應專案設定為到期的日期和時間。	日期時間
itemLevelIssues	產品供應專案的問題清單。	ProductStatusItemLevelIssue[]
lastUpdateDate	上次更新產品供應專案的日期和時間。	日期時間
productId	產品的識別碼。	字串
狀態	產品的核准狀態。可能的值為：反對警告未提供未經核准的產品。警告表示產品有您應該解決的問題，但不會阻止產品供應專案提供服務。您應該修正問題並重新提交產品供應專案。	字串
title	產品的標題	字串

ProductStatuses

定義有問題的產品供應專案清單。

名稱	值	類型
nextPageToken	如果有更多產品供應專案可供取得，則要將接續權杖查詢參數設定為的權杖。	字串
資源	有問題的產品供應專案清單。 max-results查詢參數會決定清單中的供應專案數目上限;傳回的實際數目可能較少。	ProductStatus[]

ProductStatusesSummary

定義商店中產品供應專案狀態的摘要檢視。如果剛建立存放區，則所有值都會是零。

名稱	值	類型
批准	商店中已核准的產品總數。	整數
反對	商店中因錯誤而取消核准的產品總數。	整數
到期	商店中將在未來 72 小時內到期的產品總數。	整數
商家識別碼	產品存放區的識別碼。	不帶正負號的長
等待	擱置檢閱的產品總數。	整數

ProductStatusItemLevelIssue

定義產品供應專案的問題。

名稱	值	類型
attributeName	造成問題的產品供應專案屬性名稱。並非所有問題都會識別屬性。例如，如果問題是由多個屬性所造成，則物件不會包含此欄位。	字串
code	識別問題的錯誤碼。例如，TitleTooLongErr。	字串
描述	說明屬性問題的描述。	字串
可保留性	值，指出問題是否阻止供應專案提供服務。可能的值為：反對未受影響如果未核准，供應專案將不會提供服務。	字串

HTTP 狀態碼

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

狀態碼	描述
200	成功。
400	不正確的要求。最有可能的要求會指定不正確查詢參數或參數值。
401	未經授權。使用者的認證無效。
404	找不到。找不到要求的存放區。
500	伺服器錯誤。

錯誤碼

要求可能會傳回下列錯誤碼。

錯誤碼	描述
ContinuationTokenInvalidErr	接續權杖查詢參數值無效。請務必使用 ProductStatuses 物件欄位中的值來設定參數 `nextPageToken` 。

共用方式為