generateMetadata

このページでは、generateMetadataと静的metadataオブジェクトを使用したConfigベースのMetadataオプションをすべて紹介します。

TypeScript
JavaScript

layout.tsx | page.tsx
import type { Metadata } from 'next'

//  静的なmetadata
export const metadata: Metadata = {
  title: '...',
}

//  動的なmetadata
export async function generateMetadata({ params }) {
  return {
    title: '...',
  }
}

layout.js | page.js
// 静的なmetadata
export const metadata = {
  title: '...',
}

// 動的なmetadata
export async function generateMetadata({ params }) {
  return {
    title: '...',
  }
}

Good to know:

metadataオブジェクトとgenerateMetadata関数のエクスポートは、Server Componentでのみサポートされています。

同じルートセグメントからmetadataオブジェクトとgenerateMetadata関数の両方をエクスポートすることはできません。

初回読み込み時には、generateMetadataが完全に解決されるまで、ストリーミングはブロックされます。loading.jsの内容も含まれます。

`metadata`オブジェクト

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

TypeScript
JavaScript

layout.tsx | page.tsx
import type { Metadata } from 'next'

export const metadata: Metadata = {
  title: '...',
  description: '...',
}

export default function Page() {}

layout.js | page.js
export const metadata = {
  title: '...',
  description: '...',
}

export default function Page() {}

サポートされているオプションの完全なリストは、Metadata Fieldsを参照してください。

`generateMetadata`関数

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

TypeScript
JavaScript

app/products/[id]/page.tsx
import type { Metadata, ResolvingMetadata } from 'next'

