generateImageMetadata

generateImageMetadataを使用すると、1つの画像の異なるバージョンを生成したり、1つのルートセグメントに対して複数の画像を返したりできます。これは、アイコンのようなメタデータ値をハードコーディングしたくない場合に便利です。

パラメータ

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

`params` (オプション)

generateImageMetadataが呼び出されたセグメントまでの動的ルートパラメータオブジェクトを含むオブジェクトです。

export function generateImageMetadata({
  params,
}: {
  params: { slug: string }
}) {
  // ...
}

ルート	URL	`params`
`app/shop/icon.js`	`/shop`	`undefined`
`app/shop/[slug]/icon.js`	`/shop/1`	`{ slug: '1' }`
`app/shop/[tag]/[item]/icon.js`	`/shop/1/2`	`{ tag: '1', item: '2' }`

戻り値

generateImageMetadata関数は、画像のメタデータ（altやsizeなど）を含むオブジェクトの配列を返す必要があります。さらに、各アイテムには、画像生成関数のpropsに渡されるid値を必ず含める必要があります。

画像メタデータオブジェクト	型
`id`	`string` (必須)
`alt`	`string`
`size`	`{ width: number; height: number }`
`contentType`	`string`

import { ImageResponse } from 'next/og'

export function generateImageMetadata() {
  return [
    {
      contentType: 'image/png',
      size: { width: 48, height: 48 },
      id: 'small',
    },
    {
      contentType: 'image/png',
      size: { width: 72, height: 72 },
      id: 'medium',
    },
  ]
}

export default function Icon({ id }: { id: string }) {
  return new ImageResponse(
    (
      <div
        style={{
          width: '100%',
          height: '100%',
          display: 'flex',
          alignItems: 'center',
          justifyContent: 'center',
          fontSize: 88,
          background: '#000',
          color: '#fafafa',
        }}
      >
        Icon {id}
      </div>
    )
  )
}

例

外部データの使用

この例では、paramsオブジェクトと外部データを使用して、ルートセグメントに対して複数のOpen Graph画像を生成しています。

import { ImageResponse } from 'next/og'
import { getCaptionForImage, getOGImages } from '@/app/utils/images'

export async function generateImageMetadata({
  params,
}: {
  params: { id: string }
}) {
  const images = await getOGImages(params.id)

  return images.map((image, idx) => ({
    id: idx,
    size: { width: 1200, height: 600 },
    alt: image.text,
    contentType: 'image/png',
  }))
}

export default async function Image({
  params,
  id,
}: {
  params: { id: string }
  id: number
}) {
  const productId = (await params).id
  const imageId = id
  const text = await getCaptionForImage(productId, imageId)

  return new ImageResponse(
    (
      <div
        style={
          {
            // ...
          }
        }
      >
        {text}
      </div>
    )
  )
}

バージョン履歴

バージョン	変更内容
`v13.3.0`	`generateImageMetadata`が導入されました。

メタデータファイル

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

パラメータ

params (オプション)

戻り値

例

外部データの使用

バージョン履歴

メタデータファイル

On this page

`params` (オプション)