Gebruik Destination SDK om een streamingbestemming te configureren
Overzicht overview
Deze pagina beschrijft hoe te om de informatie in opties van de Configuratie in Doelen SDKen in andere Destination SDK functionaliteit en API verwijzingsdocumenten te gebruiken om a het stromen bestemmingte vormen. De stappen worden in de onderstaande volgorde weergegeven.
Vereisten prerequisites
Alvorens aan de hieronder getoonde stappen vooruit te gaan, te lezen gelieve Destination SDK begonnenpagina voor informatie over het verkrijgen van de noodzakelijke de authentificatiegeloofsbrieven van de Adobe I/O en andere eerste vereisten om met Destination SDK APIs te werken. Dit veronderstelt dat u het partnerschap en de toestemmingsvoorwaarden hebt voltooid en bereid bent te beginnen uw bestemming te ontwikkelen.
Stappen om de configuratieopties in Destination SDK aan opstelling te gebruiken uw bestemming steps
Stap 1: Maak een server en sjabloonconfiguratie create-server-template-configuration
Begin door creërend een server en malplaatjeconfiguratiegebruikend het /destinations-server eindpunt.
Hieronder ziet u een voorbeeldconfiguratie. Merk op dat het malplaatje van de berichttransformatie in de requestBody.value parameter in stap 3 wordt gericht, creeer transformatiemalplaatje.
POST platform.adobe.io/data/core/activation/authoring/destination-servers
{
"name":"Moviestar destination server",
"destinationServerType":"URL_BASED",
"urlBasedDestination":{
"url":{
"templatingStrategy":"PEBBLE_V1",
"value":"https://api.moviestar.com/data/{{customerData.region}}/items"
}
},
"httpTemplate":{
"httpMethod":"POST",
"requestBody":{
"templatingStrategy":"PEBBLE_V1",
"value":"insert after you create a template in step 3"
},
"contentType":"application/json"
}
}
Stap 2: Doelconfiguratie maken create-destination-configuration
Hieronder ziet u een voorbeeldconfiguratie voor een doelsjabloon die is gemaakt met het API-eindpunt van /destinations . Zie tot een bestemmingsconfiguratievoor meer informatie leiden.
Als u de server- en sjabloonconfiguratie in stap 1 wilt verbinden met deze doelconfiguratie, voegt u de instantie-id van de server en de sjabloonconfiguratie hier destinationServerId toe.
identityNamespaces toevoegen, zoals hieronder getoond. Als geen doelidentiteit wordt gevormd, zullen de gebruikers niet voorbij de stap van de Toewijzingvan het activeringswerkschema kunnen te werk gaan.POST platform.adobe.io/data/core/activation/authoring/destinations
{
"name":"Moviestar",
"description":"Moviestar is a fictional destination, used for this example.",
"status":"TEST",
"customerAuthenticationConfigurations":[
{
"authType":"BEARER"
}
],
"customerDataFields":[
{
"name":"endpointsInstance",
"type":"string",
"title":"Select Endpoint",
"description":"Moviestar manages several instances across the globe for REST endpoints that our customers are provisioned for. Select your endpoint in the dropdown list.",
"isRequired":true,
"enum":[
"US",
"EU",
"APAC",
"NZ"
]
},
{
"name":"customerID",
"type":"string",
"title":"Moviestar Customer ID",
"description":"Your customer ID in the Moviestar destination (e.g. abcdef).",
"isRequired":true,
"pattern":""
}
],
"uiAttributes":{
"documentationLink":"http://www.adobe.com/go/destinations-moviestar-en",
"category":"mobile",
"connectionType":"Server-to-server",
"frequency":"Streaming"
},
"identityNamespaces":{
"external_id":{
"acceptsAttributes":true,
"acceptsCustomNamespaces":true
},
"another_id":{
"acceptsAttributes":true,
"acceptsCustomNamespaces":true
}
},
"audienceMetadataConfig":{
"mapExperiencePlatformSegmentName":false,
"mapExperiencePlatformSegmentId":false,
"mapUserInput":false,
"audienceTemplateId":"cbf90a70-96b4-437b-86be-522fbdaabe9c"
},
"aggregation":{
"aggregationType":"CONFIGURABLE_AGGREGATION",
"configurableAggregation":{
"aggregationPolicyId":null,
"aggregationKey":{
"includeSegmentId":true,
"includeSegmentStatus":true,
"includeIdentity":true,
"oneIdentityPerGroup":true,
"groups":null
},
"splitUserById":true,
"maxBatchAgeInSecs":2400,
"maxNumEventsInBatch":5000
}
},
"destinationDelivery":[
{
"authenticationRule":"CUSTOMER_AUTHENTICATION",
"destinationServerId":"9c77000a-4559-40ae-9119-a04324a3ecd4"
}
]
}
Stap 3: Creeer het malplaatje van de berichttransformatie - gebruik de malplaatjetaal om het formaat van de berichtoutput te specificeren create-transformation-template
Gebaseerd op de ladingen die uw bestemming steunt, moet u een malplaatje creëren dat het formaat van de uitgevoerde gegevens van Adobe XDM formaat in een formaat omzet dat door uw bestemming wordt gesteund. Zie malplaatjevoorbeelden in de sectie Gebruikend een malplaatjetaal voor de identiteit, de attributen, en de transformaties van het publiekslidmaatschapen gebruik het malplaatje auteursgereedschapdat door Adobe wordt verstrekt.
Zodra u een malplaatje van de berichttransformatie hebt gecreeerd dat voor u werkt, voeg het aan de server en malplaatjeconfiguratie toe u in stap 1 creeerde.
{
"name":"Moviestar destination server",
"destinationServerType":"URL_BASED",
"urlBasedDestination":{
"url":{
"templatingStrategy":"PEBBLE_V1",
"value":"https://api.moviestar.com/data/{{customerData.region}}/items"
}
},
"httpTemplate":{
"requestBody":{
"templatingStrategy":"PEBBLE_V1",
"value":"{\n \"users\": [\n {% for profile in input.profiles %}\n {{profile|raw}}{% if not loop.last %},{% endif %}\n {% endfor %}\n ]\n}"
},
"contentType":"application/json"
}
}
Stap 4: configuratie van publiekmetagegevens maken create-audience-metadata-configuration
Voor sommige bestemmingen, vereist Destination SDK dat u een configuratie van publieksmeta-gegevens vormt om publiek in uw bestemming programmatically tot stand te brengen bij te werken of te schrappen. Verwijs naar het meta-gegevensbeheer van het publiekvoor informatie over wanneer u aan opstelling deze configuratie en hoe te om het te doen moet.
Als u een configuratie van publieksmeta-gegevens gebruikt, moet u het met de bestemmingsconfiguratie verbinden u in stap 2 creeerde. Voeg de instantie-id van de configuratie van de publieksmetagegevens als audienceTemplateId toe aan de doelconfiguratie.
{
"name":"Moviestar",
"description":"Moviestar is a fictional destination, used for this example.",
"status":"TEST",
"customerAuthenticationConfigurations":[
{
"authType":"BEARER"
}
],
"customerDataFields":[
{
"name":"endpointsInstance",
"type":"string",
"title":"Select Endpoint",
"description":"Moviestar manages several instances across the globe for REST endpoints that our customers are provisioned for. Select your endpoint in the dropdown list.",
"isRequired":true,
"enum":[
"US",
"EU",
"APAC",
"NZ"
]
},
{
"name":"customerID",
"type":"string",
"title":"Moviestar Customer ID",
"description":"Your customer ID in the Moviestar destination (e.g. abcdef).",
"isRequired":true,
"pattern":""
}
],
"uiAttributes":{
"documentationLink":"http://www.adobe.com/go/destinations-moviestar-en",
"category":"mobile",
"connectionType":"Server-to-server",
"frequency":"Streaming"
},
"identityNamespaces":{
"external_id":{
"acceptsAttributes":true,
"acceptsCustomNamespaces":true
},
"another_id":{
"acceptsAttributes":true,
"acceptsCustomNamespaces":true
}
},
"audienceMetadataConfig":{
"mapExperiencePlatformSegmentName":false,
"mapExperiencePlatformSegmentId":false,
"mapUserInput":false,
"audienceTemplateId":"cbf90a70-96b4-437b-86be-522fbdaabe9c"
},
"aggregation":{
"aggregationType":"CONFIGURABLE_AGGREGATION",
"configurableAggregation":{
"aggregationPolicyId":null,
"aggregationKey":{
"includeSegmentId":true,
"includeSegmentStatus":true,
"includeIdentity":true,
"oneIdentityPerGroup":true,
"groups":null
},
"splitUserById":true,
"maxBatchAgeInSecs":2400,
"maxNumEventsInBatch":5000
}
},
"destinationDelivery":[
{
"authenticationRule":"CUSTOMER_AUTHENTICATION",
"destinationServerId":"9c77000a-4559-40ae-9119-a04324a3ecd4"
}
]
}
Stap 5: De authentificatie van de opstelling set-up-authentication
Afhankelijk van of u "authenticationRule": "CUSTOMER_AUTHENTICATION" of "authenticationRule": "PLATFORM_AUTHENTICATION" opgeeft in de bovenstaande doelconfiguratie, kunt u verificatie voor uw doel instellen met het /destination - of /credentials -eindpunt.
CUSTOMER_AUTHENTICATION is de gemeenschappelijkere van de twee authentificatieregels en is te gebruiken als u gebruikers om één of andere vorm van authentificatie aan uw bestemming alvorens zij opstelling een verbinding en uitvoergegevens vereist te verstrekken.Als u "authenticationRule": "CUSTOMER_AUTHENTICATION" in de bestemmingsconfiguratie en uw bestemming selecteerde steunt OAuth 2 authentificatiemethode, lees OAuth 2 authentificatie.
Als u "authenticationRule": "PLATFORM_AUTHENTICATION" selecteerde, moet u de configuratie van de a geloofsbrieventot stand brengen.
Stap 6: Test uw bestemming test-destination
Na vestiging kunt uw bestemming die de configuratieeindpunten in de vorige stappen gebruiken, u het bestemmings testende hulpmiddelgebruiken om de integratie tussen Adobe Experience Platform en uw bestemming te testen.
Als deel van het proces om uw bestemming te testen, moet u het Experience Platform UI gebruiken om segmenten tot stand te brengen, die u aan uw bestemming zult activeren. Raadpleeg de twee onderstaande bronnen voor instructies voor het maken van publiek in Experience Platform:
Stap 7: Publish uw bestemming publish-destination
Na het vormen van en het testen van uw bestemming, gebruik bestemmings het publiceren APIom uw configuratie aan Adobe voor overzicht voor te leggen.
Stap 8: Documenteer uw bestemming document-destination
Als u een Onafhankelijke Verkoper van de Software (ISV) of Integrator van het Systeem (SI) creërend a geproduceerde integratiebent, gebruik het zelfbedienings documentatieprocesom een pagina van de productdocumentatie voor uw bestemming in de catalogus van de bestemmingen van het Experience Platformtot stand te brengen.
Stap 9: Plaats verzenden voor revisie door Adobe submit-for-review
Tot slot vóór de bestemming in de catalogus van het Experience Platform kan worden gepubliceerd en aan alle klanten van het Experience Platform zichtbaar, moet u de bestemming officieel voorleggen voor overzicht van de Adobe. Vind volledige informatie over hoe te voor overzicht voorleggen een geproduceerde die bestemming in Destination SDKwordt geschreven.