コンテンツにスキップ
API リファレンス関数generateMetadata

generateMetadata

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

layout.tsx | page.tsx
import type { Metadata } from 'next'
 
// either Static metadata
export const metadata: Metadata = {
  title: '...',
}
 
// or Dynamic metadata
export async function generateMetadata({ params }) {
  return {
    title: '...',
  }
}

知っておくと良いこと:

  • metadata オブジェクトと generateMetadata 関数のエクスポートは、サーバーコンポーネントでのみサポートされています。
  • 同じルートセグメントから metadata オブジェクトと generateMetadata 関数の両方をエクスポートすることはできません。

metadata オブジェクト

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

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

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

generateMetadata 関数

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

app/products/[id]/page.tsx
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> {
  // read route params
  const id = (await params).id
 
  // fetch data
  const product = await fetch(`https://.../${id}`).then((res) => res.json())
 
  // optionally access and extend (rather than replace) parent 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) {}

パラメータ

generateMetadata 関数は、次のパラメータを受け取ります。

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

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

      ルートURLパラメータ
      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 - 親ルートセグメントから解決されたメタデータのPromise。

戻り値

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

知っておくと良いこと:

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

メタデータフィールド

title

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

文字列

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

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

app/layout.tsx
import type { Metadata } from 'next'
 
export const metadata: Metadata = {
  title: {
    template: '...',
    default: '...',
    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 = {}
 
// Output: <title>Acme</title>
テンプレート

title.template は、子ルートセグメントで定義されたtitlesに接頭辞または接尾辞を追加するために使用できます。

app/layout.tsx
import type { Metadata } from 'next'
 
export const metadata: Metadata = {
  title: {
    template: '%s | Acme',
    default: 'Acme', // a default is required when creating a template
  },
}
app/about/page.tsx
import type { Metadata } from 'next'
 
export const metadata: Metadata = {
  title: 'About',
}
 
// Output: <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
import type { Metadata } from 'next'
 
export const metadata: Metadata = {
  title: {
    template: '%s | Acme',
  },
}
app/about/page.tsx
import type { Metadata } from 'next'
 
export const metadata: Metadata = {
  title: {
    absolute: 'About',
  },
}
 
// Output: <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は無視されます。
    • title.template は、ページが常にルートの終端セグメントであるため、page.jsでは効果がありません。

description

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

基本フィールド

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.dokyumento.jp' }],
  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.dokyumento.jp" />
<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" />

知っておくと良いこと:

  • 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にフォールバックします。

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

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

URL構成

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

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

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

app/layout.tsx
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 | page.js
export const metadata = {
  openGraph: {
    title: 'Next.js',
    description: 'The React Framework for the Web',
    url: 'https://nextjs.dokyumento.jp',
    siteName: 'Next.js',
    images: [
      {
        url: 'https://nextjs.dokyumento.jp/og.png', // Must be an absolute URL
        width: 800,
        height: 600,
      },
      {
        url: 'https://nextjs.dokyumento.jp/og-alt.png', // Must be an absolute URL
        width: 1800,
        height: 1600,
        alt: 'My custom alt',
      },
    ],
    videos: [
      {
        url: 'https://nextjs.dokyumento.jp/video.mp4', // Must be an absolute URL
        width: 800,
        height: 600,
      },
    ],
    audio: [
      {
        url: 'https://nextjs.dokyumento.jp/audio.mp3', // Must be an absolute 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.dokyumento.jp/" />
<meta property="og:site_name" content="Next.js" />
<meta property="og:locale" content="en_US" />
<meta property="og:image" content="https://nextjs.dokyumento.jp/og.png" />
<meta property="og:image:width" content="800" />
<meta property="og:image:height" content="600" />
<meta property="og:image" content="https://nextjs.dokyumento.jp/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.dokyumento.jp/video.mp4" />
<meta property="og:video:width" content="800" />
<meta property="og:video:height" content="600" />
<meta property="og:audio" content="https://nextjs.dokyumento.jp/audio.mp3" />
<meta property="og:type" content="website" />
layout.js | page.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 | 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

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

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"
/>

知っておくと良いこと: msapplication-* メタタグは、Microsoft EdgeのChromiumビルドではサポートされなくなったため、不要になりました。

themeColor

非推奨: metadata の themeColor オプションは、Next.js 14 以降非推奨になりました。代わりに、viewport 設定を使用してください。

manifest

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

layout.js | page.js
export const metadata = {
  manifest: 'https://nextjs.dokyumento.jp/manifest.json',
}
<head> 出力
<link rel="manifest" href="https://nextjs.dokyumento.jp/manifest.json" />

twitter

Twitterの仕様は、（驚くべきことに）X（旧Twitter）以外にも使用されています。

Twitterカードのマークアップリファレンスについて詳しくはこちらをご覧ください。

layout.js | page.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.dokyumento.jp/og.png'], // Must be an absolute 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.dokyumento.jp/og.png" />
layout.js | page.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.dokyumento.jp/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.dokyumento.jp/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

非推奨: 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.dokyumento.jp',
    languages: {
      'en-US': 'https://nextjs.dokyumento.jp/en-US',
      'de-DE': 'https://nextjs.dokyumento.jp/de-DE',
    },
    media: {
      'only screen and (max-width: 600px)': 'https://nextjs.dokyumento.jp/mobile',
    },
    types: {
      'application/rss+xml': 'https://nextjs.dokyumento.jp/rss',
    },
  },
}
<head> 出力
<link rel="canonical" href="https://nextjs.dokyumento.jp" />
<link rel="alternate" hreflang="en-US" href="https://nextjs.dokyumento.jp/en-US" />
<link rel="alternate" hreflang="de-DE" href="https://nextjs.dokyumento.jp/de-DE" />
<link
  rel="alternate"
  media="only screen and (max-width: 600px)"
  href="https://nextjs.dokyumento.jp/mobile"
/>
<link
  rel="alternate"
  type="application/rss+xml"
  href="https://nextjs.dokyumento.jp/rss"
/>
layout.js | page.js
export const metadata = {
  appLinks: {
    ios: {
      url: 'https://nextjs.dokyumento.jp/ios',
      app_store_id: 'app_store_id',
    },
    android: {
      package: 'com.example.android/package',
      app_name: 'app_name_android',
    },
    web: {
      url: 'https://nextjs.dokyumento.jp/web',
      should_fallback: true,
    },
  },
}
<head> 出力
<meta property="al:ios:url" content="https://nextjs.dokyumento.jp/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.dokyumento.jp/web" />
<meta property="al:web:should_fallback" content="true" />

archives

歴史的関心のある記録、文書、その他の資料のコレクションを記述します（ソース）。

layout.js | page.js
export const metadata = {
  archives: ['https://nextjs.dokyumento.jp/13'],
}
<head> 出力
<link rel="archives" href="https://nextjs.dokyumento.jp/13" />

assets

layout.js | page.js
export const metadata = {
  assets: ['https://nextjs.dokyumento.jp/assets'],
}
<head> 出力
<link rel="assets" href="https://nextjs.dokyumento.jp/assets" />

bookmarks

layout.js | page.js
export const metadata = {
  bookmarks: ['https://nextjs.dokyumento.jp/13'],
}
<head> 出力
<link rel="bookmarks" href="https://nextjs.dokyumento.jp/13" />

category

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

facebook

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

知っておくと良いこと: 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

すべてのメタデータオプションは、組み込みのサポートを使用してカバーされるはずです。ただし、サイト固有のカスタムメタデータタグや、リリースされたばかりの新しいメタデータタグがあるかもしれません。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" />

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

次のメタデータタイプは、現在組み込みのサポートがありません。ただし、これらはレイアウトまたはページ自体でレンダリングできます。

メタデータ推奨事項
<meta http-equiv="...">redirect()、ミドルウェア、セキュリティヘッダーを介して適切な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
'use client'
 
import ReactDOM from 'react-dom'
 
export function PreloadResources() {
  ReactDOM.preload('...', { as: '...' })
  ReactDOM.preconnect('...', { crossOrigin: '...' })
  ReactDOM.prefetchDNS('...')
 
  return '...'
}

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

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

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

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

リソースがリクエストされる前に、ドメイン名の解決を試みます。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 | 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',
  }
}

セグメントプロパティ付き

layout.tsx | page.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 | 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.0viewport、themeColor、およびcolorSchemeは、viewport設定に置き換えられ、非推奨となりました。
v13.2.0metadataとgenerateMetadataが導入されました。

次のステップ

Metadata APIのすべてのオプションをご覧ください。

メタデータファイル

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

generateViewport

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

メタデータ

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