Catalogs リソース

  • [アーティクル]

カタログ リソースを使用すると、Microsoft Merchant Center ストア (MMC) でカタログを管理できます。 Catalogs リソースの使用については、「カタログの 管理」を参照してください。 カタログを追加、削除、取得する方法を示す例については、「 コード例」を参照してください。

ベース URI

テンプレートを追加するベース URI を次に示します。

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

テンプレート

カタログの管理に使用するエンドポイントを作成するには、ベース URI に適切なテンプレートを追加します。

テンプレート HTTP 動詞 説明 リソース
{mmcMerchantId}/catalogs POST を使用して、ストアにカタログを追加します。 カタログを追加するには、その名前が一意である必要があります。 ストアには最大 100 個のカタログを追加できます。

MMC ストア ID に設定 {mmcMerchantId} します。		 要求: カタログ
応答: カタログ
{mmcMerchantId}/catalogs/{catalogId} PUT を使用して、ストア内のカタログを更新します。 更新できるフィールドは name 、 フィールドと isPublishingEnabled フィールドのみです。両方を指定する必要があります。

MMC ストア ID に設定 {mmcMerchantId} します。		 要求: カタログ
応答: カタログ
{mmcMerchantId}/catalogs/{catalogId} DELETE ストアからカタログを削除するには、 を使用します。

MMC ストア ID に設定 {mmcMerchantId} します。

カタログの ID に設定 {catalogId} します。		 要求: N/A
応答: N/A
{mmcMerchantId}/catalogs/{catalogId} GET を使用して、ストアからカタログを取得します。

MMC ストア ID に設定 {mmcMerchantId} します。

カタログの ID に設定 {catalogId} します。		 要求: N/A
応答: カタログ
{mmcMerchantId}/catalogs GET ストアからカタログの一覧を取得するには、 を使用します。

MMC ストア ID に設定 {mmcMerchantId} します。		 要求: N/A
応答: カタログ

クエリ パラメーター

エンドポイントには、次のクエリ パラメーターが含まれる場合があります。

パラメーター 説明
alt オプション。 を使用して、要求と応答で使用されるコンテンツの種類を指定します。 使用可能な値は json と xmlです。 既定値は json です。

ヘッダー

要求ヘッダーと応答ヘッダーを次に示します。

ヘッダー 説明
AuthenticationToken 要求ヘッダー。

このヘッダーを OAuth 認証トークンに設定します。 トークンの取得の詳細については、「 資格情報の認証」を参照してください。
Content-Location 応答ヘッダー。

カタログが挿入されたストアを識別する URL。 このヘッダーは、Insert 要求の応答に含まれます。
CustomerAccountId 要求ヘッダー。

ヘッダーで CustomerId 指定された顧客に代わって管理する任意のアカウントのアカウント ID。 指定したアカウントは関係ありません。 このヘッダーは、顧客の代わりにアカウントを管理する場合にのみ指定します。
Customerid 要求ヘッダー。

ストアを管理する顧客の顧客 ID。 このヘッダーは、顧客の代わりにストアを管理する場合にのみ指定します。 このヘッダーを設定する場合は、ヘッダーも設定する CustomerAccountId 必要があります。
DeveloperToken 要求ヘッダー。

クライアント アプリケーションの開発者アクセス トークン。 各要求には、このヘッダーを含める必要があります。 トークンの取得の詳細については、「Microsoft Advertising の資格情報と開発者トークンはありますか?」を参照してください。
場所 応答ヘッダー。

カタログが挿入されたストアを識別する URL。 このヘッダーは、Insert 要求の応答に含まれます。
WebRequestActivityId 応答ヘッダー。

要求に関する詳細を含むログ エントリの ID。 エラーが発生した場合は、常にこの ID をキャプチャする必要があります。 問題を特定して解決できない場合は、この ID をサポート チームに提供する他の情報と共に含めます。

要求オブジェクトと応答オブジェクト

API で使用される要求オブジェクトと応答オブジェクトを次に示します。

各オブジェクトは、要求に指定するコンテンツ タイプに応じて使用する JSON キー名と XML 要素名を定義します。

オブジェクト 説明
カタログ カタログを定義します。
カタログ カタログの一覧を定義します。

