製品リソース
製品リソースを使用すると、Microsoft Merchant Center ストア (MMC) で製品オファリングを管理できます。 製品リソースの使用については、「 製品の管理」を参照してください。 製品を追加、削除、取得する方法を示す例については、「 コード例」を参照してください。
ベース URI
テンプレートを追加するベース URI を次に示します。
https://content.api.bingads.microsoft.com/shopping/v9.1/bmc/
テンプレート
製品オファリングの管理に使用するエンドポイントを作成するには、ベース URI に適切なテンプレートを追加します。
テンプレート | HTTP 動詞 | 説明 | リソース |
---|---|---|---|
{mmcMerchantId}/products/batch |
POST | を使用して、1 つの要求で複数の挿入 (更新)、取得、および削除を実行します。 バッチには、同じ製品に対して複数のアクションを含めてはなりません。 たとえば、要求で同じ製品の挿入と削除を試みてはいけません。{mmcMerchantId} を MMC ストア ID に設定します。 |
要求: Batch 応答: Batch |
{mmcMerchantId}/products/{productUniqueId} |
DELETE | ストアから 1 つの製品オファリングを削除する場合に使用します。{mmcMerchantId} を MMC ストア ID に設定します。{productUniqueId} を完全修飾製品 ID (たとえば、Online:en:US:Sku123) に設定します。同じ ID の製品を複数のカタログに挿入した場合、その製品はすべてから削除されます。 削除された製品は、配信を停止するまでに最大 12 時間かかることがあります。 削除する前に、製品の可用性を "在庫切れ" に更新することをお勧めします。 |
要求: N/A 応答: N/A |
{mmcMerchantId}/products/{productUniqueId} |
GET | を使用して、ストアから 1 つの製品オファリングを取得します。{mmcMerchantId} を MMC ストア ID に設定します。{productUniqueId} を完全修飾製品 ID (たとえば、Online:en:US:Sku123) に設定します。同じ ID を持つ製品を複数のカタログに挿入した場合、サービスはそのうちの 1 つだけを返し、どちらが未確定かを返します。 |
要求: N/A 応答: 製品 |
{mmcMerchantId}/products |
GET | を使用して、ストア内の製品の一覧を取得します。{mmcMerchantId} を MMC ストア ID に設定します。 |
要求: N/A 応答: 製品 |
{mmcMerchantId}/products |
POST | を使用して、ストアに単一の製品オファリングを挿入 (更新) します。 製品が存在しない場合は、追加されます。それ以外の場合は、製品が更新されます。 更新によって現在のオファリングが上書きされるため、オファーを構成するすべてのフィールドを含める必要があります。 オファーを特定のカタログに挿入するには、 bmc-catalog-id クエリ パラメーターを指定します。それ以外の場合、製品はストアの既定のカタログに挿入されます。 {mmcMerchantId} を MMC ストア ID に設定します。Get/List 要求と Delete 要求は、特定のカタログではなくストアに対して動作するため、同じチャネル、contentLanguage、targetCountry、および offerId を持つ製品を複数のカタログに挿入しないでください。 |
要求: 製品 応答: 製品 |
クエリ パラメーター
エンドポイントには、次のクエリ パラメーターが含まれる場合があります。
パラメーター | 説明 |
---|---|
alt | 省略可能。 を使用して、要求と応答で使用されるコンテンツの種類を指定します。 使用可能な値は、 json と xml です。 既定値は json です。 |
bmc-catalog-id | 省略可能。 製品オファリングを挿入 (更新) するカタログを指定する場合に使用します。 ストアに複数のカタログが含まれている場合は、このパラメーターを使用します。 このパラメーターを指定しない場合、製品はストアの既定のカタログに挿入されます。 このパラメーターは、製品オファリングの挿入にのみ使用されます。 このパラメーターは、カタログ間で動作するため、Get、List、Delete の各要求では無視されます。 |
dry-run | 省略可能。 アプリケーションをデバッグして呼び出しをテストするときに使用します。 このパラメーターを含む呼び出しは、運用データには影響しません (製品は挿入または削除されません)。ただし、応答には、呼び出しによって生成されるエラーが含まれます。 このパラメーターを使用する場合は、次の制限事項を考慮してください。
|
max-results | 省略可能。 List 要求で返す項目の最大数を指定するには、 を使用します。 指定できる最大値は 250 です。 既定値は 25 です。 |
start-token | 省略可能。 を使用して、ストアの製品の一覧を表示します。 トークンは、List 要求で返される製品の次のページを識別します。 最初の List 要求では、このパラメーターを指定しないでください。 カタログに要求された数を超える製品が含まれている場合 ( max-results クエリ パラメーターを参照)、応答には、次の List 要求で使用するトークン値を含む nextPageToken フィールド ( 製品を参照) が含まれます。 |
ヘッダー
要求ヘッダーと応答ヘッダーを次に示します。
ヘッダー | 説明 |
---|---|
AuthenticationToken | 要求ヘッダー。 このヘッダーを OAuth アクセス トークンに設定します。 アクセス トークンの取得については、「 資格情報の認証」を参照してください。 |
Content-Location | 応答ヘッダー。 製品が挿入されたストアを識別する URL。 このヘッダーは、Insert 要求の応答に含まれます。 |
Content-Type | 要求ヘッダーと応答ヘッダー。 要求または応答の本文内のコンテンツの種類。 POST の場合、JSON を使用する場合は、このヘッダーを application/json に設定します。 それ以外の場合、XML を使用する場合は、このヘッダーを application/xml に設定します。 |
CustomerAccountId | 要求ヘッダー。CustomerId ヘッダーで指定された顧客に代わって管理する任意のアカウントのアカウント ID。 指定したアカウントは関係ありません。 このヘッダーは、顧客の代わりにアカウントを管理する場合にのみ指定します。 |
CustomerId | 要求ヘッダー。 ストアを管理する顧客の顧客 ID。 このヘッダーは、顧客の代わりにストアを管理する場合にのみ指定します。 このヘッダーを設定する場合は、 CustomerAccountId ヘッダーも設定する必要があります。 |
DeveloperToken | 要求ヘッダー。 クライアント アプリケーションの開発者トークン。 各要求には、このヘッダーを含める必要があります。 トークンの取得の詳細については、「Microsoft Advertising の資格情報と開発者トークンはありますか?」を参照してください。 |
場所 | 応答ヘッダー。 製品が挿入されたストアを識別する URL。 このヘッダーは、Insert 要求の応答に含まれます。 |
WebRequestActivityId | 応答ヘッダー。 要求の詳細を含むログ エントリの ID。 エラーが発生した場合は、常にこの ID をキャプチャする必要があります。 問題を特定して解決できない場合は、この ID をサポート チームに提供する他の情報と共に含めます。 |
要求オブジェクトと応答オブジェクト
API で使用される要求オブジェクトと応答オブジェクトを次に示します。
各オブジェクトは、要求に指定したコンテンツ タイプに応じて使用する JSON キー名と XML 要素名を定義します。
オブジェクト | 説明 |
---|---|
バッチ | バッチ要求で処理する項目の一覧を定義します。 |
Error | エラーを定義します。 |
ErrorResponse | 1 つの製品挿入の最上位のエラー オブジェクトを定義します。 |
BatchItemError | バッチ処理中にアイテムに対して発生したエラーを定義します。 |
項目 | バッチ要求または応答の項目を定義します。 |
製品 | 製品を定義します。 |
ProductCustomAttribute | カスタム属性を定義します。 |
ProductCustomGroup | カスタム属性のグループを定義します。 |
ProductDestination | 宛先を定義します。 |
ProductPrice | 製品の価格を定義します。 |
ProductTax | 適用される税金を決定する地理的な場所を定義します。 |
製品 | 製品の一覧を定義します。 |
ProductShipping | 出荷コストを定義します。 |
ProductShippingWeight | 品目の出荷重量を定義します。 |
UnitPricing | 商品の単価を定義します。 |
Warning | 警告メッセージを定義します。 |
バッチ
バッチ要求で処理する項目の一覧を定義します。 このオブジェクトは、バッチ要求と応答で使用されることに注意してください。
名前 | 値 | 型 | XML 要素名 |
---|---|---|---|
エントリ | バッチ要求で処理する項目の配列。 指定できる項目の最大数は 12,000 です。 ただし、最大要求サイズは 4 MB であるため、実際の項目数は、含める製品属性の数 (サイズ、色、パターンなど) とデータを圧縮するかどうかによって異なります。 たとえば、データを圧縮すると、12,000 個の項目を指定できますが、指定しない場合は、2,000 個の項目のみを指定できます。 |
Item[] | <バッチ> |
BatchItemError
バッチ処理中にアイテムに対して発生したエラーを定義します。
名前 | 値 | 型 | XML 要素名 |
---|---|---|---|
エラー | アイテムの処理中に発生したエラーの一覧。 | エラー[] | <エラー> |
code | エラーの HTTP 状態コード。 | String | |
message | エラーに関連付けられているメッセージ。 | String |
Error
エラーを定義します。
名前 | 値 | 型 | XML 要素名 |
---|---|---|---|
domain | 内部使用のみ。 | String | <ドメイン> |
場所 | 不使用。 | String | <location type="string"> |
locationType | 不使用。 | String | <location> 要素の type 属性を参照してください |
message | エラーの説明。 | String | <internalReason> |
理由 | 要求が失敗した理由。 たとえば、製品の検証に失敗しました。 | String | <理由> |
ErrorResponse
1 つの製品挿入の最上位のエラー オブジェクトを定義します。
名前 | 値 | 型 | XML 要素名 |
---|---|---|---|
error | アイテムの処理中に発生したエラーの一覧。 | エラー[] | <エラー> |
エラー
オファーのエラーと警告の一覧を定義します。
名前 | 値 | 型 | XML 要素名 |
---|---|---|---|
エラー | アイテムの処理中に発生したエラーの一覧。 | エラー[] | <エラー> |
警告 | アイテムの処理中に発生した警告の一覧。 オファーは受け入れられましたが、できるだけ早く問題に対処する必要があります。 たとえば、 gtin、 mpn、 およびブランド 識別子を指定しない場合、既知である必要がある場合、MMC は警告を返します。 | 警告[] | <警告> |
code | HTTP 状態コードまたはエラー。 | String | |
message | エラーに関連付けられているメッセージ。 | String |
アイテム
バッチ要求の項目を定義します。
名前 | 値 | 型 | XML 要素名 |
---|---|---|---|
batchId | バッチ要求でこの項目を識別するユーザー定義 ID。 たとえば、バッチに 10 個の項目が含まれている場合は、ID を 1 から 10 に割り当てることができます。 | 符号なし整数 (Unsigned Integer) | <entry batch_id="unsigned integer" method="string"> |
エラー | 発生した検証エラーの一覧を含む error オブジェクト。 応答には、エラーが発生した場合にのみこのフィールドが含まれます。 | BatchItemError | <エラー> |
merchantId | Merchant Center ストア ID。 | Unsigned Long | <merchant_id> |
メソッド | アイテムに適用するアクション。 使用可能な値は insert 、get 、および delete 。 アイテムが製品オファリングを追加または更新している場合は、 メソッド を insert に設定します。アイテムが製品を削除している場合は 、メソッド を delete に設定し、アイテムが製品を取得している場合は 、メソッド を get に設定します。 文字列では大文字と小文字が区別されません。 |
String |
<entry> 要素のmethod 属性を参照してください |
積 | 製品オファリング。 製品を挿入 (更新) する場合にのみ、要求でこのフィールドを指定します。 応答には、取得と挿入 (更新) にのみこのフィールドが含まれます。 | 製品 | <積> |
productId | 完全修飾製品 ID (たとえば、Online:en:US:Sku123)。 このフィールドは、製品オファリングを取得または削除する場合にのみ含めます。 バッチ要求に同じ製品 ID を持つ複数の項目を含めないでください。 |
String | <product_id> |
製品
製品を定義します。 このオブジェクトのフィールドの詳細については、「フィード ファイルの編成方法」を参照してください。
JSON と XML 名 | 値 | 型 | 挿入に必要 |
---|---|---|---|
additionalImageLinks <additional_image_link> |
製品広告で使用できる製品の追加画像の URL。 複数のイメージを指定するには、 MMC は追加のイメージを使用しません。このフィールドは Google の互換性のために含まれています。 |
String[] | いいえ |
adult <大人> |
項目が成人製品であるかどうかを決定するブール値。 アイテムのターゲット マーケットが成人の場合は 、true に設定します。 既定値は false です。 大人の製品はサポートされていないため、拒否されることに注意してください。 |
ブール型 | いいえ |
adwordsGrouping <adwords_grouping> |
取得単価制 (CPA) 入札の項目のグループ。 MMC では、このフィールドは使用されません。Google の互換性のために含まれています。 |
String | いいえ |
adwordsLabels <adwords_label> |
グループ化されたアイテムのラベル (adwordsGrouping を参照)。 クリック単価 (CPC) にのみ適用されます。 MMC では、このフィールドは使用されません。Google の互換性のために含まれています。 |
String[] | いいえ |
adwordsRedirect <adwords_redirect> |
製品広告で使用する URL。 指定した場合、この URL は リンクで指定された URL にリダイレクトする必要があります。 | String | いいえ |
ageGroup <age_group> |
アイテムの対象年齢グループ。 使用可能な値は次のとおりです。
|
String | いいえ |
可用性 <可用性> |
製品の可用性の状態。 使用可能な値は次のとおりです。
|
String | はい |
availabilityDate <availability_date> |
事前注文製品が出荷可能になる UTC 日付 ( availability フィールドを参照)。 このフィールドは省略可能ですが、事前注文された製品が出荷可能になる日付がわかっている場合は、このフィールドを設定する必要があります。 ISO 8601 形式で日付を指定します。手記: MMC は現在、このフィールドの内容を無視します。 |
String | いいえ |
ブランド <ブランド> |
アイテムのブランド、製造元、または発行元。 文字列には、最大 10 個の単語と 1,000 文字を含む場合があります。 UX に文字列が適切に表示されるようにするには、ブランド名を 70 文字以下に制限する必要があります。 | String | はい |
チャンネル <チャンネル> |
製品の販売チャネル。 大文字と小文字を区別しない値を次に示します。
|
String | はい |
color <色> |
製品の主要な色。 色が色のブレンドである場合は、最大 3 色 (赤/緑/青など) のスラッシュ区切りのリストを指定できます。 ドレスが複数の色で使用できる場合は、色ごとに製品を作成し、 itemGroupId を 使用して製品のバリエーションをグループ化します。 フィールドは 100 文字に制限されています。 衣料品におすすめ。 |
String | いいえ |
条件 <condition> |
製品の条件。 使用可能な値は次のとおりです。
|
String | はい |
contentLanguage <content_language> |
製品の 2 文字 の ISO 639-1 言語コード。 大文字と小文字を区別しない値を次に示します。
|
String | はい |
customAttributes <custom_attribute> |
マーチャントによって使用されるカスタム属性の一覧。 | ProductCustomAttribute[] | いいえ |
customGroups<custom_group> | マーチャントによって使用されるカスタム グループの一覧。 | ProductCustomGroup[] | いいえ |
customLabel0 <custom_label_0> |
Microsoft ショッピング キャンペーンの製品をフィルター処理するために使用されるカスタム ラベル 0。 ラベルは 100 文字に制限されています。 | String | いいえ |
customLabel1 <custom_label_1> |
Microsoft ショッピング キャンペーンの製品をフィルター処理するために使用されるカスタム ラベル 1。 ラベルは 100 文字に制限されています。 | String | いいえ |
customLabel2 <custom_label_2> |
Microsoft ショッピング キャンペーンの製品をフィルター処理するために使用されるカスタム ラベル 2。 ラベルは 100 文字に制限されています。 | String | いいえ |
customLabel3 <custom_label_3> |
Microsoft ショッピング キャンペーンの製品をフィルター処理するために使用されるカスタム ラベル 3。 ラベルは 100 文字に制限されています。 | String | いいえ |
customLabel4 <custom_label_4> |
Microsoft ショッピング キャンペーンの製品をフィルター処理するために使用されるカスタム ラベル 4。 ラベルは 100 文字に制限されています。 | String | いいえ |
説明 <形容> |
製品の説明。 説明にプロモーション テキストが含まれていない場合があります。 説明は最大 10,000 文字に制限されており、Unicode 文字を含めることができます。 説明は編集レビューを受けます。 |
String | いいえ |
目的 地 <行き先> |
製品の目的の宛先。 MMC では、このフィールドは使用されません。Google の互換性のために含まれています。 |
ProductDestination[] | いいえ |
energyEfficiencyClass <energy_efficiency_class> |
EU 指令 2010/30/EU で定義されているエネルギー効率クラス。 使用可能な値は次のとおりです。
|
String | いいえ |
expirationDate <expiration_date> |
製品の有効期限を指定する UTC の日付と時刻。 有効期限を指定しない場合、製品の有効期限は、製品を追加または更新した日時から 30 日間です (日付と時刻は Microsoft サーバーのタイムゾーンに基づいています)。 このフィールドを使用して、今日から 30 日未満の有効期限を指定します。 有効期限の日付には、常に時間コンポーネントを含め、タイムゾーンまたはオフセット情報を指定する必要があります。 そうでない場合、API は targetCountry を使用してタイムゾーンの決定を試みます。 複数のタイム ゾーンを持つ国またはリージョンの場合、API は使用するタイムゾーンを決定します。 たとえば、国が米国の場合、API は太平洋標準時 (PST) を使用します。 有効期限が近い製品と有効期限が切れる前に、有効期限を更新するか、製品の更新 (製品のフィールドを更新する必要はありません) を追跡する必要があります。これにより、有効期限が自動的に 30 日延長されます。 有効期限を明示的に設定する場合は、新しい有効期限を自分で設定する必要があります。この場合、製品を更新すると、自動的に有効期限が 30 日延長されることはありません。 |
String | いいえ |
gender <ジェンダー> |
製品が対象とする性別。 使用可能な値は次のとおりです。
|
String | いいえ |
googleProductCategory <google_product_category> |
製品が見つかった製品カテゴリ。 カテゴリ文字列 (たとえば、動物 & ペット用品 > ペット用品 > 鳥用品) またはカテゴリ ID (例: 3) を指定できます。 カテゴリ文字列の場合、サブカテゴリの一覧は、より大きい記号 ('>') で区切られます。 フィールドは 255 文字に制限されています。 | String | いいえ |
gtin <gtin> |
製造元によって割り当てられたグローバル貿易項目番号 (GTIN)。 製造元が GTIN を割り当てる場合は、それを指定する必要があります。 GTIN の種類を次に示します。
|
String | はい |
id <id> |
完全修飾製品 ID。ID は、 チャネル、 contentLanguage、 targetCountry、 および offerId の複合です。 ID では大文字と小文字が区別されます。 この ID を使用して、製品を取得または削除します。 |
String | いいえ |
identifierExists <identifier_exists> |
製品オファーが gtin、 mpn、または ブランド 識別子を指定するかどうかを決定するブール値。 The default is true. 3 つの識別子をすべて指定しない場合は 、false に設定します。 一意の製品識別子は、グローバル マーケットプレースで製品を定義します。 製品に一意の識別子をタグ付けすると、顧客が製品を見つけやすくなります。 既知の場合は、3 つの識別子をすべて指定する必要があります。 |
ブール型 | いいえ |
imageLink <image_link> |
製品広告で使用できる製品の画像への URL。 URL は 1,000 文字に制限されており、HTTP または HTTPS プロトコルを使用できます。 使用できる画像の種類は、bmp、gif、exif、jpg、png、tiff です。 推奨されるイメージ サイズは 200 x 200 ピクセルです。 イメージは 3.9 MB を超えない場合があります。 画像は編集レビューを受けます。 |
String | はい |
isBundle <is_bundle> |
製品がマーチャント定義バンドルであるかどうかを決定するブール値。 製品がバンドルの場合、値は true です 。 | ブール型 | いいえ |
itemGroupId <item_group_id> |
同じ製品のすべてのバリアントをグループ化するために使用できる ID。 たとえば、ドレスが 3 色で使用できる場合は、色ごとに製品を作成し、この ID を使用してグループ化できます。 通常、色、素材、パターン、またはサイズによって異なる項目をグループ化します。 ID はカタログ内で一意である必要があり、50 文字に制限されます。 |
String | いいえ |
kind <種類> |
オブジェクトの型。 このフィールドは content#product に設定されます。 |
String | いいえ |
リンク <リンク> |
Web サイト上の製品のページへの URL。 URL は 2,000 文字に制限されており、HTTP または HTTPS プロトコルを使用できます。 ドメインはストアのドメインと一致している必要があります。 リンクは製品広告で使用されます。 URL はリダイレクトされない場合があります。 この URL にリダイレクトされる可能性がある製品広告で別の URL を使用するには、「 adwordsRedirect」を参照してください。 このリンクが指す Web ページは、編集レビューを受ける予定です。 |
String | はい |
材料 <材料> |
プロダクトの主要な材料。 素材が素材のブレンドである場合は、最大 3 つの素材 (レザー/スエード/シルクなど) のスラッシュ区切りのリストを指定できます。 複数の素材でドレスを使用できる場合は、素材ごとに製品を作成し、 itemGroupId を 使用して製品のバリエーションをグループ化します。 フィールドは 200 文字に制限されています。 衣料品におすすめ。 |
String | いいえ |
mobileLink <mobile_link> |
製品に関する情報を含むモバイル最適化バージョンの Web ページへの URL ( リンクを参照)。 | String | いいえ |
multipack <multipack> |
1 つのユニットとして販売されている同一の製品の数 (たとえば、4 つの懐中電灯)。 価格を設定する場合は、マルチパックの 合計 価格である必要があります。 | 整数 | いいえ |
mpn <mpn> |
製品の製造元の部品番号 (MPN)。 製造元が MPN を割り当てる場合は、MPN を指定する必要があります。 MPN は 70 文字に制限されています。 | String | はい |
offerId <offer_id> |
提供されている製品のユーザー定義 ID。 オファー ID では大文字と小文字が区別されず、カタログ内で一意である必要があり、最大 50 文字に制限されます。 オファー ID は製品 ID の作成に使用されるため、製品をストアに追加した後にこのフィールドを変更することはできません。 |
String | はい |
onlineOnly <online_only> |
製品がオンラインでのみ購入できるかどうかを決定するブール値。 製品がオンラインでのみ使用できる場合、値は true です 。 既定値は false です。 | ブール型 | いいえ |
pattern <パターン> |
製品のパターンまたはグラフィックプリント (チェック柄など)。 パターンは 100 文字に制限されています。 ドレスが複数のパターンで使用できる場合は、パターンごとに製品を作成し、 itemGroupId を 使用して製品のバリエーションをグループ化します。 衣料品におすすめ。 |
String | いいえ |
価格 <価格> |
製品の価格。 対象国の通貨で価格を指定します。 価格に税金を含めるかどうかの詳細については、「 Microsoft Merchant Center カタログ税ポリシー」を参照してください。 価格は、製品の Web ページに表示される価格 ( リンクを参照) と一致する必要があり、0.01 (1 セント) から 1,000000.00 (1,000 万) の範囲である必要があります。 ただし、次の条件が満たされた場合は、価格を 0.0 (ゼロ) に設定できます。 1. googleProductCategory フィールドは、次のいずれかのカテゴリに設定されます。 - 電子 > 通信 > テレフォニー > 携帯電話 - エレクトロニクス > コンピューター > タブレット コンピューター 2. タイトル フィールドには、次のいずれかのキーワードが含まれています。 -契約 -掛け金 -借り上げる -支払い 上記のキーワードは英語で表示されます。ただし、タイトルとキーワード (keyword)は、指定された市場の言語である必要があります。 通常、タイトルには"..などの言い回しが含まれます。割り込みプラン" または "...コントラクトのみ" です。 契約キーワード (keyword)はすべての市場で使用できます。ただし、割賦、支払い、リースは米国市場でのみ使用できます。 |
ProductPrice | はい |
productType <product_type> |
広告主が定義した製品カテゴリ。これは、 googleProductCategory とは異なる場合があります。 たとえば、動物 & ペット用品 > ペット用品 > 鳥用品 > 動物用品です。 サブカテゴリの一覧は、より大きい記号 ('>') で区切られます。 フィールドは 750 文字に制限されています。コンマ区切りの複数のカテゴリ文字列を指定できます。 たとえば、コスチューム & アクセサリー > かつらアクセサリー > かつらキャップ、コスチューム & アクセサリー > かつらアクセサリー > かつらグルーです。 |
String | いいえ |
promotionId <promotion_id> |
プロモーション フィードのプロモーションを識別する ID のコンマ区切りの一覧。 最大 10 個のプロモーション ID を指定できます。 ID には、1 文字以上、最大 60 文字を含める必要があります。 使用できる文字は、任意の英数字、ダッシュ (-)、アンダースコア (_) です。 マーケットのすべての ID ( contentLanguage と targetCountry を参照) は一意である必要があります。 たとえば、市場内では 、PROMO1 と promo1 を使用することはできませんが、EN-US 市場では PROMO1 、en-GB 市場では promo1 を使用できます。 1 つ以上の製品で同じ一意のプロモーション ID を指定できます。 指定した ID がプロモーション フィード (同じターゲット国) のプロモーション ID と一致する場合、Microsoft は製品を昇格させます。 ID は、大文字と小文字が同じ場合にのみ一致します。 たとえば、製品の ID が PROMO1 で、フィードの ID が PROMO1 の場合、ID は一致しますが、フィードの ID が Promo1 の場合は一致しません。 製品が将来誤って昇格されないようにするには、終了したプロモーションの ID を削除する必要があります。 プロモーションが終了してから 6 か月間、プロモーション フィードで ID を再度使用することはできませんが、その後に別のプロモーションで ID が再利用された場合、製品は昇格されます。 |
String | いいえ |
salePrice <sale_price> |
アイテムの販売価格。 販売価格は、0.01 (1 セント) から 10000000.00 (1,000 万) の範囲である必要があります。 販売品目については、販売価格と販売有効日の両方を設定します ( salePriceEffectiveDate を参照)。 セール価格を設定したが、セール価格の有効日を設定しない場合、販売価格は製品の有効期限が切れるか、有効日を設定するまで引き続き使用されます。次の条件が満たされた場合は、販売価格を 0.0 (ゼロ) に設定できます。 1. googleProductCategory フィールドは、次のいずれかのカテゴリに設定されます。 - 電子 > 通信 > テレフォニー > 携帯電話 - エレクトロニクス > コンピューター > タブレット コンピューター 2. タイトル フィールドには、次のいずれかのキーワードが含まれています。 -契約 -掛け金 -借り上げる -支払い 上記のキーワードは英語で表示されます。ただし、タイトルとキーワード (keyword)は、指定された市場の言語である必要があります。 通常、タイトルには"..などの言い回しが含まれます。割り込みプラン" または "...コントラクトのみ" です。 契約キーワード (keyword)はすべての市場で使用できます。ただし、割賦、支払い、リースは米国市場でのみ使用できます。 |
ProductPrice | いいえ |
salePriceEffectiveDate <sale_price_effective_date> |
販売の UTC 開始日と終了日。
ISO 8601 形式で日付を指定します。 たとえば、2016-04-05T08:00-08:00/2016-04-10T19:30-08:00 (開始日と終了日を区切るためにスラッシュ ('/') を使用します)。 詳細については、salePrice を参照してください。 |
String | いいえ |
sellerName <seller_name> |
製品を販売しているマーチャントの名前。 アグリゲーターのみがマーチャントを識別するために使用されます。 アグリゲーターは、個々のマーチャントに代わって動作するサード パーティ のサイトです。 アグリゲーターが販売者に代わって提出する製品は、Microsoft 広告ポリシーと 利用規約に準拠している必要があります。 アグリゲーターは、このフィールドを販売者名に設定する必要があります。 呼び出し元がアグリゲーターではなく、このフィールドが設定されていない場合、既定ではストア名になります。 名前は 255 文字に制限されています。 |
String | いいえ |
出荷 <出荷> |
場所に基づいて製品を出荷する価格。 注: 対象国が DE (ドイツ) の場合は配送が必要です。それ以外の場合は省略可能です。 |
ProductShipping[] | はい |
shippingLabel <shipping_label> |
出荷ラベル。 注: 対象国が DE (ドイツ) の場合は、配送情報が必要です。それ以外の場合は省略可能です。 |
String | はい |
shippingWeight <shipping_weight> |
製品の重量。 重量は出荷目的で使用されます。 注: 対象国が DE (ドイツ) の場合は、配送情報が必要です。それ以外の場合は省略可能です。 |
ProductShippingWeight | はい |
サイズ <大きさ> |
製品の使用可能なサイズ。 たとえば、小、中、大です。 サイズ設定を一貫して適用します。 サイズの値はユーザー定義ですが、ターゲット国に基づいている必要があります。 このフィールドは、フランス、ドイツ、イギリス、米国をターゲットにするすべてのアパレル & アクセサリ製品に必要です。 | String[] | いいえ |
sizeSystem <size_system> |
製品のサイズを設定するために使用される測定システム。 たとえば、靴のサイズは、米国のシステムまたは英国のシステムを使用して行います。 使用可能な値は次のとおりです。
|
String | いいえ |
sizeType <size_type> |
製品のカット。 使用可能な値は次のとおりです。
|
String | いいえ |
targetCountry <target_country> |
ターゲット国 (製品を宣伝する国) の 2 文字の ISO 3166 国コード。 国は、カタログで指定された市場と一致する必要があります。 大文字と小文字を区別しない値を次に示します。
|
String | はい |
税 <税金> |
製品の税情報。 MMC では、このフィールドは使用されません。Google の互換性のために含まれています。 |
ProductTax[] | いいえ |
タイトル <タイトル> |
製品のタイトル (たとえば、女性の靴)。 タイトルにプロモーション テキストが含まれていない場合があります。 タイトルは最大 150 文字に制限されており、任意の Unicode 文字を含めることができます。 タイトルは編集レビューを受けます。 |
String | はい |
unitPricingBaseMeasure <unit_pricing_base_measure> |
価格に関する製品の基本メジャー (たとえば、100ml は、価格が 100ml 単位に基づいて計算されていることを意味します)。
|
UnitPricing | いいえ |
unitPricingMeasure <unit_pricing_measure> |
製品の販売時の測定と寸法。
|
UnitPricing | いいえ |
validatedestinations <validated_destination> |
検証に合格した目的の宛先の読み取り専用リスト。 MMC では、このフィールドは使用されません。Google の互換性のために含まれています。 |
String[] | いいえ |
警告 | 製品オファーに関する問題に関する警告の一覧。 オファーは受け入れられましたが、できるだけ早く問題に対処する必要があります。 たとえば、 gtin、 mpn、 およびブランド 識別子を指定しない場合、既知である必要がある場合、MMC は警告を返します。 オファーには、挿入/更新の応答にのみこのフィールドが含まれます。 |
警告[] | いいえ |
ProductCustomAttribute
カスタム属性を定義します。
名前 | 値 | 型 | XML 要素名 |
---|---|---|---|
name | 属性の名前を取得または設定します。 | String | <名前> |
type | 属性の型を取得または設定します。 使用可能な値は次のとおりです。
|
String | <種類> |
単位 | 属性の測定単位を取得または設定します。 INT 型と FLOAT 型の値にのみ使用されます。 | String | <単位> |
値 | 属性の値を取得または設定します。 | String | <価値> |
ProductCustomGroup
顧客属性のグループを定義します。
名前 | 値 | 型 | XML 要素名 |
---|---|---|---|
属性 | グループの属性を取得または設定します。 | ProductCustomAttribute | <属性> |
name | グループの名前を取得または設定します。 | String | <名前> |
ProductDestination
宛先を定義します。
名前 | 値 | 型 | XML 要素名 |
---|---|---|---|
意図 | 使用可能な値は次のとおりです。
|
String | <意図> |
destinationName | 変換先の名前を取得または設定します。 | String | <destination_name> |
ProductPrice
製品の価格または販売価格を定義します。
名前 | 値 | 型 | XML 要素名 |
---|---|---|---|
通貨 | 価格が記載されている通貨を取得または設定します。 ISO 4217 通貨コードを使用して通貨を指定します。 使用可能な値は次のとおりです。
|
String |
currency 属性。たとえば、 <price currency="USD">。 |
値 | アイテムの価格を取得または設定します。 '$' などの通貨記号は含めないでください。 | 倍精度浮動小数点数 | テキスト値。 たとえば、 <price currency="USD">38.0<\price>。 |
製品
製品の一覧を定義します。 これは、List 要求が返す最上位のオブジェクトであることに注意してください。
名前 | 値 | 型 | XML 要素名 |
---|---|---|---|
kind | オブジェクトの型を取得します。 このフィールドは content#productsListResponse に設定されます。 | String | <種類> |
nextPageToken | 結果の次のページを取得するために使用されるトークンを取得します。 オブジェクトにこのフィールドが含まれていない場合、取得するページはこれ以上ありません。 開始トークンに関するページを参照してください。 | String | <next_page_token> |
リソース | 製品の一覧を取得します。 カタログにオファーが含まれていない場合、配列は空です。 | Product[] | <プロダクツ> |
ProductShipping
出荷コストを定義します。
名前 | 値 | 型 | XML 要素名 |
---|---|---|---|
country | アイテムが出荷される国の 2 文字 の ISO 3166 国コードを取得または設定します。 | String | <country> |
locationGroupName | 場所グループ名を取得または設定します。 | String | <location_group_name> |
locationId | アイテムが出荷される地理的な場所の ID を取得または設定します。 ID の一覧については、「 地理的な場所コード」を参照してください。 | String | <location_id> |
postalCode | アイテムの発送先の郵便番号または郵便番号範囲を取得または設定します。 郵便番号は次のように指定できます。
|
String | <postal_code> |
価格 | 指定した場所にアイテムを出荷する固定価格を取得または設定します。 | ProductPrice | <価格> |
地域 | アイテムが出荷される地理的リージョン (郵便番号など) を取得または設定します。 | String | <地域> |
サービス | サービス クラスまたは配信速度を説明するテキストの説明を取得または設定します。 | String | <サービス> |
ProductShippingWeight
品目の出荷重量を定義します。
名前 | 値 | 型 | XML 要素名 |
---|---|---|---|
単位 | 測定単位を取得または設定します。 | String |
unit 属性。たとえば、unit="oz"><shipping_weight。 |
値 | アイテムの重量を取得または設定します。これは、品目の配送料の計算に使用されます。 | String | テキスト値。 たとえば、unit="oz">20.3<shipping_weight> を<shipping_weightします。 |
ProductTax
適用される税金を決定する地理的な場所を定義します。
名前 | 値 | 型 | XML 要素名 |
---|---|---|---|
country | 税率が適用される国を取得または設定します。 2 文字の ISO 3166 国コードを使用します。 | String | <country> |
locationId | 税率が適用される地理的な場所の ID を取得または設定します。 ID の一覧については、「 地理的な場所コード」を参照してください。 | Long | <location_id> |
postalCode | 税率が適用される郵便番号または郵便番号の範囲を取得または設定します。 郵便番号は次のように指定できます。
|
String | <postal_code> |
率 | アイテムの価格に適用する税率の割合を取得または設定します。 5% のレートを指定するには、このフィールドを 5 に設定します。 9.8% レートを指定するには、このフィールドを 9.8 に設定します。 | 倍精度浮動小数点数 | <率> |
地域 | 税率が適用される地理的リージョンを取得または設定します。 | String | <地域> |
taxShip | 税を送料に適用するかどうかを決定するブール値を取得または設定します。 出荷時に税金が請求される場合は 、true に設定します。 | ブール型 | <船> |
UnitPricing
商品の単価を定義します。
名前 | 値 | 型 | XML 要素名 |
---|---|---|---|
単位 | 測定単位を取得または設定します。 たとえば、価格が 1 オンス当たりの場合、 oz です。 | String |
unit 属性。たとえば、unit="oz" <unit_pricing_measure> |
値 | ユニットあたりの価格を取得または設定します。 | 倍精度浮動小数点数 | テキスト値。 たとえば、unit="oz">34.5<\unit_pricing_measure<unit_pricing_measure> |
警告
警告メッセージを定義します。
名前 | 値 | 型 | XML 要素名 |
---|---|---|---|
domain | 内部使用のみ。 | String | <ドメイン> |
message | 警告の説明。 | String | <internalReason> |
理由 | オファーが警告を生成した理由。 たとえば、製造元が割り当てられていることがわかっている場合、識別子 (gtin、 mpn、または ブランド) を指定しませんでした。 | String | <理由> |
HTTP 状態コード
要求は、次の HTTP 状態コードを返す場合があります。
状態コード | 説明 |
---|---|
200 | 成功 |
204 | 製品が正常に削除されました。 |
400 | 要求が正しくありません。 クエリ パラメーターの値が無効であるか、要求本文の何かが無効です。 バッチ: エラーが発生した場合、失敗したバッチ項目にエラーが含まれます。 |
401 | 権限がありません。 ユーザーの資格情報が無効です。 |
404 | 見つかりません。 |
409 | 葛藤。 リソースの現在の状態と競合するため、操作を完了できませんでした。 |
413 | 要求エンティティが大きすぎます。 要求のサイズが許可される最大サイズを超えています。 |
500 | サーバー エラー。 |