Slutpunkt för marknadsföringsåtgärder

En marknadsföringsåtgärd, inom ramen för Adobe Experience Platform Data Governance, är en åtgärd som Experience Platform dataförbrukare tar, för vilka det finns ett behov av att kontrollera om dataanvändningsprinciper har överträtts.

Du kan hantera marknadsföringsåtgärder för din organisation med /marketingActions slutpunkt i principtjänstens API.

Komma igång

API-slutpunkterna som används i den här handboken är en del av Policy Service API. Läs igenom komma igång-guide för länkar till relaterad dokumentation, en guide till hur du läser exempel-API-anrop i det här dokumentet och viktig information om vilka huvuden som behövs för att kunna ringa anrop till Experience Platform API.

Hämta en lista med marknadsföringsåtgärder

Du kan hämta en lista över viktiga eller anpassade marknadsföringsåtgärder genom att göra en GET-förfrågan till /marketingActions/core eller /marketingActions/custom, respektive.

API-format

GET /marketingActions/core
GET /marketingActions/custom

Begäran

Följande begäran hämtar en lista över anpassade marknadsföringsåtgärder som hanteras av din organisation.

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}'

Svar

Ett lyckat svar returnerar information för varje hämtad marknadsföringsåtgärd, inklusive dess name och href. The href värdet används för att identifiera marknadsföringsåtgärden när skapa en dataanvändningsprincip.

{
    "_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"
                }
            }
        }
    ]
}

Egenskap	Beskrivning
`_page.count`	Det totala antalet returnerade marknadsföringsåtgärder.
`children`	En array med objekt som innehåller information om hämtade marknadsföringsåtgärder.
`name`	Namnet på marknadsföringsåtgärden, som fungerar som sin unika identifierare när söka efter en specifik marknadsföringsåtgärd.
`_links.self.href`	En URI-referens för marknadsföringsåtgärden, som kan användas för att slutföra `marketingActionsRefs` array när skapa en dataanvändningsprincip.

Slå upp en specifik marknadsföringsåtgärd

Du letar upp detaljerna om en viss marknadsföringsåtgärd genom att ta med marknadsföringsåtgärdens name i sökvägen för en GET-begäran.

API-format

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

Parameter	Beskrivning
`{MARKETING_ACTION_NAME}`	The `name` egenskapen för den marknadsföringsåtgärd som du vill söka efter.

Begäran

Följande begäran hämtar en anpassad marknadsföringsåtgärd med namnet 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}'

Svar

Svarsobjektet innehåller information om marknadsföringsåtgärden, inklusive sökvägen (_links.self.href) behövde referera till marknadsföringsåtgärderna när definiera en dataanvändningsprincip (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"
        }
    }
}

Skapa eller uppdatera en anpassad marknadsföringsåtgärd

Du kan skapa en ny anpassad marknadsföringsåtgärd, eller uppdatera en befintlig, genom att ta med marknadsföringsåtgärdens befintliga eller avsedda namn i sökvägen till en PUT-förfrågan.

API-format

PUT /marketingActions/custom/{MARKETING_ACTION_NAME}

Parameter	Beskrivning
`{MARKETING_ACTION_NAME}`	Namnet på den marknadsföringsåtgärd som ska skapas eller uppdateras. Om det redan finns en marknadsföringsåtgärd med det angivna namnet i systemet uppdateras den marknadsföringsåtgärden. Om det inte finns någon sådan, skapas en ny marknadsföringsåtgärd för det angivna namnet.

Begäran

Följande begäran skapar en ny marknadsföringsåtgärd med namnet crossSiteTargeting, förutsatt att det inte finns någon marknadsföringsåtgärd med samma namn i systemet än. Om en crossSiteTargeting marknadsföringsåtgärd finns, uppdaterar det här anropet i stället marknadsföringsåtgärden baserat på de egenskaper som anges i nyttolasten.

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."
      }'

Egenskap	Beskrivning
`name`	Namnet på den marknadsföringsåtgärd som ska skapas eller uppdateras. VIKTIGT: Den här egenskapen måste matcha `{MARKETING_ACTION_NAME}` i sökvägen, annars inträffar ett HTTP 400-fel (Ogiltig begäran). Med andra ord, när en marknadsföringsåtgärd har skapats, `name` -egenskapen kan inte ändras.
`description`	En valfri beskrivning som ger ytterligare sammanhang för marknadsföringsåtgärden.

Svar

Ett lyckat svar returnerar detaljerna om marknadsföringsåtgärden. Om en befintlig marknadsföringsåtgärd uppdaterades returnerar svaret HTTP-status 200 (OK). Om en ny marknadsföringsåtgärd skapades returnerar svaret HTTP-status 201 (Skapad).

{
    "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"
        }
    }
}

Ta bort en anpassad marknadsföringsåtgärd

Du kan ta bort en anpassad marknadsföringsåtgärd genom att ta med dess namn i sökvägen för en DELETE-begäran.

OBSERVERA

Marknadsföringsåtgärder som refereras av befintliga principer kan inte tas bort. Om du försöker ta bort en av dessa marknadsföringsåtgärder genereras ett HTTP 400-fel (felaktig begäran) tillsammans med ett meddelande som innehåller ID:n för alla profiler som refererar till marknadsföringsåtgärden.

API-format

DELETE /marketingActions/custom/{MARKETING_ACTION_NAME}

Parameter	Beskrivning
`{MARKETING_ACTION_NAME}`	Namnet på den marknadsföringsåtgärd som du vill ta bort.

Begäran

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}'

Svar

Ett lyckat svar returnerar HTTP-status 200 (OK) med en tom svarstext.

Du kan bekräfta borttagningen genom att försöka söka efter marknadsföringsåtgärder. Du bör få ett HTTP 404-fel (Hittades inte) om marknadsföringsåtgärden har tagits bort från systemet.