Catalog

カタログを定義します。

名前 値 型 XML 要素名
Id ストア内のカタログを一意に識別する ID。

このフィールドは読み取り専用です。このフィールドは設定しないでください。		 Unsigned Long <Id>
Isdefault カタログがストアの既定のカタログであるかどうかを決定するブール値。 カタログがストアの既定のカタログである場合は true です。それ以外の場合は false。

ストアを作成すると、別のカタログを指定しない場合に製品が書き込まれる既定のカタログが取得されます。

このフィールドは読み取り専用です。このフィールドは設定しないでください。		 ブール型 <is_default>
isPublishingEnabled Microsoft がカタログから製品を発行できるかどうかを決定するブール値。 Microsoft がカタログから製品を発行する場合は 、true に設定します。それ以外の場合は、 false に設定します。

このフィールドは更新できます。

このフィールドを使用して、運用環境にデプロイする前にアプリケーションをテストすることもできます。 このフィールドを false に設定すると、運用データを変更したり公開したりすることなく 、Products Resource の呼び出しを行うことができます。		 ブール型 <is_publishing_enabled>
市場 カタログ内の製品が公開される市場。

メモ： 誰もがこの機能をまだ持っているわけではありません。 そうでない場合は、心配しないでください。近日公開予定です。

指定できる市場を次に示します。
  • アルバニア、アルバニア語 (sq-AL)
  • アンドラ、フランス語 (fr-AD)
  • アルゼンチン、スペイン語 (es-AR)
  • Aruba、英語 (en-AW)
  • オーストラリア、英語 (en-AU)
  • オーストリア、ドイツ語 (de-AT)
  • バハマ、英語 (en-BS)
  • バングラデシュ、英語 (en-BD)
  • ベルギー、オランダ語 (nl-BE)
  • ベルギー、フランス語 (fr-BE)
  • ボリビア、スペイン語 (es-BO)
  • ボスニア・ヘルツェゴビナ、ボスニア語 (bs-BA)
  • ブラジル、ポルトガル語 (pt-BR)
  • ブルネイ、英語 (en-BN)
  • ブルガリア、ブルガリア語 (bg-BG)
  • カナダ、英語 (en-CA)
  • カナダ、フランス語 (fr-CA)
  • ケイマン諸島、英語 (en-KY)
  • チリ、スペイン語 (es-CL)
  • コロンビア、スペイン語 (es-CO)
  • コスタリカ、スペイン語 (es-CR)
  • クロアチア、クロアチア語 (hr-HR)
  • キプロス、英語 (en-CY)
  • キプロス、ギリシャ語 (el-CY)
  • チェコ共和国、チェコ語 (cs-CZ)
  • デンマーク、デンマーク語 (da-DK)
  • ドミニカ語、英語 (en-DM)
  • ドミニカ共和国、スペイン語 (es-DO)
  • エクアドル、スペイン語 (es-EC)
  • エルサルバドル、スペイン語 (es-SV)
  • エストニア、エストニア語 (et-EE)
  • フィジー、英語(en-FJ)
  • フィンランド、フィンランド語 (fi-FI)
  • フランス語、英語 (en-FR)
  • フランス語、フランス語 (fr-FR)
  • フランス領ギアナ、フランス語 (fr-GF)
  • フランス領ポリネシア、フランス語 (fr-PF)
  • ドイツ語、英語 (en-DE)
  • ドイツ、ドイツ語 (de-DE)
  • ギリシャ、英語 (en-GR)
  • ギリシャ、ギリシャ語 (el-GR)
  • グアム、英語 (en-GU)
  • グアテマラ、スペイン語 (es-GT)
  • ガイアナ、英語 (en-GY)
  • Haiti、フランス語 (fr-HT)
  • ホンジュラス語、スペイン語 (es-HN)
  • 香港特別行政区, 繁体字中国語 (zh-HK)
  • ハンガリー、英語 (en-HU)
  • ハンガリー、ハンガリー語 (hu-HU)
  • アイスランド、アイスランド (is-IS)
  • インド、英語 (en-IN)
  • インドネシア、英語 (en-ID)
  • アイルランド、英語 (en-IE)
  • イタリア語、英語 (en-IT)
  • イタリア語、イタリア語 (it-IT)
  • 日本、日本語 (ja-JP)
  • ラトビア、ラトビア語 (lv-LV)
  • リヒテンシュタイン、ドイツ語 (de-LI)
  • リトアニア、リトアニア語 (lt-LT)
  • ルクセンブルク、フランス語 (fr-LU)
  • ルクセンブルク、ドイツ語 (de-LU)
  • マレーシア、英語 (en-MY)
  • モルディブ、英語 (en-MV)
  • マルタ、マルタ語 (mt-MT)
  • Martinique、フランス語 (fr-MQ)
  • メキシコ、スペイン語 (es-MX)
  • モナコ、フランス語 (fr-MC)
  • モンゴル語、英語 (en-MN)
  • モンテネグロ、英語 (en-ME)
  • モンテネグロ、セルビア語 (sr-ME)
  • Montserrat、英語 (en-MS)
  • ネパール語、英語 (en-NP)
  • オランダ語、オランダ語 (nl-NL)
  • オランダ語、英語 (el-NL)
  • ニューカレドニア語、フランス語 (fr-NC)
  • ニュージーランド、英語 (en-NZ)
  • 北マケドニア、マケドニア語 (mk-MK)
  • ノルウェー、ノルウェー語 (nb-NO)
  • パナマ、スペイン語 (es-PA)
  • パプアニューギニア、英語 (en-PG)
  • パラグアイ、スペイン語 (es-PY)
  • ペルー、スペイン語 (es-PE)
  • フィリピン語、英語 (en-PH)
  • ポーランド、ポーランド語 (pl-PL)
  • ポルトガル語、ポルトガル語 (pt-PT)
  • プエルトリコ、スペイン語 (es-PR)
  • ルーマニア、ルーマニア語 (ro-RO)
  • サンマリノ、英語 (en-SM)
  • サンマリノ、イタリア語 (it-SM)
  • セルビア、英語 (en-RS)
  • セルビア、セルビア語 (sr-RS)
  • シンガポール、英語 (en-SG)
  • スロバキア、英語 (en-SK)
  • スロバキア、スロバキア語 (sk-SK)
  • スロベニア、スロベニア語 (sl-SI)
  • 南アフリカ、英語 (en-ZA)
  • スペイン、英語 (en-ES)
  • スペイン語、スペイン語 (es-ES)
  • スリランカ、英語 (en-LK)
  • スウェーデン語、英語 (en-SE)
  • スウェーデン、スウェーデン語 (sv-SE)
  • スイス、ドイツ語 (de-CH)
  • スイス、フランス語 (fr-CH)
  • 台湾、繁体字中国語 (zh-TW)
  • タイ語、英語 (en-TH)
  • トリニダード・トバゴ、英語 (en-TT)
  • Türkiye、トルコ語 (tr-TR)
  • 英国、英語 (en-GB)
  • 米国、英語 (en-US)
  • 米国、スペイン語 (es-US)
  • ウルグアイ、スペイン語 (es-UY)
  • バチカン市国、イタリア語 (it-VA)
  • ベネズエラ、スペイン語 (es-VE)
  • ベトナム語、英語 (en-VN)
カタログに追加するすべての製品は、同じ市場を指定する必要があります ( 「contentLanguage and targetCountry」を参照)。

カタログをストアに追加した後、このフィールドを更新することはできません。

上記の一覧では、de-DE は指定した市場価値です。市場文字列に (ドイツとドイツ) を含めないでください。		 String <市場>
名前 カタログの名前。 名前には、最大 70 文字を含める場合があります。

このフィールドは更新できます。		 String <名前>

カタログ

カタログの一覧を定義します。

名前 値 型 XML 要素名
カタログ ストア内のカタログの一覧。 Catalog[] <カタログ>

HTTP 状態コード

要求は、次の HTTP 状態コードを返す場合があります。

状態コード 説明
200 成功
201 カタログが正常に追加されました。
204 カタログが正常に削除されました。
400 要求が正しくありません。 クエリ パラメーターの値が無効であるか、要求本文の何かが無効です。
401 権限がありません。 ユーザーの資格情報が無効です。
404 見つかりません。
500 サーバー エラー。