Documentatie Experience Platform Handleiding Data Governance

Eindpunt van marketingacties

Last update: Wed Feb 28 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Onderwerpen:
Data Governance

Gemaakt voor:

Developer

Een marketingactie in het kader van de Adobe Experience Platform Data Governance is een actie die Experience Platform gegevens die de consument nodig heeft en waarvoor moet worden gecontroleerd op overtredingen van het beleid inzake gegevensgebruik.

U kunt marketingacties voor uw organisatie beheren met de /marketingActions eindpunt in de Dienst API van het Beleid.

Aan de slag

De API-eindpunten die in deze handleiding worden gebruikt, maken deel uit van de Policy Service API. Controleer voordat je doorgaat de gids Aan de slag voor verbindingen aan verwante documentatie, een gids aan het lezen van de steekproefAPI vraag in dit document en belangrijke informatie betreffende vereiste kopballen die nodig zijn om met succes vraag aan om het even welk Experience Platform API.

Een lijst met marketingacties ophalen list

U kunt een lijst met kern- of aangepaste marketingacties opvragen door een GET-aanvraag in te dienen bij /marketingActions/core of /marketingActions/custom, respectievelijk.

API-indeling

GET /marketingActions/core
GET /marketingActions/custom

Verzoek

Met het volgende verzoek wordt een lijst opgehaald met aangepaste marketingacties die door uw organisatie worden onderhouden.

curl -X GET \
  https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Antwoord

Een geslaagde reactie retourneert de details voor elke opgehaalde marketingactie, inclusief de bijbehorende name en href. De href waarde wordt gebruikt om de marketingactie te identificeren wanneer gegevensgebruiksbeleid maken.

{
    "_page": {
        "count": 2
    },
    "_links": {
        "page": {
            "href": "https://platform.adobe.io/marketingActions/custom?{?limit,start,property}",
            "templated": true
        }
    },
    "children": [
        {
            "name": "sampleMarketingAction",
            "description": "Marketing Action description.",
            "imsOrg": "{ORG_ID}",
            "created": 1550714012088,
            "createdClient": "string",
            "createdUser": "string",
            "updated": 1550714012088,
            "updatedClient": "string",
            "updatedUser": "string",
            "_links": {
                "self": {
                    "href": "https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/sampleMarketingAction"
                }
            }
        },
        {
            "name": "newMarketingAction",
            "description": "Another marketing action.",
            "imsOrg": "{ORG_ID}",
            "created": 1550793833224,
            "createdClient": "string",
            "createdUser": "string",
            "updated": 1550793833224,
            "updatedClient": "string",
            "updatedUser": "string",
            "_links": {
                "self": {
                    "href": "https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/newMarketingAction"
                }
            }
        }
    ]
}

Eigenschap

Beschrijving

_page.count

Het totale aantal geretourneerde marketingacties.

children

Een array met objecten die de details van de opgehaalde marketingacties bevatten.

name

De naam van de marketingactie, die fungeert als unieke id wanneer specifieke marketingactie zoeken.

_links.self.href

Een URI-referentie voor de marketingactie die kan worden gebruikt om de handeling te voltooien marketingActionsRefs array wanneer gegevensgebruiksbeleid maken.

Een specifieke marketingactie opzoeken lookup

U kunt de details van een specifieke marketingactie opzoeken door de marketingactie name eigenschap in het pad van een GET-aanvraag.

API-indeling

GET /marketingActions/core/{MARKETING_ACTION_NAME}
GET /marketingActions/custom/{MARKETING_ACTION_NAME}

Parameter

Beschrijving

{MARKETING_ACTION_NAME}

De name eigenschap van de marketingactie die u wilt opzoeken.

Verzoek

Met het volgende verzoek wordt een aangepaste marketingactie met de naam combineData.

curl -X GET \
  https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/combineData \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Antwoord

Het reactieobject bevat de details voor de marketingactie, inclusief het pad (_links.self.href) nodig zijn om te verwijzen naar de marketingactie wanneer een beleid voor gegevensgebruik definiëren (marketingActionsRefs).

