Les stratégies d’utilisation des données sont des règles qui décrivent les types d’actions marketing que vous êtes autorisé ou non à effectuer sur des données d’Experience Platform. Le point d’entrée /policies
dans Policy Service API vous permet de gérer par programme les stratégies dʼutilisation des données pour votre entreprise.
Le point d’entrée dʼAPI utilisé dans ce guide fait partie de lʼ Policy Service API. Avant de continuer, consultez le guide de prise en main pour obtenir des liens vers la documentation associée, un guide de lecture des exemples dʼappels API dans ce document et des informations importantes sur les en-têtes requis pour réussir des appels à nʼimporte quel API dʼExperience Platform.
Vous pouvez répertorier toutes les stratégies core
ou custom
en effectuant une requête GET à /policies/core
ou /policies/custom
, respectivement.
Format d’API
GET /policies/core
GET /policies/custom
Requête
La requête suivante récupère une liste de stratégies personnalisées définies par votre organisation.
curl -X GET \
https://platform.adobe.io/data/foundation/dulepolicy/policies/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}'
Réponse
Une réponse réussie comprend un tableau children
qui répertorie les détails de chaque stratégie récupérée, y compris leurs valeurs id
. Vous pouvez utiliser le champ id
dʼune stratégie spécifique pour effectuer des requêtes de recherche, de mise à jour et de suppression pour cette stratégie.
{
"_page": {
"start": "5c6dacdf685a4913dc48937c",
"count": 2
},
"_links": {
"page": {
"href": "https://platform.adobe.io/policies/custom?{?limit,start,property}",
"templated": true
}
},
"children": [
{
"name": "Export Data to Third Party",
"status": "DRAFT",
"marketingActionRefs": [
"https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/exportToThirdParty"
],
"description": "Conditions under which data cannot be exported to a third party",
"deny": {
"operator": "AND",
"operands": [
{
"label": "C1"
},
{
"operator": "OR",
"operands": [
{
"label": "C3"
},
{
"label": "C7"
}
]
}
]
},
"imsOrg": "{ORG_ID}",
"created": 1550691551888,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1550701472910,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {
"self": {
"href": "https://platform.adobe.io/data/foundation/dulepolicy/policies/custom/5c6dacdf685a4913dc48937c"
}
},
"id": "5c6dacdf685a4913dc48937c"
},
{
"name": "Combine Data",
"status": "ENABLED",
"marketingActionRefs": [
"https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/combineData"
],
"description": "Data that meets these conditions cannot be combined.",
"deny": {
"operator": "AND",
"operands": [
{
"label": "C3"
},
{
"label": "I1"
}
]
},
"imsOrg": "{ORG_ID}",
"created": 1550703519823,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1550714340335,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {
"self": {
"href": "https://platform.adobe.io/data/foundation/dulepolicy/policies/custom/5c6ddb9f5c404513dc2dc454"
}
},
"id": "5c6ddb9f5c404513dc2dc454"
}
]
}
Propriété | Description |
---|---|
_page.count |
Nombre total de stratégies récupérées. |
name |
Nom dʼaffichage dʼune stratégie. |
status |
État actuel dʼune stratégie. Il existe trois états possibles : DRAFT , ENABLED ou DISABLED . Par défaut, seules les stratégies ENABLED participent à lʼévaluation. Pour plus dʼinformations, consultez la présentation sur lʼévaluation des stratégies. |
marketingActionRefs |
Tableau qui répertorie les URI de toutes les actions marketing applicables pour une stratégie. |
description |
Description facultative qui fournit un contexte plus détaillé au cas dʼutilisation de la stratégie. |
deny |
Objet qui décrit les étiquettes dʼutilisation des données spécifiques sur lesquelles lʼaction marketing associée à une stratégie ne peut pas être effectuée. Pour plus dʼinformations sur cette propriété, consultez la section Création dʼune stratégie. |
Vous pouvez rechercher une stratégie spécifique en incluant la propriété id
de cette stratégie dans le chemin dʼune requête GET.
Format d’API
GET /policies/core/{POLICY_ID}
GET /policies/custom/{POLICY_ID}
Paramètre | Description |
---|---|
{POLICY_ID} |
Champ id de la stratégie que vous souhaitez rechercher. |
Requête
curl -X GET \
https://platform.adobe.io/data/foundation/dulepolicy/policies/custom/5c6dacdf685a4913dc48937c \
-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}'
Réponse
Une réponse réussie renvoie les détails de la stratégie.
{
"name": "Export Data to Third Party",
"status": "DRAFT",
"marketingActionRefs": [
"https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/exportToThirdParty"
],
"description": "Conditions under which data cannot be exported to a third party",
"deny": {
"operator": "AND",
"operands": [
{
"label": "C1"
},
{
"operator": "OR",
"operands": [
{
"label": "C3"
},
{
"label": "C7"
}
]
}
]
},
"imsOrg": "{ORG_ID}",
"created": 1550703519823,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1550714340335,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {
"self": {
"href": "https://platform.adobe.io/data/foundation/dulepolicy/policies/custom/5c6dacdf685a4913dc48937c"
}
},
"id": "5c6dacdf685a4913dc48937c"
}
Propriété | Description |
---|---|
name |
Nom dʼaffichage de la stratégie. |
status |
État actuel de la stratégie. Il existe trois états possibles : DRAFT , ENABLED ou DISABLED . Par défaut, seules les stratégies ENABLED participent à lʼévaluation. Pour plus dʼinformations, consultez la présentation sur lʼévaluation des stratégies. |
marketingActionRefs |
Tableau qui répertorie les URI de toutes les actions marketing applicables pour la stratégie. |
description |
Description facultative qui fournit un contexte plus détaillé au cas dʼutilisation de la stratégie. |
deny |
Objet qui décrit les étiquettes dʼutilisation des données spécifiques sur lesquelles lʼaction marketing associée à la stratégie ne peut pas être effectuée. Pour plus dʼinformations sur cette propriété, consultez la section Création dʼune stratégie. |
Dans lʼAPI Policy Service, une stratégie est définie par les éléments suivants :
Pour satisfaire à cette dernière exigence, les définitions des stratégies doivent inclure une expression booléenne par rapport à la présence dʼétiquettes dʼutilisation des données. Cette expression sʼappelle une expression de stratégie.
Les expressions de stratégie sont fournies sous la forme dʼune propriété deny
dans chaque définition de stratégie. Voici un exemple dʼobjet deny
simple qui vérifie uniquement la présence dʼune seule étiquette :
"deny": {
"label": "C1"
}
Cependant, de nombreuses stratégies spécifient des conditions plus complexes par rapport à la présence dʼétiquettes dʼutilisation des données. Pour prendre en charge ces cas dʼutilisation, vous pouvez également inclure des opérations booléennes pour décrire vos expressions de stratégie. Lʼobjet dʼexpression de stratégie doit contenir soit une étiquette soit un opérateur et des opérandes, mais pas les deux. De même, chaque opérande est également un objet d’expression de stratégie.
Par exemple, afin de définir une stratégie qui interdit lʼexécution dʼune action marketing sur des données contenant des étiquettes C1 OR (C3 AND C7)
, la propriété deny
de la stratégie est spécifiée comme suit :
"deny": {
"operator": "OR",
"operands": [
{"label": "C1"},
{
"operator": "AND",
"operands": [
{"label": "C3"},
{"label": "C7"}
]
}
]
}
Propriété | Description |
---|---|
operator |
Indique la relation conditionnelle entre les étiquettes fournies dans le tableau operands frère. Les valeurs acceptées sont les suivantes :
|
operands |
Tableau dʼobjets, chaque objet représentant soit une seule étiquette, soit une paire supplémentaire de propriétés operator et operands . La présence des étiquettes et/ou des opérations dans un tableau operands est résolue en « true » ou « false » en fonction de la valeur de sa propriété operator frère. |
label |
Nom dʼune étiquette unique dʼutilisation des données qui sʼapplique à la stratégie. |
Vous pouvez créer une nouvelle stratégie personnalisée en effectuant une requête POST vers le point d’entrée /policies/custom
.
Format d’API
POST /policies/custom
Requête
La requête suivante crée une nouvelle stratégie qui limite lʼexécution de lʼaction marketing exportToThirdParty
sur les données contenant des étiquettes C1 OR (C3 AND C7)
.
curl -X POST \
https://platform.adobe.io/data/foundation/dulepolicy/policies/custom \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '{
"name": "Export Data to Third Party",
"status": "DRAFT",
"marketingActionRefs": [
"https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/exportToThirdParty"
],
"description": "Conditions under which data cannot be exported to a third party",
"deny": {
"operator": "OR",
"operands": [
{"label": "C1"},
{
"operator": "AND",
"operands": [
{"label": "C3"},
{"label": "C7"}
]
}
]
}
}'
Propriété | Description |
---|---|
name |
Nom dʼaffichage de la stratégie. |
status |
État actuel de la stratégie. Il existe trois états possibles : DRAFT , ENABLED ou DISABLED . Par défaut, seules les stratégies ENABLED participent à lʼévaluation. Pour plus dʼinformations, consultez la présentation sur lʼévaluation des stratégies. |
marketingActionRefs |
Tableau qui répertorie les URI de toutes les actions marketing applicables pour la stratégie. LʼURI dʼune action marketing est indiqué sous _links.self.href dans la réponse pour la recherche dʼune action marketing. |
description |
Description facultative qui fournit un contexte plus détaillé au cas dʼutilisation de la stratégie. |
deny |
Lʼexpression de stratégie qui décrit les étiquettes dʼutilisation des données spécifiques sur lesquelles lʼaction marketing associée à la stratégie ne peut pas être exécutée. |
Réponse
Une réponse réussie renvoie les détails de la nouvelle stratégie créée, y compris son id
. Cette valeur est en lecture seule et s’affiche automatiquement lors de la création de la stratégie.
{
"name": "Export Data to Third Party",
"status": "DRAFT",
"marketingActionRefs": [
"https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/exportToThirdParty"
],
"description": "Conditions under which data cannot be exported to a third party",
"deny": {
"operator": "OR",
"operands": [
{
"label": "C1"
},
{
"operator": "AND",
"operands": [
{
"label": "C3"
},
{
"label": "C7"
}
]
}
]
},
"imsOrg": "{ORG_ID}",
"created": 1550691551888,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1550691551888,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {
"self": {
"href": "https://platform.adobe.io/data/foundation/dulepolicy/policies/custom/5c6dacdf685a4913dc48937c"
}
},
"id": "5c6dacdf685a4913dc48937c"
}
Vous pouvez uniquement mettre à jour des stratégies personnalisées. Si vous souhaitez activer ou désactiver des stratégies de base, consultez la section Mise à jour de la liste des stratégies de base activées.
Vous pouvez mettre à jour une stratégie personnalisée existante en fournissant son identifiant dans le chemin dʼune requête PUT avec une payload qui inclut la version actualisée de la stratégie dans son intégralité. En dʼautres termes, la requête PUT réécrit essentiellement la stratégie.
Reportez-vous à la section Mise à jour dʼune partie dʼune stratégie personnalisée si vous souhaitez uniquement mettre à jour un ou plusieurs champs dʼune stratégie, plutôt que de la remplacer.
Format d’API
PUT /policies/custom/{POLICY_ID}
Paramètre | Description |
---|---|
{POLICY_ID} |
Champ id de la stratégie à mettre à jour. |
Requête
Dans cet exemple, les conditions d’exportation des données vers un tiers ont été modifiées. Vous devez définir la stratégie créée de sorte qu’elle rejette cette action marketing en présence d’étiquettes de données C1 AND C5
.
La requête suivante met à jour la stratégie existante pour inclure la nouvelle expression de stratégie. Remarquez que puisque cette requête réécrit essentiellement la stratégie, tous les champs doivent être inclus dans la payload, même si certaines de leurs valeurs ne sont pas mises à jour.
curl -X PUT \
https://platform.adobe.io/data/foundation/dulepolicy/policies/custom/5c6dacdf685a4913dc48937c \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '{
"name": "Export Data to Third Party",
"status": "DRAFT",
"marketingActionRefs": [
"../marketingActions/custom/exportToThirdParty"
],
"description": "Conditions under which data cannot be exported to a third party",
"deny": {
"operator": "AND",
"operands": [
{"label": "C1"},
{"label": "C5"}
]
}
}'
Propriété | Description |
---|---|
name |
Nom dʼaffichage de la stratégie. |
status |
État actuel de la stratégie. Il existe trois états possibles : DRAFT , ENABLED ou DISABLED . Par défaut, seules les stratégies ENABLED participent à lʼévaluation. Pour plus dʼinformations, consultez la présentation sur lʼévaluation des stratégies. |
marketingActionRefs |
Tableau qui répertorie les URI de toutes les actions marketing applicables pour la stratégie. LʼURI dʼune action marketing est indiqué sous _links.self.href dans la réponse pour la recherche dʼune action marketing. |
description |
Description facultative qui fournit un contexte plus détaillé au cas dʼutilisation de la stratégie. |
deny |
Lʼexpression de stratégie qui décrit les étiquettes dʼutilisation des données spécifiques sur lesquelles lʼaction marketing associée à la stratégie ne peut pas être exécutée. Pour plus dʼinformations sur cette propriété, consultez la section Création dʼune stratégie. |
Réponse
Une réponse réussie renvoie les détails de la stratégie mise à jour.
{
"name": "Export Data to Third Party",
"status": "DRAFT",
"marketingActionRefs": [
"https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/core/exportToThirdParty"
],
"description": "Conditions under which data cannot be exported to a third party",
"deny": {
"operator": "AND",
"operands": [
{
"label": "C1"
},
{
"label": "C5"
}
]
},
"imsOrg": "{ORG_ID}",
"created": 1550691551888,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1550701472910,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {
"self": {
"href": "https://platform.adobe.io/data/foundation/dulepolicy/policies/custom/5c6dacdf685a4913dc48937c"
}
},
"id": "5c6dacdf685a4913dc48937c"
}
Vous pouvez uniquement mettre à jour des stratégies personnalisées. Si vous souhaitez activer ou désactiver des stratégies de base, consultez la section Mise à jour de la liste des stratégies de base activées.
Vous pouvez mettre à jour une partie spécifique d’une stratégie à l’aide d’une requête PATCH. Contrairement aux requêtes PUT qui réécrivent la stratégie, les requêtes PATCH ne mettent à jour que les propriétés spécifiées dans le corps de la requête. Cela sʼavère particulièrement utile lorsque vous souhaitez activer ou désactiver une stratégie, car vous devez uniquement fournir le chemin dʼaccès à la propriété appropriée (/status
) et sa valeur (ENABLED
ou DISABLED
).
Les payloads pour les requêtes PATCH respectent le format JSON Patch. Pour plus dʼinformations sur la syntaxe acceptée, consultez le guide des principes de base des API.
LʼAPI Policy Service prend en charge les opérations JSON Patch add
, remove
, replace
et vous permet de combiner plusieurs mises à jour en un seul appel, comme illustré dans lʼexemple ci-dessous.
Format d’API
PATCH /policies/custom/{POLICY_ID}
Paramètre | Description |
---|---|
{POLICY_ID} |
Champ id de la stratégie dont vous souhaitez mettre à jour les propriétés. |
Requête
La requête suivante utilise deux opérations replace
pour modifier lʼétat de la stratégie de DRAFT
à ENABLED
et pour mettre à jour le champ description
avec une nouvelle description.
Lors de lʼenvoi de plusieurs opérations PATCH dans une seule requête, elles seront traitées dans lʼordre dans lequel elles apparaissent dans le tableau. Assurez-vous que vous envoyez les requêtes dans le bon ordre, si nécessaire.
curl -X PATCH \
https://platform.adobe.io/data/foundation/dulepolicy/policies/custom/5c6dacdf685a4913dc48937c \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d ' [
{
"op": "replace",
"path": "/status",
"value": "ENABLED"
},
{
"op": "replace",
"path": "/description",
"value": "New policy description."
}
]'
Réponse
Une réponse réussie renvoie les détails de la stratégie mise à jour.
{
"name": "Export Data to Third Party",
"status": "ENABLED",
"marketingActionRefs": [
"https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/exportToThirdParty"
],
"description": "New policy description.",
"deny": {
"operator": "AND",
"operands": [
{
"label": "C1"
},
{
"operator": "OR",
"operands": [
{
"label": "C3"
},
{
"label": "C7"
}
]
}
]
},
"imsOrg": "{ORG_ID}",
"created": 1550703519823,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1550712163182,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {
"self": {
"href": "https://platform.adobe.io/data/foundation/dulepolicy/policies/custom/5c6dacdf685a4913dc48937c"
}
},
"id": "5c6dacdf685a4913dc48937c"
}
Vous pouvez supprimer une stratégie personnalisée en incluant son id
dans le chemin dʼaccès dʼune requête DELETE.
Les stratégies supprimées ne peuvent pas être récupérées. Il est recommandé dʼeffectuer une requête de recherche GET avant dʼafficher la stratégie et de confirmer quʼil sʼagit bien de la stratégie à supprimer.
Format d’API
DELETE /policies/custom/{POLICY_ID}
Paramètre | Description |
---|---|
{POLICY_ID} |
Lʼidentifiant de la stratégie que vous souhaitez supprimer. |
Requête
curl -X DELETE \
https://platform.adobe.io/data/foundation/dulepolicy/policies/custom/5c6ddb56eb60ca13dbf8b9a8 \
-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}'
Réponse
Une réponse réussie renvoie lʼétat HTTP 200 (OK) avec un corps vide.
Vous pouvez confirmer la suppression de la stratégie en la recherchant à lʼaide de GET. Vous devriez recevoir une erreur HTTP 404 (Not Found) si la stratégie a bien été supprimée.
Par défaut, seules les stratégies dʼutilisation des données activées participent à lʼévaluation. Vous pouvez récupérer une liste de stratégies de base actuellement activées par votre organisation en réalisant une requête GET au point d’entrée /enabledCorePolicies
.
Format d’API
GET /enabledCorePolicies
Requête
curl -X GET \
https://platform.adobe.io/data/foundation/dulepolicy/enabledCorePolicies \
-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}'
Réponse
Une réponse réussie renvoie la liste des stratégies de base activées sous un tableau policyIds
.
{
"policyIds": [
"corepolicy_0001",
"corepolicy_0002",
"corepolicy_0003",
"corepolicy_0004",
"corepolicy_0005",
"corepolicy_0006",
"corepolicy_0007",
"corepolicy_0008"
],
"imsOrg": "{ORG_ID}",
"created": 1529696681413,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1529697651972,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {
"self": {
"href": "https://platform.adobe.io:443/data/foundation/dulepolicy/enabledCorePolicies"
}
}
}
Par défaut, seules les stratégies dʼutilisation des données activées participent à lʼévaluation. En réalisant une requête PUT au point d’entrée /enabledCorePolicies
, vous pouvez mettre à jour la liste des stratégies de base activées pour votre organisation en un seul appel.
Seules les stratégies de base peuvent être activées ou désactivées par ce point d’entrée. Pour activer ou désactiver des stratégies personnalisées, consultez la section Mise à jour dʼune partie dʼune stratégie.
Format d’API
PUT /enabledCorePolicies
Requête
La requête suivante met à jour la liste des stratégies de base activées en fonction des identifiants fournis dans la payload.
curl -X GET \
https://platform.adobe.io/data/foundation/dulepolicy/enabledCorePolicies \
-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}' \
-d '{
"policyIds": [
"corepolicy_0001",
"corepolicy_0002",
"corepolicy_0007",
"corepolicy_0008"
]
}'
Propriété | Description |
---|---|
policyIds |
Liste dʼidentifiants de stratégies de base à activer. Toutes les stratégies de base qui ne sont pas incluses sont définies sur lʼétat DISABLED et ne participeront pas à lʼévaluation. |
Réponse
Une réponse réussie renvoie la liste mise à jour des stratégies de base activées sous un tableau policyIds
.
{
"policyIds": [
"corepolicy_0001",
"corepolicy_0002",
"corepolicy_0007",
"corepolicy_0008"
],
"imsOrg": "{ORG_ID}",
"created": 1529696681413,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1595876052649,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {
"self": {
"href": "https://platform.adobe.io:443/data/foundation/dulepolicy/enabledCorePolicies"
}
}
}
Une fois que vous avez défini de nouvelles stratégies ou mis à jour des stratégies existantes, vous pouvez utiliser lʼAPI Policy Service pour tester les actions marketing par rapport à des étiquettes ou des jeux de données spécifiques et voir si vos stratégies génèrent des violations comme prévu. Pour plus dʼinformations, consultez le guide sur les points d’entrée dʼévaluation des stratégies.