Menu

generateMetadata

このページでは、generateMetadataと静的メタデータオブジェクトを使用したコンフィグベースのメタデータのすべてのオプションについて説明します。

layout.tsx
TypeScript
import type { Metadata } from 'next'
 
// 静的メタデータ
export const metadata: Metadata = {
  title: '...',
}
 
// または動的メタデータ
export async function generateMetadata({ params }) {
  return {
    title: '...',
  }
}

補足:

  • metadataオブジェクトとgenerateMetadata関数のエクスポートは、サーバーコンポーネントでのみサポートされています。
  • 同じルートセグメントからmetadataオブジェクトとgenerateMetadata関数の両方をエクスポートすることはできません。
  • 初回ロード時、generateMetadataが完全に解決され、loading.jsのコンテンツを含むまでストリーミングはブロックされます。

metadataオブジェクト

静的メタデータを定義するには、layout.jsまたはpage.jsファイルからMetadataオブジェクトをエクスポートします。

layout.tsx
TypeScript
import type { Metadata } from 'next'
 
export const metadata: Metadata = {
  title: '...',
  description: '...',
}
 
export default function Page() {}

サポートされているオプションの完全なリストについては、メタデータフィールドを参照してください。

generateMetadata関数

動的メタデータは、現在のルートパラメータ、外部データ、または親セグメントのmetadataなど、動的な情報に依存します。これは、Metadataオブジェクトを返すgenerateMetadata関数をエクスポートすることで設定できます。

app/products/[id]/page.tsx
TypeScript
import type { Metadata, ResolvingMetadata } from 'next'
 
type Props = {
  params: { id: string }
  searchParams: { [key: string]: string | string[] | undefined }
}
 
export async function generateMetadata(
  { params, searchParams }: Props,
  parent: ResolvingMetadata
): Promise<Metadata> {
  // ルートパラメータを読み取る
  const id = (await params).id
 
  // データをフェッチ
  const product = await fetch(`https://.../${id}`).then((res) => res.json())
 
  // オプションで親メタデータにアクセスし、拡張（置き換えではなく）
  const previousImages = (await parent).openGraph?.images || []
 
  return {
    title: product.title,
    openGraph: {
      images: ['/some-specific-page-image.jpg', ...previousImages],
    },
  }
}
 
export default function Page({ params, searchParams }: Props) {}

パラメータ

generateMetadata関数は、以下のパラメータを受け取ります：

  • props - 現在のルートのパラメータを含むオブジェクト：

    • params - ルートセグメントからgenerateMetadataが呼び出されるまでの動的ルートパラメータオブジェクト。例：

      ルートURLparams
      app/shop/[slug]/page.js/shop/1{ slug: '1' }
      app/shop/[tag]/[item]/page.js/shop/1/2{ tag: '1', item: '2' }
      app/shop/[...slug]/page.js/shop/1/2{ slug: ['1', '2'] }

    • searchParams - 現在のURLの検索パラメータを含むオブジェクト。例：

      URLsearchParams
      /shop?a=1{ a: '1' }
      /shop?a=1&b=2{ a: '1', b: '2' }
      /shop?a=1&a=2{ a: ['1', '2'] }

  • parent - 親ルートセグメントから解決されたメタデータのプロミス。

戻り値

generateMetadataは、1つ以上のメタデータフィールドを含むMetadataオブジェクトを返す必要があります。

補足:

  • メタデータが実行時の情報に依存しない場合、静的なmetadataオブジェクトを使用する必要があります。
  • fetchリクエストは、generateMetadata、generateStaticParams、レイアウト、ページ、サーバーコンポーネント間で同じデータに対して自動的にメモ化されます。fetchが利用できない場合は、React cacheを使用できます。
  • searchParamsはpage.jsセグメントでのみ利用可能です。
  • Next.jsのredirect()およびnotFound()メソッドもgenerateMetadata内で使用できます。

メタデータフィールド

