Metaplex

紹介

表示オプション

DAS APIは、レスポンスに含まれる追加情報を制御できる表示オプションを提供します。これらのオプションは、複数のAPIメソッドでoptionsオブジェクトパラメータとして利用できます。

利用可能な表示オプション

オプション型説明デフォルト
showCollectionMetadatabooleantrueの場合、レスポンスにコレクションメタデータを含めます。これによりアセットが属するコレクションに関する情報が提供されます。false
showFungiblebooleantrueの場合、レスポンスにファンジブルトークン情報を含めます。ファンジブルトークンを表すアセットや、getAssetsByOwnerを使用して実際にすべてのアセットを表示したい場合に有用です。false
showInscriptionbooleantrueの場合、レスポンスにインスクリプションデータを含めます。これにより含まれるアセットに関連するインスクリプション情報が提供されます。false
showUnverifiedCollectionsbooleantrueの場合、レスポンスに未検証のコレクションを含めます。デフォルトでは、検証済みのコレクションのみが表示されます。false
showZeroBalancebooleantrueの場合、レスポンスに残高がゼロのトークンアカウントを含めます。デフォルトでは、残高が非ゼロのアカウントのみが表示されます。false

使用例

基本的な使用法

import { publicKey } from '@metaplex-foundation/umi'

import { createUmi } from '@metaplex-foundation/umi-bundle-defaults'

import { dasApi } from '@metaplex-foundation/digital-asset-standard-api'



const umi = createUmi('<ENDPOINT>').use(dasApi())



// コレクションメタデータ付きでアセットを取得

const asset = await umi.rpc.getAsset({

  id: publicKey('your-asset-id'),

  displayOptions: {

    showCollectionMetadata: true

  }

})

複数のオプション

import { publicKey } from '@metaplex-foundation/umi'

import { createUmi } from '@metaplex-foundation/umi-bundle-defaults'

import { dasApi } from '@metaplex-foundation/digital-asset-standard-api'



const umi = createUmi('<ENDPOINT>').use(dasApi())



// 複数の表示オプションを有効にしてアセットを取得

const assets = await umi.rpc.getAssetsByOwner({

  owner: publicKey('owner-address'),

  displayOptions: {

    showCollectionMetadata: true,

    showFungible: true,

    showInscription: true

  }

})

すべてのオプションを有効化

import { publicKey } from '@metaplex-foundation/umi'

import { createUmi } from '@metaplex-foundation/umi-bundle-defaults'

import { dasApi } from '@metaplex-foundation/digital-asset-standard-api'



const umi = createUmi('<ENDPOINT>').use(dasApi())



// すべての表示オプションを有効化

const assets = await umi.rpc.searchAssets({

  owner: publicKey('owner-address'),

  displayOptions: {

    showCollectionMetadata: true,

    showFungible: true,

    showInscription: true,

    showUnverifiedCollections: true,

    showZeroBalance: true

  }

})

表示オプションをサポートするメソッド

以下のDAS APIメソッドは表示オプション付きのoptionsパラメータをサポートします：

パフォーマンスに関する考慮事項

表示オプションを有効にすると、レスポンスサイズと処理時間が増加する場合があります。パフォーマンスを最適化するために、特定の使用ケースに必要なオプションのみを有効にしてください。

Next
メソッド概要