Show Menu
ARGOMENTI×

Endpoint delle azioni di marketing

Un'azione di marketing, nel contesto dell'Adobe Experience Platform Data Governance, è un'azione eseguita da un consumatore di Experience Platform dati, per la quale è necessario verificare la presenza di violazioni dei criteri di utilizzo dei dati.
Puoi gestire le azioni di marketing per la tua organizzazione utilizzando l' /marketingActions endpoint nell'API del servizio criteri.

Recupera un elenco di azioni di marketing

Puoi recuperare un elenco di azioni di marketing di base o personalizzate effettuando una richiesta di GET a /marketingActions/core o, rispettivamente, /marketingActions/custom a.
Formato API
GET /marketingActions/core
GET /marketingActions/custom

Richiesta
La richiesta seguente recupera un elenco di azioni di marketing personalizzate gestite dalla tua organizzazione.
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}'

Risposta
Una risposta corretta restituisce i dettagli per ogni azione di marketing recuperata, inclusi i relativi name e href . Il href valore viene utilizzato per identificare l'azione di marketing durante la creazione di un criterio di utilizzo dei dati.
{
    "_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"
                }
            }
        }
    ]
}

Proprietà
Descrizione
_page.count
Numero totale di azioni di marketing restituite.
children
Un array di oggetti che contiene i dettagli delle azioni di marketing recuperate.
name
Nome dell'azione di marketing, che funge da identificatore univoco quando si cerca una specifica azione di marketing.
_links.self.href
Un riferimento URI per l'azione di marketing, che può essere utilizzato per completare l' marketingActionsRefs array durante la creazione di un criterio di utilizzo dei dati.

Cerca un'azione di marketing specifica

Puoi cercare i dettagli di una specifica azione di marketing inserendo la name proprietà dell'azione di marketing nel percorso di una richiesta di GET.
Formato API
GET /marketingActions/core/{MARKETING_ACTION_NAME}
GET /marketingActions/custom/{MARKETING_ACTION_NAME}

Parametro
Descrizione
{MARKETING_ACTION_NAME}
La name proprietà dell’azione di marketing da ricercare.
Richiesta
La richiesta seguente recupera un'azione di marketing personalizzata denominata 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: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Risposta
L'oggetto response contiene i dettagli dell'azione di marketing, incluso il percorso ( _links.self.href ) necessario per fare riferimento all'azione di marketing durante la definizione di un criterio di utilizzo dei dati ( marketingActionsRefs ).
{
    "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"
        }
    }
}

Creazione o aggiornamento di un'azione di marketing personalizzata

Puoi creare una nuova azione di marketing personalizzata, o aggiornarne una esistente, includendo il nome esistente o previsto dell'azione di marketing nel percorso di una richiesta di PUT.
Formato API
PUT /marketingActions/custom/{MARKETING_ACTION_NAME}

Parametro
Descrizione
{MARKETING_ACTION_NAME}
Nome dell'azione di marketing da creare o aggiornare. Se nel sistema esiste già un'azione di marketing con il nome specificato, tale azione di marketing viene aggiornata. Se non esiste, viene creata una nuova azione di marketing per il nome fornito.
Richiesta
La richiesta seguente crea una nuova azione di marketing denominata crossSiteTargeting , a condizione che nel sistema non esista ancora un'azione di marketing con lo stesso nome. Se esiste un'azione crossSiteTargeting di marketing, questa chiamata aggiorna invece l'azione di marketing in base alle proprietà fornite nel payload.
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."
      }'

Proprietà
Descrizione
name
Nome dell'azione di marketing da creare o aggiornare.
IMPORTANTE : Questa proprietà deve corrispondere al percorso {MARKETING_ACTION_NAME} in caso contrario si verificherà un errore HTTP 400 (Richiesta non valida). In altre parole, una volta creata un'azione di marketing, non sarà più possibile modificarne name la proprietà.
description
Una descrizione facoltativa per fornire ulteriore contesto all'azione di marketing.
Risposta
Una risposta corretta restituisce i dettagli dell’azione di marketing. Se un'azione di marketing esistente è stata aggiornata, la risposta restituisce lo stato HTTP 200 (OK). Se è stata creata una nuova azione di marketing, la risposta restituisce lo stato HTTP 201 (Creato).
{
    "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"
        }
    }
}

Eliminazione di un'azione di marketing personalizzata

Puoi eliminare un'azione di marketing personalizzata inserendone il nome nel percorso di una richiesta di DELETE.
Le azioni di marketing cui fanno riferimento i criteri esistenti non possono essere eliminate. Se si tenta di eliminare una di queste azioni di marketing, si verificherà un errore HTTP 400 (Richiesta non valida) con un messaggio che include gli ID di tutti i criteri che fanno riferimento all'azione di marketing.
Formato API
DELETE /marketingActions/custom/{MARKETING_ACTION_NAME}

Parametro
Descrizione
{MARKETING_ACTION_NAME}
Nome dell’azione di marketing da eliminare.
Richiesta
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}'

Risposta
Una risposta corretta restituisce lo stato HTTP 200 (OK) con un corpo di risposta vuoto.
Puoi confermare l’eliminazione cercando di ricercare l’azione di marketing. Se l’azione di marketing è stata rimossa dal sistema, riceverai un errore HTTP 404 (non trovato).