Skapa en målkonfiguration

Den här sidan innehåller exempel på API-begäran och nyttolast som du kan använda för att skapa en egen målkonfiguration med API-slutpunkten /authoring/destinations.

En detaljerad beskrivning av de funktioner som du kan konfigurera via den här slutpunkten finns i följande artiklar:

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ålkonfiguration 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.

Skapa en målkonfiguration create

Du kan skapa en ny målkonfiguration genom att göra en POST-förfrågan till slutpunkten /authoring/destinations.

TIP
API-slutpunkt: platform.adobe.io/data/core/activation/authoring/destinations

API-format

POST /authoring/destinations

Följande begäran skapar en ny Amazon S3-destinationskonfiguration, konfigurerad med parametrarna som anges i nyttolasten. Nyttolasten nedan innehåller alla parametrar för filbaserade mål som accepteras av slutpunkten /authoring/destinations.

Observera att du inte behöver lägga till alla parametrar i API-anropet och att nyttolasten kan anpassas enligt dina API-krav.

Begäran
code language-shell
curl -X POST https://platform.adobe.io/data/core/activation/authoring/destinations \
 -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 '
{
   "name":"Amazon S3 destination with predefined CSV formatting options",
   "description":"Amazon S3 destination with predefined CSV formatting options",
   "status":"TEST",
   "customerAuthenticationConfigurations":[
      {
         "authType":"S3"
      }
   ],
   "customerDataFields":[
      {
         "name":"bucket",
         "title":"Enter the name of your Amazon S3 bucket",
         "description":"Amazon S3 bucket name",
         "type":"string",
         "isRequired":true,
         "readOnly":false,
         "hidden":false
      },
      {
         "name":"path",
         "title":"Enter the path to your S3 bucket folder",
         "description":"Enter the path to your S3 bucket folder",
         "type":"string",
         "isRequired":true,
         "pattern":"^[A-Za-z]+$",
         "readOnly":false,
         "hidden":false
      },
      {
         "name":"compression",
         "title":"Compression format",
         "description":"Select the desired file compression format.",
         "type":"string",
         "isRequired":true,
         "readOnly":false,
         "enum":[
            "SNAPPY",
            "GZIP",
            "DEFLATE",
            "NONE"
         ]
      },
      {
         "name":"fileType",
         "title":"Select a fileType",
         "description":"Select fileType",
         "type":"string",
         "isRequired":true,
         "readOnly":false,
         "hidden":false,
         "enum":[
            "csv",
            "json",
            "parquet"
         ],
         "default":"csv"
      }
   ],
   "uiAttributes":{
      "documentationLink":"https://www.adobe.com/go/destinations-amazon-s3-en",
      "category":"cloudStorage",
      "icon":{
         "key":"amazonS3"
      },
      "connectionType":"S3",
      "frequency":"Batch"
   },
   "destinationDelivery":[
      {
         "deliveryMatchers":[
            {
               "type":"SOURCE",
               "value":[
                  "batch"
               ]
            }
         ],
         "authenticationRule":"CUSTOMER_AUTHENTICATION",
         "destinationServerId":"{{destinationServerId}}"
      }
   ],
   "schemaConfig":{
      "profileRequired":true,
      "segmentRequired":true,
      "identityRequired":true
   },
   "batchConfig":{
      "allowMandatoryFieldSelection":true,
      "allowDedupeKeyFieldSelection":true,
      "defaultExportMode":"DAILY_FULL_EXPORT",
      "allowedExportMode":[
         "DAILY_FULL_EXPORT",
         "FIRST_FULL_THEN_INCREMENTAL"
      ],
      "allowedScheduleFrequency":[
         "DAILY",
         "EVERY_3_HOURS",
         "EVERY_6_HOURS",
         "EVERY_8_HOURS",
         "EVERY_12_HOURS",
         "ONCE"
      ],
      "defaultFrequency":"DAILY",
      "defaultStartTime":"00:00",
      "filenameConfig":{
         "allowedFilenameAppendOptions":[
            "SEGMENT_NAME",
            "DESTINATION_INSTANCE_ID",
            "DESTINATION_INSTANCE_NAME",
            "ORGANIZATION_NAME",
            "SANDBOX_NAME",
            "DATETIME",
            "CUSTOM_TEXT"
         ],
         "defaultFilenameAppendOptions":[
            "DATETIME"
         ],
         "defaultFilename":"%DESTINATION%_%SEGMENT_ID%"
      },
      "backfillHistoricalProfileData":true
   }
}'
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 7-row-3 8-row-3 9-row-3 10-row-3 11-row-3 12-row-3 13-row-3 14-row-3 15-row-3 16-row-3 17-row-3 18-row-3 19-row-3 20-row-3 21-row-3 22-row-3 23-row-3 24-row-3 25-row-3 26-row-3 27-row-3 28-row-3 29-row-3 30-row-3 31-row-3 layout-auto
Parameter Typ Beskrivning
name Sträng Anger målets namn i Experience Platform-katalogen.
description Sträng Ange en beskrivning som Adobe ska använda i Experience Platform-destinationskatalogen för ditt destinationskort. Rikta dig för högst 4-5 meningar. Plattformens gränssnittsbild visar målbeskrivningen. {width="100" modal="regular"}
status Sträng Anger målkortets livscykelstatus. Godkända värden är TEST, PUBLISHED och DELETED. Använd TEST när du först konfigurerar ditt mål.
customerAuthenticationConfigurations.authType Sträng Anger den konfiguration som används för att autentisera Experience Platform-kunder till målservern. Mer information om vilka autentiseringstyper som stöds finns i konfiguration för kundautentisering.
customerDataFields.name Sträng Ange ett namn för det anpassade fält som du introducerar.

