ForHosting KIT · サイト取得・監視

BreadcrumbListのJSON-LD生成ツール

画面に表示するパンくずリストを、番号付けや入れ子のJSONを手作業で行わずに構造化データへ変換できます。最上位のページから現在のページまで、表示順にページ名と絶対URLをご入力ください。schema.orgのBreadcrumbListオブジェクトと、headまたはbodyへそのまま配置できる完全なJSON-LD scriptを出力します。空のリスト、不正な行、未入力の名前、使用できないURLは、マークアップを返す前に検証されます。

● Beta無料・ブラウザ内で実行

無料で実行 API仕様を見る

ご利用方法ウェブAPIメールTelegramアプリ近日

ページ上の順序でパンくずを準備します

訪問者に表示されるものと同じ階層をご用意ください。通常、最初の行にはホームページまたは最も広い分類を置き、その後に範囲が狭いページを順番に並べ、最後の行で現在のページを示します。各行には、短く分かりやすい表示名と、HTTPまたはHTTPSの絶対URLが必要です。絶対URLを使うとクローラーにとって解釈が明確になり、テンプレート、プレビュー用ドメイン、CMSの間でも生成したマークアップを利用しやすくなります。名前はリンク先のページと一致させ、検索語を不自然に詰め込まないでください。このツールは入力順をそのまま保持し、1からpositionを割り当てるため、行の並べ替えは経路の意味を変えます。サイトのクロール、階層の推測、HTMLに表示されたナビゲーションとの照合は行いません。生成前にリダイレクト、canonical URL、表記、英字の大文字と小文字をご確認ください。空のリストは有効な経路を伝えられず、テンプレートの不具合や入力漏れを示すことが多いため、エラーになります。

生成されるJSON-LDの内容を確認します

結果には、プログラムで利用できるschemaオブジェクトと、ウェブページへ直接挿入できる完全なscriptが含まれます。最上位ではcontextがschema.orgを指し、typeはBreadcrumbListです。入力された各組はListItemとなり、1から始まるposition、前後の空白を除いたname、itemプロパティのURLを持ちます。読みやすく整形するため、確認が容易で、同じ入力からは常に同じ結果が得られます。また、シリアライズされた値に含まれる小なり記号をエスケープし、入力文字列がHTML内のscript要素を途中で閉じることを防ぎます。空でない名前とHTTPまたはHTTPSの絶対URLだけを受け付け、javascript、data、mailtoなどのスキームや相対パスは拒否します。処理は決定的でネットワーク通信を行わないため、URLの応答やページのインデックス可否は確認しません。別のアプリがシリアライズする場合はschemaオブジェクトを、組み立て不要の完成済みマークアップが必要な場合はjsonldフィールドをご利用ください。

マークアップを公開して検証します

生成したscriptは、経路が表すページに1つだけ追加してください。公開システムの仕様に応じて、文書のheadまたはbodyへ配置できます。構造化された経路は、利用者が実際に表示して移動できるリンクと一致させます。CMSがすでにパンくずの構造化データを出力している場合は、positionやURLが異なる複数版を併記せず、古いブロックを置換または無効化してください。ページの移動、セクション名の変更、canonical URLの更新時には、マークアップも再生成します。公開後は元のテンプレートだけでなく、レンダリング済みHTMLをご確認ください。テーマ、タグ管理ツール、最適化プラグインによってscriptが重複、削除、変更される場合があります。続いて、構造化データのテストツールや検索エンジンの検査機能を使用し、リンク切れ、canonicalタグの競合、別ページへの誤挿入など、生成処理以外の問題を確認してください。正しいJSON-LDは実装条件ですが、検索結果での特定表示を保証するものではありません。API料金は1回$0.002で、ブラウザでは同じ処理をデータ送信なしで実行できます。

活用例

ページテンプレートへ追加

テンプレートの順序付きナビゲーションを、埋め込み可能なBreadcrumbList scriptへ変換します。

CMS出力を統一

記事、商品、カテゴリ、文書セクションで同じJSON-LD形式を生成します。

不足した構造化データを補完

パンくずは表示されていても機械可読な経路がないページに、代替マークアップを作成します。

よくある質問

リストが空の場合はどうなりますか？

BreadcrumbListには有効な項目が1件以上必要なため、入力エラーとして処理されます。

どの順序で入力しますか？

最も広い階層から現在のページまで順番にご入力ください。その順序を保持し、1から番号を付けます。

相対URLを使用できますか？

いいえ。構造化データを明確にするため、各項目にはHTTPまたはHTTPSの絶対URLが必要です。

ページが存在するか確認しますか？

