Eind publiek
Een publiek is een verzameling personen die vergelijkbare gedragingen en/of kenmerken delen. Deze verzamelingen mensen kunnen worden gegenereerd met Adobe Experience Platform of met externe bronnen. U kunt het /audiences
eindpunt in de Segmentatie API gebruiken, die u toestaat om publiek programmatically terug te winnen, tot stand te brengen bij te werken en te schrappen.
Aan de slag
De eindpunten die in deze handleiding worden gebruikt, maken deel uit van de API van Adobe Experience Platform Segmentation Service . Alvorens verder te gaan, te herzien gelieve begonnen gidsvoor belangrijke informatie die u moet kennen om vraag aan API met succes te maken, met inbegrip van vereiste kopballen en hoe te om voorbeeld API vraag te lezen.
Een lijst met soorten publiek ophalen list
U kunt een lijst van alle soorten publiek voor uw organisatie terugwinnen door een verzoek van de GET tot het /audiences
eindpunt te richten.
API formaat
Het /audiences
eindpunt steunt verscheidene vraagparameters helpen uw resultaten filtreren. Hoewel deze parameters optioneel zijn, wordt het gebruik ervan sterk aanbevolen om kostbare overhead te verminderen wanneer resources worden vermeld. Als u een vraag aan dit eindpunt zonder parameters maakt, zullen alle publiek beschikbaar voor uw organisatie worden teruggewonnen. De veelvoudige parameters kunnen worden omvat, die door ampersands (&
) worden gescheiden.
GET /audiences
GET /audiences?{QUERY_PARAMETERS}
property=audienceId
vraagparameter gebruikt, zal het inactieve publiek zijn teruggekeerd.De volgende vraagparameters kunnen worden gebruikt wanneer het terugwinnen van een lijst van publiek:
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
Verzoek
Het volgende verzoek wint de laatste twee publiek terug dat in uw organisatie wordt gecreeerd.
code language-shell |
---|
|
Reactie
Een geslaagde reactie retourneert HTTP-status 200 met een lijst van soorten publiek die in uw organisatie als JSON zijn gemaakt.
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 | ||
---|---|---|
Eigenschap | Type publiek | Beschrijving |
id |
Beide | Een door het systeem gegenereerde alleen-lezen id voor het publiek. |
audienceId |
Beide | Als het publiek een publiek is dat via een platform wordt gegenereerd, heeft dit dezelfde waarde als de id . Als het publiek extern wordt gegenereerd, wordt deze waarde door de client opgegeven. |
schema |
Beide | Het schema van de Gegevens van de Ervaring Model (XDM) van het publiek. |
imsOrgId |
Beide | De id van de organisatie waartoe het publiek behoort. |
sandbox |
Beide | Informatie over de sandbox waartoe het publiek behoort. Meer informatie over zandbakken kan in het overzicht van zandbakkenworden gevonden. |
name |
Beide | De naam van het publiek. |
description |
Beide | Een beschrijving van het publiek. |
expression |
Door het platform gegenereerd | De Profile Query Language (PQL)-expressie van het publiek. Meer informatie over de uitdrukkingen van PQL kan in de uitdrukkingengids van PQLworden gevonden. |
mergePolicyId |
Door het platform gegenereerd | De id van het samenvoegbeleid waaraan het publiek is gekoppeld. Meer informatie over fusiebeleid kan in de gids van het samenvoegingsbeleidworden gevonden. |
evaluationInfo |
Door het platform gegenereerd | Toont hoe het publiek zal worden geëvalueerd. Mogelijke evaluatiemethoden zijn batch, synchronous (streaming) of continue (edge). Meer informatie over de evaluatiemethodes kan in het segmentatieoverzichtworden gevonden |
dependents |
Beide | Een array met gebruikers-id's die afhankelijk zijn van het huidige publiek. Dit zou worden gebruikt als u een publiek creeert dat een segment van een segment is. |
dependencies |
Beide | Een array met publiek-id's waarvan het publiek afhankelijk is. Dit zou worden gebruikt als u een publiek creeert dat een segment van een segment is. |
type |
Beide | Een door het systeem gegenereerd veld dat weergeeft of het publiek door het platform wordt gegenereerd of dat een extern gegenereerd publiek is. Mogelijke waarden zijn SegmentDefinition en ExternalSegment . Een SegmentDefinition verwijst naar een publiek dat is gegenereerd in Platform, terwijl een ExternalSegment verwijst naar een publiek dat niet is gegenereerd in Platform. |
originName |
Beide | Een veld dat verwijst naar de naam van de oorsprong van het publiek. Voor publiek dat door Platform wordt gegenereerd, is deze waarde REAL_TIME_CUSTOMER_PROFILE . Voor soorten publiek dat wordt gegenereerd in Audience Orchestration, is deze waarde AUDIENCE_ORCHESTRATION . Voor in Adobe Audience Manager gegenereerde soorten publiek is deze waarde AUDIENCE_MANAGER . Voor andere extern gegenereerde soorten publiek is deze waarde CUSTOM_UPLOAD . |
createdBy |
Beide | De id van de gebruiker die het publiek heeft gemaakt. |
labels |
Beide | Gegevensgebruik op objectniveau en op kenmerk gebaseerde toegangsbeheerlabels die relevant zijn voor het publiek. |
namespace |
Beide | De naamruimte waartoe het publiek behoort. Mogelijke waarden zijn AAM , AAMSegments , AAMTraits en AEPSegments . |
linkedAudienceRef |
Beide | Een object dat id's bevat voor andere publiekgerelateerde systemen. |
Een nieuw publiek maken create
U kunt een nieuw publiek tot stand brengen door een verzoek van de POST aan het /audiences
eindpunt te doen.
API formaat
POST /audiences
Verzoek
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 | |
---|---|
Eigenschap | Beschrijving |
name |
De naam van het publiek. |
description |
Een beschrijving van het publiek. |
type |
Een veld waarin wordt weergegeven of het publiek door het platform wordt gegenereerd of dat een extern gegenereerd publiek is. Mogelijke waarden zijn SegmentDefinition en ExternalSegment . Een SegmentDefinition verwijst naar een publiek dat is gegenereerd in Platform, terwijl een ExternalSegment verwijst naar een publiek dat niet is gegenereerd in Platform. |
expression |
De Profile Query Language (PQL)-expressie van het publiek. Meer informatie over de uitdrukkingen van PQL kan in de uitdrukkingengids van PQLworden gevonden. |
schema |
Het schema van de Gegevens van de Ervaring Model (XDM) van het publiek. |
labels |
Gegevensgebruik op objectniveau en op kenmerk gebaseerde toegangsbeheerlabels die relevant zijn voor het publiek. |
Reactie
Een succesvolle reactie keert status 200 van HTTP met informatie over uw pas gecreeerd publiek terug.
code language-json |
---|
|
Een bepaald publiek opzoeken get
U kunt gedetailleerde informatie over een specifiek publiek omhoog kijken door een verzoek van de GET tot het /audiences
eindpunt te richten en identiteitskaart van het publiek te verstrekken u wenst om in de verzoekweg terug te winnen.
API formaat
GET /audiences/{AUDIENCE_ID}
{AUDIENCE_ID}
id
gebied is, en niet het audienceId
gebied is.Verzoek
code language-shell |
---|
|
Reactie
Een succesvolle reactie keert status 200 van HTTP met informatie over het gespecificeerde publiek terug.
code language-json |
---|
|
Een publiek bijwerken put
U kunt een specifiek publiek bijwerken (overschrijven) door een verzoek van de PUT aan het /audiences
eindpunt te richten en identiteitskaart van het publiek te verstrekken u wenst om in de verzoekweg bij te werken.
API formaat
PUT /audiences/{AUDIENCE_ID}
{AUDIENCE_ID}
id
gebied is, en niet het audienceId
gebied is.Verzoek
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 | |
---|---|
Eigenschap | Beschrijving |
audienceId |
De id van het publiek. Voor extern gegenereerde soorten publiek kan deze waarde door de gebruiker worden opgegeven. |
name |
De naam van het publiek. |
namespace |
De naamruimte voor het publiek. |
description |
Een beschrijving van het publiek. |
type |
Een door het systeem gegenereerd veld dat weergeeft of het publiek door het platform wordt gegenereerd of dat een extern gegenereerd publiek is. Mogelijke waarden zijn SegmentDefinition en ExternalSegment . Een SegmentDefinition verwijst naar een publiek dat is gegenereerd in Platform, terwijl een ExternalSegment verwijst naar een publiek dat niet is gegenereerd in Platform. |
lifecycleState |
De status van het publiek. Mogelijke waarden zijn draft , published en inactive . draft vertegenwoordigt wanneer het publiek wordt gecreeerd, published wanneer het publiek wordt gepubliceerd, en inactive wanneer het publiek niet meer actief is. |
datasetId |
De id van de dataset die de publieksgegevens kunnen worden gevonden. |
labels |
Gegevensgebruik op objectniveau en op kenmerk gebaseerde toegangsbeheerlabels die relevant zijn voor het publiek. |
Reactie
Een geslaagde reactie retourneert HTTP status 200 met details over uw onlangs bijgewerkte publiek. Houd er rekening mee dat de details van uw publiek verschillen, afhankelijk van het publiek dat door het platform wordt gegenereerd of een publiek dat extern wordt gegenereerd.
code language-json |
---|
|
Een publiek verwijderen delete
U kunt een specifiek publiek schrappen door een DELETE verzoek aan het /audiences
eindpunt te doen en identiteitskaart van het publiek te verstrekken u wenst om in de verzoekweg te schrappen.
API formaat
DELETE /audiences/{AUDIENCE_ID}
{AUDIENCE_ID}
id
gebied is, en niet het audienceId
gebied is.Verzoek
code language-shell |
---|
|
Reactie
Een geslaagde reactie retourneert HTTP status 204 zonder bericht.
Meerdere soorten publiek ophalen bulk-get
U kunt veelvoudige publiek terugwinnen door een verzoek van de POST aan het /audiences/bulk-get
eindpunt te doen en identiteitskaarts van het publiek te verstrekken u wenst om terug te winnen.
API formaat
POST /audiences/bulk-get
Verzoek
code language-shell |
---|
|
Reactie
Een succesvolle reactie retourneert HTTP-status 207 met informatie voor het gevraagde publiek.
code language-json |
---|
|
Volgende stappen
Na het lezen van deze handleiding hebt u nu een beter inzicht in hoe u publiek kunt maken, beheren en verwijderen met de Adobe Experience Platform API. Voor meer informatie over publieksbeheer die UI gebruiken, te lezen gelieve de gids van de segmentatie UI.