Planningeindpunt

Planningen zijn een hulpmiddel dat kan worden gebruikt om batch-segmentatietaken één keer per dag automatisch uit te voeren. U kunt het /config/schedules eindpunt gebruiken om een lijst van programma's terug te winnen, een nieuw programma tot stand te brengen, details van een specifiek programma terug te winnen, een specifiek programma bij te werken, of een specifiek programma te schrappen.

Aan de slag

De eindpunten die in deze handleiding worden gebruikt, maken deel uit van de API van Adobe Experience Platform Segmentation Service . Alvorens verder te gaan, te herzien gelieve ​ begonnen gids ​ voor belangrijke informatie die u moet kennen om vraag aan API met succes te maken, met inbegrip van vereiste kopballen en hoe te om voorbeeld API vraag te lezen.

Een lijst met schema's ophalen retrieve-list

U kunt een lijst van alle programma's voor uw organisatie terugwinnen door een GET- verzoek aan het /config/schedules eindpunt te doen.

API formaat

Het /config/schedules eindpunt steunt verscheidene vraagparameters helpen uw resultaten filtreren. Hoewel deze parameters optioneel zijn, wordt het gebruik ervan sterk aanbevolen om kostbare overhead te helpen verminderen. Het maken van een vraag aan dit eindpunt zonder parameters zal alle programma's beschikbaar voor uw organisatie terugwinnen. De veelvoudige parameters kunnen worden omvat, die door ampersands (&) worden gescheiden.

GET /config/schedules
GET /config/schedules?{QUERY_PARAMETERS}

de parameters van de Vraag

Verzoek

Het volgende verzoek zal de laatste tien programma's terugwinnen die binnen uw organisatie worden gepost.

curl -X GET https://platform.adobe.io/data/core/ups/config/schedules?limit=10 \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

Reactie

Een succesvolle reactie keert status 200 van HTTP met een lijst van programma's voor de gespecificeerde organisatie als JSON terug.

{
    "_page": {
        "totalCount": 10,
        "pageSize": 1
    },
    "children": [
        {
            "id": "4e538382-dbd8-449e-988a-4ac639ebe72b",
            "imsOrgId": "{ORG_ID}",
            "sandbox": {
                "sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
                "sandboxName": "prod",
                "type": "production",
                "default": true
            },
            "name": "Batch Segmentation",
            "state": "active",
            "type": "batch_segmentation",
            "schedule": "0 0 1 * * ?",
            "properties": {
                "segments": []
            },
            "createEpoch": 1573158851,
            "updateEpoch": 1574365202
        }
    ],
    "_links": {
        "next": {}
    }
}

Een nieuw schema maken create

U kunt een nieuw schema tot stand brengen door een POST- verzoek aan het /config/schedules eindpunt te doen.

API formaat

POST /config/schedules

Verzoek

curl -X POST https://platform.adobe.io/data/core/ups/config/schedules \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'
 -d '
{
    "name":"profile-default",
    "type":"batch_segmentation",
    "properties":{
        "segments":[
            "*"
        ]
    },
    "schedule":"0 0 1 * * ?",
    "state":"inactive"
}'

Reactie

Een succesvolle reactie keert status 200 van HTTP met details van uw onlangs gecreeerd programma terug.

{
    "id": "4e538382-dbd8-449e-988a-4ac639ebe72b",
    "imsOrgId": "{ORG_ID}",
    "sandbox": {
        "sandboxId": "e7e17720-c5bb-11e9-aafb-87c71c35cac8",
        "sandboxName": "prod",
        "type": "production",
        "default": true
    },
    "name": "{SCHEDULE_NAME}",
    "state": "inactive",
    "type": "batch_segmentation",
    "schedule": "0 0 1 * * ?",
    "properties": {
        "segments": [
            "*"
        ]
    },
    "createEpoch": 1568267948,
    "updateEpoch": 1568267948
}

Een specifiek schema ophalen get

