Endpunkt der Marketing-Aktionen

A marketing action, in the context of the Adobe Experience Platform Data Governance, is an action that an Experience Platform data consumer takes, for which there is a need to check for violations of data usage policies.

Sie können Marketingaktionen für Ihr Unternehmen mithilfe des /marketingActions Endpunkts in der Policy Service-API verwalten.

Erste Schritte

The API endpoints used in this guide are part of the Policy Service API. Bevor Sie fortfahren, lesen Sie bitte die Anleitung zu den ersten Schritten für Links zur zugehörigen Dokumentation, eine Anleitung zum Lesen der Beispiel-API-Aufrufe in diesem Dokument und wichtige Informationen zu den erforderlichen Kopfzeilen, die zum erfolgreichen Aufrufen einer beliebigen Experience Platform API erforderlich sind.

Eine Liste von Marketingaktionen abrufen

Sie können eine Liste von Kern- oder benutzerspezifischen Marketingaktionen abrufen, indem Sie eine GET-Anforderung an /marketingActions/core bzw. /marketingActions/customan diese senden.

API-Format

GET /marketingActions/core
GET /marketingActions/custom

Anfrage

Die folgende Anforderung ruft eine Liste von benutzerspezifischen Marketingaktionen ab, die von Ihrem Unternehmen verwaltet werden.

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: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Antwort

Eine erfolgreiche Antwort gibt die Details zu jeder abgerufenen Marketingaktion zurück, einschließlich ihrer name und href. Der href Wert wird zur Identifizierung der Marketingaktion verwendet, wenn eine Datenverwendungsrichtlinie erstellt wird.

{
    "_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": "{IMS_ORG}",
            "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": "{IMS_ORG}",
            "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"
                }
            }
        }
    ]
}
Eigenschaft Beschreibung
_page.count Die Gesamtzahl der zurückgegebenen Marketingaktionen.
children Ein Array von Objekten, die die Details der abgerufenen Marketingaktionen enthalten.
name Der Name der Marketingaktion, die bei der Suche nach einer bestimmten Marketingaktionals eindeutige Kennung dient.
_links.self.href Eine URI-Referenz für die Marketingaktion, die zum Abschließen des marketingActionsRefs Arrays beim Erstellen einer Datenverwendungsrichtlinieverwendet werden kann.

Suchen Sie nach einer bestimmten Marketingaktion

Sie können die Details einer bestimmten Marketingaktion nachschlagen, indem Sie die name Eigenschaft der Marketingaktion in den Pfad einer GET-Anforderung aufnehmen.

API-Format

GET /marketingActions/core/{MARKETING_ACTION_NAME}
GET /marketingActions/custom/{MARKETING_ACTION_NAME}
Parameter Beschreibung
{MARKETING_ACTION_NAME} The name property of the marketing action you want to look up.

Anfrage

Die folgende Anforderung ruft eine benutzerdefinierte Marketingaktion mit dem Namen combineDataab.

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: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Antwort

Das Antwortobjekt enthält die Details zur Marketingaktion, einschließlich des Pfads (_links.self.href), der zum Verweisen auf die Marketingaktion beim Definieren einer Datenverwendungsrichtlinie (marketingActionsRefs) erforderlich ist.

{
    "name": "combineData",
    "description": "Combine multiple data sources together.",
    "imsOrg": "{IMS_ORG}",
    "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"
        }
    }
}

Erstellen oder Aktualisieren einer benutzerdefinierten Marketingaktion

Sie können eine neue benutzerspezifische Marketingaktion erstellen oder eine vorhandene aktualisieren, indem Sie den vorhandenen oder beabsichtigten Namen der Marketingaktion in den Pfad einer PUT-Anforderung aufnehmen.

API-Format

PUT /marketingActions/custom/{MARKETING_ACTION_NAME}
Parameter Beschreibung
{MARKETING_ACTION_NAME} Der Name der Marketingaktion, die erstellt oder aktualisiert werden soll. Wenn im System bereits eine Marketingaktion mit dem angegebenen Namen vorhanden ist, wird diese Marketingaktion aktualisiert. Wenn keine Marketingaktion vorhanden ist, wird eine neue Marketingaktion für den angegebenen Namen erstellt.

Anfrage

Die folgende Anforderung erstellt eine neue Marketingaktion mit dem Namen crossSiteTargeting, sofern im System noch keine Marketingaktion mit demselben Namen vorhanden ist. Wenn eine crossSiteTargeting Marketingaktion vorhanden ist, wird diese Marketingaktion stattdessen anhand der in der Nutzlast bereitgestellten Eigenschaften aktualisiert.

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: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Content-Type: application/json' \
  -d '{
        "name": "crossSiteTargeting",
        "description": "Perform targeting on information obtained across multiple web sites."
      }'
Eigenschaft Beschreibung
name Der Name der Marketingaktion, die erstellt oder aktualisiert werden soll.

WICHTIG: Diese Eigenschaft muss mit dem {MARKETING_ACTION_NAME} im Pfad übereinstimmen, andernfalls tritt ein HTTP-400-Fehler (Fehlerhafte Anforderung) auf. Mit anderen Worten, sobald eine Marketingaktion erstellt wurde, kann ihre name Eigenschaft nicht mehr geändert werden.
description Eine optionale Beschreibung, um weitere Kontexte für die Marketingaktion anzugeben.

Antwort

Eine erfolgreiche Antwort gibt die Details der Marketingaktion zurück. Wenn eine vorhandene Marketingaktion aktualisiert wurde, gibt die Antwort den HTTP-Status 200 (OK) zurück. Wenn eine neue Marketingaktion erstellt wurde, gibt die Antwort den HTTP-Status 201 (Erstellt) zurück.

{
    "name": "crossSiteTargeting",
    "description": "Perform targeting on information obtained across multiple web sites.",
    "imsOrg": "{IMS_ORG}",
    "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"
        }
    }
}

Löschen einer benutzerdefinierten Marketingaktion

Sie können eine benutzerspezifische Marketingaktion löschen, indem Sie deren Namen in den Pfad einer DELETE-Anforderung eintragen.

Hinweis

Marketingaktionen, die von bestehenden Richtlinien referenziert werden, können nicht gelöscht werden. Der Versuch, eine dieser Marketingaktionen zu löschen, führt zu einem HTTP-400-Fehler (Ungültige Anforderung) zusammen mit einer Meldung, die die IDs aller Richtlinien enthält, die auf die Marketingaktion verweisen.

API-Format

DELETE /marketingActions/custom/{MARKETING_ACTION_NAME}
Parameter Beschreibung
{MARKETING_ACTION_NAME} Der Name der Marketingaktion, die Sie löschen möchten.

Anfrage

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: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Antwort

Eine erfolgreiche Antwort gibt HTTP-Status 200 (OK) mit einem leeren Antworttext zurück.

Sie können den Löschvorgang bestätigen, indem Sie versuchen, die Marketingaktion nachzuschlagen. Sie sollten einen HTTP 404-Fehler (nicht gefunden) erhalten, wenn die Marketingaktion aus dem System entfernt wurde.

Auf dieser Seite