APIリファレンス関数generateImageMetadata

generateImageMetadata

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

パラメーター

generateImageMetadata 関数は以下のパラメーターを受け入れます

`params` (オプション)

generateImageMetadata が呼び出されるルートセグメントから動的ルートパラメーターオブジェクトを含むオブジェクト。

icon.tsx

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）を含むオブジェクトの array を返す必要があります。加えて、各アイテムは画像生成関数のプロパティに渡される id 値を**必ず**含める必要があります。

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

icon.tsx

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 画像を生成します。

app/products/[id]/opengraph-image.tsx

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>
    )
  )
}