汎用フィード ドロップボックスを使用すると、環境ごとに複数のフィードタイプを 1 つのドロップボックスにアップロードできます。このガイドでは、汎用ドロップボックスの使用方法について説明し、使用する各フィードに適したガイドへのリンクを提供します。
(ドキュメントのフィードのエクスポート(エンドツーエンド)またはフィード(スターター)のセクションをご覧ください)汎用ドロップボックスは、2 つの別々のアップロードに依存します。
- 記述子ファイル: アップロードするフィードタイプを記述する
- フィード ファイル: 実際のフィードのコンテンツ
記述子フィールドの構造化
記述子ファイルはアップロードして、アップロードするフィードタイプをシステムに伝えます。これにより、フィードを正しく検証して処理できます。記述子ファイルはフィードのコンテンツの前にアップロードし、次の命名要件を満たす必要があります。
- ファイル拡張子 .filesetdesc.json を使用する
- 各記述子ファイル名は一意である必要があります。また、アップロード間で再利用することはできません。ファイル名に世代のタイムスタンプを含めることをおすすめします。
- 例: Offers_1524606581.filesetdesc.json
message FilesetDescriptor { // The timestamp at which this feed was generated, in Unix time format // (seconds since the epoch). (required) int64 generation_timestamp = 1; // Identifies the name of this feed. (required) string name = 2; // Paths (relative to the dropbox root) specifying data files included in this // feed. (required) repeated string data_file = 3; }
name
フィールドには次のような値を指定できます。
2 つのシャードを含むクーポン フィード用の JSON 記述子ファイルの例を以下に示します。
{ "generation_timestamp": 1524606581, "name": "promote.offer", "data_file": [ "offers_1524606581_1.json", "offers_1524606581_2.json" ] }
フィード コンテンツの構造化
記述子ファイルをアップロードした後、記述子ファイルで指定したフィード設定ファイルに対応するフィードのデータ型に対応するすべてのフィード ファイルをアップロードします。ファイル名とパスの場所(ドロップボックスの相対パス)は、data_file
フィールドの内容と完全に一致している必要があります。見つからないファイル、不適切な名前が付けられたファイル、別の場所にアップロードされたファイルは、フィード全体が処理されません。
フィードのデータファイルの内容は、記述子ファイルで指定したフィードの関連仕様に準拠している必要があります。
各フィード ファイルのファイル名は一意である必要があります。また、アップロード間で再利用することはできません。ファイル名には、世代のタイムスタンプとシャード番号(増分 ID)を含めることをおすすめします。
- 例: Offers_1524606581_1.json
フィードのファイルサイズとアップロード間隔
- フィード ファイルのサイズを 200 MB 未満にします(圧縮後)。
- ほとんどの統合では、シャードを 1 つ使用するだけで済みます。シャードはできるだけ少なくする必要があります。フィードごとにシャードは最大 1,000 個です。
- 1 つのシャードで送信する個々のレコードを、今後のフィードで同じシャード番号で送信する必要はありません。
- パフォーマンスを向上させるには、データをシャード間で均等に分割し、すべてのシャード ファイルのサイズを類似させます。
- 必要に応じて、gzip を使用してフィードを圧縮します。ただし、この操作は個々のフィード シャードごとに行ってください。
トラブルシューティングとデバッグ
ファイル(記述子とフィード ファイル)をアップロードしたら、パートナー ポータルのフィード履歴ダッシュボード(ドキュメント)に移動して([履歴] > [フィード] に移動)、フィードの取り込みの進行状況を確認します。
[フィード名] 列の記述子ファイルに入力した name
を探して、フィードを見つけます。
フィードが取り込まれると(ステータスが Success
または Fail
)、その行をクリックするとエラーと警告の詳細が表示されます。