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

Content Widget: configurationオブジェクト

content widget content configuration オブジェクト (または簡潔には "content コンフィグレーション") はいくつかのウィジェットの content を指定します(例えばどんなレコメンドをするのかといった内容)。content コンフィグレーションを作成、管理するために Cxense Content 管理画面 がありますが、Cxense Content API を直接使用することも可能です。いくつかのウィジェットが同じ content コンフィグレーションを使うかもしれないことにご注意ください。あるいはウィジェットで使われない content コンフィグレーションかもしれません。

Content コンフィグレーションには以下のフィールドがあります。コンフィグレーションを作成した際にフィールドを指定しなかった場合、その値は null になります。更新でフィールドを指定しなかった場合、そのフィールドの値は変更されません。(create, read, update のレスポンスを)サーバーから読み取った際にフィールドがない場合、その値が null であることを意味します。

名前

タイプ

説明

id

String

コンフィグレーションID。

siteGroupId

String

このコンフィグレーションのサイトグループID。存在しない場合、コンフィグレーションはグローバルとなり、他のコンフィグレーションにインポートすることしかできず、ウィジェットで直接使うことができません。

description

String

コンフィグレーションの簡易説明。

settings

Object

Content セッティングオブジェクトにこのコンフィグレーションの詳細設定が含まれています。

lastUpdatedBy

String

コンフィグレーションを直近アップデートした人のEメールアドレス。

lastUpdatedAt

String (Date)

コンフィグレーションを最後に更新した時間(ISO 8601 timestamp)。

annotations

Array of Object

キーと値の組み合わせの配列。カスタムメタデータを格納するために使用されます。

history

Array of Object

以前の設定のリスト。

Annotations

キーと値の組み合わせのリスト。リストの最大サイズは1000です。

名前

タイプ

説明

key

String

ユニークで256文字以内である必要があります。文字から始まる、ASCII文字でa-z、A-Z、0-9または_(アンダースコア)のみを含めることができます。

value

String

256文字以内。

Notes

  1. オブジェクトを作成した時に lastUpdatedBy や lastUpdatedAt を指定しても影響ありません。しかしこれを update で指定した場合、update が成功するためには現在の値と一致しなければなりません。これは optimistic concurrency control の形式を取っています。しかし、同時に同じオブジェクトに対して複数の update の競合がある場合、現状の保証はできません。

  2. history フィールドがここのコンフィグレーションが read または update された時 あるいは 変更が 2013年12月8日(このフィールドが追加された時)以降にこのオブジェクトが作成されたレスポンスの場合にのみ含まれます。時系列の逆順に、過去50件のコンフィグレーションが含まれます。これらのリビジョンは configuration オブジェクトそのものであり、フィールドID、サイトグループID、 history は含まれません。configuration が 作成、更新された時に historyフィールドは無視されます。

Content settings object

こちらは別のページに移動しました。


Last updated: