XMLサイトマップを自動生成する方法
URLの一覧を渡すと、検索エンジンに送信できる形式のXMLサイトマップを自動で作成する機能です。更新日時や優先度もあわせて指定できます。
作成手順
含めたいURLの一覧を渡すと、検索エンジン向けの仕様に沿ったXML形式のサイトマップとして出力します。更新日時(lastmod)を各URLに指定することもできます。
CMSを使っていないサイト向け
自動生成機能を持たない静的サイトや、独自システムで構築されたサイトでは、公開しているページのURLを渡すだけでサイトマップを用意できます。
更新の運用
新しいページを追加した際は、更新後のURL一覧を渡すことで、その都度サイトマップを作り直せます。APIから自動化することで、公開のたびに更新することも可能です。
生成後の確認
作成したサイトマップは、この機能の隣にあるサイトマップチェックでエラーがないかを確認してから公開することをおすすめします。
活用例
静的サイトのサイトマップ整備
合同会社みどりデザインでは、CMSを使わず手作業で構築したサイトのURL一覧を渡し、公開用のサイトマップを作成しています。
新規ページ追加時の更新
株式会社山田商事のWeb担当は、新しい商品ページを追加するたびにURL一覧を更新し、サイトマップを作り直しています。
公開フローの自動化
フリーランスの田中大輔さんは、ページ公開のたびにAPIからこの機能を呼び出し、サイトマップの更新を自動化しています。
よくある質問
渡したURL一覧はどのように扱われますか?
渡していただいたURLは、このリクエストでのサイトマップ生成にのみ使用します。第三者への提供や公開は行いません。
一度に何件のURLを含められますか?
1回のリクエストで含められるURL数には上限があります。大規模なサイトの場合は複数のサイトマップに分けてご利用ください。
なぜ利用ごとの支払いなのですか?
渡されたURLからXMLファイルを組み立てる処理のため、実行のたびに費用が発生します。アカウント登録や月額の契約は不要です。
日本語のサポートはありますか?
申し訳ありませんが、日本語でのサポートは行っておりません。サポートは英語またはスペイン語で、担当者が直接対応します。日本語サイトのURLでも問題なくご利用いただけます。
料金はいくらですか?
1リクエストあたり$0.002です。含めるURL数による追加料金はありません。
URLが実際に存在するかも確認してくれますか?
いいえ、渡されたURLをそのままサイトマップに組み込みます。URLの存在確認が必要な場合は、内部リンクチェックの機能をあわせてご利用ください。
開発者向け — APIアクセス
このページの機能はすべてAPIからも利用できます。自社システムに組み込みたいチーム向けのセクションです。それ以外の方は上のツールをそのままお使いください。
エンドポイント
Bearerトークンで認証し、POST1回でタスクをキューに登録します。結果はWebhookまたは署名付きリンクで受け取れます。
お使いのスタックから呼び出す
curl -X POST https://api.kit.forhosting.com/seo/sitemap-generate \
-H "Authorization: Bearer $KIT_KEY" \
-H "Content-Type: application/json" \
-d '{"input":"…"}'const res = await fetch("https://api.kit.forhosting.com/seo/sitemap-generate", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.KIT_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({
"input": "…"
})
});
const { task_id } = await res.json();import os, requests
res = requests.post(
"https://api.kit.forhosting.com/seo/sitemap-generate",
headers={"Authorization": f"Bearer {os.environ['KIT_KEY']}"},
json={
"input": "…"
},
)
task_id = res.json()["task_id"]<?php
$res = file_get_contents("https://api.kit.forhosting.com/seo/sitemap-generate", false, stream_context_create([
"http" => [
"method" => "POST",
"header" => "Authorization: Bearer " . getenv("KIT_KEY") . "\r\nContent-Type: application/json",
"content" => '{"input":"…"}',
],
]));
$task = json_decode($res, true);body := bytes.NewBufferString(`{"input":"…"}`)
req, _ := http.NewRequest("POST", "https://api.kit.forhosting.com/seo/sitemap-generate", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("KIT_KEY"))
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)リクエスト例
{
"input": "…"
}レスポンス例
{
"task_id": "tsk_a1b2c3d4e5f6a1b2c3d4e5f6",
"type": "seo.sitemap_generate",
"status": "queued",
"_links": {
"result": "/tasks/tsk_…/result"
}
}非同期APIです。task_idは即時に返ります。ポーリングは1秒あたり1リクエストまでです。
料金
単価はすべて公開しています。トークン換算や独自クレジットはありません。失敗したタスクは課金されません。
エラー
| HTTP | コード | 意味 |
|---|---|---|
401 | unauthorized | APIキーが無効か、指定されていません。Authorizationヘッダーを確認してください。 |
402 | insufficient_balance | 残高が不足しています。チャージ後に再度お試しください。 |
404 | unknown_type | 指定されたタスクタイプは存在しません。タイプ名を確認してください。 |
429 | rate_limited | リクエストが多すぎます。しばらく待ってから再度お試しください。 |
413 | input_too_large | 入力データが上限を超えています。サイズを小さくして再度お試しください。 |