2.1.8 API voor Query Service
Doelstelling
- Gebruik de API van de Dienst van de Vraag om vraagmalplaatjes en vraagprogramma's te beheren
Context
In deze oefening zult u API vraag uitvoeren om vraagmalplaatjes en vraagprogramma's te beheren gebruikend een inzameling van Postman. U zult vraagmalplaatjes bepalen, regelmatige vragen en vragen CTAS uitvoeren. A CTAS vraag (creeer lijst als uitgezochte vraag) slaat zijn resultaatreeks in een expliciete dataset op. Terwijl de regelmatige vragen in een impliciete (of systeem geproduceerde) dataset worden opgeslagen, die typisch in parketdossierformaat wordt uitgevoerd.
Documentatie
Query Service-API
Met de API voor zoekdiensten kunt u niet-interactieve query's beheren op het Adobe Experience Platform-datumpeer.
Niet-interactief betekent dat een verzoek om een query uit te voeren niet resulteert in een directe reactie. De vraag zal worden verwerkt en zijn resultaatreeks zal in een impliciete of expliciete (CTAS: creeer lijst zoals uitgezochte) dataset worden opgeslagen.
Voorbeeldquery
Als steekproefvraag zult u de eerste vraag gebruiken die in wordt vermeld 4.3 - Vragen, vragen, vragen… en koordanalyse :
Hoeveel productweergaven hebben we dagelijks?
SQL
select date_format( timestamp , 'yyyy-MM-dd') AS Day,
count(*) AS productViews
from demo_system_event_dataset_for_website_global_v1_1
where --aepTenantId--.demoEnvironment.brandName IN ('Citi Signal')
and eventType = 'commerce.productViews'
group by Day
limit 10;
Zoekopdrachten
Open Postman op uw computer. Als deel van Module 2.1, creeerde u een milieu van Postman en importeerde een inzameling van Postman. Volg de instructies in Uitoefening 2.1.3 voor het geval u dat nog niet hebt gedaan.
Als deel van de inzameling van Postman u invoerde, zult u een omslag zien. De Dienst van de vraag. Als u deze omslag niet ziet, gelieve de inzameling van Postman opnieuw te downloaden en die inzameling in Postman opnieuw in te voeren zoals die in oefening 2.1.3 wordt geïnstrueerd.
Open die map en ken de API-aanroepen van Query Service om de query-resultset uit te voeren, te controleren en te downloaden.
Een POST vraag aan [/query/query ] met de volgende nuttige lading zal de uitvoering van onze vraag teweegbrengen;
Query maken
Klik op het verzoek genoemd 1.1 QS - creeer Vraag en ga naar Kopballen. U zult dan dit zien:
Laten we ons richten op dit headerveld:
--aepSandboxName----aepSandboxName--.Ga de sectie van het Lichaam van dit verzoek. In het Lichaam van dit verzoek, zult u het volgende zien:
{
"name" : "ldap - QS API demo - Citi Signal - Product Views Per Day",
"description": "ldap - QS API demo - Citi Signal - Product Views Per Day",
"dbName": "--aepSandboxName--:all",
"sql": "select date_format( timestamp , 'yyyy-MM-dd') AS Day, count(*) AS productViews from demo_system_event_dataset_for_website_global_v1_1 where --aepTenantId--.demoEnvironment.brandName IN ('Citi Signal') and eventType = 'commerce.productViews' group by Day limit 10"
}
Aandacht: gelieve veranderlijke naam in het hieronder verzoek bij te werken door ldap met uw specifiek te vervangen—aepUserLDAP—.
Na het toevoegen van uw specifieke ldap, zou het Lichaam aan dit gelijkaardig moeten kijken:
{
"name" : "vangeluw - QS API demo - Citi Signal - Product Views Per Day",
"description": "vangeluw - QS API demo - Citi Signal - Product Views Per Day",
"dbName": "tech-insiders:all",
"sql": "select date_format( timestamp , 'yyyy-MM-dd') AS Day, count(*) AS productViews from demo_system_event_dataset_for_website_global_v1_1 where _experienceplatform.demoEnvironment.brandName IN ('Citi Signal') and eventType = 'commerce.productViews' group by Day limit 10"
}
Daarna, klik het blauwe verzenden knoop om het segment tot stand te brengen en de resultaten van dat te bekijken.
Wanneer de POST-aanvraag succesvol is, wordt de volgende reactie geretourneerd:
{
"isInsertInto": false,
"request": {
"dbName": "module7:all",
"sql": "select date_format( timestamp , 'yyyy-MM-dd') AS Day, count(*) AS productViews from demo_system_event_dataset_for_website_global_v1_1 where _experienceplatform.demoEnvironment.brandName IN ('Luma Telco', 'Citi Signal') and eventType = 'commerce.productViews' group by Day limit 10",
"name": "vangeluw - QS API demo - Citi Signal - Product Views Per Day",
"description": "vangeluw - QS API demo - Citi Signal - Product Views Per Day"
},
"clientId": "5a143b5ae4aa4631a1f3b09cd051333f",
"state": "SUBMITTED",
"rowCount": 0,
"errors": [],
"isCTAS": false,
"version": 1,
"id": "8f0d7f25-f7aa-493b-9792-290f884a7e5b",
"elapsedTime": 0,
"updated": "2021-01-20T13:23:13.951Z",
"client": "API",
"userId": "A3392DB95FFF08EE0A495E87@techacct.adobe.com",
"created": "2021-01-20T13:23:13.951Z",
"_links": {
"self": {
"href": "https://platform-va7.adobe.io/data/foundation/query/queries/8f0d7f25-f7aa-493b-9792-290f884a7e5b",
"method": "GET"
},
"soft_delete": {
"href": "https://platform-va7.adobe.io/data/foundation/query/queries/8f0d7f25-f7aa-493b-9792-290f884a7e5b",
"method": "PATCH",
"body": "{ \"op\": \"soft_delete\"}"
},
"cancel": {
"href": "https://platform-va7.adobe.io/data/foundation/query/queries/8f0d7f25-f7aa-493b-9792-290f884a7e5b",
"method": "PATCH",
"body": "{ \"op\": \"cancel\"}"
}
}
}
De huidige staat van de vraag wordt VERZONDEN, zodra uitgevoerd zal zijn staat SUCCESS worden.
U kunt voorgelegde vragen via Adobe Experience Platform UI ook zoeken, Adobe Experience Platform openen, aan Vragen navigeren, aan Logboek en uw vraag selecteren:
Zoekopdrachten ophalen
Klik op het verzoek genoemd 1.2 QS - krijg Vragen en ga naar Kopballen. U zult dan dit zien:
Laten we ons richten op dit headerveld:
--aepSandboxName----aepSandboxName--.Ga naar Params. U zult dan dit zien:
De orde parameter staat u toe om een soortorde te specificeren die op het wordt gebaseerd gecreeerd bezit. Merk "- teken vóór gecreeerd, zo betekent het dat de orde waarin de lijst van vragen is teruggekeerd hun gecreeerde datum in dalende orde zal gebruiken. De query moet boven aan de lijst staan.
Daarna, klik het blauwe verzenden knoop om het segment tot stand te brengen en de resultaten van dat te bekijken.
Wanneer de aanvraag succesvol is, wordt een vergelijkbare reactie als hieronder gegeven. De staat van de reactie kan , IN_PROGRESS of SUCCESS worden VERZONDEN. Het kan verscheidene notulen nemen alvorens de vraag a SUCCESS staat heeft. U kunt het verzenden van dit verzoek verscheidene tijden herhalen, tot u de SUCCESS staat ziet.
{
"queries": [
{
"isInsertInto": false,
"sessionType": "HTTP_SESSION",
"request": {
"dbName": "tech-insiders:all",
"sql": "select date_format( timestamp , 'yyyy-MM-dd') AS Day, count(*) AS productViews from demo_system_event_dataset_for_website_global_v1_1 where _experienceplatform.demoEnvironment.brandName IN ('Citi Signal') and eventType = 'commerce.productViews' group by Day limit 10",
"name": "vangeluw - QS API demo - Citi Signal - Product Views Per Day",
"description": "vangeluw - QS API demo - Citi Signal - Product Views Per Day"
},
"computeMetrics": null,
"clientId": "b7d8a1fc396242889bb31dc83644e91d",
"state": "IN_PROGRESS",
"rowCount": 0,
"isService": false,
"errors": [],
"isCTAS": false,
"version": 1,
"id": "a535234e-dc0c-42ea-bcad-eb09c5997d76",
"elapsedTime": 8088,
"updated": "2024-12-04T14:17:10.627Z",
"client": "API",
"effectiveSQL": "select date_format( timestamp , 'yyyy-MM-dd') AS Day, count(*) AS productViews from demo_system_event_dataset_for_website_global_v1_1 where _experienceplatform.demoEnvironment.brandName IN ('Citi Signal') and eventType = 'commerce.productViews' group by Day limit 10",
"userId": "8CD31E54673C49EE0A495E05@techacct.adobe.com",
"isParentLevel": true,
"created": "2024-12-04T14:14:22.637Z",
"version": 1,
"_links": {
"next": {
"href": "https://platform-va7.adobe.io/data/foundation/query/queries?orderby=-created&start=2024-11-22T00:32:04.505Z"
},
"prev": {
"href": "https://platform-va7.adobe.io/data/foundation/query/queries?orderby=-created&start=2024-12-04T14:14:22.637Z&isPrevLink=true"
}
}
}
Wanneer de staat SUCCESS is, gelieve met het volgende verzoek verder te gaan.
Zoekstatus ophalen
Klik op het verzoek genoemd 1.3 QS - krijg de Status van de Vraag en ga naar Kopballen. U zult dan dit zien:
Laten we ons richten op dit headerveld:
--aepSandboxName----aepSandboxName--.Daarna, klik het blauwe verzenden knoop om het segment tot stand te brengen en de resultaten van dat te bekijken.
Wanneer de aanvraag succesvol is, wordt een vergelijkbare reactie als hieronder gegeven.
{
"isInsertInto": false,
"sessionType": "HTTP_SESSION",
"request": {
"dbName": "tech-insiders:all",
"sql": "select date_format( timestamp , 'yyyy-MM-dd') AS Day, count(*) AS productViews from demo_system_event_dataset_for_website_global_v1_1 where _experienceplatform.demoEnvironment.brandName IN ('Citi Signal') and eventType = 'commerce.productViews' group by Day limit 10",
"name": "vangeluw - QS API demo - Citi Signal - Product Views Per Day",
"description": "vangeluw - QS API demo - Citi Signal - Product Views Per Day"
},
"computeMetrics": {
"executorVMSeconds": 138,
"clusterCpuSeconds": 3312,
"clusterVMHours": 0.07666666805744171,
"driverVMSeconds": 138,
"clusterVMSeconds": 276
},
"clientId": "b7d8a1fc396242889bb31dc83644e91d",
"state": "SUCCESS",
"rowCount": 1,
"isService": false,
"errors": [],
"isCTAS": false,
"version": 1,
"id": "a535234e-dc0c-42ea-bcad-eb09c5997d76",
"elapsedTime": 199219,
"updated": "2024-12-04T14:17:41.856Z",
"client": "API",
"effectiveSQL": "select date_format( timestamp , 'yyyy-MM-dd') AS Day, count(*) AS productViews from demo_system_event_dataset_for_website_global_v1_1 where _experienceplatform.demoEnvironment.brandName IN ('Citi Signal') and eventType = 'commerce.productViews' group by Day limit 10",
"userId": "8CD31E54673C49EE0A495E05@techacct.adobe.com",
"isParentLevel": true,
"created": "2024-12-04T14:14:22.637Z",
"_links": {
"self": {
"href": "https://platform-va7.adobe.io/data/foundation/query/queries/a535234e-dc0c-42ea-bcad-eb09c5997d76",
"method": "GET"
},
"soft_delete": {
"href": "https://platform-va7.adobe.io/data/foundation/query/queries/a535234e-dc0c-42ea-bcad-eb09c5997d76",
"method": "PATCH",
"body": "{ \"op\": \"soft_delete\"}"
},
"referenced_datasets": [
{
"id": "672a10b1074ceb2af0aa7034",
"href": "https://platform-va7.adobe.io/data/foundation/catalog/dataSets/672a10b1074ceb2af0aa7034"
}
]
}
}
Wanneer een vraag de staat van SUCCESS bereikt, zal de reactie ook op het aantal rijen wijzen die door de vraag via het worden teruggewonnen rowCount bezit. In ons voorbeeld worden 10 rijen geretourneerd door de query. Laten we in de volgende sectie zien hoe we de 10 rijen kunnen ophalen.
Zoekresultaat ophalen
De SUCCESS reactie hierboven omvat a referenced_datasets bezit, dat aan de impliciete dataset richt die het vraagresultaat opslaat. Om toegang tot het resultaat te krijgen, gebruiken wij zijn href of identiteitskaart bezit.
Klik op het verzoek genoemd 1.4 QS - krijg het Resultaat van de Vraag en ga naar Kopballen. U zult dan dit zien:
Laten we ons richten op dit headerveld:
--aepSandboxName----aepSandboxName--.Daarna, klik het blauwe verzenden knoop om het segment tot stand te brengen en de resultaten van dat te bekijken.
Het antwoord op dit verzoek zal naar de datasetdossiers richten:
{
"672a10b1074ceb2af0aa7034": {
"name": "Demo System - Event Dataset for Website (Global v1.1)",
"description": "Demo System - Event Dataset for Website (Global v1.1)",
"enableErrorDiagnostics": false,
"tags": {
"adobe/siphon/partition/definition": [
"day(timestamp, _ACP_DATE)",
"identity(_ACP_BATCHID)"
],
"adobe/siphon/meta": [
"acpBufferedFlag::false"
],
"aep/siphon/partitions": [
"_ACP_DATE",
"_ACP_BATCHID"
],
"acp_granular_plugin_validation_flags": [
"identity:enabled",
"profile:disabled"
],
"adobe/pqs/table": [
"demo_system_event_dataset_for_website_global_v1_1"
],
"acp_granular_validation_flags": [
"requiredFieldCheck:enabled"
],
"aep/siphon/cleanup/trash/timestamp": [
"1733302532212"
],
"acp_validationContext": [
"enabled"
],
"adobe/siphon/table/format": [
"delta"
],
"unifiedProfile": [
"enabled:true",
"enabledAt:2024-11-05 12:33:59"
],
"aep/siphon/cleanup/meta/timestamp": [
"1733302532287"
],
"unifiedIdentity": [
"enabled:true"
]
},
"state": "ACTIVE",
"imsOrg": "907075E95BF479EC0A495C73@AdobeOrg",
"sandboxId": "79e3c8b2-0609-4564-a3c8-b20609a5648c",
"extensions": {
"adobe_lakeHouse": {
"metrics": {
"storageSize": 810709,
"rowCount": 1141,
"asOf": 1732494676514
}
},
"adobe_unifiedProfile": {}
},
"version": "1.0.21",
"created": 1730810034023,
"updated": 1733302532348,
"createdClient": "d75039d36ca543c78612f7aac18e6c2b",
"createdUser": "53FB1E5E66CDC87D0A495FC0@techacct.adobe.com",
"updatedUser": "acp_foundation_dataTracker@AdobeID",
"classification": {
"dataBehavior": "time-series",
"managedBy": "CUSTOMER"
},
"viewId": "672a10b2074ceb2af0aa7035",
"fileDescription": {
"format": "parquet"
},
"files": "@/dataSetFiles?dataSetId=672a10b1074ceb2af0aa7034",
"schemaRef": {
"id": "https://ns.adobe.com/experienceplatform/schemas/d9b88a044ad96154637965a97ed63c7b20bdf2ab3b4f642e",
"contentType": "application/vnd.adobe.xed-full+json;version=1"
}
}
}
Volgende stappen
Ga naar Samenvatting en voordelen
Ga terug naar Dienst van de Vraag
Ga terug naar Alle modules