DokumentationExperience PlatformAnvändarhandbok om segmenteringstjänst

Extern målgruppsslutpunkt

Last update: Fri Feb 20 2026 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Ämnen:

Skapat för:

  • Användare

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.

Guardrails

Från och med mars-versionen kommer följande skyddsutkast att tillämpas när du använder slutpunkten för externa målgrupper:

Guardrail
Gräns
Begränsningstyp
Beskrivning
Antal målgruppsinmatningar per dag
100
Systemstyrt skyddsräcke
Högsta tillåtna antal målgruppsinmatningar per dag. Den här gränsen är per sandbox-nivå.
Antal förslag per målgrupp
10
Systemstyrt skyddsräcke
Antalet inmatningar som kan utföras på en angiven målgrupp.
Extern målgrupp
10 GB
Prestandaskydd
Den rekommenderade totala storleken för den externa publiken är 10 GB.

Komma igång

IMPORTANT
Slutpunkterna i den här guiden har prefixet /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}
NOTE
Mer information om hur du arbetar med sandlådor i Experience Platform finns i översiktsdokumentationen för sandlådor.

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

Ett exempel på en förfrågan om att skapa en extern publik.
code language-shell 
curl -X POST https://platform.adobe.io/data/core/ais/external-audience/ \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'
 -d '{
        "name": "Sample external audience",
        "description": "A sample version of an external audience",
        "fields": [
            {
                "name": "ppid",
                "type": "string",
                "identityNs": "email"
            },
            {
                "name": "list_id",
                "type": "string",
                "labels": ["core/C2", "custom/deep"]
            },
            {
                "name": "delete",
                "type": "number"
            },
            {
                "name": "process_consent",
                "type": "string"
            }
        ],
        "sourceSpec": {
            "params": {
                "path": "activation/sample-source/example.csv",
                "type": "file",
                "sourceType": "Cloud Storage",
                "baseConnectionId": "1d1d4bc5-b527-46a3-9863-530246a61b2b"
            }
        },
        "ttlInDays": "40",
        "labels": ["core/C1"],
        "audienceType": "people",
        "originName": "CUSTOM_UPLOAD"
    }'
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. Du måste ha minst 1 fält och högst 41 fält i arrayen. Ett av fälten måste vara ett identitetsfält och innehålla identityNs. När du skapar fältlistan kan du lägga till följande objekt:

  • name: Obligatoriskt Namnet på fältet som är en del av den externa målgruppsspecifikationen.
  • type: Obligatoriskt Den typ av data som placeras i fältet. Värden som stöds är string, number, long, integer, date (2025-05-13), datetime (2025-05-23T20:19:00+00:00) och boolean.
  • identityNs: Krävs för identitetsfält Det namnutrymme som används av identitetsfältet. Värden som stöds innehåller alla giltiga namnutrymmen, till exempel ECID eller email.
  • labels: Valfritt En array med åtkomstkontrolletiketter för fältet. Mer information om tillgängliga etiketter för åtkomstkontroll finns i etikettordlistan för dataanvändning.
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:

  • path: Obligatoriskt: Platsen för den externa målgruppen eller mappen som innehåller den externa målgruppen i källan. Filsökvägen får inte innehålla blanksteg. Om sökvägen till exempel är activation/sample-source/Example CSV File.csv anger du sökvägen till activation/sample-source/ExampleCSVFile.csv. Du hittar sökvägen till källan i kolumnen Source data i dataflödesavsnittet.
  • type: Obligatoriskt Den typ av objekt som du hämtar från källan. Värdet kan vara file eller folder.
  • sourceType: Valfritt Den typ av källa som du hämtar från. För närvarande är det enda värdet som stöds Cloud Storage.
  • cloudType: Obligatoriskt Typen av molnlagring, baserat på källtypen. Värden som stöds är S3, DLZ, GCS, Azure och SFTP.
  • baseConnectionId: ID:t för basanslutningen och tillhandahålls av din källleverantör. Det här värdet är obligatoriskt om cloudType-värdet S3, GCS eller SFTP används. Annars behöver du inte ta med den här parametern. Mer information finns i översikten över källanslutningar.
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. När du lägger till arrayen med taggar måste använda tagId. 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.

