Redigera målanslutningar med API:t för Flow Service
I den här självstudiekursen beskrivs stegen för redigering av olika komponenter i en målanslutning. Lär dig hur du uppdaterar autentiseringsuppgifter, exporterar plats och mycket mer med Flow Service API.
Komma igång get-started
Den här självstudien kräver att du har ett giltigt dataflödes-ID. Om du inte har något giltigt dataflödes-ID väljer du önskat mål i målkatalogen och följer instruktionerna som beskrivs för att ansluta till målet och aktivera data innan du provar den här självstudiekursen.
Den här självstudiekursen kräver även att du har en fungerande förståelse för följande komponenter i Adobe Experience Platform:
- Destinationer: Destinations är färdiga integreringar med målplattformar som möjliggör smidig aktivering av data från Adobe Experience Platform. Du kan använda mål för att aktivera dina kända och okända data för marknadsföringskampanjer över flera kanaler, e-postkampanjer, riktad reklam och många andra användningsområden.
- Sandlådor: Experience Platform tillhandahåller virtuella sandlådor som partitionerar en enda Experience Platform-instans till separata virtuella miljöer för att utveckla och utveckla program för digitala upplevelser.
I följande avsnitt finns ytterligare information som du behöver känna till för att kunna uppdatera dataflödet med API:t Flow Service.
Läser exempel-API-anrop reading-sample-api-calls
I den här självstudiekursen finns exempel-API-anrop som visar hur du formaterar dina begäranden. Det kan vara sökvägar, obligatoriska rubriker och korrekt formaterade begärandenyttolaster. Ett exempel på JSON som returneras i API-svar finns också. Information om de konventioner som används i dokumentationen för exempel-API-anrop finns i avsnittet Så här läser du exempel-API-anrop i felsökningsguiden för Experience Platform.
Samla in värden för obligatoriska rubriker gather-values-for-required-headers
För att kunna anropa Experience Platform API:er måste du först slutföra autentiseringssjälvstudiekursen. När du slutför självstudiekursen för autentisering visas värdena för var och en av de obligatoriska rubrikerna i alla Experience Platform API-anrop, vilket visas nedan:
Authorization: Bearer {ACCESS_TOKEN}
x-api-key: {API_KEY}
x-gw-ims-org-id: {ORG_ID}
Alla resurser i Experience Platform, inklusive de som tillhör Flow Service, är isolerade till specifika virtuella sandlådor. Alla förfrågningar till Experience Platform API:er kräver en rubrik som anger namnet på sandlådan som åtgärden ska utföras i:
x-sandbox-name: {SANDBOX_NAME}
x-sandbox-name
inte anges löses förfrågningar under sandlådan prod
.Alla begäranden som innehåller en nyttolast (POST
, PUT
, PATCH
) kräver en ytterligare medietypsrubrik:
Content-Type: application/json
Söka efter dataflödesdetaljer look-up-dataflow-details
Det första steget i att redigera målanslutningen är att hämta dataflödesinformation med ditt flödes-ID. Du kan visa den aktuella informationen om ett befintligt dataflöde genom att göra en GET-begäran till slutpunkten /flows
.

