Show Menu
トピック×

Adobe Experience Platform APIの基本事項

Adobe Experience Platform APIは、JSONベースのプラットフォームリソースを効果的に管理するために理解する必要がある、基礎となる複数のテクノロジーと構文を採用しています。 このドキュメントでは、これらのテクノロジーの概要を簡単に説明し、詳細については外部ドキュメントへのリンクを提供します。

JSONポインタ

JSONポインターは、JSONドキュメント内の特定の値を識別するための標準化された文字列構文( RFC 6901 )です。 JSONポインターは、オブジェクトのキーまたは配列のインデックスを指定する、 / 文字で区切られたトークンの文字列です。トークンは文字列または数値です。 JSONポインタ文字列は、このドキュメントで後述するように、多くのPlatform APIのPATCH操作で使用されます。 JSONポインターについて詳しくは、 JSONポインターの概要に関するドキュメントを参照してください

JSONスキーマオブジェクトの例

{
    "type": "object",
    "title": "Loyalty Member Details",
    "meta:intendedToExtend": [
        "https://ns.adobe.com/xdm/context/profile"
    ],
    "description": "Loyalty Program Mixin.",
    "definitions": {
        "loyalty": {
            "properties": {
                "_{TENANT_ID}": {
                    "type": "object",
                    "properties": {
                        "loyaltyId": {
                            "title": "Loyalty Identifier",
                            "type": "string",
                            "description": "Loyalty Identifier.",
                            "meta:xdmType": "string"
                        },
                        "loyaltyLevel": {
                            "title": "Loyalty Level",
                            "description": "The current loyalty program level to which the individual member belongs.",
                            "type": "string",
                            "enum": [
                                "platinum",
                                "gold",
                                "silver",
                                "bronze"
                            ],
                            "meta:enum": {
                                "platinum": "Platinum",
                                "gold": "Gold",
                                "silver": "Silver",
                                "bronze": "Bronze"
                            },
                            "meta:xdmType": "string"
                        }
                    },
                    "meta:xdmType": "object"
                }
            },
            "type": "object",
            "meta:xdmType": "object"
        }
    }
}

スキーマオブジェクトに基づくJSONポインタの例

JSONポインタ
解決先
"/title"
忠誠度メンバーの詳細
"/definitions/loyalty"
( loyalty オブジェクトの内容を返します)
"/definitions/loyalty/properties/_{TENANT_ID}/properties/loyaltyLevel/enum"
["platinum", "gold", "silver", "bronze"]
"/definitions/loyalty/properties/_{TENANT_ID}/properties/loyaltyLevel/enum/0"
"platinum"

JSONパッチ

プラットフォームAPIには、要求ペイロードにJSONパッチオブジェクトを受け入れる多くのPATCH操作があります。 JSONパッチは、JSONドキュメントの変更を記述する標準形式( RFC 6902 )です。 これにより、リクエスト本文でドキュメント全体を送信する必要なく、JSONに部分的な更新を定義できます。

JSONパッチオブジェクトの例

{
  "op": "remove",
  "path": "/foo"
}

  • op : パッチ操作のタイプ。 JSONパッチは複数の異なる操作タイプをサポートしますが、プラットフォームAPIのすべてのPATCH操作が各操作タイプと互換性があるわけではありません。 次の操作タイプを使用できます。
    • add
    • remove
    • replace
    • copy
    • move
    • test
  • path : JSON構造の更新対象部分。 JSONポインタ 表記を使用して識別されます。
に示す操作タイプに応じて、JSONパッチオブジェクト op に追加のプロパティが必要な場合があります。 様々なJSONパッチ操作と必要な構文について詳しくは、 JSONパッチのドキュメントを参照してください

JSON スキーマ

JSONスキーマは、JSONデータの構造を記述し、検証するために使用される形式です。 Experience Data Model(XDM) は、JSONスキーマ機能を利用して、取り込む顧客体験データの構造と形式に制約を課します。 JSONのスキーマについて詳しくは、 公式ドキュメントを参照してください

次の手順

このドキュメントでは、エクスペリエンスプラットフォームのJSONベースのリソースの管理に関連するテクノロジーと構文の一部を紹介しました。 プラットフォームAPIの操作に関する詳細(よくある質問へのベストプラクティスや回答など)については、 プラットフォームトラブルシューティングガイドを参照してください