We’ve migrated our documentation to a new site, which means some URLs have changed.
Audience

Content Widget: templateオブジェクト

Contentウィジェットテンプレートオブジェクト(または単に「テンプレートオブジェクト」)は ウィジェットコンテント(JSON)からHTMLへの変換を記述したものです。
変換は simple templating language を使用して定型化されます。テンプレートを編集するための 基本的なユーザインターフェース はありますが、 直接 API を使うことも可能です。 

テンプレートオブジェクトには以下のフィールドがあります。テンプレートオブジェクトを作成する際にフィールドを指定しなかった場合、その値は null になります。更新で指定されていないフィールドの値は変更されません。サーバからコンフィグレーションを(作成, 参照, 更新のレスポンスとして)読みだした際に、存在しないフィールドの値はその値がnullであることを意味します。

名前

タイプ

説明

id

String

テンプレートID

siteGroupId

String

このテンプレートが属するサイトグループ

description

String

テンプレートオブジェクトの簡易説明

managed

Boolean

テンプレートオブジェクトが管理権限が必要な特別な設定を含む場合は True

settings

Object

このテンプレートに関する詳細設定(下記で説明)

lastUpdatedBy

String

テンプレートの最新更新者のメールアドレス

lastUpdatedAt

String (Date)

テンプレートの最終更新日時 (ISO 8601 形式).

history

Array of Object

以前の設定のリスト

Notes

  1. オブジェクト作成時に lastUpdatedBy や lastUpdatedAt が指定されてもその値は使用されません。しかし更新時にこれが指定された場合、更新を成功させるためには現在の値と一致しなければなりません。これは optimistic concurrency control とお考えください。しかしながら、同時に同じオブジェクトに対して複数の競合する更新がある場合、現在のところ保証することはできません。

  2. history フィールドは個々のオブジェクトが参照または更新された時にのみそのレスポンスに含まれます。過去50件までの履歴で、直近のものから順に表示されます。これらの履歴は id, siteGroupId, history のフィールドを含まない以外はテンプレートオブジェクトそのものです。 テンプレートオブジェクトが作成、更新された時にのみ、 history フィールドは無視されます。

テンプレートの settings オブジェクトには以下のフィールドがあります。このレベルでは更新が指定されていない場合、 null として扱われます。したがってフィールドの値は変更される可能性があります。

名前

タイプ

必須

説明

type

String

Yes

テンプレートタイプ。現在は常に "basic".

head

String

No

ウィジェットにレンダリングされる iframe のヘッダに追加される宣言

html

String

Yes

HTMLの拡張機能である simple templating language を使用した実際のテンプレート


Last updated: