機械翻訳について

移動先

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

apiNameによる推奨事項から結果を取得します。

post

/content/management/api/v1.1/personalization/recommendationResults/{apiName}

apiNameによって指定された推奨事項の結果を取得します。 このエンドポイントは、推奨で定義されているオーディエンス属性の値を指定することで、推奨のテストに使用できます。 次の制限により、オーディエンスの属性を問合せまたは本文で指定できます:

エンド・ポイントでは、attribute.\.\ = \のようにキーワードattributeが付加される名前と値のペアとしてオーディエンス属性を受け入れます。
セッションまたはシステムの状態をシミュレートするためにリクエストの本文にのみ提供できるため、sessionおよびsystemのカテゴリを問合せに含めることはできません。

例: ? attribute.custom.my Attribute1=value1& attribute.custom.my Attribute2=value2



複数値オーディエンス属性が許可される場合は、名前と値のペアを繰り返すことで、これらの属性を問合せで指定する必要があります。

例: ? attribute.custom.my MultiValue=value1& attribute.custom.my MultiValue=value2 etc.

問合せで指定されたオーディエンス属性は、本文で指定されている場合は同じオーディエンス属性をオーバーライドします。

リクエスト

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

• application/json

パス・パラメータ

• apiName: string
  推奨のAPI名。 特殊文字が存在する場合はエンコードする必要があります。

問合せパラメータ

• attribute.category.attributeName(optional): array
  コレクション形式: multi

  オーディエンス属性のリスト。 特殊文字が存在する場合は、encoded.Theオーディエンス属性にキーワードattributeをプレフィクスとして付ける必要があります :
  
  attribute.\.\ = \
  
  例: ? attribute.custom.myAttribute1 =value1& attribute.custom.myAttribute2 =value2
  
  
  
  複数値オーディエンス属性が許可される場合は、名前と値のペアを繰り返すことで、これらの属性を問合せで指定する必要があります。
  
  例: ?attribute.custom.myMultiValue=value1&attribute.custom.my MultiValue=value2など。
  
  

  • [0]: string

  {
      "name":"attribute.category.attributeName",
      "in":"query",
      "description":"List of audience attributes.  Any special characters present must be encoded.The audience attributes should be prefixed with the keyword <b>attribute</b>: <br/><br/><b><i>attribute.\\<category\\>.\\<audienceAttribute\\>=\\<value\\></i></b><br/><br/><b>Example:</b>  <i>?attribute.custom.myAttribute1=value1&attribute.custom.myAttribute2=value2</i><br/><br/><br/><br/>Where multivalued audience attributes are allowed, they should be provided in the query by repeating the name value pairs. <br/><br/><b>Example:</b>  <i>?attribute.custom.myMultiValue=value1&attribute.custom.myMultiValue=value2</i> etc.<br/><br/>\n",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"multi"
  }

• channelToken(optional): string
  推奨のテストに使用するチャネル・トークン。 チャネルが指定されていない場合、推奨は現在のリポジトリ内のすべてのアセットに対して実行され、特定のチャネルに対して公開済またはターゲット設定されているアセットのみではありません。
