次の方法で共有

リソースの格納

  • [アーティクル]

注:

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

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

Store リソースを使用して、ユーザーが所有するストアを管理します。 ストアの追加、特定のストアの取得、またはユーザーが所有するすべてのストアの取得を行うことができます。 続きを読む。

ベース URI

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

https://content.api.ads.microsoft.com/v9.1/bmc

たとえば、ストアを追加したり、ユーザーが所有するストアの一覧を取得したりするには、次のエンドポイントを使用します。

https://content.api.ads.microsoft.com/v9.1/bmc/stores

テンプレート

これらは、HTTP エンドポイントを作成するために ベース URI に追加するテンプレートです。

/stores テンプレート

HTTP 動詞 説明 リソース
投稿 ストアを追加します。 次の制限が適用され、変更される場合があります。
  • 顧客は、同じストア URL を指定する最大 14 個のストアを追加できます。
  • 顧客は、最大 1,024 店舗を追加できます。
 要求: StoreCreate
応答: ストア
GET ユーザーが所有するストアの一覧を取得します。 要求: N/A
応答: StoreCollection

/stores/{merchantId} テンプレート

HTTP 動詞 説明 リソース
GET 指定したストアを取得します。 取得するストアの ID に設定 {merchantId} します。 要求: N/A
応答: ストア

クエリ パラメーター

要求には、次のクエリ パラメーターが含まれる場合があります。

パラメーター 説明
dry-run オプション。 を使用して、アプリケーションをテストまたはデバッグします。 このパラメーターを含む呼び出しは、運用データには影響しません (ストアは追加されません)。ただし、応答には、呼び出しによって生成されるエラーが含まれます。

このパラメーターを使用する場合は、次の制限事項を考慮してください。
  • 追加操作では ID は返されません。
  • サービスは、データ品質、編集の問題、データベース関連の検証などのセカンダリ エラー メッセージを生成または返しません。
アプリケーションのテストの詳細については、「 サンドボックス」を参照してください。

ヘッダー

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

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

このヘッダーを OAuth アクセス トークンに設定します。 アクセス トークンの取得については、「 資格情報の認証」を参照してください。
Content-Type 要求ヘッダー。

すべての POST 要求でこのヘッダーを指定する必要があり、 を に設定する application/json必要があります。
CustomerAccountId 要求ヘッダー。

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

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

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

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

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

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

オブジェクト 説明
Error エラーを定義します。
ErrorResponse 最上位レベルのエラー オブジェクトを定義します。
Store Microsoft Merchant Center のストアを定義します。
StoreCollection Microsoft Merchant Center のストアのコレクションを定義します。
StoreCreate Microsoft Merchant Center に追加するストアを定義します。
StoreStatus ストアの状態を定義します。

エラー

エラーを定義します。

名前 値 型
code 要求が失敗した理由。 たとえば、フィールドが検証に失敗した場合、 storeName コードは InvalidStoreNameErr です。 String
message エラーの説明。 String

ErrorResponse

最上位レベルのエラー オブジェクトを定義します。

名前 値 型
エラー 要求の処理中に発生したエラーの一覧。 エラー[]

ストア

Microsoft Merchant Center のストアを定義します。

名前 値 型
isBlockAggregator アグリゲーターがストアから広告を配信できないようにするかどうかを示すブール値。 アグリゲーターは、多くの場合、関連性のない複数の企業からの製品オファーを統合します。 既定では、アグリゲーターは広告にカタログを含めることができます。

Bingにアグリゲーターの広告に製品が表示されないようにする場合は true です。 アグリゲーターを使用http://www.contoso.comする 2 つのストア (1 つは米国用、もう 1 つは英国用) があり、そのうちの 1 つがアグリゲーターをブロックしている場合、両方ともブロック アグリゲーターを格納します。		 ブール型
isSslCheckout ストアが SSL 対応かどうかを示すブール値。 すべてのストアには、SSL ログインページとチェックアウト ページが必要です。 ストアの Web サイトが SSL 対応の場合は true です。 ブール型
merchantId ストアの ID。 Unsigned long
notificationEmail 通知メールを受信する受信者の一覧。 ストアが承認されたとき、またはストアに検証エラーが発生した場合、電子メールによって通知されます。 String[]
notificationLanguage 通知メールの書き込みに使用する言語。 言語は、言語/国/地域>の<形式<>です。 たとえば、en-US です。 String
storeDescription ストアの使用方法を説明する説明。 String
storeName ストアの名前。 String
storeStatus ストアの状態。 StoreStatus
storeUrl ストアの宛先 URL。 宛先 URL は、ユーザーが広告をクリックしたときに誘導される Web ページです。 String

StoreCollection

ストアの一覧を定義します。

名前 値 型
店 ユーザーが所有するストアの一覧。 Store[]

StoreCreate

Microsoft Merchant Center に追加するストアを定義します。

