收藏集限定符(以前称为“标记”)允许您更好地对优惠进行组织和排序。 例如,您可以使用“黑色星期五”收藏集限定词来标记黑色星期五选件。 然后,您可以使用选件库中的搜索功能,轻松找到包含该收藏集限定符的所有选件。
收藏集限定符也可用于将优惠分组为收藏集。 有关更多信息,请参阅以下教程: 创建收藏集.
您可以通过对容器执行单个GET请求,查看容器中所有收集限定符的列表。 Offer Library API。
API格式
GET /{ENDPOINT_PATH}/{CONTAINER_ID}/queries/core/search?schema={SCHEMA_TAG}&{QUERY_PARAMS}
参数 | 描述 | 示例 |
---|---|---|
{ENDPOINT_PATH} |
存储库API的端点路径。 | https://platform.adobe.io/data/core/xcore/ |
{CONTAINER_ID} |
集合限定符所在的容器。 | e0bd8463-0913-4ca1-bd84-6309134ca1f6 |
{SCHEMA_TAG} |
定义与集合限定符关联的架构。 | https://ns.adobe.com/experience/offer-management/tag;version=0.1 |
{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/tag;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}'
在列出资源时,可以使用查询参数来分页和筛选结果。
分页最常见的查询参数包括:
参数 | 描述 | 示例 |
---|---|---|
q |
在选定字段中搜索的可选查询字符串。 查询字符串应为小写,并且可以用双引号括起来,以防止对其进行标记化并对特殊字符进行转义。 字符 `+ - = && | |
qop |
将AND或OR运算符应用于q查询字符串参数中的值。 | AND / OR |
field |
要限制搜索的可选字段列表。 此参数可重复,如下所示: field=field1[,field=field2,…] 和(路径表达式采用点分隔路径的形式,如_instance.xdm:name) | _instance.xdm:name |
orderBy |
按特定属性对结果进行排序。 添加 - 在标题之前(orderby=-title )将按标题对项目进行降序排序(Z-A)。 |
-repo:createdDate |
limit |
限制返回的集合限定符数。 | limit=5 |
响应
成功响应将返回一个收藏集限定符列表,该列表存在于您有权访问的容器中。
{
"containerId": "e0bd8463-0913-4ca1-bd84-6309134ca1f6",
"schemaNs": "https://ns.adobe.com/experience/offer-management/tag;version=0.1",
"requestTime": "2020-10-21T20:28:21.521267Z",
"_embedded": {
"results": [
{
"instanceId": "0adf2ef0-0f6e-11eb-b3be-9b775f952952",
"schemas": [
"https://ns.adobe.com/experience/offer-management/tag;version=0.1"
],
"productContexts": [
"acp"
],
"repo:etag": 2,
"repo:createdDate": "2020-10-16T05:11:26.815213Z",
"repo:lastModifiedDate": "2020-10-16T22:20:20.190006Z",
"repo:createdBy": "{CREATED_BY}",
"repo:lastModifiedBy": "{MODIFIED_BY}",
"repo:createdByClientId": "{CREATED_CLIENT_ID}",
"repo:lastModifiedByClientId": "{MODIFIED_CLIENT_ID}",
"_instance": {
"xdm:name": "Sneakers",
"@id": "xcore:tag:1246d138ec8cca1f"
},
"_links": {
"self": {
"name": "https://ns.adobe.com/experience/offer-management/tag;version=0.1#0adf2ef0-0f6e-11eb-b3be-9b775f952952",
"href": "/e0bd8463-0913-4ca1-bd84-6309134ca1f6/instances/0adf2ef0-0f6e-11eb-b3be-9b775f952952",
"@type": "https://ns.adobe.com/experience/offer-management/tag;version=0.1"
}
}
},
{
"instanceId": "149e0de0-ff5f-11ea-b017-f98866426d43",
"schemas": [
"https://ns.adobe.com/experience/offer-management/tag;version=0.1"
],
"productContexts": [
"acp"
],
"repo:etag": 1,
"repo:createdDate": "2020-09-25T18:44:02.109748Z",
"repo:lastModifiedDate": "2020-09-25T18:44:02.109748Z",
"repo:createdBy": "{CREATED_BY}",
"repo:lastModifiedBy": "{MODIFIED_BY}",
"repo:createdByClientId": "{CREATED_CLIENT_ID}",
"repo:lastModifiedByClientId": "{MODIFIED_CLIENT_ID}",
"_instance": {
"xdm:name": "retirement",
"@id": "xcore:tag:122c81d2804e69e3"
},
"_links": {
"self": {
"name": "https://ns.adobe.com/experience/offer-management/tag;version=0.1#149e0de0-ff5f-11ea-b017-f98866426d43",
"href": "/e0bd8463-0913-4ca1-bd84-6309134ca1f6/instances/149e0de0-ff5f-11ea-b017-f98866426d43",
"@type": "https://ns.adobe.com/experience/offer-management/tag;version=0.1"
}
},
"sandboxName": "ode-prod-va7-edge-testing"
}
],
"total": 11,
"count": 2
},
"_links": {
"self": {
"href": "/e0bd8463-0913-4ca1-bd84-6309134ca1f6/queries/core/search?schema=https://ns.adobe.com/experience/offer-management/tag;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=149e0de0-ff5f-11ea-b017-f98866426d43&orderby=instanceId&schema=https://ns.adobe.com/experience/offer-management/tag;version=0.1&limit=2",
"@type": "https://ns.adobe.com/experience/xcore/hal/results"
}
}
}