• fields(optional): string
  このパラメータは、結果内の各アイテムの返されるフィールドを制御するために使用します。 このパラメータは、フィールド名または「すべて」のカンマ区切りリストを受け入れます。 これらのフィールドは、結果内の各アイテムに対して返されます。 フィールド名はすべて大文字小文字が区別され、ユーザーは問合せで正しいフィールド名を指定する必要があります。 すべてのユーザー定義フィールド名には、プレフィクス・フィールドを指定し、その後にピリオド(.)を付加する必要があります。 fieldsが「すべて」 (大/小文字を区別しない)として指定されている場合、タイプ間および特定の問合せのタイプの場合、すべての標準フィールドが返され、すべての標準フィールドとユーザー・フィールドが返されます。 このパラメータは問合せではオプションで、結果には標準フィールド名と説明のみが表示されます。 標準フィールドid (type)は、尋ねられたフィールドに関係なく常に返されます。 問合せに指定されたフィールド名が間違っているか無効な場合は、error.Inがブレス・スタイル・クロス・タイプ問合せのコンテキストをスローします。タイプ固有のフィールドは、構文name,{typename1:fields.userdefinedfieldname1, fields.userdefinedfieldname2},{typename2:fields.userdefinedfieldname1}を使用して指定できます。 前述の例では、typename1タイプのすべてのアイテムにフィールドがあります - 名前、userdefinedfieldname1およびuserdefinedfieldname2。typename2タイプのすべてのアイテムにはフィールドが含まれます - 名前、userdefinedfieldname1。 型付きフィールド句で参照されているタイプにクロス・タイプの問合せが解決されない場合、エラーがスローされます。
  fieldsを「メタデータ」またはmetadata.exifとして指定するアセットの既存のメタデータを返すこともできます。 現在、新しくアップロードしたイメージに使用できるのはEXIFメタデータのみです。
  
  例 : これにより、検索結果のアドレスタイプの標準フィールドname、ユーザー・フィールドstateおよびcountryが返されます。
  https://{cecsdomain}/content/management/api/v 1.1 /items?q=type eq "Address"&fields= fields.state, fields.country
  
  例 : これにより、検索結果で使用される特定のタイプのすべての属性が返されます。
  https://{cecsdomain}/content/management/api/v 1.1 /items?q=type eq "Address"&fields=all
  
  例 : これにより、すべてのタイプのすべてのアイテムの検索結果で標準フィールドname、createdByが返されます。
  https://{cecsdomain}/content/management/api/v 1.1 /items?fields=name,createdBy
  
  例 : これにより、検索結果のすべての標準フィールドがすべてのタイプのすべてのアイテムに対して返されます。
  https://{cecsdomain}/content/management/api/v 1.1 /items?fields=all
  
  例 : これにより、すべてのタイプのすべてのアイテムについて検索結果で使用可能なメタデータが返されます。
  https://{cecsdomain}/content/management/api/v 1.1 /items?fields=metadata
  
  例 : これにより、すべてのタイプのすべてのアイテムの検索結果に使用可能なEXIFメタデータが返されます。
  https://{cecsdomain}/content/management/api/v 1.1 /items?fields=metadata.exif

  デフォルト値: name,description
• limit(optional): integer(int32)
  このパラメータは、負でない整数を受け入れ、結果のサイズの制御に使用します。

  デフォルト値: 100
• links(optional): string
  このパラメータは、リンク名のカンマ区切りのリストを受け入れます。 デフォルトでは、このパラメータによって、適用可能なすべてのリンクが指定されます。 可能な値は次のとおりです: self, canonical, describedby
• offset(optional): integer(int32)
  このパラメータは、負でない整数を受け入れ、結果の開始インデックスを制御するために使用します。

  デフォルト値: 0
• q(optional): string
  このパラメータは、フィールド値に一致する問合せ式条件を受け入れます。 問合せ条件は、AND演算子を使用して結合し、カッコでグループ化できます。 問合せ条件の値は、{fieldName} {operator} "{fieldValue}"の形式に従います。 許可されるフィールド名は、repositoryIdのみです。 演算子の使用できる値は、eq (等しい)のみです。
  例:
  https://{cecsdomain}/content/management/api/v1.1/personalization/recommendations?q=(apiName eq "TestRecommendation")
  例 :
  https://{cecsdomain}/content/management/api/v1.1/personalization/recommendations?q=(repositoryId eq "EAQWER42DGKJ10PCNMGAE")
• totalResults(optional): boolean
  このパラメータは、ブール・フラグを受け入れます。 trueとして指定した場合、返される結果には合計結果数が含まれる必要があります。

  デフォルト値: false

ヘッダー・パラメータ

• X-Requested-With: string
  CSRF攻撃を軽減するためのカスタム・ヘッダー。

  許容値: [ "XMLHttpRequest" ]

本文()

オーディエンス属性名と値のペアの配列。 これらは、推奨事項の入力として使用されます。

属性エントリは、単一の値として指定できます:
"\.\" : "\"
また、複数値属性の場合は、配列として:
" \.\" : ["\", "\", ... ]

ノート:問合せで指定されたAudience属性は、本文で指定されているオーディエンス属性より優先されます。

ルート・スキーマ : RecommendationTest

型: object

推奨テスト

ソースを表示

• assetState: string
  許容値: [ "PUBLISHED", "ALL", "PREVIEW" ]

  公開されたアセットのみを推奨のテストで返すかどうかを決定するために使用される列挙。 検証値は、ALLおよびPUBLISHEDです。 デフォルト値はALLeです。
• audienceAttributes: object audienceAttributes
  許可される追加のプロパティ: additionalProperties

  推奨のテストに使用するオーディエンス属性の配列。 各属性には、次の単一の値を指定できます:
  "\.\" : "\"
  または複数値属性の配列として:
  "\.\" : ["\", "\" ... ]

