メインコンテンツへスキップ
ストアの商品ページを 1 つ読み取り、商品情報を非同期タスク API で JSON として受け取ります。ページの url を渡すと URL からストアを選び、どのストアも同じフィールドを返します。完了した読み取り 1 件につき 3 クレジットです。

リクエスト

タスクを送信したあと、GET /v1/async/task/{id} をポーリングするか Webhook で受け取ります。非同期タスクを参照してください。

パラメータ

  • url: 必須。下の表のストアの商品ページで、2,048 文字以内です。Commerce Search がこれらのストアで返す商品の url はそのまま渡せます。ただし、Yahoo!ショッピングの LOHACO のページ(lohaco.yahoo.co.jp)は受け付けません。トラッキングコードなど結果に影響しないパラメータは読み取り前に取り除きます。
  • country: 任意。デフォルトはストアの国です。ほかの国は 422 REGION_UNSUPPORTED で拒否されます。
Amazon の /gp/product/{ASIN} や 11st のモバイルページなど、同じページの別のアドレスも使えます。

レスポンス例

結果フィールド

  • site、country、url、productId は読み取ったページを示します。url は実際に読み取ったページです。productId はストア独自の商品 ID で(Amazon は ASIN、楽天市場は shop:item)、Commerce Search が返す ID と同じです。ただし、Nykaa で色やサイズの選択肢がある商品は、Commerce Search が選択肢 1 つの ID を、この読み取りは商品ページの ID を返します。
  • title は常に含まれます。ほかのフィールドはページに表示されているときに含まれ、フィールドごとに値を返すストアは下の表のとおりです。
  • price はページが最初に表示する商品を、クーポンと送料の前に購入する価格で、通貨は currency(ISO 4217)です。listPrice はページが取り消し線で示す通常価格で、price より高いときに含まれます。inStock はその商品の在庫の有無、seller は販売者です。
  • rating は 5 段階評価で小数第 2 位までです。reviewCount はレビュー数です。
  • images は商品の画像一覧にある写真の URL をページの順に最大 30 件含みます。11st と Lotte ON はメインの写真 1 枚のみ、Sephora は 2 枚までで、楽天市場と Yahoo!ショッピングでは出店者が画像一覧に載せたバナーやお知らせの画像も含まれます。description は段落ごとに 1 行のプレーンテキストで、最大 10,000 文字です。画像の中にしかない文字は含みません。
  • descriptionImages は出店者の商品説明ページや Amazon の A+ コンテンツなど、商品説明にある画像の URL をページの順に最大 300 件含みます。出店者が説明に載せたバナーやお知らせの画像も含まれ、画像の中の文字は読み取りません。
  • specs は商品詳細の { name, value } の組を最大 100 件含みます。options はサイズや色などの選択肢を最大 20 件含み、選択肢ごとの values は最大 100 件です。ほかのフィールドはページが最初に開く選択肢のものです。categories は広いカテゴリから狭いカテゴリの順で、最大 10 階層です。gtin はページに記載された UPC、EAN、JAN です。
  • google_shopping は Commerce Search が返した商品を読み取ります。url には検索語句、Google の商品 ID、商品名が入っています。同じ検索語句で Google ショッピングを再検索し、その検索語句で商品が表示されない場合は商品名で検索して商品パネルを開くため、ほかのストアより時間がかかります。offers は Google が表示する販売店の一覧で、Google が最安値と表示した販売店が先頭です。各販売店には seller、title(販売店での商品名)、url(販売店の商品ページ)、price、listPrice、currency、inStock が入ります。商品の price、listPrice、seller、inStock は先頭の販売店の値です。reviewCount は Google が正確な件数を表示する場合(1,000 件未満)のみ含まれます。検索語句と商品名のどちらでも商品が表示されない場合、タスクは PAGE_UNAVAILABLE で終了します。
  • ストアが 404 または 410 で応答するページ(削除された商品など)は PAGE_UNAVAILABLE で終了し、メッセージにストアの応答が入ります。ほかの読み取り失敗は ENGINE_NO_RESULT です。課金は完了した読み取りごとです。

関連