機械翻訳について

移動先

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

特定のオーディエンス属性をidで読み込みます。

get

/content/management/api/v1.1/personalization/audienceAttributes/{id}

リクエスト

パス・パラメータ

• id: string
  オーディエンス属性のid。

問合せパラメータ

• fields(optional): string
  このパラメータは、オーディエンス属性に対して戻されるフィールドを制御するために使用します。 このパラメータは、フィールド名または「すべて」のカンマ区切りリストを受け入れます。 これらのフィールドは、リストの各プロパティに返されます。 すべてのフィールド名で大文字と小文字が区別されるため、問合せには正しいフィールド名を指定する必要があります。 各オーディエンス属性には、標準フィールド(id、name、descriptionおよびcategoryId)があります。 fieldsを「すべて」 (大/小文字を区別しない)として指定すると、すべての標準フィールドおよび追加フィールドが返されます。 標準フィールドは常にレスポンスで返され、除外することはできません。 ユーザーがフィルタ処理できるのは、追加フィールドのみです。 このパラメータは問合せではオプションで、デフォルトではレスポンスの標準フィールドのみが表示されます。 問合せで指定されたフィールド名が正しくないか無効な場合は、エラーが発生します。
  
  例: ?fields=all
  この結果、すべての標準フィールドと、各オーディエンス属性の追加フィールドがすべて返されます。
  
• links(optional): string
  このパラメータは、リンク名のカンマ区切りのリストを受け入れます。 デフォルトでは、このパラメータによって、適用可能なすべてのリンクが指定されます。 可能な値は次のとおりです: self, canonical, describedby

トップに戻る

レスポンス

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

• application/json

200レスポンス

OK。

本文()

ルート・スキーマ : audienceAttributeInfo

型: object

オーディエンス属性情報

ソースを表示

• apiName(optional): string
  オーディエンス属性の参照名。 これは、推奨を起動するAPIコールで使用される名前です。 参照名が指定されていない場合、サーバーによって名前フィールドから生成されます。 参照名はカテゴリ内で一意である必要があります。
• categoryId: string
  プロパティが属するカテゴリのid。
• description(optional): string
  オーディエンス属性の摘要。
• id: string
  オーディエンス属性のid。 これは、レスポンス取得の必須プロパティであり、ポスト/putリクエストで無視されました。
• links(optional): array links
  リンク
• name: string
  オーディエンス属性の名前。 これはレスポンス取得の必須プロパティであり、投稿/書込みリクエストで空にはできません。

{
    "type":"object",
    "required":[
        "categoryId",
        "id",
        "name"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of the Audience Attribute. This is a required propety in the get response and ignored in post/put requests."
        },
        "name":{
            "type":"string",
            "description":"The name of the Audience Attribute. It is a required property in the get response and cannot be empty in post/put request."
        },
        "description":{
            "type":"string",
            "description":"The description of the Audience Attribute."
        },
        "apiName":{
            "type":"string",
            "description":"The reference name of the Audience Attribute.  This is the name that is used in API calls that invoke the recommendation. If no reference name is provided the server will generate one from the name field. The referene name should be unique in a category."
        },
        "categoryId":{
            "type":"string",
            "description":"The id of the Category the property belongs to. "
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Audience Attribute Information"
}

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

304 レスポンス

変更されていません。

400レスポンス

不正リクエスト

403レスポンス

禁止。

404レスポンス

オーディエンス属性が見つかりません。 リクエストしたリソースが見つかりません。

500レスポンス

内部サーバー・エラー

先頭に戻る