製品オファーの状態を取得する

[アーティクル]
10/04/2023

注:

ProductStatuses リソースは、クローズドベータ参加者のみが使用できます。クローズドベータプログラムまたはオープンベータプログラムへの参加については、アカウントマネージャーにお問い合わせください。

すべてのストアプログラミング要素とドキュメントは、ベータ期間中に変更される可能性があります。

状態が [不承認] または [警告] に設定されているストア内の製品オファーの一覧を取得するには、製品の状態の取得テンプレートを使用します。

curl -H "AuthenticationToken: <access token goes here>" -H "DeveloperToken: <developer token goes here>"  https://content.api.ads.microsoft.com/v9.1/bmc/stores/12345/productstatuses

応答本文は ProductStatuses オブジェクトです。ストアに[不承認] または [警告] 状態の製品が含まれていない場合、 resources フィールドには空の配列が含まれます。

{
  "resources": []
}

製品の状態が [警告] と [不承認] に設定されている場合の応答を次に示します。 itemLevelIssuesフィールドには、対処する必要がある問題の一覧が含まれています。

{
  "resources": [
    {
      "productId": "online:en:CA:9",
      "title": "Slip Resistant - Shoes For Crews...",
      "status": "Warning",
      "creationDate": "2018-10-08T07:38:00Z",
      "lastUpdateDate": "2020-09-29T14:35:54Z",
      "expirationDate": "2020-10-29T14:35:54Z",
      "itemLevelIssues": [
        {
          "code": "GtinPlusBrandRequiredWarn",
          "description": "Missing one or more identifiers - The Brand and GTIN or Brand and MPN are required.",
          "servability": "Unaffected"
        }
      ]
    },

    . . .

    {
      "productId": "online:en:CA:7",
      "title": "No Slip - Shoes For Crews...",
      "status": "Disapproved",
      "creationDate": "2018-10-08T07:38:00Z",
      "lastUpdateDate": "2020-09-29T14:35:54Z",
      "expirationDate": "2020-10-29T14:35:54Z",
      "itemLevelIssues": [
        {
          "code": "EVRejectedErr",
          "description": "The offer was rejected by the external validation component: EV.",
          "servability": "Disapproved"
        },
        {
          "code": "EV_39",
          "description": "Trademark content",
          "servability": "Disapproved"
        }
      ]
    }
  ]
}

既定では、要求は最大 25 個のオファーを返します。異なる数のオファーを返すには、 max-results クエリパラメーターを含めます。

curl -H "AuthenticationToken: <access token goes here>" -H "DeveloperToken: <developer token goes here>"  "https://content.api.ads.microsoft.com/v9.1/bmc/stores/12345/productstatuses?max-results=5"

状態が [不承認] または [警告] に設定されているオファーの数が 最大結果を超える場合、応答にはフィールドが nextPageToken 含まれます。

{
  "nextPageToken": "W3sidG9rZW4iOm51bGwsInJhbmdlIjp7Im1pbiI6IjA1QzFFNTNEMUYwRjg2IiwibWF4IjoiMDVDMUU1NUIyRDk3NEEifX1d",
  "resources": [...]
}

オファーの次のページを取得するには、次の呼び出しに継続トークンクエリパラメーターを含め、トークンに設定します。

curl -H "AuthenticationToken: <access token goes here>" -H "DeveloperToken: <developer token goes here>"  "https://content.api.ads.microsoft.com/v9.1/bmc/stores/12345/productstatuses?max-results=5&continuation-token=W3sidG9rZW4iOm..."

通常、呼び出し元のパターンは、応答にフィールドが含まれないまで、このテンプレートをループで nextPageToken 呼び出すことです。

製品オファーの概要ステータス数の取得

ProductStatuses リソースは、ストア内の製品オファーの状態の概要ビューを提供します。このビューでは、承認されたオファーと不承認のオファーと、レビューが保留中または期限切れになるオファーが報告されます。

概要ビューを要求するには、概要ビューテンプレートを使用します。ビューの取得元となるストアの ID に設定 {merchantId} します。

curl -H "AuthenticationToken: <access token goes here>" -H "DeveloperToken: <developer token goes here"  https://content.api.ads.microsoft.com/v9.1/bmc/stores/12345/productstatusessummary

応答は ProductStatusesSummary オブジェクトです。

{
  "merchantId":12345,
  "approved":189,
  "expiring":14,
  "disapproved":3,
  "pending":10
}

オファーの状態が変わると、概要ビューに変更が反映されるまでに最大で 2 時間かかることがあります。

Share via

製品オファーの状態を取得する

製品オファーの概要ステータス数の取得

その他のリソース