Ponto de extremidade de rótulos
Os rótulos de uso de dados permitem categorizar os dados de acordo com as políticas de uso que podem se aplicar a esses dados. O ponto de extremidade /labels no Policy Service API permite gerenciar de forma programática os rótulos de uso de dados no aplicativo de experiência.
/labels é usado apenas para recuperar, criar e atualizar rótulos de uso de dados. Não é possível excluir rótulos. No entanto, é possível adicionar ou remover rótulos de conjuntos de dados e campos usando chamadas de API. Consulte o guia no documento gerenciamento de rótulos do conjunto de dados para obter instruções.Introdução
O ponto de extremidade de API usado neste guia faz parte de Policy Service API. Antes de continuar, consulte o guia de introdução para obter links para a documentação relacionada, um guia para ler as chamadas de API de exemplo neste documento e informações importantes sobre os cabeçalhos necessários para fazer chamadas com êxito para qualquer API do Experience Platform.
Recuperar uma lista de rótulos list
Você pode listar todos os rótulos de core ou custom fazendo uma solicitação GET para /labels/core ou /labels/custom, respectivamente.
Formato da API
GET /labels/core
GET /labels/custom
Solicitação
A solicitação a seguir lista todos os rótulos personalizados criados em sua organização.
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}'
Resposta
Uma resposta bem-sucedida retorna uma lista de rótulos personalizados recuperados do sistema. Como a solicitação de exemplo acima foi feita para /labels/custom, a resposta abaixo mostra apenas rótulos personalizados.
{
"_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"
}
}
}
]
}
Pesquisar um rótulo look-up
Você pode pesquisar um rótulo específico incluindo a propriedade name desse rótulo no caminho de uma solicitação GET para a API Policy Service.
Formato da API
GET /labels/core/{LABEL_NAME}
GET /labels/custom/{LABEL_NAME}
{LABEL_NAME}name do rótulo personalizado que você deseja pesquisar.Solicitação
A solicitação a seguir recupera o rótulo personalizado L2, conforme indicado no caminho.
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}'
Resposta
Uma resposta bem-sucedida retorna os detalhes do rótulo personalizado.
{
"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"
}
}
}
Criar ou atualizar um rótulo personalizado create-update
Para criar ou atualizar um rótulo personalizado, você deve fazer uma solicitação PUT para a API Policy Service.
Formato da API
PUT /labels/custom/{LABEL_NAME}
{LABEL_NAME}name de um rótulo personalizado. Se não existir um rótulo personalizado com esse nome, um novo rótulo será criado. Se existir, esse rótulo será atualizado.Solicitação
A solicitação a seguir cria um novo rótulo, L3, com o objetivo de descrever dados que contêm informações relacionadas aos planos de pagamento selecionados dos clientes.
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 se quiser que o rótulo apareça na interface.friendlyNamedescriptionResposta
Uma resposta bem-sucedida retorna os detalhes do rótulo personalizado, com o código HTTP 200 (OK) se um rótulo existente foi atualizado ou 201 (Criado) se um novo rótulo foi criado.
{
"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"
}
}
}
Próximas etapas
Este guia abordou o uso do ponto de extremidade /labels na API de Serviço de Política. Para obter etapas sobre como aplicar rótulos a conjuntos de dados e campos, consulte o guia da API de rótulos de conjuntos de dados.