[舊版]{class="badge informative"}
清單集合 list-collections
TIP
Adobe Journey Optimizer 的新決策功能「決策」現在可透過程式碼型體驗和電子郵件管道使用!了解更多
集合是優惠方案的子集,根據行銷人員定義的預先定義條件,例如優惠方案類別。
您可以對Offer Library API執行單一GET要求,以檢視容器中所有集合的清單。
API格式
GET /{ENDPOINT_PATH}/{CONTAINER_ID}/queries/core/search?schema={SCHEMA_FILTER}&{QUERY_PARAMS}
參數
說明
範例
{ENDPOINT_PATH}存放庫API的端點路徑。
https://platform.adobe.io/data/core/xcore/{QUERY_PARAMS}篩選結果的選用查詢引數。
limit=2{CONTAINER_ID}集合所在的容器。
e0bd8463-0913-4ca1-bd84-6309134ca1f6{SCHEMA_FILTER}{QUERY_PARAMS}篩選結果的選用查詢引數。
limit=1要求
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-filter;version=0.1&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}'
使用查詢引數 using-query-parameters
您可以在列出資源時,使用查詢引數來頁面和篩選結果。
分頁 paging
分頁最常見的查詢引數包括:
參數
說明
範例
q在選取的欄位中搜尋的可選查詢字串。 查詢字串應為小寫,並可由雙引號包圍,以防止加以代碼化及逸出特殊字元。 字元
+ - = && || > < ! ( ) { } [ ] ^ \" ~ * ? : \ /具有特殊意義,在查詢字串中出現時應該以反斜線逸出。demo collectionqop將AND或OR運運算元套用至q查詢字串引數中的值。
AND / ORfield要限制搜尋的選用欄位清單。 此引數可重複使用,如下所示: field=field1[,field=field2,…]和(路徑運算式採用點分隔路徑的形式,例如_instance.xdm:name)
_instance.xdm:nameorderBy依特定屬性排序結果。 在標題(
-)前新增orderby=-title將會依標題以遞減順序(Z-A)排序專案。-repo:createdDatelimit限制傳回的集合數。
limit=5回應
成功的回應會傳回存在於您可存取之容器中的集合清單。
{
"containerId": "e0bd8463-0913-4ca1-bd84-6309134ca1f6",
"schemaNs": "https://ns.adobe.com/experience/offer-management/offer-filter;version=0.1",
"requestTime": "2023-10-21T21:14:19.282175Z",
"_embedded": {
"results": [
{
"instanceId": "27c92e00-127d-11eb-b9fe-5bcfb5d7ef36",
"schemas": [
"https://ns.adobe.com/experience/offer-management/offer-filter;version=0.3"
],
"productContexts": [
"acp"
],
"repo:etag": 1,
"repo:createdDate": "2023-10-20T02:37:11.263718Z",
"repo:lastModifiedDate": "2023-10-20T02:37:11.263718Z",
"repo:createdBy": "{CREATED_BY}",
"repo:lastModifiedBy": "{MODIFIED_BY}",
"repo:createdByClientId": "{CREATED_CLIENT_ID}",
"repo:lastModifiedByClientId": "{MODIFIED_CLIENT_ID}",
"_instance": {
"xdm:ids": [
"xcore:tag:124bd3de7f598dd8"
],
"xdm:name": "Mobile Demo",
"xdm:filterType": "anyTags",
"@id": "xcore:offer-filter:124bd44648f17ec1"
},
"_links": {
"self": {
"name": "https://ns.adobe.com/experience/offer-management/offer-filter;version=0.3#27c92e00-127d-11eb-b9fe-5bcfb5d7ef36",
"href": "/e0bd8463-0913-4ca1-bd84-6309134ca1f6/instances/27c92e00-127d-11eb-b9fe-5bcfb5d7ef36",
"@type": "https://ns.adobe.com/experience/offer-management/offer-filter;version=0.3"
}
},
"sandboxName": "ode-prod-va7-edge-testing"
},
{
"instanceId": "2c54fc90-f8f3-11ea-ad6e-775ad2c9b1a1",
"schemas": [
"https://ns.adobe.com/experience/offer-management/offer-filter;version=0.3"
],
"productContexts": [
"acp"
],
"repo:etag": 1,
"repo:createdDate": "2023-09-17T14:36:29.272451Z",
"repo:lastModifiedDate": "2023-09-17T14:36:29.272451Z",
"repo:createdBy": "{CREATED_BY}",
"repo:lastModifiedBy": "{MODIFIED_BY}",
"repo:createdByClientId": "{CREATED_CLIENT_ID}",
"repo:lastModifiedByClientId": "{MODIFIED_CLIENT_ID}",
"_instance": {
"xdm:ids": [
"xcore:personalized-offer:1221fbedfa4d98b0"
],
"xdm:name": "demo collection",
"xdm:filterType": "offers",
"@id": "xcore:offer-filter:1221fc71c74d98b4"
},
"_links": {
"self": {
"name": "https://ns.adobe.com/experience/offer-management/offer-filter;version=0.3#2c54fc90-f8f3-11ea-ad6e-775ad2c9b1a1",
"href": "/e0bd8463-0913-4ca1-bd84-6309134ca1f6/instances/2c54fc90-f8f3-11ea-ad6e-775ad2c9b1a1",
"@type": "https://ns.adobe.com/experience/offer-management/offer-filter;version=0.3"
}
},
"sandboxName": "ode-prod-va7-edge-testing"
}
],
"total": 8,
"count": 2
},
"_links": {
"self": {
"href": "/e0bd8463-0913-4ca1-bd84-6309134ca1f6/queries/core/search?schema=https://ns.adobe.com/experience/offer-management/offer-filter;version=0.1&limit=2",
"@type": "https://ns.adobe.com/experience/xcore/hal/results"
},
"next": {
"href": "/e0bd8463-0913-4ca1-bd84-6309134ca1f6/queries/core/search?start=2c54fc90-f8f3-11ea-ad6e-775ad2c9b1a1&orderby=instanceId&schema=https://ns.adobe.com/experience/offer-management/offer-filter;version=0.1&limit=2",
"@type": "https://ns.adobe.com/experience/xcore/hal/results"
}
}
}
recommendation-more-help
b22c9c5d-9208-48f4-b874-1cefb8df4d76