Labels-eindpunt
Met labels voor gegevensgebruik kunt u gegevens indelen volgens het gebruiksbeleid dat op die gegevens van toepassing kan zijn. Met het /labels -eindpunt in de Policy Service API kunt u gegevensgebruikslabels programmatisch beheren in uw ervaringstoepassing.
/labels eindpunt wordt alleen gebruikt om gegevensgebruikslabels op te halen, te maken en bij te werken. U kunt labels niet verwijderen. Nochtans, kunt u etiketten aan datasets en gebieden toevoegen of verwijderen gebruikend API vraag. Verwijs naar de gids op het leiden datasetetikettendocument voor instructies.Aan de slag
Het API eindpunt dat in deze gids wordt gebruikt is een deel van Policy Service API. Alvorens verder te gaan, te herzien gelieve begonnen gidsvoor verbindingen aan verwante documentatie, een gids aan het lezen van de steekproefAPI vraag in dit document, en belangrijke informatie betreffende vereiste kopballen die nodig zijn om vraag aan om het even welke Experience Platform API met succes te maken.
Een lijst met labels ophalen list
U kunt alle labels core en custom weergeven door een aanvraag voor een GET in te dienen bij /labels/core respectievelijk /labels/custom .
API formaat
GET /labels/core
GET /labels/custom
Verzoek
In het volgende verzoek worden alle aangepaste labels weergegeven die in uw organisatie zijn gemaakt.
curl -X GET \
'https://platform.adobe.io/data/foundation/dulepolicy/labels/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}'
Reactie
Een succesvolle reactie keert een lijst van douanelabels terug die van het systeem worden teruggewonnen. Aangezien de bovenstaande voorbeeldaanvraag is ingediend bij /labels/custom , worden in de onderstaande reactie alleen aangepaste labels weergegeven.
{
"_page": {
"count": 2
},
"_links": {
"page": {
"href": "https://platform.adobe.io:443/data/foundation/dulepolicy/labels/custom?{?limit,start,property}",
"templated": true
}
},
"children": [
{
"name": "L1",
"category": "Custom",
"friendlyName": "Banking Information",
"description": "Data containing banking information for a customer.",
"imsOrg": "{ORG_ID}",
"sandboxName": "{SANDBOX_NAME}",
"created": 1594396718731,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1594396718731,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {
"self": {
"href": "https://platform.adobe.io:443/data/foundation/dulepolicy/labels/custom/L1"
}
}
},
{
"name": "L2",
"category": "Custom",
"friendlyName": "Purchase History Data",
"description": "Data containing information on past transactions",
"imsOrg": "{ORG_ID}",
"sandboxName": "{SANDBOX_NAME}",
"created": 1594397415663,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1594397728708,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {
"self": {
"href": "https://platform.adobe.io:443/data/foundation/dulepolicy/labels/custom/L2"
}
}
}
]
}
Een label opzoeken look-up
U kunt een specifiek label opzoeken door de eigenschap name van dat label op te nemen in het pad van een GET-aanvraag naar de Policy Service API.
API formaat
GET /labels/core/{LABEL_NAME}
GET /labels/custom/{LABEL_NAME}
{LABEL_NAME}name van het aangepaste label dat u wilt opzoeken.Verzoek
Met de volgende aanvraag wordt het aangepaste label L2 opgehaald, zoals aangegeven in het pad.
curl -X GET \
'https://platform.adobe.io/data/foundation/dulepolicy/labels/custom/L2' \
-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}'
Reactie
Als de reactie is gelukt, worden de details van het aangepaste label geretourneerd.
{
"name": "L2",
"category": "Custom",
"friendlyName": "Purchase History Data",
"description": "Data containing information on past transactions",
"imsOrg": "{ORG_ID}",
"sandboxName": "{SANDBOX_NAME}",
"created": 1594397415663,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1594397728708,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {
"self": {
"href": "https://platform.adobe.io:443/data/foundation/dulepolicy/labels/custom/L2"
}
}
}
Een aangepast label maken of bijwerken create-update
Als u een aangepast label wilt maken of bijwerken, moet u een aanvraag voor een PUT indienen bij de API van Policy Service .
API formaat
PUT /labels/custom/{LABEL_NAME}
{LABEL_NAME}name van een aangepast label. Als er geen aangepast label met deze naam bestaat, wordt een nieuw label gemaakt. Als er een label bestaat, wordt dat label bijgewerkt.Verzoek
In het volgende verzoek wordt een nieuw label L3 gemaakt dat gegevens beschrijft die informatie bevatten over de geselecteerde betaalplannen van klanten.
curl -X PUT \
'https://platform.adobe.io/data/foundation/dulepolicy/labels/custom/L3' \
-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 '{
"name": "L3",
"category": "Custom",
"friendlyName": "Payment Plan",
"description": "Data containing information on selected payment plans."
}'
namecategoryCustom gebruikt als u het etiket in UI wilt verschijnen.friendlyNamedescriptionReactie
Een geslaagde reactie retourneert de details van het aangepaste label, met HTTP-code 200 (OK) als een bestaand label is bijgewerkt, of 201 (Gemaakt) als een nieuw label is gemaakt.
{
"name": "L3",
"category": "Custom",
"friendlyName": "Payment Plan",
"description": "Data containing information on selected payment plans.",
"imsOrg": "{ORG_ID}",
"sandboxName": "{SANDBOX_NAME}",
"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/labels/custom/L3"
}
}
}
Volgende stappen
Deze gids behandelde het gebruik van het /labels eindpunt in de Dienst API van het Beleid. Voor stappen op hoe te om etiketten op datasets en gebieden toe te passen, verwijs naar de dataset etiketten API gids.