Een doelconfiguratie maken
Deze pagina illustreert de API aanvraag en lading die u kunt gebruiken om uw eigen bestemmingsconfiguratie tot stand te brengen, gebruikend /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
Controleer voordat je doorgaat de gids Aan de slag voor belangrijke informatie die u moet weten om met succes vraag aan API te maken, met inbegrip van hoe te om de vereiste toestemming van de bestemmings creatie en vereiste kopballen te verkrijgen.
Een doelconfiguratie maken create
U kunt een nieuwe bestemmingsconfiguratie tot stand brengen door een verzoek van de POST aan /authoring/destinations
eindpunt.
platform.adobe.io/data/core/activation/authoring/destinations
API-indeling
POST /authoring/destinations
Met de volgende aanvraag wordt een nieuwe Amazon S3 bestemmingsconfiguratie, die door de parameters wordt gevormd die in de lading worden verstrekt. De hieronder vermelde lading omvat alle parameters voor op dossier-gebaseerde bestemmingen die door /authoring/destinations
eindpunt.
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 . Gebruiken 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 klantverificatieconfiguratie voor gedetailleerde informatie over de gesteunde authentificatietypen. |
customerDataFields.name |
String | Geef een naam op voor het aangepaste veld dat u introduceert. Zie Gegevensvelden van de klant voor gedetailleerde informatie over deze instellingen. {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 Gegevensvelden van de klant voor gedetailleerde informatie over deze instellingen. |
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 Gegevensvelden van de klant voor gedetailleerde informatie over deze instellingen. |
customerDataFields.description |
String | Geef een beschrijving op voor het aangepaste veld. Zie Gegevensvelden van de klant voor gedetailleerde informatie over deze instellingen. |
customerDataFields.isRequired |
Boolean | Geeft aan of dit veld vereist is in de workflow voor doelinstellingen. Zie Gegevensvelden van de klant voor gedetailleerde informatie over deze instellingen. |
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 Gegevensvelden van de klant voor gedetailleerde informatie over deze instellingen. |
customerDataFields.default |
String | Hiermee wordt de standaardwaarde van een enum lijst. |
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]+$ op dit gebied.Zie Gegevensvelden van de klant voor gedetailleerde informatie over deze instellingen. |
uiAttributes.documentationLink |
String | Verwijst naar de documentatiepagina in Doelcatalogus voor uw bestemming. Gebruiken https://www.adobe.com/go/destinations-YOURDESTINATION-en , waarbij YOURDESTINATION is de naam van uw bestemming. Voor een bestemming genoemd Moviestar, zou u gebruiken 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 UI-kenmerken voor gedetailleerde informatie over deze instellingen. {width="100" modal="regular"} |
uiAttributes.category |
String | Verwijst naar de rubriek die aan je bestemming in Adobe Experience Platform is toegewezen. Lees voor meer informatie Doelcategorieën. 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 UI-kenmerken voor gedetailleerde informatie over deze instellingen. |
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. Instellen op Streaming voor API-gebaseerde integratie, of 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 | Geeft aan of klanten identiteiten kunnen toewijzen die horen bij aangepaste naamruimten aan de identiteit die u vormt. |
identityNamespaces.externalId.transformation |
String | Niet weergegeven in voorbeeldconfiguratie. Wordt bijvoorbeeld gebruikt als de Platform de klant heeft onbewerkte e-mailadressen als attribuut en uw platform accepteert alleen gehashte e-mailadressen. 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 |
- | Geeft aan welke standaardnaamruimten (bijvoorbeeld, IDFA) klanten kunnen aan de identiteit in kaart brengen die u vormt. Wanneer u acceptedGlobalNamespaces kunt u "requiredTransformation":"sha256(lower($))" om e-mailadressen of telefoonnummers in kleine letters en te hashen. |
destinationDelivery.authenticationRule |
String |
Geeft aan hoe Platform klanten verbinden met uw bestemming. Accepteerde waarden zijn
|
destinationDelivery.destinationServerId |
String | De instanceId van de doelserversjabloon gebruikt voor deze bestemming. |
backfillHistoricalProfileData |
Boolean | Bepaalt of historische profielgegevens worden geëxporteerd wanneer het publiek wordt geactiveerd naar het doel. Altijd instellen 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 | De instanceId van de sjabloon voor doelmetagegevens gebruikt voor deze bestemming. |
schemaConfig.profileFields |
Array | Wanneer u vooraf gedefinieerde profileFields zoals aangetoond in de configuratie hierboven, zullen de gebruikers de optie hebben om de attributen van het Experience Platform aan de vooraf bepaalde attributen op de kant van uw bestemming in kaart te brengen. |
schemaConfig.profileRequired |
Boolean | Gebruiken true als de gebruikers profielattributen van Experience Platform aan douanekenmerken op de kant van uw bestemming zouden moeten kunnen in kaart brengen, zoals aangetoond in de voorbeeldconfiguratie hierboven. |
schemaConfig.segmentRequired |
Boolean | Altijd gebruiken segmentRequired:true . |
schemaConfig.identityRequired |
Boolean | Gebruiken true als u gebruikers identiteitsnaamruimten van Experience Platform aan uw gewenste schema zou moeten kunnen in kaart brengen. |
API-foutafhandeling
Destination SDK API-eindpunten volgen de algemene API-foutberichtbeginselen voor Experience Platforms. Zie API-statuscodes en aanvragen, koptekstfouten in 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 de Destination SDK /authoring/destinations
API-eindpunt.
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: