Status Resource
Status リソースを使用すると、指定したカタログにアップロードした製品オファーの状態を取得できます。 オファーをカタログにアップロードすると、検証と編集レビュー プロセスが実行されます。 このプロセスには最大 36 時間かかることがあります。 オファーは、レビュー プロセスが完了した後にのみレポートに含まれます。
プロセスのしくみの概要については、「製品オファーの状態を取得する方法」を参照してください。
カタログの状態を取得し、レポートをダウンロードする方法を示すコード例については、「 カタログ状態レポートのダウンロード」を参照してください。
ベース URI
テンプレートを追加するベース URI を次に示します。
https://content.api.bingads.microsoft.com/shopping/v9.1/bmc/
テンプレート
カタログ内の製品オファリングの状態を取得するために使用されるエンドポイントを作成するには、ベース URI に適切なテンプレートを追加します。
注:
{bmcMerchantId}/catalogs/{catalogId}/status は非推奨となり、使用することはお勧めしません。
| テンプレート | HTTP 動詞 | 説明 | リソース |
|---|---|---|---|
{bmcMerchantId}/catalogs/{catalogId}/status |
GET | を使用して、検証と編集レビューに合格または失敗したアップロードされたオファーの数を取得します。 MMC ストア ID に設定 {bmcMerchantId} します。カタログの ID に設定 {catalogId} します。 |
要求: N/A 応答: 状態 |
クエリ パラメーター
エンドポイントには、次のクエリ パラメーターが含まれる場合があります。
| パラメーター | 説明 |
|---|---|
| alt | オプション。 を使用して、要求と応答で使用されるコンテンツの種類を指定します。 使用可能な値は json と xmlです。 既定値は json です。 |
ヘッダー
要求ヘッダーと応答ヘッダーを次に示します。
| ヘッダー | 説明 |
|---|---|
| 承諾 | 要求ヘッダー。<p>レポートをダウンロードするときに、このヘッダーを含めます。 このヘッダーは に設定する application/x-zip-compressed必要があります。 |
| AuthenticationToken | 要求ヘッダー。 このヘッダーを OAuth 認証トークンに設定します。 トークンの取得の詳細については、「 資格情報の認証」を参照してください。 |
| Content-Location | 応答ヘッダー。 製品が挿入されたストアを識別する URL。 このヘッダーは、Insert 要求の応答に含まれます。 |
| CustomerAccountId | 要求ヘッダー。 ヘッダーで CustomerId 指定された顧客に代わって管理する任意のアカウントのアカウント ID。 指定したアカウントは関係ありません。 このヘッダーは、顧客の代わりにアカウントを管理する場合にのみ指定します。 |
| Customerid | 要求ヘッダー。 ストアを管理する顧客の顧客 ID。 このヘッダーは、顧客の代わりにストアを管理する場合にのみ指定します。 このヘッダーを設定する場合は、ヘッダーも設定する CustomerAccountId 必要があります。 |
| DeveloperToken | 要求ヘッダー。 クライアント アプリケーションの開発者アクセス トークン。 各要求には、このヘッダーを含める必要があります。 トークンの取得の詳細については、「Microsoft Advertising の資格情報と開発者トークンはありますか?」を参照してください。 |
| 場所 | 応答ヘッダー。 製品が挿入されたストアを識別する URL。 このヘッダーは、Insert 要求の応答に含まれます。 |
| WebRequestActivityId | 応答ヘッダー。 要求に関する詳細を含むログ エントリの ID。 エラーが発生した場合は、常にこの ID をキャプチャする必要があります。 問題を特定して解決できない場合は、この ID をサポート チームに提供する他の情報と共に含めます。 |
要求オブジェクトと応答オブジェクト
API で使用される要求オブジェクトと応答オブジェクトを次に示します。
各オブジェクトは、要求に指定したコンテンツ タイプに応じて使用する JSON キー名と XML 要素名を定義します。
| オブジェクト | 説明 |
|---|---|
| 状態 | カタログにアップロードされた製品オファリングの状態を定義します。 |
状態
カタログにアップロードされた製品オファリングの状態を定義します。 オブジェクトの XML 名は <catalogStatus です>。
| 名前 | 値 | 型 | XML 要素名 |
|---|---|---|---|
| catalogId | 報告されるカタログの ID。 | ulong | <catalog_id> |
| publishedCount | 検証と編集レビューに合格したオファリングの数。 | ulong | <published_count> |
| rejectedCount | 検証と編集レビューに失敗したオファリングの数。 この数は、レポート本文の行数を示します (「 レポート形式」を参照)。 | ulong | <rejected_count> |
| rejectionReportUrl | レポートのダウンロードに使用する URL。 オブジェクトには、このフィールドが 0 より大きい場合 rejectedCount にのみ含まれます。レポートは圧縮され、読み取る前に解凍する必要があります。 |
string | <catalog_id> |
HTTP 状態コード
要求は、次の HTTP 状態コードを返す場合があります。
| 状態コード | 説明 |
|---|---|
| 200 | 成功 |
| 400 | 要求が正しくありません。 クエリ パラメーターの値が無効であるか、レポート URL ( 「rejectionReportUrl」を参照) が無効になっています。 |
| 401 | 権限がありません。 ユーザーの資格情報が無効です。 |
| 404 | 見つかりません。 指定されたカタログに対して状態が使用できないか、カタログまたはストア ID が無効です。 |
| 500 | サーバー エラー。 |
レポート形式
ダウンロードしたレポート ファイルは、Zip 圧縮フォルダー (*.zip) に含まれています。 レポートを読み取る前に、フォルダーとその内容を解凍する必要があります。 レポートは、MerchantCatalogReport.csv という名前のコンマ区切りのファイルです。
レポートはヘッダー セクションとレポート本文セクションに分割されます。 最初の行には、ヘッダー セクションの次の列名が含まれています。
| 列名 | 説明 |
|---|---|
| カタログ名 | カタログの名前。 |
| カタログ ID | カタログの ID。 |
| ストア ID | カタログを含むストアの ID。 |
| アップロード時間 | 使用しないでください。 このフィールドが存在する場合は、無視します。 |
2 行目にはヘッダー データが含まれています。
3 行目は空白です。
4 行目には、レポート本文の次の列名が含まれています。これは 5 行目から始まります。
| 列名 | 説明 |
|---|---|
| アイテム ID | 検証または編集レビューに失敗したオファーの offerId 。 レポートには一意の ID が含まれます。 |
| メッセージ | 報告されているエラー。 |
| 型 | エラーの種類。 指定できる値は、Error または Warning です。 |
| 値 | エラーが無効な値によって発生した場合、エラーの原因となったデータ値。 |
| オファー スニペット | オファー データのサブセットのセミコロン区切りのリスト。 形式は title です。productType;link;imageLink;価格;salePrice;saleStartDate;saleEndDate。 すべてのエラーにすべてのコンポーネントが含まれるわけではありません。 |
レポートの例については、「レポートの 例」を参照してください。