Använd Destination SDK för att konfigurera ett direktuppspelningsmål
Översikt overview
På den här sidan beskrivs hur du använder informationen i Konfigurationsalternativen i Destinations SDK och i andra Destinationer SDK och API-referensdokument för att konfigurera ett direktuppspelningsmål. Stegen beskrivs i sekventiell ordning nedan.
Förhandskrav prerequisites
Innan du går vidare till stegen som visas nedan bör du läsa sidan Komma igång för Destination SDK för att få information om hur du får de autentiseringsuppgifter för Adobe I/O och andra krav som krävs för att arbeta med Destination SDK-API:er. Detta förutsätter att du har slutfört villkoren för partnerskap och behörighet och är redo att börja utveckla ditt mål.
Steg för att använda konfigurationsalternativen i Destinationen SDK för att konfigurera destinationen steps
Steg 1: Skapa en server- och mallkonfiguration create-server-template-configuration
Börja med att skapa en server- och mallkonfiguration med slutpunkten /destinations-server.
Nedan visas ett exempel på en konfiguration. Observera att meddelandeomformningsmallen i parametern requestBody.value behandlas i steg 3, Skapa omformningsmall.
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"
}
}
Steg 2: Skapa målkonfiguration create-destination-configuration
Nedan visas ett exempel på en konfiguration för en målmall som skapats med API-slutpunkten /destinations. Mer information finns i Skapa en målkonfiguration.
Om du vill ansluta server- och mallkonfigurationen i steg 1 till den här målkonfigurationen lägger du till instans-ID:t för servern och mallkonfigurationen som destinationServerId här.
identityNamespaces, vilket visas nedan. Om ingen målidentitet har konfigurerats kan användarna inte fortsätta förbi mappningssteget i aktiveringsarbetsflödet.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"
}
]
}
Steg 3: Skapa mall för meddelandeomvandling - använd mallspråk för att ange meddelandets utdataformat create-transformation-template
Beroende på vilka nyttolaster målet har stöd för måste du skapa en mall som omformar formatet för exporterade data från Adobe XDM-formatet till ett format som stöds av målet. Se mallexempel i avsnittet Använda ett mallspråk för omvandlingar av identitet, attribut och målgruppsmedlemskap och använd mallutvecklingsverktyget från Adobe.
När du har skapat en meddelandeomformningsmall som fungerar för dig lägger du till den i server- och mallkonfigurationen som du skapade i steg 1.
{
"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"
}
}
Steg 4: Skapa konfiguration av målgruppsmetadata create-audience-metadata-configuration
För vissa destinationer kräver Destinationen SDK att du konfigurerar en målgruppsmetadatakonfiguration för att skapa, uppdatera eller ta bort målgrupper i målgruppen. Mer information om när du behöver konfigurera konfigurationen och hur du gör den finns i Hantering av målgruppsmetadata.
Om du använder en konfiguration för målgruppsmetadata måste du ansluta den till målkonfigurationen som du skapade i steg 2. Lägg till instans-ID för målgruppens metadatakonfiguration i målkonfigurationen som 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"
}
]
}
Steg 5: Konfigurera autentisering set-up-authentication
Beroende på om du anger "authenticationRule": "CUSTOMER_AUTHENTICATION" eller "authenticationRule": "PLATFORM_AUTHENTICATION" i målkonfigurationen ovan, kan du konfigurera autentisering för ditt mål med hjälp av /destination eller /credentials-slutpunkten.
CUSTOMER_AUTHENTICATION är det vanligaste av de två autentiseringsreglerna och det är det som ska användas om du kräver att användarna tillhandahåller någon form av autentisering till ditt mål innan de kan konfigurera en anslutning och exportera data.Läs OAuth 2-autentisering om du valde "authenticationRule": "CUSTOMER_AUTHENTICATION" i målkonfigurationen och målet stöder autentiseringsmetoden OAuth 2.
Om du valde "authenticationRule": "PLATFORM_AUTHENTICATION" måste du skapa en autentiseringskonfiguration.
Steg 6: Testa destinationen test-destination
När du har konfigurerat ditt mål med hjälp av konfigurationsslutpunkterna i föregående steg kan du använda måltestningsverktyget för att testa integrationen mellan Adobe Experience Platform och ditt mål.
Som en del av processen för att testa destinationen måste du använda användargränssnittet i Experience Platform för att skapa segment, som du aktiverar för destinationen. Se de två resurserna nedan för instruktioner om hur du skapar målgrupper i Experience Platform:
Steg 7: Publish ditt mål publish-destination
När du har konfigurerat och testat målet kan du använda API:t för målpublicering för att skicka konfigurationen till Adobe för granskning.
Steg 8: Dokumentera destinationen document-destination
Om du är en oberoende programvaruleverantör (ISV) eller systemintegratör (SI) som skapar en tillverkad integrering använder du självbetjäningsdokumentationsprocessen för att skapa en produktdokumentationssida för destinationen i Experience Platform-målkatalogen.
Steg 9: Skicka mål för Adobe granskning submit-for-review
Innan destinationen kan publiceras i Experience Platform-katalogen och vara synlig för alla Experience Platform-kunder måste du skicka in destinationen för Adobe granskning officiellt. Hitta fullständig information om hur du skickar för granskning av ett produkterat mål som har skapats i Destinationen SDK.