title

title属性は、ドキュメントのタイトルを設定するために使用されます。シンプルな文字列または省略可能なテンプレートオブジェクトとして定義できます。

文字列

layout.js
export const metadata = {
  title: 'Next.js',
}
<head>
<title>Next.js</title>

テンプレートオブジェクト

app/layout.tsx
TypeScript
import type { Metadata } from 'next'
 
export const metadata: Metadata = {
  title: {
    template: '...',
    default: '...',
    absolute: '...',
  },
}
デフォルト

title.defaultは、タイトルを定義していない子ルートセグメントのためのフォールバックタイトルとして使用できます。

app/layout.tsx
import type { Metadata } from 'next'
 
export const metadata: Metadata = {
  title: {
    default: 'Acme',
  },
}
app/about/page.tsx
import type { Metadata } from 'next'
 
export const metadata: Metadata = {}
 
// 出力: <title>Acme</title>
テンプレート

title.templateは、子ルートセグメントで定義されたtitlesにプレフィックスまたはサフィックスを追加するために使用できます。

app/layout.tsx
TypeScript
import type { Metadata } from 'next'
 
export const metadata: Metadata = {
  title: {
    template: '%s | Acme',
    default: 'Acme', // テンプレートを作成する際にデフォルトが必要
  },
}
app/about/page.tsx
TypeScript
import type { Metadata } from 'next'
 
export const metadata: Metadata = {
  title: 'About',
}
 
// 出力: <title>About | Acme</title>

補足:

  • title.templateは子のルートセグメントに適用され、定義されているセグメント自体には適用されません。つまり:

    • title.templateを追加する場合、title.defaultが必須です。
    • layout.jsで定義されたtitle.templateは、同じルートセグメントのpage.jsで定義されたtitleには適用されません。
    • page.jsで定義されたtitle.templateは効果がありません。ページは常に終端セグメントであるため（子のルートセグメントがないため）。

  • ルートがtitleまたはtitle.defaultを定義していない場合、title.templateは効果がありません。

絶対パス

title.absoluteは、親セグメントで設定されたtitle.templateを無視するタイトルを提供するために使用できます。

app/layout.tsx
TypeScript
import type { Metadata } from 'next'
 
export const metadata: Metadata = {
  title: {
    template: '%s | Acme',
  },
}
app/about/page.tsx
TypeScript
import type { Metadata } from 'next'
 
export const metadata: Metadata = {
  title: {
    absolute: 'About',
  },
}
 
// 出力: <title>About</title>

補足:

  • layout.js

    • title（文字列）とtitle.defaultは子セグメントのデフォルトタイトルを定義します（独自のtitleを定義しないセグメント）。最も近い親セグメントのtitle.templateが存在する場合、それを拡張します。
    • title.absoluteは子セグメントのデフォルトタイトルを定義します。親セグメントのtitle.templateを無視します。
    • title.templateは子セグメントの新しいタイトルテンプレートを定義します。

  • page.js

    • ページが独自のタイトルを定義しない場合、最も近い親の解決されたタイトルが使用されます。
    • title（文字列）はルートのタイトルを定義します。最も近い親セグメントのtitle.templateが存在する場合、それを拡張します。
    • title.absoluteはルートのタイトルを定義します。親セグメントのtitle.templateを無視します。
    • page.jsではtitle.templateは効果がありません。ページは常にルートの終端セグメントであるためです。

description

layout.js
export const metadata = {
  description: 'The React Framework for the Web',
}
<head>
<meta name="description" content="The React Framework for the Web" />

基本フィールド

