Dokumentation Experience Platform Zielhandbuch

Aktualisieren einer Zielgruppenvorlage

Last update: Mon Jul 29 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Themen:
Ziele

Erstellt für:

Admin
Benutzende

IMPORTANT

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

Auf dieser Seite werden die API-Anfrage und die Payload erläutert, die Sie verwenden können, um eine Zielgruppenvorlage mithilfe des API-Endpunkts /authoring/audience-templates zu aktualisieren.

Eine ausführliche Beschreibung der Funktionen, die Sie über diesen Endpunkt konfigurieren können, finden Sie unter Verwaltung von Zielgruppen-Metadaten.

IMPORTANT

Bei allen von Destination SDK unterstützten Parameternamen und Werten wird nach Groß-/Kleinschreibung unterschieden. Um Fehler bei der Groß-/Kleinschreibung zu vermeiden, verwenden Sie bitte die Parameternamen und -werte genau wie in der Dokumentation dargestellt.

Erste Schritte mit API-Vorgängen für Zielgruppenvorlagen get-started

Bevor Sie fortfahren, lesen Sie Erste Schritte. Dort finden Sie die nötigen Informationen für den erfolgreichen Aufruf der API, einschließlich Details für den Abruf der erforderlichen Authoring-Berechtigung für Ziele und zu den erforderlichen Kopfzeilen.

Aktualisieren einer Zielgruppenvorlage create

Sie können eine vorhandene Zielgruppenvorlage aktualisieren, indem Sie eine PUT-Anfrage mit der aktualisierten Payload an den Endpunkt /authoring/audience-templates stellen.

Wie Sie eine vorhandene Zielgruppenvorlage und die zugehörige {INSTANCE_ID} abrufen, erfahren Sie im Artikel zum Abrufen einer Zielgruppenvorlage.

API-Format

PUT /authoring/audience-templates/{INSTANCE_ID}

Parameter

Beschreibung

{INSTANCE_ID}

Die ID der Zielgruppenvorlage, die Sie aktualisieren möchten. Wie Sie eine vorhandene Zielgruppenvorlage und die zugehörige {INSTANCE_ID} abrufen, erfahren Sie unter Abrufen einer Zielgruppenvorlage.

Mit der folgenden Anfrage wird eine vorhandene Vorlage für Zielgruppen-Metadaten aktualisiert, die durch die in der Payload bereitgestellten Parameter konfiguriert wird.

Anfrage

code language-shell

code language-shell
curl -X POST 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 POST 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"
      }
   ]
}'

Antwort

Bei einer erfolgreichen Antwort wird der HTTP-Status 200 mit den Details der neu erstellten Zielgruppenvorlage zurückgegeben.

Umgang mit API-Fehlern

Destination SDK-API-Endpunkte folgen den allgemeinen Grundsätzen von Experience Platform API-Fehlermeldungen. Siehe API-Status-Codes und Fehler im Anfrage-Header in der Anleitung zur Fehlerbehebung für Platform.

Nächste Schritte

Nach dem Lesen dieses Dokuments wissen Sie jetzt, wann Sie Zielgruppenvorlagen verwenden sollten und wie Sie eine Zielgruppenvorlage mithilfe des API-Endpunkts /authoring/audience-templates aktualisieren. Lesen Sie Verwenden des Destination SDK zum Konfigurieren Ihres Ziels, um zu verstehen, wo dieser Schritt in den Prozess der Konfiguration Ihres Ziels passt.

recommendation-more-help

7f4d1967-bf93-4dba-9789-bb6b505339d6