type Props = {
  params: Promise<{ id: string }>
  searchParams: Promise<{ [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())

  //親metadataへのアクセスと拡張（置換ではなく）を行う
  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) {}

app/products/[id]/page.js
export async function generateMetadata({ params, searchParams }, parent) {
  // ルートのパラメーターを読み取る
  const id = (await params).id

  // データを取得する
  const product = await fetch(`https://.../${id}`).then((res) => res.json())

  // 親metadataへのアクセスと拡張（置換ではなく）を行う
  const previousImages = (await parent).openGraph?.images || []

  return {
    title: product.title,
    openGraph: {
      images: ['/some-specific-page-image.jpg', ...previousImages],
    },
  }
}

export default function Page({ params, searchParams }) {}

パラメーター

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

props - 現在のルートのパラメーターを含むオブジェクト：
- params - 動的ルートパラメーターオブジェクトを含むオブジェクトで、root セグメントからgenerateMetadataが呼び出されたセグメントまでのオブジェクトです。例：
  
  ルート URL params
  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の検索パラメーターを含むオブジェクトです。例：
  
  URL searchParams
  /shop?a=1 { a: '1' }
  /shop?a=1&b=2 { a: '1', b: '2' }
  /shop?a=1&a=2 { a: ['1', '2'] }
parent - 親ルートセグメントから解決されたmetadataのPromise。

ルート	URL	`params`
`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'] }`

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

戻り値

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

Good to know:

metadataが実行時情報に依存しない場合、generateMetadataではなく静的metadataオブジェクトを使用して定義する必要があります。

generateMetadata、generateStaticParams、Layout、Pages、Server Component全体で同じデータに対するfetchリクエストは自動的にメモ化されます。 fetchが使用できない場合、React cacheを使用することができます。

searchParamsはpage.jsセグメントでのみ使用可能です。

Next.jsの方法であるredirect()とnotFound()は、generateMetadata内でも使用できます。

Metadataフィールド

`title`

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

文字列

layout.js | page.js
export const metadata = {
  title: 'Next.js',
}

<head>出力
<title>Next.js</title>

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

TypeScript
JavaScript

app/layout.tsx
import type { Metadata } from 'next'

export const metadata: Metadata = {
  title: {
    template: '...',
    default: '...',
    absolute: '...',
  },
}

app/layout.js
export const metadata = {
  title: {
    default: '...',
    template: '...',
    absolute: '...',
  },
}

デフォルト

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

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は、childルートセグメントで定義されたtitlesにプレフィックスやサフィックスを追加するために使用できます。

TypeScript
JavaScript

app/layout.tsx
import type { Metadata } from 'next'

export const metadata: Metadata = {
  title: {
    template: '%s | Acme',
    default: 'Acme', // テンプレートを作成する際にはデフォルトが必要です
  },
}

app/layout.js
export const metadata = {
  title: {
    template: '%s | Acme',
    default: 'Acme', // テンプレートを作成する際にはデフォルトが必要です
  },
}

TypeScript
JavaScript

app/about/page.tsx
import type { Metadata } from 'next'

export const metadata: Metadata = {
  title: 'About',
}

// 出力：<title>About | Acme</title>

app/about/page.js
export const metadata = {
  title: 'About',
}

// 出力：<title>About | Acme</title>

Good to know:

title.templateは、childルートセグメントに適用され、定義されたセグメントには適用されません。つまり：

title.templateを追加した場合、title.defaultが必須となります。

layout.jsで定義されたtitle.templateは、同じルートセグメントのpage.jsで定義されたtitleには適用されません。

page.jsで定義されたtitle.templateは、ページは常に終端セグメントで（子ルートセグメントがないため）影響を与えません。

ルートがtitleやtitle.defaultを定義していない場合、title.templateは影響を与えません。

絶対

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

TypeScript
JavaScript

app/layout.tsx
import type { Metadata } from 'next'

export const metadata: Metadata = {
  title: {
    template: '%s | Acme',
  },
}

app/layout.js
export const metadata = {
  title: {
    template: '%s | Acme',
  },
}

TypeScript
JavaScript

app/about/page.tsx
import type { Metadata } from 'next'

export const metadata: Metadata = {
  title: {
    absolute: 'About',
  },
}

// 出力：<title>About</title>

app/about/page.js
export const metadata = {
  title: {
    absolute: 'About',
  },
}

// 出力：<title>About</title>

Good to know:

layout.js

title（文字列）およびtitle.defaultは、子セグメントのデフォルトのタイトルを定義します（独自のtitleを定義していない場合）。親セグメントからのtitle.templateが存在する場合、それを補完します。

title.absoluteは、子セグメントのデフォルトのタイトルを定義します。親セグメントからのtitle.templateは無視されます。

title.templateは、子セグメントの新しいタイトルテンプレートを定義します。

page.js

ページが独自のタイトルを定義していない場合は、最も近い親の解決されたタイトルが使用されます。

title（文字列）は、ルートのタイトルを定義します。親セグメントからのtitle.templateが存在する場合、それを補完します。

title.absoluteは、ルートタイトルを定義します。親セグメントからのtitle.templateは無視されます。

title.templateは常にルートの終端セグメントであるため、page.jsでは影響を与えません。

`description`

layout.js | page.js
export const metadata = {
  description: 'Webに特化したReactフレームワーク',
}

<head>出力
<meta name="description" content="Webに特化したReactフレームワーク" />

基本フィールド

layout.js | page.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フィールドは、絶対URLの代わりに相対パスを使用できます。
フィールドの相対パスはmetadataBaseと組み合わされ、完全修飾URLを形成します。
設定されていない場合、metadataBaseはデフォルト値で自動的に設定されます。

layout.js | page.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" />

Good to know:

metadataBaseは通常、すべてのルートにわたるURLベースのmetadataフィールドに適用されるようにroot 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に戻ります。

これらの値が存在する場合、これがmetadataBaseのデフォルト値として使用され、存在しない場合はhttp://localhost:${process.env.PORT || 3000}に戻ります。これにより、Open Graph画像はローカルビルドとVercelプレビューおよび本番展開の両方で動作することができます。デフォルトを上書きする際には、環境変数を使用してURLを計算することをお勧めします。これにより、開発環境、ステージング、および本番環境のURLを構成できます。

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

URLの構成

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

metadataBaseとmetadataフィールド間の後続スラッシュは正規化されます。
metadataフィールドの「絶対的」なパスは、「相対的」なパス（metadataBaseの終わりから始まる）として扱われます。

たとえば、次のmetadataBaseが与えられた場合：

TypeScript
JavaScript

app/layout.tsx
import type { Metadata } from 'next'

export const metadata: Metadata = {
  metadataBase: new URL('https://acme.com'),
}

app/layout.js
export const metadata = {
  metadataBase: new URL('https://acme.com'),
}

上記のmetadataBaseを継承し、自分の値を設定したすべてのmetadataフィールドは次のように解決されます：

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

`openGraph`

layout.js | page.js
export const metadata = {
  openGraph: {
    title: 'Next.js',
    description: 'Webに特化したReactフレームワーク',
    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: 'My custom 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="Webに特化したReactフレームワーク" />
<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="My custom 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 | page.js
export const metadata = {
  openGraph: {
    title: 'Next.js',
    description: 'Webに特化したReactフレームワーク',
    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="Webに特化したReactフレームワーク" />
<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" />

Good to know:

Open Graph画像には、ファイルベースのMetadata APIを使用するほうが便利かもしれません。設定エクスポートと実際のファイルを同期するのではなく、ファイルベースのAPIは自動的に正しいmetadataを生成します。

`robots`

layout.tsx | page.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`

Good to know: アイコンには、可能な限り、ファイルベースのMetadata APIを使用することをお勧めします。設定エクスポートと実際のファイルを同期するのではなく、ファイルベースのAPIは自動的に正しいmetadataを生成します。

layout.js | page.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 | page.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"
/>

Good to know: msapplication-*メタタグは、Microsoft EdgeのChromiumビルドではもはやサポートされていないため、もはや必要ありません。

`themeColor`

Deprecated: metadataのthemeColorオプションはNext.js 14から廃止されました。代わりにviewport構成を使用してください。

`manifest`

Webアプリケーションマニフェストは、Webアプリケーションマニフェスト仕様で定義されています。

layout.js | page.js
export const metadata = {
  manifest: 'https://nextjs.org/manifest.json',
}

<head>出力
<link rel="manifest" href="https://nextjs.org/manifest.json" />

`twitter`

Twitter仕様は（驚くべきことに）X（旧称Twitter）だけでなく、多くの用途に使用されています。

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

layout.js | page.js
export const metadata = {
  twitter: {
    card: 'summary_large_image',
    title: 'Next.js',
    description: 'Webに特化したReactフレームワーク',
    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="Webに特化したReactフレームワーク" />
<meta name="twitter:image" content="https://nextjs.org/og.png" />

layout.js | page.js
export const metadata = {
  twitter: {
    card: 'app',
    title: 'Next.js',
    description: 'Webに特化したReactフレームワーク',
    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="Webに特化したReactフレームワーク" />
<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`

Deprecated: metadataのviewportオプションはNext.js 14から廃止されました。代わりにviewport構成を使用してください。

`verification`

layout.js | page.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 | page.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 | page.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 | page.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 | page.js
export const metadata = {
  archives: ['https://nextjs.org/13'],
}

<head>出力
<link rel="archives" href="https://nextjs.org/13" />

`assets`

layout.js | page.js
export const metadata = {
  assets: ['https://nextjs.org/assets'],
}

<head>出力
<link rel="assets" href="https://nextjs.org/assets" />

`bookmarks`

layout.js | page.js
export const metadata = {
  bookmarks: ['https://nextjs.org/13'],
}

<head>出力
<link rel="bookmarks" href="https://nextjs.org/13" />

`category`

layout.js | page.js
export const metadata = {
  category: 'technology',
}

<head>出力
<meta name="category" content="technology" />

`facebook`

特定のFacebookソーシャルプラグインに対してWebページにFacebookアプリやFacebookアカウントを接続できます。Facebookドキュメント

Good to know: appIdまたはadminsを指定できますが、両方は指定できません。

layout.js | page.js
export const metadata = {
  facebook: {
    appId: '12345678',
  },
}

<head>出力
<meta property="fb:app_id" content="12345678" />

layout.js | page.js
export const metadata = {
  facebook: {
    admins: '12345678',
  },
}

<head>出力
<meta property="fb:admins" content="12345678" />

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

layout.js | page.js
export const metadata = {
  facebook: {
    admins: ['12345678', '87654321'],
  },
}

<head>出力
<meta property="fb:admins" content="12345678" />
<meta property="fb:admins" content="87654321" />

`other`

すべてのmetadataオプションは、組み込みサポートを使用してカバーされるべきです。ただし、サイトに固有のカスタムmetadataタグや、新しくリリースされたmetadataタグが存在するかもしれません。それらをレンダリングするためにotherオプションを使用できます。

layout.js | page.js
export const metadata = {
  other: {
    custom: 'meta',
  },
}

<head>出力
<meta name="custom" content="meta" />

同一キーの複数のメタタグを生成したい場合、配列値を使用できます。

layout.js | page.js
export const metadata = {
  other: {
    custom: ['meta1', 'meta2'],
  },
}

<head>出力
<meta name="custom" content="meta1" /> <meta name="custom" content="meta2" />

非サポートのMetadata

以下のmetadata型は現在組み込みサポートを持っていません。ただし、それらはレイアウトまたはページ自体でレンダリングできます。

Metadata	推奨事項
`<meta http-equiv="...">`	適切なHTTPヘッダー、Middleware、Security Headersを使用してください。
`<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キーワードがいくつかあります。ブラウザはこの情報を使用してキーワードに応じたプリロード最適化を適用します。

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

TypeScript
JavaScript

app/preload-resources.tsx
'use client'

import ReactDOM from 'react-dom'

export function PreloadResources() {
  ReactDOM.preload('...', { as: '...' })
  ReactDOM.preconnect('...', { crossOrigin: '...' })
  ReactDOM.prefetchDNS('...')

  return '...'
}

app/preload-resources.js
'use client'

import ReactDOM from 'react-dom'

export function PreloadResources() {
  ReactDOM.preload('...', { as: '...' })
  ReactDOM.preconnect('...', { crossOrigin: '...' })
  ReactDOM.prefetchDNS('...')

  return '...'
}

`<link rel="preload">`

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

ReactDOM.preload(href: string, options: { as: string })

<head>出力
<link rel="preload" href="..." as="..." />

`<link rel="preconnect">`

予めオリジンに接続を開始します。MDN Docs.

ReactDOM.preconnect(href: string, options?: { crossOrigin?: string })

<head>出力
<link rel="preconnect" href="..." crossorigin />

`<link rel="dns-prefetch">`

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

ReactDOM.prefetchDNS(href: string)

<head>出力
<link rel="dns-prefetch" href="..." />

Good to know:

これらのメソッドは現在クライアントコンポーネントでのみサポートされており、初回ページ読み込み時にはサーバサイドレンダリングを行っています。

Next.jsの組み込み機能であるnext/font、next/image、およびnext/scriptは、自動的に関連するリソースヒントを処理します。

型

Metadata型を使用して、metadataに型安全性を追加できます。IDEで組み込みTypeScriptプラグインを使用している場合、手動で型を追加する必要はありませんが、需要によっては依然として明示的に追加できます。

`metadata`オブジェクト

layout.tsx | page.tsx
import type { Metadata } from 'next'

export const metadata: Metadata = {
  title: 'Next.js',
}

`generateMetadata`関数

通常の関数

layout.tsx | page.tsx
import type { Metadata } from 'next'

export function generateMetadata(): Metadata {
  return {
    title: 'Next.js',
  }
}

非同期関数

layout.tsx | page.tsx
import type { Metadata } from 'next'

export async function generateMetadata(): Promise<Metadata> {
  return {
    title: 'Next.js',
  }
}

セグメントpropsを使用した場合

layout.tsx | page.tsx
import type { Metadata } from 'next'

type Props = {
  params: Promise<{ id: string }>
  searchParams: Promise<{ [key: string]: string | string[] | undefined }>
}

export function generateMetadata({ params, searchParams }: Props): Metadata {
  return {
    title: 'Next.js',
  }
}

export default function Page({ params, searchParams }: Props) {}

親metadataを使用した場合

layout.tsx | page.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 | page.js
/** @type {import("next").Metadata} */
export const metadata = {
  title: 'Next.js',
}

バージョン履歴

バージョン	変更内容
`v13.2.0`	`viewport`、`themeColor`、および`colorScheme`は、`viewport`構成に置き換えられて削除されました。
`v13.2.0`	`metadata`および`generateMetadata`が導入されました。

metadataオブジェクト​

generateMetadata関数​

パラメーター​

戻り値​

Metadataフィールド​

title​

文字列​

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

デフォルト​

テンプレート​

絶対​

description​

基本フィールド​

metadataBase​

デフォルトの値​

URLの構成​

openGraph​

robots​

icons​

themeColor​

manifest​

twitter​

viewport​

verification​

appleWebApp​

alternates​

appLinks​

archives​

assets​

bookmarks​

category​

facebook​

other​

非サポートのMetadata​

リソースヒント​

<link rel="preload">​

<link rel="preconnect">​

<link rel="dns-prefetch">​

型​

metadataオブジェクト​

generateMetadata関数​

通常の関数​

非同期関数​

セグメントpropsを使用した場合​

親metadataを使用した場合​

JavaScriptプロジェクト​

バージョン履歴​

`metadata`オブジェクト

`generateMetadata`関数

パラメーター

戻り値

Metadataフィールド

`title`

文字列

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

デフォルト

テンプレート

絶対

`description`

基本フィールド

`metadataBase`

デフォルトの値

URLの構成

`openGraph`

`robots`

`icons`

`themeColor`

`manifest`

`twitter`

`viewport`

`verification`

`appleWebApp`

`alternates`

`appLinks`

`archives`

`assets`

`bookmarks`

`category`

`facebook`

`other`

非サポートのMetadata

リソースヒント

`<link rel="preload">`

`<link rel="preconnect">`

`<link rel="dns-prefetch">`

型

`metadata`オブジェクト

`generateMetadata`関数

通常の関数

非同期関数

セグメントpropsを使用した場合

親metadataを使用した場合

JavaScriptプロジェクト

バージョン履歴