layout.js
export const metadata = {
  generator: 'Next.js',
  applicationName: 'Next.js',
  referrer: 'origin-when-cross-origin',
  keywords: ['Next.js', 'React', 'JavaScript'],
  authors: [{ name: 'Seb' }, { name: 'Josh', url: 'https://nextjs.org' }],
  creator: 'Jiachi Liu',
  publisher: 'Sebastian Markbåge',
  formatDetection: {
    email: false,
    address: false,
    telephone: false,
  },
}
<head>
<meta name="application-name" content="Next.js" />
<meta name="author" content="Seb" />
<link rel="author" href="https://nextjs.org" />
<meta name="author" content="Josh" />
<meta name="generator" content="Next.js" />
<meta name="keywords" content="Next.js,React,JavaScript" />
<meta name="referrer" content="origin-when-cross-origin" />
<meta name="color-scheme" content="dark" />
<meta name="creator" content="Jiachi Liu" />
<meta name="publisher" content="Sebastian Markbåge" />
<meta name="format-detection" content="telephone=no, address=no, email=no" />

metadataBase

metadataBaseは、完全修飾URLを必要とするmetadataフィールドのベースURLプレフィックスを設定するための便利なオプションです。

  • metadataBaseにより、現在のルートセグメント以下で定義されたURL関連のmetadataフィールドは、相対パスを使用できます。
  • フィールドの相対パスはmetadataBaseと組み合わせて完全修飾URLを形成します。
  • 設定されていない場合、metadataBaseは自動的にデフォルト値が設定されます。
layout.js
export const metadata = {
  metadataBase: new URL('https://acme.com'),
  alternates: {
    canonical: '/',
    languages: {
      'en-US': '/en-US',
      'de-DE': '/de-DE',
    },
  },
  openGraph: {
    images: '/og-image.png',
  },
}
<head>
<link rel="canonical" href="https://acme.com" />
<link rel="alternate" hreflang="en-US" href="https://acme.com/en-US" />
<link rel="alternate" hreflang="de-DE" href="https://acme.com/de-DE" />
<meta property="og:image" content="https://acme.com/og-image.png" />

補足:

  • metadataBaseは通常、すべてのルートでURL関連のmetadataフィールドに適用するために、ルートのapp/layout.jsで設定されます。
  • 絶対URLを必要とするすべてのURL関連のmetadataフィールドは、metadataBaseオプションで設定できます。
  • metadataBaseはサブドメイン（例：https://app.acme.com）またはベースパス（例：https://acme.com/start/from/here）を含むことができます。
  • metadataフィールドが絶対URLを提供する場合、metadataBaseは無視されます。
  • metadataBaseを設定せずにURL関連のmetadataフィールドで相対パスを使用すると、ビルドエラーが発生します。
  • Next.jsは、metadataBase（例：https://acme.com/）と相対フィールド（例：/path）間の重複するスラッシュを単一のスラッシュ（例：https://acme.com/path）に正規化します。

デフォルト値

設定されていない場合、metadataBaseはデフォルト値を持ちます。

Vercelの場合:

  • 本番デプロイメントでは、VERCEL_PROJECT_PRODUCTION_URLが使用されます。
  • プレビューデプロイメントでは、VERCEL_BRANCH_URLが優先され、存在しない場合はVERCEL_URLにフォールバックします。

これらの値が存在する場合、デフォルト値として使用され、それ以外の場合はhttp://localhost:${process.env.PORT || 3000}にフォールバックします。これにより、Open GraphイメージがローカルビルドとVercelのプレビュー、本番デプロイメントの両方で機能します。デフォルトを上書きする場合は、URLを計算するために環境変数を使用することをお勧めします。これにより、ローカル開発、ステージング、本番環境のURLを設定できます。

これらの環境変数の詳細については、システム環境変数ドキュメントを参照してください。

URLの構成

URL構成は、デフォルトのディレクトリトラバーサルセマンティクスよりも開発者の意図を優先します。

  • metadataBaseとmetadataフィールド間の末尾のスラッシュは正規化されます。
  • metadataフィールドの「絶対」パス（通常、URLパス全体を置き換える）は、「相対」パス（metadataBaseの末尾から開始）として扱われます。

例えば、次のmetadataBaseが与えられた場合:

app/layout.tsx
TypeScript
import type { Metadata } from 'next'
 
export const metadata: Metadata = {
  metadataBase: new URL('https://acme.com'),
}

上記のmetadataBaseを継承し、独自の値を設定するmetadataフィールドは、次のように解決されます:

metadataフィールド解決されたURL
/https://acme.com
./https://acme.com
paymentshttps://acme.com/payments
/paymentshttps://acme.com/payments
./paymentshttps://acme.com/payments
../paymentshttps://acme.com/payments
https://beta.acme.com/paymentshttps://beta.acme.com/payments

openGraph

layout.js
export const metadata = {
  openGraph: {
    title: 'Next.js',
    description: 'The React Framework for the Web',
    url: 'https://nextjs.org',
    siteName: 'Next.js',
    images: [
      {
        url: 'https://nextjs.org/og.png', // 絶対URLである必要があります
        width: 800,
        height: 600,
      },
      {
        url: 'https://nextjs.org/og-alt.png', // 絶対URLである必要があります
        width: 1800,
        height: 1600,
        alt: 'マイカスタムalt',
      },
    ],
    videos: [
      {
        url: 'https://nextjs.org/video.mp4', // 絶対URLである必要があります
        width: 800,
        height: 600,
      },
    ],
    audio: [
      {
        url: 'https://nextjs.org/audio.mp3', // 絶対URLである必要があります
      },
    ],
    locale: 'en_US',
    type: 'website',
  },
}
<head>
<meta property="og:title" content="Next.js" />
<meta property="og:description" content="The React Framework for the Web" />
<meta property="og:url" content="https://nextjs.org/" />
<meta property="og:site_name" content="Next.js" />
<meta property="og:locale" content="en_US" />
<meta property="og:image" content="https://nextjs.org/og.png" />
<meta property="og:image:width" content="800" />
<meta property="og:image:height" content="600" />
<meta property="og:image" content="https://nextjs.org/og-alt.png" />
<meta property="og:image:width" content="1800" />
<meta property="og:image:height" content="1600" />
<meta property="og:image:alt" content="マイカスタムalt" />
<meta property="og:video" content="https://nextjs.org/video.mp4" />
<meta property="og:video:width" content="800" />
<meta property="og:video:height" content="600" />
<meta property="og:audio" content="https://nextjs.org/audio.mp3" />
<meta property="og:type" content="website" />
layout.js
export const metadata = {
  openGraph: {
    title: 'Next.js',
    description: 'The React Framework for the Web',
    type: 'article',
    publishedTime: '2023-01-01T00:00:00.000Z',
    authors: ['Seb', 'Josh'],
  },
}
<head>
<meta property="og:title" content="Next.js" />
<meta property="og:description" content="The React Framework for the Web" />
<meta property="og:type" content="article" />
<meta property="article:published_time" content="2023-01-01T00:00:00.000Z" />
<meta property="article:author" content="Seb" />
<meta property="article:author" content="Josh" />

補足:

  • Open Graph 画像については、ファイルベースのメタデータ API を使用する方が便利な場合があります。設定のエクスポートと実際のファイルを同期する必要がなく、ファイルベースの API が自動的に正しいメタデータを生成します。

robots

layout.tsx
import type { Metadata } from 'next'
 
export const metadata: Metadata = {
  robots: {
    index: false,
    follow: true,
    nocache: true,
    googleBot: {
      index: true,
      follow: false,
      noimageindex: true,
      'max-video-preview': -1,
      'max-image-preview': 'large',
      'max-snippet': -1,
    },
  },
}
<head>
<meta name="robots" content="noindex, follow, nocache" />
<meta
  name="googlebot"
  content="index, nofollow, noimageindex, max-video-preview:-1, max-image-preview:large, max-snippet:-1"
/>

icons

補足: 可能な限り、ファイルベースのメタデータ API を使用してアイコンを設定することをお勧めします。設定のエクスポートと実際のファイルを同期する必要がなく、ファイルベースの API が自動的に正しいメタデータを生成します。

