Documentatie Experience Platform Handleiding voor bestemmingen

Voorbeeldprofielen genereren op basis van een bronschema sample-profile-api-operations

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Onderwerpen:
Destinations

Gemaakt voor:

Beheerder
Gebruiker

IMPORTANT

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

Deze pagina bevat een overzicht en beschrijving van alle API-bewerkingen die u kunt uitvoeren met het API-eindpunt van /authoring/sample-profiles .

Verschillende profieltypen genereren voor verschillende API's different-profiles-different-apis

IMPORTANT

Gebruik dit API-eindpunt om voorbeeldprofielen te genereren voor twee afzonderlijke gebruiksgevallen. U kunt:

produceren profielen om te gebruiken wanneer creërend en het testen van een malplaatje van de berichttransformatie- door bestemmingsidentiteitskaart als vraagparameter te gebruiken.
produceren profielen om te gebruiken wanneer het maken van vraag aan test als uw bestemming correctwordt gevormd - door identiteitskaart van de bestemmingsinstantie als vraagparameter te gebruiken.

U kunt steekproefprofielen produceren die op of het Adobe XDM bronschema (om te gebruiken wanneer het testen van uw bestemming) worden gebaseerd, of het doelschema dat door uw bestemming wordt gesteund (om te gebruiken wanneer het ontwerpen van uw malplaatje). Om het verschil tussen Adobe XDM bronschema en doelschema te begrijpen, lees de overzichtssectie van het formaat van het Berichtartikel.

De doeleinden waarvoor de voorbeeldprofielen kunnen worden gebruikt, zijn niet onderling verwisselbaar. De profielen die op worden geproduceerd bestemmingsidentiteitskaart kunnen slechts worden gebruikt om uw malplaatjes en de profielen van de berichttransformatie te amberen die op worden geproduceerd identiteitskaart van de bestemmingsinstantie kunnen slechts worden gebruikt om uw bestemmingspunten te testen.

Aan de slag met API-bewerkingen voor het genereren van voorbeeldprofielen get-started

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 hoe te om de vereiste toestemming van de bestemmings authoring en vereiste kopballen te verkrijgen.

Voorbeeldprofielen genereren op basis van het bronschema dat moet worden gebruikt voor het testen van uw bestemming generate-sample-profiles-source-schema

IMPORTANT

Voeg de steekproefprofielen toe hier aan de vraag van HTTP worden geproduceerd wanneer het testen van uw bestemming.

U kunt steekproefprofielen produceren die op het bronschema worden gebaseerd door een verzoek van de GET tot het authoring/sample-profiles/ eindpunt te richten en identiteitskaart van een bestemmingsinstantie te verstrekken die u op de bestemmingsconfiguratie creeerde die u wilt testen.

Om identiteitskaart van een bestemmingsinstantie te krijgen, moet u een verbinding in het Experience Platform UI aan uw bestemming eerst tot stand brengen alvorens uw bestemming te proberen. Lees het activeer bestemmingsleerprogrammaen zie hieronder het uiteinde voor hoe te om identiteitskaart van de bestemmingsinstantie aan gebruik voor dit API te krijgen.

IMPORTANT

Als u deze API wilt gebruiken, moet u een bestaande verbinding met uw doel hebben in de interface van het Experience Platform. Lees verbind met bestemmingen activeer profielen en publiek aan een bestemmingvoor meer informatie.
Na het vestigen van de verbinding aan uw bestemming, krijg identiteitskaart van de bestemmingsinstantie die u in API vraag aan dit eindpunt zou moeten gebruiken wanneer doorbladert een verbinding met uw bestemming.

API formaat

GET authoring/sample-profiles?destinationInstanceId={DESTINATION_INSTANCE_ID}&count={COUNT}

Query-parameter

Beschrijving

{DESTINATION_INSTANCE_ID}

De id van de doelinstantie waarop u voorbeeldprofielen genereert.

{COUNT}

