Het publiek op aanvraag activeren naar batchbestemmingen via de API voor ad-hocactivering

Overzicht overview

Met de API voor ad-hocactivering kunnen marketers het publiek programmatisch naar bestemmingen activeren, op een snelle en efficiënte manier, in situaties waarin onmiddellijke activering vereist is.

Gebruik de API voor ad-hocactivering om volledige bestanden te exporteren naar het gewenste systeem voor het ontvangen van bestanden. Ad-hoc publieksactivering wordt slechts gesteund door ​ op dossier-gebaseerde bestemmingen ​.

In het onderstaande diagram ziet u de end-to-end workflow voor het activeren van het publiek via de API voor ad-hocactivering, inclusief de segmentatietaken die elke 24 uur in Experience Platform plaatsvinden.

Gebruiksscenario's use-cases

Flash-verkoop of -promoties flash-sales

Een online retailer bereidt een beperkte flash-verkoop voor en wil klanten op korte termijn op de hoogte stellen. Via de API voor ad-hocactivering van Experience Platform kan het marketingteam soorten publiek op aanvraag exporteren en snel e-mails met speciale acties naar de klantenbasis sturen.

Actuele gebeurtenissen of het doorbreken van nieuws current-events

Een hotel verwacht het hoogteweer in de komende dagen en het team wil de aankomende gasten snel informeren, zodat ze dienovereenkomstig kunnen plannen. Het marketingteam kan de API voor ad-hocactivering van Experience Platform gebruiken om een publiek op aanvraag te exporteren en de gasten op de hoogte te stellen.

Integratie testen integration-testing

IT-managers kunnen de API voor ad-hocactivering van Experience Platform gebruiken om soorten publiek op aanvraag te exporteren, zodat ze hun aangepaste integratie met Adobe Experience Platform kunnen testen en kunnen controleren of alles correct werkt.

Beveiligingsmechanismen guardrails

Houd rekening met de volgende instructies wanneer u de API voor ad-hocactivering gebruikt.

Segmenteringsoverwegingen segmentation-considerations

In Adobe Experience Platform worden om de 24 uur geplande segmentatietaken uitgevoerd. De API voor ad-hocactivering wordt uitgevoerd op basis van de meest recente segmentatieresultaten.

Stap 1: Voorwaarden prerequisites

Voordat u de API's van Adobe Experience Platform kunt aanroepen, moet u controleren of aan de volgende voorwaarden is voldaan:

Stap 2: Referenties verzamelen credentials

Om vraag aan Experience Platform APIs te maken, moet u het ​ authentificatieleerprogramma ​ eerst voltooien. Als u de zelfstudie over verificatie voltooit, krijgt u de waarden voor elk van de vereiste headers in alle Experience Platform API-aanroepen, zoals hieronder wordt getoond:

De middelen in Experience Platform kunnen aan specifieke virtuele zandbakken worden geïsoleerd. In aanvragen voor Experience Platform API's kunt u de naam en id opgeven van de sandbox waarin de bewerking plaatsvindt. Dit zijn optionele parameters.

Alle verzoeken die een lading (POST, PUT, PATCH) bevatten vereisen een extra media typekopbal:

Stap 3: De activeringsstroom maken in de gebruikersinterface van Experience Platform activation-flow

Voordat u het publiek kunt activeren via de API voor ad-hocactivering, moet u eerst een activeringsstroom hebben geconfigureerd in de gebruikersinterface van Experience Platform voor het gekozen doel.

Dit omvat het ingaan van in het activeringswerkschema, het selecteren van uw publiek, het vormen van een programma, en het activeren van hen. U kunt de UI of API gebruiken om een activeringsstroom tot stand te brengen:

Stap 4: Vraag de meest recente uitvoertaak-id voor het publiek aan (niet vereist in v2) segment-export-id

Nadat u een activeringsstroom voor uw partijbestemming vormt, beginnen de geplande segmentatietaken automatisch om de 24 uur lopend.

Voordat u de ad-hocactiveringstaak kunt uitvoeren, moet u de id van de laatste doelexporttaak opvragen. U moet deze id doorgeven in de aanvraag voor een ad-hocactiveringstaak.

Volg de hier beschreven instructies ​ ​ om een lijst van alle banen van de publieksuitvoer terug te winnen.

In de reactie, zoek het eerste verslag dat het schemabezit hieronder omvat.

"schema":{
   "name":"_xdm.context.profile"
}

De gebruikers voeren baan ID uit is in het id bezit, zoals hieronder getoond.

Stap 5: De ad-hocactiveringstaak uitvoeren activation-job