layout.js
export const metadata = {
  icons: {
    icon: '/icon.png',
    shortcut: '/shortcut-icon.png',
    apple: '/apple-icon.png',
    other: {
      rel: 'apple-touch-icon-precomposed',
      url: '/apple-touch-icon-precomposed.png',
    },
  },
}
<head>
<link rel="shortcut icon" href="/shortcut-icon.png" />
<link rel="icon" href="/icon.png" />
<link rel="apple-touch-icon" href="/apple-icon.png" />
<link
  rel="apple-touch-icon-precomposed"
  href="/apple-touch-icon-precomposed.png"
/>
layout.js
export const metadata = {
  icons: {
    icon: [
      { url: '/icon.png' },
      new URL('/icon.png', 'https://example.com'),
      { url: '/icon-dark.png', media: '(prefers-color-scheme: dark)' },
    ],
    shortcut: ['/shortcut-icon.png'],
    apple: [
      { url: '/apple-icon.png' },
      { url: '/apple-icon-x3.png', sizes: '180x180', type: 'image/png' },
    ],
    other: [
      {
        rel: 'apple-touch-icon-precomposed',
        url: '/apple-touch-icon-precomposed.png',
      },
    ],
  },
}
<head>
<link rel="shortcut icon" href="/shortcut-icon.png" />
<link rel="icon" href="/icon.png" />
<link rel="icon" href="https://example.com/icon.png" />
<link rel="icon" href="/icon-dark.png" media="(prefers-color-scheme: dark)" />
<link rel="apple-touch-icon" href="/apple-icon.png" />
<link
  rel="apple-touch-icon-precomposed"
  href="/apple-touch-icon-precomposed.png"
/>
<link
  rel="apple-touch-icon"
  href="/apple-icon-x3.png"
  sizes="180x180"
  type="image/png"
/>

補足: Chromium ベースの Microsoft Edge では、msapplication-* メタタグはサポートされなくなったため、もはや必要ありません。

themeColor

非推奨: Next.js 14 現在、metadata の themeColor オプションは非推奨です。代わりに viewport 設定を使用してください。

manifest

Web Application Manifest 仕様で定義されているウェブアプリケーションマニフェスト。

layout.js
export const metadata = {
  manifest: 'https://nextjs.org/manifest.json',
}
<head>
<link rel="manifest" href="https://nextjs.org/manifest.json" />

twitter

（意外にも）X（以前の Twitter）以外にも使用される Twitter の仕様。

Twitter カードマークアップリファレンスについてさらに詳しく学ぶ。

