Documentación Experience Platform Guía de destinos

Actualización de una plantilla de audiencia

Last update: Wed Mar 25 2026 00:00:00 GMT+0000 (Coordinated Universal Time)

Temas:
Destinos

Creado para:

Administrador
Usuario

IMPORTANT

extremo de API: platform.adobe.io/data/core/activation/authoring/audience-templates

Esta página ejemplifica la solicitud de API y la carga útil que puede utilizar para actualizar una plantilla de audiencia mediante el extremo de API /authoring/audience-templates.

Para obtener una descripción detallada de las funcionalidades que puede configurar a través de este extremo, consulte gestión de metadatos de audiencia.

IMPORTANT

Todos los nombres y valores de parámetro admitidos por Destination SDK distinguen entre mayúsculas y minúsculas 1}. Para evitar errores de distinción entre mayúsculas y minúsculas, utilice los nombres y valores de los parámetros exactamente como se muestra en la documentación.

Introducción a las operaciones de API de plantillas de audiencia get-started

Antes de continuar, revisa la guía de introducción para obtener información importante que necesitas saber para realizar llamadas a la API correctamente, incluyendo cómo obtener el permiso de creación de destino requerido y los encabezados requeridos.

Actualización de una plantilla de audiencia create

Puede actualizar una plantilla de audiencia existing realizando una solicitud PUT al extremo /authoring/audience-templates con la carga útil actualizada.

Para obtener una plantilla de audiencia existente y sus {INSTANCE_ID} correspondientes, consulte el artículo acerca de recuperar una plantilla de audiencia.

Formato de API

PUT /authoring/audience-templates/{INSTANCE_ID}

Parámetro

Descripción

{INSTANCE_ID}

El ID de la plantilla de audiencia que desea actualizar. Para obtener una plantilla de audiencia existente y sus {INSTANCE_ID} correspondientes, vea Recuperar una plantilla de audiencia.

La siguiente solicitud actualiza una plantilla de metadatos de audiencia existente, configurada por los parámetros proporcionados en la carga útil.

Solicitud

code language-shell

code language-shell
curl -X PUT https://platform.adobe.io/data/core/activation/authoring/audience-templates/{INSTANCE_ID} \ -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" } ] }'

curl -X PUT https://platform.adobe.io/data/core/activation/authoring/audience-templates/{INSTANCE_ID} \
 -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"
      }
   ]
}'

Respuesta

Una respuesta correcta devuelve el estado HTTP 200 con detalles de la plantilla de audiencia actualizada.

Administración de errores de API error-handling

Los extremos de la API de Destination SDK siguen los principios generales del mensaje de error de la API de Experience Platform. Consulte Códigos de estado de API y errores de encabezado de solicitud en la guía de solución de problemas de Experience Platform.

Próximos pasos next-steps

Después de leer este documento, sabe cuándo usar plantillas de audiencia y cómo actualizar una plantilla de audiencia mediante el punto de conexión de API /authoring/audience-templates. Lee cómo usar Destination SDK para configurar tu destino para saber dónde encaja este paso en el proceso de configuración de tu destino.

recommendation-more-help

7f4d1967-bf93-4dba-9789-bb6b505339d6