DocumentaçãoAPI do sistema de produção de imagens Dynamic Media

searchAssetsByMetadata searchassetsbymetadata

Last update: Sat Jul 20 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Tópicos:

Criado para:

  • undefined
  • undefined

Pesquisa no repositório de índice de metadados os termos de pesquisa fornecidos. Retorna dados de ativos como o método searchAssets.

Embora searchAssetsByMetadata permita a pesquisa em Campos de Metadados Definidos pelo Usuário, esses campos não serão retornados se forem especificados em responseMetadataArray. Para ilustrar esse ponto, o seguinte exemplo de código:

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

retorna um valor nulo:

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

Para contornar esse problema, você pode usar o fieldHandles dos ativos retornados da pesquisa para executar o getAssets (consulte também getAssets). Esse método obtém os valores dos Campos definidos pelo usuário para os ativos em questão. Use o exemplo de sintaxe a seguir para pesquisar em Campos de Metadados Definidos pelo Usuário:

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

Tipos de usuário autorizados section-9f85dd55ab574104b5fdc0f95aa0a0e2

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

Parâmetros section-5f1edb9c5b914160ab361f4364b8aa8d

Entrada (searchAssetsByMetadataParam)

Nome
Tipo
Obrigatório
Descrição
companyHandle
xsd:string
Sim
O identificador da empresa.
Filtro
tipo:SearchFilter
Não

Filtros que ajudam a definir critérios de pesquisa.

Consulte SearchFilter.

metadataConditionArray
type:MetadataConditionArray
Não
Condições que definem os critérios de pesquisa. Consulte a seção abaixo para obter informações adicionais.
responseMetadataArray
tipo:StringArray
Não
Campos adicionais que você deseja preencher na resposta do resumo do ativo. Os campos devem ser especificados no formato normalizado.
recordsPerPage
xsd:int
Não
O número de ativos retornados pela resposta. O valor padrão é 1000.
resultsPage
xsd:int
Não
Especifica a página de resultados a ser retornada, com base no tamanho de página recordsPerPage.
sortBy
xsd:string
Não
Classifique por campo de ativo selecionado.
sortDirection
xsd:string
Não
Escolha da direção da classificação. Crescente é o padrão.

Saída (searchAssetsByMetadataReturn)

Nome
Tipo
Obrigatório
Descrição
totalRows
xsd:int
Não
Número de correspondências.
assetArray
types:AssetArray
Não
Matriz de ativos retornados pela pesquisa.

metadataConditionArray Detalhes section-1af4a4a22f82451eabdf6dfe13d9f27d

Estrutura do Item

A estrutura metadataConditionArray é a seguinte:

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

Valores

field_handle é a chave de pesquisa de metadados. Ele pode conter a notação de pontos. Os valores possíveis incluem:

  • asset_id (sem prefixo)

  • name

  • folder_path

  • type

  • file_name

  • description

  • comment

  • user_data

  • sku

  • modified_at

  • modified_by

  • created_at (igual a modified_at (Data no formulário: sexta-feira, 25 de julho de 2014 22:13:45 GMT-0500 (CDT))

  • created_by

Operadores permitidos

O operator define como comparar o valor e inclui:

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

O comparison_value é o termo a ser pesquisado.

Exemplos section-53a12b9c023e4e629eddf5719c955ad4

Essa amostra de código realiza uma pesquisa com os seguintes critérios de metadados:

  • O campo name contém 1000801.

  • O campo dc.rights é igual a Per Jessen Schmidt.

Solicitação

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

Resposta

<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