📘 公式リファレンス📦 リファレンス/オブジェクト中級

group オブジェクト

robots.txt ファイル内のユーザーエージェント別ルールグループを表すオブジェクト。クローラーの許可・禁止設定とサイトマップ情報をまとめて管理する。

用途

robots.txt.liquid テンプレートで、特定のボットに対する巡回ルールやサイトマップ参照先を動的に出力するとき。Google ボット、Bing ボットなど複数エージェント向けに異なるルールセットを定義する場面で使う。

設置場所

robots.txt.liquid テンプレート内で `{{ robots.default_groups[0].user_agent }}`、`{{ robots.default_groups[0].rules }}`、`{{ robots.default_groups[0].sitemap }}` の形で参照する。loops で複数グループを反復処理することもできる。

注意点

このオブジェクトは `robots` オブジェクトの `default_groups` プロパティ配下にのみ存在し、他のテンプレートやセクションからは直接アクセスできない。`sitemap` プロパティが返す値はグループがサイトマップを必要としない場合は blank になるため、出力前に存在確認が必要。

タグ:robots-txtseocrawlsitemapuser-agent

仕様

74 行 / json

{
  "access": {
    "global": false,
    "parents": [
      {
        "object": "robots",
        "property": "default_groups"
      }
    ],
    "template": []
  },
  "deprecated": false,
  "deprecation_reason": "",
  "description": "&gt; Tip:\n&gt; You can [customize the `robots.txt` file](/themes/seo/robots-txt) with the [`robots.txt.liquid` template](/themes/architecture/templates/robots-txt-liquid).",
  "properties": [
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "",
      "examples": [],
      "return_type": [
        {
          "type": "user_agent",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The user agent for the group.",
      "name": "user_agent"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "",
      "examples": [],
      "return_type": [
        {
          "type": "array",
          "name": "",
          "description": "",
          "array_value": "rule"
        }
      ],
      "summary": "The rules in the group.",
      "name": "rules"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "If the group doesn't require a sitemap, then `blank` is returned.\n\nThe sitemap can be accessed at `/sitemap.xml`.",
      "examples": [],
      "return_type": [
        {
          "type": "sitemap",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The sitemap for the group.",
      "name": "sitemap"
    }
  ],
  "summary": "A group of rules for the `robots.txt` file.",
  "name": "group",
  "examples": [],
  "json_data": {
    "path": "/robots.txt",
    "handle": "robots.default_groups[0]",
    "data_from_file": ""
  },
  "return_type": []
}

出典・ライセンス

Source:: Shopify/theme-liquid-docs/data/objects.json
Repository:: https://github.com/Shopify/theme-liquid-docs
License:: MIT

このコードは Shopify 著作の MIT ライセンスソースです。原本の著作権は Shopify が保有します。日本語訳は ALSEL によるものです。

group オブジェクト

仕様

出典・ライセンス

関連項目

content_for_header オブジェクト

metaobjects オブジェクト

additional_checkout_buttons オブジェクト

canonical_url オブジェクト

content_for_index オブジェクト

content_for_additional_checkout_buttons オブジェクト