決定包含通知選擇要約的邏輯。
通過對容器執行單個GET請求,可以查看容器內所有決策的清單 Offer Library API。
API格式
GET /{ENDPOINT_PATH}/{CONTAINER_ID}/queries/core/search?schema={SCHEMA_ACTIVITIES}&{QUERY_PARAMS}
參數 | 說明 | 範例 |
---|---|---|
{ENDPOINT_PATH} |
儲存庫API的終結點路徑。 | https://platform.adobe.io/data/core/xcore/ |
{CONTAINER_ID} |
決策所在的容器。 | e0bd8463-0913-4ca1-bd84-6309134ca1f6 |
{SCHEMA_ACTIVITIES} |
定義與決策關聯的架構。 | https://ns.adobe.com/experience/offer-management/offer-activity;version=0.5 |
{QUERY_PARAMS} |
用於篩選結果的可選查詢參數。 | limit=2 |
要求
curl -X GET \
'https://platform.adobe.io/data/core/xcore/e0bd8463-0913-4ca1-bd84-6309134ca1f6/queries/core/search?schema=https://ns.adobe.com/experience/offer-management/offer-activity;version=0.5&limit=2' \
-H 'Accept: *,application/vnd.adobe.platform.xcore.hal+json; schema="https://ns.adobe.com/experience/xcore/hal/results"' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
在列出資源時,可以使用查詢參數來頁面和篩選結果。
用於分頁的最常見的查詢參數包括:
參數 | 說明 | 範例 |
---|---|---|
q |
要在所選欄位中搜索的可選查詢字串。 查詢字串應為小寫,並且可以用雙引號環繞,以防止其被標籤化並轉義特殊字元。 字元 `+ - = && | |
qop |
將AND或OR運算子應用於q查詢字串參數中的值。 | AND / OR |
field |
將搜索限制為的欄位的可選清單。 此參數可以重複,如下所示:欄位=欄位1[,field=field2,…] 和(路徑表達式採用點分隔路徑的形式,如_instance.xdm:name) | _instance.xdm:name |
orderBy |
按特定屬性對結果排序。 添加 - 前標題(B)orderby=-title )將按標題按降序(Z-A)排序。 |
-repo:createdDate |
limit |
限制返回的決定數。 | limit=5 |
回應
成功的響應將返回您有權訪問的容器中存在的決策清單。
{
"containerId": "e0bd8463-0913-4ca1-bd84-6309134ca1f6",
"schemaNs": "https://ns.adobe.com/experience/offer-management/offer-activity;version=0.5",
"requestTime": "2020-10-21T22:38:32.838180Z",
"_embedded": {
"results": [
{
"instanceId": "286f6f80-026b-11eb-9439-ad36e372cbf1",
"schemas": [
"https://ns.adobe.com/experience/offer-management/offer-activity;version=0.5"
],
"productContexts": [
"acp"
],
"repo:etag": 5,
"repo:createdDate": "2020-09-29T15:48:02.808677Z",
"repo:lastModifiedDate": "2020-10-15T15:49:26.673560Z",
"repo:createdBy": "{CREATED_BY}",
"repo:lastModifiedBy": "{MODIFIED_BY}",
"repo:createdByClientId": "{CREATED_CLIENT_ID}",
"repo:lastModifiedByClientId": "{MODIFIED_CLIENT_ID}",
"_instance": {
"xdm:fallback": "xcore:fallback-offer:1233160780eaa2ef",
"xdm:name": "A2: Cross Channel Activity",
"xdm:endDate": "2020-10-09T07:00:00.000Z",
"xdm:startDate": "2020-09-29T07:00:00.000Z",
"xdm:status": "live",
"xdm:criteria": [
{
"xdm:placements": [
"xcore:offer-placement:122204529514a2c0"
],
"xdm:optionSelection": {
"xdm:filter": "xcore:offer-filter:122a120f234dac7f"
}
},
{
"xdm:placements": [
"xcore:offer-placement:122201b2150d98c2"
],
"xdm:optionSelection": {
"xdm:filter": "xcore:offer-filter:1222058c3f0d98de"
}
}
],
"@id": "xcore:offer-activity:12317fe6aeec9330"
},
"_links": {
"self": {
"name": "https://ns.adobe.com/experience/offer-management/offer-activity;version=0.5#286f6f80-026b-11eb-9439-ad36e372cbf1",
"href": "/e0bd8463-0913-4ca1-bd84-6309134ca1f6/instances/286f6f80-026b-11eb-9439-ad36e372cbf1",
"@type": "https://ns.adobe.com/experience/offer-management/offer-activity;version=0.5"
}
},
"sandboxName": "ode-prod-va7-edge-testing"
},
{
"instanceId": "4e0206d0-0e6a-11eb-884a-c1a1104e3d7d",
"schemas": [
"https://ns.adobe.com/experience/offer-management/offer-activity;version=0.5"
],
"productContexts": [
"acp"
],
"repo:etag": 1,
"repo:createdDate": "2020-10-14T22:12:10.300775Z",
"repo:lastModifiedDate": "2020-10-14T22:12:10.300775Z",
"repo:createdBy": "{CREATED_BY}",
"repo:lastModifiedBy": "{MODIFIED_BY}",
"repo:createdByClientId": "{CREATED_CLIENT_ID}",
"repo:lastModifiedByClientId": "{MODIFIED_CLIENT_ID}",
"_instance": {
"xdm:fallback": "xcore:fallback-offer:1233160780eaa2ef",
"xdm:name": "LBAR",
"xdm:endDate": "2021-02-28T08:00:00.000Z",
"xdm:startDate": "2020-10-14T07:00:00.000Z",
"xdm:status": "live",
"xdm:criteria": [
{
"xdm:placements": [
"xcore:offer-placement:122204529514a2c0"
],
"xdm:optionSelection": {
"xdm:filter": "xcore:offer-filter:122a120f234dac7f"
}
}
],
"@id": "xcore:offer-activity:124527ab00b2ebbc"
},
"_links": {
"self": {
"name": "https://ns.adobe.com/experience/offer-management/offer-activity;version=0.5#4e0206d0-0e6a-11eb-884a-c1a1104e3d7d",
"href": "/e0bd8463-0913-4ca1-bd84-6309134ca1f6/instances/4e0206d0-0e6a-11eb-884a-c1a1104e3d7d",
"@type": "https://ns.adobe.com/experience/offer-management/offer-activity;version=0.5"
}
},
"sandboxName": "ode-prod-va7-edge-testing"
}
],
"total": 7,
"count": 2
},
"_links": {
"self": {
"href": "/e0bd8463-0913-4ca1-bd84-6309134ca1f6/queries/core/search?schema=https://ns.adobe.com/experience/offer-management/offer-activity;version=0.5&limit=2",
"@type": "https://ns.adobe.com/experience/xcore/hal/results"
},
"next": {
"href": "/e0bd8463-0913-4ca1-bd84-6309134ca1f6/queries/core/search?start=4e0206d0-0e6a-11eb-884a-c1a1104e3d7d&orderby=instanceId&schema=https://ns.adobe.com/experience/offer-management/offer-activity;version=0.5&limit=2",
"@type": "https://ns.adobe.com/experience/xcore/hal/results"
}
}
}