{
    "type":"object",
    "required":[
        "assetState",
        "audienceAttributes"
    ],
    "properties":{
        "audienceAttributes":{
            "type":"object",
            "description":"Array of audience attributes to be used in testing the recommendation.  Each attribute can be proprovided as a single value: <br/> \"\\<category\\>.\\<attribute\\>\" : \"\\<value\\>\" <br/> or as an array for multi value attributes: <br/>\"\\<category\\>.\\<attribute\\>\" : [\"\\<value1\\>\", \"\\<value2\\>\" ... ]",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "assetState":{
            "type":"string",
            "description":"A Enum that is used to determine if only published assets should be returned in the testing of the recommendation.  Valida values are <i>ALL</i> and <i>PUBLISHED</i>. Default value is <i>ALL</i>e.",
            "enum":[
                "PUBLISHED",
                "ALL",
                "PREVIEW"
            ]
        }
    },
    "description":"Recommendation Test"
}

ネストされたスキーマ : audienceAttributes

型: object

使用可能なその他のプロパティ

ソースを表示

• array additionalProperties

{
    "type":"object",
    "description":"Array of audience attributes to be used in testing the recommendation.  Each attribute can be proprovided as a single value: <br/> \"\\<category\\>.\\<attribute\\>\" : \"\\<value\\>\" <br/> or as an array for multi value attributes: <br/>\"\\<category\\>.\\<attribute\\>\" : [\"\\<value1\\>\", \"\\<value2\\>\" ... ]",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

推奨のテストに使用するオーディエンス属性の配列。 各属性には、次の単一の値を指定できます:
"\.\" : "\"
または複数値属性の配列として:
"\.\" : ["\", "\" ... ]

ネストされたスキーマ: additionalProperties

型: array

ソースを表示

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

トップに戻る

レスポンス

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

• application/json

201レスポンス

作成されました。

本文()

ルート・スキーマ : RecommendationTestResults

型: object

推奨テスト結果

ソースを表示

• links(optional): array links
  リンク
• results: object CollectionItemMap
  コレクション
• resultsDetails(optional): object RecommendationTestResultsDetails
  推奨テスト結果詳細

{
    "type":"object",
    "required":[
        "results"
    ],
    "properties":{
        "results":{
            "description":"The list of items return as a result of the recommendation.",
            "$ref":"#/definitions/CollectionItemMap"
        },
        "resultsDetails":{
            "description":"Details on how the results of the recommendation was constructed.",
            "$ref":"#/definitions/RecommendationTestResultsDetails"
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Recommendation Test Results"
}

ネストされたスキーマ: links

型: array

リンク

ソースを表示

• Array of: object Link
  リソースのリンク。

{
    "type":"array",
    "description":"Links",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

ネストされたスキーマ : CollectionItemMap

型: object

コレクション

ソースを表示

• aggregationResults(optional): array aggregationResults
  集計結果。
• count(optional): integer(int32)
  現在のレスポンス内のレコードの合計数
• hasMore(optional): boolean
  フェッチするページがまだあるかどうかを確認します。
• items(optional): array items
  コレクションに含まれる特異なリソース。
• limit(optional): integer(int32)
  サーバーによって使用される実際のページ・サイズ。 これは、クライアントがリクエストするものと同じではない可能性があります。
• links(optional): array links
  リソースのリンク。
• message(optional): string
  検索のヒントを検索します。
• offset(optional): integer(int32)
  特異リソースが返される実際のインデックス。
• pinned(optional): array pinned
  固定品目。 検索リストの上部に固定されたアイテムを表示
• related(optional): object Related
  related
• scrollId(optional): string
  scrollId:検索がスクロール検索に解決された場合。
• totalResults(optional): integer(int32)
  クライアント・リクエストを満たすローの総数(ページング・パラメータを除く)

{
    "type":"object",
    "properties":{
        "hasMore":{
            "type":"boolean",
            "description":"Check whether there are more pages to fetch."
        },
        "offset":{
            "type":"integer",
            "format":"int32",
            "description":"The actual index from which the singular resources are returned."
        },
        "count":{
            "type":"integer",
            "format":"int32",
            "description":"Total number of records in the current response."
        },
        "limit":{
            "type":"integer",
            "format":"int32",
            "description":"Actual page size used by the server. This might not be the same as what the client requests."
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Total number of rows that satisfy the client request (excluding the paging parameters.)"
        },
        "items":{
            "type":"array",
            "description":"Singular resources contained in the collection.",
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"object"
                }
            }
        },
        "links":{
            "type":"array",
            "description":"Links of the resource.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "related":{
            "description":"Related information of the search.",
            "$ref":"#/definitions/Related"
        },
        "message":{
            "type":"string",
            "description":"Search hint of the search."
        },
        "scrollId":{
            "type":"string",
            "description":"scrollId if the search resolved to a scroll search."
        },
        "pinned":{
            "type":"array",
            "description":"Pinned items. Shows items pinned at the top of search list",
            "items":{
                "type":"string"
            }
        },
        "aggregationResults":{
            "type":"array",
            "description":"Aggregation results.",
            "items":{
                "$ref":"#/definitions/AggregationResult"
            }
        }
    },
    "description":"Collection"
}

ネストされたスキーマ : RecommendationTestResultsDetails

型: object

推奨テスト結果詳細

ソースを表示

• defaultsUsed(optional): boolean
  デフォルト・アイテムから結果が作成された場合は、trueに設定します。
• queryStatuses(optional): array queryStatuses
  各推奨問合せの結果を説明する推奨問合せステータス。

{
    "type":"object",
    "properties":{
        "defaultsUsed":{
            "type":"boolean",
            "description":"Set to true if the results were created from the default items."
        },
        "queryStatuses":{
            "type":"array",
            "description":"Recommendation query statuses describing outcome of each reccomendation query.",
            "items":{
                "$ref":"#/definitions/RecommendationTestQueryStatus"
            }
        }
    },
    "description":"Recommendation Test Results Details"
}

ネストされたスキーマ: Link

型: object

リソースのリンク。

ソースを表示

• href(optional): string
  ターゲット・リソースのURI それはテンプレートURIである可能性があります。 これはレスポンス取得の必須プロパティです。
• mediaType(optional): string
  メディア・タイプ。
• method(optional): string
  ターゲット・リソースへのアクセスに使用できるHTTPメソッド。
• profile(optional): string
  ターゲット・リソースを記述するメタデータにリンクします。
• rel(optional): string
  関連タイプ これはレスポンス取得の必須プロパティです。
• templated(optional): boolean
  URIがテンプレートであるかどうか。

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"The target resource's URI. It could be template URI. It is a required property in the get response."
        },
        "rel":{
            "type":"string",
            "description":"Relation type. It is a required property in the get response."
        },
        "templated":{
            "type":"boolean",
            "description":"Whether the URI is a template."
        },
        "method":{
            "type":"string",
            "description":"What HTTP method can be used to access the target resource."
        },
        "profile":{
            "type":"string",
            "description":"Link to the metadata that describes the target resource."
        },
        "mediaType":{
            "type":"string",
            "description":"Media type."
        }
    },
    "description":"Link of the resource."
}

