検索APIURL

検索API URLとは、MARS Platform 管理画面にて発行した下記フォーマットのURLです。

https://finder.api.mf3stg.marsflag.com/api/v1/finder_service/documents/f1fddd3e/search

こちらのURLを設置するカスタムエレメントの ajax-url属性に設定する必要があります。

設置例

<mf-search-box
  ajax-url="https://finder.api.mf3stg.marsflag.com/api/v1/finder_service/documents/f1fddd3e/search"
  serp-url="minimum.html#/"
></mf-search-box>

リクエストパラメータ

HTTP GET または POST で以下のパラメータを受け付ける。

q - (String) 検索語
input_encoding - (String) 検索語の文字エンコーディング(以下のいずれか)
- utf8 (デフォルト)
- sjis
- jis
- euc-jp
- euc-kr
- iso-8859-1
page_number - (Integer) 取得ページ番号
number_per_page - (Integer) 1 ページ毎の検索結果表示件数
sort_by - (String) ソート (カンマ区切りにて複数指定可能)
- field order,…
  - field
    - score マッチ順 (デフォルト)
    - last_modified 日付順
  - order (省略可能)
    - desc 降順 (デフォルト)
    - asc 照準
category - (String) カテゴリ
drilldown - (String) ドリルダウン (複数指定可能)
- 階層指定は AB のように tab 文字(%09)で区切る
- A OR B のように OR 指定も可能
doctype - (String) ドキュメント種類 (カンマ区切りにて複数指定可能)
- all 全て (デフォルト)
- html HTML のみ
- pdf PDF のみ
callback - (String) JSONP 用のコールバック関数名

レスポンスデータ

JSON で以下の構造からなるデータを返す。

parameter - (map) 次の検索時に引き継ぐデフォルトパラメータ
- q - (String) 検索語
- input_encoding - (String) 検索語の文字コード
- page_number - (Integer) ページ番号
- number_per_page - (Integer) ページ毎の検索結果表示件数
- sort_by - (Array) ソート
- drilldown - (Array) ドリルダウン
- doctype - (Array) ドキュメント種類
- category - (String) カテゴリ
category - (map) カテゴリの情報
- items - (Array<String>) カテゴリのリスト
- selected - (Array<String>) 選択中カテゴリのリスト
facet_drilldown_roots - (Array) ドリルダウンに関する情報
- (map)
  - is_selected - (Boolean) このドリルダウン root で絞り込まれている場合に true がセットされる
  - is_opened - (Boolean) このドリルダウン root もしくはこの下位のドリルダウンで絞り込まれている場合に true がセットされる
  - facet_drilldowns - (Array<FacetDrillDownInfo>) ドリルダウンの階層情報のリスト
spellcheck - (map)
- main_phrase - (String) 類似語候補
organic - (map) 検索結果のページ情報のリスト
- hits - (Integer) ヒットしたページ数
- docs - (Array<OrganicDoc>)
- range_min - (Integer) docs に含まれるデータの検索結果範囲の開始位置
- range_max - (Integer) docs に含まれるデータの検索結果範囲の終端位置
featured_contents - (map) おすすめコンテンツ結果の情報のリスト
- docs - (Array<FeaturedContentsDoc>)

FacetDrillDownInfo

ドリルダウンの階層情報

depth - (Integer) 階層の深さ(最上位階層は 1)
title - (String) 表示テキスト
path - (String) ドリルダウンラベルを最上位から順にタブ区切りで連結した文字列
count - (Integer) この階層内で検索にヒットしたページ数
is_selected - (Boolean) この階層で絞り込まれている場合に true がセットされる
is_opened - (Boolean) この階層もしくはこの下位のドリルダウンで絞り込まれている場合に true がセットされる
children - (Array<FacetDrillDownInfo>) 下位のドリルダウン情報のリスト

OrganicDoc

検索結果のページの情報

ranking - (Integer) 順位
url - (String) ページ URL
title - (String) ページタイトル
description - (String) ページ description
thumbnail_url - (String) サムネイル画像URL
highlight - (map) テキスト毎のハイライト情報
- url_parts - (Array<HighlightInfo>)
- title_parts - (Array<HighlightInfo>)
- description_parts - (Array<HighlightInfo>)
- document_text_parts - (Array<HighlightInfo>)
start_text - (String) BODY タグ先頭のテキスト
doctype - (String) ドキュメント

FeaturedContentsDoc

おすすめコンテンツ結果の情報

title - (String) ページタイトル
url - (String) ページ URL
thumbnail_url - (String) サムネイル画像URL

HighligntInfo

テキストのハイライト情報

is_highlighted - (Boolean) 以下のいずれか
- false ハイライト無し
- true ハイライト有り
text - (String) テキスト文字列

サンプル

レスポンスデータ(整形済み)

