機械翻訳について

移動先

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

推奨を非公開にします。

post

/content/management/api/v1.1/personalization/recommendations/{id}/unpublish

オプション・チャネルから推奨を公開解除します。

リクエスト

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

• application/json

パス・パラメータ

• id: string
  推奨のId。

問合せパラメータ

• links(optional): string
  このパラメータは、リンク名のカンマ区切りのリストを受け入れます。 デフォルトでは、このパラメータによって、適用可能なすべてのリンクが指定されます。 可能な値は次のとおりです: self, canonical, describedby

ヘッダー・パラメータ

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

  許容値: [ "XMLHttpRequest" ]

本文()

推奨の公開取消に必要な情報。

ルート・スキーマ : RecommendationUnpublish

型: object

推奨非公開リクエスト

ソースを表示

• allowUnpublishFromActiveSite(optional): boolean
  アクティブなサイト・アイテム(推奨とデフォルト)をunpublished.(defaults to false)に許可するかどうか
• channels(optional): array channels
  公開取消チャネルのリスト。 チャネルが空でない場合、推奨は指定チャネルに対する公開を取り消されます。 チャネルが空の場合、推奨はターゲット・チャネルから非公開にされます。

{
    "type":"object",
    "properties":{
        "channels":{
            "type":"array",
            "description":"List of unpublish channels. If channels are not empty, the recommendation is unpublished to the given channels. If the channels are empty, the recommendation is unpublished from its targeted channels.",
            "items":{
                "$ref":"#/definitions/ChannelId"
            }
        },
        "allowUnpublishFromActiveSite":{
            "type":"boolean",
            "description":"whether to allow active site items (recommendtion and defaults) to be unpublished.(defaults to false)"
        }
    },
    "description":"Recommendation Unpublish Request"
}

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

型: array

公開取消チャネルのリスト。 チャネルが空でない場合、推奨は指定チャネルに対する公開を取り消されます。 チャネルが空の場合、推奨はターゲット・チャネルから非公開にされます。

ソースを表示

• Array of: object ChannelId
  ChannelId

{
    "type":"array",
    "description":"List of unpublish channels. If channels are not empty, the recommendation is unpublished to the given channels. If the channels are empty, the recommendation is unpublished from its targeted channels.",
    "items":{
        "$ref":"#/definitions/ChannelId"
    }
}

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

型: object

ChannelId

ソースを表示

• id(optional): string
• isPrimaryChannel(optional): boolean
  チャネルがアセットのプライマリかどうかを示します。
• links(optional): array links
  リンク
• name(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "isPrimaryChannel":{
            "type":"boolean",
            "description":"Indicates if channel is primary for an asset."
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"ChannelId"
}

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

型: array

リンク

ソースを表示

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

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

ネストされたスキーマ: 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."
}

トップに戻る

レスポンス

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

• application/json

202レスポンス

Accepted.

400レスポンス

不正リクエスト

403レスポンス

禁止。

500レスポンス

内部サーバー・エラー

先頭に戻る