Mer information om de här inställningarna finns i Kunddatafält. Plattformsgränssnittsbild som visar kunddatafält. {width="100" modal="regular"}
customerDataFields.type Sträng Anger vilken typ av anpassat fält du introducerar. Godkända värden är string, object, integer.

Mer information om de här inställningarna finns i Kunddatafält.
customerDataFields.title Sträng Anger fältets namn, så som det visas för kunder i användargränssnittet i Experience Platform.

Mer information om de här inställningarna finns i Kunddatafält.
customerDataFields.description Sträng Ange en beskrivning för det anpassade fältet. Mer information om de här inställningarna finns i Kunddatafält.
customerDataFields.isRequired Boolean Anger om det här fältet är obligatoriskt i arbetsflödet för målkonfiguration.

Mer information om de här inställningarna finns i Kunddatafält.
customerDataFields.enum Sträng Återger det anpassade fältet som en listruta och visar de alternativ som är tillgängliga för användaren.

Mer information om de här inställningarna finns i Kunddatafält.
customerDataFields.default Sträng Definierar standardvärdet från en enum-lista.
customerDataFields.pattern Sträng Tvingar fram ett mönster för det anpassade fältet, om det behövs. Använd reguljära uttryck för att framtvinga ett mönster. Om dina kund-ID till exempel inte innehåller siffror eller understreck anger du ^[A-Za-z]+$ i det här fältet.

Mer information om de här inställningarna finns i Kunddatafält.
uiAttributes.documentationLink Sträng Refererar till dokumentationssidan i målkatalogen för ditt mål. Använd https://www.adobe.com/go/destinations-YOURDESTINATION-en, där YOURDESTINATION är namnet på målet. För ett mål som heter Moviestar använder du https://www.adobe.com/go/destinations-moviestar-en. Observera att den här länken bara fungerar när Adobe har aktiverat målet och dokumentationen har publicerats.

Mer information om de här inställningarna finns i Gränssnittsattribut. Plattformsgränssnittsbild som visar dokumentationslänken. {width="100" modal="regular"}
uiAttributes.category Sträng Hänvisar till den kategori som tilldelats ditt mål i Adobe Experience Platform. Mer information finns i Målkategorier. Använd ett av följande värden: adobeSolutions, advertising, analytics, cdp, cloudStorage, crm, customerSuccess, database, dmp, ecommerce, email, emailMarketing, enrichment, livechat, marketingAutomation, mobile, personalization, protocols, social, streaming, subscriptions, surveys, tagManagers, voc, warehouses, payments.

Mer information om de här inställningarna finns i Gränssnittsattribut.
uiAttributes.connectionType Sträng

Vilken typ av anslutning det är, beroende på målet. Värden som stöds:

  • Server-to-server
  • Cloud storage
  • Azure Blob
  • Azure Data Lake Storage
  • S3
  • SFTP
  • DLZ