いいえ。通信は行わずURLの構文とスキームだけを検証するため、応答、インデックス、リダイレクト、canonicalタグは確認しません。

生成したブロックはどこに置きますか？

公開システムに合わせてheadまたはbodyへ配置し、重複するパンくずマークアップが出力されないようにしてください。

APIリクエストの料金はいくらですか？

APIは1回$0.002です。同じ決定的な変換をブラウザでも実行できます。

開発者向け — APIアクセス

このページの機能はすべてAPIからも利用できます。自社システムに組み込みたいチーム向けのセクションです。それ以外の方は上のツールをそのままお使いください。

エンドポイント

POSThttps://api.kit.forhosting.com/web/breadcrumb-schema-generate

Bearerトークンで認証し、POST1回でタスクをキューに登録します。結果はWebhookまたは署名付きリンクで受け取れます。

お使いのスタックから呼び出す

curl -X POST https://api.kit.forhosting.com/web/breadcrumb-schema-generate \
  -H "Authorization: Bearer $KIT_KEY" \
  -H "Content-Type: application/json" \
  -d '{"breadcrumbs":[{"name":"Home","url":"https://example.com/"},{"name":"Guides","url":"https://example.com/guides"},{"name":"Technical SEO","url":"https://example.com/guides/technical-seo"}]}'

const res = await fetch("https://api.kit.forhosting.com/web/breadcrumb-schema-generate", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.KIT_KEY}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "breadcrumbs": [
      {
        "name": "Home",
        "url": "https://example.com/"
      },
      {
        "name": "Guides",
        "url": "https://example.com/guides"
      },
      {
        "name": "Technical SEO",
        "url": "https://example.com/guides/technical-seo"
      }
    ]
  })
});
const { task_id } = await res.json();

import os, requests

res = requests.post(
    "https://api.kit.forhosting.com/web/breadcrumb-schema-generate",
    headers={"Authorization": f"Bearer {os.environ['KIT_KEY']}"},
    json={
    "breadcrumbs": [
        {
            "name": "Home",
            "url": "https://example.com/"
        },
        {
            "name": "Guides",
            "url": "https://example.com/guides"
        },
        {
            "name": "Technical SEO",
            "url": "https://example.com/guides/technical-seo"
        }
    ]
},
)
task_id = res.json()["task_id"]

<?php
$res = file_get_contents("https://api.kit.forhosting.com/web/breadcrumb-schema-generate", false, stream_context_create([
  "http" => [
    "method"  => "POST",
    "header"  => "Authorization: Bearer " . getenv("KIT_KEY") . "\r\nContent-Type: application/json",
    "content" => '{"breadcrumbs":[{"name":"Home","url":"https://example.com/"},{"name":"Guides","url":"https://example.com/guides"},{"name":"Technical SEO","url":"https://example.com/guides/technical-seo"}]}',
  ],
]));
$task = json_decode($res, true);

body := bytes.NewBufferString(`{"breadcrumbs":[{"name":"Home","url":"https://example.com/"},{"name":"Guides","url":"https://example.com/guides"},{"name":"Technical SEO","url":"https://example.com/guides/technical-seo"}]}`)
req, _ := http.NewRequest("POST", "https://api.kit.forhosting.com/web/breadcrumb-schema-generate", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("KIT_KEY"))
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)

リクエスト例

{
  "breadcrumbs": [
    {
      "name": "Home",
      "url": "https://example.com/"
    },
    {
      "name": "Guides",
      "url": "https://example.com/guides"
    },
    {
      "name": "Technical SEO",
      "url": "https://example.com/guides/technical-seo"
    }
  ]
}

レスポンス例

{
  "task_id": "tsk_a1b2c3d4e5f6a1b2c3d4e5f6",
  "type": "web.breadcrumb_schema_generate",
  "status": "queued",
  "_links": {
    "result": "/tasks/tsk_…/result"
  }
}

非同期APIです。task_idは即時に返ります。ポーリングは1秒あたり1リクエストまでです。

料金

1リクエストあたり$0.002

単価はすべて公開しています。トークン換算や独自クレジットはありません。失敗したタスクは課金されません。

制限

`timeout_sec`	30
`max_crawl_pages`	25

エラー

HTTP	コード	意味
`401`	`unauthorized`	APIキーが無効か、指定されていません。Authorizationヘッダーを確認してください。
`402`	`insufficient_balance`	残高が不足しています。チャージ後に再度お試しください。
`404`	`unknown_type`	指定されたタスクタイプは存在しません。タイプ名を確認してください。
`429`	`rate_limited`	リクエストが多すぎます。しばらく待ってから再度お試しください。

KITの完全なドキュメントを見る →