{
    "name": "combineData",
    "description": "Combine multiple data sources together.",
    "imsOrg": "{ORG_ID}",
    "created": 1550793805590,
    "createdClient": "string",
    "createdUser": "string",
    "updated": 1550793805590,
    "updatedClient": "string",
    "updatedUser": "string",
    "_links": {
        "self": {
            "href": "https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/combineData"
        }
    }
}

Een aangepaste marketingactie maken of bijwerken create-update

U kunt een nieuwe aangepaste marketingactie maken of een bestaande actie bijwerken door de bestaande of beoogde naam van de marketingactie op te nemen in het pad van een aanvraag voor een PUT.

API-indeling

PUT /marketingActions/custom/{MARKETING_ACTION_NAME}

Parameter

Beschrijving

{MARKETING_ACTION_NAME}

De naam van de marketingactie die moet worden gemaakt of bijgewerkt. Als het systeem al een marketingactie met de opgegeven naam bevat, wordt die marketingactie bijgewerkt. Als er geen naam bestaat, wordt er een nieuwe marketingactie voor de opgegeven naam gemaakt.

Verzoek

Met het volgende verzoek wordt een nieuwe marketingactie gemaakt met de naam crossSiteTargeting, op voorwaarde dat het systeem nog geen afzetactie met dezelfde naam heeft. Indien een crossSiteTargeting marketingactie bestaat wel, maar deze aanroep werkt die marketingactie bij op basis van de eigenschappen die in de payload zijn opgegeven.

curl -X PUT \
  https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/crossSiteTargeting \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Content-Type: application/json' \
  -d '{
        "name": "crossSiteTargeting",
        "description": "Perform targeting on information obtained across multiple web sites."
      }'

Eigenschap

Beschrijving

name

De naam van de marketingactie die moet worden gemaakt of bijgewerkt.

BELANGRIJK: Deze eigenschap moet overeenkomen met {MARKETING_ACTION_NAME} in het pad, anders treedt een HTTP 400-fout (Bad Request) op. Met andere woorden, zodra een marketingactie is opgezet, moet deze name eigenschap kan niet worden gewijzigd.

description

Een optionele beschrijving om de context van de marketingactie te verfijnen.

Antwoord

Als de reactie succesvol was, worden de details van de marketingactie geretourneerd. Als een bestaande marketingactie is bijgewerkt, retourneert de reactie HTTP-status 200 (OK). Als een nieuwe marketing actie werd gecreeerd, keert de reactie HTTP status 201 (Gemaakt) terug.

{
    "name": "crossSiteTargeting",
    "description": "Perform targeting on information obtained across multiple web sites.",
    "imsOrg": "{ORG_ID}",
    "created": 1550713341915,
    "createdClient": "string",
    "createdUser": "string",
    "updated": 1550713856390,
    "updatedClient": "string",
    "updatedUser": "string",
    "_links": {
        "self": {
            "href": "https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/crossSiteTargeting"
        }
    }
}

Een aangepaste marketingactie verwijderen delete

U kunt een aangepaste marketingactie verwijderen door de naam ervan op te nemen in het pad van een DELETE-aanvraag.

NOTE

Marketing-acties waarnaar wordt verwezen door bestaand beleid, kunnen niet worden verwijderd. Wanneer u probeert een van deze marketingacties te verwijderen, wordt een HTTP 400-fout (Onjuist verzoek) gegenereerd samen met een bericht dat de id's bevat van alle beleidsvormen die naar de marketingactie verwijzen.

API-indeling

DELETE /marketingActions/custom/{MARKETING_ACTION_NAME}

Parameter

Beschrijving

{MARKETING_ACTION_NAME}

De naam van de marketingactie die u wilt verwijderen.

Verzoek

curl -X DELETE \
  https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/crossSiteTargeting \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Antwoord

Een geslaagde reactie retourneert HTTP Status 200 (OK) met een lege antwoordinstantie.

U kunt de verwijdering bevestigen door te proberen marketingactie opzoeken. Er wordt een HTTP 404-fout (Niet gevonden) weergegeven als de marketingactie van het systeem is verwijderd.

recommendation-more-help

834e0cae-2761-454a-be4d-62f0fd4b4456