Ett exempelsvar när du skapar en extern publik.
code language-json 
{
    "operationId": "df8cd82f-a214-4b72-b549-d6ee23f1ff1a",
    "operationDetails": {
        "name": "Sample external audience",
        "description": "A sample version of an external audience",
        "fields": [
            {
                "name": "ppid",
                "type": "string",
                "identityNs": "Email"
            },
            {
                "name": "list_id",
                "type": "string",
                "labels": ["core/C2", "custom/deep"]
            },
            {
                "name": "delete",
                "type": "number"
            },
            {
                "name": "process_consent",
                "type": "string"
            }
        ],
        "sourceSpec": {
            "params": {
                "path": "activation/sample-source/example.csv",
                "type": "file",
                "sourceType": "Cloud Storage",
                "baseConnectionId": "1d1d4bc5-b527-46a3-9863-530246a61b2b"
            }
        },
        "ttlInDays": 40,
        "labels": ["core/C1"],
        "audienceType": "people",
        "originName": "CUSTOM_UPLOAD"
    }
}
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}
Parameter
Beskrivning
{OPERATION_ID}
Värdet id för åtgärden som du vill hämta.

Begäran

Ett exempel på en begäran om att hämta en extern målgrupps åtgärdsstatus.
code language-shell 
curl -X GET https://platform.adobe.io/data/core/ais/external-audience/operations/df8cd82f-a214-4b72-b549-d6ee23f1ff1a \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

Svar

Ett lyckat svar returnerar HTTP-status 200 med information om den externa målgruppens aktivitetsstatus.

Ett exempelsvar när du hämtar en extern målgrupps aktivitetsstatus.
code language-json 
{
    "operationId": "df8cd82f-a214-4b72-b549-d6ee23f1ff1a",
    "status": "SUCCESS",
    "operationDetails": {
        "name": "Sample external audience",
        "description": "A sample version of an external audience",
        "fields": [
            {
                "name": "ppid",
                "type": "string",
                "identityNs": "Email"
            },
            {
                "name": "list_id",
                "type": "string",
                "labels": ["core/C2", "custom/deep"]
            },
            {
                "name": "delete",
                "type": "number"
            },
            {
                "name": "process_consent",
                "type": "string"
            }
        ],
        "sourceSpec": {
            "params": {
                "path": "activation/sample-source/example.csv",
                "type": "file",
                "sourceType": "Cloud Storage",
                "baseConnectionId": "1d1d4bc5-b527-46a3-9863-530246a61b2b"
            }
        },
        "ttlInDays": 40,
        "labels": ["core/C1"],
        "audienceType": "people",
        "originName": "CUSTOM_UPLOAD"
    },
    "audienceName": "Sample external audience",
    "audienceId": "60ccea95-1435-4180-97a5-58af4aa285ab",
    "createdBy": "{USER_ID}",
    "createdAt": 1749324248,
    "updatedBy": "{USER_ID}",
    "updatedAt": 1749624273
}
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

NOTE
Om du vill använda följande slutpunkt måste du ha 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

Ett exempel på en begäran om att uppdatera den externa målgruppens beskrivning.
code language-shell 
curl -X PATCH https://platform.adobe.io/data/core/ais/external-audience/60ccea95-1435-4180-97a5-58af4aa285ab\
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'
 -d '{
    "description": "New sample description"
 }'
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.

Ett exempelsvar när den externa målgruppens beskrivning uppdateras.
code language-json 
{
    "audienceId": "60ccea95-1435-4180-97a5-58af4aa285ab",
    "audienceName": "Sample external audience",
    "description": "New sample description",
    "fields": [
        {
            "name": "ppid",
            "type": "string",
            "identityNs": "Email"
        },
        {
            "name": "list_id",
            "type": "string",
            "labels": ["core/C2", "custom/deep"]
        },
        {
            "name": "delete",
            "type": "number"
        },
        {
            "name": "process_consent",
            "type": "string"
        }
    ],
    "sourceSpec": {
        "path": "activation/sample-source/example.csv",
        "type": "file",
        "sourceType": "Cloud Storage",
        "baseConnectionId": "1d1d4bc5-b527-46a3-9863-530246a61b2b"
        },
    "ttlInDays": 40,
    "labels": ["core/C1"],
    "audienceType": "people",
    "originName": "CUSTOM_UPLOAD",
    "createdBy": "{USER_ID}",
    "createdAt": 1749324248,
    "updatedBy": "{USER_ID}",
    "updatedAt": 1749624273
}

