Experience Platform API の基本

Adobe Experience Platform API は、JSON ベースを効果的に管理するために理解しておくことが重要な、基盤となる複数のテクノロジーと構文を使用しています Platform リソース。 このドキュメントでは、これらのテクノロジーの概要のほか、詳細が記載されている外部ドキュメントへのリンクを提供します。

JSON ポインター

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

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

次の JSON は、JSON ポインター文字列を使用してフィールドを参照できる、シンプルな XDM スキーマを表しています。 カスタムスキーマフィールドグループ ( loyaltyLevel) は、 _{TENANT_ID} オブジェクトとは異なり、コアフィールドグループ ( fullName) は含まれていません。

{
  "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/85a4bdaa168b01bf44384e049fbd3d2e9b2ffaca440d35b9",
  "meta:altId": "_{TENANT_ID}.schemas.85a4bdaa168b01bf44384e049fbd3d2e9b2ffaca440d35b9",
  "meta:resourceType": "schemas",
  "version": "1.0",
  "title": "Example schema",
  "type": "object",
  "description": "This is an example schema.",
  "properties": {
    "_{TENANT_ID}": {
      "type": "object",
      "properties": {
        "loyaltyLevel": {
          "title": "Loyalty Level",
          "description": "",
          "type": "string",
          "isRequired": false,
          "enum": [
            "platinum",
            "gold",
            "silver",
            "bronze"
          ]
        }
      }
    },
    "person": {
      "title": "Person",
      "description": "An individual actor, contact, or owner.",
      "type": "object",
      "properties": {
        "name": {
          "title": "Full name",
          "description": "The person's full name.",
          "type": "object",
          "properties": {
            "fullName": {
              "title": "Full name",
              "type": "string",
              "description": "The full name of the person, in writing order most commonly accepted in the language of the name.",
            },
            "suffix": {
              "title": "Suffix",
              "type": "string",
              "description": "A group of letters provided after a person's name to provide additional information. The `suffix` is used at the end of someones name. For example Jr., Sr., M.D., PhD, I, II, III, etc.",
            }
          },
          "meta:referencedFrom": "https://ns.adobe.com/xdm/context/person-name",
          "meta:xdmField": "xdm:name"
        }
      }
    }
  }
}

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

JSON パッチ

次の操作に対して多くのPATCH操作があります。 Platform リクエストペイロードの JSON パッチオブジェクトを受け取る API。 JSON パッチは、JSON ドキュメントの変更を記述するための標準形式（RFC 6902）です。この標準形式では、リクエスト本文でドキュメント全体を送信する必要なく、JSON の部分的なアップデートを定義できます。

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

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

• op：パッチ操作のタイプ。JSON パッチは複数の異なる操作タイプをサポートしますが、でのすべてのPATCH操作ではありません Platform API は、すべての操作タイプと互換性があります。 使用可能な操作のタイプは次のとおりです。
  • add
  • remove
  • replace
  • copy
  • move
  • test
• path：JSON 構造のアップデートされる部分。JSON ポインター表記を使用して識別されます。

op で示されている操作タイプによっては、JSON パッチオブジェクトに追加のプロパティが必要な場合があります。JSON パッチの様々な操作と必要な構文の詳細については、JSON パッチのドキュメントを参照してください。

JSON スキーマ

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

次の手順

このドキュメントでは、 Experience Platform. 詳しくは、 入門ガイド を参照してください。 よくある質問に対する回答については、 Platform トラブルシューティングガイド.