{"title":"サイトマップ・フレームワーク","version":"5.2","locale":"ja","docname":"ref/contrib/sitemaps","url":"/ja/5.2/ref/contrib/sitemaps/","canonical":"https://djangodocs.dev/ja/5.2/ref/contrib/sitemaps/","summary":"Djangoには、 sitemap XML ファイルを作成するための高レベルなサイトマップ生成フレームワークが付属しています。 概要 Link to this heading #…","html":"

サイトマップ・フレームワークLink to this heading#

\n

Djangoには、 sitemap XML ファイルを作成するための高レベルなサイトマップ生成フレームワークが付属しています。

\n
\n

概要Link to this heading#

\n

サイトマップとは、検索エンジンのインデクサーに、ページの変更頻度や、あるページがサイト内の他のページと比較してどの程度「重要」であるかを伝える、ウェブサイト上のXMLファイルのことです。この情報は、検索エンジンがあなたのサイトをインデックスするのに役立ちます。

\n

Django サイトマップフレームワークは、この情報を Python コードで表現することで、XML ファイルの作成を自動化します。

\n

これは Django の 配信 (syndication) フレームワーク のように動作します。サイトマップを作成するには、 Sitemap クラスを書き、 URLconf の中でそれを指定します。

\n
\n
\n

インストールLink to this heading#

\n

サイトマップ アプリをインストールするには、以下の手順に従ってください。

\n
    \n

  1. 'django.contrib.sitemaps' を INSTALLED_APPS 設定に追加します。

    2. \n

  2. TEMPLATES 設定には、DjangoTemplates バックエンドが含まれており、APP_DIRS オプションが True に設定されていることを確認してください。これはデフォルトで設定されているので、設定を変更していない場合は、この設定を変更する必要はありません。

    3. \n

  3. sites フレームワーク がインストールされていることを確認してください。

    4. \n
\n

(注意: サイトマップアプリケーションはデータベーステーブルをインストールしません。 INSTALLED_APPS に入れる必要があるのは、 Loader() テンプレートローダーがデフォルトのテンプレートを見つけられるようにするためです)。

\n
\n
\n

初期設定Link to this heading#

\n
\n
\nviews.sitemap(request, sitemaps, section=None, template_name='sitemap.xml', content_type='application/xml')Link to this definition#
\n
\n\n

Django サイトでサイトマップの生成を有効にするには、 URLconf に以下の行を追加します:

\n
Code
from django.contrib.sitemaps.views import sitemap\n\npath(\n    "sitemap.xml",\n    sitemap,\n    {"sitemaps": sitemaps},\n    name="django.contrib.sitemaps.views.sitemap",\n)\n
\n

これは Django に、クライアントが /sitemap.xml にアクセスしたときにサイトマップを構築するように指示します。

\n

サイトマップファイルの名前は重要ではありませんが、場所は重要です。検索エンジンは、現在のURLレベル以下のサイトマップのリンクだけをインデックスします。例えば、 sitemap.xml がルートディレクトリにある場合、サイト内のどのURLでも参照できます。しかし、サイトマップが /content/sitemap.xml にある場合は、 /content/ で始まるURLのみを参照できます。

\n

サイトマップビューは追加の必須引数を取ります: {'sitemaps': sitemaps}. sitemaps は短いセクションラベル (例えば blog や news) を Sitemap クラス (例えば BlogSitemap や NewsSitemap) にマップする辞書です。また、 Sitemap クラスの インスタンス (例えば BlogSitemap(some_var)) にマップすることもできます。

\n
\n
\n

Sitemap クラスLink to this heading#

\n

Sitemap クラスは、サイトマップ内のエントリの「セクション」を表す Python クラスです。例えば、1 つの Sitemap クラスはブログのすべてのエントリを表し、別のクラスはイベントカレンダー内のすべてのイベントを表すことができます。

\n

最も単純なケースでは、これらのセクションはすべて1つの sitemap.xml にまとめられますが、フレームワークを使って、セクションごとに1つのサイトマップファイルを参照するサイトマップインデックスを生成することもできます。(下記の Creating a sitemap index を参照してください)。

\n

Sitemap クラスは django.contrib.sitemaps.Sitemap のサブクラスでなければなりません。これらはコードベースのどこにあっても構いません。

\n
\n
\n

例Link to this heading#

\n

たとえば、 Entry モデルのブログシステムがあり、サイトマップに個々のブログエントリへのリンクをすべて含めたいとします。サイトマップクラスは次のようになります:

\n
Code
from django.contrib.sitemaps import Sitemap\nfrom blog.models import Entry\n\n\nclass BlogSitemap(Sitemap):\n    changefreq = "never"\n    priority = 0.5\n\n    def items(self):\n        return Entry.objects.filter(is_draft=False)\n\n    def lastmod(self, obj):\n        return obj.pub_date\n
\n

備考:

\n\n
\n
\n

Sitemap クラス リファレンスLink to this heading#

\n
\n
\nclass SitemapLink to this definition#
\n

サイトマップ Sitemap クラスは以下のメソッドや属性を定義できます:

\n
\n
\nitemsLink to this definition#
\n

必須項目. オブジェクトの sequence または QuerySet を返すメソッド。フレームワークはこれらのオブジェクトの タイプ が何であるかについては関心を持ちません; 大切なのはこれらのオブジェクトが location(), lastmod(), changefreq()、および priority() メソッドに渡されることです。

\n
\n\n
\n
\nlocationLink to this definition#
\n

オプション。 メソッドまたは属性のいずれか。

\n

メソッドであれば、items() が返すオブジェクトの絶対パスを返す必要があります。

\n

属性である場合、その値は items() が返す すべての オブジェクトに使用する絶対パスを表す文字列でなければなりません。

\n

どちらの場合も、「絶対パス」とは、プロトコルやドメインを含まないURLを意味します。たとえば:

\n
    \n

  • 良い例: '/foo/bar/'

    • \n

  • 悪い例: 'example.com/foo/bar/'

    • \n

  • 悪い例: 'https://example.com/foo/bar/'

    • \n
\n

location が提供されていない場合、フレームワークは items() が返す各オブジェクトに対して get_absolute_url() メソッドを呼び出します。

\n

'http' 以外のプロトコルを指定するには、 protocol を使用してください。

\n
\n\n
\n
\nlastmodLink to this definition#
\n

オプション。 メソッドまたは属性のいずれか。

\n

メソッドであれば、 items() が返すオブジェクトを引数に取り、そのオブジェクトの最終更新日時を datetime として返す必要があります。

\n

属性であれば、その値は items() で返されるすべてのオブジェクトの最終更新日時を表す datetime である必要があります。

\n

サイトマップ内のすべてのアイテムに lastmod がある場合、 views.sitemap() によって生成されるサイトマップには、最新の lastmod に等しい Last-Modified ヘッダーが付きます。リクエストに If-Modified-Since ヘッダーがある場合、Django が適切に応答するようにするには、 ConditionalGetMiddleware をアクティブにします。これにより、サイトマップが変更されていない場合には送信を防ぎます。

\n
\n\n
\n
\npaginatorLink to this definition#
\n

オプション。

\n

このプロパティは、 items() のための Paginator を返します。サイトマップを一括生成する場合は、複数の items() 呼び出しを避けるためにこのキャッシュされたプロパティをオーバーライドすると良いでしょう。

\n
\n\n
\n
\nchangefreqLink to this definition#
\n

オプション。 メソッドまたは属性のいずれか。

\n

メソッドの場合、1つの引数 (items() で返されるオブジェクト) を取るべきであり、そのオブジェクトの変更頻度を文字列で返すべきです。

\n

属性であれば、その値は items() が返す すべての オブジェクトの変更頻度を表す文字列でなければなりません。

\n

changefreq の可能な値は、メソッドの場合も属性の場合も、以下の通りです。

\n
    \n

  • 'always'

    • \n

  • 'hourly'

    • \n

  • 'daily'

    • \n

  • 'weekly'

    • \n

  • 'monthly'

    • \n

  • 'yearly'

    • \n

  • 'never'

    • \n
\n
\n\n
\n
\npriorityLink to this definition#
\n

オプション。 メソッドまたは属性のいずれか。

\n

メソッドであれば、1つの引数 (items() が返すオブジェクト) を取り、そのオブジェクトの優先順位を文字列か浮動小数点数で返します。

\n

属性であれば、その値は、items() で返される すべて のオブジェクトの優先度を表す文字列または浮動小数点数である必要があります。

\n

priority の例として、0.4、1.0 を指定します。ページのデフォルトの優先度は 0.5 です。詳細については、sitemaps.org documentation を参照してください。

\n
\n\n
\n
\nprotocolLink to this definition#
\n

オプション。

\n

この属性はサイトマップのURLのプロトコル ('http' または 'https') を定義します。設定されていない場合は、サイトマップがリクエストされたプロトコルが使用されます。サイトマップがリクエストのコンテキスト外で作成された場合、デフォルトは 'https' です。

\n
\n\n
\n
\nlimitLink to this definition#
\n

オプション。

\n

この属性はサイトマップの各ページに含まれるURLの最大数を定義します。この値はデフォルト値の 50000 を超えてはいけません。これは Sitemaps protocol で許可されている上限値です。

\n
\n\n
\n
\ni18nLink to this definition#
\n

オプション。

\n

このサイトマップのURLを LANGUAGES のすべてを使用して生成するかどうかを定義するブール値の属性です。デフォルトは False です。

\n
\n\n
\n
\nlanguagesLink to this definition#
\n

オプション。

\n

i18n が有効のときに代替リンクを生成するために使用する 言語コード の sequence。デフォルトは LANGUAGES。

\n
\n\n
\n
\nalternatesLink to this definition#
\n

オプション。

\n

真偽値属性。これを i18n と併用すると、生成される各URLには他言語バージョンを指す代替リンクのリストがあり、 hreflang attribute を使用します。デフォルトは False です。

\n
\n\n
\n
\nx_defaultLink to this definition#
\n

オプション。

\n

真偽値属性です。True の場合、 alternates によって生成された代替リンクには、 hreflang="x-default" フォールバックエントリーが含まれ、その値は LANGUAGE_CODE になります。デフォルトは False です。

\n
\n\n
\n
\nget_latest_lastmod()Link to this definition#
\n

オプション。 lastmod で返される最新の値を返すメソッド。この関数は、 Sitemap インデックス コンテキスト変数 に lastmod 属性を追加するために使用されます。

\n

デフォルトでは、 get_latest_lastmod() は以下を返します:

\n
    \n

  • lastmod が属性の場合:  lastmod 。

    • \n

  • lastmod がメソッドの場合、 Sitemap.items() で返されるすべてのアイテムを使用してメソッドを呼び出した結果、最新の lastmod が返されます。

    • \n
\n
\n\n
\n
\nget_languages_for_item(item)Link to this definition#
\n

オプション。 アイテムが表示される言語コードのシーケンスを返すメソッド。デフォルトでは、 get_languages_for_item() は languages を返します。

\n
\n\n
\n\n
\n
\n

ショートカットLink to this heading#

\n

サイトマップフレームワークは、一般的なケースに対する便利なクラスを提供します。

\n
\n
\nclass GenericSitemap(info_dict, priority=None, changefreq=None, protocol=None)Link to this definition#
\n

django.contrib.sitemaps.GenericSitemap クラスでは、少なくとも queryset エントリを含む辞書を渡すことで、サイトマップを作成できます。この queryset は、サイトマップのアイテムを生成するために使用されます。また、queryset から取得されたオブジェクトの日付フィールドを指定する date_field エントリを持つこともできます。これは、生成されたサイトマップの lastmod 属性および get_latest_lastmod() メソッドに使用されます。

\n

priority 、 changefreq、 protocol キーワード引数を使用すると、すべてのURLに対してこれらの属性を指定できます。

\n
\n\n
\n

カスタマイズ例Link to this heading#

\n

以下は GenericSitemap を使用した URLconf の例です:

\n
Code
from django.contrib.sitemaps import GenericSitemap\nfrom django.contrib.sitemaps.views import sitemap\nfrom django.urls import path\nfrom blog.models import Entry\n\ninfo_dict = {\n    "queryset": Entry.objects.all(),\n    "date_field": "pub_date",\n}\n\nurlpatterns = [\n    # some generic view using info_dict\n    # ...\n    # the sitemap\n    path(\n        "sitemap.xml",\n        sitemap,\n        {"sitemaps": {"blog": GenericSitemap(info_dict, priority=0.6)}},\n        name="django.contrib.sitemaps.views.sitemap",\n    ),\n]\n
\n
\n
\n
\n

静的ビューのサイトマップLink to this heading#

\n

検索エンジンのクローラに、オブジェクト詳細ページでもフラットページでもないビューをインデックスさせたいことがよくあります。その解決策は、 items にこれらのビューの URL 名を明示的に列挙し、サイトマップの location メソッドで reverse() を呼び出すことです。例えば次のようにします:

\n
Code
# sitemaps.py\nfrom django.contrib import sitemaps\nfrom django.urls import reverse\n\n\nclass StaticViewSitemap(sitemaps.Sitemap):\n    priority = 0.5\n    changefreq = "daily"\n\n    def items(self):\n        return ["main", "about", "license"]\n\n    def location(self, item):\n        return reverse(item)\n\n\n# urls.py\nfrom django.contrib.sitemaps.views import sitemap\nfrom django.urls import path\n\nfrom .sitemaps import StaticViewSitemap\nfrom . import views\n\nsitemaps = {\n    "static": StaticViewSitemap,\n}\n\nurlpatterns = [\n    path("", views.main, name="main"),\n    path("about/", views.about, name="about"),\n    path("license/", views.license, name="license"),\n    # ...\n    path(\n        "sitemap.xml",\n        sitemap,\n        {"sitemaps": sitemaps},\n        name="django.contrib.sitemaps.views.sitemap",\n    ),\n]\n
\n
\n
\n

サイトマップインデックスを作成するLink to this heading#

\n
\n
\nviews.index(request, sitemaps, template_name='sitemap_index.xml', content_type='application/xml', sitemap_url_name='django.contrib.sitemaps.views.sitemap')Link to this definition#
\n
\n\n

サイトマップフレームワークには、 sitemaps 辞書で定義された各セクションごとに1つずつ、個別のサイトマップファイルを参照するサイトマップインデックスを作成する機能もあります。使用上の唯一の違いは下記です:

\n\n

上記の例に対する関連するURLconfの行は、次のようになります:

\n
Code
from django.contrib.sitemaps import views\n\nurlpatterns = [\n    path(\n        "sitemap.xml",\n        views.index,\n        {"sitemaps": sitemaps},\n        name="django.contrib.sitemaps.views.index",\n    ),\n    path(\n        "sitemap-<section>.xml",\n        views.sitemap,\n        {"sitemaps": sitemaps},\n        name="django.contrib.sitemaps.views.sitemap",\n    ),\n]\n
\n

これにより、自動的に sitemap.xml ファイルが生成され、 sitemap-flatpages.xml と sitemap-blog.xml の両方が参照されます。 Sitemap クラスと sitemaps 辞書は全く変わりません。

\n

すべてのサイトマップが Sitemap.get_latest_lastmod() で返される lastmod を持っている場合、サイトマップインデックスは最新の lastmod と同じ Last-Modified ヘッダーを持ちます。

\n

サイトマップの URL が 50,000 を超える場合は、インデックスファイルを作成すべきです。この場合、 Django は自動的にサイトマップをページ分割し、インデックスに反映します。

\n

通常のサイトマップビューを使用していない場合 (たとえば、キャッシュデコレータでラップされている場合) は、サイトマップビューに名前を付けて、インデックスビューに sitemap_url_name を渡さなければなりません:

\n
Code
from django.contrib.sitemaps import views as sitemaps_views\nfrom django.views.decorators.cache import cache_page\n\nurlpatterns = [\n    path(\n        "sitemap.xml",\n        cache_page(86400)(sitemaps_views.index),\n        {"sitemaps": sitemaps, "sitemap_url_name": "sitemaps"},\n    ),\n    path(\n        "sitemap-<section>.xml",\n        cache_page(86400)(sitemaps_views.sitemap),\n        {"sitemaps": sitemaps},\n        name="sitemaps",\n    ),\n]\n
\n
\n
\n

テンプレートをカスタマイズするLink to this heading#

\n

サイト上で利用可能な各サイトマップやサイトマップインデックスごとに異なるテンプレートを使用したい場合は、URLconf を介して sitemap ビューや index ビューに template_name パラメータを渡すことで指定できます:

\n
Code
from django.contrib.sitemaps import views\n\nurlpatterns = [\n    path(\n        "custom-sitemap.xml",\n        views.index,\n        {"sitemaps": sitemaps, "template_name": "custom_sitemap.html"},\n        name="django.contrib.sitemaps.views.index",\n    ),\n    path(\n        "custom-sitemap-<section>.xml",\n        views.sitemap,\n        {"sitemaps": sitemaps, "template_name": "custom_sitemap.html"},\n        name="django.contrib.sitemaps.views.sitemap",\n    ),\n]\n
\n

これらのビューは TemplateResponse インスタンスを返し、レンダリング前のレスポンスデータを簡単にカスタマイズできます。詳細は TemplateResponse のドキュメント を参照してください。

\n
\n

コンテキスト変数Link to this heading#

\n

テンプレートをカスタマイズする際に、 index() と sitemap() ビューには、以下のコンテキスト変数に依存できます。

\n
\n
\n

インデックスLink to this heading#

\n

変数 sitemaps は各サイトマップの location と lastmod 属性を含むオブジェクトのリストです。各URLは以下の属性を持ちます:

\n\n
\n
\n

サイトマップLink to this heading#

\n

変数 urlset は、サイトマップに表示されるべきURLのリストです。各URLは、 Sitemap クラスで定義された属性を公開しています。

\n\n

alternates 属性は、 i18n と alternates が有効になっている場合に利用可能です。それは、各URLに対してオプションの x_default フォールバックを含む、他の言語バージョンのリストです。各代替バージョンは、location と lang_code キーを持つ辞書です。

\n

各URLに item 属性が追加され、Google news sitemaps のようなテンプレートをより柔軟にカスタマイズできるようになりました。Sitemapの items() が publication_data と tags フィールドを持つアイテムのリストを返すと仮定すると、このようにGoogleニュース互換のサイトマップが生成されます:

\n
Xml Django
<?xml version="1.0" encoding="UTF-8"?>\n<urlset\n  xmlns="https://www.sitemaps.org/schemas/sitemap/0.9"\n  xmlns:news="https://www.google.com/schemas/sitemap-news/0.9">\n{% spaceless %}\n{% for url in urlset %}\n  <url>\n    <loc>{{ url.location }}</loc>\n    {% if url.lastmod %}<lastmod>{{ url.lastmod|date:"Y-m-d" }}</lastmod>{% endif %}\n    {% if url.changefreq %}<changefreq>{{ url.changefreq }}</changefreq>{% endif %}\n    {% if url.priority %}<priority>{{ url.priority }}</priority>{% endif %}\n    <news:news>\n      {% if url.item.publication_date %}<news:publication_date>{{ url.item.publication_date|date:"Y-m-d" }}</news:publication_date>{% endif %}\n      {% if url.item.tags %}<news:keywords>{{ url.item.tags }}</news:keywords>{% endif %}\n    </news:news>\n   </url>\n{% endfor %}\n{% endspaceless %}\n</urlset>\n
\n
\n
","rootId":"module-django.contrib.sitemaps","toc":[{"title":"概要","anchor":"overview","children":[]},{"title":"インストール","anchor":"installation","children":[]},{"title":"初期設定","anchor":"initialization","children":[]},{"title":"Sitemap クラス","anchor":"sitemap-classes","children":[]},{"title":"例","anchor":"an-example","children":[]},{"title":"Sitemap クラス リファレンス","anchor":"sitemap-class-reference","children":[]},{"title":"ショートカット","anchor":"shortcuts","children":[{"title":"カスタマイズ例","anchor":"example","children":[]}]},{"title":"静的ビューのサイトマップ","anchor":"sitemap-for-static-views","children":[]},{"title":"サイトマップインデックスを作成する","anchor":"creating-a-sitemap-index","children":[]},{"title":"テンプレートをカスタマイズする","anchor":"template-customization","children":[{"title":"コンテキスト変数","anchor":"context-variables","children":[]},{"title":"インデックス","anchor":"index","children":[]},{"title":"サイトマップ","anchor":"id1","children":[]}]}],"breadcrumbs":[{"docname":"ref/index","title":"API リファレンス","url":"/ja/5.2/ref/"},{"docname":"ref/contrib/index","title":"contrib パッケージ","url":"/ja/5.2/ref/contrib/"}],"prev":{"docname":"ref/contrib/redirects","title":"redirects （リダイレクト）アプリ","url":"/ja/5.2/ref/contrib/redirects/"},"next":{"docname":"ref/contrib/sites","title":"\"sites\" フレームワーク","url":"/ja/5.2/ref/contrib/sites/"},"formats":{"html":"/ja/5.2/ref/contrib/sitemaps/","markdown":"/ja/5.2/ref/contrib/sitemaps.md","json":"/ja/5.2/ref/contrib/sitemaps.json"},"source":"https://github.com/django/django/blob/stable/5.2.x/docs/ref/contrib/sitemaps.txt","official":"https://docs.djangoproject.com/ja/5.2/ref/contrib/sitemaps/","inVersions":["6.1","6.0","5.2","5.1","5.0","4.2","4.1","4.0","3.2","3.1","3.0","2.2","2.1","2.0","1.11","1.10","1.9"],"inLocales":["en","sv","zh-hans","ga","fr","ja","id","it","pt-br","ko","es","el","pl"]}