建立臨時結構描述

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

主題：

建立對象：

開發人員

在特定情況下，可能需要建立Experience Data Model (XDM)結構描述，其欄位必須由單一資料集命名以供使用。這稱為「臨機」結構描述。特定結構描述用於Experience Platform的各種資料擷取工作流程，包括擷取CSV檔案和建立特定型別的來源連線。

本檔案提供使用結構描述登入API建立臨機結構描述的一般步驟。此教學課程旨在搭配其他Experience Platform教學課程使用，這些教學課程需要建立隨選結構描述作為其工作流程的一部分。其中每個檔案都提供了有關如何為其特定使用案例正確配置臨時方案的詳細資訊。

快速入門

此教學課程需要實際瞭解Experience Data Model (XDM)系統。開始進行本教學課程之前，請先檢閱下列XDM檔案：

XDM系統總覽： Experience Platform中XDM及其實作的高層級總覽。
結構描述組合的基本概念： XDM結構描述的基本元件概觀。

開始進行此教學課程之前，請檢閱開發人員指南以取得重要資訊，您必須瞭解這些資訊才能成功呼叫Schema Registry API。這包括您的{TENANT_ID}、「容器」的概念，以及發出要求所需的標頭（特別注意Accept標頭及其可能的值）。

建立臨時類別

XDM結構描述的資料行為取決於其基礎類別。建立臨時結構描述的第一步是根據adhoc行為建立類別。這是透過向/tenant/classes端點發出POST要求來完成。

API格式

POST /tenant/classes

要求

以下請求會建立新的XDM類別，由承載中提供的屬性設定。透過提供allOf陣列中設定為https://ns.adobe.com/xdm/data/adhoc的$ref屬性，此類別會繼承adhoc行為。此要求也定義了_adhoc物件，其中包含類別的自訂欄位。

NOTE

在_adhoc下定義的自訂欄位會依臨機操作結構描述的使用案例而有所不同。如需根據使用案例的必要自訂欄位，請參閱相關教學課程中的特定工作流程。

curl -X POST \
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/classes \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
        "title":"New ad-hoc class",
        "description": "New ad-hoc class description",
        "type":"object",
        "allOf": [
          {
            "$ref":"https://ns.adobe.com/xdm/data/adhoc"
          },
          {
            "properties": {
              "_adhoc": {
                "type":"object",
                "properties": {
                  "field1": {
                    "type":"string"
                  },
                  "field2": {
                    "type":"string"
                  }
                }
              }
            }
          }
        ]
      }'

屬性

說明

$ref

新類別的資料行為。若為臨機類別，此值必須設為https://ns.adobe.com/xdm/data/adhoc。

properties._adhoc

包含類別自訂欄位的物件，以欄位名稱和資料型別的索引鍵值配對表示。

回應

成功的回應會傳回新類別的詳細資料，將properties._adhoc物件的名稱取代為系統產生的類別唯讀唯一識別碼GUID。 meta:datasetNamespace屬性也會自動產生並包含在回應中。

{
    "$id": "https://ns.adobe.com/{TENANT_ID}/classes/6395cbd58812a6d64c4e5344f7b9120f",
    "meta:altId": "_{TENANT_ID}.classes.6395cbd58812a6d64c4e5344f7b9120f",
    "meta:resourceType": "classes",
    "version": "1.0",
    "title": "New Class",
    "description": "New class description",
    "type": "object",
    "allOf": [
        {
            "$ref": "https://ns.adobe.com/xdm/data/adhoc"
        },
        {
            "properties": {
                "_6395cbd58812a6d64c4e5344f7b9120f": {
                    "type": "object",
                    "properties": {
                        "field1": {
                            "type": "string",
                            "meta:xdmType": "string"
                        },
                        "field2": {
                            "type": "string",
                            "meta:xdmType": "string"
                        }
                    },
                    "meta:xdmType": "object"
                }
            },
            "type": "object",
            "meta:xdmType": "object"
        }
    ],
    "meta:abstract": true,
    "meta:extensible": true,
    "meta:extends": [
        "https://ns.adobe.com/xdm/data/adhoc"
    ],
    "meta:containerId": "tenant",
    "meta:datasetNamespace": "_6395cbd58812a6d64c4e5344f7b9120f",
    "imsOrg": "{ORG_ID}",
    "meta:xdmType": "object",
    "meta:registryMetadata": {
        "repo:createdDate": 1557527784822,
        "repo:lastModifiedDate": 1557527784822,
        "xdm:createdClientId": "{CREATED_CLIENT}",
        "xdm:lastModifiedClientId": "{MODIFIED_CLIENT}",
        "eTag": "Jggrlh4PQdZUvDUhQHXKx38iTQo="
    }
}

屬性

說明

$id

作為唯讀、系統為新的ad-hoc類別產生的唯一識別碼的URI。此值用於建立臨機模式的下一個步驟。