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

createMetadataField createmetadatafield

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

Criado para:

  • Desenvolvedor
  • Administrador

Ele permite que os administradores criem campos de metadados para coordenar com sistemas de gerenciamento de conteúdo ou operações de modelo. Exemplos de campos de metadados criados incluem palavras-chave, informações sobre o autor da imagem ou informações sobre o detentor dos direitos autorais.

Sintaxe

Tipos de usuário autorizados section-2f61d79f8cac4692bfa53b95035ddd89

  • IpsAdmin

Parâmetros section-f8260bc8dd0a4570bc7f714f81ab975f

Entrada (createMetadataFieldParam)

Nome do parâmetro
Tipo
Obrigatório
Descrição
companyName
xsd:string
Sim
O nome da empresa à qual o campo de metadados pertence.
assetType
xsd:string
Sim
Tipo de ativo.
nome
xsd:string
Sim
Nome do campo de metadados que você está criando.
fieldType
xsd:string
Sim

Tipo de campo de metadados.

A constante de tipos de campo de metadados define os tipos disponíveis.

valorPadrão
xsd:string
Não

O valor padrão do campo de metadados a ser criado (por exemplo, Cena 7).

Os valores padrão não são compatíveis com tipos de campo de tag e devem ser omitidos. Se um padrão não vazio for especificado para um tipo de campo de tag, uma falha será retornada.

isHidden
xsd:booleano
Não
Ocultar ou expor metadados específicos do sistema IPS.
isEnforced
xsd:booleano
Não

Um sinalizador booleano que indica se o campo de metadados é aplicado (validado) quando o valor é definido.

Se definido como verdadeiro, uma falha será gerada se um valor ilegal for definido em setAssetMetadata / batchSetAssetMetadata.

initialTagValue
xsd:string
Não
Ela permite criar um conjunto de valores específicos compartilhados para o qual as tags selecionadas podem apontar.

Saída (createMetadataFieldReturn)

Nome
Tipo
Obrigatório
Descrição
fieldHandle
xsd:string
Sim
O identificador para o novo campo de metadados.

Exemplos section-ba66be30f36b4aeba1bc721b0b92fdfc

Esta amostra de código cria um campo de metadados do tipo string chamado createMetadataField. A resposta retorna o identificador para o novo campo de metadados.

Solicitação

<createMetadataFieldParam xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
   <companyHandle>c|21</companyHandle>
   <assetType>Image</assetType>
   <name>createMetadataField</name>
   <fieldType>String</fieldType>
   <initialTagValue>Fall</initialTagValue>
   <defaultValue>Default</defaultValue>
</createMetadataFieldParam>

Resposta

<createMetadataFieldReturn xmlns="http://www.scene7.com/IpsApi/xsd/2008-01-15">
   <fieldHandle>m|21|IMAGE|createMetadataField</fieldHandle>
</createMetadataFieldReturn>
recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681