ビヘイビアーエンドポイント
Experience Data Model （XDM）では、動作により、スキーマが記述するデータの性質が定義されます。 各XDM クラスは、特定の動作を参照する必要があります。この動作は、そのクラスを使用するすべてのスキーマが継承します。 Experience Platformのほぼすべてのユースケースで、次の2つのビヘイビアーを使用できます。
- レコード：主体の属性に関する情報を提供します。 主体は、組織または個人にすることができます。
- 時系列: レコードの被写体によって直接または間接的にアクションが実行された時点のシステムのスナップショットを提供します。
Schema Registry APIの/behaviors エンドポイントを使用すると、global コンテナで使用可能な動作を表示できます。
はじめに
このガイドで使用されているエンドポイントは、Schema Registry APIの一部です。 先に進む前に、はじめる前にを参照し、関連ドキュメントへのリンク、このドキュメントのサンプル API 呼び出しを読み取るためのガイドおよび任意の Experience Platform API を正常に呼び出すために必要なヘッダーに関する重要な情報を確認してください。
行動のリストの取得 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を使用してクラスにビヘイビアーを割り当てる方法については、 クラスエンドポイントガイド を参照してください。