layout.js
export const metadata = {
  twitter: {
    card: 'summary_large_image',
    title: 'Next.js',
    description: 'The React Framework for the Web',
    siteId: '1467726470533754880',
    creator: '@nextjs',
    creatorId: '1467726470533754880',
    images: ['https://nextjs.org/og.png'], // 絶対 URL である必要があります
  },
}
<head>
<meta name="twitter:card" content="summary_large_image" />
<meta name="twitter:site:id" content="1467726470533754880" />
<meta name="twitter:creator" content="@nextjs" />
<meta name="twitter:creator:id" content="1467726470533754880" />
<meta name="twitter:title" content="Next.js" />
<meta name="twitter:description" content="The React Framework for the Web" />
<meta name="twitter:image" content="https://nextjs.org/og.png" />
layout.js
export const metadata = {
  twitter: {
    card: 'app',
    title: 'Next.js',
    description: 'The React Framework for the Web',
    siteId: '1467726470533754880',
    creator: '@nextjs',
    creatorId: '1467726470533754880',
    images: {
      url: 'https://nextjs.org/og.png',
      alt: 'Next.js Logo',
    },
    app: {
      name: 'twitter_app',
      id: {
        iphone: 'twitter_app://iphone',
        ipad: 'twitter_app://ipad',
        googleplay: 'twitter_app://googleplay',
      },
      url: {
        iphone: 'https://iphone_url',
        ipad: 'https://ipad_url',
      },
    },
  },
}
<head>
<meta name="twitter:site:id" content="1467726470533754880" />
<meta name="twitter:creator" content="@nextjs" />
<meta name="twitter:creator:id" content="1467726470533754880" />
<meta name="twitter:title" content="Next.js" />
<meta name="twitter:description" content="The React Framework for the Web" />
<meta name="twitter:card" content="app" />
<meta name="twitter:image" content="https://nextjs.org/og.png" />
<meta name="twitter:image:alt" content="Next.js Logo" />
<meta name="twitter:app:name:iphone" content="twitter_app" />
<meta name="twitter:app:id:iphone" content="twitter_app://iphone" />
<meta name="twitter:app:id:ipad" content="twitter_app://ipad" />
<meta name="twitter:app:id:googleplay" content="twitter_app://googleplay" />
<meta name="twitter:app:url:iphone" content="https://iphone_url" />
<meta name="twitter:app:url:ipad" content="https://ipad_url" />
<meta name="twitter:app:name:ipad" content="twitter_app" />
<meta name="twitter:app:name:googleplay" content="twitter_app" />

viewport

非推奨: Next.js 14 現在、metadata の viewport オプションは非推奨です。代わりに viewport 設定を使用してください。

verification

layout.js
export const metadata = {
  verification: {
    google: 'google',
    yandex: 'yandex',
    yahoo: 'yahoo',
    other: {
      me: ['my-email', 'my-link'],
    },
  },
}
<head>
<meta name="google-site-verification" content="google" />
<meta name="y_key" content="yahoo" />
<meta name="yandex-verification" content="yandex" />
<meta name="me" content="my-email" />
<meta name="me" content="my-link" />

appleWebApp

layout.js
export const metadata = {
  itunes: {
    appId: 'myAppStoreID',
    appArgument: 'myAppArgument',
  },
  appleWebApp: {
    title: 'Apple Web App',
    statusBarStyle: 'black-translucent',
    startupImage: [
      '/assets/startup/apple-touch-startup-image-768x1004.png',
      {
        url: '/assets/startup/apple-touch-startup-image-1536x2008.png',
        media: '(device-width: 768px) and (device-height: 1024px)',
      },
    ],
  },
}
<head>
<meta
  name="apple-itunes-app"
  content="app-id=myAppStoreID, app-argument=myAppArgument"
/>
<meta name="mobile-web-app-capable" content="yes" />
<meta name="apple-mobile-web-app-title" content="Apple Web App" />
<link
  href="/assets/startup/apple-touch-startup-image-768x1004.png"
  rel="apple-touch-startup-image"
/>
<link
  href="/assets/startup/apple-touch-startup-image-1536x2008.png"
  media="(device-width: 768px) and (device-height: 1024px)"
  rel="apple-touch-startup-image"
/>
<meta
  name="apple-mobile-web-app-status-bar-style"
  content="black-translucent"
/>

alternates

layout.js
export const metadata = {
  alternates: {
    canonical: 'https://nextjs.org',
    languages: {
      'en-US': 'https://nextjs.org/en-US',
      'de-DE': 'https://nextjs.org/de-DE',
    },
    media: {
      'only screen and (max-width: 600px)': 'https://nextjs.org/mobile',
    },
    types: {
      'application/rss+xml': 'https://nextjs.org/rss',
    },
  },
}
<head>
<link rel="canonical" href="https://nextjs.org" />
<link rel="alternate" hreflang="en-US" href="https://nextjs.org/en-US" />
<link rel="alternate" hreflang="de-DE" href="https://nextjs.org/de-DE" />
<link
  rel="alternate"
  media="only screen and (max-width: 600px)"
  href="https://nextjs.org/mobile"