名前 値 型 必須
isBlockAggregator アグリゲーターがストアから広告を配信できないようにするかどうかを示すブール値。 アグリゲーターは、多くの場合、関連性のない複数の企業からの製品オファーを統合します。 既定では、アグリゲーターは広告にカタログを含めることができます。

Bingにアグリゲーターの広告に製品が表示されないようにするには 、true に設定します。 アグリゲーターを使用http://www.contoso.comする 2 つのストア (1 つは米国用、もう 1 つは英国用) があり、そのうちの 1 つがアグリゲーターをブロックしている場合、両方ともブロック アグリゲーターを格納します。

既定は false です。		 ブール型 いいえ
isSslCheckout ストアが SSL 対応かどうかを示すブール値。 すべてのストアには、SSL ログインページとチェックアウト ページが必要です。 ストアの Web サイトが SSL 対応の場合は 、true に設定します。 false の場合、ストアは不承認になります。

既定は true です。		 ブール型 いいえ
notificationEmail 通知メールを受信する受信者の一覧。 ストアが承認されたとき、またはストアに検証エラーが発生した場合、電子メールによって通知されます。 指定できるメール アドレスの最大数は 14 です。 String[] はい
notificationLanguage 通知メールの書き込みに使用する言語。 言語は、言語/国/地域>の<形式<>です。 指定できる大文字と小文字を区別しない値を次に示します。
  • en-US (英語-米国)
  • en-AU (English-Australia)
  • en-GB (英語-イギリス)
  • fr-FR (フランス語-フランス)
  • de-DE (ドイツドイツ)
  • ja-JP (日本)
 String はい
storeDescription ストアの使用方法を説明する説明。 説明は最大 350 文字に制限されており、英数字 ([a-zA-Z0-9]) のみを含む場合があります。 String いいえ
storeName ストアの名前。 商品広告にはストアの名前が表示されるため、ウェブサイトを正確に表す名前を必ず使用してください。 名前は次の必要があります。
  • Bingマーチャント センター内で一意にする
  • 70 文字以下
  • 英数字のみを含む ([a-zA-Z0-9])
 String はい
storeUrl ストアの宛先 URL。 宛先 URL は、ユーザーが広告をクリックしたときに誘導される Web ページです。 URL を別の場所にリダイレクトすることはできません。 URL は整形式で、最大 1,024 文字である必要があります。 Web サイトの URL を確認して要求する必要があります。 Microsoft が Web サイトが SSL に準拠していることを確認できない場合、ストアは不承認となります。 マーチャント Web サイトには、SSL ログインページとチェックアウト ページが必要です。 SSL 証明書が有効であることを確認します。 String はい

StoreStatus

ストアの状態を定義します。

名前 値 型
message ストアが不承認になった理由。 オブジェクトには、このフィールドが [不承認] の場合 status にのみ含まれます。 String
status ストアの状態。 使用可能な値を次に示します。
  • 承認済み
  • 不承認
  • ManualReview
ストアが不承認の場合は、理由を参照してください message 。

最初に自動的に承認されたストアは、[承認済み] から [ManualReview] に移動できます。 手動レビュー中のストアに製品を追加することはできません。また、ストア内の製品は提供されません。

不承認の理由によっては、Microsoft 広告アプリケーションを使用して問題を解決できる場合があります。 それ以外の場合は、適切な値を持つ新しいストアを作成する必要があります。		 String

HTTP 状態コード

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

状態コード 説明
200 成功
201 ストアが正常に追加されました。
400 要求が正しくありません。 ほとんどの場合、POST 要求の本文に無効なデータが含まれているか、形式が正しくありません。
401 権限がありません。 ユーザーの資格情報が無効です。
404 見つかりません。 要求されたストアが見つかりませんでした。
500 サーバー エラー。

エラー コード

要求は、次のエラー コードを返す場合があります。

エラー コード 説明
AdultAdvertiserErr 成人の広告主は、ストアを作成することはできません。
DomainNotOwnedByCustomerErr storeUrl フィールドで指定されたドメインは、顧客が所有していません。 顧客がドメインを所有していることを確認します。
DuplicateStoreNameErr 指定したストア名を持つ別のストアが存在します。ストア名は、Microsoft Merchant Center で一意である必要があります。
ExceededMaxStoresForCustomerErr 顧客が作成する可能性があるストアの数を超えました。 制限については、「 ストア POST の追加」を参照してください。
ExceededMaxStoresForDestinationUrlErr 顧客は、同じ宛先 URL を使用して作成する可能性があるストアの数を超えました。 制限については、「 ストア POST の追加」を参照してください。
InvalidStoreDescriptionErr ストアの説明が無効です。 制限については、「 storeDescription」を参照してください。
InvalidStoreDestinationUrlErr storeUrl フィールドで指定したストアの宛先 URL が無効です。
InvalidStoreNameErr ストアの名前が無効です。 制限については、「 storeName」を参照してください。
MarketNotSupportedErr notificationLanguage フィールドで指定した市場が無効です。
NoDomainsFoundForCustomerErr 顧客が所有する検証済みドメインはありません。