Gebruik Destination SDK om een streamingbestemming te configureren
Overzicht overview
In deze pagina wordt beschreven hoe u de informatie in Configuratieopties in de SDK Doelen en in andere Destination SDK-functionaliteit en API-referentiedocumenten om een streamingdoel. De stappen worden in de onderstaande volgorde weergegeven.
Vereisten prerequisites
Lees de onderstaande stappen voordat u verdergaat Aan de slag met Destination SDK pagina voor informatie over het verkrijgen van de vereiste autorisatiegeloofsbrieven 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
Beginnen met een server- en sjabloonconfiguratie maken met de /destinations-server eindpunt.
Hieronder ziet u een voorbeeldconfiguratie. De sjabloon voor berichttransformatie in het dialoogvenster requestBody.value parameter wordt behandeld in stap 3; Transformatiesjabloon maken.
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 weergegeven is een voorbeeldconfiguratie voor een doelsjabloon, die is gemaakt met de /destinations API-eindpunt. Zie een doelconfiguratie maken voor meer informatie .
Om de server en malplaatjeconfiguratie in stap 1 met deze bestemmingsconfiguratie te verbinden, voeg instantieidentiteitskaart van de server en malplaatjeconfiguratie als toe destinationServerId hier.
identityNamespaces, zoals hieronder weergegeven. Als er geen doelidentiteit is geconfigureerd, kunnen gebruikers niet verder gaan dan de Toewijzingsstap van de activeringsworkflow.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 sjabloonvoorbeelden in de sectie Een sjabloontaal gebruiken voor de transformaties voor identiteit, kenmerken en publieksleiding en gebruiken de sjabloonontwerpgereedschap verstrekt door Adobe.
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. Zie Metagegevensbeheer voor het publiek voor informatie over wanneer u aan opstelling deze configuratie en hoe te om het moet doen.
Als u een configuratie van publieksmeta-gegevens gebruikt, moet u het met de bestemmingsconfiguratie verbinden u in stap 2 creeerde. Voeg instanceID van uw configuratie van publieksmeta-gegevens aan uw bestemmingsconfiguratie als toe audienceTemplateId.
{
"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 opgeeft "authenticationRule": "CUSTOMER_AUTHENTICATION" of "authenticationRule": "PLATFORM_AUTHENTICATION" in de bestemmingsconfiguratie hierboven, kunt u opstellingsauthentificatie voor uw bestemming door /destination of de /credentials eindpunt.
CUSTOMER_AUTHENTICATION is gemeenschappelijker van de twee authentificatieregels en is te gebruiken als u gebruikers vereist om één of andere vorm van authentificatie aan uw bestemming te verstrekken alvorens zij opstelling een verbinding kunnen en gegevens uitvoeren.Als u "authenticationRule": "CUSTOMER_AUTHENTICATION" in de bestemmingsconfiguratie en uw bestemming steunt de OAuth 2 authentificatiemethode, gelezen OAuth 2-verificatie.
Als u "authenticationRule": "PLATFORM_AUTHENTICATION"moet u een aanmeldingsconfiguratie.
Stap 6: Test uw bestemming test-destination
Nadat u de bestemming hebt ingesteld met de eindpunten van de configuratie in de vorige stappen, kunt u de opdracht doeltestgereedschap 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 doel-publicatie-API om uw configuratie ter controle naar de Adobe te verzenden.
Stap 8: Documenteer uw bestemming document-destination
Als u een Onafhankelijke Verkoper van de Software (ISV) of Integrator van het Systeem (SI) creeert productievere integratie, gebruikt u de zelfbedieningsdocumentatie om een pagina van de productdocumentatie voor uw bestemming in te stellen in Catalogus Experience Platform-doelen.
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. Volledige informatie over hoe te vinden een in Destination SDK gefabriceerde bestemming ter controle indienen.