Een doelconfiguratie maken
Deze pagina illustreert de API aanvraag en lading die u kunt gebruiken om uw eigen bestemmingsconfiguratie tot stand te brengen, gebruikend het /authoring/destinations
API eindpunt.
Voor een gedetailleerde beschrijving van de mogelijkheden die u door dit eindpunt kunt vormen, lees de volgende artikelen:
- Configuratie van klantverificatie
- OAuth2-vergunning
- Gegevensvelden van de klant
- UI-kenmerken
- Schema-configuratie
- Configuratie naamruimte voor identiteit
- Levering bestemming
- Configuratie van metagegevens voor publiek
- Configuratie van metagegevens voor publiek
- Samenvoegingsbeleid
- Batchconfiguratie
- Historische profielkwalificaties
Aan de slag met API-bewerkingen voor doelconfiguratie get-started
Alvorens verder te gaan, te herzien gelieve begonnen gidsvoor belangrijke informatie die u moet kennen om vraag aan API met succes te maken, met inbegrip van hoe te om de vereiste toestemming van de bestemmings authoring en vereiste kopballen te verkrijgen.
Een doelconfiguratie maken create
U kunt een nieuwe bestemmingsconfiguratie tot stand brengen door een verzoek van de POST aan het /authoring/destinations
eindpunt te doen.
platform.adobe.io/data/core/activation/authoring/destinations
API formaat
POST /authoring/destinations
Het volgende verzoek leidt tot een nieuwe Amazon S3 bestemmingsconfiguratie, die door de parameters wordt gevormd die in de lading worden verstrekt. De nuttige lading omvat hieronder alle parameters voor op dossier-gebaseerde bestemmingen die door het /authoring/destinations
eindpunt worden goedgekeurd.
U hoeft niet alle parameters aan uw API-aanroep toe te voegen en de laadbewerking kan worden aangepast aan uw API-vereisten.
code language-shell |
---|
|
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 | Type | Beschrijving |
name |
String | Geeft de titel van het doel in de catalogus met Experience Platforms aan. |
description |
String | Geef een beschrijving op die de Adobe in de catalogus met Experience Platforms-doelen voor uw doelkaart zal gebruiken. Doel voor niet meer dan 4-5 zinnen. {width="100" modal="regular"} |
status |
String | Geeft de levenscyclusstatus van de doelkaart aan. Accepteerde waarden zijn TEST , PUBLISHED en DELETED . Gebruik TEST wanneer u eerst uw bestemming vormt. |
customerAuthenticationConfigurations.authType |
String | Wijst op de configuratie die wordt gebruikt om de klanten van het Experience Platform aan uw bestemmingsserver voor authentiek te verklaren. Zie configuratie van de klantenauthentificatievoor gedetailleerde informatie over de gesteunde authentificatietypen. |
customerDataFields.name |
String | Geef een naam op voor het aangepaste veld dat u introduceert. zie {de gegevensgebieden van 1} Klant 🔗 voor gedetailleerde informatie over deze montages. {width="100" modal="regular"} |
customerDataFields.type |
String | Hiermee geeft u aan welk type aangepast veld u wilt gebruiken. Accepteerde waarden zijn string , object , integer .zie {de gegevensgebieden van 1} Klant 🔗 voor gedetailleerde informatie over deze montages. |
customerDataFields.title |
String | Hiermee wordt de naam van het veld aangegeven, zoals deze wordt weergegeven door klanten in de gebruikersinterface van het Experience Platform. zie {de gegevensgebieden van 1} Klant 🔗 voor gedetailleerde informatie over deze montages. |
customerDataFields.description |
String | Geef een beschrijving op voor het aangepaste veld. Zie {de gegevensgebieden van 0} Klant 🔗 voor gedetailleerde informatie over deze montages. |
customerDataFields.isRequired |
Boolean | Geeft aan of dit veld vereist is in de workflow voor doelinstellingen. zie {de gegevensgebieden van 1} Klant 🔗 voor gedetailleerde informatie over deze montages. |
customerDataFields.enum |
String | Hiermee geeft u het aangepaste veld weer als een vervolgkeuzemenu en geeft u de opties weer die beschikbaar zijn voor de gebruiker. zie {de gegevensgebieden van 1} Klant 🔗 voor gedetailleerde informatie over deze montages. |
customerDataFields.default |
String | Definieert de standaardwaarde in de lijst enum . |
customerDataFields.pattern |
String | Hiermee wordt, indien nodig, een patroon voor het aangepaste veld afgedwongen. Gebruik reguliere expressies om een patroon af te dwingen. Als uw klant-id's bijvoorbeeld geen cijfers of onderstrepingstekens bevatten, voert u ^[A-Za-z]+$ in dit veld in.zie {de gegevensgebieden van 1} Klant 🔗 voor gedetailleerde informatie over deze montages. |
uiAttributes.documentationLink |
String | Verwijst naar de documentatiepagina in de Catalogus van Doelenvoor uw bestemming. Gebruik https://www.adobe.com/go/destinations-YOURDESTINATION-en , waarbij YOURDESTINATION de naam van het doel is. Voor een doel met de naam Moviestar gebruikt u https://www.adobe.com/go/destinations-moviestar-en . Merk op dat deze verbinding slechts werkt nadat de Adobe uw bestemming live plaatst en de documentatie wordt gepubliceerd.zie attributen UIvoor gedetailleerde informatie over deze montages. {width="100" modal="regular"} |
uiAttributes.category |
String | Verwijst naar de rubriek die aan je bestemming in Adobe Experience Platform is toegewezen. Voor meer informatie, lees Categorieën van de Bestemming. Gebruik een van de volgende waarden: 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 .zie attributen UIvoor gedetailleerde informatie over deze montages. |
uiAttributes.connectionType |
String |
Het type verbinding, afhankelijk van het doel. Ondersteunde waarden:
|
uiAttributes.frequency |
String | Verwijst naar het type gegevens die worden uitgevoerd door de bestemming wordt gesteund. Stel dit in op Streaming voor API-gebaseerde integratie of op Batch wanneer u bestanden exporteert naar uw doelen. |
identityNamespaces.externalId.acceptsAttributes |
Boolean | Geeft aan of klanten standaardprofielkenmerken kunnen toewijzen aan de identiteit die u configureert. |
identityNamespaces.externalId.acceptsCustomNamespaces |
Boolean | Wijst erop als de klanten identiteiten kunnen in kaart brengen die tot douane namespacesbehoren aan de identiteit die u vormt. |
identityNamespaces.externalId.transformation |
String | niet getoond in voorbeeldconfiguratie. Wordt bijvoorbeeld gebruikt wanneer de klant van Platform normale e-mailadressen heeft als attribuut en uw platform alleen gehashte e-mails accepteert. Hier geeft u de transformatie op die moet worden toegepast (zet de e-mail bijvoorbeeld om in kleine letters en vervolgens in de hash). |
identityNamespaces.externalId.acceptedGlobalNamespaces |
- | Wijst op welke standaardidentiteit namespaces(bijvoorbeeld, IDFA) klanten aan de identiteit kunnen in kaart brengen die u vormt. Wanneer u acceptedGlobalNamespaces gebruikt, kunt u "requiredTransformation":"sha256(lower($))" gebruiken om e-mailadressen of telefoonnummers in kleine letters te plaatsen en te hashen. |
destinationDelivery.authenticationRule |
String |
Geeft aan hoe Platform -klanten verbinding maken met uw doel. Accepteerde waarden zijn
|
destinationDelivery.destinationServerId |
String | instanceId van het malplaatje van de bestemmingsserverdat voor deze bestemming wordt gebruikt. |
backfillHistoricalProfileData |
Boolean | Bepaalt of historische profielgegevens worden geëxporteerd wanneer het publiek wordt geactiveerd naar het doel. Stel dit altijd in op true . |
segmentMappingConfig.mapUserInput |
Boolean | Controls whether the publiek mapping ID in the destination activation workflow is input by user. |
segmentMappingConfig.mapExperiencePlatformSegmentId |
Boolean | Bepaalt of de publiekstoewijzings-id in de workflow voor doelactivering de Experience Platform-gebruikers-id is. |
segmentMappingConfig.mapExperiencePlatformSegmentName |
Boolean | Bepaalt of de publiekstoewijzings-id in de workflow voor doelactivering de publieksnaam van het Experience Platform is. |
segmentMappingConfig.audienceTemplateId |
String | instanceId van het malplaatje van publieksmeta-gegevensdat voor deze bestemming wordt gebruikt. |
schemaConfig.profileFields |
Array | Wanneer u vooraf gedefinieerde profileFields toevoegt, zoals in de bovenstaande configuratie wordt getoond, kunnen gebruikers de kenmerken van het Experience Platform toewijzen aan de vooraf gedefinieerde kenmerken aan de kant van uw bestemming. |
schemaConfig.profileRequired |
Boolean | Gebruik true als gebruikers profielkenmerken van Experience Platform aan douanekenmerken op de kant van uw bestemming, zoals aangetoond in de bovenstaande voorbeeldconfiguratie zouden moeten kunnen in kaart brengen. |
schemaConfig.segmentRequired |
Boolean | Altijd segmentRequired:true gebruiken. |
schemaConfig.identityRequired |
Boolean | Gebruik true als u gebruikers naamruimten van Experience Platform aan uw gewenste schema zou moeten kunnen toewijzen. |
API-foutafhandeling
Destination SDK API-eindpunten volgen de algemene API-foutberichtbeginselen voor Experience Platforms. Verwijs naar API statuscodesen de fouten van de verzoekkopbalin de het oplossen van problemengids van het Platform.
Volgende stappen
Nadat u dit document hebt gelezen, weet u nu hoe u een nieuwe doelconfiguratie kunt maken via het API-eindpunt Destination SDK /authoring/destinations
.
Raadpleeg de volgende artikelen voor meer informatie over wat u met dit eindpunt kunt doen:
Om te begrijpen waar dit eindpunt in het bestemmings auteursproces past, zie de volgende artikelen: