ジャンプ先

• リクエスト
• レスポンス

指定した推奨のアイテムの取得

get

/resources/v1/aggregates/{siteName}/engage/recommendation/{recommendationName}/items

リソース・エンドポイントは、指定されたサイト名に属する指定された推奨アセットに対する集約された結果を返します。

重要な注意: これは、コレクション・リソースです。指定した推奨名の推奨されたアセットはすべて、レスポンスのアイテム配列で提供されます。各結果も集約されたアセットです。そのため、すべての集約アセット問合せパラメータ(assetDepth、expand、fields)はこのリソースにも適用されます。これらの集約アセット問合せパラメータは、アイテム配列の各結果に適用されます。集約アセット問合せパラメータの詳細は、「アセット・リソース・エンドポイント」を参照してください。

リクエスト

パス・パラメータ

• recommendationName: string
  推奨項目の名前
• siteName: string
  サイトの名前

問合せパラメータ

• assetDepth: number
  このパラメータの詳細は、「アセット・リソース・エンドポイント」の'assetDepth'問合せパラメータを参照してください。アイテム配列の各結果に適用されます。
• expand: string
  assetTypeのカンマ区切りのリストを受け入れます。このパラメータの詳細は、「アセット・リソース・エンドポイント」の'expand'問合せパラメータを参照してください。アイテム配列の各結果に適用されます。
• fields: string
  このパラメータの詳細は、「アセット・リソース・エンドポイント」の'fields'問合せパラメータを参照してください。アイテム配列の各結果に適用されます。
• limit: number
  返されるアイテムの合計数を指定します。
• links: string
  リンク名のカンマ区切りのリストを受け入れます。デフォルトでは、このパラメータですべてのリンク(next、prev、first、last、schema、selfおよびcanonicalリソース)が返されます。
• offset: number
  結果を返す開始地点となる開始索引を指定します。
• profileName: string
  推奨の評価基準のSitesVisitorServiceプロファイル名
• segments: string
  推奨の評価基準となるカンマ区切りのセグメント名を受け入れます。
• totalResults: boolean
  ブール値を受け入れます。trueに設定すると、レスポンスに結果総数フィールドが表示されます。デフォルトはfalseです。
• visitorid: number
  推奨の評価基準の訪問者ID

先頭に戻る

レスポンス

サポートされるメディア・タイプ

• application/json

200レスポンス

集約された形式の推奨アセット結果

先頭に戻る