generateImageMetadata
generateImageMetadataを使用して、1つの画像の異なるバージョンを生成したり、1つのルートセグメントに対して複数の画像を返したりできます。アイコンなどのメタデータ値をハードコーディングしたくない場合に便利です。
パラメータ
generateImageMetadata関数は、次のパラメータを受け入れます：
params（オプション）
ルートセグメントからgenerateImageMetadataが呼び出されるセグメントまでの動的ルートパラメータオブジェクト。
icon.tsx
TypeScript
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やサイズなどの画像のメタデータを含むオブジェクトのarrayを返す必要があります。さらに、各アイテムには画像生成関数のプロップスに渡されるid値が必須となります。
| 画像メタデータオブジェクト | 型 |
|---|---|
id | string（必須） |
alt | string |
size | { width: number; height: number } |
contentType | string |
icon.tsx
TypeScript
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
TypeScript
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 |
次のステップ
すべてのMetadata APIオプションを表示。