/>
<link
  rel="alternate"
  type="application/rss+xml"
  href="https://nextjs.org/rss"
/>

appLinks

layout.js
export const metadata = {
  appLinks: {
    ios: {
      url: 'https://nextjs.org/ios',
      app_store_id: 'app_store_id',
    },
    android: {
      package: 'com.example.android/package',
      app_name: 'app_name_android',
    },
    web: {
      url: 'https://nextjs.org/web',
      should_fallback: true,
    },
  },
}
<head>
<meta property="al:ios:url" content="https://nextjs.org/ios" />
<meta property="al:ios:app_store_id" content="app_store_id" />
<meta property="al:android:package" content="com.example.android/package" />
<meta property="al:android:app_name" content="app_name_android" />
<meta property="al:web:url" content="https://nextjs.org/web" />
<meta property="al:web:should_fallback" content="true" />

archives

歴史的に興味深いレコード、ドキュメント、その他の資料のコレクションを説明します（出典）。

layout.js
export const metadata = {
  archives: ['https://nextjs.org/13'],
}
<head>
<link rel="archives" href="https://nextjs.org/13" />

assets

layout.js
export const metadata = {
  assets: ['https://nextjs.org/assets'],
}
<head>
<link rel="assets" href="https://nextjs.org/assets" />

bookmarks

layout.js
export const metadata = {
  bookmarks: ['https://nextjs.org/13'],
}
<head>
<link rel="bookmarks" href="https://nextjs.org/13" />

category

layout.js
export const metadata = {
  category: 'technology',
}
<head>
<meta name="category" content="technology" />

facebook

特定のFacebook ソーシャルプラグインのために、Facebook アプリまたはFacebookアカウントをウェブページに接続できます Facebook ドキュメント

補足: appIdまたはadminsのいずれかを指定できますが、両方は指定できません。

layout.js
export const metadata = {
  facebook: {
    appId: '12345678',
  },
}
<head>
<meta property="fb:app_id" content="12345678" />
layout.js
export const metadata = {
  facebook: {
    admins: '12345678',
  },
}
<head>
<meta property="fb:admins" content="12345678" />

複数のfb:adminsメタタグを生成する場合は、配列値を使用できます。

layout.js
export const metadata = {
  facebook: {
    admins: ['12345678', '87654321'],
  },
}
<head>
<meta property="fb:admins" content="12345678" />
<meta property="fb:admins" content="87654321" />

other

すべてのメタデータオプションは、組み込みのサポートでカバーされるはずです。ただし、サイト固有のカスタムメタデータタグや、新しくリリースされたメタデータタグがある場合があります。otherオプションを使用して、任意のカスタムメタデータタグをレンダリングできます。

layout.js
export const metadata = {
  other: {
    custom: 'meta',
  },
}
<head>
<meta name="custom" content="meta" />

同じキーの複数のメタタグを生成する場合は、配列値を使用できます。

layout.js
export const metadata = {
  other: {
    custom: ['meta1', 'meta2'],
  },
}
<head>
<meta name="custom" content="meta1" /> <meta name="custom" content="meta2" />

サポートされていないメタデータ

以下のメタデータタイプは、現在組み込みのサポートがありません。ただし、レイアウトやページ自体にレンダリングすることは可能です。

メタデータ推奨事項
<meta http-equiv="...">redirect()、Middleware、セキュリティヘッダーを介して適切なHTTPヘッダーを使用
<base>レイアウトやページ自体にタグをレンダリングします。
<noscript>レイアウトやページ自体にタグをレンダリングします。
<style>Next.jsでのスタイリングについてさらに詳しく学びます。
<script>スクリプトの使用についてさらに詳しく学びます。
<link rel="stylesheet" />レイアウトやページ自体にスタイルシートを直接importします。
<link rel="preload />ReactDOMのpreloadメソッドを使用
<link rel="preconnect" />ReactDOMのpreconnectメソッドを使用
<link rel="dns-prefetch" />ReactDOMのprefetchDNSメソッドを使用

