Show TOC

機能文書カスタムタグ ナビゲーション構造内でこの文書を検索

 

テーマの動的機能を登録するには、Web オークション管理で管理者が登録し、標準テーマ HTML に混在するカスタムタグを使用します。カスタムタグは特殊なプレースホルダとして機能し、テーマパーサでテーマが処理される際にコンテンツのどの部分をバックエンドからリトリーブされた値に置換するかをシステムに指示します。

統合

カスタムタグは標準テーマ HTML に混在することができます。

前提条件

テーマを登録してあります。

機能

現在、[Web オークション: eBay® を介した販売]のタグでは置換タイプの機能がサポートされており、タグが宣言するプロパティおよびプロパティ値に応じて、タグの内容が別の値に置換されます。

オークション登録時にテーマが処理されるときは、テーマ内のすべてのカスタムタグのパースや構造の追加が試行されます。タグの検出が行われ、タグに割り当てられたアクションや動作に従って処理が行われます。また、タグのプロパティのパースも行われ、結果値は対応するバックエンド情報の識別およびリトリーブを実行するためのキーとして使用されます。テーマのコンテキストによっては、タグのプロパティでアプリケーション動作に影響を及ぼすこともできます。

タグは、テーマの最後に達するまで 1 つずつ処理されます。処理が完了すると、出力が生成され、オークションでの使用が可能になります。

カスタムタグの構文は、xml-namespace 擬似名称、タグエレメント名、隣接する名称/値のペアのプロパティ、および名前空間値 sap という標準書式に従います。

例 例

<custom_tag>::=<xml-namespace>:<tagname>[<property_name>="<value>"]

sap 名前空間で始まるタグはすべてカスタムタグとして認識されます。

例の終了

一般的なタグ要件は以下のとおりです。

  • テーマ内のタグのそれぞれに一意の ID が必要です。

  • タグは、ブロックレベルと非ブロックの HTML エレメント (div、p、span など) 間のコンテンツを置換することができます。

  • タグは、イメージタグの URL など、HTML プロパティ値の代替にすることができます。

    これは、各 HTML エレメントに対して 1 回実行することができます。言い換えると、複数の HTML プロパティ値を複数のカスタムタグで置換することはできません。

  • タグは HTML 内で使用する必要があります。CSS スタイルブロックなどの非 HTML エレメントで使用することはできません。

[Web オークション: eBay® を介した販売]でタグ名 var を使用することができます。

var (変数の短縮形) はプレースホルダタグであり、バックエンドからテキスト値をリトリーブするために使用されます。全体タグは、最終出力時に対応するテキストに置換されます。単一タグであり、タグ終了は <sap:var.../> です。

var タグには以下のプロパティがあります。

  • id

    id プロパティは、1 つのテーマ内で使用されるカスタムタグごとに一意であることが必要です。

  • type

    type プロパティはタグの置換値をリトリーブするために使用されます。type プロパティ値がオークション対象製品の固有製品 id とクロスリファレンスされます。

  • previewValue

    このプロパティは、通常バックエンド情報によって入力されるコンテンツの代替に使用されます。テーマを登録する際には固有の製品が指定されていないため、代わりに previewValue プロパティが使用されます。

    値の書式は <typename>$<index> です。有効な typename は以下の 3 つです。

    • productDescription

    • imageURL

    • productURL

    index は、オークションでの第 1 の製品や第 2 の製品など、オークションでの製品を示します。

  • clientText

    このプロパティはオークションにテーマを適用する場合に使用されます。アプリケーションインタフェースにラベルと入力項目が作成されます。ラベルと入力項目の値を使用して、type プロパティの代替値が置換されます。

例

以下の例では、テーマタグにシステムによって読み込まれ、次の方法で処理される多様なセクションが設定されています。

  • タグエレメント名、この場合は var が認識されます。

  • タグプロパティが処理されます。

  • type プロパティで示されるバックエンドからの値にタグ全体が置換されます。その理由は、タグエレメント名が var であるためです。

    例 例

    • ローソース

      <img id='productimage' src='sap:var id='imageURI' type='imageURL$1'

      clientText='Enter the product Image URL'

      previewValue='http://www.sap.com/images/blank.gif'/>'/>

    • 生成される出力

      <img id='productimage' src='http://someurl.com/directoryname/imagename/.jpg'/>

    例の終了