Starta målgruppsintag start-audience-ingestion

IMPORTANT
Du kan inte starta ett nytt intag för den externa målgruppen om ett tidigare målgruppsintag redan pågår.
NOTE
Om du vill använda följande slutpunkt måste du ha 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.

Ett exempel på en förfrågan om att starta ett målgruppsintag.
code language-shell 
curl -X POST https://platform.adobe.io/data/core/ais/external-audience/60ccea95-1435-4180-97a5-58af4aa285ab/runs \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'
 -d '{
    "dataFilterStartTime": 764245635
 }'
table 0-row-3 1-row-3 2-row-3
Egenskap Typ Beskrivning
dataFilterStartTime Epoch-tidsstämpel Obligatoriskt Intervallet som anger starttid för att avgöra vilka filer som ska bearbetas. Det innebär att de markerade filerna blir filer efter den angivna tiden.
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. Det innebär att de markerade filerna blir filer före den angivna tiden.

Svar

Ett lyckat svar returnerar HTTP-status 200 med information om importen.

Ett exempelsvar när målgruppsintaget startas.
code language-json 
{
    "audienceName": "Sample external audience",
    "audienceId": "60ccea95-1435-4180-97a5-58af4aa285ab",
    "runId": "fb342311-725d-4b48-ab7d-c6105fbc2b8b",
    "differentialIngestion": true,
    "dataFilterStartTime": 764245635,
    "dataFilterEndTime": 4565657575,
    "createdAt": 4565657575,
    "createdBy:" "{USER_ID}"
}
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

NOTE
Om du vill använda följande slutpunkt måste du ha både 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.

Ett exempel på en begäran om att hämta den externa målgruppens inmatningsstatus.
code language-shell 
curl -X GET https://platform.adobe.io/data/core/ais/external-audience/60ccea95-1435-4180-97a5-58af4aa285ab/runs/fb342311-725d-4b48-ab7d-c6105fbc2b8b \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

Svar

Ett lyckat svar returnerar HTTP-status 200 med information om den externa målgruppens inmatning.

Ett exempelsvar när den externa målgruppens förtäring hämtas.
code language-json 
{
    "audienceName": "Sample external audience",
    "audienceId": "60ccea95-1435-4180-97a5-58af4aa285ab",
    "runId": "fb342311-725d-4b48-ab7d-c6105fbc2b8b",
    "status": "SUCCESS",
    "differentialIngestion": true,
    "dataFilterStartTime": 764245635,
    "dataFilterEndTime": 3456788568,
    "createdAt": 1749324248,
    "createdBy": "{USER_ID}",
    "details": [
        {
            "stage": "DATASET_INGEST",
            "status": "SUCCESS",
            "flowRunId": "{FLOW_RUN_ID}"
        },
        {
            "stage": "PROFILE_STORE_INGEST",
            "status": "SUCCESS",
            "flowRunId": "{FLOW_RUN_ID}"
        }
    ]
}
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.

  • stage: Inledningsfasen. Detta kan antingen vara DATASET_INGEST eller PROFILE_STORE_INGEST, som representerar inmatningen av data i sjön och intaget av profilen.
  • status: Status för intaget på scenen. Möjliga statusar är SUCCESS och FAILED.
  • flowRunId: ID:t för scenens inmatningsflöde.

Lista målgruppsmatningar list-ingestion-runs

NOTE
Om du vill använda följande slutpunkt måste du ha 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.

En exempelbegäran om att få en lista över målgruppsinmatning körs.
code language-shell 
curl -X GET https://platform.adobe.io/data/core/ais/external-audience/60ccea95-1435-4180-97a5-58af4aa285ab/runs \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

Svar

Ett lyckat svar returnerar HTTP-status 200 med en lista över antalet inkommande filer för den angivna externa målgruppen.

Ett exempelsvar när du hämtar en lista över målgruppsinmatningen körs.
code language-json 
{
    "runs": [
        {
            "audienceName": "Sample external audience",
            "audienceId": "60ccea95-1435-4180-97a5-58af4aa285ab",
            "runId": "fb342311-725d-4b48-ab7d-c6105fbc2b8b",
            "status": "SUCCESS",
            "differentialIngestion": true,
            "dataFilterStartTime": 764245635,
            "dataFilterEndTime": 3456788568,
            "createdAt": 1785678909,
            "createdBy": "{USER_NAME}"
        },
        {
            "audienceName": "Sample external audience 2",
            "audienceId": "60ccea95-1435-4180-97a5-58af4aa285ab",
            "runId": "406e38e4-fbd5-43e1-8d0c-01ccb3f9ad10",
            "status": "SUCCESS",
            "differentialIngestion": true,
            "dataFilterStartTime": 764245635,
            "dataFilterEndTime": 3456788568,
            "createdAt": 1749324248,
            "createdBy": "{USER_ID}"
        }
    ]
}
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.

Utöka utgångsdatum för externa användare extend-data-expiration

NOTE
Om du vill använda följande slutpunkt måste du ha 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 utöka dataförfallotiden för en extern målgrupp genom att göra en POST-begäran till följande slutpunkt och samtidigt ange målar-ID.

Utgångsdatumet för data förlängs med den ursprungliga varaktighet som angetts vid intag. Om ingen varaktighet har angetts används ett standardtillägg på 30 dagar. När du förlänger giltigheten för data hämtas data från det senast framgångsrika intaget.

API-format

/ais/external-audience/extend-ttl/{AUDIENCE_ID}

Begäran

Följande begäran utökar dataförfallotiden för den angivna externa målgruppen.

Ett exempel på en begäran om att förlänga utgångsdatum för data för en extern publik.
code language-shell 
curl -x POST https://platform.adobe.io/data/core/ais/external-audience/extend-ttl/60ccea95-1435-4180-97a5-58af4aa285ab \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

Svar

Ett lyckat svar returnerar HTTP-status 200 med information om målgruppen.

Ett exempelsvar när du förlänger förfallotiden för data.
code language-json 
{
    "audienceId": "60ccea95-1435-4180-97a5-58af4aa285ab",
    "name": "Sample external audience"
}

Ta bort en extern målgrupp delete-audience

NOTE
Om du vill använda följande slutpunkt måste du ha 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.

En exempelbegäran om att ta bort den externa målgruppen.
code language-shell 
curl -X DELETE https://platform.adobe.io/data/core/ais/external-audience/60ccea95-1435-4180-97a5-58af4aa285ab/ \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

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.

Felkod för plattform
Statuskod
Meddelande
Beskrivning
100910-400
400
BAD_REQUEST
En felaktig begäran har inträffat på grund av ett fel som uppstod när begäran validerades.
100911-400
400
BAD_REQUEST
En ogiltig token har angetts.
100920-401
401
UNAUTHORIZED
Ett huvud saknas.
100921-401
401
UNAUTHORIZED
En ogiltig imsOrgId har angetts.
100922-401
401
UNAUTHORIZED
Du har inte behörighet att använda externa målgrupps-API:er.
100940-404
404
NOT_FOUND
Det gick inte att hitta den begärda målgruppen.
100950-409
409
DUPLICATE_RESOURCE
Publiken finns redan.
100960-422
422
UNPROCESSABLE_ENTITY
Begärandestrukturen är giltig, men den kan inte behandlas på grund av logiska eller semantiska fel.
100970-500
500
INTERNAL_SERVER_ERROR
Ett problem uppstod när begäran bearbetades i systemet.
100970-502
502
BAD_GATEWAY
Det finns beroendeproblem i senare led.
recommendation-more-help
770bc05d-534a-48a7-9f07-017ec1e14871