手順5: アップロードしたカタログにエラーがないか検証する


手順5: アップロードしたカタログにエラーがないか検証する

カタログファイルのアップロード後は、新しいカタログファイルをアップロードするたびに、カタログデータのインポート結果について成功か失敗かを示すレポートがカタログバケットに配信されます。このレポートを確認して、カタログにエラーがないことを確認します。エラーがある場合は、統合レポートに含まれているメッセージの内容を確認して、カタログファイルのトラブルシューティングを行う必要があります。

カタログ統合レポートの取得とその内容

Amazonのカタログとの統合のためにAmazon Simple Storage Service(S3)バケットにカタログデータをアップロードすると、カタログ統合システムにより、カタログファイルが使用可能かどうかを報告する統合レポートが4時間以内に生成されます。このレポートには、成功または失敗の全般的なステータス、ファイル内に見つかった問題、および各問題の詳細が記載されています。

統合レポートの取得

統合レポートはreport.htmlという名前のHTMLファイルで、カタログファイルのアップロード先と同じS3バケット内に配信されます。新しいレポートが作成されたことを通知するEメールを受信するかどうかを選択できます。この通知には、レポートの概要と、レポート全体をダウンロードするためのコマンドが記載されています。 

統合ステータスの通知Eメールを受け取る方法

統合レポートのサマリーをEメールで受け取るには、p11-catalog-subscriptions@amazon.com宛てにEメールを送信し、カタログの配信リストへの登録を依頼します。Amazonがその依頼を検証し、開発者をリストに登録します。

成功を通知するEメールと失敗を通知するEメールは別々に送信されます。両方のEメールの受信を希望する場合は、両方のリストへの追加を依頼してください。レポートは、アップロードごとに1回、または統合ステータスが変更されたときに作成されます。

Eメール内の情報を活用する方法

受信するEメールには、統合の成功または失敗のステータスが示されます。統合に失敗した場合、エラーはEメール内ではなく詳細なレポートに表示されます。Eメールには、詳細なレポートを取得するためのアマゾンウェブサービス(AWS)コマンドも記載されています。

AWSコマンドを使用してレポートを取得するには、まずアマゾンウェブサービスのコマンドラインインターフェイス(CLI)ツールをインストールする必要があります。インストール後、通常のコマンドウィンドウまたはターミナルウィンドウでAWSコマンドを使用できます。この方法により、開発者のカタログ情報が確実に保護されます。このコマンドを使用してレポートを取得できるのは、開発者のS3バケットへのアクセス権を持つユーザーのみに制限されるためです。

以下に、レポートを取得するAWSコマンドの例を示します。Eメールからこの行をコピーして、コマンドウィンドウまたはターミナルウィンドウに貼り付けます。

aws s3api get-object --bucket cdf-test --key reports/report.html --version-id FciuqMvVh2oWFv726L6Ytf8ECLbO6Kj0 report.html

このコマンドが正常に実行されると、現在のフォルダにレポートがダウンロードされます。ダウンロードされるファイルの名前はreport.htmlです(コマンドの詳細については、AWS CLIコマンドリファレンスのget-objectのページを参照してください)。

AWS CLIコマンドに加えて、Eメールにはレポートに直接アクセスするためのリンクも記載されています。このリンクは7日間有効です。このリンクを使用するとだれでも詳細なレポートにアクセスできるため、Eメールを転送する場合は注意してください。

統合レポートの内容

統合レポートは次の3つのセクションに分かれています。

  • 概要。成功と失敗のどちらかのステータスが記載されています。
  • エラー、警告、推奨事項。
  • 追加、削除、更新、未変更のカタログエントリのカウント。

概要

以下に、統合レポートの概要セクションの例を示します。

統合レポートの概要セクションの例

概要には、統合の試行ごとに付与された一意のID、使用されたカタログ、統合の試行が行われた日時、試行の結果が記載されています。試行の結果は次のいずれかになります。

  • 成功: カタログにエラーは見つかりませんでした。ただし、有用な警告や推奨事項がある場合があります。カタログ情報はAmazonのカタログに統合されました。

  • 失敗: エラーがあると、そのカタログは使用されません。前回正常に統合されたカタログが引き続き有効なカタログとして使用されます。レポートのエラー、警告、推奨事項のセクションで、問題の詳細情報を確認できます。

