Extern målgruppsslutpunkt
Med externa målgrupper kan du överföra profildata från externa källor till Adobe Experience Platform. Du kan använda slutpunkten /external-audience
i segmenteringstjänstens API för att importera en extern målgrupp till Experience Platform, visa information och uppdatera externa målgrupper samt ta bort externa målgrupper.
Komma igång
/core/ais
i motsats till /core/ups
.För att du ska kunna använda Experience Platform API:er måste du ha slutfört autentiseringssjälvstudiekursen. När du är klar med självstudiekursen för autentisering visas värdena för var och en av de obligatoriska rubrikerna i Experience Platform API-anrop, vilket visas nedan:
- Behörighet:
Bearer {ACCESS_TOKEN}
- x-api-key:
{API_KEY}
- x-gw-ims-org-id:
{ORG_ID}
Alla resurser i Experience Platform är isolerade till specifika virtuella sandlådor. Alla begäranden till Experience Platform API:er kräver ett huvud som anger namnet på den sandlåda där åtgärden ska utföras:
- x-sandbox-name:
{SANDBOX_NAME}
Skapa externa målgrupper create-audience
Du kan skapa en extern målgrupp genom att göra en POST-begäran till slutpunkten /external-audience/
.
API-format
POST /external-audience/
Begäran
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 | ||
---|---|---|
Egenskap | Typ | Beskrivning |
name |
Sträng | Namnet på den externa publiken. |
description |
Sträng | En valfri beskrivning för den externa målgruppen. |
customAudienceId |
Sträng | En valfri identifierare för den externa målgruppen. |
fields |
Array med objekt |
Listan med fält och deras datatyper. När du skapar fältlistan kan du lägga till följande objekt:
|
sourceSpec |
Objekt |
Ett objekt som innehåller information om var den externa målgruppen finns. När du använder det här objektet måste innehålla följande information:
|
ttlInDays |
Heltal | Datan upphör att gälla för den externa målgruppen, i dagar. Värdet kan anges från 1 till 90. Som standard är utgångsdatumet för data inställt på 30 dagar. |
audienceType |
Sträng | Målgruppstypen för den externa målgruppen. För närvarande stöds bara people . |
originName |
Sträng | Obligatorisk Målgruppens ursprung. Det är här som publiken kommer ifrån. För externa målgrupper bör du använda CUSTOM_UPLOAD . |
namespace |
Sträng | Namnutrymmet för målgruppen. Som standard är det här värdet inställt på CustomerAudienceUpload . |
labels |
Array med strängar | De etiketter för åtkomstkontroll som gäller för den externa målgruppen. Mer information om tillgängliga etiketter för åtkomstkontroll finns i etikettordlistan för dataanvändning. |
tags |
Array med strängar | De taggar som du vill använda för den externa målgruppen. Mer information om taggar finns i handboken för hantering av taggar. |
Svar
Ett lyckat svar returnerar HTTP-status 202 med information om din nya externa målgrupp.
code language-json |
---|
|
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 | ||
---|---|---|
Egenskap | Typ | Beskrivning |
operationId |
Sträng | Åtgärdens ID. Du kan sedan använda det här ID:t för att hämta status för hur målgruppen har skapats. |
operationDetails |
Objekt | Ett objekt som innehåller information om den begäran du skickade för att skapa den externa målgruppen. |
name |
Sträng | Namnet på den externa publiken. |
description |
Sträng | Beskrivningen för den externa målgruppen. |
fields |
Array med objekt | Listan med fält och deras datatyper. Den här arrayen avgör vilka fält du behöver i den externa publiken. |
sourceSpec |
Objekt | Ett objekt som innehåller information om var den externa målgruppen finns. |
ttlInDays |
Heltal | Datan upphör att gälla för den externa målgruppen, i dagar. Värdet kan anges från 1 till 90. Som standard är utgångsdatumet för data inställt på 30 dagar. |
audienceType |
Sträng | Målgruppstypen för den externa målgruppen. |
originName |
Sträng | Obligatorisk Målgruppens ursprung. Det är här som publiken kommer ifrån. |
namespace |
Sträng | Namnutrymmet för målgruppen. |
labels |
Array med strängar | De etiketter för åtkomstkontroll som gäller för den externa målgruppen. Mer information om tillgängliga etiketter för åtkomstkontroll finns i etikettordlistan för dataanvändning. |
Hämta status för målgruppsskapande retrieve-status
Du kan hämta status för din externa målgruppssändning genom att göra en GET-begäran till /external-audiences/operations
-slutpunkten och ange ID:t för åtgärden som du fick från det skapade externa målgruppssvaret.
API-format
GET /external-audiences/operations/{OPERATION_ID}
{OPERATION_ID}
id
för åtgärden som du vill hämta.Begäran
code language-shell |
---|
|
Svar
Ett lyckat svar returnerar HTTP-status 200 med information om den externa målgruppens aktivitetsstatus.
code language-json |
---|
|
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 | ||
---|---|---|
Egenskap | Typ | Beskrivning |
operationId |
Sträng | ID:t för åtgärden som du hämtar. |
status |
Sträng | Åtgärdens status. Detta kan vara något av följande värden: SUCCESS , FAILED , PROCESSING . |
operationDetails |
Objekt | Ett objekt som innehåller information om målgruppen. |
audienceId |
Sträng | ID för den externa målgrupp som skickas av åtgärden. |
createdBy |
Sträng | ID för den användare som skapade den externa målgruppen. |
createdAt |
Lång epok-tidsstämpel | Tidsstämpeln, i sekunder, när begäran om att skapa den externa målgruppen skickades. |
updatedBy |
Sträng | ID för den användare som senast uppdaterade målgruppen. |
updatedAt |
Lång epok-tidsstämpel | Tidsstämpeln, i sekunder, när målgruppen senast uppdaterades. |
Uppdatera en extern målgrupp update-audience
audienceId
för din externa målgrupp. Du kan hämta audienceId
från ett lyckat anrop till slutpunkten GET /external-audiences/operations/{OPERATION_ID}
.Du kan uppdatera fält för din externa målgrupp genom att göra en PATCH-begäran till slutpunkten /external-audience
och ange målgruppens ID i sökvägen för begäran.
När du använder den här slutpunkten kan du uppdatera följande fält:
- Målgruppsbeskrivning
- Åtkomstkontrolletiketter på fältnivå
- Etiketter för åtkomstkontroll på målgruppsnivå
- Publiken har passerat utgångsdatum
Om du uppdaterar fältet med den här slutpunkten ersätts innehållet i det fält som du har begärt.
API-format
PATCH /external-audience/{AUDIENCE_ID}
Begäran
code language-shell |
---|
|
table 0-row-3 1-row-3 | ||
---|---|---|
Egenskap | Typ | Beskrivning |
description |
Sträng | Den uppdaterade beskrivningen för den externa målgruppen. |
Dessutom kan du uppdatera följande parametrar:
table 0-row-3 1-row-3 2-row-3 3-row-3 | ||
---|---|---|
Egenskap | Typ | Beskrivning |
labels |
Array | En array som innehåller den uppdaterade listan med åtkomstetiketter för målgruppen. Mer information om tillgängliga etiketter för åtkomstkontroll finns i etikettordlistan för dataanvändning. |
fields |
Array med objekt | En array som innehåller fälten och tillhörande etiketter för den externa målgruppen. Endast de fält som anges i PATCH-begäran kommer att uppdateras. Mer information om tillgängliga etiketter för åtkomstkontroll finns i etikettordlistan för dataanvändning. |
ttlInDays |
Heltal | Datan upphör att gälla för den externa målgruppen, i dagar. Värdet kan anges från 1 till 90. |
Svar
Ett lyckat svar returnerar HTTP-status 200 med information om den uppdaterade externa målgruppen.
code language-json |
---|
|
Starta målgruppsintag start-audience-ingestion
audienceId
för din externa målgrupp. Du kan hämta audienceId
från ett lyckat anrop till slutpunkten GET /external-audiences/operations/{OPERATION_ID}
.Du kan påbörja en målgruppsinmatning genom att göra en POST-begäran till följande slutpunkt och samtidigt ange målar-ID.
API-format
POST /external-audience/{AUDIENCE_ID}/runs
Begäran
Följande begäran utlöser en ingressning för den externa målgruppen.
code language-shell |
---|
|
table 0-row-3 1-row-3 2-row-3 | ||
---|---|---|
Egenskap | Typ | Beskrivning |
dataFilterStartTime |
Epoch-tidsstämpel | Obligatoriskt Intervallet som anger den starttid som flödet ska köras för att välja vilka filer som ska bearbetas. |
dataFilterEndTime |
Epoch-tidsstämpel | Det intervall som anger sluttiden som flödet ska köras för att välja vilka filer som ska bearbetas. |
Svar
Ett lyckat svar returnerar HTTP-status 200 med information om importen.
code language-json |
---|
|
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 | ||
---|---|---|
Egenskap | Typ | Beskrivning |
audienceName |
Sträng | Namnet på målgruppen som du påbörjar ett förtäringsförsök för. |
audienceId |
Sträng | Målgruppens ID. |
runId |
Sträng | ID:t för det intag du påbörjade. |
differentialIngestion |
Boolean | Ett fält som avgör om intaget är ett partiellt intag baserat på skillnaden sedan det senaste intaget eller ett fullständigt målgruppsintag. |
dataFilterStartTime |
Epoch-tidsstämpel | Det intervall som anger den starttid som flödet körs för att välja vilka filer som bearbetades. |
dataFilterEndTime |
Epoch-tidsstämpel | Det intervall som anger sluttiden som flödet körs för att välja vilka filer som bearbetades. |
createdAt |
Lång epok-tidsstämpel | Tidsstämpeln, i sekunder, när begäran om att skapa den externa målgruppen skickades. |
createdBy |
Sträng | ID för den användare som skapade den externa målgruppen. |
Hämta specifik status för målgruppsinmatning retrieve-ingestion-status
audienceId
för din externa målgrupp och runId
för ditt ID för att köra inmatning. Du kan hämta din audienceId
från ett lyckat anrop till GET /external-audiences/operations/{OPERATION_ID}
-slutpunkten och din runId
från ett tidigare lyckat anrop av POST /external-audience/{AUDIENCE_ID}/runs
-slutpunkten.Du kan hämta status för ett målgruppsintag genom att göra en GET-begäran till följande slutpunkt samtidigt som du anger både målgrupps- och kör-ID:n.
API-format
GET /external-audience/{AUDIENCE_ID}/runs/{RUN_ID}
Begäran
Följande begäran hämtar den externa målgruppens inmatningsstatus.
code language-shell |
---|
|
Svar
Ett lyckat svar returnerar HTTP-status 200 med information om den externa målgruppens inmatning.
code language-json |
---|
|
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 | ||
---|---|---|
Egenskap | Typ | Beskrivning |
audienceName |
Sträng | Namnet på publiken. |
audienceId |
Sträng | Målgruppens ID. |
runId |
Sträng | ID:t för importen. |
status |
Sträng | Status för importen. Möjliga statusar är SUCCESS och FAILED . |
differentialIngestion |
Boolean | Ett fält som avgör om intaget är ett partiellt intag baserat på skillnaden sedan det senaste intaget eller ett fullständigt målgruppsintag. |
dataFilterStartTime |
Epoch-tidsstämpel | Det intervall som anger den starttid som flödet körs för att välja vilka filer som bearbetades. |
dataFilterEndTime |
Epoch-tidsstämpel | Det intervall som anger sluttiden som flödet körs för att välja vilka filer som bearbetades. |
createdAt |
Lång epok-tidsstämpel | Tidsstämpeln, i sekunder, när begäran om att skapa den externa målgruppen skickades. |
createdBy |
Sträng | ID för den användare som skapade den externa målgruppen. |
details |
Array med objekt |
Ett objekt som innehåller information om importen.
|
Lista målgruppsmatningar list-ingestion-runs
audienceId
för din externa målgrupp. Du kan hämta audienceId
från ett lyckat anrop till slutpunkten GET /external-audiences/operations/{OPERATION_ID}
.Du kan hämta alla inmatningskörningar för den valda externa målgruppen genom att göra en GET-begäran till följande slutpunkt och samtidigt ange målar-ID:t. Flera parametrar kan inkluderas, avgränsade med et-tecken (&
).
API-format
GET /external-audience/{AUDIENCE_ID}/runs
Begäran
Följande begäran hämtar alla inmatningskörningar för den externa målgruppen.
code language-shell |
---|
|
Svar
Ett lyckat svar returnerar HTTP-status 200 med en lista över antalet inkommande filer för den angivna externa målgruppen.
code language-json |
---|
|
table 0-row-3 1-row-3 | ||
---|---|---|
Egenskap | Typ | Beskrivning |
runs |
Objekt | Ett objekt som innehåller listan med förtäring körs som tillhör målgruppen. Mer information om det här objektet finns i avsnittet Hämta inmatningsstatus. |
Ta bort en extern målgrupp delete-audience
audienceId
för din externa målgrupp. Du kan hämta audienceId
från ett lyckat anrop till slutpunkten GET /external-audiences/operations/{OPERATION_ID}
.Du kan ta bort en extern målgrupp genom att göra en DELETE-förfrågan till följande slutpunkt och samtidigt ange målar-ID.
API-format
DELETE /external-audience/{AUDIENCE_ID}
Begäran
Följande begäran tar bort den angivna externa målgruppen.
code language-shell |
---|
|
Svar
Ett lyckat svar returnerar HTTP-status 204 med en tom svarstext.
Nästa steg next-steps
När du har läst den här guiden får du nu en bättre förståelse för hur du skapar, hanterar och tar bort externa målgrupper med Experience Platform API:er. Om du vill lära dig hur du använder externa målgrupper med Experience Platform-gränssnittet läser du dokumentationen för målportalen.
Bilaga appendix
I följande avsnitt visas de tillgängliga felkoderna när du använder det externa målgrupps-API:t.
BAD_REQUEST
BAD_REQUEST
UNAUTHORIZED
UNAUTHORIZED
imsOrgId
har angetts.UNAUTHORIZED
NOT_FOUND
DUPLICATE_RESOURCE
UNPROCESSABLE_ENTITY
INTERNAL_SERVER_ERROR
BAD_GATEWAY