インベントリ リソース
注:
Inventory API は、クローズド パイロット参加者のみが使用できます。 API とドキュメントは変更される可能性があります。
インベントリ リソースを使用すると、Microsoft Merchant Center (MMC) ストアの製品の価格と可用性を更新できます。 インベントリ リソースの使用については、「 製品価格の更新」を参照してください。 価格と可用性を更新する方法を示す例については、「 コード例」を参照してください。
ベース URI
テンプレートを追加するベース URI を次に示します。
https://content.api.bingads.microsoft.com/shopping/v9.1
テンプレート
製品オファリングの更新に使用するエンドポイントを作成するには、ベース URI に適切なテンプレートを追加します。
テンプレート | HTTP 動詞 | 説明 |
---|---|---|
/bmc/{mmcMerchantId}/inventory/batch | POST | を使用して、1 つの要求で複数の製品価格更新プログラムを実行します。 MMC ストア ID に設定 {mmcMerchantId} します。要求オブジェクト: Batch 応答オブジェクト: Batch |
/bmc/{mmcMerchantId}/inventory/{storeCode}/products/{productUniqueId} | POST | を使用して、1 つの製品の価格と可用性を更新します。 MMC ストア ID に設定 {mmcMerchantId} します。[オンライン] に設定 {storeCode} します。完全修飾製品 ID (たとえば、Online:en:US:Sku123) に設定 {productUniqueId} します。要求オブジェクト: 製品 応答オブジェクト: Product |
クエリ パラメーター
エンドポイントには、次のクエリ パラメーターが含まれる場合があります。
パラメーター | 説明 |
---|---|
dry-run | オプション。 アプリケーションをデバッグして呼び出しをテストするときに使用します。 このパラメーターを含む呼び出しは、運用データには影響しません。 エラーが発生した場合、応答には、データ品質、編集の問題、データベース関連の検証などのセカンダリ エラー メッセージを除き、呼び出しで通常生成されるエラーが含まれます。 アプリケーションのテストの詳細については、「 サンドボックス」を参照してください。 |
ヘッダー
要求ヘッダーと応答ヘッダーを次に示します。
ヘッダー | 説明 |
---|---|
AuthenticationToken | 要求ヘッダー。 このヘッダーを OAuth アクセス トークンに設定します。 アクセス トークンの取得については、「 資格情報の認証」を参照してください。 |
Content-Type | 要求ヘッダーと応答ヘッダー。 要求または応答の本文内のコンテンツの種類。 application/json に設定します。 |
CustomerAccountId | 要求ヘッダー。 ヘッダーで CustomerId 指定された顧客に代わって管理する任意のアカウントのアカウント ID。 指定したアカウントは関係ありません。 このヘッダーは、顧客の代わりにアカウントを管理する場合にのみ指定します。 |
Customerid | 要求ヘッダー。 ストアを管理する顧客の顧客 ID。 このヘッダーは、顧客の代わりにストアを管理する場合にのみ指定します。 このヘッダーを設定する場合は、ヘッダーも設定する CustomerAccountId 必要があります。 |
DeveloperToken | 要求ヘッダー。 クライアント アプリケーションの開発者トークン。 各要求には、このヘッダーを含める必要があります。 トークンの取得の詳細については、「Microsoft Advertising の資格情報と開発者トークンはありますか?」を参照してください。 |
場所 | 応答ヘッダー。 更新された製品の URL。 |
WebRequestActivityId | 応答ヘッダー。 要求の詳細を含むログ エントリの ID。 エラーが発生した場合は、常にこの ID をキャプチャする必要があります。 問題を特定して解決できない場合は、この ID をサポート チームに提供する他の情報と共に含めます。 |
要求オブジェクトと応答オブジェクト
API で使用される要求オブジェクトと応答オブジェクトを次に示します。
オブジェクト | 説明 |
---|---|
バッチ | バッチ要求で更新する製品の一覧を定義します。 |
Error | エラーを定義します。 |
ErrorResponse | バッチ以外の更新の最上位レベルのエラー オブジェクトを定義します。 |
BatchEntryError | バッチ処理中にアイテムに対して発生したエラーを定義します。 |
エントリ | バッチ要求または応答のエントリを定義します。 |
製品 | 製品を定義します。 |
ProductPrice | 製品の価格を定義します。 |
バッチ
バッチで更新する製品の一覧を定義します。
名前 | 値 | 型 |
---|---|---|
エントリ | バッチで更新する製品の一覧。 指定できる製品の最大数は 400 です。 | Entry[] |
BatchEntryError
バッチ処理中にエントリに対して発生したエラーを定義します。
名前 | 値 | 型 |
---|---|---|
エラー | エントリの処理中に発生したエラーの一覧。 | エラー[] |
code | エラーの HTTP 状態コード。 | String |
message | エラーに関連付けられているメッセージ。 | String |
エラー
エラーを定義します。
名前 | 値 | 型 |
---|---|---|
domain | 内部使用のみ。 | String |
message | エラーの説明。 | String |
理由 | 要求が失敗した理由。 たとえば、製品の検証に失敗しました。 | String |
ErrorResponse
1 つの製品更新プログラムの最上位のエラー オブジェクトを定義します。
名前 | 値 | 型 |
---|---|---|
error | アイテムの処理中に発生したエラーの一覧。 | エラー[] |
エラー
製品のエラーの一覧を定義します。
名前 | 値 | 型 |
---|---|---|
エラー | エントリの処理中に発生したエラーの一覧。 | エラー[] |
code | エラーの HTTP 状態コード。 | String |
message | エラーに関連付けられているメッセージ。 | String |
エントリ
バッチ要求のエントリを定義します。
名前 | 値 | 型 |
---|---|---|
batchId | バッチ要求でこのエントリを一意に識別するユーザー定義 ID。 たとえば、バッチに 10 個のエントリが含まれている場合は、ID を 1 から 10 に割り当てることができます。 | 符号なし整数 (Unsigned Integer) |
エラー | 発生した検証エラーの一覧を含む error オブジェクト。 応答には、エラーが発生した場合にのみこのフィールドが含まれます。 | BatchEntryError |
inventory | 更新された価格と可用性。 | 製品 |
merchantId | Merchant Center ストア ID。 URL にはストア ID が含まれているため、このフィールドは無視されます。 | Unsigned Long |
Productid | 更新する製品の完全修飾製品 ID (たとえば、Online:en:US:Sku123)。 同じ製品 ID を持つ複数のエントリを含めないでください。 | String |
storeCode | 更新するストアを識別するコード。 オンラインに設定すると、オンライン ストア内の製品の価格と可用性が更新されます。 | String |
製品
製品を定義します。
プロパティ | 説明 | 型 | 必須 |
---|---|---|---|
可用性 | 製品の可用性。 使用可能な値:
|
String | はい |
kind | オブジェクトの型。 content#inventory に設定します。 | String | いいえ |
価格 | 製品の新しい価格。 対象の国または地域の通貨で価格を指定します。 価格に税金を含めるかどうかの詳細については、「 Microsoft Merchant Center カタログ税ポリシー」を参照してください。 価格は、製品の Web ページに表示される価格と一致し、0.01 (1 セント) から 10000000.00 (1000 万) の範囲である必要があります。 ただし、次の条件が満たされた場合は、価格を 0.0 (ゼロ) に設定できます。
|
ProductPrice | はい |
salePrice | 製品の販売価格。 販売品目の場合は、販売価格と販売有効日の両方を設定します (を参照)。salePriceEffectiveDate セール価格を設定したが、セール価格の有効日を設定しない場合、販売価格は製品の有効期限が切れるか、有効日を設定するまで引き続き使用されます。販売価格は、0.01 (1 セント) から 10000000.00 (1,000 万) の範囲である必要があります。 ただし、次の条件が満たされた場合は、販売価格を 0.0 (ゼロ) に設定できます。
|
ProductPrice | 不要 |
salePriceEffectiveDate | 販売の UTC 開始日と終了日。 を設定 salePrice した場合にのみ日付を指定します。開始日と終了日を ISO 8601 形式で指定します。 たとえば、2016-04-05T08:00-08:00/2016-04-10T19:30-08:00 (開始日と終了日を区切るためにスラッシュ ('/') を使用します)。 詳細については、 salePrice を参照してください。指定しない場合、現在の販売日がオファーから削除されます。 null を渡さないでください。 |
String | いいえ |
ProductPrice
製品の価格または販売価格を定義します。
名前 | 値 | 型 |
---|---|---|
通貨 | 価格が記載されている通貨。 使用可能な値:
|
String |
値 | 製品の価格。 | 倍精度浮動小数点数 |
HTTP 状態コード
要求は、次の HTTP 状態コードを返す場合があります。
状態コード | 説明 |
---|---|
200 | 成功 |
400 | 要求が正しくありません。 クエリ パラメーターの値が無効であるか、要求本文の何かが無効です。 エラーが発生した場合、失敗したバッチ エントリにはエラーが含まれます。 |
401 | 権限がありません。 ユーザーの資格情報が無効です。 |
403 | 禁止。 ユーザーには、リソースを使用するためのアクセス許可がありません。 |
404 | 見つかりません。 |
409 | 競合。 リソースの現在の状態と競合するため、操作を完了できませんでした。 |
413 | 要求エンティティが大きすぎます。 要求のサイズが許可される最大サイズを超えています。 |
500 | サーバー エラー。 |