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

searchAssetsByMetadata searchassetsbymetadata

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

作成対象：

  • 開発者
  • 管理者

指定された検索用語について、メタデータインデックスリポジトリを検索します。 searchAssets メソッドのようなアセットデータを返します。

searchAssetsByMetadata では、ユーザー定義のメタデータフィールドを検索できますが、これらのフィールドが responseMetadataArray で指定されている場合は返されません。 この点を説明するために、次のコード例を示します。

<ns:responseMetadataArray>
 <ns:items>custom_attributes.x</ns:items>
</ns:responseMetadataArray>

が null 値を返します。

<items>
 <name>custom_attributes.x</name>
 <value>null</value>
</items>

この問題を回避するには、検索から返されるアセットの fieldHandles を使用して getAssets を実行します（getAssets も参照）。 このメソッドは、対象のアセットのユーザー定義フィールド値を取得します。 ユーザー定義のメタデータフィールドを検索するには、次の構文例を使用します。

<ns:metadataConditionArray>
 <ns:items>
  <ns:fieldHandle>custom_attributes.[UDF Field Name]</ns:fieldHandle>
  <ns:op>[Conditional]</ns:op>
  <ns:value>[Value]</ns:value>
 </ns:items>
</ns:metadataConditionArray>

許可されているユーザータイプ section-9f85dd55ab574104b5fdc0f95aa0a0e2

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • ImagePortalAdmin
  • ImagePortalUser
  • ImagePortalContrib
  • ImagePortalContribUser

パラメーター section-5f1edb9c5b914160ab361f4364b8aa8d

入力（searchAssetsByMetadataParam）

名前
種類
必須
説明
companyHandle
xsd:string
はい
会社へのハンドル。
フィルター
type:SearchFilter
いいえ

検索条件の定義に役立つフィルター。

SearchFilter を参照してください。

metadataConditionArray
type:MetadataConditionArray
いいえ
検索条件を定義する条件。 詳しくは、以下を参照してください。
responseMetadataArray
type:StringArray
いいえ
アセットの概要の応答に入力する追加フィールド。 フィールドは、正規化された形式で指定する必要があります。
recordsPerPage
xsd:int
いいえ
応答によって返されるアセットの数。 デフォルト値は 1000 です。
resultsPage
xsd:int
いいえ
recordsPerPage ページのサイズに基づいて、返す結果 ページを指定します。
sortBy
xsd:string
いいえ
選択したアセットフィールドで並べ替えます。
sortDirection
xsd:string
いいえ
並べ替え方向の選択。 デフォルトは昇順です。

出力（searchAssetsByMetadataReturn）

名前
種類
必須
説明
totalRows
xsd:int
いいえ
一致する数。
assetArray
types:AssetArray
いいえ
検索によって返されるアセットの配列。

metadataConditionArray の詳細 section-1af4a4a22f82451eabdf6dfe13d9f27d

アイテム構造

構造 metadataConditionArray 次のとおりです。

<ns1:items>
   <ns:fieldHandle>field_handle</ns:fieldHandle>
   <ns:op>operator</ns:op>
   <ns:value>comparison_value</ns:value>
</ms1:items>

値

field_handle はメタデータ検索キーです。 ドット表記を含めることができます。 使用可能な値は次のとおりです。

  • asset_id （プレフィックスなし）

  • name

  • folder_path

  • type

  • file_name

  • description

  • comment

  • user_data

  • sku

  • modified_at

  • modified_by

  • created_at （modified_at と同じ（記載日：2014 年 7 月 25 日金 22:13:45 GMT-0500 （CDT））

  • created_by

許可される演算子

operator では、値の比較方法と以下を定義します。

  • Equals
  • NotEquals
  • Contains
  • NotContains
  • StartsWith
  • EndsWith

comparison_value は検索する用語です。

例 section-53a12b9c023e4e629eddf5719c955ad4

このコードサンプルでは、次のメタデータ条件で検索を実行します。

  • フィ name ルドに 1000801 が含まれています。

  • dc.rights フィールドは Per Jessen Schmidt と等しくなります。

リクエスト

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.scene7.com/IpsApi/xsd"
xmlns:ns="http://www.scene7.com/IpsApi/xsd/2010-01-31">
   <soapenv:Header>
      <xsd:authHeader>
          <xsd:user>user@adobe.com</xsd:user>
          <xsd:password>topSecret</xsd:password>
      </xsd:authHeader>
   </soapenv:Header>
   <soapenv:Body>
      <ns:searchAssetsByMetadataParam>
         <ns:companyHandle>c|656</ns:companyHandle>
         <ns:metadataConditionArray>
            <ns:items>
               <ns:fieldHandle>name</ns:fieldHandle>
               <ns:op>Contains</ns:op>
               <ns:value>1000801</ns:value>
            </ns:items>
            <ns:items>
               <ns:fieldHandle>dc.rights</ns:fieldHandle>
               <ns:op>Equals</ns:op>
               <ns:value>Per Jessen Schmidt</ns:value>
            </ns:items>
         </ns:metadataConditionArray>
         <ns:responseMetadataArray>
            <ns:items>dc.subject</ns:items>
            <ns:items>xmp.CreatorTool</ns:items>
         </ns:responseMetadataArray>
      </ns:searchAssetsByMetadataParam>
   </soapenv:Body>
</soapenv:Envelope>

応答

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <searchAssetsByMetadataReturn xmlns="http://www.scene7.com/IpsApi/xsd/2010-01-31">
         <totalRows>1</totalRows>
         <assetSummaryArray>
            <items>
               <assetHandle>a|885289</assetHandle>
               <type>Image</type>
               <name>test9-1000801</name>
               <folder>Extroscope/Test subfolders/</folder>
               <filename>test9-1000801.jpg</filename>
               <created>2009-11-19T07:21:24.252-08:00</created>
               <createUser>pschmidt@adobe.com</createUser>
               <lastModified>2009-11-19T07:21:25.487-08:00</lastModified>
               <lastModifyUser>pschmidt@adobe.com</lastModifyUser>
               <metadataArray>
                  <items>
                     <name>dc.subject</name>
                     <value>[San Fransico, USA</value>
                  </items>
                  <items>
                     <name>xmp.CreatorTool</name>
                     <value>Ver.1.0</value>
                  </items>
               </metadataArray>
            </items>
         </assetSummaryArray>
      </searchAssetsByMetadataReturn>
   </soapenv:Body>
</soapenv:Envelope>
recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681