DevTools Japan トップへ

WebSite構造化データ生成

schema.org WebSite + SearchAction(サイトリンク検索ボックス)JSON-LD をリアルタイム生成

サイト情報

サイトのトップページ(ホームページ)の正規URL。末尾のスラッシュ有無は実際のURLに合わせてください。
サイトの略称・愛称・英語表記など。検索でサイト名の別表記を伝えたいときに入力します。
BCP 47 の言語タグ。日本語サイトなら ja、英語なら en など。空欄にすると出力から除外されます。

サイト内検索(SearchAction・任意)

サイト内検索の結果ページURLに {search_term_string} を含めてください。この欄が空だと SearchAction は出力されません。

生成された JSON-LD

// 入力するとここに JSON-LD が表示されます

サイトリンク検索ボックス要件のヒント

生成される JSON-LD は schema.org の WebSite 型に基づき、検索URLテンプレートを入力すると potentialAction として SearchAction(EntryPoint の urlTemplate + query-input)を組み込みます。空欄のフィールドは自動的に除外されます。サイトリンク検索ボックスはサイトのホームページに1つだけ設置するのが原則です。実装後は Google のリッチリザルトテストで検証することを推奨します。すべての処理は端末内で完結し、入力内容は送信されません。

WebSite構造化データ生成ツールの使い方

サイト名・サイトURL・サイト内検索のURLテンプレートを入力するだけで、schema.org の WebSite 型に準拠した JSON-LD 構造化データをリアルタイムに生成する無料ツールです。検索URLテンプレートを入力すると、potentialAction として SearchAction(サイトリンク検索ボックス、Sitelinks Searchbox)を自動で組み込みます。生成された ld+json のスクリプトタグ一式をコピーして、サイトのホームページのHTMLに貼り付けるだけで、検索エンジンにサイトの基本情報とサイト内検索の仕組みを伝えられます。インストールや会員登録は不要で、入力した内容はサーバーに送信されず、すべての生成処理がお使いのブラウザ内で完結します。

使い方はシンプルです。まず必須のサイト名とサイトURLを入力し、必要に応じて別名(alternateName)やコンテンツの言語(inLanguage)を埋めます。続いてサイト内検索を持っている場合は、検索結果ページのURLに検索語のプレースホルダ {search_term_string} を含めた検索URLテンプレートを入力します。入力を変更するたびに下部の出力エリアの JSON-LD が即座に更新されるので、内容を確認しながら仕上げられます。空欄の項目は出力から自動で除外されるため、埋めたい項目だけを入力すれば有効な構造化データになります。

SearchAction(サイトリンク検索ボックス)の仕組み

Google のサイトリンク検索ボックスは、検索結果にあなたのサイト専用の検索窓を表示する機能です。これを狙うには、WebSite の potentialAction に SearchAction を記述します。SearchAction の target には検索結果ページのURLテンプレートを EntryPoint の urlTemplate として指定し、query-input には required name=search_term_string を設定します。本ツールでは、入力された検索URLテンプレート内の {search_term_string} がそのままプレースホルダとして機能し、正しい形の SearchAction を自動で組み立てます。

生成されるプロパティ

本ツールが出力する主な WebSite / SearchAction プロパティは次のとおりです。必須級の項目と任意項目を区別して、必要なものだけを入力してください。

プロパティ内容形式
@typeWebSite固定(必須)
nameサイト名文字列(必須)
urlサイトのトップページURLURL文字列(必須)
alternateNameサイトの別名・略称文字列(任意)
inLanguageコンテンツの言語BCP 47(例: ja)
potentialActionサイト内検索アクションSearchAction 型
target検索結果URLテンプレートEntryPoint / urlTemplate
query-input検索語の入力定義required name=search_term_string

設置と検証のための推奨事項

サイトリンク検索ボックスを狙う場合、WebSite の構造化データは原則としてサイトのホームページに1つだけ設置します。検索URLテンプレートは、実際に動作するサイト内検索の結果ページのURL形式に正確に合わせることが重要です。{search_term_string} の位置に検索語が入ったとき、そのURLで本当に検索結果が表示されるかをブラウザで確認しておきましょう。なお、構造化データを記述しても検索結果への表示可否は Google が自動的に判断するため、必ずしも検索ボックスが表示されるとは限りません。実装後は Google のリッチリザルトテストや schema.org バリデータでエラー・警告を確認しましょう。JSON-LD はHTMLの表示位置に影響しないため、head 内・body 内のどちらに置いても構いません。

よくある質問

WebSiteの構造化データとは何ですか?
WebSite構造化データは、サイト全体を表す schema.org の WebSite 型の情報を、検索エンジンが理解できる JSON-LD 形式で記述したものです。サイト名(name)や正規URL(url)、別名(alternateName)などを含みます。さらに potentialAction として SearchAction を加えると、サイト内検索の仕組みを検索エンジンに伝えられます。本ツールは入力内容から、この WebSite と SearchAction をひとつにまとめた JSON-LD を自動生成します。
SearchAction(サイトリンク検索ボックス)とは何ですか?
SearchAction は、あなたのサイトのサイト内検索機能を表す schema.org のアクション定義です。WebSite の potentialAction として記述すると、Google の検索結果に「サイトリンク検索ボックス(Sitelinks Searchbox)」が表示される対象になり得ます。ユーザーが検索結果から直接サイト内を検索できるようになり、目的のページへ素早く誘導できます。ただし表示可否は Google が自動判定するため、記述しても必ず表示されるとは限りません。
検索URLテンプレートはどう書けばよいですか?
サイト内検索の結果ページのURLに、検索語が入る位置へプレースホルダ {search_term_string} を置いた形で入力してください。たとえば検索結果が https://www.example.com/search?q=キーワード の形式なら、テンプレートは https://www.example.com/search?q={search_term_string} と書きます。ツールはこれを SearchAction の target(EntryPoint の urlTemplate)に設定し、query-input を required name=search_term_string として自動で組み立てます。
入力していない項目はどうなりますか?
空欄のフィールドは JSON-LD に含まれず自動的に除外されます。別名(alternateName)や検索URLテンプレートは任意項目のため、必要なものだけ入力すれば構いません。検索URLテンプレートを空欄にすると potentialAction(SearchAction)ブロック全体が出力から除かれ、サイト名とURLだけのシンプルな WebSite 構造化データになります。値のないプロパティが空文字として残らないため、常に有効な構造化データを生成できます。
生成したJSON-LDはどこに貼り付けますか?
生成された ld+json のスクリプトタグ一式をコピーし、サイトのトップページ(ホームページ)のHTMLの head 内、または body 内に貼り付けてください。サイトリンク検索ボックスを狙う場合は、原則としてサイトのホームページに1つだけ設置します。貼り付け後は Google のリッチリザルトテストや schema.org バリデータで、エラーや警告がないか確認することを推奨します。JSON-LD はページの見た目に影響しません。

関連ツール

Recipe構造化データ生成ツール一覧へ