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

searchAssets searchassets

Last update: Mon Jul 22 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • トピック：

作成対象：

  • 開発者
  • 管理者

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

構文

searchAssets：詳細 section-4ad74f12eb754768bf85bd235a7e25f0

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

応答サイズ

searchAssets は、1 回の呼び出しで最大 1,000 個のアセットを返します。 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
いいえ
Publish州の選択。
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
いいえ
Search Match metadataCondition の一致を組み合わせ ためのモード。 デフォルトは MatchAll です。
metadataConditionArray
タイプ：MetadataConditionArray
いいえ
メタデータフィールド検索条件の配列。
assetTypeArray
型：StringArray
いいえ
検索に含めるアセットタイプの配列。
excludeAssetTypeArray
型：StringArray
いいえ
検索から除外するアセットタイプの配列。
assetSubTypeArray
型：StringArray
いいえ
フィルタリング対象のサブタイプ名のリスト。
strictSubTypeCheck
xsd:boolean
いいえ
trueassetSubTypeArray が空でない場合 、サブタイプが assetSubTypeArray に含まれるアセットのみ 返されます。 false 場合 （デフォルト）、サブタイプが定義されていないアセットが返されます。
excludeByproducts
xsd:boolean
いいえ
true の場合、PDFページの画像を取り込むなど、プライマリアセットの取り込み中に生成された副産物アセットは、検索結果から除外されます。 初期設定は false。
excludByproductArray
の種類：ExcludeByproductArray
いいえ
検索結果から除外する副産物アセット生成条件の配列。 存在する場合、このパラメーターは excludeByproducts 設定を上書きします。
projectHandle
xsd:sting
いいえ
検索するアセットを含むプロジェクトのハンドル。
recordsPerPage
xsd:int
いいえ
返される結果の最大数。
resultsPage
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
4e9b9d8c-5839-4215-aa35-01b652869681