ドキュメントAEMDynamic Media Image Production System API

searchAssets searchassets

最終更新日： 2025年8月14日

作成対象：

  • Developer
  • Admin

指定した条件に基づいてアセットを検索します。

構文

searchAssets：概要 section-4ad74f12eb754768bf85bd235a7e25f0

searchAssetsは、IPS アセットを取得する主な方法です。 この方法は、フォルダー階層の参照や、特定のアセットの名前の検索など、様々な目的で使用されます。

応答サイズ

searchAssetsは、1回の呼び出しで最大1000個のアセットを返します。 1回の呼び出しで最大10,000個のアセットを返すには、応答データをtotalRows、name、handle、type、およびsubType フィールドのサブセットに制限します。 大きなセットを返すには、resultPage パラメーターを使用してページングを設定します。

responseFieldArrayまたはexcludeFieldArray​を使用して結果ファイルサイズを制限

データセットのサイズをresponseFieldArrayまたはexcludFieldArray パラメーターで制限します。 これらのパラメーターは、メモリの使用と帯域幅を減らし、サーバーの応答時間を短縮するのに役立ちます。

承認済みユーザータイプ section-9c4bc41bb8b4493982197eb13c7cdc55

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • ImagePortalUser
  • ImagePortalContrib
  • ImagePortalContribUser
NOTE
アセットを返すには、ユーザーに読み取りアクセス権が必要です。

パラメーター section-49aabc0600764f55a8b7017d86ded44f

入力（searchAssetsParam）

名前
種類
必要ですか？
説明
companyHandle
xsd:string
はい
検索するアセットを持つ会社へのハンドル。
accessUserHandle
xsd:string
いいえ
管理者は別のユーザーとして作業できます。
accessGroupHandle
xsd:string
いいえ
管理者は別のグループの一部として作業できます。
フォルダー
xsd:string
いいえ
アセットを検索するためのルートパス。 省略した場合は、会社のルートフォルダーが使用されます。
includeSubfolders
xsd:boolean
いいえ
サブフォルダーを検索するには、 trueに設定します。
publishState
xsd:string
いいえ
公開状態の選択：
trashState
xsd:string
いいえ
ゴミ箱の状態選択。 デフォルトは NotInTrashです。
conditionMatchMode
xsd:string
いいえ

keywordArrayの結果を組み合わせるための検索マッチモードの選択

conditionMatchMode

systemFieldConditionArrayおよび metadataConditionArray。 デフォルトは MatchAllです。

keywordArray
タイプ：StringArray
いいえ

注意：非推奨のパラメーター。 あなたはそれを使わないことをお勧めします。

一致するキーワードの文字列配列。

systemFieldMatchMode
xsd:string
いいえ

個のsystemFieldCondition個の一致を組み合わせるための検索マッチモードを選択します。 デフォルトは MatchAllです

.

systemFieldConditionArray
種類：SystemFieldConditionArray
いいえ
システムフィールド条件の配列。
tagMatchMode
xsd:string
いいえ
検索マッチモードの文字列定数。 デフォルトは MatchAllです。
tagConditionArray
種類：TagConditionArray
いいえ

タグフィールド検索述語の配列。

述語は tagMatchMode設定に従って組み合わされ、次に keywordArray、 systemFieldConditionArray、 metadataConditionArrayの任意の用語と conditionMatchMode設定に従って組み合わされます。

metadataMatchMode
xsd:string
いいえ
metadataConditionの一致を組み合わせるための一致モードを検索します。 デフォルトは MatchAllです。
metadataConditionArray
種類：MetadataConditionArray
いいえ
メタデータフィールド検索条件の配列。
assetTypeArray
タイプ：StringArray
いいえ
検索に含めるアセットタイプの配列。
excludeAssetTypeArray
タイプ：StringArray
いいえ
検索から除外するアセットタイプの配列。
assetSubTypeArray
タイプ：StringArray
いいえ
フィルターするサブタイプ名のリスト。
strictSubTypeCheck
xsd:boolean
いいえ
trueと assetSubTypeArrayが空でない場合、 assetSubTypeArrayのサブタイプを持つアセットのみが返されます。 false （デフォルト）の場合、定義されたサブタイプのないアセットが返されます。
excludeByproducts
xsd:boolean
いいえ
trueの場合、リッピングされたPDF ページ画像などのプライマリアセットの取り込み中に生成された副産物アセットは、検索結果から除外されます。 初期設定は false。
excludByproductArray
種類：ExcludeByproductArray
いいえ
検索結果から除外する副産物アセット生成条件の配列。 存在する場合、このパラメーターはexcludeByproducts設定を上書きします。
projectHandle
xsd:sting
いいえ
検索するアセットを含むプロジェクトのハンドル。
recordsPerPage
xsd:int
いいえ
返される結果の最大数。
件の結果ページ
xsd:int
いいえ
recordsPerPage ページサイズに基づいて、返す結果のページを指定します。
sortBy
xsd:string
いいえ
アセットソートフィールドの選択。
sortDirection
xsd:string
いいえ
ソート方向の選択。
responseFieldArray
タイプ：StringArray
いいえ
応答に含めるフィールドとサブフィールドのリストが含まれます。
excludeFieldArray
タイプ：StringArray
いいえ
応答から除外するフィールドとサブフィールドのリストが含まれます。

出力（searchAssetsReturn）

名前
種類
必須
説明
totalRows
xsd:int
いいえ
ページあたりのレコードが制限されていない場合に検索が返す行数。
assetArray
types:AssetArray
いいえ
検索で返されるAssets。

例 section-725484cc09b54772a838ad2cc930b94b

このコードサンプルは、特定の会社に属する画像アセットを検索します。 簡潔にするために、応答は切り捨てられます。

リクエスト

<ns1:searchAssetsParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:companyHandle>47</ns1:companyHandle>
   <ns1:includeSubfolders>true</ns1:includeSubfolders>
   <ns1:assetTypeArray>
      <ns1:items>Image</ns1:items>
   </ns1:assetTypeArray>
</ns1:searchAssetsParam>

応答

<searchAssetsReturn xmlns="http://www.scene7.com/IpsApi/xsd">
   <totalRows>210</totalRows>
   <assetArray>
      <items>
         <assetHandle>24265|1|17061</assetHandle>
         <type>Image</type>
         <name>Autumn Leaves</name>
         ...
      </items>
    </assetArray>
</searchAssetsReturn>
recommendation-more-help
dynamic-media-developer-resources-help-aem-ips-api