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 en Experience Platform-datakonsument utför, och där 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 slutpunkten /marketingActions i principtjänstens API.

Komma igång

API-slutpunkterna som används i den här guiden ingår i Policy Service API. Innan du fortsätter bör du läsa kom igång-guiden för att få länkar till relaterad dokumentation, en guide till hur du läser exempelanropen för API i det här dokumentet och viktig information om vilka huvuden som krävs för att kunna anropa ett Experience Platform -API.

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

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 respektive /marketingActions/custom.

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. Värdet href används för att identifiera marknadsföringsåtgärden när en dataanvändningsprincip skapas.

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

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

Du kan söka efter information om en viss marknadsföringsåtgärd genom att ta med marknadsföringsåtgärdens name-egenskap i sökvägen till en GET-begäran.

API-format

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

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) som behövs för att referera till marknadsföringsåtgärden när en dataanvändningsprincip definieras (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 create-update

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}

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 det finns en crossSiteTargeting-marknadsföringsåtgärd 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."
      }'

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 delete

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.

API-format

DELETE /marketingActions/custom/{MARKETING_ACTION_NAME}

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 slå upp marknadsföringsåtgärden. Du bör få ett HTTP 404-fel (Hittades inte) om marknadsföringsåtgärden har tagits bort från systemet.