カタログの管理
コンテンツ API は、 Catalogs リソースを使用して Microsoft Merchant Center (MMC) ストア内のカタログを管理する RESTful API です。
Content API の呼び出しに使用するベース URI を次に示します。
https://content.api.bingads.microsoft.com/shopping/v9.1/bmc/
各 HTTP 要求には、ユーザーの OAuth アクセス トークンと開発者トークンが含まれている必要があります。 ユーザーのアクセス トークンを指定するには、 AuthenticationToken ヘッダーを設定します。 開発者トークンを指定するには、 DeveloperToken ヘッダーを設定します。
他の顧客に代わってカタログを管理する場合は、次の設定を行う必要があります。
- 管理しているストアを持つ顧客の顧客 ID に対する CustomerId ヘッダー。
- 管理する顧客のアカウントのアカウント ID に対する CustomerAccountId ヘッダー (管理対象アカウントは関係ありません)。
既定では、Content API は JSON オブジェクトを使用してカタログを表します。 XML を使用するには、 alt クエリ パラメーターを XML に設定します。
Catalogs リソースの使用の詳細については、次のセクションを参照してください。
カタログを取得、追加、更新、削除する方法を示すコード例については、「 カタログの管理コード例」を参照してください。
ストアからカタログを取得する
ストアからカタログを取得するには、次のテンプレートをベース URI に追加します。
{bmcMerchantId}/catalogs/{catalogId}
MMC ストア ID に設定{bmcMerchantId}し、カタログの ID に設定{catalogId}します。
結果の URL に HTTP GET 要求を送信します。 カタログが見つかった場合、応答にはカタログの詳細を含む Catalog オブジェクトが含まれます。
ストアからカタログの一覧を取得する
ストアからカタログの一覧を取得するには、次のテンプレートをベース URI に追加します。
{bmcMerchantId}/catalogs
MMC ストア ID に設定 {bmcMerchantId} します。
結果の URL に HTTP GET 要求を送信します。 ストアにカタログが含まれている場合、応答にはカタログの一覧を含む Catalogs オブジェクトが含まれます。
ストアからのカタログの削除
ストアからカタログを削除するには、次のテンプレートをベース URI に追加します。
{bmcMerchantId}/catalogs/{catalogId}
MMC ストア ID に設定{bmcMerchantId}し、カタログの ID に設定{catalogId}します。
結果の URL に HTTP DELETE 要求を送信します。 カタログが見つかった場合は削除されます。
ストアへのカタログの追加
カタログを使用して、製品を論理的にグループ化します。 ストアにカタログを追加するには、次のテンプレートをベース URI に追加します。
{bmcMerchantId}/catalogs
MMC ストア ID に設定 {bmcMerchantId} します。
結果の URL に HTTP POST 要求を送信します。 カタログが追加された場合、応答には Catalog オブジェクトが含まれます。 オブジェクトには Catalog 、カタログの ID が含まれます。 ID を使用してカタログを取得および削除します。
要求の本文は Catalog オブジェクトです。 次のフィールドを指定する必要があります。
指定する名前はストア内で一意である必要があり、最大 70 文字に制限されています。 市場は、製品が提供される場所を識別します。 サポートされている市場の一覧については、「 市場」を参照してください。 製品は true の場合isPublishingEnabledにのみ提供されます。 アプリのテストに使用 isPublishingEnabled する方法の詳細については、「 サンドボックスでのコードのテスト」を参照してください。
ストア内のカタログの更新
ストア内のカタログを更新するには、ベース URI に次のテンプレートを追加します。
{bmcMerchantId}/catalogs/{catalogId}
MMC ストア ID に設定{bmcMerchantId}し、カタログの ID に設定{catalogId}します。
要求の本文は Catalog オブジェクトです。 次のフィールドを指定する必要があります。
結果の URL に HTTP PUT 要求を送信します。 カタログが更新された場合、応答には更新された Catalog オブジェクトが含まれます。