Facultatief. Het aantal voorbeeldprofielen dat u genereert. De parameter kan waarden aannemen tussen 1 - 1000 .
Als de tellingsparameter niet wordt gespecificeerd, dan wordt het standaardaantal geproduceerde profielen bepaald door de maxUsersPerRequest waarde in de configuratie van de bestemmingsserver. Als deze eigenschap niet is gedefinieerd, genereert Adobe één voorbeeldprofiel.

Verzoek

Met de volgende aanvraag worden voorbeeldprofielen gegenereerd, geconfigureerd door de parameters {DESTINATION_INSTANCE_ID} en {COUNT} query.

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}' \

Reactie

Een succesvolle reactie keert status 200 van HTTP met het gespecificeerde aantal steekproefprofielen, met publiekslidmaatschap, identiteiten, en profielattributen terug die aan het bronXDM schema beantwoorden.

TIP

De reactie retourneert alleen het publiekslidmaatschap, de identiteiten en de profielkenmerken die in de doelinstantie worden gebruikt. Zelfs als uw bronschema andere gebieden heeft, worden deze genegeerd.

[
    {
        "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"
            }
        }
    }
]

Eigenschap

Beschrijving

segmentMembership

A map object that describes the person's publiek membership. Voor meer informatie over segmentMembership, lees de Details van het Lidmaatschap van de Publiek.

lastQualificationTime

Een tijdstempel van de laatste keer dat dit profiel voor het segment kwalificeerde.

xdm:status

Een tekenreeksveld dat aangeeft of het publieklidmaatschap is gerealiseerd als onderdeel van de huidige aanvraag. De volgende waarden worden geaccepteerd:

realized: Het profiel maakt deel uit van het segment.
exited: Het profiel sluit het publiek af als onderdeel van de huidige aanvraag.

identityMap

A map-type field that describes the various identity values for an individual, together with their associated namespaces. Voor meer informatie over identityMap, lees Basis van schemacompositie.

Voorbeeldprofielen genereren op basis van het doelschema dat moet worden gebruikt bij het maken van een sjabloon voor berichttransformatie generate-sample-profiles-target-schema

IMPORTANT

Gebruik de steekproefprofielen hier worden geproduceerd wanneer het ontwerpen van uw malplaatje, in geven malplaatjestapterug.

U kunt steekproefprofielen produceren die op het doelschema worden gebaseerd die een verzoek van de GET tot het authoring/sample-profiles/ eindpunt richten en bestemmingsidentiteitskaart van de bestemmingsconfiguratie verstrekken die op wordt gebaseerd die u uw malplaatje creeert.

TIP

De doel-id die u hier moet gebruiken, is de instanceId die overeenkomt met een doelconfiguratie die is gemaakt met het /destinations -eindpunt. Verwijs naar een bestemmingsconfiguratievoor meer details terugwinnen.

API formaat

GET authoring/sample-profiles?destinationId={DESTINATION_ID}&count={COUNT}

Query-parameter

Beschrijving

{DESTINATION_ID}

De id van de doelconfiguratie waarop u voorbeeldprofielen genereert.

{COUNT}

Verzoek

Met de volgende aanvraag worden voorbeeldprofielen gegenereerd, geconfigureerd door de parameters {DESTINATION_ID} en {COUNT} query.

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}' \

Reactie

[
    {
        "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-foutafhandeling api-error-handling

Destination SDK API-eindpunten volgen de algemene API-foutberichtbeginselen voor Experience Platforms. Verwijs naar API statuscodesen de fouten van de verzoekkopbalin de het oplossen van problemengids van het Platform.

Volgende stappen

Na het lezen van dit document, weet u nu hoe te om steekproefprofielen te produceren die moeten worden gebruikt wanneer het testen van een malplaatje van de berichttransformatieof wanneer het testen als uw bestemming correctwordt gevormd.

recommendation-more-help

7f4d1967-bf93-4dba-9789-bb6b505339d6