uiAttributes.frequency Sträng Hänvisar till den typ av dataexport som stöds av målet. Ange Streaming för API-baserade integreringar eller Batch när du exporterar filer till dina mål.
identityNamespaces.externalId.acceptsAttributes Boolean Anger om kunder kan mappa standardprofilattribut till identiteten som du konfigurerar.
identityNamespaces.externalId.acceptsCustomNamespaces Boolean Anger om kunderna kan mappa identiteter som tillhör anpassade namnutrymmen till identiteten som du konfigurerar.
identityNamespaces.externalId.transformation Sträng Visas inte i exempelkonfigurationen. Används till exempel när kunden Platform har oformaterade e-postadresser som attribut och din plattform bara accepterar hashkodade e-postmeddelanden. Här anger du den omformning som ska användas (till exempel transformera e-postmeddelandet till gemener och sedan hash).
identityNamespaces.externalId.acceptedGlobalNamespaces Anger vilka standardidentitetsnamnutrymmen (till exempel IDFA) som kunder kan mappa till identiteten som du konfigurerar.
När du använder acceptedGlobalNamespaces kan du använda "requiredTransformation":"sha256(lower($))" för att skriva ned gemener och skicka e-postadresser eller telefonnummer med hash-kod.
destinationDelivery.authenticationRule Sträng

Anger hur Platform-kunder ansluter till ditt mål. Godkända värden är CUSTOMER_AUTHENTICATION, PLATFORM_AUTHENTICATION, NONE.

  • Använd CUSTOMER_AUTHENTICATION om plattformskunder loggar in på ditt system via ett användarnamn och lösenord, en innehavartoken eller någon annan autentiseringsmetod. Du kan till exempel välja det här alternativet om du även har markerat authType: OAUTH2 eller authType:BEARER i customerAuthenticationConfigurations.
  • Använd PLATFORM_AUTHENTICATION om det finns ett globalt autentiseringssystem mellan Adobe och ditt mål och Platform-kunden inte behöver ange några autentiseringsuppgifter för att ansluta till ditt mål. I det här fallet måste du skapa ett autentiseringsobjekt med hjälp av API:t för autentiseringsuppgifter-konfigurationen.
  • Använd NONE om ingen autentisering krävs för att skicka data till målplattformen.
destinationDelivery.destinationServerId Sträng instanceId för målservermallen som används för det här målet.
backfillHistoricalProfileData Boolean Anger om historiska profildata exporteras när målgrupper aktiveras till målet. Ange alltid detta till true.
segmentMappingConfig.mapUserInput Boolean Kontrollerar om målgruppsmappnings-ID:t i målaktiveringsarbetsflödet anges av användaren.
segmentMappingConfig.mapExperiencePlatformSegmentId Boolean Styr om målgruppsmappnings-ID:t i målaktiveringsarbetsflödet är Experience Platform målgrupps-ID:t.
segmentMappingConfig.mapExperiencePlatformSegmentName Boolean Styr om målgruppsmappnings-ID:t i målaktiveringsarbetsflödet är Experience Platform målgruppsnamnet.
segmentMappingConfig.audienceTemplateId Sträng instanceId för målgruppens metadatamall som används för det här målet.
schemaConfig.profileFields Array När du lägger till fördefinierade profileFields enligt konfigurationen ovan kan användare välja att mappa Experience Platform-attribut till de fördefinierade attributen på målsidan.
schemaConfig.profileRequired Boolean Använd true om användare ska kunna mappa profilattribut från Experience Platform till anpassade attribut på målsidan, vilket visas i exempelkonfigurationen ovan.
schemaConfig.segmentRequired Boolean Använd alltid segmentRequired:true.
schemaConfig.identityRequired Boolean Använd true om du vill att användare ska kunna mappa identitetsnamnutrymmen från Experience Platform till det önskade schemat.
svar
Ett lyckat svar returnerar HTTP-status 200 med information om den nya målkonfigurationen.

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 hur du skapar en ny målkonfiguration via API-slutpunkten för Destinationen SDK /authoring/destinations.

Mer information om vad du kan göra med den här slutpunkten finns i följande artiklar:

Mer information om var den här slutpunkten passar in i målredigeringsprocessen finns i följande artiklar:

recommendation-more-help
7f4d1967-bf93-4dba-9789-bb6b505339d6