コンテンツ・フィード
本書はフラット・ファイル・カタログ・フィードの資料と合わせてご利用ください。
本書では、Engageで使用するコンテンツをフィードを利用してリッチレリバンスに提供する方法について説明します。コンテンツ・フィードは3つのファイルで構成され、1日に最低一回送信される標準の圧縮カタログ・フィードに格納され送られます。本データは毎日送信する必要はありません。コンテンツに変更があった場合のみ送ってください。
フィードを送信する方法は2つあります。単独で送るか、商品フィードと合わせて圧縮して送ってください。
フィード・ファイル
ファイル |
詳細 |
命名規則 |
---|---|---|
コンテンツ・フィード |
クライアントのサイト上でリッチレリバンスが管理するすべてのコンテンツの詳細リストです。 |
content_full_sitename_YYYY_MM_DD.txt |
コンテンツ・カテゴリー・フィード |
コンテンツを関連するカテゴリーへマッピングするためのものです。一つのコンテンツを複数のカテゴリーにマッピングできます。 |
content_in_category_sitename_YYYY_MM_DD.txt |
コンテンツ属性フィード |
それぞれのコンテンツの属性です。一つのコンテンツには少なくとも一つの属性が必要です。属性がないと表示されません。 |
content_attribute_sitename_YYYY_MM_DD.txt |
注記: これらのファイルはフラット・ファイル・カタログ・フィードにzip圧縮してリッチレリバンスに送るか、それぞれ単独で送ってください。どちらの方法を採用するかはリッチレリバンスの担当者にご相談ください。
ファイルの仕様
各ファイルの仕様は以下のとおりです。
指定がない限り、ファイルで使用する区切り文字はパイプ「|」にしてください。なんらかの理由によりパイプ区切りを使用できない場合は、リッチレリバンスの担当者までご相談ください。
コンテンツ・フィード
ファイル名: content_full_sitename_YYYY_MM_DD.txt(必須)
注記: 商品IDと同じIDを使用することはできません。商品とコンテンツにはそれぞれ固有のIDを使用してください。
名称 |
タイプ |
必須/ オプション |
定義 |
---|---|---|---|
id |
ASCII |
必須 |
コンテンツ固有のIDです。それぞれのコンテンツIDは終始一貫している必要があります。 注記: コンテンツIDにスラッシュ「/」は使用できません。 |
name |
テキスト |
必須 |
コンテンツの名称です。この名称はサイト上のレコメンデーション及びダッシュボードに表示されます。名前に使用できる文字数は半角で最大255文字までです。 |
start_date |
日付 |
オプション |
このコンテンツが表示可能になる日付です。指定されていない場合は常時表示可能とみなされます。形式はYYYY-MM-DDです。 |
end_date |
日付 |
オプション |
このコンテンツの表示が終了する日付です。指定されていない場合は無期限で表示されます。形式はYYYY-MM-DDです。 |
rating |
整数 |
オプション |
このコンテンツの評価です(クライアントが指定)。通常は顧客評価の平均を集計した値を使用します。あまり使用されることはありません。 |
tags |
テキスト |
オプション |
コンテンツを説明するタグの一覧です(例: 赤ちゃん用品、ベビーカー、Graco)。既定の区切り文字はピリオド「.」です。 注記: 一つのタグの名称に使用できる文字数は最大100文字です。100文字以上を使用した場合は、101文字以降は切り捨てられます。この結果タグの総数が影響を受けることはありません。理論上、タグの数に技術的制約はありませんが、管理上の理由から一つのコンテンツに使用するタグは20個までとすることをお勧めします。 |
例
id|name|start_date|end_date|rating|tags
100|Hero Shirts Sale Banner|2017-06-07|2017-07-07|5|shirts.sale.hero
200|Footer Handbag Winter Sale Banner|2017-11-01|2018-02-28||handbags.sale.footer
コンテンツ・カテゴリー・フィード
ファイル名: content_in_category_sitename_YYYY_MM_DD.txt
名称 |
タイプ |
必須/ オプション |
定義 |
---|---|---|---|
category_id |
ASCII |
必須 |
コンテンツが属するカテゴリーのIDです。カテゴリー・ファイルで定義されます。 |
content_id |
ASCII |
必須 |
コンテンツ・ファイルで定義されているコンテンツのIDです。 注記: コンテンツIDにスラッシュ「/」は使用できません。 |
注記: Recommendをお使いの場合は、コンテンツに使用されているカテゴリーIDが商品に割り当てられているカテゴリーIDと一致していることを確注記認してください。
例
category_id|content_id
10|100
20|200
コンテンツ属性フィード
ファイル名: content_attribute_sitename_YYYY_MM_DD.txt(必須)
属性値(及び多値属性)は、列ベースまたは行ベースのどちらかの形式のリストです。ただし、ファイル内では必ずどちらかの形式に統一する必要があります。同じファイル内で異なる形式を取り混ぜて使用することができません。システムはヘッダーから自動的に形式を認識します。
リストの区切り文字に、属性値やファイルの他の場所では使用されていない文字を使用する必要があります。ピリオドがある値はリストとして処理されます(これは既定の動作です)。ピリオドはリスト内の各値の区切りとして使用されます。しかしながら、フィード・プロファイルを作成する際に区切り文字をカスタム化することができます。
コンテンツの属性では、コンテンツの表示に必要な変数を指定します。イメージURLやランディング・ページのURLは属性として送信する必要があります。
一つのコンテンツには最低一つの属性が必要です。コンテンツはホワイトリスト化(レコメンド可能)されていない限り表示されないため、コンテンツを表示するためのホワイトリスト化に必要なルールの作成に、属性が使用されます。コンテンツに属性が全くない場合は、システムに保存されません。
列(カラム)ベースの形式
名称 |
タイプ |
必須/ オプション |
定義 |
---|---|---|---|
content_id |
ASCII |
必須 |
コンテンツ・ファイルで定義されているコンテンツのIDです。 注記: コンテンツIDにスラッシュ「/」は使用できません。 |
attribute.[attribute key 1] |
テキスト |
必須 |
1番目の固有の属性キーです。 |
attribute.[attribute key 2] |
テキスト |
必須 |
2番目の固有の属性キーです。 |
... |
|
|
|
attribute.[attribute key N] |
テキスト |
必須 |
N番目の固有の属性キーです。 |
例
列ベースの形式のコンテンツ属性フィードの基本的な例です。
content_id|attribute.size|attribute.image_url|attribute.link_url
100|medium|http://mysite.com/images/100.jpg|http://mysite.com/content100
101|large|http://mysite.com/images/100.jpg|http://mysite.com/content101
以下では、複数の属性を指定しまています(既定では値の区切り文字の既定値はピリオドですがフィード・プロファイル作成時に変更できます)。
content_id|attribute.size|attribute.color
100|small.large|red.green
200|medium.large|red.blue.green
行ベースの形式
名称 |
タイプ |
必須/ オプション |
定義 |
---|---|---|---|
content_id |
ASCII |
必須 |
コンテンツ・ファイルで定義されているコンテンツのIDです。 注記: コンテンツIDにスラッシュ「/」は使用できません。 |
attr_name |
テキスト |
必須 |
固有の属性キーです。 |
attr_value |
テキスト |
必須 |
属性名です。 |
例
行ベースの形式のコンテンツ属性フィードの基本的な例です:
content_id|attr_name|attr_value
100|size|medium
200|size|large
100|image_url|http://mysite.com/images/100.jpg
200|image_url|http://mysite.com/images/200.jpg
100|link_url|http://mysite.com/content100
200|link_url|http://mysite.com/content200
以下では、それぞれの行に複数の属性を指定しています。
content_id|attr_name|attr_value
100|color|red
100|color|blue
100|color|green
100|size|small
100|size|medium
100|size|large
以下では、一つの行に複数の属性を指定しています(既定では値の区切り文字の既定値はピリオドですがフィード・プロファイル作成時に変更できます)。
content_id|attr_name|attr_value
100|color|red.blue.green
100|size|s.m.l