リソースヒント

<link>要素には、外部リソースが必要になる可能性があることをブラウザに示唆するいくつかのrelキーワードがあります。ブラウザはこの情報を使用して、キーワードに応じて先読み最適化を適用します。

メタデータ API は直接これらのヒントをサポートしていませんが、新しい ReactDOM のメソッドを使用して、ドキュメントの <head> に安全に挿入することができます。

app/preload-resources.tsx
TypeScript
'use client'
 
import ReactDOM from 'react-dom'
 
export function PreloadResources() {
  ReactDOM.preload('...', { as: '...' })
  ReactDOM.preconnect('...', { crossOrigin: '...' })
  ReactDOM.prefetchDNS('...')
 
  return '...'
}
<link rel="preload">

ページレンダリング（ブラウザ）のライフサイクルの早い段階でリソースの読み込みを開始します。MDNドキュメント。

ReactDOM.preload(href: string, options: { as: string })
<head>
<link rel="preload" href="..." as="..." />
<link rel="preconnect">

事前に接続元への接続を開始します。MDNドキュメント。

ReactDOM.preconnect(href: string, options?: { crossOrigin?: string })
<head>
<link rel="preconnect" href="..." crossorigin />
<link rel="dns-prefetch">

リソースが要求される前にドメイン名を解決しようとします。MDNドキュメント。

ReactDOM.prefetchDNS(href: string)
<head>
<link rel="dns-prefetch" href="..." />

補足:

  • これらのメソッドは現在、クライアントコンポーネントでのみサポートされており、初期ページ読み込み時にはサーバーサイドレンダリングされます。
  • next/font、next/image、next/script などのNext.jsの組み込み機能が、関連するリソースヒントを自動的に処理します。

型

Metadata 型を使用して、メタデータに型安全性を追加できます。IDEで組み込みのTypeScriptプラグインを使用している場合、手動で型を追加する必要はありませんが、明示的に追加することもできます。

metadata オブジェクト

layout.tsx
import type { Metadata } from 'next'
 
export const metadata: Metadata = {
  title: 'Next.js',
}

generateMetadata 関数

通常の関数

layout.tsx
import type { Metadata } from 'next'
 
export function generateMetadata(): Metadata {
  return {
    title: 'Next.js',
  }
}

非同期関数

layout.tsx
import type { Metadata } from 'next'
 
export async function generateMetadata(): Promise<Metadata> {
  return {
    title: 'Next.js',
  }
}

セグメントのプロップスと共に

layout.tsx
import type { Metadata } from 'next'
 
type Props = {
  params: { id: string }
  searchParams: { [key: string]: string | string[] | undefined }
}
 
export function generateMetadata({ params, searchParams }: Props): Metadata {
  return {
    title: 'Next.js',
  }
}
 
export default function Page({ params, searchParams }: Props) {}

親のメタデータと共に

layout.tsx
import type { Metadata, ResolvingMetadata } from 'next'
 
export async function generateMetadata(
  { params, searchParams }: Props,
  parent: ResolvingMetadata
): Promise<Metadata> {
  return {
    title: 'Next.js',
  }
}

JavaScriptプロジェクト

JavaScriptプロジェクトでは、JSDocを使用して型安全性を追加できます。

layout.js
/** @type {import("next").Metadata} */
export const metadata = {
  title: 'Next.js',
}

バージョン履歴

VersionChanges
v13.2.0viewport、themeColor、colorScheme は viewport 設定を推奨して非推奨になりました。
v13.2.0metadata と generateMetadata が導入されました。

次のステップ

すべてのメタデータAPIオプションを表示します。

メタデータ

メタデータ API を使用して、任意のレイアウトまたはページでメタデータを定義します。

メタデータファイル API リファレンス

メタデータファイルの規約に関する API ドキュメント。

generateViewport

generateViewport関数のAPIリファレンス。