In Adobe Experience Platform worden om de 24 uur geplande segmentatietaken uitgevoerd. De API voor ad-hocactivering wordt uitgevoerd op basis van de meest recente segmentatieresultaten.

Voordat u een ad-hocactiveringstaak uitvoert, moet u controleren of de geplande doeluitvoertaak voor uw publiek is voltooid. Zie ​ bestemmingdataflow controle ​ voor informatie over hoe te om het statuut van activeringsstromen te controleren. Als in uw activeringsgegevens bijvoorbeeld de status Processing wordt weergegeven, wacht u tot deze is voltooid voordat de ad-hocactiveringstaak wordt uitgevoerd om een volledig bestand te exporteren.

Nadat de doelexporttaak is voltooid, kunt u de activering activeren.

Verzoek request

Voor niet-segmentatie de dienstpubliek (bijvoorbeeld, ​ extern of douane uploadt publiek ​), moet u het publiek identiteitskaart specificeren die door Experience Platform in uw verzoek wordt geproduceerd, niet externe publieksidentiteitskaart U kunt systeem-geproduceerde identiteitskaart bij de bovenkant van het ​ paneel van de publiekssamenvatting ​ vinden, die als wordt getoond identiteitskaart# die door UUID wordt gevolgd, wanneer u de pagina van de publieksdetails in het publiek UI opent.

curl --location --request POST 'https://platform.adobe.io/data/core/activation/disflowprovider/adhocrun' \
--header 'x-gw-ims-org-id: 5555467B5D8013E50A494220@AdobeOrg' \
--header 'Authorization: Bearer {{token}}' \
--header 'x-sandbox-id: 6ef74723-3ee7-46a4-b747-233ee7a6a41a' \
--header 'x-sandbox-name: {sandbox-id}' \
--header 'Accept: application/vnd.adobe.adhoc.activation+json; version=2' \
--header 'Content-Type: application/json' \
--data-raw '{
   "activationInfo":{
      "destinationId1":[
         "segmentId1",
         "segmentId2"
      ],
      "destinationId2":[
         "segmentId2",
         "segmentId3"
      ]
   }
}'

Eigenschap

Beschrijving

• destinationId1
• destinationId2

De id's van de doelinstanties waarop u het publiek wilt activeren. U kunt deze id's ophalen vanuit de gebruikersinterface van Experience Platform door naar het tabblad Destinations > Browse te navigeren en op de gewenste doelrij te klikken om de doel-id op te halen in de rechtertrack. Voor meer informatie, lees de ​ documentatie van de bestemmingswerkruimte ​.

• segmentId1
• segmentId2
• segmentId3

De id's van het publiek dat u wilt activeren naar het geselecteerde doel. U kunt de API voor ad-hoc gebruiken om door Experience Platform gegenereerde soorten publiek en externe (aangepaste upload) soorten publiek te exporteren. Wanneer u een extern publiek activeert, gebruikt u de door het systeem gegenereerde id in plaats van de gebruikers-id. U vindt de door het systeem gegenereerde id in de overzichtsweergave voor het publiek in de gebruikersinterface.
{width="100" modal="regular"}
{width="100" modal="regular"}

Aanvragen met export-id's request-export-ids

curl -X POST https://platform.adobe.io/data/core/activation/disflowprovider/adhocrun \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -d '
{
   "activationInfo":{
      "destinationId1":[
         "segmentId1",
         "segmentId2"
      ],
      "destinationId2":[
         "segmentId2",
         "segmentId3"
      ]
   },
   "exportIds":[
      "exportId1"
   ]
}

Antwoord response

Een geslaagde reactie retourneert HTTP-status 200.

{
   "order":[
      {
         "segment":"db8961e9-d52f-45bc-b3fb-76d0382a6851",
         "order":"ef2dcbd6-36fc-49a3-afed-d7b8e8f724eb",
         "statusURL":"https://platform.adobe.io/data/foundation/flowservice/runs/88d6da63-dc97-460e-b781-fc795a7386d9"
      }
   ]
}

API-foutafhandeling api-error-handling

Destination SDK API-eindpunten volgen de algemene beginselen van Experience Platform API-foutberichten. Zie ​ API statuscodes ​ en ​ de fouten van de verzoekkopbal ​ in de het oplossen van problemengids van Experience Platform.

API-foutcodes en specifieke berichten voor de API voor ad-hocactivering specific-error-messages

Wanneer u de API voor ad-hocactivering gebruikt, kunt u foutberichten tegenkomen die specifiek zijn voor dit API-eindpunt. Bekijk de tabel om te begrijpen hoe u deze kunt aanpakken wanneer ze worden weergegeven.

Verwante informatie related-information