Aanvullende bewerkingen additional-operations
Sorteren sorting
Sorteren is standaard in oplopende volgorde beschikbaar. Om in dalende orde te sorteren, voeg %20desc aan de _order waarde van de parameter toe.
Als u wilt weten of een veld kan worden gesorteerd, controleert u de parameter "sortable" in de metagegevens van de bron. Raadpleeg deze sectie voor meer informatie.
verzoeken van de Steekproef
-
Voorbeeld van een GET-aanvraag om e-mailberichten op te halen in de database in alfabetische volgorde.
code language-none -X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/profile/email?_order=email \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Cache-Control: no-cache' \ -H 'X-Api-Key: <API_KEY>'Antwoord op het verzoek.
code language-none { "content": [ "adam@email.com", "allison.durance@example.com", "amy.dakota@mail.com", "andrea.johnson@mail.com", ... ] ... } -
Voorbeeld van een GET-aanvraag om de e-mail in de database op te halen in aflopende alfavolgorde.
code language-none -X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/profile/email?_order=email%20desc \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Cache-Control: no-cache' \ -H 'X-Api-Key: <API_KEY>'Antwoord op het verzoek.
code language-none { "content": [ "tombinder@example.com", "tombinder@example.com", "timross@example.com", "john.smith@example.com", ... ] }
Filteren filtering
Metagegevens van filters ophalen
Filters zijn beschikbaar voor elke bron. Om de filters te identificeren verbonden aan een middel, moet u een verzoek van GET op de middelmeta-gegevens uitvoeren. Dit verzoek retourneert de URL waar alle filters zijn gedefinieerd voor een bepaalde bron. Voor meer op meta-gegevens, verwijs naar deze sectie .
Om de meta-gegevens van een filter te identificeren en te bepalen hoe te om het te gebruiken, moet u een GET verzoek op eerder teruggekeerde URL uitvoeren.
verzoek van de Steekproef
In de onderstaande voorbeeldladingen ziet u hoe u de metagegevens van de "byText"-filter voor de "profile"-bron ophaalt. Voer eerst een GET-aanvraag uit op de metada van de resource "profile".
-X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/resourceType/profile \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>'
De URL waar de filters worden beschreven, wordt geretourneerd.
{
"filters": {
"href": "https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/resourceType/<PKEY>/filters/"
}
}
Voer een GET-aanvraag uit op de URL. De lijst met filters voor de profielbron wordt geretourneerd, met de metagegevens die aan elk filter zijn gekoppeld.
{
"birthday": {
"PKey": "@FL-CbDFXbnHbXcVpeCGWL46VXJLn1LqxLMPagt2vz8sCxQ52lvB15KiUaxXkxJYQw-tZXYrgUWG6K8QcB4gxVY9RKoba5bRFY3294YFshDmorRr8",
"category": "0150_profile",
"condition": ...,
"data": "https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/profile/birthday?type=$value&precision=$value&operator=$value&day=$value&month=$value&includeStart=$value&endDay=$value&endMonth=$value&includeEnd=$value&relativeValue=$value&nextUnitsValue=$value&previousUnitsValue=$value",
"formType": "webPage",
"fragmentName": "",
"label": "Birthday",
}
Metagegevensstructuur filteren
Voor elk filter is dezelfde metagegevensstructuur beschikbaar:
- De velden @formType en @webPage zijn technische velden.
- Het gegevens gebied geeft een steekproef op hoe te om de filter te gebruiken.
- De meta-gegevens knoop beschrijft de filterparameters.
- De voorwaarde knoop beschrijft wat de filter bedoeld is te doen. De filterparameters die in het metagegevensknooppunt worden beschreven, worden gebruikt om filtervoorwaarden te maken. Voor elke filtervoorwaarde, als enabledIf waar is, zal expr worden toegepast.
Voorbeeld van de structuur van filtermetagegevens:
"byText": {
"PKey": "...",
"category": "99_none",
"condition": ...,
"data": "/profileAndServices/profile/byText?text=$value",
"formType": "none",
"fragmentName": "",
"label": "By name or email",
}
Filters gebruiken
Filteren wordt uitgevoerd met het volgende verzoek:
GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/<resourceName>/by<filterName>?<filterParam>=<filterValue>
Het is mogelijk meerdere filters te combineren in één aanvraag:
GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/<resourceName>/<filter1name>/<filter2name>?<filter1param>=<filter1value>&<filter2param>=<filter2value>
verzoeken van de Steekproef
-
Voorbeeld van een GET-aanvraag om de 'service'-bronnen op te halen met het type 'email'.
code language-none -X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/service/byChannel?channel=email \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Cache-Control: no-cache' \ -H 'X-Api-Key: <API_KEY>'Antwoord op het verzoek.
code language-none { "content": [ { "PKey": "<PKEY>", "created": "2019-09-25 23:20:35.000Z", "href": "https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/service/@I_FIiDush4OQPc0mbOVR9USoh36Tt5CsD35lATvQjdWlXrYc0lFkvle2XIwZUbD8GqTVvSp8AfWFUvjkGMe1fPe5nok", "label": "Marketing Newsletter", "lastModified": "2019-09-25 23:20:35.000Z", "limitedDuration": false, "messageType": "email", "mode": "newsletter", ... }, ... ], ... } -
Voorbeeld van een GET-aanvraag om de "profiel"-bronnen met "Doe" op te halen in
de velden voor e-mail- of achternaam (het filter ByText zoekt zowel naar de velden voor e-mail- als achternaam).code language-none -X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/profile/byText?text=Doe \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Cache-Control: no-cache' \ -H 'X-Api-Key: <API_KEY>'Antwoord op het verzoek.
code language-none { "content": [ { "PKey": "<PKEY>", "firstName": "John", "lastName":"Doe", "birthDate": "1980-10-24", ... } ... ], ... } -
Voorbeeld van een GET-aanvraag om de servicemiddelen op te halen met het type "email" en het label "sport".
code language-none -X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/service/byChannel/byText?channel=email&text=sport \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer <ACCESS_TOKEN>' \ -H 'Cache-Control: no-cache' \ -H 'X-Api-Key: <API_KEY>'Antwoord op het verzoek.
code language-none { "content": [ { "PKey": "<PKEY>", "created": "2019-09-26 09:36:01.014Z", "href": "https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/service/<PKEY>", "label": "sport", "lastModified": "2019-09-26 09:36:01.014Z", "limitedDuration": false, "messageType": "email", "mode": "newsletter", "name": "SVC13", ... } ], ... }
Aangepaste filters
Als u een aangepast filter wilt gebruiken, moet u het maken en aanpassen in de Adobe Campaign Standard-interface. Het aangepaste filter heeft dan hetzelfde gedrag als de vervagingsfilters:
GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServicesExt/<resourceName>/by<customFilterName>?<customFilterparam>=<customFilterValue>
Raadpleeg de documentatie bij Campaign Standard voor meer informatie:
verzoek van de Steekproef
Voorbeeld van een GET-aanvraag om de "profile"-bronnen op te halen met transactiebedragen van 100$ of meer. Het filter "byAmount" is eerst gedefinieerd in de Adobe Campaign Standard-interface en gekoppeld aan de aangepaste tabel "Transaction".
-X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServicesExt/profile/byAmount?amount_parameter=100 \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>'
Tellen counting
De Adobe Campaign REST API kan het aantal records in een aanvraag tellen. Om dit te doen, gebruik URL die in de tellings knoop is teruggekeerd.
verzoek van de Steekproef
Om alle diensten te tellen die a messageType waarde die aan "sms"evenaart, een verzoek van GET met de byChannel filter uitvoeren.
-X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/service/byChannel?channel=sms \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>'
Het keert de diensten terug die aan de filter beantwoorden.
{
"content": [
{
...
"messageType": "sms",
"mode": "newsletter",
"name": "SVC6",
...
},
...
],
"count": {
"href": "https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/service/byChannel/_count?channel=sms&_lineStart=@iKTZ2q3IiSEDqZ5Nw1vdoGnQCqF-8DAUJRaVwR9obqqTxhMy"
},
"serverSidePagination": true
}
Voer een verzoek van GET op de telling knoop URL uit om het aantal resultaten terug te winnen.
-X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/service/byChannel/_count?channel=sms&_lineStart=@iKTZ2q3IiSEDqZ5Nw1vdoGnQCqF-8DAUJRaVwR9obqqTxhMy \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>'
Het retourneert het aantal records.
{
"count": 26
}
Paginering pagination
Standaard worden 25 bronnen in een lijst geladen.
Met de parameter _lineCount kunt u het aantal bronnen beperken dat in de reactie wordt vermeld. U kunt de volgende knoop dan gebruiken om de volgende resultaten te tonen.
verzoek van de Steekproef
Voorbeeld van GET-verzoek om 1 record van de profielbron weer te geven.
-X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/profile?_lineCount=1 \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>'
Reactie op het verzoek, met volgende knoop om paginering uit te voeren.
{
"content": [
{
"PKey": "<PKEY>",
"firstName": "John",
"lastName":"Doe",
"birthDate": "1980-10-24",
...
}
],
"next": {
"href": "https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/profile/email?_lineCount=10&_
lineStart=@Qy2MRJCS67PFf8soTf4BzF7BXsq1Gbkp_e5lLj1TbE7HJKqc"
}
...
}
Door gebrek, is de volgende knoop niet beschikbaar wanneer het in wisselwerking staan met lijsten met grote hoeveelheid gegevens. Om paginering uit te kunnen voeren, moet u de _forcePagination=true parameter aan uw vraag URL toevoegen.
-X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/profile?_forcePagination=true \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>'