Eindpunt voor extern publiek
Met externe doelgroepen kunt u profielgegevens van externe bronnen uploaden naar Adobe Experience Platform. U kunt het /external-audience
eindpunt in de Segmentation Service API gebruiken om een extern publiek aan Experience Platform op te nemen, details te bekijken en uw externe publiek bij te werken, evenals uw externe publiek te schrappen.
Aan de slag
/core/ais
, in tegenstelling tot /core/ups
.om Experience Platform APIs te gebruiken, moet u het authentificatieleerprogrammahebben voltooid. Als u de zelfstudie over verificatie voltooit, krijgt u de waarden voor elk van de vereiste headers in Experience Platform API-aanroepen, zoals hieronder wordt getoond:
- Autorisatie:
Bearer {ACCESS_TOKEN}
- x-api-key:
{API_KEY}
- x-gw-ims-org-id:
{ORG_ID}
Alle bronnen in Experience Platform zijn geïsoleerd naar specifieke virtuele sandboxen. Alle aanvragen naar Experience Platform API's vereisen een header die de naam aangeeft van de sandbox waarin de bewerking plaatsvindt:
- x-sandbox-name:
{SANDBOX_NAME}
Extern publiek maken create-audience
U kunt een extern publiek maken door een POST-aanvraag in te dienen bij het eindpunt van /external-audience/
.
API formaat
POST /external-audience/
Verzoek
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 | ||
---|---|---|
Eigenschap | Type | Beschrijving |
name |
String | De naam voor het externe publiek. |
description |
String | Een optionele beschrijving voor het externe publiek. |
customAudienceId |
String | Een optionele id voor uw externe publiek. |
fields |
Array van objecten |
De lijst met velden en hun gegevenstypen. Wanneer u de lijst met velden maakt, kunt u de volgende items toevoegen:
|
sourceSpec |
Object |
Een object dat de informatie bevat waar het externe publiek zich bevindt. Wanneer het gebruiken van dit voorwerp, moet u de volgende informatie omvatten:
|
ttlInDays |
Geheel | De gegevensvervaldatum voor het externe publiek, in dagen. Deze waarde kan van 1 tot 90 worden geplaatst. De gegevensvervaldatum wordt standaard ingesteld op 30 dagen. |
audienceType |
String | Het publiekstype voor het externe publiek. Momenteel wordt alleen people ondersteund. |
originName |
String | Vereiste de oorsprong van het publiek. Dit geeft aan waar het publiek vandaan komt. Gebruik CUSTOM_UPLOAD voor externe doelgroepen. |
namespace |
String | De naamruimte voor het publiek. Deze waarde wordt standaard ingesteld op CustomerAudienceUpload . |
labels |
Array van tekenreeksen | De labels van het toegangsbeheer die op het externe publiek van toepassing zijn. Meer informatie over de beschikbare etiketten van de toegangscontrole kan in de verklarende woordenlijst van de de etiketten van het gegevensgebruikworden gevonden. |
tags |
Array van tekenreeksen | De tags die u wilt toepassen op het externe publiek. Meer informatie over markeringen kan in worden gevonden het leiden de gids van markeringen. |
Reactie
Een geslaagde reactie retourneert HTTP-status 202 met details van het nieuwe externe publiek.
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 | ||
---|---|---|
Eigenschap | Type | Beschrijving |
operationId |
String | De id van de bewerking. U kunt deze id vervolgens gebruiken om de status van het maken van de doelgroep op te halen. |
operationDetails |
Object | Een object dat de details bevat van het verzoek dat u hebt verzonden om het externe publiek te maken. |
name |
String | De naam voor het externe publiek. |
description |
String | De beschrijving voor het externe publiek. |
fields |
Array van objecten | De lijst met velden en hun gegevenstypen. Deze array bepaalt welke velden u nodig hebt in uw externe publiek. |
sourceSpec |
Object | Een object dat de informatie bevat waar het externe publiek zich bevindt. |
ttlInDays |
Geheel | De gegevensvervaldatum voor het externe publiek, in dagen. Deze waarde kan van 1 tot 90 worden geplaatst. De gegevensvervaldatum wordt standaard ingesteld op 30 dagen. |
audienceType |
String | Het publiekstype voor het externe publiek. |
originName |
String | Vereiste de oorsprong van het publiek. Dit geeft aan waar het publiek vandaan komt. |
namespace |
String | De naamruimte voor het publiek. |
labels |
Array van tekenreeksen | De labels van het toegangsbeheer die op het externe publiek van toepassing zijn. Meer informatie over de beschikbare etiketten van de toegangscontrole kan in de verklarende woordenlijst van de de etiketten van het gegevensgebruikworden gevonden. |
Status van het maken van een publiek ophalen retrieve-status
U kunt de status van uw externe publieksinzending ophalen door een GET-aanvraag in te dienen bij het /external-audiences/operations
-eindpunt en de id op te geven van de bewerking die u hebt ontvangen van de reactie van het externe publiek maken.
API formaat
GET /external-audiences/operations/{OPERATION_ID}
{OPERATION_ID}
id
-waarde van de bewerking die u wilt ophalen.Verzoek
code language-shell |
---|
|
Reactie
Een succesvolle reactie keert status 200 van HTTP met details van de de taakstatus van het externe publiek terug.
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 | ||
---|---|---|
Eigenschap | Type | Beschrijving |
operationId |
String | De id van de bewerking die u ophaalt. |
status |
String | De status van de operatie. Dit kan een van de volgende waarden zijn: SUCCESS , FAILED , PROCESSING . |
operationDetails |
Object | Een object dat details van het publiek bevat. |
audienceId |
String | De id van het externe publiek dat door de bewerking wordt verzonden. |
createdBy |
String | De id van de gebruiker die het externe publiek heeft gemaakt. |
createdAt |
Lange tijdstempel | De tijdstempel, in seconden, wanneer het verzoek om het externe publiek te maken is verzonden. |
updatedBy |
String | De id van de gebruiker die het publiek voor het laatst heeft bijgewerkt. |
updatedAt |
Lange tijdstempel | De tijdstempel, in seconden, toen het publiek voor het laatst werd bijgewerkt. |
Een extern publiek bijwerken update-audience
audienceId
van uw extern publiek hebben. U kunt audienceId
van een succesvolle vraag aan het GET /external-audiences/operations/{OPERATION_ID}
eindpunt krijgen.U kunt velden van uw externe publiek bijwerken door een PATCH-aanvraag in te dienen bij het /external-audience
-eindpunt en de id van het publiek op te geven in het aanvraagpad.
Wanneer u dit eindpunt gebruikt, kunt u de volgende velden bijwerken:
- Beschrijving van het publiek
- Toegangsbeheerlabels op veldniveau
- Toegangsbeheerlabels op het niveau van het publiek
- Vervaldatum van de gegevens van het publiek
Het bijwerken van het gebied gebruikend dit eindpunt vervangt de inhoud van het gebied u vroeg.
API formaat
PATCH /external-audience/{AUDIENCE_ID}
Verzoek
code language-shell |
---|
|
table 0-row-3 1-row-3 | ||
---|---|---|
Eigenschap | Type | Beschrijving |
description |
String | De bijgewerkte beschrijving voor het externe publiek. |
Bovendien kunt u de volgende parameters bijwerken:
table 0-row-3 1-row-3 2-row-3 3-row-3 | ||
---|---|---|
Eigenschap | Type | Beschrijving |
labels |
Array | Een array met de bijgewerkte lijst met toegangslabels voor het publiek. Meer informatie over de beschikbare etiketten van de toegangscontrole kan in de verklarende woordenlijst van de de etiketten van het gegevensgebruikworden gevonden. |
fields |
Array van objecten | Een array met de velden en de bijbehorende labels voor het externe publiek. Alleen de velden die in het PATCH-verzoek worden vermeld, worden bijgewerkt. Meer informatie over de beschikbare etiketten van de toegangscontrole kan in de verklarende woordenlijst van de de etiketten van het gegevensgebruikworden gevonden. |
ttlInDays |
Geheel | De gegevensvervaldatum voor het externe publiek, in dagen. Deze waarde kan van 1 tot 90 worden geplaatst. |
Reactie
Een geslaagde reactie retourneert HTTP-status 200 met details van het bijgewerkte externe publiek.
code language-json |
---|
|
Beginnen met publiek starten start-audience-ingestion
audienceId
van uw extern publiek hebben. U kunt audienceId
van een succesvolle vraag aan het GET /external-audiences/operations/{OPERATION_ID}
eindpunt krijgen.U kunt een publieksopname beginnen door een POST- verzoek aan het volgende eindpunt te doen terwijl het verstrekken van publiekidentiteitskaart
API formaat
POST /external-audience/{AUDIENCE_ID}/runs
Verzoek
De volgende aanvraag activeert een opname die voor het externe publiek wordt uitgevoerd.
code language-shell |
---|
|
table 0-row-3 1-row-3 2-row-3 | ||
---|---|---|
Eigenschap | Type | Beschrijving |
dataFilterStartTime |
Tijdstempel tijdperk | Vereist de waaier die de beginnende tijd specificeren die de stroom zal lopen om te selecteren welke dossiers zullen worden verwerkt. |
dataFilterEndTime |
Tijdstempel tijdperk | Het bereik dat de eindtijd opgeeft die de flow moet gebruiken om te selecteren welke bestanden worden verwerkt. |
Reactie
Een geslaagde reactie retourneert HTTP status 200 met details over de opname run.
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 | ||
---|---|---|
Eigenschap | Type | Beschrijving |
audienceName |
String | De naam van het publiek waarvoor u een opname start. |
audienceId |
String | De id van het publiek. |
runId |
String | De id van de opname die u hebt gestart. |
differentialIngestion |
Boolean | Een veld dat bepaalt of de opname een gedeeltelijke opname is op basis van het verschil sinds de laatste opname of een volledige opname van het publiek. |
dataFilterStartTime |
Tijdstempel tijdperk | Het bereik dat de begintijd opgeeft waarop de stroom wordt uitgevoerd om te selecteren welke bestanden zijn verwerkt. |
dataFilterEndTime |
Tijdstempel tijdperk | Het bereik dat de eindtijd opgeeft waarop de stroom wordt uitgevoerd om te selecteren welke bestanden zijn verwerkt. |
createdAt |
Lange tijdstempel | De tijdstempel, in seconden, wanneer het verzoek om het externe publiek te maken is verzonden. |
createdBy |
String | De id van de gebruiker die het externe publiek heeft gemaakt. |
Specifieke inspraakstatus van het publiek ophalen retrieve-ingestion-status
audienceId
van uw externe publiek als de runId
van de id van de invoeringsuitvoering hebben. U kunt audienceId
van een succesvolle vraag aan het GET /external-audiences/operations/{OPERATION_ID}
eindpunt en uw runId
van een vorige succesvolle vraag van het POST /external-audience/{AUDIENCE_ID}/runs
eindpunt krijgen.U kunt de status van een publieksinvoer terugwinnen door een GET- verzoek aan het volgende eindpunt te doen terwijl het verstrekken van zowel het publiek als looppas IDs.
API formaat
GET /external-audience/{AUDIENCE_ID}/runs/{RUN_ID}
Verzoek
Het volgende verzoek wint de innamestatus voor het externe publiek terug.
code language-shell |
---|
|
Reactie
Een succesvolle reactie keert status 200 van HTTP met details van de externe publieksinvoer terug.
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 | ||
---|---|---|
Eigenschap | Type | Beschrijving |
audienceName |
String | De naam van het publiek. |
audienceId |
String | De id van het publiek. |
runId |
String | De id van de inlogrun. |
status |
String | De status van de opname. Mogelijke statussen zijn SUCCESS en FAILED . |
differentialIngestion |
Boolean | Een veld dat bepaalt of de opname een gedeeltelijke opname is op basis van het verschil sinds de laatste opname of een volledige opname van het publiek. |
dataFilterStartTime |
Tijdstempel tijdperk | Het bereik dat de begintijd opgeeft waarop de stroom wordt uitgevoerd om te selecteren welke bestanden zijn verwerkt. |
dataFilterEndTime |
Tijdstempel tijdperk | Het bereik dat de eindtijd opgeeft waarop de stroom wordt uitgevoerd om te selecteren welke bestanden zijn verwerkt. |
createdAt |
Lange tijdstempel | De tijdstempel, in seconden, wanneer het verzoek om het externe publiek te maken is verzonden. |
createdBy |
String | De id van de gebruiker die het externe publiek heeft gemaakt. |
details |
Array van objecten |
Een object dat de details van de invoerbewerking bevat.
|
Voer publieksinvoer weergeven list-ingestion-runs
audienceId
van uw extern publiek hebben. U kunt audienceId
van een succesvolle vraag aan het GET /external-audiences/operations/{OPERATION_ID}
eindpunt krijgen.U kunt alle ingestitielooppas voor het geselecteerde externe publiek terugwinnen door een verzoek van GET aan het volgende eindpunt te doen terwijl het verstrekken van publiekID. De veelvoudige parameters kunnen worden omvat, die door ampersands (&
) worden gescheiden.
API formaat
GET /external-audience/{AUDIENCE_ID}/runs
Verzoek
Het volgende verzoek wint alle ingestitielooppas voor het externe publiek terug.
code language-shell |
---|
|
Reactie
Een succesvolle reactie keert status 200 van HTTP met een lijst van ingestitielooppas voor het gespecificeerde externe publiek terug.
code language-json |
---|
|
table 0-row-3 1-row-3 | ||
---|---|---|
Eigenschap | Type | Beschrijving |
runs |
Object | Een voorwerp dat de lijst van ingestie looppas bevat die tot het publiek behoort. Meer informatie over dit voorwerp kan in worden gevonden wint sectie van de inspraakstatusterug. |
Een extern publiek verwijderen delete-audience
audienceId
van uw extern publiek hebben. U kunt audienceId
van een succesvolle vraag aan het GET /external-audiences/operations/{OPERATION_ID}
eindpunt krijgen.U kunt een extern publiek schrappen door een verzoek van DELETE aan het volgende eindpunt te doen terwijl het verstrekken van publiekID.
API formaat
DELETE /external-audience/{AUDIENCE_ID}
Verzoek
Met het volgende verzoek verwijdert u het opgegeven externe publiek.
code language-shell |
---|
|
Reactie
Een geslaagde reactie retourneert HTTP status 204 met een lege response body.
Volgende stappen next-steps
Na het lezen van deze handleiding hebt u nu een beter inzicht in hoe u uw externe publiek kunt maken, beheren en verwijderen met de Experience Platform API's. Leren hoe te om extern publiek met Experience Platform UI te gebruiken, te lezen gelieve de Poortdocumentatie van het Poort van het Publiek.
Bijlage appendix
In de volgende sectie worden de beschikbare foutcodes weergegeven wanneer de externe publiek-API wordt gebruikt.
BAD_REQUEST
BAD_REQUEST
UNAUTHORIZED
UNAUTHORIZED
imsOrgId
opgegeven.UNAUTHORIZED
NOT_FOUND
DUPLICATE_RESOURCE
UNPROCESSABLE_ENTITY
INTERNAL_SERVER_ERROR
BAD_GATEWAY