Contentウィジェットオブジェクト（または単に「ウィジェットオブジェクト」）は実際のウィジェットを説明しています。そのIDはウィジェットIDです。
管理ウィジェットオブジェクトを作成するための基本的なユーザーインターフェースはありますが、APIを直接しようすることもできます。
Contentコンフィグレーションには下記のフィールドがあります。コンフィグレーションが作成された際に指定されていないフィールドの値はnullとなります更新で指定されていないフィールドの値は変更されません。サーバからコンフィグレーションを読みだした際（作成, 参照, 更新の応答として）に存在しないフィールドの値はその値がnullであることを意味します。
|
名称 |
タイプ |
説明 |
|---|---|---|
|
|
String |
コンフィグレーションの識別子 |
|
|
String |
このコンフィグレーションが属するサイトグループ |
|
|
String |
コンフィグレーションについての短い説明 |
|
|
Boolean |
コンフィグレーションがadmin権限を必要とする特別の設定を含んでいる場合True |
|
enabled |
Boolean |
falseの場合、このウィジェットにはインプレッションが配信されません。
|
|
|
Object |
このコンフィグレーションに対して定義された詳細な設定（Content セッティングオブジェクト） |
|
|
String |
最終更新者のメールアドレス |
|
|
String (Date) |
最終更新日時 (ISO 8601 形式). |
|
|
Array of Object |
キーと値の組み合わせオブジェクトの配列。カスタムメタデータの格納に使用されます。 |
|
history |
Array of Object |
以前の設定のリスト |
Annotations
キーと値の組み合わせのリスト。リストの最大サイズは1000。
|
名称 |
タイプ |
説明 |
|---|---|---|
|
key |
String |
|
|
value |
String |
|
Notes
-
オブジェクト作成時に
lastUpdatedByやlastUpdatedAtが指定されてもその値は使用されません。しかしこれらが更新の際に指定された場合には更新前の値と一致しなければなりません。これは optimistic concurrency control とお考えください。しかしながら、同時に同じオブジェクトに対して複数の競合する更新がある場合、現在のところ保証することはできません。 -
historyフィールドが応答に含まれるのは、個々のコンフィグレーションが参照あるいは更新された時で、かつオブジェクトに対する変更が2013/12/08以降に行われたもののみです。このフィールドに含まれるのは50件までの履歴で、直近のものから順に表示されます。これらの履歴はid,siteGroupId,historyフィールドが含まれないことを除いてコンフィグレーションオブジェクトそのものです。Contentコンフィグレーションの作成・更新時にhistoryフィールドが指定されても無視されます。 -
ウィジェットを削除するには特別な権限が必要となりますが、enabled を false に設定することで、すぐに古いウィジェットを取得することができます。特にコンテンツのアプリケーションでは表示されなくなります。 無効にしたウィジェットはenabled を true に設定することで再度有効にできます。
ウィジェットセッティングオブジェクトは次のフィールドがあります。このレベルではフィールドが更新で指定されていない場合、フィールドは null として扱われます。したがってフィールドの値が変更される可能性があります。
|
名称 |
タイプ |
必須 |
説明 |
|---|---|---|---|
|
|
String |
Yes |
ウィジェットタイプ。現在は常に "basic" |
|
|
Integer |
No (default value) |
このウィジェットで取得する（レコメンデーションの）アイテム数（最大 50）。 |
|
|
String |
Yes |
このウィジェットが動作するサイトID |
|
|
String |
No |
このウィジェットのContent セッティングオブジェクト |
|
|
String |
No |
このウィジェットの template object |
|
styleId |
String |
No |
このウィジェットの style object |
|
timeout |
Integer |
No |
このリクエストを処理するために最大時間制限（ミリ秒単位）を示す値。ネットワーク遅延や待ち行列の時間はカウントされません。レスポンスに時間のかかるものがある場合に使用する必要があります。基本的にはこれはセットせずとも、最適なタイムアウトが自動的に処理されます。値は 0〜10000の範囲内にしなければなりません。 |
Notes
-
insertWidget をコールして renderTemplateUrl: 'auto' と指定した場合、templateId と styleId のフィールドは（マッピングされた）レンダーテンプレートの代わりに使われます。
Contentセッティングオブジェクト
セッティングオブジェクトについてはこちらのページをご参照ください。