Generera exempelprofiler baserat på ett källschema

VIKTIGT

API-slutpunkt: https://platform.adobe.io/data/core/activation/authoring/sample-profiles

På den här sidan visas och beskrivs alla API-åtgärder som du kan utföra med /authoring/sample-profiles API-slutpunkt.

Generera olika profiltyper för olika API:er

VIKTIGT

Använd den här API-slutpunkten om du vill generera exempelprofiler för två olika användningsområden. Du kan antingen:

Du kan generera exempelprofiler baserat på antingen Adobe XDM-källschemat (som används vid testning av ditt mål) eller målschemat som stöds av ditt mål (som används när du skapar mallen). Om du vill förstå skillnaden mellan källschemat och målschemat för Adobe XDM läser du översiktsavsnittet i Meddelandeformat artikel.

Observera att de syften för vilka exempelprofilerna kan användas inte är utbytbara. Profiler som genereras baserat på mål-ID kan bara användas för att skapa dina meddelandeomformningsmallar och profiler som genereras baserat på målinstans-ID kan bara användas för att testa målslutpunkten.

Komma igång med API-åtgärder för generering av exempelprofiler

Läs igenom komma igång-guide för viktig information som du behöver känna till för att kunna anropa API:t, inklusive hur du får nödvändig behörighet för målredigering och obligatoriska huvuden.

Generera exempelprofiler baserat på källschemat som ska användas vid testning av målet

VIKTIGT

Lägg till exempelprofilerna som genereras här i HTTP-anrop när testa destinationen.

Du kan generera exempelprofiler baserat på källschemat genom att göra en GET-förfrågan till authoring/sample-profiles/ slutpunkt och ange ID:t för en målinstans som du har skapat baserat på den målkonfiguration som du vill testa.

Om du vill hämta ID:t för en målinstans måste du först skapa en anslutning i användargränssnittet i Experience Platform till målet innan du försöker testa målet. Läs aktivera mål, självstudiekurs och se tipset nedan för hur du får destinationsinstans-ID att använda för detta API.

VIKTIGT

API-format

GET authoring/sample-profiles?destinationInstanceId={DESTINATION_INSTANCE_ID}&count={COUNT}
Frågeparameter Beskrivning
{DESTINATION_INSTANCE_ID} ID:t för målinstansen som du genererar exempelprofiler utifrån.
{COUNT} Valfritt. Antalet exempelprofiler som du genererar. Parametern kan ha värden mellan 1 - 1000.
Om parametern count inte anges bestäms standardantalet genererade profiler av maxUsersPerRequest värdet i målserverkonfiguration. Om den här egenskapen inte är definierad genereras en exempelprofil i Adobe.

Begäran

Följande begäran genererar exempelprofiler som konfigurerats av {DESTINATION_INSTANCE_ID} och {COUNT} frågeparametrar.

curl --location --request GET 'https://platform.adobe.io/data/core/activation/authoring/sample-profiles?destinationInstanceId=49966037-32cd-4457-a105-2cbf9c01826a&count=3' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'x-api-key: {API_KEY}' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-gw-ims-org-id: {ORG_ID}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \

Svar

Ett lyckat svar returnerar HTTP-status 200 med det angivna antalet exempelprofiler, med målgruppsmedlemskap, identiteter och profilattribut som motsvarar XDM-källschemat.

TIPS

Svaret returnerar endast målgruppsmedlemskap, identiteter och profilattribut som används i målinstansen. Även om källschemat innehåller andra fält ignoreras dessa.

[
    {
        "segmentMembership": {
            "ups": {
                "03fb9938-8537-4b4c-87f9-9c4d413a0ee5": {
                    "lastQualificationTime": "2021-06-30T18:40:07.591378Z",
                    "status": "realized"
                },
                "27e05542-d6a3-46c7-9c8e-d59d50229530": {
                    "lastQualificationTime": "2021-06-30T18:40:07.591380Z",
                    "status": "realized"
                }
            }
        },
        "personalEmail": {
            "address": "john.smith@abc.com"
        },
        "identityMap": {
            "ECID": [
                {
                    "id": "ECID-7VEsJ"
                }
            ]
        },
        "person": {
            "name": {
                "firstName": "string"
            }
        }
    },
    {
        "segmentMembership": {
            "ups": {
                "03fb9938-8537-4b4c-87f9-9c4d413a0ee5": {
                    "lastQualificationTime": "2021-06-30T18:40:07.591378Z",
                    "status": "realized"
                },
                "27e05542-d6a3-46c7-9c8e-d59d50229530": {
                    "lastQualificationTime": "2021-06-30T18:40:07.591380Z",
                    "status": "realized"
                }
            }
        },
        "personalEmail": {
            "address": "john.smith@abc.com"
        },
        "identityMap": {
            "ECID": [
                {
                    "id": "ECID-Y55JJ"
                }
            ]
        },
        "person": {
            "name": {
                "firstName": "string"
            }
        }
    },
    {
        "segmentMembership": {
            "ups": {
                "03fb9938-8537-4b4c-87f9-9c4d413a0ee5": {
                    "lastQualificationTime": "2021-06-30T18:40:07.591378Z",
                    "status": "realized"
                },
                "27e05542-d6a3-46c7-9c8e-d59d50229530": {
                    "lastQualificationTime": "2021-06-30T18:40:07.591380Z",
                    "status": "realized"
                }
            }
        },
        "personalEmail": {
            "address": "john.smith@abc.com"
        },
        "identityMap": {
            "ECID": [
                {
                    "id": "ECID-Nd9GK"
                }
            ]
        },
        "person": {
            "name": {
                "firstName": "string"
            }
        }
    }
]
Egenskap Beskrivning
segmentMembership Ett kartobjekt som beskriver personens målgruppsmedlemskap. Mer information om segmentMembership, läsa Information om målgruppsmedlemskap.
lastQualificationTime En tidsstämpel från den senaste gången profilen kvalificerades för segmentet.
xdm:status Ett strängfält som anger om målgruppsmedlemskapet har realiserats som en del av den aktuella begäran. Följande värden accepteras:
  • realized: Profilen är en del av segmentet.
  • exited: Profilen avslutar publiken som en del av den aktuella begäran.
identityMap Ett mappningsfält som beskriver de olika identitetsvärdena för en individ, tillsammans med deras associerade namnutrymmen. Mer information om identityMap, läsa Grund för schemakomposition.

Generera exempelprofiler baserade på målschemat som ska användas när en meddelandeomformningsmall skapas

VIKTIGT

Använd exempelprofilerna som genereras här när du skapar mallen i återge mallsteg.

Du kan generera exempelprofiler baserat på målschemat och göra en GET-förfrågan till authoring/sample-profiles/ slutpunkt och ange mål-ID för den målkonfiguration som du skapar mallen utifrån.

TIPS
  • Mål-ID som du ska använda här är instanceId som motsvarar en målkonfiguration, skapad med /destinations slutpunkt. Se hämta en destinationskonfiguration för mer information.

API-format

GET authoring/sample-profiles?destinationId={DESTINATION_ID}&count={COUNT}
Frågeparameter Beskrivning
{DESTINATION_ID} ID:t för målkonfigurationen baserat på vilket du genererar exempelprofiler.
{COUNT} Valfritt. Antalet exempelprofiler som du genererar. Parametern kan ha värden mellan 1 - 1000.
Om parametern count inte anges bestäms standardantalet genererade profiler av maxUsersPerRequest värdet i målserverkonfiguration. Om den här egenskapen inte är definierad genereras en exempelprofil i Adobe.

Begäran

Följande begäran genererar exempelprofiler som konfigurerats av {DESTINATION_ID} och {COUNT} frågeparametrar.

curl --location --request GET 'https://platform.adobe.io/data/core/activation/authoring/sample-profiles?destinationId=49966037-32cd-4457-a105-2cbf9c01826a&count=3' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'x-api-key: {API_KEY}' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-gw-ims-org-id: {ORG_ID}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \

Svar

Ett lyckat svar returnerar HTTP-status 200 med det angivna antalet exempelprofiler, med målgruppsmedlemskap, identiteter och profilattribut som motsvarar mål-XDM-schemat.

[
    {
        "segmentMembership": {
            "ups": {
                "segmentid1": {
                    "lastQualificationTime": "2021-06-30T18:42:27.609326Z",
                    "status": "realized"
                },
                "segmentid3": {
                    "lastQualificationTime": "2021-06-30T18:42:27.609328Z",
                    "status": "exited"
                },
                "segmentid2": {
                    "lastQualificationTime": "2021-06-30T18:42:27.609328Z",
                    "status": "realized"
                }
            }
        },
        "identityMap": {
            "phone_sha256": [
                {
                    "id": "phone_sha256-vizii"
                }
            ],
            "gaid": [
                {
                    "id": "gaid-adKYs"
                }
            ],
            "idfa": [
                {
                    "id": "idfa-t4sKv"
                }
            ],
            "extern_id": [
                {
                    "id": "extern_id-C3enB"
                }
            ],
            "email_lc_sha256": [
                {
                    "id": "email_lc_sha256-bfnbs"
                }
            ]
        }
    },
    {
        "segmentMembership": {
            "ups": {
                "segmentid1": {
                    "lastQualificationTime": "2021-06-30T18:42:27.609626Z",
                    "status": "realized"
                },
                "segmentid3": {
                    "lastQualificationTime": "2021-06-30T18:42:27.609627Z",
                    "status": "exited"
                },
                "segmentid2": {
                    "lastQualificationTime": "2021-06-30T18:42:27.609627Z",
                    "status": "realized"
                }
            }
        },
        "identityMap": {
            "phone_sha256": [
                {
                    "id": "phone_sha256-6YjGc"
                }
            ],
            "gaid": [
                {
                    "id": "gaid-SfJ21"
                }
            ],
            "idfa": [
                {
                    "id": "idfa-eQMWS"
                }
            ],
            "extern_id": [
                {
                    "id": "extern_id-d3WzP"
                }
            ],
            "email_lc_sha256": [
                {
                    "id": "email_lc_sha256-eWfFn"
                }
            ]
        }
    },
    {
        "segmentMembership": {
            "ups": {
                "segmentid1": {
                    "lastQualificationTime": "2021-06-30T18:42:27.609823Z",
                    "status": "realized"
                },
                "segmentid3": {
                    "lastQualificationTime": "2021-06-30T18:42:27.609824Z",
                    "status": "exited"
                },
                "segmentid2": {
                    "lastQualificationTime": "2021-06-30T18:42:27.609824Z",
                    "status": "realized"
                }
            }
        },
        "identityMap": {
            "phone_sha256": [
                {
                    "id": "phone_sha256-2PMjZ"
                }
            ],
            "gaid": [
                {
                    "id": "gaid-3aLez"
                }
            ],
            "idfa": [
                {
                    "id": "idfa-D2H1J"
                }
            ],
            "extern_id": [
                {
                    "id": "extern_id-i6PsF"
                }
            ],
            "email_lc_sha256": [
                {
                    "id": "email_lc_sha256-VPUtZ"
                }
            ]
        }
    }
]

API-felhantering

Destination SDK-API-slutpunkter följer de allmänna felmeddelandeprinciperna för Experience Platform API. Se API-statuskoder och fel i begäranhuvudet i felsökningsguiden för plattformen.

Nästa steg

När du har läst det här dokumentet vet du nu hur du genererar exempelprofiler som ska användas när testa en meddelandeomvandlingsmall eller när testar om målet är korrekt konfigurerat.

På denna sida