microCMSを利用したサイトで、記事の構造化データを実装します。
参照
https://dev.katari-no-tomoshibi.com/nextjs-schema-dts-seo/
やりたいこと
- ブログに構造化データを追加したい
- 構造化データのタイプは記事とパンくず
- タイトルなどはOGPにも使えるようにしたいし、デフォルト値を作っておきたい
各ページ別の構造化データ(完成イメージ)
- 全体枠(WebSite): ルートレイアウトでサイト情報を定義
- 記事詳細(BlogPosting): タイトル・説明文・公開日・更新日・サムネイルを openGraph と完全同期して出力
- アーカイブ・検索(CollectionPage / SearchResultsPage): カテゴリー・タグ・検索結果の各一覧およびページネーション(2ページ目以降)に対応
- パンくずリスト(BreadcrumbList & UI): 構造化データと画面表示のパンくずを一致させる
事前準備
schema-dtsをインストールします
npm install schema-dts
コード例
公式で配布されてるテンプレートに組み込む形で紹介します。
オリジナル
デフォルト値の設定
/constants/index.ts でデフォルト値を設定しつつ、記事ページなどで個別に変更できるようにします。
後にOGPでも使えるように設定しています。
/constants/index.ts
import { Person, Organization } from 'schema-dts';
// 1ページの表示件数
export const LIMIT = 10;
// サイト基本情報
export const BASE_URL = process.env.BASE_URL || 'http://localhost:3000';
export const SITE_TITLE = 'Simple Blog';
export const SITE_DESCRIPTION = 'A simple blog presented by microCMS';
export const SITE_OG_IMAGE = '/ogp.png';
// 著者情報
export const SITE_AUTHOR: Person = {
'@type': 'Person',
name: 'Your Name',
url: BASE_URL,
};
// パブリッシャー情報
export const SITE_PUBLISHER: Organization = {
'@type': 'Organization',
name: SITE_TITLE,
url: BASE_URL,
"logo": {
"@type": "ImageObject",
"url": BASE_URL + SITE_OG_IMAGE,
}
};
パンくず構造化データ生成の共通関数
/libs/jsonLd.ts で関数を作っておきます。
/libs/jsonLd.ts
import { WithContext, BreadcrumbList, ListItem } from 'schema-dts';
import { BASE_URL } from '@/constants';
export type BreadcrumbItem = {
name: string;
path: string;
};
/**
* パンくずリスト(BreadcrumbList)の構造化データを生成する共通関数
* 先頭に必ず「HOME」を自動付与します
*/
export function generateBreadcrumbJsonLd(
items: BreadcrumbItem[]
): WithContext<BreadcrumbList> {
const allItems: BreadcrumbItem[] = [
{ name: 'HOME', path: '/' },
...items,
];
const itemListElement: ListItem[] = allItems.map((item, index) => ({
'@type': 'ListItem',
position: index + 1,
name: item.name,
item: item.path === '/' ? BASE_URL : `${BASE_URL}${item.path}`,
}));
return {
'@context': 'https://schema.org',
'@type': 'BreadcrumbList',
itemListElement,
};
}
パンくずのマークアップ
アーカイブや記事詳細など複数箇所で利用するのでコンポーネントを作成しておきます。見た目については /components/Breadcrumb/index.module.css で適宜調整してください
/components/Breadcrumb/index.tsx
import Link from 'next/link';
import { BreadcrumbItem } from '@/libs/jsonLd';
import styles from './index.module.css';
type Props = {
items: BreadcrumbItem[];
};
export default function Breadcrumb({ items }: Props) {
// 先頭に必ず「HOME」を追加
const allItems: BreadcrumbItem[] = [{ name: 'HOME', path: '/' }, ...items];
return (
<nav aria-label="パンくずリスト" className={styles.nav}>
<ol className={styles.list}>
{allItems.map((item, index) => {
const isLast = index === allItems.length - 1;
return (
<li key={item.path} className={styles.item}>
{isLast ? (
// 現在のページ(末尾)はリンクにせずテキスト表示
<span aria-current="page" className={styles.current}>
{item.name}
</span>
) : (
<>
<Link href={item.path} className={styles.link}>
{item.name}
</Link>
<span aria-hidden="true" className={styles.separator}>
>
</span>
</>
)}
</li>
);
})}
</ol>
</nav>
);
}
構造化データとパンくずの組み込み
構造化データとパンくずを組み込んでいきます。OGP(メタ)データも共通にしたので、だいぶ改変してます。
記事ページを参考例に記載します。パンくずの挿入箇所は適宜調整してください。
/app/articles/[slug]/page.tsx
import { Metadata } from 'next';
// 構造化データ関係のファイルの読み込み
import { WithContext, BlogPosting } from 'schema-dts';
import { generateBreadcrumbJsonLd, BreadcrumbItem } from '@/libs/jsonLd';
import {
BASE_URL,
SITE_AUTHOR,
SITE_PUBLISHER,
SITE_DESCRIPTION,
SITE_OG_IMAGE,
} from '@/constants';
import { getDetail } from '@/libs/microcms';
import Breadcrumb from '@/components/Breadcrumb';
import Article from '@/components/Article';
type Props = {
params: Promise<{
slug: string;
}>;
searchParams: Promise<{
dk: string;
}>;
};
// 1. generateMetadata と Page で共有するSEOデータ取得関数
async function getArticleSeoData(slug: string, draftKey?: string) {
const data = await getDetail(slug, { draftKey });
const imageUrl = data?.eyecatch?.url || `${BASE_URL}${SITE_OG_IMAGE}`;
const openGraph = {
title: data.title,
description: data.description || SITE_DESCRIPTION,
images: [imageUrl],
};
return {
data,
openGraph,
url: `${BASE_URL}/articles/${slug}`,
};
}
// 2. メタデータ生成
export async function generateMetadata(props: Props): Promise<Metadata> {
const searchParams = await props.searchParams;
const params = await props.params;
const { openGraph } = await getArticleSeoData(params.slug, searchParams.dk);
return {
title: openGraph.title,
description: openGraph.description,
openGraph,
alternates: {
canonical: `/articles/${params.slug}`,
},
};
}
// 3. ページコンポーネント と JSON-LD の 出力
export default async function Page(props: Props) {
const searchParams = await props.searchParams;
const params = await props.params;
const { data, openGraph, url } = await getArticleSeoData(
params.slug,
searchParams.dk
);
// schema-dts (BlogPosting) で構造化データを定義
const jsonLd: WithContext<BlogPosting> = {
'@context': 'https://schema.org',
'@type': 'BlogPosting',
// openGraph.title と完全に一致
headline: openGraph.title,
// openGraph.description と完全に一致
description: openGraph.description,
url,
image: openGraph.images,
// 下書きプレビュー時に日付が未設定でもエラーにならないようフォールバック
datePublished: data.publishedAt || new Date().toISOString(),
dateModified: data.revisedAt || data.publishedAt || new Date().toISOString(),
author: SITE_AUTHOR,
publisher: SITE_PUBLISHER,
};
// 複数選択カテゴリの最初の1つだけを取得
const primaryCategory = data.categories?.[0];
// BreadcrumbItem[] 型を明示してパンくずリストの組み立て
const breadcrumbItems: BreadcrumbItem[] = [
...(primaryCategory?.name
? [{ name: primaryCategory.name, path: `/categories/${primaryCategory.id}` }]
: []),
{ name: openGraph.title || '', path: `/articles/${params.slug}` },
];
const breadcrumbJsonLd = generateBreadcrumbJsonLd(breadcrumbItems);
return (
<>
<script
type="application/ld+json"
dangerouslySetInnerHTML={{ __html: JSON.stringify(jsonLd) }}
/>
<script
type="application/ld+json"
dangerouslySetInnerHTML={{ __html: JSON.stringify(breadcrumbJsonLd) }}
/>
<Breadcrumb items={breadcrumbItems} />
<Article data={data} />
</>
);
}
現場からは以上です。
