Creare un modello di pubblico
- Argomenti:
- Destinazioni
Creato per:
- Amministratore
- Utente
platform.adobe.io/data/core/activation/authoring/audience-templates
Per alcune destinazioni create con Destination SDK, devi creare una configurazione di metadati di pubblico per creare, aggiornare o eliminare in modo programmatico i metadati di pubblico nella destinazione. Questa pagina mostra come utilizzare l'endpoint API /authoring/audience-templates
per creare la configurazione.
Per una descrizione dettagliata delle funzionalità che è possibile configurare tramite questo endpoint, vedere Gestione metadati pubblico.
Guida introduttiva alle operazioni API dei modelli di pubblico
Prima di continuare, consulta la guida introduttiva per informazioni importanti che devi conoscere per effettuare correttamente chiamate all'API, tra cui come ottenere l'autorizzazione di authoring della destinazione richiesta e le intestazioni richieste.
Creare un modello di pubblico
Per creare un nuovo modello di pubblico, devi eseguire una richiesta POST
all'endpoint /authoring/audience-templates
.
Formato API
POST /authoring/audience-templates
La richiesta seguente crea un nuovo modello di pubblico, configurato dai parametri forniti nel payload. Il payload seguente include tutti i parametri accettati dall'endpoint /authoring/audience-templates
. Tieni presente che non è necessario aggiungere tutti i parametri alla chiamata e che il modello è personalizzabile, in base ai requisiti API.
curl -X POST https://platform.adobe.io/data/core/activation/authoring/audience-templates \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '
{
"metadataTemplate": {
"name": "Test Webhook Audience Template",
"create": {
"url": "https://your-webhook-site/0bd222fa-8ae2-433b-8f0e-f2ce137b0ee4/{{customerData.customerID}}/segments",
"httpMethod": "POST",
"headers": [
{
"value": "application/json",
"header": "Content-Type"
},
{
"value": "Bearer {{authData.token}}",
"header": "Authorization"
}
],
"requestBody": {
"json": {
"name": "{{segment.name}}",
"type": "segment",
"metadata": {
"org_id": "{{destination.imsOrgId}}",
"sandbox": "{{destination.sandboxName}}",
"destination_id": "{{destination.id}}",
"destination_name": "{{destination.name}}",
"segmentEnrichmentAttributes": "{% set columns = [] %}{% for atr in segmentEnrichmentAttributes %}{% set columns = columns|merge([atr.source]) %}{% endfor %}{{ columns | toJson }}"
},
"external_id": "{{segment.id}}"
}
},
"responseFields": [
{
"value": "{{headers.X-Request-Id}}",
"name": "externalAudienceId"
}
],
"responseErrorFields": [
{
"value": "{{root}}",
"name": "message"
}
]
},
"update": {
"url": "https://your-webhook-site/0bd222fa-8ae2-433b-8f0e-f2ce137b0ee4/{{customerData.customerID}}/segments/{{segment.alias}}",
"httpMethod": "PUT",
"headers": [
{
"value": "application/json",
"header": "Content-Type"
},
{
"value": "Bearer {{authData.token}}",
"header": "Authorization"
}
],
"requestBody": {
"json": {
"name": "{{segment.name}}",
"type": "segment",
"metadata": {
"org_id": "{{destination.imsOrgId}}",
"sandbox": "{{destination.sandboxName}}",
"destination_id": "{{destination.id}}",
"destination_name": "{{destination.name}}",
"segmentEnrichmentAttributes": "{% set columns = [] %}{% for atr in segmentEnrichmentAttributes %}{% set columns = columns|merge([atr.source]) %}{% endfor %}{{ columns | toJson }}"
},
"external_id": "{{segment.id}}"
}
},
"responseFields": [
{
"value": "{{headers.X-Request-Id}}",
"name": "externalAudienceId"
}
],
"responseErrorFields": [
{
"value": "{{root}}",
"name": "message"
}
]
},
"delete": {
"url": "https://your-webhook-site/0bd222fa-8ae2-433b-8f0e-f2ce137b0ee4/{{customerData.customerID}}/segments/{{segment.alias}}",
"httpMethod": "DELETE",
"headers": [
{
"value": "Bearer {{authData.token}}",
"header": "Authorization"
}
],
"responseErrorFields": [
{
"value": "{{root}}",
"name": "message"
}
]
},
"createDestination": {
"url": "https://your-webhook-site/0bd222fa-8ae2-433b-8f0e-f2ce137b0ee4/{{customerData.customerID}}/createDestination",
"httpMethod": "POST",
"headers": [
{
"value": "application/json",
"header": "Content-Type"
},
{
"value": "Bearer {{authData.token}}",
"header": "Authorization"
}
],
"requestBody": {
"json": {
"name": "{{destination.name}}",
"type": "destination",
"metadata": {
"org_id": "{{destination.imsOrgId}}",
"sandbox": "{{destination.sandboxName}}",
"destination_id": "{{destination.id}}",
"destination_name": "{{destination.name}}",
"enrichmentAttributes": "{{destination.enrichmentAttributes}}"
},
"external_id": "{{destination.id}}"
}
},
"responseFields": [
{
"value": "{{headers.X-Request-Id}}",
"name": "externalAudienceId"
}
],
"responseErrorFields": [
{
"value": "{{root}}",
"name": "message"
}
]
},
"updateDestination": {
"url": "https://your-webhook-site/0bd222fa-8ae2-433b-8f0e-f2ce137b0ee4/{{customerData.customerID}}/updateDestination",
"httpMethod": "POST",
"headers": [
{
"value": "application/json",
"header": "Content-Type"
},
{
"value": "Bearer {{authData.token}}",
"header": "Authorization"
}
],
"requestBody": {
"json": {
"name": "{{destination.name}}",
"type": "destination",
"metadata": {
"org_id": "{{destination.imsOrgId}}",
"sandbox": "{{destination.sandboxName}}",
"destination_id": "{{destination.id}}",
"destination_name": "{{destination.name}}",
"enrichmentAttributes": "{{destination.enrichmentAttributes}}"
},
"external_id": "{{destination.id}}"
}
},
"responseFields": [
{
"value": "{{headers.X-Request-Id}}",
"name": "externalAudienceId"
}
],
"responseErrorFields": [
{
"value": "{{root}}",
"name": "message"
}
]
},
"deleteDestination": {
"url": "https://your-webhook-site/0bd222fa-8ae2-433b-8f0e-f2ce137b0ee4/{{customerData.customerID}}/deleteDestination",
"httpMethod": "DELETE",
"headers": [
{
"value": "Bearer {{authData.token}}",
"header": "Authorization"
}
],
"responseErrorFields": [
{
"value": "{{root}}",
"name": "message"
}
]
}
},
"validations":[
{
"field":"string",
"regex":"string"
}
]
}'
name
url
https://adsapi.snapchat.com/v1/adaccounts/{{customerData.accountId}}/segments
e https://api.linkedin.com/v2/dmpSegments/{{segment.alias}}
.httpMethod
POST
, PUT
, DELETE
headers.header
"Content-Type"
headers.value
"application/x-www-form-urlencoded"
requestBody
requestBody
dipendono dai campi accettati dall'API. Per informazioni su cosa includere nel corpo del messaggio, consultare la documentazione sulle macro supportate.responseFields.name
responseFields.value
responseErrorFields.name
responseErrorFields.value
validations.field
{{validations.accountId}}
per convalidare l'ID account dell'utente.validations.regex
Gestione degli errori API
Gli endpoint API di Destination SDK seguono i principi generali dei messaggi di errore API di Experience Platform. Consulta Codici di stato API e errori di intestazione della richiesta nella guida alla risoluzione dei problemi di Experience Platform.
Passaggi successivi
Dopo aver letto questo documento, ora sai quando utilizzare i modelli di pubblico e come configurare un modello di pubblico utilizzando l'endpoint API /authoring/audience-templates
. Leggi come utilizzare Destination SDK per configurare la tua destinazione per capire in che modo questo passaggio si inserisce nel processo di configurazione della tua destinazione.