searchAssets

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

構文

searchAssets:について

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

応答サイズ

searchAssets は 1 回の呼び出しで最大 1,000 個のアセットを返します。 1 回の呼び出しで最大 10,000 個のアセットを返すには、応答データを totalRows, name, handle, type、および subType フィールド。 より大きなセットを返すには、 resultPage パラメーター。

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

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

認証済みユーザータイプ

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • ImagePortalUser
  • ImagePortalContrib
  • ImagePortalContribUser
メモ

アセットを返すには、読み取りアクセス権が必要です。

パラメータ

入力 (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 types:StringArray いいえ

注意：廃止されたパラメーター。 使用しないようお勧めします。

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

systemFieldMatchMode xsd:string いいえ

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

.

systemFieldConditionArray

types:SystemFieldConditionArray

いいえ システムフィールド条件の配列。
tagMatchMode xsd:string いいえ 検索一致モード文字列定数。 デフォルトはです。 MatchAll.
tagConditionArray types:TagConditionArray いいえ

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

述語は、 tagMatchMode 設定し、 keywordArray, systemFieldConditionArray、および metadataConditionArray 次によると conditionMatchMode 設定。

metadataMatchMode xsd:string いいえ 組み合わせのための検索一致モード metadataCondition 一致する。 デフォルトはです。 MatchAll.
metadataConditionArray

types:MetadataConditionArray

いいえ メタデータフィールドの検索条件の配列。
assetTypeArray types:StringArray いいえ 検索に含めるアセットタイプの配列。
excludeAssetTypeArray types:StringArray いいえ 検索から除外するアセットタイプの配列。
assetSubTypeArray types:StringArray いいえ フィルターするサブタイプ名のリスト。
strictSubTypeCheck xsd:boolean いいえ If true および assetSubTypeArray が空ではなく、サブタイプがに含まれるアセットのみ assetSubTypeArray が返されます。 If false （デフォルト）の場合、サブタイプが定義されていないアセットが返されます。
excludeByproducts xsd:boolean いいえ true の場合、プライマリアセットの取り込み中に生成された副産物アセット (PDFページの切り抜き画像など ) は、検索結果から除外されます。 初期設定は false。
excludByproductArray

types:ExcludeByproductArray

いいえ 検索結果から除外する副産物アセット生成条件の配列。 存在する場合、このパラメーターは excludeByproducts の設定を上書きします。
projectHandle xsd:sting いいえ 検索するアセットを含むプロジェクトの処理。
recordsPerPage xsd:int いいえ 返す結果の最大数。
resultsPage xsd:int いいえ 返す結果のページを、 recordsPerPage ページサイズ。
sortBy xsd:string いいえ アセット並べ替えフィールドの選択。
sortDirection xsd:string いいえ 並べ替え方向の選択。
responseFieldArray types:StringArray いいえ 応答に含めるフィールドとサブフィールドのリストが含まれます。
excludeFieldArray types:StringArray いいえ 応答から除外するフィールドとサブフィールドのリストが含まれます。

出力 (searchAssetsReturn)

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

例

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

リクエスト

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

このページ