U kunt gedetailleerde informatie over een specifiek programma terugwinnen door een GET- verzoek aan het /config/schedules eindpunt te doen en identiteitskaart van het programma te verstrekken u in de verzoekweg wenst terug te winnen.

API formaat

GET /config/schedules/{SCHEDULE_ID}

Verzoek

curl -X GET https://platform.adobe.io/data/core/ups/config/schedules/4e538382-dbd8-449e-988a-4ac639ebe72b
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

Reactie

Een succesvolle reactie keert status 200 van HTTP met gedetailleerde informatie over het gespecificeerde programma terug.

{
    "id": "4e538382-dbd8-449e-988a-4ac639ebe72b",
    "imsOrgId": "{ORG_ID}",
    "sandbox": {
        "sandboxId": "e7e17720-c5bb-11e9-aafb-87c71c35cac8",
        "sandboxName": "prod",
        "type": "production",
        "default": true
    },
    "name": "{SCHEDULE_NAME}",
    "state": "inactive",
    "type": "batch_segmentation",
    "schedule": "0 0 1 * * ?",
    "properties": {
        "segments": [
            "*"
        ]
    },
    "createEpoch": 1568267948,
    "updateEpoch": 1568267948
}

Details bijwerken voor een specifiek schema update

U kunt een specifiek programma bijwerken door een PATCH-aanvraag in te dienen bij het /config/schedules -eindpunt en de id op te geven van het schema dat u probeert bij te werken in het aanvraagpad.

Het verzoek van PATCH staat u toe om of de ​ staat ​ of het ​ bouwplan ​ voor een individueel programma bij te werken.

API formaat

PATCH /config/schedules/{SCHEDULE_ID}

curl -X PATCH https://platform.adobe.io/data/core/ups/config/schedules/4e538382-dbd8-449e-988a-4ac639ebe72b \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'
 -d '
[
    {
        "op": "add",
        "path": "/state",
        "value": "active"
    }
]'

Verzoek

curl -X PATCH https://platform.adobe.io/data/core/ups/config/schedules/4e538382-dbd8-449e-988a-4ac639ebe72b \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'
 -d '
[
    {
        "op":"add",
        "path":"/schedule",
        "value":"0 0 2 * * ?"
    }
]'

Reactie

Een geslaagde reactie retourneert HTTP-status 204 (Geen inhoud).

Een specifiek schema verwijderen

U kunt verzoeken om een specifiek programma te schrappen door een DELETE- verzoek aan het /config/schedules eindpunt te doen en identiteitskaart van het programma te verstrekken u wenst om in de verzoekweg te schrappen.

API formaat

DELETE /config/schedules/{SCHEDULE_ID}

Verzoek

curl -X DELETE https://platform.adobe.io/data/core/ups/config/schedules/4e538382-dbd8-449e-988a-4ac639ebe72b \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

Reactie

Een geslaagde reactie retourneert HTTP-status 204 (Geen inhoud).

Volgende stappen

Na het lezen van deze gids hebt u nu een beter inzicht in hoe de programma's werken.

Bijlage appendix

In de volgende bijlage wordt de notatie van de expressie van een uitsnede beschreven die in de planningen wordt gebruikt.

Indeling

Een uitsnijdexpressie is een tekenreeks die bestaat uit 6 of 7 velden. De expressie ziet er ongeveer als volgt uit:

0 0 12 * * ?

In een expressie-tekenreeks voor een bijsnijden vertegenwoordigt het eerste veld de seconden, het tweede veld de minuten, het derde veld de uren, het vierde veld de dag van de maand, het vijfde veld de maand en het zesde veld de dag van de week. U kunt desgewenst ook een zevende veld opnemen, dat het jaar vertegenwoordigt.

De speciale tekens die zijn toegestaan, vertegenwoordigen de volgende betekenissen:

Voorbeelden

In de volgende tabel ziet u voorbeelden van tekenreeksen voor snijexpressie en geeft u een uitleg van wat deze betekenen.