Las etiquetas permiten organizar y ordenar mejor las ofertas. Por ejemplo, puede etiquetar las ofertas del Black Friday con la etiqueta "Black Friday". A continuación, puede utilizar la funcionalidad de búsqueda de la Biblioteca de ofertas para localizar fácilmente todas las ofertas con esa etiqueta.
Las etiquetas también se pueden usar para agrupar ofertas en colecciones. Para obtener más información, consulte el tutorial sobre creación de colecciones.
Puede ver una lista de todas las etiquetas dentro de un contenedor realizando una única solicitud de GET al Offer Library API.
Formato de API
GET /{ENDPOINT_PATH}/{CONTAINER_ID}/queries/core/search?schema={SCHEMA_TAG}&{QUERY_PARAMS}
Parámetro | Descripción | Ejemplo |
---|---|---|
{ENDPOINT_PATH} |
Ruta de extremo para las API del repositorio. | https://platform.adobe.io/data/core/xcore/ |
{CONTAINER_ID} |
Contenedor donde se encuentran las etiquetas. | e0bd8463-0913-4ca1-bd84-6309134ca1f6 |
{SCHEMA_TAG} |
Define el esquema asociado a las etiquetas. | https://ns.adobe.com/experience/offer-management/tag;version=0.1 |
{QUERY_PARAMS} |
Parámetros de consulta opcionales para filtrar los resultados por. | limit=2 |
Solicitud
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}'
Puede utilizar parámetros de consulta para filtrar los resultados y la página cuando enumere recursos.
Los parámetros de consulta más comunes para la paginación incluyen:
Parámetro | Descripción | Ejemplo |
---|---|---|
q |
Una cadena de consulta opcional para buscar en los campos seleccionados. La cadena de consulta debe estar en minúscula y puede estar rodeada de comillas dobles para evitar que se la toquee y para que escape de caracteres especiales. Los caracteres `+ - = && | |
qop |
Aplica el operador AND u OR a los valores del parámetro de cadena de consulta q. | AND / OR |
field |
Lista opcional de campos a los que limitar la búsqueda. Este parámetro se puede repetir de esta manera: field=field1[,campo=campo2,…] y (las expresiones de ruta están en forma de rutas separadas por puntos como _instance.xdm:name) | _instance.xdm:name |
orderBy |
Ordene los resultados por una propiedad específica. Adición de un - antes del título (orderby=-title ) ordenará los elementos por título en orden descendente (Z-A). |
-repo:createdDate |
limit |
Limite el número de etiquetas devueltas. | limit=5 |
Respuesta
Una respuesta correcta devuelve una lista de etiquetas que están presentes dentro del contenedor al que tiene acceso.
{
"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"
}
}
}