プレビューHTML参照API

2024年9月6日
本APIは提供終了を予定しています。
詳細につきましては、以下ページをご覧ください。
【Yahoo!ショッピング】【重要】プレビューHTML参照APIの提供終了のお知らせ

ストアページにおける反映前のプレビュー状態をHTMLで取得します。

リクエストURL

XML
https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/getPreviewHtml

こちらはテスト用APIもご利用いただけます。URLは以下の通りです。
https://test.circus.shopping.yahooapis.jp/ShoppingWebService/V1/getPreviewHtml
テスト用APIを利用したい場合は、こちらから利用申請をお願いします。

リクエストパラメータ

「Web APIの使い方#GETとは」をご参照ください。

パラメータ 値 説明
seller_id
（必須）		 string ストアアカウントを指定します。
page_key string ページキー
なにも指定しない場合はストアトップページになります。
device_flg string
（デフォルト : 1）		 プレビューページの対象デバイスを指定します。
1の場合、PC版プレビューページを取得します。
2の場合、 スマホ版レビューページを取得します。

指定を省略した場合のデフォルト値は1です。

スマホ版プレビューで取得できるページは、商品詳細ページのみです。

ページキーについて

  • ページキーとは、PC版URL"http://store.shopping.yahoo.co.jp/{storename}/{pagekey}"におけるpagekeyに該当する文字列です。（".html"は不要です。）
  • 商品詳細ページでは、ページキーは商品コードとなりますが、商品コードの大文字はURLでは小文字化されます。
  • カスタムページでは、ページキーはページIDとなりますが、ページIDの大文字はURLでは小文字化されます。
  • カテゴリページでは、カテゴリ名が英数字のみで構成されている場合はカテゴリ名がそのままページキーとなります。（大文字は小文字化されます。）
  • カテゴリ名にマルチバイト文字が使用されている場合は、マルチバイト文字が英数字に変換されカテゴリIDとなります。
  • その他にもinfo（会社概要）、guide（お買いものガイド）、privacypolicy（プライバシーポリシー）、autherr（隠しページ認証エラーページ）などもページキーです。
  • ページキーのリクエストが無い場合、ストアトップとなります。

※こちらのAPIはYahoo! ID連携に対応したAPIです。
Yahoo! ID連携によるAPIアクセス方法の詳細は、以下のページをご確認ください。

※こちらのAPIを利用する場合は、こちらからClient ID（アプリケーションID）を取得してください。

サンプルリクエストURL

https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/getPreviewHtml?seller_id=test-store

サンプルリクエスト

GET /ShoppingWebService/V1/getPreviewHtml?seller_id=test-store HTTP/1.1
Host: circus.shopping.yahooapis.jp
Authorization: Bearer <アクセストークン>

レスポンスフィールド

フィールド 説明
/ResultSet クエリーレスポンスのすべてを含みます。
/ResultSet/Result 結果
/ResultSet/Result/Html HTML

サンプルレスポンス

※実際のプレビュー画面のHTMLのCSSを<link>タグから<style>タグへと変更して中身のCSSを展開しています。

<?xml version="1.0" encoding="UTF-8" ?>
<ResultSet>
    <Result>
        <Html><![CDATA[<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
              <html><head>
              <meta name="keywords" content="テストテスト">
              <meta name="description" content="テストテスト:1:6Hills - Yahoo!ショッピング - ネットで通販、オンラインショッピング">
              <link rel="canonical" href="http://store.yahoo.co.jp/test-store/1.html">
 <script src="http://i.yimg.jp/images/commerce/js/service/shp/rtoaster/1.0.2/Rtoaster.js" type="text/javascript"></script>
 <script type="text/javascript">
 Rtoaster.init("RTA-6606-26d3dc7e127d");
 Rtoaster.track();
 </script>
 <title>SHPテスト:1:6Hills - Yahoo!ショッピング - ネットで通販、オンラインショッピング</title>
 <style>/* STYLE v1.0 */ body{ background-color:#ffffff; ; margin:0; padding:0; text-align:center; } #wrapper2{ color:#333333; } #wrapper2 th, #wrapper2 td{ color:#333333; } #hdHeadLine li h1{ color:#999999; margin:0; padding:0; font-weight:normal; font-size:x-small; f\ont-size:small; text-align:right; } h2{ color:##333333; } h2.ptFree{ font-size:small; f\ont-size:medium; font-weight:normal; }</style>
 <script type="text/javascript" src="http://i.yimg.jp/images/store/shp/js/window.js"></script>
 </head></html>]]></Html>
    </Result>
</ResultSet>

エラー

Yahoo!ショッピングで提供している全てのAPIには、共通で利用するエラーコードがあります。エラーの際には、まず始めに以下をご確認ください。

商品系API、およびプレビューHTML参照APIで固有に返すエラーコードは以下をご覧ください。

商品系API共通エラーコード

コード HTTPステータスコード 説明
ed-00000 404 ページが見つかりません。
ed-00001 500 システムエラーが発生しました。
ed-00002 503 サーバがメンテナンス中です。
ed-00003 400 ストアアカウントが指定されていません。
ed-00004 400 ストアアカウントが存在しません。
ed-00005 400 ストアアカウントの指定が不正です。

エラーコード

コード HTTPステータスコード 説明
ds-01001 400 指定されたページが見つかりませんでした。
ds-01002 400 device_flgに指定可能な値は1または2です。

利用制限

※短い時間の間に同一URLに大量にアクセスを行った場合、一定時間利用できなくなることもございます。（1クエリー/秒）

利用約款

このAPIに関する利用約款はこちら。

アプリケーションの管理

目次

利用のルール

開発のヒント