上記の例では、9個のエラーによって統合が失敗しています。警告と推奨事項も多数生成されていますが、このカテゴリーのメッセージは通常、統合が失敗する原因にはなりません(画像関連の警告と推奨事項は例外です)。追加、削除、更新の数はすべて0となっています。これは、統合が失敗し、アップロードしたカタログが使用されなかったためです。未変更の数が0であるのは、変更対象となる以前のカタログが存在しないことを意味しています。

いずれかのボックスをクリックすると、レポートの該当するセクションに移動できます。

エラー、警告、推奨事項

このセクションでは、問題を修正するために必要な情報を確認できます。レポートの情報を表示するには、次のようにセクションを展開します。

  • 各セクションの [詳細] ボタンをクリックすると、セクションが展開され、個々のメッセージが一覧表示されます。各メッセージの末尾にある数字は、該当するエントリの数です。
  • 各メッセージの隣にあるプラス記号をクリックすると、メッセージが生成された作品のIDが表示されます。エラーの詳細が含まれた追加のメッセージが表示される場合もあります。以下は、2つのエラーを展開した例を示しています。
エラーを展開し、詳細を表示した例

エラーのセクションで問題が見つかった場合、統合は失敗しますが、警告と推奨事項では通常、統合は成功します。そのため、統合が成功した場合でも、レポートには、確認する必要のある警告や推奨事項が多数記載されている場合があります。

カウント

レポートの最後のセクションには、統合に際してカタログに加えられた変更の詳細が記載されています。このセクションでも、各カテゴリーの [詳細] ボタンをクリックすると各作品のIDが表示されます。予期される変更のリストを用意しておくと、最終確認として、このセクションをリストと比較できます。

統合が失敗すると、アップロードしたカタログは使用されないため、「追加」、「削除」、「更新」の値は0になります。「未変更」の値は、前回統合に成功したカタログのカタログエントリの数を示します。

統合が成功した場合は、「追加」、「削除」、「更新」、「未変更」の値が期待される結果と一致するはずです。前述したとおり、このセクションのカウントは、ほかの検証結果に基づいて統合が成功した場合でも、カタログに問題があることを示していることがあります。

統合レポートに基づくアクション

以下は、統合ステータスに応じて実施する必要のある作業です。

  • 成功: 追加、削除、更新、未変更の数が予期したとおりであれば、必要な作業はありません。ただし、警告と推奨事項に対処することを検討してください。各エントリの説明と対処法については、カタログ統合レポートのメッセージを参照してください。
  • 失敗: 「エラー」セクションの各エントリの説明と対処法については、カタログ統合レポートのメッセージを参照してください。必要な作業やその方法が不明な場合は、Amazonビジネスデベロッパーマネージャーにお問い合わせください。

統合レポートに関するよくある質問(FAQ)

Q: 統合レポートとは何ですか?
A: このレポートは、カタログがAmazonに正常に統合されたかどうかと、統合されなかった場合はその理由を示すものです。最新のカタログをアップロードした後、通常は4時間以内に、レポートの新しいコピーがreport.htmlとしてS3バケットに追加されます。このレポートを使用して、カタログファイル内の問題のトラブルシューティングを行うことができます。レポートには、統合の成功または失敗を示すステータスと、エラー、警告、推奨事項が含まれています。
Q: アップロードしたカタログファイルがシステムに統合されたかどうかは、どうすればわかりますか?
A: 統合の結果はオプトインメールで受け取ることができます。メールには詳細なレポートをダウンロードできるリンクも記載されています。
Q: カタログ統合の結果のメール配信リストに登録するにはどうすればよいですか?
A: p11-catalog-subscriptions@amazon.comに登録依頼のメールを送信してください。成功と失敗のレポートは別々のEメールリストになっているため、両方のリストへの登録を依頼してください。
Q: カタログ統合に失敗しました。次は何をすればよいですか?
A: 統合レポートで、失敗を引き起こした具体的なエラーを確認してください。統合レポートのドキュメントには、各エラーの説明とフォローアップの指示が記載されています。必要に応じて、担当のAmazonビジネスデベロッパーマネージャーがカタログの問題への対処をお手伝いします。カタログ統合レポートのメッセージを参照してください。