{
  "parameter": {
    "q": "service",
    "input_encoding": "utf8",
    "page_number": 1,
    "number_per_page": 1,
    "sort_by": [
      "score"
    ],
    "category": "",
    "drilldown": [

    ],
    "doctype": [
      "all"
    ]
  },
  "organic": {
    "hits": 39,
    "range_min": 1,
    "range_max": 1,
    "docs": [
      {
        "ranking": 1,
        "url": "https://www.marsflag.com/en/",
        "title": "MARS FLAG Corporation",
        "description": "BEYOND EMOTION Bringing excitement to website search technology. As Japan's first search platformer with the largest domestic market share, we provide web services based on search technology to domestic and overseas companies and government agencies.",
        "start_text": "BEYOND\nEMOTION\n \nMaking search te\nABOUT US\nJapan's first search platformerwith the largest domestic market share\nSince its establishment in 1998, MARS FLAG Co., Ltd. has always been at the vanguard of the industry with search technology. We support your site management with powerful web services based on search technology.\nABOUT US\n \n \nOUR SERVICES\nThe most popular website search tool in Japan\nMARS FINDER is a website search service designed to maximize the capabilities of your website. It guides website visitors to the information they need quickly and accurately. MARS FLAG's search technology and its rich functions and user-friendliness are highly regarded, and it is currently used by many companies, organizations, and government offices around the world.\nNo.1 in Japan*\n*Adapted from FY2021 Search Engine Market (SaaS) in Software Business New Market 2022 Edition by Fuji Chimera Research Institute, Inc.\nSERVICE DETAILS\nCASE STUDIES\nProduct Search Platform\nEasy start without knowledge ",
        "content_size": 22722,
        "last_modified": 1675755999,
        "doctype": "html",
        "drilldown": [
          "その他"
        ],
        "highlight": {
          "url_parts": [

          ],
          "title_parts": [

          ],
          "description_parts": [
            {
              "text": " with the largest domestic market share, we provide web ",
              "is_highlighted": false
            },
            {
              "text": "services",
              "is_highlighted": true
            },
            {
              "text": " based on search technology to domestic",
              "is_highlighted": false
            }
          ],
          "document_text_parts": [
            {
              "text": " industry with search technology. We support your site management with powerful web ",
              "is_highlighted": false
            },
            {
              "text": "services",
              "is_highlighted": true
            },
            {
              "text": " based on search",
              "is_highlighted": false
            }
          ]
        },
        "thumbnail_url": "https://image.mf3.marsflag.com/screenshot/https/www.marsflag.com/en/-/-/cap_org.jpg"
      }
    ]
  },
  "category": {
    "items": [
      "製品・サービス",
      "導入事例",
      "会社情報",
      "メールマガジン"
    ],
    "selected": [

    ]
  },
  "facet_drilldown_roots": [
    {
      "is_selected": false,
      "is_opened": true,
      "facet_drilldowns": [
        {
          "depth": 1,
          "title": "製品・サービス",
          "path": "製品・サービス",
          "count": 0,
          "is_selected": false,
          "is_opened": false,
          "children": [
            {
              "depth": 2,
              "title": "FAQ",
              "path": "製品・サービス\tFAQ",
              "count": 0,
              "is_selected": false,
              "is_opened": false,
              "children": [

              ]
            },
            {
              "depth": 2,
              "title": "導入事例",
              "path": "製品・サービス\t導入事例",
              "count": 0,
              "is_selected": false,
              "is_opened": false,
              "children": [
                {
                  "depth": 3,
                  "title": "導入インタビュー",
                  "path": "製品・サービス\t導入事例\t導入インタビュー",
                  "count": 0,
                  "is_selected": false,
                  "is_opened": false,
                  "children": [

                  ]
                }
              ]
            }
          ]
        },
        {
          "depth": 1,
          "title": "ニュース",
          "path": "ニュース",
          "count": 0,
          "is_selected": false,
          "is_opened": false,
          "children": [

          ]
        },
        {
          "depth": 1,
          "title": "メールマガジン",
          "path": "メールマガジン",
          "count": 0,
          "is_selected": false,
          "is_opened": false,
          "children": [

          ]
        },
        {
          "depth": 1,
          "title": "会社情報",
          "path": "会社情報",
          "count": 1,
          "is_selected": false,
          "is_opened": false,
          "children": [
            {
              "depth": 2,
              "title": "スポンサード",
              "path": "会社情報\tスポンサード",
              "count": 0,
              "is_selected": false,
              "is_opened": false,
              "children": [

              ]
            },
            {
              "depth": 2,
              "title": "スタッフ紹介",
              "path": "会社情報\tスタッフ紹介",
              "count": 0,
              "is_selected": false,
              "is_opened": false,
              "children": [

              ]
            },
            {
              "depth": 2,
              "title": "採用情報",
              "path": "会社情報\t採用情報",
              "count": 0,
              "is_selected": false,
              "is_opened": false,
              "children": [

              ]
            }
          ]
        },
        {
          "depth": 1,
          "title": "その他",
          "path": "その他",
          "count": 38,
          "is_selected": false,
          "is_opened": false,
          "children": [

          ]
        }
      ]
    }
  ],
  "spellcheck": {
    "main_phrase": ""
  },
  "featured_contents": {
    "docs": [
      {
        "title": "MARS FINDER",
        "url": "https://www.marsflag.com/ja/marsfinder/",
        "thumbnail_url": "https://www.marsflag.com/wp-content/uploads/2020/05/mf_top.jpg"
      },
      {
        "title": "MARS SCREEN",
        "url": "https://www.marsflag.com/ja/marsscreen/",
        "thumbnail_url": "https://www.marsflag.com/wp-content/uploads/2019/11/MSF_ProductSearch_3.jpg"
      },
      {
        "title": "MARS EXPLORER",
        "url": "https://www.marsflag.com/ja/marsexplorer/",
        "thumbnail_url": "https://www.marsflag.com/wp-content/uploads/2020/05/mps_top.jpg"
      },
      {
        "title": "MARS QUALITY",
        "url": "https://www.marsflag.com/ja/marsquality/",
        "thumbnail_url": "https://www.marsflag.com/wp-content/uploads/2019/11/MSF_4041.jpg"
      },
      {
        "title": "MARS Platform",
        "url": "https://www.marsflag.com/ja/marsplatform/",
        "thumbnail_url": "https://image.mf3.marsflag.com/screenshot/https/www.marsflag.com/ja/marsplatform/-/-/cap_org.jpg"
      }
    ]
  }
}

カスタムエレメントドキュメント - 検索URL

トップ > カスタムエレメントドキュメント - 検索URL

リファレンスマニュアル内検索