Målgruppsslutpunkt
En publik är en samling personer som har liknande beteenden och/eller egenskaper. Dessa samlingar med personer kan genereras antingen med Adobe Experience Platform eller från externa källor. Du kan använda slutpunkten /audiences
i segmenterings-API:t, som gör att du kan hämta, skapa, uppdatera och ta bort målgrupper med programkod.
Komma igång
Slutpunkterna som används i den här guiden ingår i Adobe Experience Platform Segmentation Service-API:t. Innan du fortsätter bör du läsa kom igång-guiden för att få viktig information som du behöver känna till för att kunna ringa anrop till API:t, inklusive nödvändiga rubriker och hur du läser exempel-API-anrop.
Hämta en lista med målgrupper list
Du kan hämta en lista över alla målgrupper för din organisation genom att göra en GET-förfrågan till slutpunkten /audiences
.
API-format
Slutpunkten /audiences
har stöd för flera frågeparametrar som kan hjälpa dig att filtrera dina resultat. Även om dessa parametrar är valfria rekommenderar vi starkt att de används för att minska dyra overheadkostnader när du listar resurser. Om du anropar den här slutpunkten utan parametrar hämtas alla målgrupper som är tillgängliga för din organisation. Flera parametrar kan inkluderas, avgränsade med et-tecken (&
).
GET /audiences
GET /audiences?{QUERY_PARAMETERS}
property=audienceId
, returneras inaktiva målgrupper .Följande frågeparametrar kan användas när en lista över målgrupper hämtas:
start
start=5
limit
limit=10
sort
attributeName:[desc/asc]
.sort=updateTime:desc
property
property=
property=audienceId==test-audience-id
name
name=Sample
description
description=Test Description
Begäran
Följande begäran hämtar de två sista målgrupperna som skapats i din organisation.
code language-shell |
---|
|
Svar
Ett lyckat svar returnerar HTTP-status 200 med en lista över målgrupper som skapats i din organisation som JSON.
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 12-row-3 13-row-3 14-row-3 15-row-3 16-row-3 17-row-3 18-row-3 | ||
---|---|---|
Egenskap | Målgruppstyp | Beskrivning |
id |
Båda | En systemgenererad skrivskyddad identifierare för målgruppen. |
audienceId |
Båda | Om målgruppen är en plattformsgenererad målgrupp är detta samma värde som id . Om målgruppen genereras externt anges det här värdet av klienten. |
schema |
Båda | Målgruppens XDM-schema (Experience Data Model). |
imsOrgId |
Båda | ID för organisationen som målgruppen tillhör. |
sandbox |
Båda | Information om sandlådan som målgruppen tillhör. Mer information om sandlådor finns i översikten över sandlådor. |
name |
Båda | Namnet på publiken. |
description |
Båda | En beskrivning av publiken. |
expression |
Plattformsgenererad | Målgruppens Profile Query Language-uttryck (PQL). Mer information om PQL-uttryck finns i handboken för PQL-uttryck. |
mergePolicyId |
Plattformsgenererad | ID:t för den sammanfogningsprincip som målgruppen är kopplad till. Mer information om sammanfogningsprinciper finns i guiden för sammanfogningsprinciper. |
evaluationInfo |
Plattformsgenererad | Visar hur målgruppen kommer att utvärderas. Möjliga utvärderingsmetoder är batch, synkron (direktuppspelning) eller kontinuerlig (kant). Mer information om utvärderingsmetoderna finns i segmenteringsöversikten |
dependents |
Båda | En array med målgrupps-ID som är beroende av den aktuella målgruppen. Detta används om du skapar en målgrupp som är ett segment i ett segment. |
dependencies |
Båda | En array med målgrupps-ID:n som målgruppen är beroende av. Detta används om du skapar en målgrupp som är ett segment i ett segment. |
type |
Båda | Ett systemgenererat fält som visar om publiken genereras av plattformen eller är en externt genererad publik. Möjliga värden är SegmentDefinition och ExternalSegment . En SegmentDefinition refererar till en målgrupp som har skapats i Platform, medan en ExternalSegment refererar till en målgrupp som inte har genererats i Platform. |
originName |
Båda | Ett fält som refererar till namnet på målgruppens ursprung. För plattformsgenererade målgrupper är det här värdet REAL_TIME_CUSTOMER_PROFILE . För målgrupper som genereras i Audience Orchestration är det här värdet AUDIENCE_ORCHESTRATION . För målgrupper som genereras i Adobe Audience Manager är det här värdet AUDIENCE_MANAGER . För andra externt genererade målgrupper blir det här värdet CUSTOM_UPLOAD . |
createdBy |
Båda | ID för den användare som skapade målgruppen. |
labels |
Båda | Dataanvändning på objektnivå och attributbaserade etiketter för åtkomstkontroll som är relevanta för publiken. |
namespace |
Båda | Det namnutrymme som målgruppen tillhör. Möjliga värden är AAM , AAMSegments , AAMTraits och AEPSegments . |
linkedAudienceRef |
Båda | Ett objekt som innehåller identifierare för andra målgruppsrelaterade system. |
Skapa en ny målgrupp create
Du kan skapa en ny målgrupp genom att göra en POST-förfrågan till slutpunkten /audiences
.
API-format
POST /audiences
Begäran
code language-shell |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 | |
---|---|
Egenskap | Beskrivning |
name |
Namnet på publiken. |
description |
En beskrivning av publiken. |
type |
Ett fält som visar om målgruppen är plattformsgenererad eller är en externt genererad målgrupp. Möjliga värden är SegmentDefinition och ExternalSegment . En SegmentDefinition refererar till en målgrupp som har skapats i Platform, medan en ExternalSegment refererar till en målgrupp som inte har genererats i Platform. |
expression |
Målgruppens Profile Query Language-uttryck (PQL). Mer information om PQL-uttryck finns i handboken för PQL-uttryck. |
schema |
Målgruppens XDM-schema (Experience Data Model). |
labels |
Dataanvändning på objektnivå och attributbaserade etiketter för åtkomstkontroll som är relevanta för publiken. |
Svar
Ett lyckat svar returnerar HTTP-status 200 med information om den nya målgruppen.
code language-json |
---|
|
Söka efter en viss målgrupp get
Du kan söka efter detaljerad information om en viss målgrupp genom att göra en GET-förfrågan till slutpunkten /audiences
och ange ID:t för den målgrupp som du vill hämta i sökvägen för begäran.
API-format
GET /audiences/{AUDIENCE_ID}
{AUDIENCE_ID}
id
och att det inte är fältet audienceId
.Begäran
code language-shell |
---|
|
Svar
Ett lyckat svar returnerar HTTP-status 200 med information om den angivna målgruppen.
code language-json |
---|
|
Uppdatera en målgrupp put
Du kan uppdatera (skriva över) en viss målgrupp genom att göra en PUT-begäran till slutpunkten /audiences
och ange ID:t för den målgrupp som du vill uppdatera i sökvägen till begäran.
API-format
PUT /audiences/{AUDIENCE_ID}
{AUDIENCE_ID}
id
och att det inte är fältet audienceId
.Begäran
code language-shell |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 | |
---|---|
Egenskap | Beskrivning |
audienceId |
Målgruppens ID. För externt genererade målgrupper kan det här värdet anges av användaren. |
name |
Namnet på publiken. |
namespace |
Namnutrymmet för målgruppen. |
description |
En beskrivning av publiken. |
type |
Ett systemgenererat fält som visar om publiken genereras av plattformen eller är en externt genererad publik. Möjliga värden är SegmentDefinition och ExternalSegment . En SegmentDefinition refererar till en målgrupp som har skapats i Platform, medan en ExternalSegment refererar till en målgrupp som inte har genererats i Platform. |
lifecycleState |
Publiken. Möjliga värden är draft , published och inactive . draft representerar när målgruppen skapas, published när målgruppen publiceras och inactive när målgruppen inte längre är aktiv. |
datasetId |
ID:t för datauppsättningen som målgruppsdata kan hittas. |
labels |
Dataanvändning på objektnivå och attributbaserade etiketter för åtkomstkontroll som är relevanta för publiken. |
Svar
Ett lyckat svar returnerar HTTP-status 200 med information om din nya uppdaterade målgrupp. Observera att informationen om er målgrupp varierar beroende på om det är en plattformsgenererad publik eller en externt genererad målgrupp.
code language-json |
---|
|
Ta bort en målgrupp delete
Du kan ta bort en viss målgrupp genom att göra en DELETE-begäran till slutpunkten /audiences
och ange ID:t för den målgrupp som du vill ta bort i sökvägen för begäran.
API-format
DELETE /audiences/{AUDIENCE_ID}
{AUDIENCE_ID}
id
och att det inte är fältet audienceId
.Begäran
code language-shell |
---|
|
Svar
Ett lyckat svar returnerar HTTP-status 204 utan något meddelande.
Hämta flera målgrupper bulk-get
Du kan hämta flera målgrupper genom att göra en begäran om POST till /audiences/bulk-get
-slutpunkten och ange ID:n för de målgrupper som du vill hämta.
API-format
POST /audiences/bulk-get
Begäran
code language-shell |
---|
|
Svar
Ett lyckat svar returnerar HTTP-status 2007 med information om de begärda målgrupperna.
code language-json |
---|
|
Nästa steg
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 målgrupper med Adobe Experience Platform API. Mer information om målgruppshantering med användargränssnittet finns i segmenteringsgränssnittsguiden.