データ要素は、アプリケーション内の重要なデータを指す変数として機能します。データ要素は、ルールと拡張の設定内で使用されます。ブラウザーまたはアプリケーションで実行時にルールがトリガーされると、データ要素の値が解決され、ルール内で使用されます。データ要素は、拡張機能の設定でも同じように機能します。
複数のデータ要素を一緒に使用すると、データディクショナリまたはデータマップが作成されます。この辞書は、Adobe Experience Platform が認識し、利用できるデータを表します。
データ要素は、1 つのプロパティのみに属します。プロパティには、多くのデータ要素を含めることができます。
データ要素とタグでの使用に関する一般的な情報については、UI ドキュメントのデータ要素ガイドを参照してください。
このガイドで使用するエンドポイントは、Reactor API の一部です。続行する前に、API への認証方法に関する重要な情報について、はじめる前にを確認してください。
GET リクエストのパスにプロパティの ID を含めることで、プロパティのデータ要素のリストを取得できます。
API 形式
GET /properties/{PROPERTY_ID}/data_elements
パラメーター | 説明 |
---|---|
PROPERTY_ID |
データ要素を所有するプロパティの id 。 |
クエリパラメーターを使用して、リストされたデータ要素を次の属性に基づいてフィルタリングできます。
created_at
dirty
enabled
name
origin_id
published
published_at
revision_number
updated_at
リクエスト
curl -X GET \
https://reactor.adobe.io/properties/PR97d92a379a5f48758947cdf44f607a0d/data_elements \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H "Content-Type: application/vnd.api+json" \
-H 'Accept: application/vnd.api+json;revision=1'
応答
応答が成功すると、指定したプロパティのデータ要素のリストが返されます。
{
"data": [
{
"id": "DE5d11b3ed301d4ce99b530a5121e392b2",
"type": "data_elements",
"attributes": {
"created_at": "2020-12-14T17:36:09.045Z",
"deleted_at": null,
"dirty": true,
"enabled": true,
"name": "My Data Element 2020-12-14 17:36:08 +0000",
"published": false,
"published_at": null,
"revision_number": 0,
"updated_at": "2020-12-14T17:36:09.045Z",
"clean_text": false,
"default_value": null,
"delegate_descriptor_id": "kessel-test::dataElements::dom-attribute",
"force_lower_case": false,
"review_status": "unsubmitted",
"storage_duration": null,
"settings": "{\"elementProperty\":\"html\",\"elementSelector\":\".target-element\"}"
},
"relationships": {
"libraries": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE5d11b3ed301d4ce99b530a5121e392b2/libraries"
}
},
"revisions": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE5d11b3ed301d4ce99b530a5121e392b2/revisions"
}
},
"notes": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE5d11b3ed301d4ce99b530a5121e392b2/notes"
}
},
"property": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE5d11b3ed301d4ce99b530a5121e392b2/property"
},
"data": {
"id": "PR97d92a379a5f48758947cdf44f607a0d",
"type": "properties"
}
},
"origin": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE5d11b3ed301d4ce99b530a5121e392b2/origin"
},
"data": {
"id": "DE5d11b3ed301d4ce99b530a5121e392b2",
"type": "data_elements"
}
},
"extension": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE5d11b3ed301d4ce99b530a5121e392b2/extension"
},
"data": {
"id": "EX0348d463358c4c89afe726245576f112",
"type": "extensions"
}
},
"updated_with_extension_package": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE5d11b3ed301d4ce99b530a5121e392b2/updated_with_extension_package"
},
"data": {
"id": "EP75db2452065b44e2b8a38ca883ce369a",
"type": "extension_packages"
}
},
"updated_with_extension": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE5d11b3ed301d4ce99b530a5121e392b2/updated_with_extension"
},
"data": {
"id": "EX1cc78b39339242da82a0e0752fa53375",
"type": "extensions"
}
}
},
"links": {
"property": "https://reactor.adobe.io/properties/PR97d92a379a5f48758947cdf44f607a0d",
"origin": "https://reactor.adobe.io/data_elements/DE5d11b3ed301d4ce99b530a5121e392b2",
"self": "https://reactor.adobe.io/data_elements/DE5d11b3ed301d4ce99b530a5121e392b2",
"extension": "https://reactor.adobe.io/extensions/EX0348d463358c4c89afe726245576f112"
},
"meta": {
"latest_revision_number": 0
}
}
],
"meta": {
"pagination": {
"current_page": 1,
"next_page": null,
"prev_page": null,
"total_pages": 1,
"total_count": 1
}
}
}
GET リクエストのパスにデータ要素の ID を指定することで、データ要素を検索できます。
データ要素が削除されると、削除済みとマークされますが、実際にはシステムから削除されません。したがって、削除されたデータ要素を検索することができます。削除されたデータ要素は、data.meta.deleted_at
属性の存在によって識別できます。
API 形式
GET /data_elements/{DATA_ELEMENT_ID}
パラメーター | 説明 |
---|---|
DATA_ELEMENT_ID |
検索するデータ要素の id 。 |
リクエスト
curl -X GET \
https://reactor.adobe.io/data_elements/DE8097636264104451ac3a18c95d5ff833 \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H "Content-Type: application/vnd.api+json" \
-H 'Accept: application/vnd.api+json;revision=1'
応答
応答が成功すると、データ要素の詳細が返されます。
{
"data": {
"id": "DE8097636264104451ac3a18c95d5ff833",
"type": "data_elements",
"attributes": {
"created_at": "2020-12-14T17:35:54.956Z",
"deleted_at": null,
"dirty": true,
"enabled": true,
"name": "My Data Element 2020-12-14 17:35:54 +0000",
"published": false,
"published_at": null,
"revision_number": 0,
"updated_at": "2020-12-14T17:35:54.956Z",
"clean_text": false,
"default_value": null,
"delegate_descriptor_id": "kessel-test::dataElements::dom-attribute",
"force_lower_case": false,
"review_status": "unsubmitted",
"storage_duration": null,
"settings": "{\"elementProperty\":\"html\",\"elementSelector\":\".target-element\"}"
},
"relationships": {
"libraries": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE8097636264104451ac3a18c95d5ff833/libraries"
}
},
"revisions": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE8097636264104451ac3a18c95d5ff833/revisions"
}
},
"notes": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE8097636264104451ac3a18c95d5ff833/notes"
}
},
"property": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE8097636264104451ac3a18c95d5ff833/property"
},
"data": {
"id": "PRa5621686159f44c880557e12af412a95",
"type": "properties"
}
},
"origin": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE8097636264104451ac3a18c95d5ff833/origin"
},
"data": {
"id": "DE8097636264104451ac3a18c95d5ff833",
"type": "data_elements"
}
},
"extension": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE8097636264104451ac3a18c95d5ff833/extension"
},
"data": {
"id": "EX085a465793b54be39b5408d13b50b46e",
"type": "extensions"
}
},
"updated_with_extension_package": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE8097636264104451ac3a18c95d5ff833/updated_with_extension_package"
},
"data": {
"id": "EP75db2452065b44e2b8a38ca883ce369a",
"type": "extension_packages"
}
},
"updated_with_extension": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE8097636264104451ac3a18c95d5ff833/updated_with_extension"
},
"data": {
"id": "EXf9a32699efde42e9b9410b43bd660848",
"type": "extensions"
}
}
},
"links": {
"property": "https://reactor.adobe.io/properties/PRa5621686159f44c880557e12af412a95",
"origin": "https://reactor.adobe.io/data_elements/DE8097636264104451ac3a18c95d5ff833",
"self": "https://reactor.adobe.io/data_elements/DE8097636264104451ac3a18c95d5ff833",
"extension": "https://reactor.adobe.io/extensions/EX085a465793b54be39b5408d13b50b46e"
},
"meta": {
"latest_revision_number": 0
}
}
}
POST リクエストをおこなうことで、新しいデータ要素を作成できます。
API 形式
POST /properties/{PROPERTY_ID}/data_elements
パラメーター | 説明 |
---|---|
PROPERTY_ID |
データ要素を定義しているプロパティの id 。 |
リクエスト
次のリクエストは、指定されたプロパティに新しいデータ要素を作成します。また、この呼び出しは、 relationships
プロパティを通じてデータ要素を既存の拡張機能に関連付けます。詳しくは、 関係 に関するガイドを参照してください。
curl -X POST \
https://reactor.adobe.io/properties/PR97d92a379a5f48758947cdf44f607a0d/data_elements \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"attributes": {
"name": "My Data Element 2020-12-14 17:33:21 +0000",
"delegate_descriptor_id": "kessel-test::dataElements::dom-attribute",
"settings": "{\"elementSelector\":\".target-element\",\"elementProperty\":\"html\"}",
"default_value": "general_label",
"enabled": true,
"force_lower_case": true,
"clean_text": true,
},
"relationships": {
"extension": {
"data": {
"id": "EX28788723a8e24a2f927fce1b55eb7ffc",
"type": "extensions"
}
}
},
"type": "data_elements"
}
}'
プロパティ | 説明 |
---|---|
attributes.name |
(必須)データ要素の人間が判読できる名前。 |
attributes.delegate_descriptor_id |
(必須)データ要素を拡張機能パッケージに関連付けるフォーマットされた文字列。すべてのデータ要素は、最初に作成されるときに拡張パッケージに関連付ける必要があります。各拡張パッケージは、デリゲートデータ要素と互換性のあるタイプと、その意図された動作を定義しているからです。詳しくは 、デリゲート記述子 ID に関するガイドを参照してください。 |
attributes.settings |
文字列として表される設定 JSON オブジェクト。 |
attributes.default_value |
データ要素の評価結果が undefined の場合に返されるデフォルト値。 |
attributes.enabled |
データ要素が有効かどうかを示すブール値。 |
attributes.force_lower_case |
データ要素の値を保存する前に小文字に変換するかどうかを示すブール値。 |
attributes.clean_text |
データ要素の値を保存する前に、先頭と末尾の空白を削除する必要があるかどうかを示すブール値。 |
type |
更新するリソースのタイプ。 このエンドポイントの場合は、値を data_elements にする必要があります。 |
応答
応答が成功すると、新しく作成したデータ要素の詳細が返されます。
{
"data": {
"id": "DE8667bc64ceba4b599e8458ea4ab58b8f",
"type": "data_elements",
"attributes": {
"created_at": "2020-12-14T17:33:21.774Z",
"deleted_at": null,
"dirty": true,
"enabled": true,
"name": "My Data Element 2020-12-14 17:33:21 +0000",
"published": false,
"published_at": null,
"revision_number": 0,
"updated_at": "2020-12-14T17:33:21.774Z",
"clean_text": false,
"default_value": null,
"delegate_descriptor_id": "kessel-test::dataElements::dom-attribute",
"force_lower_case": false,
"review_status": "unsubmitted",
"storage_duration": null,
"settings": "{\"elementSelector\":\".target-element\",\"elementProperty\":\"html\"}"
},
"relationships": {
"libraries": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE8667bc64ceba4b599e8458ea4ab58b8f/libraries"
}
},
"revisions": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE8667bc64ceba4b599e8458ea4ab58b8f/revisions"
}
},
"notes": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE8667bc64ceba4b599e8458ea4ab58b8f/notes"
}
},
"property": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE8667bc64ceba4b599e8458ea4ab58b8f/property"
},
"data": {
"id": "PR05ad70a8078f44c1a229ecf0da2802f2",
"type": "properties"
}
},
"origin": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE8667bc64ceba4b599e8458ea4ab58b8f/origin"
},
"data": {
"id": "DE8667bc64ceba4b599e8458ea4ab58b8f",
"type": "data_elements"
}
},
"extension": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE8667bc64ceba4b599e8458ea4ab58b8f/extension"
},
"data": {
"id": "EX28788723a8e24a2f927fce1b55eb7ffc",
"type": "extensions"
}
},
"updated_with_extension_package": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE8667bc64ceba4b599e8458ea4ab58b8f/updated_with_extension_package"
},
"data": {
"id": "EP75db2452065b44e2b8a38ca883ce369a",
"type": "extension_packages"
}
},
"updated_with_extension": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE8667bc64ceba4b599e8458ea4ab58b8f/updated_with_extension"
},
"data": {
"id": "EXd6bf04b143e64fe0ae7efe55a6655fa9",
"type": "extensions"
}
}
},
"links": {
"property": "https://reactor.adobe.io/properties/PR05ad70a8078f44c1a229ecf0da2802f2",
"origin": "https://reactor.adobe.io/data_elements/DE8667bc64ceba4b599e8458ea4ab58b8f",
"self": "https://reactor.adobe.io/data_elements/DE8667bc64ceba4b599e8458ea4ab58b8f",
"extension": "https://reactor.adobe.io/extensions/EX28788723a8e24a2f927fce1b55eb7ffc"
},
"meta": {
"latest_revision_number": 0
}
}
}
PATCH リクエストのパスに ID を含めることで、データ要素を更新できます。
API 形式
PATCH /data_elements/{DATA_ELEMENT_ID}
パラメーター | 説明 |
---|---|
DATA_ELEMENT_ID |
更新するデータ要素の id 。 |
リクエスト
次のリクエストは、既存のデータ要素の name
を更新します。
curl -X PATCH \
https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"attributes": {
"name": "New Data Element Name"
},
"id": "DE3fab176ccf8641838b3da59f716fc42b",
"type": "data_elements"
}
}'
プロパティ | 説明 |
---|---|
attributes |
プロパティが、そのデータ要素に対して更新される属性を表すオブジェクト。すべてのデータ要素属性を更新できます。属性のリストとその使用例については、データ要素の作成の呼び出し例を参照してください。 |
id |
更新するデータ要素の id 。リクエストパスで指定された {DATA_ELEMENT_ID} 値と一致する必要があります。 |
type |
更新するリソースのタイプ。 このエンドポイントの場合は、値を data_elements にする必要があります。 |
応答
応答が成功すると、更新されたデータ要素の詳細が返されます。
{
"data": {
"id": "DE3fab176ccf8641838b3da59f716fc42b",
"type": "data_elements",
"attributes": {
"created_at": "2020-12-14T17:36:24.552Z",
"deleted_at": null,
"dirty": true,
"enabled": true,
"name": "New Data Element Name",
"published": false,
"published_at": null,
"revision_number": 0,
"updated_at": "2020-12-14T17:36:25.578Z",
"clean_text": false,
"default_value": null,
"delegate_descriptor_id": "kessel-test::dataElements::dom-attribute",
"force_lower_case": false,
"review_status": "unsubmitted",
"storage_duration": null,
"settings": "{\"elementSelector\":\".target-element-b\",\"elementProperty\":\"html\"}"
},
"relationships": {
"libraries": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b/libraries"
}
},
"revisions": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b/revisions"
}
},
"notes": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b/notes"
}
},
"property": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b/property"
},
"data": {
"id": "PR85e261fb61ce44c9b2498807a6e6410b",
"type": "properties"
}
},
"origin": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b/origin"
},
"data": {
"id": "DE3fab176ccf8641838b3da59f716fc42b",
"type": "data_elements"
}
},
"extension": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b/extension"
},
"data": {
"id": "EX71f31a3eeec249dfb77fedd6c5ce6387",
"type": "extensions"
}
},
"updated_with_extension_package": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b/updated_with_extension_package"
},
"data": {
"id": "EP75db2452065b44e2b8a38ca883ce369a",
"type": "extension_packages"
}
},
"updated_with_extension": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b/updated_with_extension"
},
"data": {
"id": "EX1f4df32a850c48a4930fb3e1dfa83536",
"type": "extensions"
}
}
},
"links": {
"property": "https://reactor.adobe.io/properties/PR85e261fb61ce44c9b2498807a6e6410b",
"origin": "https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b",
"self": "https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b",
"extension": "https://reactor.adobe.io/extensions/EX71f31a3eeec249dfb77fedd6c5ce6387"
},
"meta": {
"latest_revision_number": 0
}
}
}
データ要素を修正すると、現在の(先頭の)リビジョンでデータ要素の新しいリビジョンが作成されます。データ要素の各リビジョンには、独自の ID があります。元のデータ要素は、オリジンリンクを介して検出できます。
PATCH リクエストの本文で、meta.action
プロパティに revise
の値を指定することで、データ要素を修正できます。
API 形式
PATCH /data_elements/{DATA_ELEMENT_ID}
パラメーター | 説明 |
---|---|
DATA_ELEMENT_ID |
修正するデータ要素の id 。 |
リクエスト
curl -X PATCH \
https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"attributes": {
"name": "New Data Element Name"
},
"meta": {
"action": "revise"
},
"id": "DE7d7284657ee540ee8f402277860e9f8a",
"type": "data_elements"
}
}'
プロパティ | 説明 |
---|---|
attributes |
プロパティが、そのデータ要素に対して更新される属性を表すオブジェクト。すべてのデータ要素属性を更新できます。属性のリストとその使用例については、データ要素の作成の呼び出し例を参照してください。 |
meta.action |
revise の値が含まれている場合、このプロパティは、データ要素に対して新しいリビジョンを作成する必要があることを示します。 |
id |
修正するデータ要素の id 。 リクエストパスで指定された {DATA_ELEMENT_ID} 値と一致する必要があります。 |
type |
修正するリソースのタイプ。このエンドポイントの場合は、値を data_elements にする必要があります。 |
応答
応答が成功すると、増分された meta.latest_revision_number
属性で示されるように、データ要素の新しいリビジョンの詳細が返されます。
{
"data": {
"id": "DE3fab176ccf8641838b3da59f716fc42b",
"type": "data_elements",
"attributes": {
"created_at": "2020-12-14T17:36:24.552Z",
"deleted_at": null,
"dirty": true,
"enabled": true,
"name": "New Data Element Name",
"published": false,
"published_at": null,
"revision_number": 0,
"updated_at": "2020-12-14T17:36:25.578Z",
"clean_text": false,
"default_value": null,
"delegate_descriptor_id": "kessel-test::dataElements::dom-attribute",
"force_lower_case": false,
"review_status": "unsubmitted",
"storage_duration": null,
"settings": "{\"elementSelector\":\".target-element-b\",\"elementProperty\":\"html\"}"
},
"relationships": {
"libraries": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b/libraries"
}
},
"revisions": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b/revisions"
}
},
"notes": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b/notes"
}
},
"property": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b/property"
},
"data": {
"id": "PR85e261fb61ce44c9b2498807a6e6410b",
"type": "properties"
}
},
"origin": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b/origin"
},
"data": {
"id": "DE3fab176ccf8641838b3da59f716fc42b",
"type": "data_elements"
}
},
"extension": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b/extension"
},
"data": {
"id": "EX71f31a3eeec249dfb77fedd6c5ce6387",
"type": "extensions"
}
},
"updated_with_extension_package": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b/updated_with_extension_package"
},
"data": {
"id": "EP75db2452065b44e2b8a38ca883ce369a",
"type": "extension_packages"
}
},
"updated_with_extension": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b/updated_with_extension"
},
"data": {
"id": "EX1f4df32a850c48a4930fb3e1dfa83536",
"type": "extensions"
}
}
},
"links": {
"property": "https://reactor.adobe.io/properties/PR85e261fb61ce44c9b2498807a6e6410b",
"origin": "https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b",
"self": "https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b",
"extension": "https://reactor.adobe.io/extensions/EX71f31a3eeec249dfb77fedd6c5ce6387"
},
"meta": {
"latest_revision_number": 1
}
}
}
DELETE リクエストのパスに ID を含めることで、データ要素を削除できます。
API 形式
DELETE /data_elements/{DATA_ELEMENT_ID}
パラメーター | 説明 |
---|---|
DATA_ELEMENT_ID |
削除するデータ要素の id 。 |
リクエスト
curl -X DELETE \
https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}'
応答
応答が成功すると、応答本文なしで HTTP ステータス 204(コンテンツなし)が返され、データ要素が削除されたことを示します。
データ要素は「メモ機能のある」リソースのため、個々のリソースでテキストベースのメモを作成し、取得することができます。データ要素およびその他の互換性のあるリソースのメモを管理する方法について詳しくは、メモエンドポイントガイドを参照してください。
次の呼び出しは、データ要素の関連リソースを取得する方法を示しています。 データ要素を検索すると、これらの関係は relationships
プロパティの下にリストされます。
Reactor API の関係について詳しくは、 関係に関するガイド を参照してください。
参照リクエストのパスに /libraries
を追加すると、データ要素を利用するライブラリをリストできます。
API 形式
GET /data_elements/{DATA_ELEMENT_ID}/libraries
パラメーター | 説明 |
---|---|
{DATA_ELEMENT_ID} |
ライブラリのリストを取得するデータ要素の id 。 |
リクエスト
curl -X GET \
https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b/libraries \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H "Content-Type: application/vnd.api+json" \
-H 'Accept: application/vnd.api+json;revision=1'
応答
応答が成功すると、指定されたデータ要素を使用しているライブラリのリストが返されます。
{
"data": [
{
"id": "LB62d20ad807a949e6b13b0a2c7299eb65",
"type": "libraries",
"attributes": {
"created_at": "2020-12-14T17:50:19.589Z",
"name": "My Library",
"published_at": null,
"state": "development",
"updated_at": "2020-12-14T17:50:19.589Z",
"build_required": true
},
"relationships": {
"builds": {
"links": {
"related": "https://reactor.adobe.io/libraries/LB62d20ad807a949e6b13b0a2c7299eb65/builds"
}
},
"environment": {
"links": {
"self": "https://reactor.adobe.io/libraries/LB62d20ad807a949e6b13b0a2c7299eb65/relationships/environment"
},
"data": null
},
"data_elements": {
"links": {
"related": "https://reactor.adobe.io/libraries/LB62d20ad807a949e6b13b0a2c7299eb65/data_elements",
"self": "https://reactor.adobe.io/libraries/LB62d20ad807a949e6b13b0a2c7299eb65/relationships/data_elements"
}
},
"extensions": {
"links": {
"related": "https://reactor.adobe.io/libraries/LB62d20ad807a949e6b13b0a2c7299eb65/extensions",
"self": "https://reactor.adobe.io/libraries/LB62d20ad807a949e6b13b0a2c7299eb65/relationships/extensions"
}
},
"notes": {
"links": {
"related": "https://reactor.adobe.io/libraries/LB62d20ad807a949e6b13b0a2c7299eb65/notes"
}
},
"rules": {
"links": {
"related": "https://reactor.adobe.io/libraries/LB62d20ad807a949e6b13b0a2c7299eb65/rules",
"self": "https://reactor.adobe.io/libraries/LB62d20ad807a949e6b13b0a2c7299eb65/relationships/rules"
}
},
"upstream_library": {
"data": null
},
"property": {
"links": {
"related": "https://reactor.adobe.io/libraries/LB62d20ad807a949e6b13b0a2c7299eb65/property"
},
"data": {
"id": "PR241ba9cd56324ac192de68d658f20cb0",
"type": "properties"
}
},
"last_build": {
"links": {
"related": "https://reactor.adobe.io/libraries/LB62d20ad807a949e6b13b0a2c7299eb65/last_build"
},
"data": null
}
},
"links": {
"property": "https://reactor.adobe.io/properties/PR241ba9cd56324ac192de68d658f20cb0",
"self": "https://reactor.adobe.io/libraries/LB62d20ad807a949e6b13b0a2c7299eb65"
},
"meta": {
"build_status": null,
"build_required_detail": "No build found since last state change"
}
}
],
"meta": {
"pagination": {
"current_page": 1,
"next_page": null,
"prev_page": null,
"total_pages": 1,
"total_count": 1
}
}
}
参照リクエストのパスに /revisions
を追加すると、データ要素の以前のリビジョンをリストできます。
API 形式
GET /data_elements/{DATA_ELEMENT_ID}/revisions
パラメーター | 説明 |
---|---|
{DATA_ELEMENT_ID} |
リビジョンのリストを取得するデータ要素の id 。 |
リクエスト
curl -X GET \
https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b/revisions \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H "Content-Type: application/vnd.api+json" \
-H 'Accept: application/vnd.api+json;revision=1'
応答
応答が成功すると、指定されたデータ要素のリビジョンのリストが返されます。
{
"data": [
{
"id": "DEaeceb5164d494c768c18e37ec6f3b091",
"type": "data_elements",
"attributes": {
"created_at": "2020-12-14T17:37:06.488Z",
"deleted_at": null,
"dirty": false,
"enabled": true,
"name": "My Data Element 2020-12-14 17:37:05 +0000",
"published": false,
"published_at": null,
"revision_number": 1,
"updated_at": "2020-12-14T17:37:06.488Z",
"clean_text": false,
"default_value": null,
"delegate_descriptor_id": "kessel-test::dataElements::dom-attribute",
"force_lower_case": false,
"review_status": "unsubmitted",
"storage_duration": null,
"settings": "{\"elementProperty\":\"html\",\"elementSelector\":\".target-element\"}"
},
"relationships": {
"libraries": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DEaeceb5164d494c768c18e37ec6f3b091/libraries"
}
},
"revisions": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DEaeceb5164d494c768c18e37ec6f3b091/revisions"
}
},
"notes": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DEaeceb5164d494c768c18e37ec6f3b091/notes"
}
},
"property": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DEaeceb5164d494c768c18e37ec6f3b091/property"
},
"data": {
"id": "PR52072581500b44cd808e03e36c38e005",
"type": "properties"
}
},
"origin": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DEaeceb5164d494c768c18e37ec6f3b091/origin"
},
"data": {
"id": "DE5172417ff56e43d2a99ca149021bf65a",
"type": "data_elements"
}
},
"extension": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DEaeceb5164d494c768c18e37ec6f3b091/extension"
},
"data": {
"id": "EXdd53073348ef467683365286a33ade02",
"type": "extensions"
}
},
"updated_with_extension_package": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DEaeceb5164d494c768c18e37ec6f3b091/updated_with_extension_package"
},
"data": {
"id": "EP75db2452065b44e2b8a38ca883ce369a",
"type": "extension_packages"
}
},
"updated_with_extension": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DEaeceb5164d494c768c18e37ec6f3b091/updated_with_extension"
},
"data": {
"id": "EXf9d7d1ca8e6f436b900659ce499c09ce",
"type": "extensions"
}
}
},
"links": {
"property": "https://reactor.adobe.io/properties/PR52072581500b44cd808e03e36c38e005",
"origin": "https://reactor.adobe.io/data_elements/DE5172417ff56e43d2a99ca149021bf65a",
"self": "https://reactor.adobe.io/data_elements/DEaeceb5164d494c768c18e37ec6f3b091",
"extension": "https://reactor.adobe.io/extensions/EXdd53073348ef467683365286a33ade02"
},
"meta": {
"latest_revision_number": 1
}
},
{
"id": "DE5172417ff56e43d2a99ca149021bf65a",
"type": "data_elements",
"attributes": {
"created_at": "2020-12-14T17:37:05.920Z",
"deleted_at": null,
"dirty": false,
"enabled": true,
"name": "My Data Element 2020-12-14 17:37:05 +0000",
"published": false,
"published_at": null,
"revision_number": 0,
"updated_at": "2020-12-14T17:37:05.920Z",
"clean_text": false,
"default_value": null,
"delegate_descriptor_id": "kessel-test::dataElements::dom-attribute",
"force_lower_case": false,
"review_status": "unsubmitted",
"storage_duration": null,
"settings": "{\"elementProperty\":\"html\",\"elementSelector\":\".target-element\"}"
},
"relationships": {
"libraries": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE5172417ff56e43d2a99ca149021bf65a/libraries"
}
},
"revisions": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE5172417ff56e43d2a99ca149021bf65a/revisions"
}
},
"notes": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE5172417ff56e43d2a99ca149021bf65a/notes"
}
},
"property": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE5172417ff56e43d2a99ca149021bf65a/property"
},
"data": {
"id": "PR52072581500b44cd808e03e36c38e005",
"type": "properties"
}
},
"origin": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE5172417ff56e43d2a99ca149021bf65a/origin"
},
"data": {
"id": "DE5172417ff56e43d2a99ca149021bf65a",
"type": "data_elements"
}
},
"extension": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE5172417ff56e43d2a99ca149021bf65a/extension"
},
"data": {
"id": "EXdd53073348ef467683365286a33ade02",
"type": "extensions"
}
},
"updated_with_extension_package": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE5172417ff56e43d2a99ca149021bf65a/updated_with_extension_package"
},
"data": {
"id": "EP75db2452065b44e2b8a38ca883ce369a",
"type": "extension_packages"
}
},
"updated_with_extension": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE5172417ff56e43d2a99ca149021bf65a/updated_with_extension"
},
"data": {
"id": "EXf9d7d1ca8e6f436b900659ce499c09ce",
"type": "extensions"
}
}
},
"links": {
"property": "https://reactor.adobe.io/properties/PR52072581500b44cd808e03e36c38e005",
"origin": "https://reactor.adobe.io/data_elements/DE5172417ff56e43d2a99ca149021bf65a",
"self": "https://reactor.adobe.io/data_elements/DE5172417ff56e43d2a99ca149021bf65a",
"extension": "https://reactor.adobe.io/extensions/EXdd53073348ef467683365286a33ade02"
},
"meta": {
"latest_revision_number": 1
}
}
],
"meta": {
"pagination": {
"current_page": 1,
"next_page": null,
"prev_page": null,
"total_pages": 1,
"total_count": 2
}
}
}
GET リクエストのパスに /extension
を追加することで、データ要素を利用する拡張機能を検索できます。
API 形式
GET /data_elements/{DATA_ELEMENT_ID}/extension
パラメーター | 説明 |
---|---|
{DATA_ELEMENT_ID} |
拡張機能を検索するデータ要素の id 。 |
リクエスト
curl -X GET \
https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b/extension \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H "Content-Type: application/vnd.api+json" \
-H 'Accept: application/vnd.api+json;revision=1'
応答
応答が成功すると、指定されたデータ要素を使用する拡張機能の詳細が返されます。
{
"data": {
"id": "EX9c7f9f1e826149978f2dadaf4c639679",
"type": "extensions",
"attributes": {
"created_at": "2020-12-14T17:37:31.952Z",
"deleted_at": null,
"dirty": false,
"enabled": true,
"name": "kessel-test",
"published": false,
"published_at": null,
"revision_number": 0,
"updated_at": "2020-12-14T17:37:31.952Z",
"delegate_descriptor_id": null,
"display_name": "Kessel Test",
"review_status": "unsubmitted",
"version": "1.2.0",
"settings": "{}"
},
"relationships": {
"libraries": {
"links": {
"related": "https://reactor.adobe.io/extensions/EX9c7f9f1e826149978f2dadaf4c639679/libraries"
}
},
"revisions": {
"links": {
"related": "https://reactor.adobe.io/extensions/EX9c7f9f1e826149978f2dadaf4c639679/revisions"
}
},
"notes": {
"links": {
"related": "https://reactor.adobe.io/extensions/EX9c7f9f1e826149978f2dadaf4c639679/notes"
}
},
"property": {
"links": {
"related": "https://reactor.adobe.io/extensions/EX9c7f9f1e826149978f2dadaf4c639679/property"
},
"data": {
"id": "PR5c15543ef7bb403abc79d65fee0bf1f9",
"type": "properties"
}
},
"origin": {
"links": {
"related": "https://reactor.adobe.io/extensions/EX9c7f9f1e826149978f2dadaf4c639679/origin"
},
"data": {
"id": "EX9c7f9f1e826149978f2dadaf4c639679",
"type": "extensions"
}
},
"updated_with_extension_package": {
"links": {
"related": "https://reactor.adobe.io/extensions/EX9c7f9f1e826149978f2dadaf4c639679/updated_with_extension_package"
},
"data": {
"id": "EP75db2452065b44e2b8a38ca883ce369a",
"type": "extension_packages"
}
},
"extension_package": {
"links": {
"related": "https://reactor.adobe.io/extensions/EX9c7f9f1e826149978f2dadaf4c639679/extension_package"
},
"data": {
"id": "EP75db2452065b44e2b8a38ca883ce369a",
"type": "extension_packages"
}
}
},
"links": {
"property": "https://reactor.adobe.io/properties/PR5c15543ef7bb403abc79d65fee0bf1f9",
"origin": "https://reactor.adobe.io/extensions/EX9c7f9f1e826149978f2dadaf4c639679",
"self": "https://reactor.adobe.io/extensions/EX9c7f9f1e826149978f2dadaf4c639679",
"extension_package": "https://reactor.adobe.io/extension_packages/EP75db2452065b44e2b8a38ca883ce369a",
"latest_extension_package": "https://reactor.adobe.io/extension_packages/EP75db2452065b44e2b8a38ca883ce369a"
},
"meta": {
"latest_revision_number": 1
}
}
}
GET リクエストのパスに /origin
を追加することで、データ要素のオリジンを検索できます。データ要素のオリジンは、現在のリビジョンを作成するために更新された前のリビジョンです。
API 形式
GET /data_elements/{DATA_ELEMENT_ID}/origin
パラメーター | 説明 |
---|---|
{DATA_ELEMENT_ID} |
オリジンを検索するデータ要素の id 。 |
リクエスト
curl -X GET \
https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b/origin \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H "Content-Type: application/vnd.api+json" \
-H 'Accept: application/vnd.api+json;revision=1'
応答
正常な応答は、指定されたデータ要素の接触チャネルの詳細を返します。
{
"data": {
"id": "DE790cb76f91594c2082a727b9f97024f6",
"type": "data_elements",
"attributes": {
"created_at": "2020-12-14T17:37:19.891Z",
"deleted_at": null,
"dirty": false,
"enabled": true,
"name": "My Data Element 2020-12-14 17:37:19 +0000",
"published": false,
"published_at": null,
"revision_number": 0,
"updated_at": "2020-12-14T17:37:19.891Z",
"clean_text": false,
"default_value": null,
"delegate_descriptor_id": "kessel-test::dataElements::dom-attribute",
"force_lower_case": false,
"review_status": "unsubmitted",
"storage_duration": null,
"settings": "{\"elementProperty\":\"html\",\"elementSelector\":\".target-element\"}"
},
"relationships": {
"libraries": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE790cb76f91594c2082a727b9f97024f6/libraries"
}
},
"revisions": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE790cb76f91594c2082a727b9f97024f6/revisions"
}
},
"notes": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE790cb76f91594c2082a727b9f97024f6/notes"
}
},
"property": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE790cb76f91594c2082a727b9f97024f6/property"
},
"data": {
"id": "PRf1ac400fb1e04c689e28d5efcd675c94",
"type": "properties"
}
},
"origin": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE790cb76f91594c2082a727b9f97024f6/origin"
},
"data": {
"id": "DE790cb76f91594c2082a727b9f97024f6",
"type": "data_elements"
}
},
"extension": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE790cb76f91594c2082a727b9f97024f6/extension"
},
"data": {
"id": "EX2345dba2c8b34d1cbe2795e29c62bf27",
"type": "extensions"
}
},
"updated_with_extension_package": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE790cb76f91594c2082a727b9f97024f6/updated_with_extension_package"
},
"data": {
"id": "EP75db2452065b44e2b8a38ca883ce369a",
"type": "extension_packages"
}
},
"updated_with_extension": {
"links": {
"related": "https://reactor.adobe.io/data_elements/DE790cb76f91594c2082a727b9f97024f6/updated_with_extension"
},
"data": {
"id": "EXad7ebb72d721478483b741eebfffda6a",
"type": "extensions"
}
}
},
"links": {
"property": "https://reactor.adobe.io/properties/PRf1ac400fb1e04c689e28d5efcd675c94",
"origin": "https://reactor.adobe.io/data_elements/DE790cb76f91594c2082a727b9f97024f6",
"self": "https://reactor.adobe.io/data_elements/DE790cb76f91594c2082a727b9f97024f6",
"extension": "https://reactor.adobe.io/extensions/EX2345dba2c8b34d1cbe2795e29c62bf27"
},
"meta": {
"latest_revision_number": 1
}
}
}
GET リクエストのパスに /property
を追加することで、データ要素を所有するプロパティを検索できます。
API 形式
GET /data_elements/{DATA_ELEMENT_ID}/property
パラメーター | 説明 |
---|---|
{DATA_ELEMENT_ID} |
プロパティを検索するデータ要素の id 。 |
リクエスト
curl -X GET \
https://reactor.adobe.io/data_elements/DE3fab176ccf8641838b3da59f716fc42b/property \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H "Content-Type: application/vnd.api+json" \
-H 'Accept: application/vnd.api+json;revision=1'
応答
応答が成功すると、指定されたデータ要素を所有するプロパティの詳細が返されます。
{
"data": {
"id": "PRae9440b0f3234c4286569485f2b7a6a2",
"type": "properties",
"attributes": {
"created_at": "2020-12-14T17:52:40.829Z",
"enabled": true,
"name": "Kessel Example Property",
"updated_at": "2020-12-14T17:52:40.829Z",
"platform": "web",
"development": false,
"token": "42daac072e1e",
"domains": [
"example.com"
],
"undefined_vars_return_empty": false,
"rule_component_sequencing_enabled": false
},
"relationships": {
"company": {
"links": {
"related": "https://reactor.adobe.io/properties/PRae9440b0f3234c4286569485f2b7a6a2/company"
},
"data": {
"id": "CO2bf094214ffd4785bb4bcf88c952a7c1",
"type": "companies"
}
},
"callbacks": {
"links": {
"related": "https://reactor.adobe.io/properties/PRae9440b0f3234c4286569485f2b7a6a2/callbacks"
}
},
"hosts": {
"links": {
"related": "https://reactor.adobe.io/properties/PRae9440b0f3234c4286569485f2b7a6a2/hosts"
}
},
"environments": {
"links": {
"related": "https://reactor.adobe.io/properties/PRae9440b0f3234c4286569485f2b7a6a2/environments"
}
},
"libraries": {
"links": {
"related": "https://reactor.adobe.io/properties/PRae9440b0f3234c4286569485f2b7a6a2/libraries"
}
},
"data_elements": {
"links": {
"related": "https://reactor.adobe.io/properties/PRae9440b0f3234c4286569485f2b7a6a2/data_elements"
}
},
"extensions": {
"links": {
"related": "https://reactor.adobe.io/properties/PRae9440b0f3234c4286569485f2b7a6a2/extensions"
}
},
"rules": {
"links": {
"related": "https://reactor.adobe.io/properties/PRae9440b0f3234c4286569485f2b7a6a2/rules"
}
},
"notes": {
"links": {
"related": "https://reactor.adobe.io/properties/PRae9440b0f3234c4286569485f2b7a6a2/notes"
}
}
},
"links": {
"company": "https://reactor.adobe.io/companies/CO2bf094214ffd4785bb4bcf88c952a7c1",
"data_elements": "https://reactor.adobe.io/properties/PRae9440b0f3234c4286569485f2b7a6a2/data_elements",
"environments": "https://reactor.adobe.io/properties/PRae9440b0f3234c4286569485f2b7a6a2/environments",
"extensions": "https://reactor.adobe.io/properties/PRae9440b0f3234c4286569485f2b7a6a2/extensions",
"rules": "https://reactor.adobe.io/properties/PRae9440b0f3234c4286569485f2b7a6a2/rules",
"self": "https://reactor.adobe.io/properties/PRae9440b0f3234c4286569485f2b7a6a2"
},
"meta": {
"rights": [
"approve",
"develop",
"manage_environments",
"manage_extensions",
"publish"
]
}
}
}