行為端點

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

主題：

建立對象：

開發人員

在Experience Data Model (XDM)中，行為會定義結構描述之資料的性質。每個XDM類別都必須參考特定行為，採用該類別的所有結構描述都會繼承。在Platform的幾乎所有使用案例中，有兩個可用的行為：

記錄：提供有關主旨屬性的資訊。主旨可以是組織或個人。
時間序列：提供記錄主體直接或間接執行動作時的系統快照。

NOTE

Platform中有些使用案例需要使用未採用上述任一行為的結構描述。對於這些情況，有第三種「臨機」行為可供使用。如需詳細資訊，請參閱有關建立臨時結構描述的教學課程。

如需資料行為如何影響結構描述組合的一般資訊，請參閱結構描述組合基本概念指南。

Schema Registry API中的/behaviors端點可讓您檢視global容器中的可用行為。

快速入門

本指南中使用的端點是Schema Registry API的一部分。繼續之前，請先檢閱快速入門手冊，以取得相關檔案的連結、閱讀本檔案中範例API呼叫的手冊，以及有關成功呼叫任何Experience PlatformAPI所需必要標題的重要資訊。

擷取行為清單 list

您可以向/behaviors端點發出GET要求，以擷取所有可用行為的清單。

API格式

GET /global/behaviors

要求

curl -X GET \
  https://platform.adobe.io/data/foundation/schemaregistry/global/behaviors \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Accept: application/vnd.adobe.xed-id+json'

回應

{
    "results": [
        {
            "$id": "https://ns.adobe.com/xdm/data/record",
            "meta:altId": "_xdm.data.record",
            "version": "1.16.4",
            "title": "Record Schema"
        },
        {
            "$id": "https://ns.adobe.com/xdm/data/adhoc",
            "meta:altId": "_xdm.data.adhoc",
            "version": "1.16.4",
            "title": "Ad Hoc Schema"
        },
        {
            "$id": "https://ns.adobe.com/xdm/data/time-series",
            "meta:altId": "_xdm.data.time-series",
            "version": "1.16.4",
            "title": "Time-series Schema"
        }
    ],
    "_page": {
        "orderby": "updated",
        "next": null,
        "count": 3
    },
    "_links": {
        "next": null
    }
}

查詢行為 lookup

您可以在/behaviors端點的GET要求路徑中提供其ID，以查詢特定行為。

API格式

GET /global/behaviors/{BEHAVIOR_ID}

參數

說明

{BEHAVIOR_ID}

您要查閱之行為的meta:altId或URL編碼$id。

要求

下列請求會透過在請求路徑中提供其meta:altId來擷取記錄行為的詳細資料。

curl -X GET \
  https://platform.adobe.io/data/foundation/schemaregistry/global/behaviors/_xdm.data.record \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Accept: application/vnd.adobe.xed+json;version=1'

回應

成功的回應會傳回行為的詳細資訊，包括其版本、說明，以及該行為提供給採用它的類別的屬性。

{
    "$id": "https://ns.adobe.com/xdm/data/record",
    "meta:altId": "_xdm.data.record",
    "meta:resourceType": "behaviors",
    "version": "1.16.4",
    "title": "Record Schema",
    "type": "object",
    "description": "Used to indicate the behavior of record data semantic when composed into data schemas.",
    "definitions": {
        "record": {
            "properties": {
                "_id": {
                    "title": "Identifier",
                    "type": "string",
                    "format": "uri-reference",
                    "description": "A unique identifier for the record.",
                    "meta:xdmType": "string",
                    "meta:xdmField": "@id"
                }
            }
        }
    },
    "allOf": [
        {
            "$ref": "#/definitions/record",
            "type": "object",
            "meta:xdmType": "object"
        },
        {
            "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context",
            "type": "object",
            "meta:xdmType": "object"
        }
    ],
    "meta:extensible": true,
    "meta:abstract": true,
    "meta:xdmType": "object",
    "meta:status": "stable",
    "$schema": "http://json-schema.org/draft-06/schema#",
    "meta:registryMetadata": {
        "repo:createdDate": 1606266789446,
        "repo:lastModifiedDate": 1606266789446,
        "eTag": "2cc114a54949a9668fe2ad046ccece59192e1bfa28f14e5ac7c893acb7820ba2",
        "meta:globalLibVersion": "1.16.4"
    }
}

後續步驟

本指南涵蓋Schema Registry API中/behaviors端點的使用。若要瞭解如何使用API將行為指派給類別，請參閱類別端點指南。

recommendation-more-help

62e9ffd9-1c74-4cef-8f47-0d00af32fc07