API-format
GET /flows/{FLOW_ID}
{FLOW_ID}
id
-värdet för måldataflödet som du vill hämta.Begäran
Följande begäran hämtar information om ditt flödes-ID.
curl -X GET \
'https://platform.adobe.io/data/foundation/flowservice/flows/226fb2e1-db69-4760-b67e-9e671e05abfc' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Svar
Ett lyckat svar returnerar aktuell information om dataflödet, inklusive version, unik identifierare (id
) och annan relevant information. Det viktigaste för den här självstudiekursen är de ID:n för målanslutning och basanslutning som markeras i svaret nedan. Du använder dessa ID:n i nästa avsnitt för att uppdatera olika komponenter i målanslutningen.
{
"items":[
{
"id":"226fb2e1-db69-4760-b67e-9e671e05abfc",
"createdAt":"{CREATED_AT}",
"updatedAt":"{UPDATED_BY}",
"createdBy":"{CREATED_BY}",
"updatedBy":"{UPDATED_BY}",
"createdClient":"{CREATED_CLIENT}",
"updatedClient":"{UPDATED_CLIENT}",
"sandboxId":"{SANDBOX_ID}",
"sandboxName":"prod",
"imsOrgId":"{ORG_ID}",
"name":"2021 winter campaign",
"description":"ACME company holiday campaign for high fidelity customers",
"flowSpec":{
"id":"71471eba-b620-49e4-90fd-23f1fa0174d8",
"version":"1.0"
},
"state":"enabled",
"version":"\"8b0351ca-0000-0200-0000-61c4d6700000\"",
"etag":"\"8b0351ca-0000-0200-0000-61c4d6700000\"",
"sourceConnectionIds":[
"5e45582a-5336-4ea1-9ec9-d0004a9f344a"
],
"targetConnectionIds":[
"8ce3dc63-3766-4220-9f61-51d2f8f14618"
],
"inheritedAttributes":{
"sourceConnections":[
{
"id":"5e45582a-5336-4ea1-9ec9-d0004a9f344a",
"connectionSpec":{
"id":"8a9c3494-9708-43d7-ae3f-cda01e5030e1",
"version":"1.0"
},
"baseConnection":{
"id":"0a82f29f-b457-47f7-bb30-33856e2ae5aa",
"connectionSpec":{
"id":"8a9c3494-9708-43d7-ae3f-cda01e5030e1",
"version":"1.0"
}
},
"typeInfo":{
"type":"ProfileFragments",
"id":"ups"
}
}
],
"targetConnections":[
{
"id":"8ce3dc63-3766-4220-9f61-51d2f8f14618",
"connectionSpec":{
"id":"0b23e41a-cb4a-4321-a78f-3b654f5d7d97",
"version":"1.0"
},
"baseConnection":{
"id":"7fbf542b-83ed-498f-8838-8fde0c4d4d69",
"connectionSpec":{
"id":"0b23e41a-cb4a-4321-a78f-3b654f5d7d97",
"version":"1.0"
}
}
}
]
},
"transformations":[
"shortened for brevity"
]
}
]
Redigera målanslutningskomponenter (lagringsplats och andra komponenter) patch-target-connection
Komponenterna för en målanslutning skiljer sig åt beroende på mål. För Amazon S3-mål kan du till exempel uppdatera den bucket och sökvägen dit filerna exporteras. För Pinterest mål kan du uppdatera Pinterest Advertiser ID och för Google Customer Match kan du uppdatera Pinterest Account ID.
Om du vill uppdatera komponenter för en målanslutning utför du en PATCH
-begäran till /targetConnections/{TARGET_CONNECTION_ID}
-slutpunkten samtidigt som du anger ditt målanslutnings-ID, version och de nya värden som du vill använda. Kom ihåg att du fick ditt målanslutnings-ID i föregående steg när du inspekterade ett befintligt dataflöde till önskat mål.
If-Match
krävs när en PATCH
-begäran görs. Värdet för den här rubriken är den unika versionen av målanslutningen som du vill uppdatera. Taggen-värdet uppdateras med alla lyckade uppdateringar av en flödenhet som dataflöde, målanslutning och andra./targetConnections/{TARGET_CONNECTION_ID}
-slutpunkten, där {TARGET_CONNECTION_ID}
är det målanslutnings-ID som du vill uppdatera.If-Match
inom citattecken, som i exemplen nedan, när du gör PATCH
-begäranden.Nedan visas några exempel på hur du uppdaterar parametrar i målanslutningsspecifikationen för olika typer av destinationer. Men den allmänna regeln för uppdatering av parametrar för alla mål är följande:
Hämta dataflödes-ID för anslutningen > hämta målanslutnings-ID > PATCH
målanslutningen med uppdaterade värden för de önskade parametrarna.
API-format
PATCH /targetConnections/{TARGET_CONNECTION_ID}
Begäran
Följande begäran uppdaterar parametrarna bucketName
och path
för en Amazon S3-målanslutning.
code language-shell |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 | |
---|---|
Egenskap | Beskrivning |
op |
Åtgärdsanropet som används för att definiera den åtgärd som krävs för att uppdatera dataflödet. Åtgärderna omfattar: add , replace och remove . |
path |
Definierar den del av flödet som ska uppdateras. |
value |
Det nya värdet som du vill uppdatera parametern med. |
Svar
Ett lyckat svar returnerar ditt målanslutnings-ID och en uppdaterad Etag. Du kan verifiera uppdateringen genom att göra en GET-begäran till API:t Flow Service och samtidigt ange ditt målanslutnings-ID.
code language-json |
---|
|
Begäran
Följande begäran uppdaterar parametrarna för en Google Ad Manager- eller Google Ad Manager 360 målanslutning för att lägga till det nya Append audience ID to audience name-fältet.
code language-shell |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 | |
---|---|
Egenskap | Beskrivning |
op |
Åtgärdsanropet som används för att definiera den åtgärd som krävs för att uppdatera dataflödet. Åtgärderna omfattar: add , replace och remove . |
path |
Definierar den del av flödet som ska uppdateras. |
value |
Det nya värdet som du vill uppdatera parametern med. |
Svar
Ett lyckat svar returnerar ditt målanslutnings-ID och en uppdaterad tagg. Du kan verifiera uppdateringen genom att göra en GET-begäran till API:t Flow Service och samtidigt ange ditt målanslutnings-ID.
code language-json |
---|
|
Begäran
Följande begäran uppdaterar parametern advertiserId
för en Pinterest målanslutning.
code language-shell |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 | |
---|---|
Egenskap | Beskrivning |
op |
Åtgärdsanropet som används för att definiera den åtgärd som krävs för att uppdatera dataflödet. Åtgärderna omfattar: add , replace och remove . |
path |
Definierar den del av flödet som ska uppdateras. |
value |
Det nya värdet som du vill uppdatera parametern med. |
Svar
Ett lyckat svar returnerar ditt målanslutnings-ID och en uppdaterad tagg. Du kan verifiera uppdateringen genom att göra en GET-begäran till API:t Flow Service och samtidigt ange ditt målanslutnings-ID.
code language-json |
---|
|
Redigera basanslutningskomponenter (autentiseringsparametrar och andra komponenter) patch-base-connection
Redigera basanslutningen när du vill uppdatera autentiseringsuppgifterna för ett mål. Komponenterna i en basanslutning skiljer sig åt beroende på mål. För Amazon S3 mål kan du till exempel uppdatera åtkomstnyckeln och den hemliga nyckeln till din Amazon S3-plats.
Om du vill uppdatera komponenter för en basanslutning utför du en PATCH
-begäran till /connections
-slutpunkten samtidigt som du anger ditt grundläggande anslutnings-ID, version och de nya värden som du vill använda.
Kom ihåg att du fick ditt grundläggande anslutnings-ID i ett föregående steg när du inspekterade ett befintligt dataflöde till det önskade målet för parametern baseConnection
.
If-Match
krävs när en PATCH
-begäran görs. Värdet för den här rubriken är den unika versionen av basanslutningen som du vill uppdatera. Värdet för etag uppdateras med varje lyckad uppdatering av en flödenhet, till exempel dataflöde, basanslutning och andra./connections/{BASE_CONNECTION_ID}
-slutpunkten, där {BASE_CONNECTION_ID}
är det grundläggande anslutnings-ID som du vill uppdatera.If-Match
inom citattecken, som i exemplen nedan, när du gör PATCH
-begäranden.Nedan visas några exempel på hur du uppdaterar parametrar i basanslutningsspecifikationen för olika typer av destinationer. Men den allmänna regeln för uppdatering av parametrar för alla mål är följande:
Hämta dataflödes-ID för anslutningen > hämta basanslutnings-ID > PATCH
basanslutningen med uppdaterade värden för de önskade parametrarna.
API-format
PATCH /connections/{BASE_CONNECTION_ID}
Begäran
Följande begäran uppdaterar parametrarna accessId
och secretKey
för en Amazon S3-målanslutning.
code language-shell |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 | |
---|---|
Egenskap | Beskrivning |
op |
Åtgärdsanropet som används för att definiera den åtgärd som krävs för att uppdatera dataflödet. Åtgärderna omfattar: add , replace och remove . |
path |
Definierar den del av flödet som ska uppdateras. |
value |
Det nya värdet som du vill uppdatera parametern med. |
Svar
Ett lyckat svar returnerar ditt grundläggande anslutnings-ID och en uppdaterad tagg. Du kan verifiera uppdateringen genom att göra en GET-begäran till API:t Flow Service och samtidigt ange ditt grundläggande anslutnings-ID.
code language-json |
---|
|
Begäran
Följande begäran uppdaterar parametrarna för en Azure Blob mål-anslutning för att uppdatera anslutningssträngen som krävs för att ansluta till en Azure Blob-instans.
code language-shell |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 | |
---|---|
Egenskap | Beskrivning |
op |
Åtgärdsanropet som används för att definiera den åtgärd som krävs för att uppdatera dataflödet. Åtgärderna omfattar: add , replace och remove . |
path |
Definierar den del av flödet som ska uppdateras. |
value |
Det nya värdet som du vill uppdatera parametern med. |
Svar
Ett lyckat svar returnerar ditt grundläggande anslutnings-ID och en uppdaterad tagg. Du kan verifiera uppdateringen genom att göra en GET-begäran till API:t Flow Service och samtidigt ange ditt grundläggande anslutnings-ID.
code language-json |
---|
|
API-felhantering api-error-handling
API-slutpunkterna i den här självstudien följer de allmänna felmeddelandeprinciperna för Experience Platform API. Mer information om hur du tolkar felsvar finns i API-statuskoder och begäranrubrikfel i felsökningsguiden för Experience Platform.
Nästa steg next-steps
Genom att följa den här självstudiekursen har du lärt dig hur du uppdaterar olika komponenter i en målanslutning med API:t Flow Service. Mer information om mål finns i målöversikten.