Uso de parâmetros de consulta
Você pode usar parâmetros de consulta para paginar e filtrar resultados ao listar recursos.
Paginação
Os parâmetros de consulta mais comuns para paginação incluem:
| Parâmetro | Descrição | Exemplo |
|---|---|---|
q | Uma sequência de consulta opcional a ser pesquisada nos campos selecionados. A sequência de consulta deve estar em minúsculas e pode estar entre aspas duplas para impedir que seja tokenizada e para evitar caracteres especiais. Os caracteres + - = && || > < ! ( ) { } [ ] ^ \" ~ * ? : \ / têm significado especial e devem ser escapados com uma barra invertida ao serem exibidos na cadeia de caracteres de consulta. | discounted offers |
qop | Aplica o operador AND ou OR a valores no parâmetro de sequência de consulta q. | AND / OR |
field | Lista opcional de campos aos quais limitar a pesquisa. Esse parâmetro pode ser repetido da seguinte maneira: field=field1[,field=field2,…] e (expressões de caminho estão no formato de caminhos separados por pontos, como _instance.xdm:name) | _instance.xdm:name |
orderBy | Classificar os resultados por uma propriedade específica. Adicionar um - antes do título (orderby=-title) classificará os itens por título em ordem decrescente (Z-A). | -repo:createdDate |
limit | Limite o número de ofertas personalizadas retornadas. | limit=5 |
Resposta
Uma resposta bem-sucedida retorna uma lista de ofertas personalizadas que estão presentes no container ao qual você tem acesso.
{
"containerId": "e0bd8463-0913-4ca1-bd84-6309134ca1f6",
"schemaNs": "https://ns.adobe.com/experience/offer-management/personalized-offer;version=0.5",
"requestTime": "2023-10-22T20:36:50.408105Z",
"_embedded": {
"results": [
{
"instanceId": "2cdb4d10-149e-11eb-b1a9-a779d2fe8690",
"schemas": [
"https://ns.adobe.com/experience/offer-management/personalized-offer;version=0.5"
],
"productContexts": [
"acp"
],
"repo:etag": 2,
"repo:createdDate": "2023-10-22T19:38:35.489354Z",
"repo:lastModifiedDate": "2023-10-22T19:45:43.839088Z",
"repo:createdBy": "{CREATED_BY}",
"repo:lastModifiedBy": "{MODIFIED_BY}",
"repo:createdByClientId": "{CREATED_CLIENT_ID}",
"repo:lastModifiedByClientId": "{MODIFIED_CLIENT_ID}",
"_instance": {
"xdm:name": "Checking Advanced",
"xdm:representations": [
{
"xdm:components": [
{
"dc:format": "image/png",
"repo:id": "urn:aaid:sc:US:7db21be9-89ee-472a-b2c9-91f7a39ada51",
"repo:resolveURL": "https://platform-cs-va6.adobe.io/content/storage/id/urn:aaid:sc:US:7db21be9-89ee-472a-b2c9-91f7a39ada51/:rendition;size=300",
"repo:name": "mobile-check-deposit.png",
"dc:language": [
"en-us"
],
"@type": "https://ns.adobe.com/experience/offer-management/content-component-imagelink",
"xdm:deliveryURL": ""
}
],
"xdm:channel": "https://ns.adobe.com/xdm/channel-types/offline",
"xdm:placement": "xcore:offer-placement:124f4e33724bb15f"
},
{
"xdm:components": [
{
"dc:format": "text/html",
"repo:name": "my content",
"dc:language": [
"en-us"
],
"xdm:content": "{\n\"foo\": \"bar\"\n}",
"@type": "https://ns.adobe.com/experience/offer-management/content-component-html"
}
],
"xdm:channel": "https://ns.adobe.com/xdm/channel-types/web",
"xdm:placement": "xcore:offer-placement:124e0be5699743d3"
}
],
"xdm:rank": {
"xdm:priority": 10
},
"xdm:characteristics": {
"PROD": "checking",
"offer_code": "CHECK200",
"region": "NA"
},
"xdm:selectionConstraint": {
"xdm:startDate": "2023-10-22T07:00:00.000Z",
"xdm:endDate": "2023-12-31T08:00:00.000Z",
"xdm:eligibilityRule": "xcore:eligibility-rule:124f4f57259caba5"
},
"xdm:status": "draft",
"xdm:cappingConstraint": {
"xdm:globalCap": 1000
},
"xdm:tags": [
"xcore:tag:124f4e5c8a00cd92",
"xcore:tag:1229cf47455177b1"
],
"@id": "xcore:personalized-offer:124f513c290bb16e"
},
"_links": {
"self": {
"name": "https://ns.adobe.com/experience/offer-management/personalized-offer;version=0.5#2cdb4d10-149e-11eb-b1a9-a779d2fe8690",
"href": "/e0bd8463-0913-4ca1-bd84-6309134ca1f6/instances/2cdb4d10-149e-11eb-b1a9-a779d2fe8690",
"@type": "https://ns.adobe.com/experience/offer-management/personalized-offer;version=0.5"
}
},
"sandboxName": "ode-prod-va7-edge-testing"
}
],
"total": 15,
"count": 1
},
"_links": {
"self": {
"href": "/e0bd8463-0913-4ca1-bd84-6309134ca1f6/queries/core/search?schema=https://ns.adobe.com/experience/offer-management/personalized-offer;version=0.5&orderby=-repo:createdDate&limit=1",
"@type": "https://ns.adobe.com/experience/xcore/hal/results"
},
"next": {
"href": "/e0bd8463-0913-4ca1-bd84-6309134ca1f6/queries/core/search?start=1603395515489%2C2cdb4d10-149e-11eb-b1a9-a779d2fe8690&schema=https://ns.adobe.com/experience/offer-management/personalized-offer;version=0.5&orderby=-repo%3AcreatedDate%2CinstanceId&limit=1",
"@type": "https://ns.adobe.com/experience/xcore/hal/results"
}
}
}
recommendation-more-help