Dokumentation Experience Platform Användarhandbok om destinationer

Uppdatera en målgruppsmall

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

Ämnen:
Destinationer

Skapat för:

Administratör
Användare

IMPORTANT

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

Den här sidan innehåller exempel på API-begäran och nyttolast som du kan använda för att uppdatera en målgruppsmall med API-slutpunkten /authoring/audience-templates.

En detaljerad beskrivning av de funktioner som du kan konfigurera via den här slutpunkten finns i hantering av målgruppsmetadata.

IMPORTANT

Alla parameternamn och värden som stöds av Destinationen SDK är skiftlägeskänsliga. Undvik skiftlägeskänslighetsfel genom att använda parameternamn och värden exakt som de visas i dokumentationen.

Komma igång med API-åtgärder för målgruppsmallar get-started

Innan du fortsätter bör du läsa igenom kom igång-guiden för att få viktig information som du behöver känna till för att kunna ringa anrop till API:t, inklusive hur du får nödvändig behörighet för målredigering och nödvändiga rubriker.

Uppdatera en målgruppsmall create

Du kan uppdatera en befintlig målgruppsmall genom att göra en PUT-förfrågan till /authoring/audience-templates-slutpunkten med den uppdaterade nyttolasten.

Om du vill hämta en befintlig målgruppsmall och dess motsvarande {INSTANCE_ID} kan du läsa artikeln om att hämta en målgruppsmall.

API-format

PUT /authoring/audience-templates/{INSTANCE_ID}

Parameter

Beskrivning

{INSTANCE_ID}

ID:t för målgruppsmallen som du vill uppdatera. Mer information om hur du hämtar en befintlig målgruppsmall och dess motsvarande {INSTANCE_ID} finns i Hämta en målgruppsmall.

Följande begäran uppdaterar en befintlig målgruppsmetadatamall som konfigurerats med parametrarna i nyttolasten.

Begäran

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"
      }
   ]
}'

svar

Ett lyckat svar returnerar HTTP-status 200 med information om den uppdaterade målgruppsmallen.

API-felhantering

Destination SDK-API-slutpunkter följer de allmänna felmeddelandeprinciperna för Experience Platform API. Se API-statuskoder och begäranrubrikfel i felsökningsguiden för plattformen.

Nästa steg

När du har läst det här dokumentet vet du nu när du ska använda målgruppsmallar och hur du uppdaterar en målgruppsmall med API-slutpunkten /authoring/audience-templates. Läs om hur du använder Destination SDK för att konfigurera ditt mål och förstå var det här steget passar in i processen att konfigurera ditt mål.

recommendation-more-help

7f4d1967-bf93-4dba-9789-bb6b505339d6