ネストされたスキーマ : aggregationResults

型: array

集計結果。

ソースを表示

• Array of: object AggregationResult

{
    "type":"array",
    "description":"Aggregation results.",
    "items":{
        "$ref":"#/definitions/AggregationResult"
    }
}

ネストされたスキーマ: items

型: array

コレクションに含まれる特異なリソース。

ソースを表示

• Array of: object items
  許可される追加のプロパティ: additionalProperties

{
    "type":"array",
    "description":"Singular resources contained in the collection.",
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"object"
        }
    }
}

ネストされたスキーマ: links

型: array

リソースのリンク。

ソースを表示

• Array of: object Link
  リソースのリンク。

{
    "type":"array",
    "description":"Links of the resource.",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

ネストされたスキーマ : 殺害

型: array

固定品目。 検索リストの上部に固定されたアイテムを表示

ソースを表示

• Array of: string

{
    "type":"array",
    "description":"Pinned items. Shows items pinned at the top of search list",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ : 関連

型: object

related

ネストされたスキーマ : AggregationResult

型: object

ソースを表示

• name(optional): string
  読取り専用: true

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "readOnly":true
        }
    }
}

ネストされたスキーマ: items

型: object

使用可能なその他のプロパティ

ソースを表示

• object additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"object"
    }
}

ネストされたスキーマ: additionalProperties

型: object

ネストされたスキーマ : queryStatuses

型: array

各推奨問合せの結果を説明する推奨問合せステータス。

ソースを表示

• Array of: object RecommendationTestQueryStatus
  レコメンデーション・テスト問合せステータス。

{
    "type":"array",
    "description":"Recommendation query statuses describing outcome of each reccomendation query.",
    "items":{
        "$ref":"#/definitions/RecommendationTestQueryStatus"
    }
}

ネストされたスキーマ : RecommendationTestQueryStatus

型: object

レコメンデーション・テスト問合せステータス。

ソースを表示

• id(optional): string
  一意の問合せ識別子。
• status(optional): string
  実行ステータスを問い合せます。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique query identifier."
        },
        "status":{
            "type":"string",
            "description":"Query execution status."
        }
    },
    "description":"Recommendation test query status."
}

400レスポンス

不正リクエスト

403レスポンス

禁止。

500レスポンス

内部サーバー・エラー

先頭に戻る